Merge pull request #141 from sue445/feature/fix_rb_event_flag_t

Check whether generated code is valid

Author: sue445

.github/workflows/ruby_h_to_go.yml

@@ -21,20 +21,28 @@ defaults:
 
 jobs:
   test:
-    name: "test (Ruby ${{ matrix.ruby }})"
+    name: "test (Go ${{ matrix.golang }}, Ruby ${{ matrix.ruby }})"
 
     runs-on: ubuntu-latest
 
     strategy:
       fail-fast: false
 
       matrix:
+        golang:
+          # TODO: Enable after repo is published
+          # - "1.22"
+          - "1.23"
         ruby:
           - "3.3"
 
     steps:
       - uses: actions/checkout@v4
 
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.golang }}
+
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
@@ -43,6 +51,8 @@ jobs:
       - run: sudo apt-get update
       - run: sudo apt-get install -y universal-ctags
 
+      - run: go install golang.org/x/tools/cmd/goimports@latest
+
       - run: bundle exec rspec
 
       - name: Slack Notification (not success)

_tools/ruby_h_to_go/lib/ruby_h_to_go/cli.rb

@@ -30,6 +30,13 @@ def perform
       go_fmt
     end
 
+    private
+
+    # @return [RubyHeaderParser::Parser]
+    def parser
+      @parser ||= RubyHeaderParser::Parser.new(header_dir)
+    end
+
     def write_type_definitions_to_go_file
       type_definitions = parser.extract_type_definitions.map do |definition|
         RubyHToGo::TypeDefinition.new(definition:, header_dir:)
@@ -70,13 +77,6 @@ def write_function_definitions_to_go_file
       end
     end
 
-    private
-
-    # @return [RubyHeaderParser::Parser]
-    def parser
-      @parser ||= RubyHeaderParser::Parser.new(header_dir)
-    end
-
     # Clean all generated files in dist/
     def clean_generated_files
       FileUtils.rm_f(Dir.glob(File.join(dist_dir, "*.go")))

_tools/ruby_h_to_go/lib/ruby_header_parser/parser.rb

@@ -19,12 +19,12 @@ def initialize(header_dir)
 
     # @return [Array<RubyHeaderParser::FunctionDefinition>]
     def extract_function_definitions
-      __extract_function_definitions(c_kinds: "p", is_parse_multiline_definition: true)
+      __extract_function_definitions(c_kinds: "p", kind: "p", is_parse_multiline_definition: true)
     end
 
     # @return [Array<RubyHeaderParser::FunctionDefinition>]
     def extract_static_inline_function_definitions
-      __extract_function_definitions(c_kinds: "+p-d", is_parse_multiline_definition: false)
+      __extract_function_definitions(c_kinds: "+p-d", kind: "f", is_parse_multiline_definition: false)
     end
 
     # @return [Array<RubyHeaderParser::StructDefinition>]
@@ -66,9 +66,10 @@ def extract_type_definitions
     private
 
     # @param c_kinds [String]
+    # @param kind [String]
     # @param is_parse_multiline_definition [Boolean]
     # @return [Array<RubyHeaderParser::FunctionDefinition>]
-    def __extract_function_definitions(c_kinds:, is_parse_multiline_definition:)
+    def __extract_function_definitions(c_kinds:, kind:, is_parse_multiline_definition:)
       stdout = execute_ctags("--c-kinds=#{c_kinds} --fields=+nS --extras=+q")
 
       stdout.each_line.with_object([]) do |line, definitions|
@@ -78,6 +79,8 @@ def __extract_function_definitions(c_kinds:, is_parse_multiline_definition:)
 
         next unless data.should_generate_function?(function_name)
 
+        next unless parts[3] == kind
+
         line_num = Util.find_field(parts, "line").to_i
         definition =
           parse_function_definition(filepath: parts[1], pattern: parts[2], line_num:, is_parse_multiline_definition:)
@@ -213,11 +216,12 @@ def parse_definition_args(function_name, signature)
     def create_typeref(definition:, function_name:, typeref_field:)
       typeref_type =
         if typeref_field
-          typeref_field.gsub(/^RBIMPL_ATTR_NONNULL\s*\(\(\)\)/, "").strip
+          type = typeref_field.gsub(/[A-Z_]+\s*\(\(.*\)\)/, "").gsub("RUBY_SYMBOL_EXPORT_BEGIN", "")
+          Util.sanitize_type(type) # rubocop:disable Style/IdenticalConditionalBranches
         else
           # parse typeref in definition
           type = definition[0...definition.index(function_name)].gsub("char *", "char*").strip
-          Util.sanitize_type(type)
+          Util.sanitize_type(type) # rubocop:disable Style/IdenticalConditionalBranches
         end
 
       typeref_pointer = nil

_tools/ruby_h_to_go/spec/ruby_h_to_go/cli_spec.rb

@@ -10,20 +10,12 @@
     )
   end
 
-  describe "#write_type_definitions_to_go_file" do
-    subject { cli.write_type_definitions_to_go_file }
+  describe "#perform" do
+    subject { cli.perform }
 
-    it { expect { subject }.not_to raise_error }
-  end
-
-  describe "#write_struct_definitions_to_go_file" do
-    subject { cli.write_struct_definitions_to_go_file }
-
-    it { expect { subject }.not_to raise_error }
-  end
-
-  describe "#write_function_definitions_to_go_file" do
-    subject { cli.write_function_definitions_to_go_file }
+    before do
+      FileUtils.cp(File.join(project_root_dir, "go.mod"), temp_dir)
+    end
 
     it { expect { subject }.not_to raise_error }
   end

_tools/ruby_h_to_go/spec/ruby_header_parser/parser_spec.rb

@@ -143,6 +143,11 @@
 
     its(:count) { should be > 0 }
 
+    it "should not return type defined in typedef" do
+      definition_names = definitions.map(&:name)
+      expect(definition_names).not_to include("rb_event_flag_t")
+    end
+
     context "rb_num2int_inline" do
       subject { definitions.find { |d| d.name == "rb_num2int_inline" } }
 

_tools/ruby_h_to_go/spec/spec_helper.rb

@@ -111,3 +111,8 @@
     meta[:aggregate_failures] = true
   end
 end
+
+# @return [String]
+def project_root_dir
+  File.expand_path("../../..", __dir__)
+end