ruby-protocol-buffers 1.3.3 → 1.4.0

data/bin/protoc-gen-ruby

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+require 'protocol_buffers/compiler/file_descriptor_to_ruby'
+require 'protocol_buffers/compiler/plugin.pb'
+require 'stringio'
+
+response = CodeGeneratorResponse.new
+begin
+  request = CodeGeneratorRequest.parse($stdin)
+
+  request.proto_file.each do |file_descriptor|
+    next unless request.file_to_generate.include? file_descriptor.name
+    dumper = FileDescriptorToRuby.new(file_descriptor)
+    io = StringIO.new
+    dumper.write(io)
+    filename = File.join(File.dirname(file_descriptor.name),
+                         File.basename(file_descriptor.name, '.proto') + '.pb.rb')
+    file = CodeGeneratorResponse::File.new(:name => filename, :content => io.string)
+    response.file << file
+  end
+rescue => error
+  response.file.clear
+  response.error = "%s\n%s\n\nBacktrace:\n%s" % [
+    "Failed to generate a Ruby file",
+    error.message,
+    error.backtrace.join("\n")
+  ]
+  $stderr.puts response.error
+else
+  print response.to_s
+end

data/lib/protocol_buffers/compiler/file_descriptor_to_ruby.rb

@@ -24,7 +24,13 @@ require 'protocol_buffers'
 HEADER
 
     descriptor.dependency.each do |dep|
-      path = File.basename(dep, ".proto") + ".pb"
+      dir      = File.dirname(dep)
+      filename = File.basename(dep, ".proto") + ".pb"
+      path = if dir == '.'
+        filename
+      else
+        File.join(dir, filename)
+      end
       @io.write("begin; require '#{path}'; rescue LoadError; end\n")
     end
     @io.write("\n") unless descriptor.dependency.empty?
@@ -123,6 +129,9 @@ HEADER
       message.field.each do |field|
         typename = field_typename(field)
         fieldline = %{#{LABEL_MAPPING[field.label]} #{typename}, :#{field.name}, #{field.number}}
+        if field.type == TYPE_GROUP
+          fieldline << %{, :group => true}
+        end
         if field.default_value && field.default_value != ""
           fieldline << %{, :default => #{default_value(field)}}
         end

data/lib/protocol_buffers/compiler/plugin.pb.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# Generated by the protocol buffer compiler. DO NOT EDIT!
+
+require 'protocol_buffers'
+
+begin; require 'descriptor.pb'; rescue LoadError; end
+
+# forward declarations
+class CodeGeneratorRequest < ::ProtocolBuffers::Message; end
+class CodeGeneratorResponse < ::ProtocolBuffers::Message; end
+
+class CodeGeneratorRequest < ::ProtocolBuffers::Message
+  repeated :string, :file_to_generate, 1
+  optional :string, :parameter, 2
+  repeated ::FileDescriptorProto, :proto_file, 15
+end
+
+class CodeGeneratorResponse < ::ProtocolBuffers::Message
+  # forward declarations
+  class File < ::ProtocolBuffers::Message; end
+
+  # nested messages
+  class File < ::ProtocolBuffers::Message
+    optional :string, :name, 1
+    optional :string, :insertion_point, 2
+    optional :string, :content, 15
+  end
+
+  optional :string, :error, 1
+  repeated ::CodeGeneratorResponse::File, :file, 15
+end
+

data/lib/protocol_buffers/compiler/plugin.proto

@@ -0,0 +1,146 @@
+// Protocol Buffers - Google's data interchange format
+// Copyright 2008 Google Inc.  All rights reserved.
+// http://code.google.com/p/protobuf/
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//     * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//     * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//     * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+// Author: kenton@google.com (Kenton Varda)
+//
+// WARNING:  The plugin interface is currently EXPERIMENTAL and is subject to
+//   change.
+//
+// protoc (aka the Protocol Compiler) can be extended via plugins.  A plugin is
+// just a program that reads a CodeGeneratorRequest from stdin and writes a
+// CodeGeneratorResponse to stdout.
+//
+// Plugins written using C++ can use google/protobuf/compiler/plugin.h instead
+// of dealing with the raw protocol defined here.
+//
+// A plugin executable needs only to be placed somewhere in the path.  The
+// plugin should be named "protoc-gen-$NAME", and will then be used when the
+// flag "--${NAME}_out" is passed to protoc.
+
+//package google.protobuf.compiler;
+
+//import "google/protobuf/descriptor.proto";
+import "descriptor.proto";
+
+// An encoded CodeGeneratorRequest is written to the plugin's stdin.
+message CodeGeneratorRequest {
+  // The .proto files that were explicitly listed on the command-line.  The
+  // code generator should generate code only for these files.  Each file's
+  // descriptor will be included in proto_file, below.
+  repeated string file_to_generate = 1;
+
+  // The generator parameter passed on the command-line.
+  optional string parameter = 2;
+
+  // FileDescriptorProtos for all files in files_to_generate and everything
+  // they import.  The files will appear in topological order, so each file
+  // appears before any file that imports it.
+  //
+  // protoc guarantees that all proto_files will be written after
+  // the fields above, even though this is not technically guaranteed by the
+  // protobuf wire format.  This theoretically could allow a plugin to stream
+  // in the FileDescriptorProtos and handle them one by one rather than read
+  // the entire set into memory at once.  However, as of this writing, this
+  // is not similarly optimized on protoc's end -- it will store all fields in
+  // memory at once before sending them to the plugin.
+  repeated FileDescriptorProto proto_file = 15;
+}
+
+// The plugin writes an encoded CodeGeneratorResponse to stdout.
+message CodeGeneratorResponse {
+  // Error message.  If non-empty, code generation failed.  The plugin process
+  // should exit with status code zero even if it reports an error in this way.
+  //
+  // This should be used to indicate errors in .proto files which prevent the
+  // code generator from generating correct code.  Errors which indicate a
+  // problem in protoc itself -- such as the input CodeGeneratorRequest being
+  // unparseable -- should be reported by writing a message to stderr and
+  // exiting with a non-zero status code.
+  optional string error = 1;
+
+  // Represents a single generated file.
+  message File {
+    // The file name, relative to the output directory.  The name must not
+    // contain "." or ".." components and must be relative, not be absolute (so,
+    // the file cannot lie outside the output directory).  "/" must be used as
+    // the path separator, not "\".
+    //
+    // If the name is omitted, the content will be appended to the previous
+    // file.  This allows the generator to break large files into small chunks,
+    // and allows the generated text to be streamed back to protoc so that large
+    // files need not reside completely in memory at one time.  Note that as of
+    // this writing protoc does not optimize for this -- it will read the entire
+    // CodeGeneratorResponse before writing files to disk.
+    optional string name = 1;
+
+    // If non-empty, indicates that the named file should already exist, and the
+    // content here is to be inserted into that file at a defined insertion
+    // point.  This feature allows a code generator to extend the output
+    // produced by another code generator.  The original generator may provide
+    // insertion points by placing special annotations in the file that look
+    // like:
+    //   @@protoc_insertion_point(NAME)
+    // The annotation can have arbitrary text before and after it on the line,
+    // which allows it to be placed in a comment.  NAME should be replaced with
+    // an identifier naming the point -- this is what other generators will use
+    // as the insertion_point.  Code inserted at this point will be placed
+    // immediately above the line containing the insertion point (thus multiple
+    // insertions to the same point will come out in the order they were added).
+    // The double-@ is intended to make it unlikely that the generated code
+    // could contain things that look like insertion points by accident.
+    //
+    // For example, the C++ code generator places the following line in the
+    // .pb.h files that it generates:
+    //   // @@protoc_insertion_point(namespace_scope)
+    // This line appears within the scope of the file's package namespace, but
+    // outside of any particular class.  Another plugin can then specify the
+    // insertion_point "namespace_scope" to generate additional classes or
+    // other declarations that should be placed in this scope.
+    //
+    // Note that if the line containing the insertion point begins with
+    // whitespace, the same whitespace will be added to every line of the
+    // inserted text.  This is useful for languages like Python, where
+    // indentation matters.  In these languages, the insertion point comment
+    // should be indented the same amount as any inserted code will need to be
+    // in order to work correctly in that context.
+    //
+    // The code generator that generates the initial file and the one which
+    // inserts into it must both run as part of a single invocation of protoc.
+    // Code generators are executed in the order in which they appear on the
+    // command line.
+    //
+    // If |insertion_point| is present, |name| must also be present.
+    optional string insertion_point = 2;
+
+    // The file contents.
+    optional string content = 15;
+  }
+  repeated File file = 15;
+}

data/lib/protocol_buffers/runtime/decoder.rb

@@ -12,6 +12,7 @@ module ProtocolBuffers
         tag_int = Varint.decode(io)
         tag = tag_int >> 3
         wire_type = tag_int & 0b111
+        break if wire_type == 4
         field = fields[tag]
 
         if field && ( !( field.packed? || wire_type == field.wire_type ) || ( field.packed? && wire_type != 2 ) )
@@ -31,8 +32,10 @@ module ProtocolBuffers
           value = LimitedIO.new(io, length)
         when 5 # FIXED32
           value = io.read(4)
-        when 3, 4 # deprecated START_GROUP/END_GROUP types
-          raise(DecodeError, "groups are deprecated and unsupported")
+        when 3 # START_GROUP
+          value = io
+        when 4 # END_GROUP
+          break
         else
           raise(DecodeError, "unknown wire type: #{wire_type}")
         end

data/lib/protocol_buffers/runtime/encoder.rb

@@ -49,6 +49,7 @@ module ProtocolBuffers
       # write the tag
       Varint.encode(io, tag)
       self.serialize_field_value(io, wire_type, serialized)
+      Varint.encode(io, tag & ~3 | 4) if wire_type == 3
     end
 
     def self.serialize_field_value(io, wire_type, serialized)
@@ -61,8 +62,10 @@ module ProtocolBuffers
       when 2 # LENGTH_DELIMITED
         Varint.encode(io, serialized.bytesize)
         io.write(serialized)
-      when 3, 4 # deprecated START_GROUP/END_GROUP types
-        raise(EncodeError, "groups are deprecated and unsupported")
+      when 3 # START_GROUP
+        io.write(serialized)
+      when 4 # END_GROUP: never appear
+        raise(EncodeError, "Unexpected wire type END_GROUP")
       else
         raise(EncodeError, "unknown wire type: #{wire_type}")
       end

data/lib/protocol_buffers/runtime/field.rb

@@ -107,7 +107,11 @@ module ProtocolBuffers
       elsif type.ancestors.include?(ProtocolBuffers::Enum)
         field = Field::EnumField.new(type, otype, name, tag, opts)
       elsif type.ancestors.include?(ProtocolBuffers::Message)
-        field = Field::MessageField.new(type, otype, name, tag, opts)
+        if opts[:group]
+          field = Field::GroupField.new(type, otype, name, tag, opts)
+        else
+          field = Field::MessageField.new(type, otype, name, tag, opts)
+        end
       else
         raise("Type not found: #{type}")
       end
@@ -237,9 +241,11 @@ module ProtocolBuffers
         def wire_type
           WireTypes::LENGTH_DELIMITED
         end
+      end
 
-        def deserialize(value)
-          value.read
+      module GROUP
+        def wire_type
+          WireTypes::START_GROUP
         end
       end
 
@@ -288,6 +294,10 @@ module ProtocolBuffers
       def default_value
         @default_value || @default_value = (@opts[:default] || "").freeze
       end
+
+      def deserialize(value)
+        value.read
+      end
     end
 
     class StringField < BytesField
@@ -572,9 +582,7 @@ module ProtocolBuffers
       end
     end
 
-    class MessageField < Field
-      include WireFormats::LENGTH_DELIMITED
-      
+    class AggregateField < Field
       attr_reader :proxy_class
 
       def initialize(proxy_class, otype, name, tag, opts = {})
@@ -602,5 +610,12 @@ module ProtocolBuffers
       end
     end
 
+    class MessageField < AggregateField
+      include WireFormats::LENGTH_DELIMITED
+    end
+
+    class GroupField < AggregateField
+      include WireFormats::GROUP
+    end
   end
 end

data/lib/protocol_buffers/runtime/message.rb

@@ -498,7 +498,7 @@ module ProtocolBuffers
       field = fields[tag]
       new_value = field.default_value
       self.instance_variable_set("@#{field.name}", new_value)
-      if field.class == Field::MessageField
+      if field.kind_of? Field::AggregateField
         new_value.notify_on_change(self, tag)
       end
       @set_fields[tag] = false

data/lib/protocol_buffers/version.rb

@@ -1,3 +1,3 @@
 module ProtocolBuffers
-  VERSION = "1.3.3"
+  VERSION = "1.4.0"
 end

data/spec/compiler_spec.rb

@@ -4,6 +4,10 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 require 'protocol_buffers'
 require 'protocol_buffers/compiler'
 
+require 'protocol_buffers/compiler/file_descriptor_to_ruby'
+
+require 'tmpdir'
+require 'tempfile'
 describe ProtocolBuffers, "compiler" do
 
   test_files = Dir[File.join(File.dirname(__FILE__), "proto_files", "*.proto")]
@@ -13,6 +17,8 @@ describe ProtocolBuffers, "compiler" do
   end
 
   test_files.each do |file|
+    next if File.basename(file) == 'depends.proto'
+
     it "can compile #{File.basename(file)}" do
       proc do
         ProtocolBuffers::Compiler.compile_and_load(file)
@@ -20,6 +26,35 @@ describe ProtocolBuffers, "compiler" do
     end
   end
 
+  it 'can compile and instantiate a proto with nested dependencies' do
+    protocfile = Tempfile.new('ruby-protoc')
+    protocfile.binmode
+
+    ProtocolBuffers::Compiler.compile(protocfile.path, %w(
+      spec/proto_files/simple.proto
+      spec/proto_files/nested/child.proto
+      spec/proto_files/depends.proto
+    ), :include_dirs => %w(spec/proto_files))
+
+
+    descriptor_set = FileDescriptorSet.parse(protocfile)
+    protocfile.close(true)
+
+    Dir.mktmpdir do |dir|
+      descriptor_set.file.each do |file|
+        name = file.name
+        path = File.join(dir, File.dirname(name), File.basename(name, '.proto') + '.pb.rb')
+        FileUtils.mkdir_p File.dirname(path)
+        File.open(path, "w") {|f|
+          FileDescriptorToRuby.new(file).write(f)
+        }
+      end
+
+      $LOAD_PATH << dir
+      load File.join(dir, 'depends.pb.rb')
+    end
+  end
+
   it "can compile and instantiate a message in a package with under_scores" do
     Object.send(:remove_const, :UnderScore) if defined?(UnderScore)
 

data/spec/proto_files/depends.proto

@@ -1,5 +1,8 @@
 package depends;
 
 import "simple.proto";
+import "nested/child.proto";
 
-message Depends {}
+message Depends {
+  optional nested.child.Child child_field = 1;
+}

data/spec/proto_files/featureful.pb.rb

@@ -20,6 +20,9 @@ module Featureful
   class A < ::ProtocolBuffers::Message
     # forward declarations
     class Sub < ::ProtocolBuffers::Message; end
+    class Group1 < ::ProtocolBuffers::Message; end
+    class Group2 < ::ProtocolBuffers::Message; end
+    class Group3 < ::ProtocolBuffers::Message; end
 
     # nested messages
     class Sub < ::ProtocolBuffers::Message
@@ -43,12 +46,54 @@ module Featureful
       optional ::Featureful::A::Sub::SubSub, :subsub1, 3
     end
 
+    class Group1 < ::ProtocolBuffers::Message
+      # forward declarations
+      class Subgroup < ::ProtocolBuffers::Message; end
+
+      # nested messages
+      class Subgroup < ::ProtocolBuffers::Message
+        required :int32, :i1, 1
+      end
+
+      required :int32, :i1, 1
+      repeated ::Featureful::A::Group1::Subgroup, :subgroup, 2, :group => true
+    end
+
+    class Group2 < ::ProtocolBuffers::Message
+      # forward declarations
+      class Subgroup < ::ProtocolBuffers::Message; end
+
+      # nested messages
+      class Subgroup < ::ProtocolBuffers::Message
+        required :int32, :i1, 1
+      end
+
+      required :int32, :i1, 1
+      repeated ::Featureful::A::Group2::Subgroup, :subgroup, 2, :group => true
+    end
+
+    class Group3 < ::ProtocolBuffers::Message
+      # forward declarations
+      class Subgroup < ::ProtocolBuffers::Message; end
+
+      # nested messages
+      class Subgroup < ::ProtocolBuffers::Message
+        required :int32, :i1, 1
+      end
+
+      required :int32, :i1, 1
+      repeated ::Featureful::A::Group3::Subgroup, :subgroup, 2, :group => true
+    end
+
     repeated :int32, :i1, 1
     optional :int32, :i2, 2
     required :int32, :i3, 3
     repeated ::Featureful::A::Sub, :sub1, 4
     optional ::Featureful::A::Sub, :sub2, 5
     required ::Featureful::A::Sub, :sub3, 6
+    repeated ::Featureful::A::Group1, :group1, 7, :group => true
+    optional ::Featureful::A::Group2, :group2, 8, :group => true
+    required ::Featureful::A::Group3, :group3, 9, :group => true
   end
 
   class B < ::ProtocolBuffers::Message

data/spec/proto_files/featureful.proto

@@ -25,6 +25,25 @@ message A {
   repeated Sub sub1 = 4;
   optional Sub sub2 = 5;
   required Sub sub3 = 6;
+
+  repeated group Group1 = 7 {
+    required int32 i1 = 1;
+    repeated group Subgroup = 2 {
+      required int32 i1 = 1;
+    }
+  }
+  optional group Group2 = 8 {
+    required int32 i1 = 1;
+    repeated group Subgroup = 2 {
+      required int32 i1 = 1;
+    }
+  }
+  required group Group3 = 9 {
+    required int32 i1 = 1;
+    repeated group Subgroup = 2 {
+      required int32 i1 = 1;
+    }
+  }
 };
 
 message B {

data/spec/proto_files/nested/child.proto

@@ -0,0 +1,5 @@
+package nested.child;
+
+message Child {
+  optional string test_field = 1;
+};

data/spec/runtime_spec.rb

@@ -135,6 +135,20 @@ describe ProtocolBuffers, "runtime" do
     a1.has_sub2?.should == true
   end
 
+  it "flags group that have been set" do
+    a1 = Featureful::A.new
+    a1.value_for_tag?(a1.class.field_for_name(:group1).tag).should == true
+    a1.value_for_tag?(a1.class.field_for_name(:group2).tag).should == false
+    a1.value_for_tag?(a1.class.field_for_name(:group3).tag).should == false
+
+    a1.has_group1?.should == true
+    a1.has_group2?.should == false
+    a1.has_group3?.should == false
+
+    a1.group2 = Featureful::A::Group2.new(:i1 => 1)
+    a1.has_group2?.should == true
+  end
+
   describe "#inspect" do
     it "should leave out un-set fields" do
       b1 = Simple::Bar.new
@@ -149,6 +163,10 @@ describe ProtocolBuffers, "runtime" do
     a1.has_sub2?.should == false
     a1.sub2.payload = "ohai"
     a1.has_sub2?.should == true
+
+    a1.has_group2?.should == false
+    a1.group2.i1 = 1
+    a1.has_sub2?.should == true
   end
 
   it "detects changes to a sub-sub-message and flags up the chain" do
@@ -609,6 +627,9 @@ describe ProtocolBuffers, "runtime" do
       f.valid?.should == false
       f.sub3.valid?.should == false
       f.sub3.payload_type = Featureful::A::Sub::Payloads::P1
+      f.valid?.should == false
+      f.group3.valid?.should == false
+      f.group3.i1 = 1
       f.valid?.should == true
       f.sub3.valid?.should == true
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-protocol-buffers
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-22 00:00:00.000000000 Z
+date: 2013-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: autotest-standalone
@@ -131,6 +131,7 @@ email:
 - brian@codekitchen.net
 - bb@xnull.de
 executables:
+- protoc-gen-ruby
 - ruby-protoc
 extensions: []
 extra_rdoc_files:
@@ -145,6 +146,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/protoc-gen-ruby
 - bin/ruby-protoc
 - debian/changelog
 - debian/compatability
@@ -159,6 +161,8 @@ files:
 - lib/protocol_buffers/compiler/descriptor.proto
 - lib/protocol_buffers/compiler/file_descriptor_to_d.rb
 - lib/protocol_buffers/compiler/file_descriptor_to_ruby.rb
+- lib/protocol_buffers/compiler/plugin.pb.rb
+- lib/protocol_buffers/compiler/plugin.proto
 - lib/protocol_buffers/limited_io.rb
 - lib/protocol_buffers/runtime/decoder.rb
 - lib/protocol_buffers/runtime/encoder.rb
@@ -178,6 +182,7 @@ files:
 - spec/proto_files/dotted_package.proto
 - spec/proto_files/featureful.pb.rb
 - spec/proto_files/featureful.proto
+- spec/proto_files/nested/child.proto
 - spec/proto_files/no_package.proto
 - spec/proto_files/packed.pb.rb
 - spec/proto_files/packed.proto
@@ -203,12 +208,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2363751627391486036
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2363751627391486036
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -224,6 +235,7 @@ test_files:
 - spec/proto_files/dotted_package.proto
 - spec/proto_files/featureful.pb.rb
 - spec/proto_files/featureful.proto
+- spec/proto_files/nested/child.proto
 - spec/proto_files/no_package.proto
 - spec/proto_files/packed.pb.rb
 - spec/proto_files/packed.proto