protobuf_transpiler 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15fbfbb54281b38de5cfd351b52541f39ae5e242af25db502bc130c84bddf6d3
-  data.tar.gz: 265c16629afd53e58cc88833c72cf7cf69a98c88b5cc51917bf732f04b4bbb27
+  metadata.gz: 5ae36cca017f8dc92d448d3312284e2462934a87b522675684d3e987e53e1029
+  data.tar.gz: 781b649dd1a6dcace6b68e9fea32efb5699c63008af53106f4a4b081b0b103ea
 SHA512:
-  metadata.gz: d3103191a91d091d7e43afba1ca24a009c62a239960b238d41b474fe52e3958be6f138f3dbcac12d5abf0f8a6fad4d469a1886642a27a0763c557f3b519926b8
-  data.tar.gz: '0380a204e36963f651e5963b61d3d39770b3ab11aed2ee5d696371a1648ebd0c68f8e38d265ee9d9663b4597cd24e5736fc50f57dfe5177f8dc301e43f0711d3'
+  metadata.gz: f9eedd08deb9598d3d6a978e57549ae8472e8129021e3d5d7a775c301b4198633c999c376ef6356755d358530e695b056e1c0a6d08b1601a650ae6d60c90dd15
+  data.tar.gz: 4fcd0154d6e585a43331d65e6077689abeacd7abafeabf4f6689c65cb56aacbff99b96be5d73606ab939e2bd06e8dfa058bd60731c5696c0f2fdf55dc5137086

data/CHANGELOG.md

@@ -8,6 +8,11 @@
 ### Bug fixes
 )-->
 
+## 1.2.0 2025-04-10
+- generate task can create an initializer that allows the generated stubs to work with zeitwerk
+- added possibility to specify stubs path for generate task
+- added possibility to specify stubs path for annotate task
+
 ## 1.1.3 2025-02-28
 - remove rails versions constraints, keep only dependency
 

data/README.md

@@ -21,7 +21,7 @@ bundle
 
 ## Usage
 
-This gem provides two rake tasks, `grpc_stubs:generate` and `grpc_stubs:annotate`. `generate` transpiles all `.proto` files nested in a `public` folder looking in the `$LOAD_PATH`, putting the generated ruby stubs in `app/stubs`, respecting the inner nesting. `annotate` annotates all the generated stubs with a comment section leveraging reflection.
+This gem provides two rake tasks, `grpc_stubs:generate` and `grpc_stubs:annotate`. `generate` transpiles all `.proto` files nested in a `public` folder looking in the `$LOAD_PATH`, putting the generated ruby stubs in `app/stubs` (or a path specified by the user), respecting the inner nesting. `annotate` annotates all the generated stubs with a comment section leveraging reflection.
 
 Beware that at the moment this gem does not support nested messages definition.
 
@@ -30,9 +30,15 @@ To generate the stubs simply run:
 ```bash
 rake grpc_stubs:generate
 ```
-The task accepts two optional positional arguments, `annotate` and `keep_require` which default respectively to `'yes'` and `'no'`.
-This means that by default the `generate` task also runs the `annotate` one, and the behavior can be changed by specifying the first argument as `'no'`. Furthermore the default behavior of `generate` removes all the `require ...` generated by `grpc_tools_ruby_protoc`; if, for any reason, you may want to keep them, you need to specify the second argument as `'yes'` (which implies you need to explicitly state the first parameter, even if you want to keep the default behavior).
-Finally, following the stubs generation, the task also creates a ruby file for all the proto packages, which corresponds to the created folders in `app/stubs`, containing `require_relative` instructions to the corresponding stubs. This allows `zeitwerk` to work properly despite `grpc_tools_ruby_protoc` not respecting the naming conventions.
+The task accepts four optional positional arguments:
+- `annotate` (default: `'yes'`): This specifies whether the task `annotate` should also be run. Options are `'yes'` and `'no'`
+- `keep_require` (default: `'no'`): This specifies whether `generate` should remove all the `require ...` generated by `grpc_tools_ruby_protoc` or keep them. Options are `'yes'` and `'no'`
+- `path` (default: `'app/stubs'`): This specifies the folder in which the stubs should be generated.
+- `create_initializer` (default: `'yes'`): This specifies whether to create the file `config/initializers/protobuf_transpiler.rb`. Options are `'yes'` and `'no'`
+
+This means that by default the `generate` task also runs the `annotate` one, and the behavior can be changed by specifying the first argument as `'no'`. Furthermore, the default behavior of `generate` removes all the `require ...` generated by `grpc_tools_ruby_protoc`; if, for any reason, you may want to keep them, you need to specify the second argument as `'yes'` (which implies you need to explicitly state the first parameter, even if you want to keep the default behavior).
+Following the stubs generation, the task also creates a ruby file for all the proto packages, which corresponds to the created folders in `app/stubs`, containing `require_relative` instructions to the corresponding stubs.
+To allow `zeitwerk` to work properly despite `grpc_tools_ruby_protoc` not respecting the naming conventions, by default the task will create an initializer that requires the generated stubs and stops the specified folder from being autoloaded (if it's inside of the `app` directory).
 
 For example if you have a gem defining proto files with this structure:
 ```
@@ -61,6 +67,9 @@ To annotate generated stubs simply run:
 ```bash
 rake grpc_stubs:annotate
 ```
+
+This task has just one positional argument: `path`. It represents the folder in which the stubs were generated.
+
 As stated in [generate](#generate) this task is executed automatically unless you opt out after the generation step. Leveraging reflection, Messages and Services are inspected and a comment summary is prepended in the corresponding stub file.
 
 The annotations of messages follow these conventions:

data/lib/protobuf_transpiler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProtobufTranspiler
-  VERSION = '1.1.3'
+  VERSION = '1.2.0'
 end

data/lib/protobuf_transpiler.rb

@@ -7,26 +7,30 @@ module ProtobufTranspiler
   require_relative 'railtie'
 
   class << self
-    def generate_stubs(keep_require = false)
+    def generate_stubs(keep_require = false, path = 'app/stubs')
       paths       = $LOAD_PATH.map { |p| "#{p}/**/public/**/*.proto" }
       proto_files = Dir[*paths].join ' '
       proto_paths = proto_files
                       .split.map { |p| p.sub %r{(?<=public).*}, '' }
                       .uniq.join ' '
-      out_path    = "#{Rails.root}/app/stubs/"
+      out_path    = "#{Rails.root}/#{path}/"
       FileUtils.mkdir_p out_path
       `grpc_tools_ruby_protoc --ruby_out=#{out_path} --grpc_out=#{out_path} #{proto_files} -I #{proto_paths}`
 
       # remove possibly useless require from stub file
       unless keep_require
-        Dir['app/stubs/**/*.rb'].each do |fp|
+        Dir["#{path}/**/*.rb"].each do |fp|
           f = File.read fp
           File.write fp, (f.sub %r{\n(require.*?'\n)+}, '')
         end
       end
 
+      if path_in_app path
+        Rails.autoloaders.main.ignore "#{path}/**/*"
+      end
+
       # make zeitwerk happy
-      Dir['app/stubs/**']
+      Dir["#{path}/**"]
         .filter { |f| File.directory? f }
         .each { |dir|
           requires = Dir.chdir dir do
@@ -37,15 +41,15 @@ module ProtobufTranspiler
         }
     end
 
-    def annotate_stubs
+    def annotate_stubs path = 'app/stubs'
       require 'active_support/core_ext/string/inflections'
 
-      Dir['app/stubs/**/*.rb']
+      Dir["#{path}/**/*.rb"]
         .map { |s| File.absolute_path s }
-        .each { |f| require f }
+        .each { |f| zeitwerk_original_require f }
 
-      stubs_modules = Dir['app/stubs/*.rb']
-                        .map { |s| s.sub('app/stubs/', '') }
+      stubs_modules = Dir["#{path}/*.rb"]
+                        .map { |s| s.sub(path, '') }
                         .map { |s| s.sub '.rb', '' }
                         .uniq
                         .map { |c| Object.const_get c.camelize }
@@ -54,7 +58,8 @@ module ProtobufTranspiler
         out                       = m
                                       .constants
                                       .sort
-                                      .map { |c| m.const_get c }
+                                      .map { |c| ignore_errors(NameError) { m.const_get c } }
+                                      .filter(&:present?)
                                       .each_with_object({ messages: [], services: [] }) { |c, acc|
                                         if c.is_a? Class
                                           acc[:messages] << class_annotations(c)
@@ -62,7 +67,7 @@ module ProtobufTranspiler
                                           acc[:services] << module_annotations(c)
                                         end
                                       }
-        types_file, services_file = Dir["app/stubs/#{m.name.underscore}/*.rb"]
+        types_file, services_file = Dir["#{path}/#{m.name.underscore}/*.rb"]
                                       .sort_by { |s| s.scan('services').count }
         [types_file, services_file]
           .zip([out[:messages], out[:services]])
@@ -70,10 +75,30 @@ module ProtobufTranspiler
       end
     end
 
+    def generate_initializer stubs_path = 'app/stubs'
+      file_content = ''
+
+      if path_in_app stubs_path
+        # Ignore the path in zeitwerk
+        file_content += "Rails.autoloaders.main.ignore '#{stubs_path}/**/*'\n"
+      end
+
+      file_content += "Dir[\"\#{Rails.root}/#{stubs_path}/*\"].each { |f| require_relative f }\n"
+
+      File.write "#{Rails.root}/config/initializers/protobuf_transpiler.rb", file_content
+    end
+
     private
 
     ANNOTATE_DELIMITER = '# ===== Protobuf Annotation ====='
 
+    def path_in_app path
+      stubs_path = File.realdirpath path, Rails.root
+      app_folder = File.realdirpath 'app', Rails.root
+
+      stubs_path.start_with? app_folder
+    end
+
     def class_annotations klass
       oneof_fields, oneof_annotations = lambda do |descriptor|
         [
@@ -124,13 +149,20 @@ module ProtobufTranspiler
         end.to_s
     end
 
+    def ignore_errors(*errors, &block)
+      begin
+        block.call
+      rescue errors
+        nil
+      end
+    end
+
     def module_annotations mod
-      mod
-        .const_get('Service')
-        .rpc_descs.sort
-        .map { |_, d| "\t#{d.name}(#{d.input}): #{d.output}" }
-        .prepend(mod.name.to_s)
-        .join "\n"
+      ignore_errors(NameError, NoMethodError) { mod.const_get('Service') }
+        &.sort
+        &.map { |_, d| "\t#{d.name}(#{d.input}): #{d.output}" }
+        &.prepend(mod.name.to_s)
+        &.join "\n"
     end
 
     def annotate_file file, content

data/lib/tasks/grpc_stubs.rake

@@ -1,16 +1,19 @@
 namespace :grpc_stubs do
   desc 'Generate stubs for all .proto files (looking into entire LOAD_PATH)'
-  task :generate, [:annotate, :keep_require] do |_, args|
-    args.with_defaults annotate: :yes, keep_require: :no
+  task :generate, [:annotate, :keep_require, :path, :create_initializer] => :environment do |_, args|
+    args.with_defaults annotate: :yes, keep_require: :no, path: 'app/stubs', create_initializer: :yes
     require_relative '../protobuf_transpiler'
-    ProtobufTranspiler.generate_stubs args[:keep_require].to_sym == :yes
-    ProtobufTranspiler.annotate_stubs unless args[:annotate].to_sym == :no
+    ProtobufTranspiler.generate_stubs args[:keep_require].to_sym == :yes, args[:path]
+    ProtobufTranspiler.generate_initializer args[:path] unless args[:create_initializer].to_sym == :no
+    ProtobufTranspiler.annotate_stubs args[:path] unless args[:annotate].to_sym == :no
   end
 
   desc 'Annotate generated stubs'
-  task :annotate do
+  task :annotate, [:path, :create_initializer] => :environment do |_, args|
+    args.with_defaults path: 'app/stubs', create_initializer: :no
     require_relative '../protobuf_transpiler'
-    ProtobufTranspiler.annotate_stubs
+    ProtobufTranspiler.generate_initializer args[:path] unless args[:create_initializer].to_sym == :no
+    ProtobufTranspiler.annotate_stubs args[:path]
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protobuf_transpiler
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Moku S.r.l.
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-28 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A protobuf transpiler and annotator for Rails applications.