protobuf_descriptor 0.1.0

data/spec/protos/single_file_test/single_file.proto

@@ -0,0 +1,169 @@
+package porkbuns;
+
+// The following is copied from
+// https://code.google.com/p/protobuf/source/browse/trunk/src/google/protobuf/descriptor.proto
+enum UnnestedEnum {
+  // Default mode.
+  STRING = 0;
+  CORD = 1;
+  STRING_PIECE = 2;
+}
+
+message FieldOptions {
+  // The ctype option instructs the C++ code generator to use a different
+  // representation of the field than it normally would.  See the specific
+  // options below.  This option is not yet implemented in the open source
+  // release -- sorry, we'll try to include it in a future version!
+  optional CType ctype = 1 [default = STRING];
+  enum CType {
+      // Default mode.
+    STRING = 0;
+
+    CORD = 1;
+
+    STRING_PIECE = 2;
+  }
+  // The packed option can be enabled for repeated primitive fields to enable
+  // a more efficient representation on the wire. Rather than repeatedly
+  // writing the tag and type for each element, the entire array is encoded as
+  // a single length-delimited blob.
+  optional bool packed = 2;
+
+
+
+  // Should this field be parsed lazily?  Lazy applies only to message-type
+  // fields.  It means that when the outer message is initially parsed, the
+  // inner message's contents will not be parsed but instead stored in encoded
+  // form.  The inner message will actually be parsed when it is first accessed.
+  //
+  // This is only a hint.  Implementations are free to choose whether to use
+  // eager or lazy parsing regardless of the value of this option.  However,
+  // setting this option true suggests that the protocol author believes that
+  // using lazy parsing on this field is worth the additional bookkeeping
+  // overhead typically needed to implement it.
+  //
+  // This option does not affect the public interface of any generated code;
+  // all method signatures remain the same.  Furthermore, thread-safety of the
+  // interface is not affected by this option; const methods remain safe to
+  // call from multiple threads concurrently, while non-const methods continue
+  // to require exclusive access.
+  //
+  //
+  // Note that implementations may choose not to check required fields within
+  // a lazy sub-message.  That is, calling IsInitialized() on the outher message
+  // may return true even if the inner message has missing required fields.
+  // This is necessary because otherwise the inner message would have to be
+  // parsed in order to perform the check, defeating the purpose of lazy
+  // parsing.  An implementation which chooses not to check required fields
+  // must be consistent about it.  That is, for any particular sub-message, the
+  // implementation must either *always* check its required fields, or *never*
+  // check its required fields, regardless of whether or not the message has
+  // been parsed.
+  optional bool lazy = 5 [default=false];
+
+  // Is this field deprecated?
+  // Depending on the target platform, this can emit Deprecated annotations
+  // for accessors, or it will be completely ignored; in the very least, this
+  // is a formalization for deprecating fields.
+  optional bool deprecated = 3 [default=false];
+
+  // EXPERIMENTAL.  DO NOT USE.
+  // For "map" fields, the name of the field in the enclosed type that
+  // is the key for this map.  For example, suppose we have:
+  //   message Item {
+  //     required string name = 1;
+  //     required string value = 2;
+  //   }
+  //   message Config {
+  //     repeated Item items = 1 [experimental_map_key="name"];
+  //   }
+  // In this situation, the map key for Item will be set to "name".
+  // TODO: Fully-implement this, then remove the "experimental_" prefix.
+  optional string experimental_map_key = 9;
+
+  // For Google-internal migration only. Do not use.
+  optional bool weak = 10 [default=false];
+
+  // The parser stores options it doesn't recognize here. See above.
+  repeated UninterpretedOption uninterpreted_option = 999;
+
+  // Clients can define custom options in extensions of this message. See above.
+  extensions 1000 to max;
+}
+
+message EnumOptions {
+
+  // Set this option to false to disallow mapping different tag names to a same
+  // value.
+  optional bool allow_alias = 2 [default=true];
+
+  // The parser stores options it doesn't recognize here. See above.
+  repeated UninterpretedOption uninterpreted_option = 999;
+
+  // Clients can define custom options in extensions of this message. See above.
+  extensions 1000 to max;
+}
+
+message EnumValueOptions {
+  // The parser stores options it doesn't recognize here. See above.
+  repeated UninterpretedOption uninterpreted_option = 999;
+
+  // Clients can define custom options in extensions of this message. See above.
+  extensions 1000 to max;
+}
+
+message ServiceOptions {
+
+  // Note:  Field numbers 1 through 32 are reserved for Google's internal RPC
+  //   framework.  We apologize for hoarding these numbers to ourselves, but
+  //   we were already using them long before we decided to release Protocol
+  //   Buffers.
+
+  // The parser stores options it doesn't recognize here. See above.
+  repeated UninterpretedOption uninterpreted_option = 999;
+
+  // Clients can define custom options in extensions of this message. See above.
+  extensions 1000 to max;
+}
+
+message MethodOptions {
+
+  // Note:  Field numbers 1 through 32 are reserved for Google's internal RPC
+  //   framework.  We apologize for hoarding these numbers to ourselves, but
+  //   we were already using them long before we decided to release Protocol
+  //   Buffers.
+
+  // The parser stores options it doesn't recognize here. See above.
+  repeated UninterpretedOption uninterpreted_option = 999;
+
+  // Clients can define custom options in extensions of this message. See above.
+  extensions 1000 to max;
+}
+
+// A message representing a option the parser does not recognize. This only
+// appears in options protos created by the compiler::Parser class.
+// DescriptorPool resolves these when building Descriptor objects. Therefore,
+// options protos in descriptor objects (e.g. returned by Descriptor::options(),
+// or produced by Descriptor::CopyTo()) will never have UninterpretedOptions
+// in them.
+message UninterpretedOption {
+  // The name of the uninterpreted option.  Each string represents a segment in
+  // a dot-separated name.  is_extension is true iff a segment represents an
+  // extension (denoted with parentheses in options specs in .proto files).
+  // E.g.,{ ["foo", false], ["bar.baz", true], ["qux", false] } represents
+  // "foo.(bar.baz).qux".
+  message NamePart {
+      required string name_part = 1;
+    required bool is_extension = 2;
+  }
+  repeated NamePart name = 2;
+
+  // The value of the uninterpreted option, in whatever type the tokenizer
+  // identified it as during parsing. Exactly one of these should be set.
+  optional string identifier_value = 3;
+  optional uint64 positive_int_value = 4;
+  optional int64 negative_int_value = 5;
+  optional double double_value = 6;
+  optional bytes string_value = 7;
+  optional string aggregate_value = 8;
+}

data/spec/service_descriptor_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe ProtobufDescriptor::ServiceDescriptor do
+  describe "#methods" do
+    it "has right size" do
+      with_descriptor("service_rpc_test") do |descriptor|
+        service_descriptor = descriptor["wearabouts_api/user"].services[:UserService]
+        expect(service_descriptor).to be_a(ProtobufDescriptor::ServiceDescriptor)
+        expect(service_descriptor.methods).to have(3).items
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,145 @@
+require 'rspec'
+require "protobuf_descriptor"
+
+require "fileutils"
+require "pathname"
+require "tempfile"
+
+# "Parses" a java package returning a mapping of class/enum names to their fully
+# qualified name.
+#
+# Raises if a class name occurs twice.
+def ghetto_parse_java_package(dir)
+  tokens = [
+    # Wire enum
+    [:enum, /public\s+enum\s+(\w+)\s+implements\s+ProtoEnum\s+{/],
+    # Protoc Java enum
+    [:enum, /public\s+enum\s+(\w+)\s+implements\s+com\.google\.protobuf\.ProtocolMessageEnum\s+{/],
+    # This is used by the protocol buffer compiler to wrap all the protos
+    # defined in a single file.
+    [:namespace, /public\s+(?:(?:static|final)\s+)*class\s+(\w+)\s+{/],
+    # Wire message type
+    [:message, /public\s+(?:(?:static|final)\s+)*class\s+(\w+)\s+extends\s+Message\s+{/],
+    # Protoc java message
+    [:message, /public\s+(?:(?:static|final)\s+)*class\s+(\w+)\s+extends\s+com\.google\.protobuf\.GeneratedMessage\s+implements\s+(\w+)\s+{/],
+    [:open_brace, /{/],
+    [:close_brace, /}/],
+    [:eof, /\z/]]
+
+  found = {}
+
+  Dir.glob("#{dir}/**/*.java").each do |filename|
+    contents = File.read(filename)
+
+    package = contents.match(/package\s+([\w\.]+);/)
+    package = package[1] unless package.nil?
+
+    # puts "#{filename[dir.length..-1]}: package #{package}"
+
+    bits = [package]
+
+    offset = 0
+    while offset < contents.length
+      token, regex = tokens.min_by { |k, v|
+        match = v.match(contents, offset)
+        # Move offset off end of file so EOF matches first.
+        match.nil? ? contents.length + 1: match.begin(0)
+      }
+      match = regex.match(contents, offset)
+      offset = match.end(0)
+
+      # Build a stack of named components
+      case token
+      when :enum, :message
+        # If we find a named component, add it to the stack as well as
+        # generating its portion of the output.
+        bits.push(match[1])
+        raise "Type name #{match[1]} occurs twice!" if found[match[1]]
+        found[match[1]] = bits.compact.join('.')
+      when :namespace
+        bits.push(match[1])
+      when :open_brace
+        bits.push(nil)
+      when :close_brace
+        bits.pop
+      end
+
+      # puts "#{token}@#{offset} #{bits.inspect}"
+    end
+  end
+  return found
+end
+
+def with_temp_file(name="tempfile")
+  file = Tempfile.new(name)
+  begin
+    yield file
+  ensure
+    file.close
+    file.unlink
+  end
+end
+
+def compile_wire_protobuf(args={})
+  args = {
+    destination: ".",
+    source: ".",
+    extra_args: []
+  }.merge(args)
+
+  jar_path = File.realpath("#{File.dirname(__FILE__)}/../wire-compiler.jar")
+  command = ["java", "-jar", jar_path]
+  command << "--proto_path=#{args[:source]}"
+  command += args[:extra_args]
+  command << "--java_out=#{args[:destination]}"
+  command += Dir.glob("#{args[:source]}**/*.proto").map { |p|
+    Pathname.new(p).relative_path_from(Pathname.new(args[:source])).to_s
+  }
+  with_temp_file do |tmp_log|
+    rv = system(*command, out: [tmp_log.path, "a"], err: [tmp_log.path, "a"])
+
+    raise "Wire protobuf generation failed!\n#{File.read(tmp_log)}" unless rv
+  end
+end
+
+def generate_protobuf_descriptor(args={})
+  args = {
+    source: ".",
+    extra_args: [],
+    plugin: nil,
+    plugin_out: "",
+    out: "out.desc"
+  }.merge(args)
+  args[:source] += '/' unless args[:source].end_with?('/')
+
+  command = []
+  command << "protoc"
+  command << "-I#{args[:source]}"
+  if args[:plugin]
+    command << "--#{args[:plugin]}_out=#{args[:plugin_out]}"
+  end
+  command += args[:extra_args]
+  command << "--descriptor_set_out=#{args[:out]}"
+  command += Dir.glob("#{args[:source]}**/*.proto")
+
+  rv = system(*command)
+
+  raise "ProtobufDescriptor generation failed!" unless rv
+end
+
+def with_descriptor_file(source, args={})
+  with_temp_file do |f|
+    args = {
+      out: f.path,
+      source: "#{File.dirname(__FILE__)}/protos/#{source}/"
+    }.merge(args)
+    generate_protobuf_descriptor(args)
+    yield f
+  end
+end
+
+def with_descriptor(source, args={})
+  with_descriptor_file(source, args) do |f|
+    yield ProtobufDescriptor.decode_from(f)
+  end
+end

data/spec/wire_generator_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+require "tmpdir"
+
+describe "WireCompiler" 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|
+      # The following is to compile protos with wire, since its done as a
+      # separate process:
+      compile_wire_protobuf(source: "#{File.dirname(__FILE__)}/protos/generator_test/", destination: dir)
+      generated_classes = ghetto_parse_java_package(dir)
+
+      with_descriptor("generator_test") do |descriptor|
+        children = descriptor.all_descendants
+
+        children.each do |child|
+          expect(child.fully_qualified_wire_name).to eq(generated_classes[child.name])
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: protobuf_descriptor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hsiu-Fan Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Wraps the protobuf FileDescriptorSet messages with happy features like
+  type name resolution and the like.
+email: hfwang@porkbuns.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .yardopts
+- ChangeLog.rdoc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/protobuf_descriptor.rb
+- lib/protobuf_descriptor/enum_descriptor.rb
+- lib/protobuf_descriptor/file_descriptor.rb
+- lib/protobuf_descriptor/has_parent.rb
+- lib/protobuf_descriptor/message_descriptor.rb
+- lib/protobuf_descriptor/named_child.rb
+- lib/protobuf_descriptor/named_collection.rb
+- lib/protobuf_descriptor/service_descriptor.rb
+- lib/protobuf_descriptor/version.rb
+- protobuf_descriptor.gemspec
+- spec/enum_descriptor_spec.rb
+- spec/field_descriptor_spec.rb
+- spec/file_descriptor_spec.rb
+- spec/message_descriptor_spec.rb
+- spec/method_descriptor_spec.rb
+- spec/protobuf_descriptor_spec.rb
+- spec/protoc_generator_spec.rb
+- spec/protos/generator_test/aaa.proto
+- spec/protos/generator_test/foo/aab.proto
+- spec/protos/generator_test/java_package.proto
+- spec/protos/generator_test/outer_class_name.proto
+- spec/protos/service_rpc_test/wearabouts_api/multiple_files.proto
+- spec/protos/service_rpc_test/wearabouts_api/outer_class_proto.proto
+- spec/protos/service_rpc_test/wearabouts_api/user.proto
+- spec/protos/service_rpc_test/wearabouts_pb.proto
+- spec/protos/single_file_test/single_file.proto
+- spec/service_descriptor_spec.rb
+- spec/spec_helper.rb
+- spec/wire_generator_spec.rb
+homepage: https://github.com/hfwang/protobuf_descriptor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Protocol Buffer file descriptor parser
+test_files:
+- spec/enum_descriptor_spec.rb
+- spec/field_descriptor_spec.rb
+- spec/file_descriptor_spec.rb
+- spec/message_descriptor_spec.rb
+- spec/method_descriptor_spec.rb
+- spec/protobuf_descriptor_spec.rb
+- spec/protoc_generator_spec.rb
+- spec/protos/generator_test/aaa.proto
+- spec/protos/generator_test/foo/aab.proto
+- spec/protos/generator_test/java_package.proto
+- spec/protos/generator_test/outer_class_name.proto
+- spec/protos/service_rpc_test/wearabouts_api/multiple_files.proto
+- spec/protos/service_rpc_test/wearabouts_api/outer_class_proto.proto
+- spec/protos/service_rpc_test/wearabouts_api/user.proto
+- spec/protos/service_rpc_test/wearabouts_pb.proto
+- spec/protos/single_file_test/single_file.proto
+- spec/service_descriptor_spec.rb
+- spec/spec_helper.rb
+- spec/wire_generator_spec.rb