protobuf_descriptor 1.0.0 → 1.1.0

data/lib/protobuf_descriptor/message_descriptor.rb

@@ -1,94 +1,11 @@
-require "protobuf_descriptor/enum_descriptor"
-require "protobuf_descriptor/has_parent"
-require "protobuf_descriptor/named_child"
-require "protobuf_descriptor/named_collection"
-
-require "active_support"
-require "active_support/core_ext/module/delegation"
-
 class ProtobufDescriptor
   # Describes a message type.
   #
   # See DescriptorProto[https://code.google.com/p/protobuf/source/browse/trunk/src/google/protobuf/descriptor.proto#84]
   class MessageDescriptor
-    # Describes a field within a message.
-    #
-    # See FieldDescriptorProto[https://code.google.com/p/protobuf/source/browse/trunk/src/google/protobuf/descriptor.proto#103]
-    class FieldDescriptor
-      # The parent {ProtobufDescriptor::MessageDescriptor}
-      attr_reader :parent
-      # The +FieldDescriptorProto+ this +FieldDescriptor+ is wrapping.
-      attr_reader :field_descriptor_proto
-
-      def initialize(parent, field_descriptor_proto)
-        @parent = parent
-        @field_descriptor_proto = field_descriptor_proto
-      end
-
-      # The +FieldOptions+ for this field
-      def options
-        field_descriptor_proto.options
-      end
-
-      # Default value for this field.
-      # * For numeric types, contains the original text representation of the
-      #   value.
-      # * For booleans, "true" or "false".
-      # * For strings, contains the default text contents (not escaped in any
-      #   way).
-      # * For bytes, contains the C escaped value.  All bytes >= 128 are
-      #   escaped.
-      def default_value
-        field_descriptor_proto.default_value
-      end
-
-      # For extensions, this is the name of the type being extended.  It is
-      # resolved in the same manner as type_name.
-      def extendee
-        field_descriptor_proto.extendee
-      end
-
-      # For message and enum types, this is the name of the type.  If the name
-      # starts with a '.', it is fully-qualified.  Otherwise, C++-like scoping
-      # rules are used to find the type (i.e. first the nested types within this
-      # message are searched, then within the parent, on up to the root
-      # namespace).
-      #
-      # Note: the protocol buffer compiler always emits the fully qualified name!
-      def type_name
-        field_descriptor_proto.type_name
-      end
-
-      # Whether the field is optional/required/repeated.
-      def label
-        field_descriptor_proto.label
-      end
-
-      # The tag number of this field.
-      def number
-        field_descriptor_proto.number
-      end
-
-      # The name of this field.
-      def name
-        field_descriptor_proto.name
-      end
-
-      include ProtobufDescriptor::HasParent
-
-      # If type_name is set, this need not be set.  If both this and type_name
-      # are set, this must be either TYPE_ENUM or TYPE_MESSAGE.
-      def field_type
-        field_descriptor_proto.type
-      end
-
-      # Resolves the field's +type_name+, returning the
-      # {ProtobufDescriptor::MessageDescriptor} or
-      # {ProtobufDescriptor::EnumDescriptor} that this field will represent.
-      def resolve_type
-        protobuf_descriptor.resolve_type_name(self.type_name, self.parent)
-      end
-    end
+    include ProtobufDescriptor::HasParent
+    include ProtobufDescriptor::NamedChild
+    include ProtobufDescriptor::HasChildren
 
     # The containing {ProtobufDescriptor::FileDescriptor}
     # or {ProtobufDescriptor::MessageDescriptor} that
@@ -101,29 +18,43 @@ class ProtobufDescriptor
     # The messages that are defined at the top level of this message, as a
     # NamedCollection of {ProtobufDescriptor::MessageDescriptor}
     attr_reader :nested_type
+    alias_method :nested_types, :nested_type
+    alias_method :messages, :nested_type
 
     # The enums that are defined at the top level of this message, as a
     # NamedCollection of {ProtobufDescriptor::EnumDescriptor}
     attr_reader :enum_type
+    alias_method :enum_types, :enum_type
+    alias_method :enums, :enum_type
 
     # The fields of this message, as a NamedCollection of
     # {ProtobufDescriptor::MessageDescriptor::FieldDescriptor}
     attr_reader :field
+    alias_method :fields, :field
+
+    # Field index is hard-coded since these are a bit annoying to grab
+    # consistently with the different protocol buffer implementations.
+    self.register_children(:field, 2)
+    self.register_children(:nested_type, 3)
+    self.register_children(:enum_type, 4)
 
     def initialize(parent, message_descriptor_proto)
       @parent = parent
       @message_descriptor_proto = message_descriptor_proto
+
       @nested_type = ProtobufDescriptor::NamedCollection.new(
           message_descriptor_proto.nested_type.map { |m|
               ProtobufDescriptor::MessageDescriptor.new(self, m)
           })
+
       @enum_type = ProtobufDescriptor::NamedCollection.new(
           message_descriptor_proto.enum_type.map { |m|
               ProtobufDescriptor::EnumDescriptor.new(self, m)
           })
+
       @field = ProtobufDescriptor::NamedCollection.new(
           message_descriptor_proto.field.map { |m|
-              ProtobufDescriptor::MessageDescriptor::FieldDescriptor.new(self, m)
+              ProtobufDescriptor::FieldDescriptor.new(self, m)
           })
     end
 
@@ -136,32 +67,17 @@ class ProtobufDescriptor
     def extension_range
       message_descriptor_proto.extension_range
     end
+    alias_method :extension_ranges, :extension_range
 
     # The extensions defined for this message
     def extension
       message_descriptor_proto.extension
     end
+    alias_method :extensions, :extension
 
     # The name of the message
     def name
       message_descriptor_proto.name
     end
-
-    alias_method :fields, :field
-    alias_method :extensions, :extension
-    alias_method :nested_types, :nested_type
-    alias_method :messages, :nested_type
-    alias_method :enum_types, :enum_type
-    alias_method :enums, :enum_type
-    alias_method :extension_ranges, :extension_range
-
-    include ProtobufDescriptor::NamedChild
-
-    # Set of all top-level messages ahnd enums that are defined within this
-    # message.
-    def children
-      @children ||= ProtobufDescriptor::NamedCollection.new(
-          @nested_type.collection + @enum_type.collection)
-    end
   end
 end

data/lib/protobuf_descriptor/method_descriptor.rb

@@ -0,0 +1,54 @@
+class ProtobufDescriptor
+  # Describes a method of a service.
+  #
+  # See MethodDescriptorProto[https://code.google.com/p/protobuf/source/browse/trunk/src/google/protobuf/descriptor.proto#196]
+  class MethodDescriptor
+    include ProtobufDescriptor::HasParent
+
+    # The parent {ProtobufDescriptor::ServiceDescriptor}
+    attr_reader :parent
+
+    # The +MethodDescriptorProto+ this +MethodDescriptor+ is wrapping
+    attr_reader :method_descriptor_proto
+
+    def initialize(parent, method_descriptor_proto)
+      @parent = parent
+      @method_descriptor_proto = method_descriptor_proto
+    end
+
+    # The name of the service method
+    def name
+      method_descriptor_proto.name
+    end
+
+    # The +MethodOptions+ for the service method
+    def options
+      method_descriptor_proto.options
+    end
+
+    # Input type name for the service method. This is resolved in the same way
+    # as FieldDescriptorProto.type_name, but must refer to a message type.
+    def input_type_name
+      method_descriptor_proto.input_type
+    end
+
+    # Output type name for the service method. This is resolved in the same way
+    # as FieldDescriptorProto.type_name, but must refer to a message type.
+    def output_type_name
+      method_descriptor_proto.output_type
+    end
+
+    # Resolves the method's +input_type_name+, returning the
+    # {ProtobufDescriptor::MessageDescriptor} that this method receives.
+    def resolve_input_type
+      protobuf_descriptor.resolve_type_name(input_type_name, file_descriptor)
+    end
+
+    # Resolves the method's +output_type_name+, returning the
+    # {ProtobufDescriptor::MessageDescriptor} that this method
+    # returns.
+    def resolve_output_type
+      protobuf_descriptor.resolve_type_name(output_type_name, file_descriptor)
+    end
+  end
+end

data/lib/protobuf_descriptor/named_child.rb

@@ -1,6 +1,8 @@
 class ProtobufDescriptor
   # A mixin module that adds tasty fully qualified name methods to objects that
   # have a name and a parent.
+  #
+  # Classes including this module *must* respond_to `name` and `parent`
   module NamedChild
     def fully_qualified_name
       return "#{parent.fully_qualified_name}.#{self.name}"
@@ -17,5 +19,10 @@ class ProtobufDescriptor
     def fully_qualified_ruby_name
       return "#{parent.fully_qualified_ruby_name}::#{self.name}"
     end
+
+    def inspect
+      oid = (object_id << 1)
+      return "#<%s:0x%x %s>" % [self.class, oid, self.fully_qualified_name]
+    end
   end
 end

data/lib/protobuf_descriptor/service_descriptor.rb

@@ -1,66 +1,11 @@
-require "protobuf_descriptor/named_collection"
-require "protobuf_descriptor/has_parent"
-
-require "active_support"
-require "active_support/core_ext/module/delegation"
-
 class ProtobufDescriptor
   # Describes a service.
   #
   # See ServiceDescriptorProto[https://code.google.com/p/protobuf/source/browse/trunk/src/google/protobuf/descriptor.proto#188]
   class ServiceDescriptor
-    # Describes a method of a service.
-    #
-    # See MethodDescriptorProto[https://code.google.com/p/protobuf/source/browse/trunk/src/google/protobuf/descriptor.proto#196]
-    class MethodDescriptor
-      # The parent {ProtobufDescriptor::ServiceDescriptor}
-      attr_reader :parent
-
-      # The +MethodDescriptorProto+ this +MethodDescriptor+ is wrapping
-      attr_reader :method_descriptor_proto
-
-      def initialize(parent, method_descriptor_proto)
-        @parent = parent
-        @method_descriptor_proto = method_descriptor_proto
-      end
-
-      include ProtobufDescriptor::HasParent
-
-      # The name of the service method
-      def name
-        method_descriptor_proto.name
-      end
-
-      # The +MethodOptions+ for the service method
-      def options
-        method_descriptor_proto.options
-      end
-
-      # Input type name for the service method. This is resolved in the same way
-      # as FieldDescriptorProto.type_name, but must refer to a message type.
-      def input_type_name
-        method_descriptor_proto.input_type
-      end
-
-      # Output type name for the service method. This is resolved in the same way
-      # as FieldDescriptorProto.type_name, but must refer to a message type.
-      def output_type_name
-        method_descriptor_proto.output_type
-      end
-
-      # Resolves the method's +input_type_name+, returning the
-      # {ProtobufDescriptor::MessageDescriptor} that this method receives.
-      def resolve_input_type
-        protobuf_descriptor.resolve_type_name(input_type_name, file_descriptor)
-      end
-
-      # Resolves the method's +output_type_name+, returning the
-      # {ProtobufDescriptor::MessageDescriptor} that this method
-      # returns.
-      def resolve_output_type
-        protobuf_descriptor.resolve_type_name(output_type_name, file_descriptor)
-      end
-    end
+    include ProtobufDescriptor::HasParent
+    include ProtobufDescriptor::NamedChild
+    include ProtobufDescriptor::HasChildren
 
     # The parent {ProtobufDescriptor::FileDescriptor}
     attr_reader :parent
@@ -71,23 +16,26 @@ class ProtobufDescriptor
     # Set of methods contained within this service, as a NamedCollection of
     # {ProtobufDescriptor::ServiceDescriptor::MethodDescriptor MethodDescriptors}
     attr_reader :method
+    alias_method :methods, :method
+
+    # Field index is hard-coded since these are a bit annoying to grab
+    # consistently with the different protocol buffer implementations.
+    self.register_children(:method, 2)
 
     def initialize(parent, service_descriptor_proto)
       @parent = parent
       @service_descriptor_proto = service_descriptor_proto
       @method = ProtobufDescriptor::NamedCollection.new(
           service_descriptor_proto.method.map { |m|
-              ProtobufDescriptor::ServiceDescriptor::MethodDescriptor.new(self, m)
+              ProtobufDescriptor::MethodDescriptor.new(self, m)
           })
     end
 
-
     # The name of the service
     def name; service_descriptor_proto.name; end
 
     # The +ServiceOptions+ for this service.
     def options; service_descriptor_proto.options; end
 
-    alias_method :methods, :method
   end
 end

data/lib/protobuf_descriptor/version.rb

@@ -1,4 +1,4 @@
 class ProtobufDescriptor
   # protobuf_descriptor version
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/protobuf_descriptor.rb

@@ -1,7 +1,4 @@
 require "protobuf_descriptor/version"
-require "protobuf_descriptor/file_descriptor"
-require "protobuf_descriptor/message_descriptor"
-require "protobuf_descriptor/named_collection"
 
 require "stringio"
 require "protobuf"
@@ -11,6 +8,19 @@ require "protobuf/descriptors/google/protobuf/descriptor.pb.rb"
 # {+FileDescriptorSet+}[https://code.google.com/p/protobuf/source/browse/trunk/src/google/protobuf/descriptor.proto#49]
 # proto. This acts as the root from which name resolution occurs.
 class ProtobufDescriptor
+  autoload :EnumDescriptor, "protobuf_descriptor/enum_descriptor"
+  autoload :EnumValueDescriptor, "protobuf_descriptor/enum_value_descriptor"
+  autoload :FieldDescriptor, "protobuf_descriptor/field_descriptor"
+  autoload :FileDescriptor, "protobuf_descriptor/file_descriptor"
+  autoload :MethodDescriptor, "protobuf_descriptor/method_descriptor"
+  autoload :MessageDescriptor, "protobuf_descriptor/message_descriptor"
+  autoload :ServiceDescriptor, "protobuf_descriptor/service_descriptor"
+
+  autoload :HasParent, "protobuf_descriptor/has_parent"
+  autoload :HasChildren, "protobuf_descriptor/has_children"
+  autoload :NamedChild, "protobuf_descriptor/named_child"
+  autoload :NamedCollection, "protobuf_descriptor/named_collection"
+
   # Decode a ProtobufDescriptor from bytes
   #
   #   ProtobufDescriptor.decode(File.read("descriptor.desc"))
@@ -56,10 +66,10 @@ class ProtobufDescriptor
     seeds = files.to_a.dup
     children = Set.new
     while !seeds.empty?
-      seeds.pop.children.each do |child|
+      seeds.pop.named_children.each do |child|
         children << child
 
-        seeds << child if child.respond_to?(:children)
+        seeds << child if child.is_a?(HasChildren)
       end
     end
     children
@@ -93,4 +103,9 @@ class ProtobufDescriptor
   def [](index)
     return files[index]
   end
+
+  # Returns whether all files have source code info attached
+  def has_source_code_info?
+    return files.all? { |f| f.has_source_code_info? }
+  end
 end

data/protobuf_descriptor.gemspec

@@ -18,10 +18,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'protobuf', '~> 3.0.0'
-  gem.add_dependency 'activesupport', '>= 3.0.0'
+  gem.add_dependency 'rubyzip', '~> 1.1.3'
 
+  gem.add_development_dependency 'rake', '~> 10.3'
   gem.add_development_dependency 'pry', '~> 0.9.12.6'
-  gem.add_development_dependency 'rspec', '~> 2.4'
+  gem.add_development_dependency 'rspec', '~> 3.0.0.beta2'
   gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
   gem.add_development_dependency 'yard', '~> 0.8'
 end

data/spec/field_descriptor_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe ProtobufDescriptor::MessageDescriptor::FieldDescriptor do
+describe ProtobufDescriptor::FieldDescriptor do
   describe "#type_name" do
     it "is sane" do
       with_descriptor("single_file_test") do |descriptor|

data/spec/file_descriptor_spec.rb

@@ -4,7 +4,6 @@ describe ProtobufDescriptor::FileDescriptor do
   describe "#files" do
     it "has the right size" do
       with_descriptor("single_file_test") do |descriptor|
-        expect(descriptor.files).to have(1).items
         expect(descriptor.files.size).to eq(1)
       end
     end

data/spec/method_descriptor_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe ProtobufDescriptor::ServiceDescriptor::MethodDescriptor do
+describe ProtobufDescriptor::MethodDescriptor do
   it "is sane" do
     with_descriptor("service_rpc_test") do |descriptor|
       file_descriptor = descriptor["wearabouts_api/user"]

data/spec/protobuf_descriptor_spec.rb

@@ -45,7 +45,7 @@ describe ProtobufDescriptor do
 
           descriptor = ProtobufDescriptor.load(f.path)
 
-          expect(descriptor.files).to have(1).item
+          expect(descriptor.files.size).to eq(1)
         end
       end
     end
@@ -56,7 +56,7 @@ describe ProtobufDescriptor do
 
           descriptor = ProtobufDescriptor.decode_from(f)
 
-          expect(descriptor.files).to have(1).item
+          expect(descriptor.files.size).to eq(1)
         end
       end
     end
@@ -67,7 +67,7 @@ describe ProtobufDescriptor do
 
           descriptor = ProtobufDescriptor.decode(f.read)
 
-          expect(descriptor.files).to have(1).item
+          expect(descriptor.files.size).to eq(1)
         end
       end
     end

data/spec/protoc_generator_spec.rb

@@ -5,16 +5,13 @@ describe "ProtocJavaCompiler" do
   # Compile the contents of the generator_tests proto dir, and then assert
   # everything is where it should be.
   it "computes fully-qualified class names correctly" do
-    Dir.mktmpdir do |dir|
-      with_descriptor("generator_test", plugin: "java", plugin_out: dir) do |descriptor|
-        generated_classes = ghetto_parse_java_package(dir)
+    with_descriptor("generator_test") do |descriptor|
+      generated_classes = ghetto_parse_java_package(find_generated_files("generator_test", :java))
 
-        children = descriptor.all_descendants
-
-        children.each do |child|
-          expect(child.fully_qualified_java_name).to eq(generated_classes[child.name])
-        end
-      end
+      children = descriptor.all_descendants.map { |child|
+        [child.name, child.fully_qualified_java_name]
+      }
+      expect(children).to contain_exactly(*generated_classes.to_a)
     end
   end
 end

data/spec/protos/custom_options/custom_options.proto

@@ -0,0 +1,53 @@
+import "google/protobuf/descriptor.proto";
+
+extend google.protobuf.FileOptions {
+  optional string my_file_option = 50000;
+}
+extend google.protobuf.MessageOptions {
+  optional int32 my_message_option = 50001;
+}
+extend google.protobuf.FieldOptions {
+  optional float my_field_option = 50002;
+}
+extend google.protobuf.EnumOptions {
+  optional bool my_enum_option = 50003;
+}
+extend google.protobuf.EnumValueOptions {
+  optional uint32 my_enum_value_option = 50004;
+}
+extend google.protobuf.ServiceOptions {
+  optional MyEnum my_service_option = 50005;
+}
+extend google.protobuf.MethodOptions {
+  optional MyMessage my_method_option = 50006;
+}
+
+option (my_file_option) = "Hello world!";
+
+message MyMessage {
+  option (my_message_option) = 1234;
+
+  optional int32 foo = 1 [(my_field_option) = 4.5];
+  optional string bar = 2;
+}
+
+enum MyEnum {
+  option (my_enum_option) = true;
+
+  FOO = 1 [(my_enum_value_option) = 321];
+  BAR = 2;
+}
+
+message RequestType {}
+message ResponseType {}
+
+service MyService {
+  option (my_service_option) = FOO;
+
+  rpc MyMethod(RequestType) returns(ResponseType) {
+      // Note:  my_method_option has type MyMessage.  We can set each field
+    //   within it using a separate "option" line.
+    option (my_method_option).foo = 567;
+    option (my_method_option).bar = "Some string";
+  }
+}