ruby_protobuf 0.4.5 → 0.4.6

data/lib/protobuf/message/decoder.rb

@@ -7,28 +7,43 @@ module Protobuf
 
     module_function
 
+    READ_METHODS = [
+      :read_varint,           # 0: Varint
+      :read_fixed64,          # 1: 64 bit
+      :read_length_delimited, # 2: Length-delimited
+      :read_start_group,      # 3: Start group
+      :read_end_group,        # 4: End group
+      :read_fixed32,          # 5: 32 bit
+    ]
+
     # Read bytes from +stream+ and pass to +message+ object.
     def decode(stream, message)
       until stream.eof?
         tag, wire_type = read_key(stream)
-        bytes =
-          case wire_type
-          when WireType::VARINT
-            read_varint(stream)
-          when WireType::FIXED64
-            read_fixed64(stream)
-          when WireType::LENGTH_DELIMITED
-            read_length_delimited(stream)
-          when WireType::START_GROUP
-            read_start_group(stream)
-          when WireType::END_GROUP
-            read_end_group(stream)
-          when WireType::FIXED32
-            read_fixed32(stream)
+        field = message.get_field_by_tag(tag)
+
+        method = READ_METHODS[wire_type]
+        raise InvalidWireType, "Unknown wire type: #{wire_type}" unless method
+        value = send(method, stream)
+
+        if field.nil?
+          # ignore unknown field
+        elsif field.repeated?
+          array = message.__send__(field.name)
+          if wire_type == WireType::LENGTH_DELIMITED && WireType::PACKABLE_TYPES.include?(field.wire_type)
+            # packed
+            s = StringIO.new(value)
+            m = READ_METHODS[field.wire_type]
+            until s.eof?
+              array << field.decode(send(m, s))
+            end
           else
-            raise InvalidWireType, wire_type
+            # non-packed
+            array << field.decode(value)
           end
-        message.set_field(tag, bytes)
+        else
+          message.__send__("#{field.name}=", field.decode(value))
+        end
       end
       message
     end

data/lib/protobuf/message/encoder.rb

@@ -14,6 +14,7 @@ module Protobuf
         next unless message.has_field?(field.name)
 
         if field.repeated?
+          next if value.empty?
           if field.packed?
             key = (field.tag << 3) | WireType::LENGTH_DELIMITED
             packed_value = value.map {|val| field.encode(val) }.join

data/lib/protobuf/message/field.rb

@@ -36,7 +36,7 @@ module Protobuf
         nil
       end
 
-      attr_reader :message_class, :rule, :type, :name, :tag, :default
+      attr_reader :message_class, :rule, :type, :name, :tag, :default, :extension
       attr_reader :default_value
 
       def descriptor
@@ -53,7 +53,7 @@ module Protobuf
         unless options.empty?
           warn "WARNING: Invalid options: #{options.inspect} (in #{@message_class.name.split('::').last}.#{@name})"
         end
-        if packed? && ! [WireType::VARINT, WireType::FIXED32, WireType::FIXED64].include?(wire_type)
+        if packed? && ! WireType::PACKABLE_TYPES.include?(wire_type)
           raise "Can't use packed encoding for `#{@type}' type"
         end
 
@@ -70,7 +70,7 @@ module Protobuf
         define_accessor
       end
 
-      def ready?
+      def ready? # :nodoc:
         true
       end
 
@@ -86,30 +86,6 @@ module Protobuf
         end
       end
 
-      # Decode +bytes+ and pass to +message_instance+.
-      def set(message_instance, bytes)
-        if packed?
-          array = message_instance.__send__(@name)
-          method = \
-            case wire_type
-            when WireType::FIXED32 then :read_fixed32
-            when WireType::FIXED64 then :read_fixed64
-            when WireType::VARINT  then :read_varint
-            end
-          stream = StringIO.new(bytes)
-          until stream.eof?
-            array << decode(Decoder.__send__(method, stream))
-          end
-        else
-          value = decode(bytes)
-          if repeated?
-            message_instance.__send__(@name) << value
-          else
-            message_instance.__send__("#{@name}=", value)
-          end
-        end
-      end
-
       # Decode +bytes+ and return a field value.
       def decode(bytes)
         raise NotImplementedError, "#{self.class.name}\#decode"
@@ -146,7 +122,7 @@ module Protobuf
 
       # Is this a packed repeated field?
       def packed?
-        !!@packed
+        @packed
       end
 
       # Upper limit for this field.
@@ -240,7 +216,7 @@ module Protobuf
           message_class, rule, type, name, tag, options
       end
 
-      def ready?
+      def ready? # :nodoc:
         false
       end
 
@@ -338,7 +314,6 @@ module Protobuf
       end
 
       def decode(bytes)
-        bytes.force_encoding(Encoding::ASCII_8BIT) if bytes.respond_to?(:force_encoding)
         bytes
       end
 
@@ -346,7 +321,7 @@ module Protobuf
         if value.respond_to?(:force_encoding)
           # Ruby 1.9
           result = VarintField.encode(value.bytesize)
-          result << value.dup.force_encoding(Encoding::ASCII_8BIT)
+          result << value.dup.force_encoding(Encoding::BINARY)
         else
           # Ruby 1.8
           result = VarintField.encode(value.size)
@@ -592,7 +567,7 @@ module Protobuf
       end
 
       def decode(value)
-        value == 1
+        value != 0
       end
 
       def encode(value)
@@ -652,7 +627,7 @@ module Protobuf
     class EnumField < VarintField
       def acceptable?(val)
         case val
-        when Symbol
+        when Symbol, String
           raise TypeError unless @type.const_defined?(val)
         when EnumValue
           raise TypeError if val.parent_class != @type
@@ -683,9 +658,9 @@ module Protobuf
             if val.nil?
               @values.delete(field.name)
             else
-              val = \
+              enum_value = \
                 case val
-                when Symbol
+                when Symbol, String
                   field.type.const_get(val) rescue nil
                 when Integer
                   field.type.const_get(field.type.name_by_value(val)) rescue nil
@@ -693,9 +668,9 @@ module Protobuf
                   raise TypeError, "Invalid value: #{val.inspect}" if val.parent_class != field.type
                   val
                 end
-              raise TypeError, "Invalid value: #{val.inspect}" unless val
+              raise TypeError, "Invalid value: #{val.inspect}" unless enum_value
 
-              @values[field.name] = val
+              @values[field.name] = enum_value
             end
           end
         end

data/lib/protobuf/message/message.rb

@@ -1,4 +1,3 @@
-require 'pp'
 require 'stringio'
 require 'protobuf/descriptor/descriptor'
 require 'protobuf/message/decoder'
@@ -11,27 +10,12 @@ module Protobuf
 
   class Message
 
-    class ExtensionFields < Hash
-      def initialize(key_range=0..-1)
-        @key_range = key_range
-      end
-
-      def []=(key, value)
-        raise RangeError, "#{key} is not in #{@key_range}" unless @key_range.include?(key)
-        super
-      end
-
-      def include_tag?(tag)
-        @key_range.include?(tag)
-      end
-    end
-
     class <<self
       include Protoable
 
       # Reserve field numbers for extensions. Don't use this method directly.
       def extensions(range)
-        @extension_fields = ExtensionFields.new(range)
+        @extension_tag = range
       end
 
       # Define a required field. Don't use this method directly.
@@ -51,15 +35,18 @@ module Protobuf
 
       # Define a field. Don't use this method directly.
       def define_field(rule, type, fname, tag, options)
-        field_hash = options[:extension] ? extension_fields : fields
-        if field_hash.keys.include?(tag)
-          raise TagCollisionError, %!{Field number #{tag} has already been used in "#{self.name}" by field "#{fname}".!
+        if options[:extension] && ! extension_tag?(tag)
+          raise RangeError, "#{tag} is not in #{@extension_tag}"
+        end
+
+        if fields.include?(tag)
+          raise TagCollisionError, "Field tag #{tag} has already been used."
         end
-        field_hash[tag] = Field.build(self, rule, type, fname, tag, options)
+        fields[tag] = Field.build(self, rule, type, fname, tag, options)
       end
 
       def extension_tag?(tag)
-        extension_fields.include_tag?(tag)
+        @extension_tag.include?(tag)
       end
 
       # A collection of field object.
@@ -67,11 +54,6 @@ module Protobuf
         @fields ||= {}
       end
 
-      # An extension field object.
-      def extension_fields
-        @extension_fields ||= ExtensionFields.new
-      end
-
       # Find a field object by +name+.
       def get_field_by_name(name)
         name = name.to_sym
@@ -92,26 +74,6 @@ module Protobuf
         end
       end
 
-      #TODO merge to get_field_by_name
-      def get_ext_field_by_name(name)
-        name = name.to_sym
-        extension_fields.values.find {|field| field.name == name}
-      end
-
-      #TODO merge to get_field_by_tag
-      def get_ext_field_by_tag(tag)
-        extension_fields[tag]
-      end
-
-      #TODO merge to get_field
-      def get_ext_field(tag_or_name)
-        case tag_or_name
-        when Integer        then get_ext_field_by_tag(tag_or_name)
-        when String, Symbol then get_ext_field_by_name(tag_or_name)
-        else                     raise TypeError, tag_or_name.class
-        end
-      end
-
       def descriptor
         @descriptor ||= Descriptor::Descriptor.new(self)
       end
@@ -120,7 +82,7 @@ module Protobuf
     def initialize(values={})
       @values = {}
 
-      self.class.fields.to_a.each do |tag, field|
+      self.class.fields.dup.each do |tag, field|
         unless field.ready?
           field = field.setup
           self.class.fields[tag] = field
@@ -130,27 +92,15 @@ module Protobuf
         end
       end
 
-      # TODO
-      self.class.extension_fields.to_a.each do |tag, field|
-        unless field.ready?
-          field = field.setup
-          self.class.extension_fields[tag] = field
-        end
-        if field.repeated?
-          @values[field.name] = Field::FieldArray.new(field)
-        end
-      end
-
-      values.each {|tag, val| self[tag] = val}
+      values.each {|name, val| self.__send__("#{name}=", val)}
     end
 
     def initialized?
-      fields.all? {|tag, field| field.initialized?(self) } && \
-        extension_fields.all? {|tag, field| field.initialized?(self) }
+      fields.all? {|tag, field| field.initialized?(self) }
     end
 
     def has_field?(tag_or_name)
-      field = get_field(tag_or_name) || get_ext_field(tag_or_name)
+      field = get_field(tag_or_name)
       raise ArgumentError, "unknown field: #{tag_or_name.inspect}" unless field
       @values.has_key?(field.name)
     end
@@ -263,7 +213,7 @@ module Protobuf
       io = StringIO.new(string)
       serialize_to(io)
       result = io.string
-      result.force_encoding(Encoding::ASCII_8BIT) if result.respond_to?(:force_encoding)
+      result.force_encoding(Encoding::BINARY) if result.respond_to?(:force_encoding)
       result
     end
     alias to_s serialize_to_string
@@ -283,23 +233,11 @@ module Protobuf
     end
 
     def merge_from(message)
-      # TODO
-      fields.each {|tag, field| merge_field(tag, message.__send__(field.name))}
-      extension_fields.each {|tag, field| merge_field(tag, message.__send__(field.name))}
-    end
-
-    def set_field(tag, bytes)
-      field = (get_field_by_tag(tag) || get_ext_field_by_tag(tag))
-      field.set(self, bytes) if field
-    end
-
-    def merge_field(tag, value)
-      #get_field_by_tag(tag).merge self, bytes #TODO
-      (get_field_by_tag(tag) || get_ext_field_by_tag(tag)).merge(self, value)
+      fields.each {|tag, field| field.merge(self, message.__send__(field.name))}
     end
 
     def [](tag_or_name)
-      if field = get_field(tag_or_name) || get_ext_field(tag_or_name)
+      if field = get_field(tag_or_name)
         __send__(field.name)
       else
         raise NoMethodError, "No such field: #{tag_or_name.inspect}"
@@ -307,7 +245,7 @@ module Protobuf
     end
 
     def []=(tag_or_name, value)
-      if field = get_field(tag_or_name) || get_ext_field(tag_or_name)
+      if field = get_field(tag_or_name)
         __send__("#{field.name}=", value)
       else
         raise NoMethodError, "No such field: #{tag_or_name.inspect}"
@@ -334,32 +272,34 @@ module Protobuf
       self.class.get_field(tag_or_name)
     end
 
-    # Returns extension fields. See Message#fields method.
-    def extension_fields
-      self.class.extension_fields
-    end
-
-    def get_ext_field_by_name(name) # :nodoc:
-      self.class.get_ext_field_by_name(name)
-    end
-
-    def get_ext_field_by_tag(tag) # :nodoc:
-      self.class.get_ext_field_by_tag(tag)
-    end
-
-    def get_ext_field(tag_or_name) # :nodoc:
-      self.class.get_ext_field(tag_or_name)
-    end
-
     # Iterate over a field collection.
     #   message.each_field do |field_object, value|
     #     # do something
     #   end
     def each_field
-      fields.merge(extension_fields).sort_by {|tag, _| tag}.each do |_, field|
+      @sorted_fields ||= fields.sort_by {|tag, _| tag}
+      @sorted_fields.each do |_, field|
         value = __send__(field.name)
         yield(field, value)
       end
     end
+
+    def to_hash
+      hash = {}
+      each_field do |field, value|
+        next unless has_field?(field.tag)
+        case value
+        when Array
+          next if value.empty?
+          hash[field.name] = value.map {|val| val.is_a?(Message) ? val.to_hash : val}
+        when Message
+          hash[field.name] = value.to_hash
+        else
+          hash[field.name] = value
+        end
+      end
+      hash
+    end
+
   end
 end

data/test/proto/merge.pb.rb

@@ -8,12 +8,12 @@
 #   }
 #   message InnerMessage2 {
 #     required string name = 1;
-#     repeated InnerMessage1 repeate_message = 2;
+#     repeated InnerMessage1 repeated_message = 2;
 #   }
 # 
 #   required string name = 1;
-#   repeated InnerMessage1 repeate_message = 2;
-#   required InnerMessage2 require_message = 3;
+#   repeated InnerMessage1 repeated_message = 2;
+#   required InnerMessage2 required_message = 3;
 # }
 
 require 'protobuf/message/message'
@@ -31,10 +31,10 @@ module Test
     class InnerMessage2 < ::Protobuf::Message
       defined_in __FILE__
       required :string, :name, 1
-      repeated :InnerMessage1, :repeate_message, 2
+      repeated :InnerMessage1, :repeated_message, 2
     end
     required :string, :name, 1
-    repeated :InnerMessage1, :repeate_message, 2
-    required :InnerMessage2, :require_message, 3
+    repeated :InnerMessage1, :repeated_message, 2
+    required :InnerMessage2, :required_message, 3
   end
 end

data/test/proto/merge.proto

@@ -6,10 +6,10 @@ message MergeMessage {
   }
   message InnerMessage2 {
     required string name = 1;
-    repeated InnerMessage1 repeate_message = 2;
+    repeated InnerMessage1 repeated_message = 2;
   }
 
   required string name = 1;
-  repeated InnerMessage1 repeate_message = 2;
-  required InnerMessage2 require_message = 3;
+  repeated InnerMessage1 repeated_message = 2;
+  required InnerMessage2 required_message = 3;
 }

data/test/test_enum_value.rb

@@ -30,9 +30,10 @@ class EnumValueTest < Test::Unit::TestCase
     assert_equal(1, phone_number.type)
 
     phone_number.type = :HOME
-    assert_kind_of(Protobuf::EnumValue, phone_number.type)
     assert_equal(Tutorial::Person::PhoneType::HOME, phone_number.type)
-    assert_equal(1, phone_number.type)
+
+    phone_number.type = 'HOME'
+    assert_equal(Tutorial::Person::PhoneType::HOME, phone_number.type)
 
     assert_raise(TypeError) do
       phone_number.type = TutorialExt::Person::PhoneType::HOME

data/test/test_extension.rb

@@ -3,8 +3,8 @@ require 'test/proto/addressbook_ext.pb'
 
 class ExtensionTest < Test::Unit::TestCase
   def test_accessor
-    assert(TutorialExt::Person.extension_fields.to_a.map{|t, f| f.name}.include?(:age))
     person = TutorialExt::Person.new
+    assert(TutorialExt::Person.get_field(:age).extension)
     assert_nothing_raised {person.age = 100}
     assert_equal(100, person.age)
   end

data/test/test_message.rb

@@ -32,26 +32,32 @@ class MessageTest < Test::Unit::TestCase
   end
 
   def test_initialize_with_hash
-    person = Tutorial::Person.new(:name => 'Jiro', :id => 300, :email => 'jiro@ema.il')
+    hash = { :name => 'Jiro', :id => 300, :email => 'jiro@ema.il' }
+    person = Tutorial::Person.new(hash)
     assert_equal('Jiro', person.name)
     assert_equal(300, person.id)
     assert_equal('jiro@ema.il', person.email)
+    assert_equal(hash, person.to_hash)
 
     # initialize with array of hash
-    person = Tutorial::Person.new(:phone => [{:number => 'phone1'}, {:number => 'phone2'}])
+    hash = { :phone => [{:number => 'phone1'}, {:number => 'phone2'}] }
+    person = Tutorial::Person.new(hash)
     assert_equal('phone1', person.phone[0].number)
     assert_equal('phone2', person.phone[1].number)
+    assert_equal(hash, person.to_hash)
 
     # initalize with hash in hash
-    message = Test::MergeMessage.new(:require_message => { :name => 'name1', :repeate_message => [{:name => 'name2'}] })
-    assert_equal('name1', message.require_message.name)
-    assert_equal('name2', message.require_message.repeate_message[0].name)
-
-    message.require_message = { :name => 'name21' }
-    message.require_message.repeate_message = [ {:name => 'name22'} ]
-    assert_equal('name21', message.require_message.name)
-    assert_equal('name22', message.require_message.repeate_message[0].name)
-    assert_equal(1,        message.require_message.repeate_message.size)
+    hash = { :required_message => { :name => 'name1', :repeated_message => [{:name => 'name2'}] } }
+    message = Test::MergeMessage.new(hash)
+    assert_equal('name1', message.required_message.name)
+    assert_equal('name2', message.required_message.repeated_message[0].name)
+    assert_equal(hash, message.to_hash)
+
+    message.required_message = { :name => 'name21' }
+    message.required_message.repeated_message = [ {:name => 'name22'} ]
+    assert_equal('name21', message.required_message.name)
+    assert_equal('name22', message.required_message.repeated_message[0].name)
+    assert_equal(1,        message.required_message.repeated_message.size)
   end
 
   def test_defined_filenames
@@ -106,23 +112,23 @@ message AddressBook {
 
   def test_merge_field
     inner_message1_2 = Test::MergeMessage::InnerMessage2.new(:name => 'name12')
-    inner_message1_2.repeate_message << Test::MergeMessage::InnerMessage1.new(:name => 'name121')
-    message1 = Test::MergeMessage.new(:name => 'name1', :require_message => inner_message1_2)
-    message1.repeate_message << Test::MergeMessage::InnerMessage1.new(:name => 'name11')
+    inner_message1_2.repeated_message << Test::MergeMessage::InnerMessage1.new(:name => 'name121')
+    message1 = Test::MergeMessage.new(:name => 'name1', :required_message => inner_message1_2)
+    message1.repeated_message << Test::MergeMessage::InnerMessage1.new(:name => 'name11')
 
     inner_message2_2 = Test::MergeMessage::InnerMessage2.new(:name => 'name22')
-    inner_message2_2.repeate_message << Test::MergeMessage::InnerMessage1.new(:name => 'name221')
-    message2 = Test::MergeMessage.new(:name => 'name2', :require_message => inner_message2_2)
-    message2.repeate_message << Test::MergeMessage::InnerMessage1.new(:name => 'name21')
+    inner_message2_2.repeated_message << Test::MergeMessage::InnerMessage1.new(:name => 'name221')
+    message2 = Test::MergeMessage.new(:name => 'name2', :required_message => inner_message2_2)
+    message2.repeated_message << Test::MergeMessage::InnerMessage1.new(:name => 'name21')
 
     message1.merge_from(message2)
     assert_equal('name2', message1.name)
-    assert_equal(2, message1.repeate_message.size)
-    assert_equal('name11', message1.repeate_message[0].name)
-    assert_equal('name21', message1.repeate_message[1].name)
-    assert_equal('name22', message1.require_message.name)
-    assert_equal(2, message1.require_message.repeate_message.size)
-    assert_equal('name121', message1.require_message.repeate_message[0].name)
-    assert_equal('name221', message1.require_message.repeate_message[1].name)
+    assert_equal(2, message1.repeated_message.size)
+    assert_equal('name11', message1.repeated_message[0].name)
+    assert_equal('name21', message1.repeated_message[1].name)
+    assert_equal('name22', message1.required_message.name)
+    assert_equal(2, message1.required_message.repeated_message.size)
+    assert_equal('name121', message1.required_message.repeated_message[0].name)
+    assert_equal('name221', message1.required_message.repeated_message[1].name)
   end
 end

data/test/test_packed_field.rb

@@ -37,4 +37,9 @@ class PackedFieldTest < Test::Unit::TestCase
     end
   end
 
+  def test_empty_packed_field
+    message = Test::PackedField::Message.new
+    assert_equal('', message.to_s)
+  end
+
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 5
-  version: 0.4.5
+  - 6
+  version: 0.4.6
 platform: ruby
 authors: 
 - MATSUYAMA Kengo
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-17 00:00:00 +09:00
+date: 2010-09-12 00:00:00 +09:00
 default_executable: rprotoc
 dependencies: []
 
@@ -147,38 +147,33 @@ signing_key:
 specification_version: 3
 summary: Protocol Buffers for Ruby
 test_files: 
+- test/check_unbuild.rb
+- test/test_descriptor.rb
+- test/test_optional_field.rb
+- test/proto/merge.pb.rb
+- test/proto/ext_collision.pb.rb
+- test/proto/lowercase.pb.rb
+- test/proto/addressbook_base.pb.rb
 - test/proto/packed.pb.rb
-- test/proto/types.pb.rb
+- test/proto/optional_field.pb.rb
 - test/proto/addressbook.pb.rb
-- test/proto/ext_range.pb.rb
+- test/proto/addressbook_ext.pb.rb
 - test/proto/nested.pb.rb
-- test/proto/client_search.rb
-- test/proto/addressbook_base.pb.rb
-- test/proto/rpc.pb.rb
-- test/proto/address_book_service.rb
+- test/proto/ext_range.pb.rb
+- test/proto/types.pb.rb
 - test/proto/collision.pb.rb
-- test/proto/optional_field.pb.rb
-- test/proto/merge.pb.rb
-- test/proto/addressbook_ext.pb.rb
-- test/proto/client_add.rb
-- test/proto/float_default.pb.rb
-- test/proto/lowercase.pb.rb
-- test/proto/ext_collision.pb.rb
-- test/test_compiler.rb
-- test/test_parse.rb
-- test/test_addressbook.rb
-- test/test_extension.rb
-- test/test_lowercase.rb
-- test/test_standard_message.rb
 - test/test_enum_value.rb
-- test/test_message.rb
-- test/test_types.rb
 - test/test_repeated_types.rb
-- test/test_descriptor.rb
-- test/test_optional_field.rb
-- test/test_packed_field.rb
+- test/test_types.rb
+- test/test_extension.rb
 - test/test_serialize.rb
-- test/check_unbuild.rb
-- examples/addressbook.pb.rb
+- test/test_standard_message.rb
+- test/test_packed_field.rb
+- test/test_lowercase.rb
+- test/test_compiler.rb
+- test/test_message.rb
+- test/test_parse.rb
+- test/test_addressbook.rb
 - examples/writing_a_message.rb
 - examples/reading_a_message.rb
+- examples/addressbook.pb.rb