ruby_protobuf 0.3.0 → 0.3.2

data/lib/protobuf/message/message.rb

@@ -1,15 +1,17 @@
 require 'pp'
 require 'stringio'
+require 'protobuf/descriptor/descriptor'
 require 'protobuf/message/decoder'
 require 'protobuf/message/encoder'
 require 'protobuf/message/field'
-require 'protobuf/descriptor/descriptor'
+require 'protobuf/message/protoable'
 
 module Protobuf
   OPTIONS = {}
 
-
   class Message
+    class TagCollisionError < StandardError; end
+
     class ExtensionFields < Hash
       def initialize(key_range=0..-1)
         @key_range = key_range
@@ -26,7 +28,8 @@ module Protobuf
     end
 
     class <<self
-      attr_reader :fields
+      include Protobuf::Protoable
+      def fields; @fields ||= [] end #attr_reader :fields
 
       def extensions(range)
         @extension_fields = ExtensionFields.new range
@@ -44,10 +47,13 @@ module Protobuf
         define_field :repeated, type, name, tag, opts
       end
 
-      def define_field(rule, type, name, tag, opts={})
+      def define_field(rule, type, fname, tag, opts={})
         field_hash = opts[:extension] ? extension_fields : (@fields ||= {})
-        field_hash[tag] = Protobuf::Field.build self, rule, type, name, tag, opts
-        #(@fields ||= {})[tag] = Protobuf::Field.build self, rule, type, name, tag, opts
+        raise Protobuf::Message::TagCollisionError.new(<<-eos.strip) if field_hash.keys.include? tag
+          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)
@@ -70,7 +76,7 @@ module Protobuf
         case tag_or_name
         when Integer; get_field_by_tag tag_or_name
         when String, Symbol; get_field_by_name tag_or_name
-        else; raise TypeError
+        else; raise TypeError.new(tag_or_name.class)
         end
       end
 
@@ -89,7 +95,7 @@ module Protobuf
         case tag_or_name
         when Integer; get_ext_field_by_tag tag_or_name
         when String, Symbol; get_ext_field_by_name tag_or_name
-        else; raise TypeError
+        else; raise TypeError.new(tag_or_name.class)
         end
       end
 
@@ -98,7 +104,7 @@ module Protobuf
       end
     end
 
-    def initialize
+    def initialize(values={})
       fields.each do |tag, field|
         unless field.ready?
           field = field.setup
@@ -115,6 +121,8 @@ module Protobuf
         end
         field.define_accessor self
       end
+
+      values.each {|tag, val| self[tag] = val}
     end
 
     def initialized?
@@ -126,6 +134,14 @@ module Protobuf
       end
     end
 
+    def ==(obj)
+      return false unless obj.is_a? self.class
+      each_field do |field, value|
+        return false unless value == obj[field.name]
+      end
+      true
+    end
+
     def clear!
       each_field do |field, value|
         field.clear self
@@ -146,13 +162,13 @@ module Protobuf
       ret
     end
 
-    def to_s(indent=0)
+    def inspect(indent=0)
       ret = ''
       i = '  ' * indent
       field_value_to_string = lambda do |field, value|
         ret +=
           if field.is_a? Protobuf::Field::MessageField
-            "#{i}#{field.name} {\n#{value.to_s(indent + 1)}#{i}}\n"
+            "#{i}#{field.name} {\n#{value.inspect(indent + 1)}#{i}}\n"
           elsif field.is_a? Protobuf::Field::EnumField
             "#{i}#{field.name}: #{field.type.name_by_value(value)}\n"
           else
@@ -194,6 +210,7 @@ module Protobuf
       serialize_to io
       io.string
     end
+    alias to_s serialize_to_string
 
     def serialize_to_file(filename)
       if filename.is_a? File
@@ -209,14 +226,20 @@ module Protobuf
       Protobuf::Encoder.encode stream, self
     end
 
+    def merge_from(message)
+      # TODO
+      fields.each {|tag, field| merge_field tag, message[tag]}
+      self.class.extension_fields.each {|tag, field| merge_field tag, message[tag]}
+    end
+
     def set_field(tag, bytes)
-      #get_field_by_tag(tag).set self, 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
     end
     
     def merge_field(tag, value)
-      # TODO
-      #get_field_by_tag(tag).merge self, bytes
+      #get_field_by_tag(tag).merge self, bytes #TODO
+      (get_field_by_tag(tag) or get_ext_field_by_tag(tag)).merge self, value
     end
     
     def [](tag_or_name)

data/lib/protobuf/message/protoable.rb

@@ -0,0 +1,37 @@
+module Protobuf
+  module Protoable
+    def defined_filenames
+      @defined_filenames ||= []
+    end
+
+    def defined_in(filename)
+      defined_filenames << File.expand_path(filename)
+    end
+
+    def proto_filenames
+      defined_filenames.map do |filename|
+        retrieve_header(File.read(filename)).first
+      end
+    end
+
+    def proto_contents
+      #TODO: temporary implementation because the result includes not only this message but also all messages
+      ret = {}
+      defined_filenames.map do |filename|
+        header = retrieve_header File.read(filename)
+        ret[header.first] = header.last
+      end
+      ret
+    end
+
+    def retrieve_header(contents)
+      if contents =~ /### Generated by rprotoc\. DO NOT EDIT!\n### <proto file: (.*)>\n((# .*\n)+)/
+        proto_filename = $1
+        proto_contents = $2.gsub(/^# /, '')
+        [proto_filename, proto_contents]
+      else
+        [nil, nil]
+      end
+    end
+  end
+end

data/lib/ruby_protobuf.rb

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

data/test/addressbook.rb

@@ -1,3 +1,35 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: test/addressbook.proto>
+# package tutorial;
+# 
+# message Person {
+#   required string name = 1;
+#   required int32 id = 2;
+#   optional string email = 3;
+# 
+#   enum PhoneType {
+#     MOBILE = 0;
+#     HOME = 1;
+#     WORK = 2;
+#   }
+# 
+#   message PhoneNumber {
+#     required string number = 1;
+#     optional PhoneType type = 2 [default = HOME];
+#   }
+# 
+#   repeated PhoneNumber phone = 4;
+# 
+#   extensions 100 to 200;
+# }
+# 
+# extend Person {
+#   optional int32 age = 100;
+# }
+# 
+# message AddressBook {
+#   repeated Person person = 1;
+# }
 require 'protobuf/message/message'
 require 'protobuf/message/enum'
 require 'protobuf/message/service'
@@ -6,17 +38,20 @@ require 'protobuf/message/extend'
 module Tutorial
   
   class Person < ::Protobuf::Message
+    defined_in __FILE__
     required :string, :name, 1
     required :int32, :id, 2
     optional :string, :email, 3
     
     class PhoneType < ::Protobuf::Enum
+      defined_in __FILE__
       MOBILE = 0
       HOME = 1
       WORK = 2
     end
     
     class PhoneNumber < ::Protobuf::Message
+      defined_in __FILE__
       required :string, :number, 1
       optional :PhoneType, :type, 2, {:default => :HOME}
     end
@@ -32,6 +67,7 @@ module Tutorial
   #end
   
   class AddressBook < ::Protobuf::Message
+    defined_in __FILE__
     repeated :Person, :person, 1
   end
 

data/test/check_unbuild.rb

@@ -1,4 +1,4 @@
-#!/usr/local/bin/ruby
+#!/usr/bin/env ruby
 
 $:.push "#{File.dirname(__FILE__)}/../lib"
 

data/test/collision.rb

@@ -0,0 +1,18 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: test/proto/collision.proto>
+# message CollisionTest {
+#   optional string a = 1;
+#   optional string b = 1;
+# }
+# 
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+class CollisionTest < ::Protobuf::Message
+  defined_in __FILE__
+  optional :string, :a, 1
+  optional :string, :b, 1
+end

data/test/ext_collision.rb

@@ -0,0 +1,25 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: test/proto/ext_collision.proto>
+# message ExtCollisionTest {
+#   extensions 1 to 10;
+# }
+# 
+# message ExtCollisionTest {
+#   optional string a = 1;
+#   optional string b = 1;
+# }
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+class ExtCollisionTest < ::Protobuf::Message
+  defined_in __FILE__
+  extensions 1..10
+end
+class ExtCollisionTest < ::Protobuf::Message
+  defined_in __FILE__
+  optional :string, :a, 1
+  optional :string, :b, 1
+end

data/test/ext_range.rb

@@ -0,0 +1,23 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: test/proto/ext_range.proto>
+# message ExtCollisionTest {
+#   extensions 1 to 10;
+# }
+# 
+# message ExtCollisionTest {
+#   optional string a = 11;
+# }
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+class ExtCollisionTest < ::Protobuf::Message
+  defined_in __FILE__
+  extensions 1..10
+end
+class ExtCollisionTest < ::Protobuf::Message
+  defined_in __FILE__
+  optional :string, :a, 11, :extension => true
+end

data/test/merge.rb

@@ -0,0 +1,40 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: test/merge.proto>
+# package test;
+# 
+# message MergeMessage {
+#   message InnerMessage1 {
+#     required string name = 1;
+#   }
+#   message InnerMessage2 {
+#     required string name = 1;
+#     repeated InnerMessage1 repeate_message = 2;
+#   }
+# 
+#   required string name = 1;
+#   repeated InnerMessage1 repeate_message = 2;
+#   required InnerMessage2 require_message = 3;
+# }
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+module Test
+  class MergeMessage < ::Protobuf::Message
+    defined_in __FILE__
+    class InnerMessage1 < ::Protobuf::Message
+      defined_in __FILE__
+      required :string, :name, 1
+    end
+    class InnerMessage2 < ::Protobuf::Message
+      defined_in __FILE__
+      required :string, :name, 1
+      repeated :InnerMessage1, :repeate_message, 2
+    end
+    required :string, :name, 1
+    repeated :InnerMessage1, :repeate_message, 2
+    required :InnerMessage2, :require_message, 3
+  end
+end

data/test/nested.rb

@@ -0,0 +1,25 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: test/nested.proto>
+# message Foo {  
+#   message Bar {
+#   } 
+# }
+# message Baaz {  
+#   optional Foo.Bar x = 1;
+# }
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+class Foo < ::Protobuf::Message
+  defined_in __FILE__
+  class Bar < ::Protobuf::Message
+    defined_in __FILE__
+  end
+end
+class Baaz < ::Protobuf::Message
+  defined_in __FILE__
+  optional :'Foo::Bar', :x, 1
+end

data/test/proto/addressbook.pb.rb

@@ -0,0 +1,69 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: test/proto/addressbook.proto>
+# package tutorial;
+# 
+# message Person {
+#   required string name = 1;
+#   required int32 id = 2;
+#   optional string email = 3;
+# 
+#   enum PhoneType {
+#     MOBILE = 0;
+#     HOME = 1;
+#     WORK = 2;
+#   }
+# 
+#   message PhoneNumber {
+#     required string number = 1;
+#     optional PhoneType type = 2 [default = HOME];
+#   }
+# 
+#   repeated PhoneNumber phone = 4;
+#   optional uint32 age = 5 [default = 20];
+# 
+#   extensions 100 to 200;
+# }
+# 
+# extend Person {
+#   optional int32 age = 100;
+# }
+# 
+# message AddressBook {
+#   repeated Person person = 1;
+# }
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+module Tutorial
+  class Person < ::Protobuf::Message
+    defined_in __FILE__
+    required :string, :name, 1
+    required :int32, :id, 2
+    optional :string, :email, 3
+    class PhoneType < ::Protobuf::Enum
+      defined_in __FILE__
+      MOBILE = 0
+      HOME = 1
+      WORK = 2
+    end
+    class PhoneNumber < ::Protobuf::Message
+      defined_in __FILE__
+      required :string, :number, 1
+      optional :PhoneType, :type, 2, :default => :HOME
+    end
+    repeated :PhoneNumber, :phone, 4
+    optional :uint32, :age, 5, :default => 20
+    extensions 100..200
+  end
+  class Person < ::Protobuf::Message
+    defined_in __FILE__
+    optional :int32, :age, 100, :extension => true
+  end
+  class AddressBook < ::Protobuf::Message
+    defined_in __FILE__
+    repeated :Person, :person, 1
+  end
+end