protobuf_descriptor 0.1.0

data/lib/protobuf_descriptor/service_descriptor.rb

@@ -0,0 +1,94 @@
+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 ServiceDescriptor[../ServiceDescriptor.html]
+      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
+      # MessageDescriptor[link:MessageDescriptor.html] 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
+      # MessageDescriptor[link:MessageDescriptor.html] that this method
+      # returns.
+      def resolve_output_type
+        protobuf_descriptor.resolve_type_name(output_type_name, file_descriptor)
+      end
+    end
+
+    # The parent FileDescriptor[FileDescriptor.html]
+    attr_reader :parent
+
+    # The +ServiceDescriptorProto+ this +ServiceDescriptor+ is wrapping
+    attr_reader :service_descriptor_proto
+
+    # Set of methods contained within this service, as a NamedCollection of
+    # MethodDescriptor[link:ServiceDescriptor/MethodDescriptor.html]
+    attr_reader :method
+
+    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)
+          })
+    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

@@ -0,0 +1,4 @@
+class ProtobufDescriptor
+  # protobuf_descriptor version
+  VERSION = "0.1.0"
+end

data/lib/protobuf_descriptor.rb

@@ -0,0 +1,95 @@
+require "protobuf_descriptor/version"
+require "protobuf_descriptor/file_descriptor"
+require "protobuf_descriptor/message_descriptor"
+require "protobuf_descriptor/named_collection"
+
+require "stringio"
+require "protobuf"
+require "protobuf/descriptors/google/protobuf/descriptor.pb.rb"
+
+# A wrapper for the
+# {+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
+  # Decode a ProtobufDescriptor from bytes
+  #
+  #   ProtobufDescriptor.decode(File.read("descriptor.desc"))
+  def self.decode(bytes)
+    return self.decode_from(::StringIO.new(bytes))
+  end
+
+  # Decode a ProtobufDescriptor from a readable stream
+  #
+  #   ProtobufDescriptor.decode_from(File.open("descriptor.desc"))
+  def self.decode_from(stream)
+    return self.new(stream)
+  end
+
+  # Loads a ProtobufDescriptor from a file
+  #
+  #   ProtobufDescriptor.load("descriptor.desc")
+  def self.load(path)
+    return self.decode_from(File.open(path))
+  end
+
+  # Raw FileDescriptorSet protocol buffer
+  attr_reader :descriptor_set
+  # Set of .proto files that are contained within the descriptor set, as a NamedCollection of FileDescriptors[link:ProtobufDescriptor/FileDescriptor.html]
+  attr_reader :file
+
+  def initialize(stream)
+    @descriptor_set = Google::Protobuf::FileDescriptorSet.new.decode_from(stream)
+    @file = ProtobufDescriptor::NamedCollection.new(@descriptor_set.file.map { |f| ProtobufDescriptor::FileDescriptor.new(self, f) }) do |name, member|
+      member.name == name || member.name == "#{name}.proto"
+    end
+  end
+
+  alias_method :files, :file
+
+  # Returns all the named descendants of this descriptor set, basically every
+  # defined MessageDescriptor[link:ProtobufDescriptor/MessageDescriptor.html],
+  # EnumDescriptor[link:ProtobufDescriptor/EnumDescriptor.html], and
+  # ServiceDescriptor[link:ProtobufDescriptor/ServiceDescriptor] referenced
+  # in this set of proto files.
+  def all_descendants
+    seeds = files.to_a.dup
+    children = Set.new
+    while !seeds.empty?
+      seeds.pop.children.each do |child|
+        children << child
+
+        seeds << child if child.respond_to?(:children)
+      end
+    end
+    children
+  end
+
+  # Finds the descriptor corresponding to a given type name. +type_name+ can
+  # either be a fully qualified name (with a leading "."), or a relative name,
+  # in which case +relative_to+ must either be a descriptor or a fully qualified
+  # name that the relative name is resolved relative to.
+  def resolve_type_name(type_name, relative_to=nil)
+    if type_name.start_with?('.')
+      all_descendants.find { |descendant|
+        descendant.fully_qualified_name == type_name
+      }
+    else
+      raise "Must provide a relative path!" unless relative_to
+
+      relative_to = relative_to.fully_qualified_name if relative_to.respond_to? :fully_qualified_name
+      parents = relative_to.split('.')
+
+      # The first element is the empty string, which is the root.
+      while parents.size > 1
+        type = resolve_type_name("#{parents.join('.')}.#{type_name}")
+        return type if type
+        parents.pop
+      end
+    end
+  end
+
+  # Shorthand for accessing files
+  def [](index)
+    return files[index]
+  end
+end

data/protobuf_descriptor.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/protobuf_descriptor/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "protobuf_descriptor"
+  gem.version       = ProtobufDescriptor::VERSION
+  gem.summary       = %q{Protocol Buffer file descriptor parser}
+  gem.description   = %q{Wraps the protobuf FileDescriptorSet messages with happy features like type name resolution and the like.}
+  gem.license       = "MIT"
+  gem.authors       = ["Hsiu-Fan Wang"]
+  gem.email         = "hfwang@porkbuns.net"
+  gem.homepage      = "https://github.com/hfwang/protobuf_descriptor"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'protobuf', '~> 3.0.0'
+  gem.add_dependency 'active_support', '>= 3.0'
+
+  gem.add_development_dependency 'pry', '~> 0.9.12.6'
+  gem.add_development_dependency 'rspec', '~> 2.4'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'yard', '~> 0.8'
+end

data/spec/enum_descriptor_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe ProtobufDescriptor::EnumDescriptor do
+  describe "#fully_qualified_name" do
+    it "handles top-level enums" do
+      with_descriptor("single_file_test") do |descriptor|
+        expect(descriptor[:single_file].enum_types[:UnnestedEnum].fully_qualified_name).to eq(".porkbuns.UnnestedEnum")
+      end
+    end
+
+    it "handles nested enums" do
+      with_descriptor("single_file_test") do |descriptor|
+        expect(descriptor[:single_file].message_types[:FieldOptions].enum_types[:CType].fully_qualified_name).to eq(".porkbuns.FieldOptions.CType")
+      end
+    end
+  end
+
+  describe "#fully_qualified_java_name" do
+    it "handles top-level enums" do
+      with_descriptor("single_file_test") do |descriptor|
+        expect(descriptor[:single_file].enum_types[:UnnestedEnum].fully_qualified_java_name).to eq("porkbuns.SingleFile.UnnestedEnum")
+      end
+    end
+
+    it "handles nested enums" do
+      with_descriptor("single_file_test") do |descriptor|
+        expect(descriptor[:single_file].message_types[:FieldOptions].enum_types[:CType].fully_qualified_java_name).to eq("porkbuns.SingleFile.FieldOptions.CType")
+      end
+    end
+
+    it "handles java_outer_classname option" do
+      with_descriptor("service_rpc_test") do |descriptor|
+        name = descriptor["wearabouts_api/outer_class_proto"].enum_types[:IconEnum].fully_qualified_java_name
+        expect(name).to eq("us.wearabouts.chatabout.outer.OuterClassName.IconEnum")
+      end
+    end
+
+    it "handles java_multiple_files option" do
+      with_descriptor("service_rpc_test") do |descriptor|
+        name = descriptor["wearabouts_api/multiple_files"].enum_types[:IconEnum].fully_qualified_java_name
+        expect(name).to eq("us.wearabouts.chatabout.multiple.IconEnum")
+      end
+    end
+  end
+end

data/spec/field_descriptor_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe ProtobufDescriptor::MessageDescriptor::FieldDescriptor do
+  describe "#type_name" do
+    it "is sane" do
+      with_descriptor("single_file_test") do |descriptor|
+        message_descriptor = descriptor[:single_file].messages[:FieldOptions]
+        field_descriptor = message_descriptor.fields[:ctype]
+
+        expect(field_descriptor.field_type).to eq(Google::Protobuf::FieldDescriptorProto::Type::TYPE_ENUM)
+        expect(field_descriptor.type_name).to eq(".porkbuns.FieldOptions.CType")
+      end
+    end
+  end
+
+  it "#resolve_type resolves a field's type name" do
+    with_descriptor("single_file_test") do |descriptor|
+      message_descriptor = descriptor[:single_file].messages[:FieldOptions]
+      field_descriptor = message_descriptor.fields[:ctype]
+
+      expect(field_descriptor.resolve_type).to eq(message_descriptor.enums[:CType])
+    end
+  end
+end

data/spec/file_descriptor_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+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
+
+    describe "#[]" do
+      it "handles numeric index" do
+        with_descriptor("service_rpc_test") do |descriptor|
+          expect(descriptor.files[0]).to eq(descriptor.files.first)
+        end
+      end
+
+      it "handles lookup by basename" do
+        with_descriptor("service_rpc_test") do |descriptor|
+          expect(descriptor.files["wearabouts_api/user"].name).to eq("wearabouts_api/user.proto")
+        end
+      end
+
+      it "handles lookup by filename" do
+        with_descriptor("service_rpc_test") do |descriptor|
+          expect(descriptor.files["wearabouts_api/user.proto"].name).to eq("wearabouts_api/user.proto")
+        end
+      end
+
+      it "returns nil if not found" do
+        with_descriptor("service_rpc_test") do |descriptor|
+          expect(descriptor.files["wearabouts_api/userblah"]).to be_nil
+        end
+      end
+    end
+  end
+
+  describe "#java_package" do
+    it "handles java_package option" do
+      with_descriptor("service_rpc_test") do |descriptor|
+        expect(descriptor.files[:wearabouts_pb].java_package).to eq("us.wearabouts.chatabout.proto")
+      end
+    end
+
+    it "defaults to package if no java_package specified" do
+      with_descriptor("single_file_test") do |descriptor|
+        expect(descriptor.files[:single_file].java_package).to eq("porkbuns")
+      end
+    end
+  end
+end

data/spec/message_descriptor_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe ProtobufDescriptor::MessageDescriptor do
+  describe "#fully_qualified_name" do
+    it "handles top-level messages" do
+      with_descriptor("single_file_test") do |descriptor|
+        expect(descriptor[:single_file].message_types[:FieldOptions].fully_qualified_name).to eq(".porkbuns.FieldOptions")
+      end
+    end
+
+    it "handles nested messages" do
+      with_descriptor("service_rpc_test") do |descriptor|
+        expect(descriptor[:wearabouts_pb].message_types[:UserProto].nested_type[:UserDetails].fully_qualified_name).to eq(".WearaboutsPb.UserProto.UserDetails")
+      end
+    end
+  end
+
+  describe "#fully_qualified_java_name" do
+    it "handles top-level messages" do
+      with_descriptor("single_file_test") do |descriptor|
+        expect(descriptor[:single_file].message_types[:FieldOptions].fully_qualified_java_name).to eq("porkbuns.SingleFile.FieldOptions")
+      end
+    end
+
+    it "handles nested messages" do
+      with_descriptor("service_rpc_test") do |descriptor|
+        expect(descriptor[:wearabouts_pb].message_types[:UserProto].nested_type[:UserDetails].fully_qualified_java_name).to eq("us.wearabouts.chatabout.proto.WearaboutsPb.UserProto.UserDetails")
+      end
+    end
+
+    it "handles java_outer_classname option" do
+      with_descriptor("service_rpc_test") do |descriptor|
+        expect(descriptor["wearabouts_api/outer_class_proto"].message_types[:Icon].fully_qualified_java_name).to eq("us.wearabouts.chatabout.outer.OuterClassName.Icon")
+      end
+    end
+
+    it "handles java_multiple_files option" do
+      with_descriptor("service_rpc_test") do |descriptor|
+        expect(descriptor["wearabouts_api/multiple_files"].message_types[:Icon].fully_qualified_java_name).to eq("us.wearabouts.chatabout.multiple.Icon")
+      end
+    end
+  end
+end

data/spec/method_descriptor_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe ProtobufDescriptor::ServiceDescriptor::MethodDescriptor do
+  it "is sane" do
+    with_descriptor("service_rpc_test") do |descriptor|
+      file_descriptor = descriptor["wearabouts_api/user"]
+      service_descriptor = file_descriptor.services[:UserService]
+      method_descriptor = service_descriptor.methods[:Authenticate]
+
+      expect(method_descriptor.input_type_name).to eq(".WearaboutsApi.User.AuthenticateRequest")
+      expect(method_descriptor.output_type_name).to eq(".WearaboutsApi.User.AuthenticateResponse")
+
+      expect(method_descriptor.resolve_input_type).to eq(file_descriptor.messages[:AuthenticateRequest])
+      expect(method_descriptor.resolve_output_type).to eq(file_descriptor.messages[:AuthenticateResponse])
+    end
+  end
+end

data/spec/protobuf_descriptor_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+describe ProtobufDescriptor do
+  it "should have a VERSION constant" do
+    expect(ProtobufDescriptor::VERSION).not_to be_empty
+  end
+
+  describe "#resolve_type_name" do
+    it "should handle fully qualified names" do
+      with_descriptor("single_file_test") do |descriptor|
+        expect(descriptor.resolve_type_name(".porkbuns.UnnestedEnum")).to eq(descriptor[:single_file].enums[:UnnestedEnum])
+        expect(descriptor.resolve_type_name(".porkbuns.FieldOptions")).to eq(descriptor[:single_file].messages[:FieldOptions])
+        expect(descriptor.resolve_type_name(".porkbuns.FieldOptions.CType")).to eq(descriptor[:single_file].messages[:FieldOptions].enums[:CType])
+      end
+    end
+
+    it "should handle relative names" do
+      with_descriptor("single_file_test") do |descriptor|
+        expect(descriptor.resolve_type_name("UnnestedEnum", ".porkbuns")).to eq(descriptor[:single_file].enums[:UnnestedEnum])
+        expect(descriptor.resolve_type_name("FieldOptions", ".porkbuns")).to eq(descriptor[:single_file].messages[:FieldOptions])
+        expect(descriptor.resolve_type_name("CType", ".porkbuns.FieldOptions")).to eq(descriptor[:single_file].messages[:FieldOptions].enums[:CType])
+      end
+    end
+
+    it "should allow the relative_to argument to be a descriptor object" do
+      with_descriptor("single_file_test") do |descriptor|
+        file_descriptor = descriptor[:single_file]
+        expect(descriptor.resolve_type_name("UnnestedEnum", file_descriptor)).to eq(file_descriptor.enums[:UnnestedEnum])
+        expect(descriptor.resolve_type_name("FieldOptions", file_descriptor)).to eq(file_descriptor.messages[:FieldOptions])
+        expect(descriptor.resolve_type_name("CType", file_descriptor.messages[:FieldOptions])).to eq(file_descriptor.messages[:FieldOptions].enums[:CType])
+      end
+    end
+
+    it "should backtrack when using relative names" do
+      with_descriptor("single_file_test") do |descriptor|
+        expect(descriptor.resolve_type_name("UnnestedEnum", ".porkbuns.FieldOptions.CType")).to eq(descriptor[:single_file].enums[:UnnestedEnum])
+      end
+    end
+  end
+
+  describe "Deserialization" do
+    describe "#load" do
+      it "should load the file" do
+        with_descriptor_file("single_file_test") do |f|
+
+          descriptor = ProtobufDescriptor.load(f.path)
+
+          expect(descriptor.files).to have(1).item
+        end
+      end
+    end
+
+    describe "#decode_from" do
+      it "should load the file" do
+        with_descriptor_file("single_file_test") do |f|
+
+          descriptor = ProtobufDescriptor.decode_from(f)
+
+          expect(descriptor.files).to have(1).item
+        end
+      end
+    end
+
+    describe "#decode" do
+      it "should load the file" do
+        with_descriptor_file("single_file_test") do |f|
+
+          descriptor = ProtobufDescriptor.decode(f.read)
+
+          expect(descriptor.files).to have(1).item
+        end
+      end
+    end
+  end
+end

data/spec/protoc_generator_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+require "tmpdir"
+
+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)
+
+        children = descriptor.all_descendants
+
+        children.each do |child|
+          expect(child.fully_qualified_java_name).to eq(generated_classes[child.name])
+        end
+      end
+    end
+  end
+end

data/spec/protos/generator_test/aaa.proto

@@ -0,0 +1,13 @@
+package aaa;
+
+enum Eaa {
+  FOO = 1;
+}
+
+message Maa {
+  message MaaNested {
+    optional int32 i = 2;
+  }
+
+  optional MaaNested maa_nested = 1;
+}

data/spec/protos/generator_test/foo/aab.proto

@@ -0,0 +1,5 @@
+package aa_package;
+
+enum Eab {
+  FOO = 1;
+}

data/spec/protos/generator_test/java_package.proto

@@ -0,0 +1,7 @@
+package aaa;
+
+option java_package = "net.porkbuns.customPackage";
+
+enum Ead {
+  EAD = 2;
+}

data/spec/protos/generator_test/outer_class_name.proto

@@ -0,0 +1,7 @@
+package aaa;
+
+option java_outer_classname = "CustomOuterClassName";
+
+enum Eac {
+  FOO2 = 1;
+}

data/spec/protos/service_rpc_test/wearabouts_api/multiple_files.proto

@@ -0,0 +1,12 @@
+package WearaboutsApi.MultipleFiles;
+
+option java_package = "us.wearabouts.chatabout.multiple";
+option java_multiple_files = true;
+
+message Icon {
+  required int32 id = 1;
+}
+
+enum IconEnum {
+  FOO = 1;
+}

data/spec/protos/service_rpc_test/wearabouts_api/outer_class_proto.proto

@@ -0,0 +1,12 @@
+package WearaboutsApi.OuterClassProto;
+
+option java_package = "us.wearabouts.chatabout.outer";
+option java_outer_classname = "OuterClassName";
+
+message Icon {
+  required int32 id = 1;
+}
+
+enum IconEnum {
+  FOO = 1;
+}

data/spec/protos/service_rpc_test/wearabouts_api/user.proto

@@ -0,0 +1,36 @@
+package WearaboutsApi.User;
+
+option java_package = "us.wearabouts.chatabout.proto.user";
+
+import "wearabouts_pb.proto";
+
+message AuthenticateRequest {
+  optional string email = 1;
+  optional string phone = 2;
+  required string device_id = 3;
+  optional string name = 4;
+}
+message AuthenticateResponse {
+  optional WearaboutsPb.UserProto user = 1;
+  optional WearaboutsPb.DeviceLinkProto device_link = 2;
+  optional string auth_token = 3;
+}
+
+message MeRequest {}
+message MeResponse {
+  optional WearaboutsPb.UserProto user = 1;
+  optional WearaboutsPb.DeviceLinkProto device_link = 2;
+}
+
+message UpdateNameRequest {
+  required string name = 1;
+}
+message UpdateNameResponse {
+  optional WearaboutsPb.UserProto user = 1;
+}
+
+service UserService {
+  rpc Authenticate (AuthenticateRequest) returns (AuthenticateResponse);
+  rpc Me (MeRequest) returns (MeResponse);
+  rpc UpdateName (UpdateNameRequest) returns (UpdateNameResponse);
+}

data/spec/protos/service_rpc_test/wearabouts_pb.proto

@@ -0,0 +1,35 @@
+package WearaboutsPb;
+
+option java_package = "us.wearabouts.chatabout.proto";
+
+message UserProto {
+  message UserDetails {
+    optional string email = 2;
+    optional string phone = 3;
+    optional string name = 4;
+  }
+  required string id = 1;
+  optional UserDetails user_details = 2;
+}
+
+message ConversationProto {
+  required string id = 1;
+  repeated UserProto participants = 2;
+}
+
+message PostProto {
+  enum Kind {
+    TEXT = 1;
+    AUDIO = 2;
+  }
+  required string id = 1;
+
+  required Kind kind = 2;
+  optional string text = 100;
+  optional string audio_url = 200;
+}
+
+message DeviceLinkProto {
+  required string device_id = 1;
+  optional bool verified = 2;
+}