ruby_protobuf 0.3.2 → 0.3.3

data/lib/protobuf/message/message.rb

@@ -29,7 +29,7 @@ module Protobuf
 
     class <<self
       include Protobuf::Protoable
-      def fields; @fields ||= [] end #attr_reader :fields
+      def fields; @fields ||= {} end
 
       def extensions(range)
         @extension_fields = ExtensionFields.new range
@@ -53,7 +53,6 @@ module Protobuf
           Field number #{tag} has already been used in "#{self.name}" by field "#{fname}".
         eos
         field_hash[tag] = Protobuf::Field.build self, rule, type, fname, tag, opts
-        #(@fields ||= {})[tag] = Protobuf::Field.build self, rule, type, fname, tag, opts
       end
 
       def extension_tag?(tag)
@@ -65,7 +64,8 @@ module Protobuf
       end
 
       def get_field_by_name(name)
-        fields.values.find {|field| field.name == name.to_sym}
+        name = name.to_sym
+        fields.values.find {|field| field.name == name}
       end
 
       def get_field_by_tag(tag)
@@ -82,7 +82,8 @@ module Protobuf
 
       #TODO merge to get_field_by_name
       def get_ext_field_by_name(name)
-        extension_fields.values.find {|field| field.name == name.to_sym}
+        name = name.to_sym
+        extension_fields.values.find {|field| field.name == name}
       end
 
       #TODO merge to get_field_by_tag
@@ -105,12 +106,16 @@ module Protobuf
     end
 
     def initialize(values={})
-      fields.each do |tag, field|
+      @values = {}
+
+      self.class.fields.each do |tag, field|
         unless field.ready?
           field = field.setup
           self.class.class_eval {@fields[tag] = field}
         end
-        field.define_accessor self
+        if field.repeated?
+          @values[field.name] = Protobuf::Field::FieldArray.new(field)
+        end
       end
 
       # TODO
@@ -119,25 +124,29 @@ module Protobuf
           field = field.setup
           self.class.class_eval {@extension_fields[tag] = field}
         end
-        field.define_accessor self
+        if field.repeated?
+          @values[field.name] = Protobuf::Field::FieldArray.new(field)
+        end
       end
 
       values.each {|tag, val| self[tag] = val}
     end
 
     def initialized?
-      fields.to_a.inject(true) do |result, (tag, field)|
-        result and field.initialized?(self)
-      end and
-      extension_fields.to_a.inject(true) do |result, (tag, field)|
-        result and field.initialized?(self)
-      end
+      fields.all? {|tag, field| field.initialized?(self) } && \
+      extension_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)
+      raise ArgumentError.new("unknown field: #{tag_or_name.inspect}") unless field
+      @values.has_key?(field.name)
     end
 
     def ==(obj)
       return false unless obj.is_a? self.class
       each_field do |field, value|
-        return false unless value == obj[field.name]
+        return false unless value == obj.send(field.name)
       end
       true
     end
@@ -152,11 +161,12 @@ module Protobuf
       ret = self.class.new
       each_field do |field, value|
         if field.repeated?
+          field_array = ret.send(field.name)
           value.each do |v|
-            ret[field.name] << (v.is_a?(Numeric) ? v : v.dup)
+            field_array << (v.is_a?(Numeric) ? v : v.dup)
           end
         else
-          ret[field.name] = value.is_a?(Numeric) ? value : value.dup
+          ret.send("#{field.name}=", value.is_a?(Numeric) ? value : value.dup)
         end
       end
       ret
@@ -168,11 +178,31 @@ module Protobuf
       field_value_to_string = lambda do |field, value|
         ret +=
           if field.is_a? Protobuf::Field::MessageField
-            "#{i}#{field.name} {\n#{value.inspect(indent + 1)}#{i}}\n"
+            if value.nil?
+              if $DEBUG
+                "#{i}#{field.name} {\n#{'  ' * (indent + 1)}nil\n#{i}}\n"
+              else
+                "#{i}#{field.name} {}\n"
+              end
+            else
+              "#{i}#{field.name} {\n#{value.inspect(indent + 1)}#{i}}\n"
+            end
           elsif field.is_a? Protobuf::Field::EnumField
-            "#{i}#{field.name}: #{field.type.name_by_value(value)}\n"
+	    if field.optional? and not has_field?(field.name)
+	      ''
+	    else
+              "#{i}#{field.name}: #{field.type.name_by_value(value)}\n"
+            end
           else
-            "#{i}#{field.name}: #{value.inspect}\n"
+            if $DEBUG
+              "#{i}#{field.name}: #{value.inspect}\n"
+            else
+              if field.optional? and not has_field?(field.name)
+                ''
+              else
+                "#{i}#{field.name}: #{value.inspect}\n"
+              end
+            end
           end
       end
       each_field do |field, value|
@@ -195,7 +225,7 @@ module Protobuf
       if filename.is_a? File
         parse_from filename
       else
-        File.open(filename, 'r') do |f|
+        File.open(filename, 'rb') do |f|
           parse_from f
         end
       end
@@ -208,7 +238,9 @@ module Protobuf
     def serialize_to_string(string='')
       io = StringIO.new string
       serialize_to io
-      io.string
+      result = io.string
+      result.force_encoding('ASCII-8BIT') if result.respond_to?(:force_encoding)
+      result
     end
     alias to_s serialize_to_string
 
@@ -216,7 +248,7 @@ module Protobuf
       if filename.is_a? File
         serialize_to filename
       else
-        File.open(filename, 'w') do |f|
+        File.open(filename, 'wb') do |f|
           serialize_to f
         end
       end
@@ -233,8 +265,8 @@ module Protobuf
     end
 
     def set_field(tag, bytes)
-      #get_field_by_tag(tag).set self, bytes # TODO
-      (get_field_by_tag(tag) or get_ext_field_by_tag(tag)).set self, bytes
+      field = (get_field_by_tag(tag) or get_ext_field_by_tag(tag))
+      field.set self, bytes if field
     end
     
     def merge_field(tag, value)
@@ -243,22 +275,18 @@ module Protobuf
     end
     
     def [](tag_or_name)
-      if field = get_field(tag_or_name)
-        send field.name
-      elsif field = get_ext_field(tag_or_name)
+      if field = get_field(tag_or_name) || get_ext_field(tag_or_name)
         send field.name
       else
-        raise NoMethodError.new("No such method: #{tag_or_name.inspect}")
+        raise NoMethodError.new("No such field: #{tag_or_name.inspect}")
       end
     end
 
     def []=(tag_or_name, value)
-      if field = get_field(tag_or_name) and not field.repeated?
-        send "#{field.name}=", value
-      elsif field = get_ext_field(tag_or_name) and not field.repeated?
+      if field = get_field(tag_or_name) || get_ext_field(tag_or_name)
         send "#{field.name}=", value
       else
-        raise NoMethodError.new("No such method: #{tag_or_name.inspect}")
+        raise NoMethodError.new("No such field: #{tag_or_name.inspect}")
       end
     end
 
@@ -272,9 +300,9 @@ module Protobuf
     def get_ext_field_by_tag(tag); self.class.get_ext_field_by_tag(tag) end
     def get_ext_field(tag_or_name); self.class.get_ext_field(tag_or_name) end
 
-    def each_field(&block)
-      (fields.merge extension_fields).to_a.sort{|(t1, f1), (t2, f2)| t1 <=> t2}.each do |tag, field|
-        block.call field, self[tag]
+    def each_field
+      (fields.merge extension_fields).sort_by {|tag, field| tag}.each do |tag, field|
+        yield field, send(field.name)
       end
     end
   end

data/lib/ruby_protobuf.rb

@@ -1,3 +1,3 @@
 class RubyProtobuf
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/test/merge.rb

@@ -37,4 +37,4 @@ module Test
     repeated :InnerMessage1, :repeate_message, 2
     required :InnerMessage2, :require_message, 3
   end
-end
+end

data/test/proto/types.proto

@@ -14,4 +14,24 @@ message TestTypes {
   required bool type11 = 11;
   required string type12 = 12;
   required bytes type13 = 13;
+  required sfixed32 type14 = 14;
+  required sfixed64 type15 = 15;
+}
+
+message RepeatedTypes {
+  repeated double type1 = 1;
+  repeated float type2 = 2;
+  repeated int32 type3 = 3;
+  repeated int64 type4 = 4;
+  repeated uint32 type5 = 5;
+  repeated uint64 type6 = 6;
+  repeated sint32 type7 = 7;
+  repeated sint64 type8 = 8;
+  repeated fixed32 type9 = 9;
+  repeated fixed64 type10 = 10;
+  repeated bool type11 = 11;
+  repeated string type12 = 12;
+  repeated bytes type13 = 13;
+  repeated sfixed32 type14 = 14;
+  repeated sfixed64 type15 = 15;
 }

data/test/test_addressbook.rb

@@ -6,6 +6,7 @@ require 'test/addressbook'
 class AddressbookTest < Test::Unit::TestCase
   def test_enum
     phone_number = Tutorial::Person::PhoneNumber.new
+    assert_equal Tutorial::Person::PhoneType::HOME, phone_number.type
     phone_number.type = Tutorial::Person::PhoneType::MOBILE
     assert_equal 0, phone_number.type
     phone_number.type = Tutorial::Person::PhoneType::HOME

data/test/test_compiler.rb

@@ -8,7 +8,15 @@ class CompilerTest < Test::Unit::TestCase
     assert_compile_proto <<-eos, 'test/proto/float_default.proto'
 ### Generated by rprotoc. DO NOT EDIT!
 ### <proto file: test/proto/float_default.proto>
-# message M {  optional float f = 1 [default = 4.2];  }
+# message M {  
+#   optional float f = 1 [default = 4.2];  
+#   optional float g = 2 [default = -4.2];  
+#   optional float h = 3 [default = 4352];
+#   optional float i = 4 [default = 23145.2 ];
+#   optional float j = 5 [default = -5 ];
+#   optional float k = 6 [default = +23 ];
+#   optional float l = 7 [default = +23.42 ];
+# }
 # 
 
 require 'protobuf/message/message'
@@ -19,6 +27,12 @@ require 'protobuf/message/extend'
 class M < ::Protobuf::Message
   defined_in __FILE__
   optional :float, :f, 1, :default => 4.2
+  optional :float, :g, 2, :default => -4.2
+  optional :float, :h, 3, :default => 4352
+  optional :float, :i, 4, :default => 23145.2
+  optional :float, :j, 5, :default => -5
+  optional :float, :k, 6, :default => 23
+  optional :float, :l, 7, :default => 23.42
 end
     eos
   end
@@ -136,15 +150,15 @@ end
   def test_nested_message
     Protobuf::Visitor::CreateMessageVisitor.instance_eval {remove_const :Baaz}
     file_contents = Protobuf::Compiler.new.create_message('test/proto/nested.proto', '.', '.', false)
-    assert_nothing_raised {eval file_contents}
+    assert_nothing_raised {Object.class_eval file_contents}
     assert_raise(TypeError) {Baaz.new.x = 1}
     assert_nothing_raised {Baaz.new.x = Foo::Bar.new}
   end
 
   def test_create_rpc
-    file_contents = Protobuf::Compiler.new.create_rpc('test/proto/rpc.proto', '.', '.', false)
+    file_contents = Protobuf::Compiler.new.create_rpc('test/proto/rpc.proto', '.', 'test/proto', false)
 
-    assert_source <<-eos, file_contents['./test/proto/address_book_service.rb']
+    assert_source <<-eos, file_contents['test/proto/address_book_service.rb']
 require 'protobuf/rpc/server'
 require 'protobuf/rpc/handler'
 require 'test/proto/rpc.pb'
@@ -177,14 +191,14 @@ class Tutorial::AddressBookService < Protobuf::Rpc::Server
 end
     eos
 
-    assert_source <<-eos, file_contents['./test/proto/start_address_book_service']
+    assert_source <<-eos, file_contents['test/proto/start_address_book_service']
 #!/usr/bin/env ruby
 require 'address_book_service'
 
 Tutorial::AddressBookService.new(:port => 9999).start
     eos
 
-    assert_source <<-eos, file_contents['./test/proto/client_search.rb']
+    assert_source <<-eos, file_contents['test/proto/client_search.rb']
 #!/usr/bin/env ruby
 require 'protobuf/rpc/client'
 require 'test/proto/rpc.pb'
@@ -204,7 +218,7 @@ Protobuf::Rpc::Client.new('localhost', 9999).call :search, request, response
 puts response
     eos
 
-    assert_source <<-eos, file_contents['./test/proto/client_add.rb']
+    assert_source <<-eos, file_contents['test/proto/client_add.rb']
 #!/usr/bin/env ruby
 require 'protobuf/rpc/client'
 require 'test/proto/rpc.pb'

data/test/test_message.rb

@@ -3,6 +3,9 @@ require 'test/addressbook'
 require 'test/merge'
 require 'test/unit'
 
+# It should not conflict with Test::InnerMessage1 which is included in merge.proto
+class InnerMessage1; end
+
 class MessageTest < Test::Unit::TestCase
   def test_equality
     person1 = Tutorial::Person.new :name => 'ando'
@@ -33,6 +36,22 @@ class MessageTest < Test::Unit::TestCase
     assert_equal 'Jiro', person.name
     assert_equal 300, person.id
     assert_equal 'jiro@ema.il', person.email
+
+    # initialize with array of hash
+    person = Tutorial::Person.new(:phone => [{:number => 'phone1'}, {:number => 'phone2'}])
+    assert_equal 'phone1', person.phone[0].number
+    assert_equal 'phone2', person.phone[1].number
+
+    # 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
   end
 
   def test_defined_filenames

data/test/test_optional_field.rb

@@ -0,0 +1,80 @@
+require 'test/unit'
+require 'test/optional_field'
+
+class OptionalFieldTest < Test::Unit::TestCase
+  def test_accessor
+    message = Test::Optional_field::Message.new
+
+    # default values
+    assert !message.has_field?(:number)
+    assert_equal 20, message.number
+
+    assert !message.has_field?(:text)
+    assert_equal 'default string', message.text
+
+    assert !message.has_field?(:enum)
+    assert_equal 2, message.enum
+
+    assert !message.has_field?(:signed)
+    assert_equal(-100, message.signed)
+
+    # assign values
+    assert_nothing_raised { message.number = 100 }
+    assert message.has_field?(:number)
+    assert_equal 100, message.number
+
+    assert_nothing_raised { message.text = 'abc' }
+    assert message.has_field?(:text)
+    assert_equal 'abc', message.text
+
+    assert_nothing_raised { message.enum = Test::Optional_field::Message::Enum::A }
+    assert message.has_field?(:enum)
+    assert_equal 1, message.enum
+
+    assert_nothing_raised { message.signed = -20 }
+    assert message.has_field?(:signed)
+    assert_equal(-20, message.signed)
+  end
+
+  def test_serialize
+    message1 = Test::Optional_field::Message.new
+    message2 = Test::Optional_field::Message.new
+
+    # all fields are empty
+    serialized_string = message1.to_s
+    assert serialized_string.empty?
+    message2.parse_from_string(serialized_string)
+    assert_equal message1.number, message2.number
+    assert_equal message1.text,   message2.text
+    assert_equal message1.enum,   message2.enum
+    assert_equal message1.signed, message2.signed
+    assert !message2.has_field?(:number)
+    assert !message2.has_field?(:text)
+    assert !message2.has_field?(:enum)
+    assert !message2.has_field?(:signed)
+
+    # assign the value whith is equal to default value
+    message1 = Test::Optional_field::Message.new
+    message1.number = message1.number
+    message1.text   = message1.text
+    message1.enum   = message1.enum
+    message1.signed = message1.signed
+    serialized_string = message1.to_s
+    assert !serialized_string.empty?
+
+    # set some fields
+    message1 = Test::Optional_field::Message.new
+    message1.number = 100
+    message1.text   = 'new text'
+    serialized_string = message1.to_s
+    message2.parse_from_string(serialized_string)
+    assert_equal message1.number, message2.number
+    assert_equal message1.text,   message2.text
+    assert_equal message1.enum,   message2.enum
+    assert_equal message1.signed, message2.signed
+    assert  message2.has_field?(:number)
+    assert  message2.has_field?(:text)
+    assert !message2.has_field?(:enum)
+    assert !message2.has_field?(:signed)
+  end
+end