protobuf_transpiler 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55572283d38aaaf17ae92233d0a4e276f1f4fa969ecea798d85c838b46070605
-  data.tar.gz: a1b7299db9e0ac59d5c818b729e5515400a9f0127f18bf99cb074685d8f7fb60
+  metadata.gz: c4d91bcc62be9eb73107bf462765f913081d60f8795d3b2aa3833aa46c5e7c6d
+  data.tar.gz: 4ab88cacd593ded7f0a9280ab300531a2ca3b3f6e2a6e9d19eeff34bbdff7f50
 SHA512:
-  metadata.gz: c157a107eada279ba863e049248cfb38a8d573cb11c97fe7a92b8cf9af245f04338433845021381b9e5d2c51d880621bc82bf32a8e371a59ca0f2d4b71b19ae8
-  data.tar.gz: e9240d2f92d78141d79e993ca8fda889540a7fa14d7c72fd8556d25e35e6aebba092ac80cac9768a53989579b0d83f2f8241e9de0d7fb1a11b2b19801434b5e1
+  metadata.gz: 01a17468881fbe21a0632ef79846a01a7350f37c1ef2464909f9ff3fbe462c28067d4bfe29ff18eec18aa45b932288a694a02815141e2199b1f77c3087b00bd9
+  data.tar.gz: b429fc9270fe9a2682b514298a73d9cf2c1541ff406c18cf839c703bec91ecd04821e3c5fc016ee3f54213d6fe2c9ec17debce6c5894b7a4082aa038a94a8380

data/CHANGELOG.md

@@ -8,6 +8,16 @@
 ### Bug fixes
 )-->
 
+## 1.1.0 2023-08-21
+### New features
+- Add annotation support for:
+  - streams
+  - oneofs
+  - maps
+  - nested messages
+### Bug fixes
+- Annotate task now correctly replaces existing annotations
+
 ## 1.0.0 2023-07-24
 
 First release. Refer to [README.md](README.md) for the full documentation.

data/README.md

@@ -37,12 +37,12 @@ Finally, following the stubs generation, the task also creates a ruby file for a
 For example if you have a gem defining proto files with this structure:
 ```
  public
-    ├── mod1
-    │   └── sample1.proto
-    ├── mod2
-    │   └── sample2.proto
+ ├── mod1
+ │   └── sample1.proto
+ ├── mod2
+ │   └── sample2.proto
 ```
-you will get the follwing structure nested in `app/stubs`
+you will get the following structure nested in `app/stubs`:
 ```
 app/stubs
 ├── mod1
@@ -63,15 +63,26 @@ rake grpc_stubs:annotate
 ```
 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:
+- each message is reported with its fully qualified name
+- fields are indented in the lines following the message name and are reported as `name: type`
+- `repeated` fields are annotated with their type enclosed in brackets (`[type]`)
+- `map` fields are annotated with angular brackets: `Map<key_type, value_type>`
+- `oneof` fields are annotated with their wrapper name, then each possible variant placed on a new line, further indented and prepended with `| `.
+
 Here's an example of annotations of some messages:
 ```
 # ===== Protobuf Annotation =====
 # Test::GetJobReq
 # 	id: uint64
+#   some_oneof_wrapper:
+# 	  | alternative: string
+# 	  | another: uint64
 # Test::GetJobResp
 # 	id: uint64
 # 	name: string
 # 	surname: string
+#   notes: [string]
 # ===== Protobuf Annotation =====
 ```
 and some rpcs:
@@ -84,6 +95,7 @@ and some rpcs:
 # ===== Protobuf Annotation =====
 ```
 
+
 ## Future extensions
 - Support nested messages definition
 

data/lib/protobuf_transpiler/version.rb

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

data/lib/protobuf_transpiler.rb

@@ -12,7 +12,7 @@ module ProtobufTranspiler
       proto_paths = proto_files
                       .split.map { |p| p.sub %r{(?<=public).*}, '' }
                       .uniq.join ' '
-      out_path = "#{Rails.root}/app/stubs/"
+      out_path    = "#{Rails.root}/app/stubs/"
       FileUtils.mkdir_p out_path
       `grpc_tools_ruby_protoc --ruby_out=#{out_path} --grpc_out=#{out_path} #{proto_files} -I #{proto_paths}`
 
@@ -20,7 +20,7 @@ module ProtobufTranspiler
       unless keep_require
         Dir['app/stubs/**/*.rb'].each do |fp|
           f = File.read fp
-          File.write fp, (f.sub /\n(require.*?'\n)+/, '')
+          File.write fp, (f.sub %r{\n(require.*?'\n)+}, '')
         end
       end
 
@@ -30,7 +30,7 @@ module ProtobufTranspiler
         .each { |dir|
           requires = Dir.chdir dir do
             curr_dir = Dir.pwd.split('/').last
-            Dir['*.rb'].map { |s| "require_relative './#{curr_dir}/#{s.sub(/.rb$/, '')}'" }
+            Dir['*.rb'].map { |s| "require_relative './#{curr_dir}/#{s.sub %r{.rb$}, ''}'" }
           end
           File.write "#{dir}.rb", requires.join("\n")
         }
@@ -52,6 +52,7 @@ module ProtobufTranspiler
       stubs_modules.each do |m|
         out                       = m
                                       .constants
+                                      .sort
                                       .map { |c| m.const_get c }
                                       .each_with_object({ messages: [], services: [] }) { |c, acc|
                                         if c.is_a? Class
@@ -60,7 +61,7 @@ module ProtobufTranspiler
                                           acc[:services] << module_annotations(c)
                                         end
                                       }
-        types_file, services_file = Dir["app/stubs/#{m.name.downcase}/*.rb"]
+        types_file, services_file = Dir["app/stubs/#{m.name.underscore}/*.rb"]
                                       .sort_by { |s| s.scan('services').count }
         [types_file, services_file]
           .zip([out[:messages], out[:services]])
@@ -70,20 +71,64 @@ module ProtobufTranspiler
 
     private
 
-    ANNOTATE_DELIMITER = '===== Protobuf Annotation ====='
+    ANNOTATE_DELIMITER = '# ===== Protobuf Annotation ====='
 
-    def class_annotations c
-      c
-        .descriptor.entries.map { |d| "\t#{d.name}: #{d.type}" }
-        .prepend("#{c.name}")
-        .join "\n"
+    def class_annotations klass
+      oneof_fields, oneof_annotations = lambda do |descriptor|
+        [
+          descriptor.each_oneof
+                    .flat_map { |o| o.entries.map(&:name) },
+          descriptor.each_oneof
+                    .map { |o| ["#{o.name}:", o.entries.map { |e| "\t| #{e.name}: #{type_handler e}" }].join("\n") }
+                    .map { |s| s.gsub(%r{\t}, "\t\t").prepend("\t") + "\n" }
+        ]
+      end.call(klass.descriptor)
+
+      map_fields = lambda do |descriptor, instance|
+        descriptor.entries
+                  .map(&:name)
+                  .filter { |n| instance[n].class == Google::Protobuf::Map }
+      end.call(klass.descriptor, klass.new)
+
+      [
+        klass.name.to_s,
+        klass.constants(false).sort
+             .map { |msg| klass.const_get msg }
+             .map { |msg_class| class_annotations(msg_class) }
+             .map { |s| s.gsub(%r{\t}, "\t\t").prepend("\t") }
+             .prepend("\n"),
+        oneof_annotations,
+        klass.descriptor.entries
+             .reject{|d|oneof_fields.include? d.name}
+             .map { |d|
+               "\t#{d.name}: "+
+               type_handler(d, map_fields)
+             }
+             .join("\n"),
+        "\n"
+
+      ].join('')
     end
 
-    def module_annotations m
-      m
+    def type_handler d, map_fields = []
+        case
+        when d.is_a?(Symbol)
+          d
+        when map_fields.include?(d.name)
+          d.subtype.entries.then { |k,v| "Map<#{k.type}, #{type_handler(v)}>" }
+        when d.type == :message
+          d.subtype.msgclass.then{|t| d.label == :repeated ? "[#{t}]" : t}
+        else
+          d.type.then{|t| d.label == :repeated ? "[#{t}]" : t}
+        end.to_s
+    end
+
+    def module_annotations mod
+      mod
         .const_get('Service')
-        .rpc_descs.map { |_, d| "\t#{d.name}(#{d.input}): #{d.output}" }
-        .prepend("#{m.name}")
+        .rpc_descs.sort
+        .map { |_, d| "\t#{d.name}(#{d.input}): #{d.output}" }
+        .prepend(mod.name.to_s)
         .join "\n"
     end
 
@@ -92,13 +137,33 @@ module ProtobufTranspiler
       content     = content.join("\n").gsub(%r{^}, '# ')
       new_content = if old_content.match? ANNOTATE_DELIMITER
                       # replace annotation content
-                      old_content.sub %r{(?<=#{ANNOTATE_DELIMITER})(.|\n)*?(?=##{ANNOTATE_DELIMITER})}, "\n#{content}\n"
+                      old_content.sub %r{(?<=#{ANNOTATE_DELIMITER}\n)(.|\n)*?(?=\n#{ANNOTATE_DELIMITER})}, "\n#{content}"
                     else
                       # find first spot after comments
                       # add and fill annotation
-                      old_content.sub %r{^[^#]}, "\n# #{ANNOTATE_DELIMITER}\n#{content}\n# #{ANNOTATE_DELIMITER}\n\n"
+                      old_content.sub %r{^[^#]}, "\n#{ANNOTATE_DELIMITER}\n\n#{content}\n#{ANNOTATE_DELIMITER}\n\n"
                     end
       File.write file, new_content
     end
   end
 end
+
+class GRPC::RpcDesc::Stream
+
+  def to_s
+    "stream #{type}"
+  end
+end
+
+monkey_patch_descriptor = Module.new do
+  def each_oneof(&)
+    return super if block_given?
+
+    Enumerator.new do |y|
+      super do |d|
+        y << d
+      end
+    end
+  end
+end
+Google::Protobuf::Descriptor.prepend monkey_patch_descriptor

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protobuf_transpiler
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Moku S.r.l.
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2023-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf