ruby_protobuf 0.3.0 → 0.3.2

data/test/{addressbook.proto → proto/addressbook.proto}

@@ -17,6 +17,7 @@ message Person {
   }
 
   repeated PhoneNumber phone = 4;
+  optional uint32 age = 5 [default = 20];
 
   extensions 100 to 200;
 }

data/test/proto/addressbook.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

data/test/proto/bool_default.pb.rb

@@ -0,0 +1,16 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: test/proto/bool_default.proto>
+# message BoolDefault {
+#   required bool enabled = 1  [default = true];
+# }
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+class BoolDefault < ::Protobuf::Message
+  defined_in __FILE__
+  #required :bool, :enabled, 1, :default => true
+  optional :bool, :enabled, 1, :default => true
+end

data/test/proto/bool_default.proto

@@ -0,0 +1,3 @@
+message BoolDefault {
+  required bool enabled = 1  [default = true];
+}

data/test/proto/collision.proto

@@ -0,0 +1,5 @@
+message CollisionTest {
+  optional string a = 1;
+  optional string b = 1;
+}
+

data/test/proto/ext_collision.proto

@@ -0,0 +1,8 @@
+message ExtCollisionTest {
+  extensions 1 to 10;
+}
+
+message ExtCollisionTest {
+  optional string a = 1;
+  optional string b = 1;
+}

data/test/proto/ext_range.proto

@@ -0,0 +1,7 @@
+message ExtCollisionTest {
+  extensions 1 to 10;
+}
+
+extend ExtCollisionTest {
+  optional string a = 11;
+}

data/test/proto/float_default.proto

@@ -0,0 +1,2 @@
+message M {  optional float f = 1 [default = 4.2];  }
+

data/test/proto/merge.proto

@@ -0,0 +1,15 @@
+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;
+}

data/test/proto/nested.proto

@@ -0,0 +1,7 @@
+message Foo {  
+  message Bar {
+  } 
+}
+message Baaz {  
+  optional Foo.Bar x = 1;
+}

data/test/test_compiler.rb

@@ -3,8 +3,61 @@ require 'test/unit'
 require 'protobuf/compiler/compiler'
 
 class CompilerTest < Test::Unit::TestCase
+  # Issue 12:    Parse error on float default value
+  def test_compile_float_default
+    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];  }
+# 
+
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+class M < ::Protobuf::Message
+  defined_in __FILE__
+  optional :float, :f, 1, :default => 4.2
+end
+    eos
+  end
+
   def test_create_message
-    assert_equal <<-eos.gsub(/^\s*\n/, '').strip, Protobuf::Compiler.new.create_message('test/addressbook.proto', '.', '.', false).gsub(/^\s*\n/, '').strip
+    assert_compile_proto <<-eos, 'test/proto/addressbook.proto'
+### 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'
@@ -13,44 +66,88 @@ 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
     eos
   end
 
+  def test_create_nested_message
+    assert_compile_proto <<-eos, 'test/proto/nested.proto'
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: test/proto/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
+    eos
+  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_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/rpc.proto', '.', '.', false)
+    file_contents = Protobuf::Compiler.new.create_rpc('test/proto/rpc.proto', '.', '.', false)
 
-    assert_source <<-eos, file_contents['./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/rpc'
+require 'test/proto/rpc.pb'
 
 class Tutorial::SearchHandler < Protobuf::Rpc::Handler
   request Tutorial::Person
@@ -80,17 +177,17 @@ class Tutorial::AddressBookService < Protobuf::Rpc::Server
 end
     eos
 
-    assert_source <<-eos, file_contents['./start_address_book_service']
-#!/usr/bin/ruby
+    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['./client_search.rb']
-#!/usr/bin/ruby
+    assert_source <<-eos, file_contents['./test/proto/client_search.rb']
+#!/usr/bin/env ruby
 require 'protobuf/rpc/client'
-require 'test/rpc'
+require 'test/proto/rpc.pb'
 
 # build request
 request = Tutorial::Person.new
@@ -107,10 +204,10 @@ Protobuf::Rpc::Client.new('localhost', 9999).call :search, request, response
 puts response
     eos
 
-    assert_source <<-eos, file_contents['./client_add.rb']
-#!/usr/bin/ruby
+    assert_source <<-eos, file_contents['./test/proto/client_add.rb']
+#!/usr/bin/env ruby
 require 'protobuf/rpc/client'
-require 'test/rpc'
+require 'test/proto/rpc.pb'
 
 # build request
 request = Tutorial::Person.new
@@ -128,6 +225,88 @@ puts response
     eos
   end
 
+  def test_create_descriptor
+    proto_path = 'test/proto/addressbook.proto'
+    visitor = Protobuf::Visitor::CreateDescriptorVisitor.new proto_path
+    File.open proto_path, 'r' do |file|
+      visitor.visit Protobuf::ProtoParser.new.parse(file)
+    end
+    file_descriptor = visitor.file_descriptor
+    assert_equal proto_path, file_descriptor.name
+    assert_equal 'tutorial', file_descriptor.package
+ 
+    person_descriptor = file_descriptor.message_type[0]
+    assert_equal 'Person', person_descriptor.name
+    assert_equal [:name, :id, :email, :phone, :age].size, person_descriptor.field.size
+
+    name_field_descriptor = person_descriptor.field.find {|d| d.name == 'name'}
+    assert_equal 1, name_field_descriptor.number
+    assert_equal Google::Protobuf::FieldDescriptorProto::Type::TYPE_STRING, name_field_descriptor.type
+    assert_equal Google::Protobuf::FieldDescriptorProto::Label::LABEL_REQUIRED, name_field_descriptor.label
+    assert_equal 'string', name_field_descriptor.type_name
+
+    phone_field_descriptor = person_descriptor.field.find {|d| d.name == 'phone'}
+    assert_equal 4, phone_field_descriptor.number
+    assert_equal 0, phone_field_descriptor.type #TODO: is this right?
+    assert_equal Google::Protobuf::FieldDescriptorProto::Label::LABEL_REPEATED, phone_field_descriptor.label
+    assert_equal 'PhoneNumber', phone_field_descriptor.type_name
+
+    age_field_descriptor = person_descriptor.field.find {|d| d.name == 'age'}
+    assert_equal 5, age_field_descriptor.number
+    assert_equal Google::Protobuf::FieldDescriptorProto::Type::TYPE_UINT32, age_field_descriptor.type
+    assert_equal Google::Protobuf::FieldDescriptorProto::Label::LABEL_OPTIONAL, age_field_descriptor.label
+    assert_equal 'uint32', age_field_descriptor.type_name
+    assert_equal '20', age_field_descriptor.default_value
+
+    phone_type_descriptor = person_descriptor.enum_type.first
+    assert_equal 'PhoneType', phone_type_descriptor.name
+    assert_equal 3, phone_type_descriptor.value.size
+
+    phone_type_home_descriptor = phone_type_descriptor.value.find {|d| d.name == 'HOME'}
+    assert_equal 'HOME', phone_type_home_descriptor.name
+    assert_equal 1, phone_type_home_descriptor.number
+
+    extensions_descriptor = person_descriptor.extension_range.first
+    assert_equal 100, extensions_descriptor.start
+    assert_equal 200, extensions_descriptor.end
+
+    phone_number_descriptor = person_descriptor.nested_type.first
+    assert_equal 'PhoneNumber', phone_number_descriptor.name
+    assert_equal [:number, :type].size, phone_number_descriptor.field.size
+
+    #TODO: test extend
+    #extend_person_descriptor = ??
+    #assert_equal extend_person_descriptor
+
+    addressbook_descriptor = file_descriptor.message_type[1]
+    assert_equal 'AddressBook', addressbook_descriptor.name
+  end
+
+  def test_collision
+    assert_raise Protobuf::Message::TagCollisionError do require 'test/collision' end
+    assert_raise Protobuf::Message::TagCollisionError do 
+      Protobuf::Compiler.new.create_message('test/proto/collision.proto', '.', '.', false) 
+    end
+  end
+
+  def test_ext_collision
+    assert_raise Protobuf::Message::TagCollisionError do require 'test/ext_collision' end
+    assert_raise Protobuf::Message::TagCollisionError do 
+      Protobuf::Compiler.new.create_message('test/proto/ext_collision.proto', '.', '.', false) 
+    end
+  end
+
+  def test_ext_range
+    assert_raise RangeError do require 'test/ext_range' end
+    assert_raise RangeError do 
+      Protobuf::Compiler.new.create_message('test/proto/ext_range.proto', '.', '.', false) 
+    end
+  end
+
+  def assert_compile_proto(ideal, filename)
+    assert_equal ideal.gsub(/^\s*\n/, '').strip, Protobuf::Compiler.new.create_message(filename, '.', '.', false).gsub(/^\s*\n/, '').strip
+  end
+
   def assert_source(ideal, real)
     assert_equal ideal.strip.gsub(/^\s*\n/, '').gsub(/\s+\n/, "\n"), real.strip.gsub(/^\s*\n/, '').gsub(/\s+\n/, "\n")
   end

data/test/test_message.rb

@@ -1,8 +1,18 @@
 require 'protobuf/message/message'
 require 'test/addressbook'
+require 'test/merge'
 require 'test/unit'
 
 class MessageTest < Test::Unit::TestCase
+  def test_equality
+    person1 = Tutorial::Person.new :name => 'ando'
+    person2 = Tutorial::Person.new :name => 'ando'
+    person3 = Tutorial::Person.new :name => 'Ando'
+    assert person1 == person2
+    assert person1 != person3
+    assert person1 != 'ando'
+  end
+
   def test_bracketed_access
     person = Tutorial::Person.new
     name_tag = 1
@@ -17,4 +27,80 @@ class MessageTest < Test::Unit::TestCase
     assert_equal 200, person[:id]
     assert_equal 200, person['id']
   end
+
+  def test_initialize_with_hash
+    person = Tutorial::Person.new :name => 'Jiro', :id => 300, :email => 'jiro@ema.il'
+    assert_equal 'Jiro', person.name
+    assert_equal 300, person.id
+    assert_equal 'jiro@ema.il', person.email
+  end
+
+  def test_defined_filenames
+    assert Tutorial::Person.defined_filenames
+    assert_equal 1, Tutorial::Person.defined_filenames.size
+    assert Tutorial::Person.defined_filenames.first =~ %r{/.*/test/addressbook\.rb}
+  end
+
+  def test_proto_filenames
+    assert Tutorial::Person.proto_filenames
+    assert_equal 1, Tutorial::Person.proto_filenames.size
+    assert_equal 'test/addressbook.proto', Tutorial::Person.proto_filenames.first
+  end
+
+  def test_proto_contents
+    assert_equal <<-eos.strip, Tutorial::Person.proto_contents.values.first.strip
+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;
+}
+    eos
+  end
+
+  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_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')
+
+    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
+  end
 end