macks-ruby_protobuf 0.3.2.1

data/lib/protobuf/message/message.rb

@@ -0,0 +1,308 @@
+require 'pp'
+require 'stringio'
+require 'protobuf/descriptor/descriptor'
+require 'protobuf/message/decoder'
+require 'protobuf/message/encoder'
+require 'protobuf/message/field'
+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
+      end
+
+      def []=(key, value)
+        raise RangeError.new("#{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 Protobuf::Protoable
+      def fields; @fields ||= {} end
+
+      def extensions(range)
+        @extension_fields = ExtensionFields.new range
+      end
+
+      def required(type, name, tag, opts={})
+        define_field :required, type, name, tag, opts
+      end
+
+      def optional(type, name, tag, opts={})
+        define_field :optional, type, name, tag, opts
+      end
+
+      def repeated(type, name, tag, opts={})
+        define_field :repeated, type, name, tag, opts
+      end
+
+      def define_field(rule, type, fname, tag, opts={})
+        field_hash = opts[:extension] ? extension_fields : (@fields ||= {})
+        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
+      end
+
+      def extension_tag?(tag)
+        extension_fields.include_tag? tag
+      end
+
+      def extension_fields
+        @extension_fields ||= ExtensionFields.new
+      end
+
+      def get_field_by_name(name)
+        fields.values.find {|field| field.name == name.to_sym}
+      end
+
+      def get_field_by_tag(tag)
+        fields[tag]
+      end
+
+      def get_field(tag_or_name)
+        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.new(tag_or_name.class)
+        end
+      end
+
+      #TODO merge to get_field_by_name
+      def get_ext_field_by_name(name)
+        extension_fields.values.find {|field| field.name == name.to_sym}
+      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; get_ext_field_by_tag tag_or_name
+        when String, Symbol; get_ext_field_by_name tag_or_name
+        else; raise TypeError.new(tag_or_name.class)
+        end
+      end
+
+      def descriptor
+        @descriptor ||= Protobuf::Descriptor::Descriptor.new(self)
+      end
+    end
+
+    def initialize(values={})
+      @values = {}
+
+      fields.each do |tag, field|
+        unless field.ready?
+          field = field.setup
+          self.class.class_eval {@fields[tag] = field}
+        end
+        field.define_accessor self
+      end
+
+      # TODO
+      self.class.extension_fields.each do |tag, field|
+        unless field.ready?
+          field = field.setup
+          self.class.class_eval {@extension_fields[tag] = field}
+        end
+        field.define_accessor self
+      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
+    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]
+      end
+      true
+    end
+
+    def clear!
+      each_field do |field, value|
+        field.clear self
+      end
+    end
+
+    def dup
+      ret = self.class.new
+      each_field do |field, value|
+        if field.repeated?
+          value.each do |v|
+            ret[field.name] << (v.is_a?(Numeric) ? v : v.dup)
+          end
+        else
+          ret[field.name] = value.is_a?(Numeric) ? value : value.dup
+        end
+      end
+      ret
+    end
+
+    def inspect(indent=0)
+      ret = ''
+      i = '  ' * indent
+      field_value_to_string = lambda do |field, value|
+        ret +=
+          if field.is_a? Protobuf::Field::MessageField
+            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
+	    if field.optional? and not has_field?(field.name)
+	      ''
+	    else
+              "#{i}#{field.name}: #{field.type.name_by_value(value)}\n"
+            end
+          else
+            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|
+        if field.repeated?
+          value.each do |v| 
+            field_value_to_string.call field, v
+          end
+        else 
+          field_value_to_string.call field, value
+        end
+      end
+      ret
+    end
+
+    def parse_from_string(string)
+      parse_from StringIO.new(string)
+    end
+
+    def parse_from_file(filename)
+      if filename.is_a? File
+        parse_from filename
+      else
+        File.open(filename, 'r') do |f|
+          parse_from f
+        end
+      end
+    end
+
+    def parse_from(stream)
+      Protobuf::Decoder.decode stream, self
+    end
+
+    def serialize_to_string(string='')
+      io = StringIO.new string
+      serialize_to io
+      io.string
+    end
+    alias to_s serialize_to_string
+
+    def serialize_to_file(filename)
+      if filename.is_a? File
+        serialize_to filename
+      else
+        File.open(filename, 'w') do |f|
+          serialize_to f
+        end
+      end
+    end
+
+    def serialize_to(stream)
+      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 # TODO
+      (get_field_by_tag(tag) or get_ext_field_by_tag(tag)).set self, bytes
+    end
+    
+    def merge_field(tag, value)
+      #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)
+      if field = get_field(tag_or_name)
+        send field.name
+      elsif field = get_ext_field(tag_or_name)
+        send field.name
+      else
+        raise NoMethodError.new("No such method: #{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?
+        send "#{field.name}=", value
+      else
+        raise NoMethodError.new("No such method: #{tag_or_name.inspect}")
+      end
+    end
+
+    def fields; self.class.fields end
+    def get_field_by_name(name); self.class.get_field_by_name(name) end
+    def get_field_by_tag(tag); self.class.get_field_by_tag(tag) end
+    def get_field(tag_or_name); self.class.get_field(tag_or_name) end
+
+    def extension_fields; self.class.extension_fields end
+    def get_ext_field_by_name(name); self.class.get_ext_field_by_name(name) end
+    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]
+      end
+    end
+  end
+end

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/protobuf/message/service.rb

@@ -0,0 +1,9 @@
+module Protobuf
+  class Service
+    class <<self
+      def rpc(hash)
+        raise NotImplementedError('TODO')
+      end
+    end
+  end
+end

data/lib/protobuf/rpc/client.rb

@@ -0,0 +1,19 @@
+require 'socket'
+
+module Protobuf
+  module Rpc
+    class Client
+      def initialize(host, port)
+        @host, @port = host, port
+      end
+
+      def call(name, request, response)
+        socket = TCPSocket.open @host, @port
+        socket.write "#{name}\n"
+        request.serialize_to socket
+        socket.close_write
+        response.parse_from socket
+      end
+    end
+  end
+end

data/lib/protobuf/rpc/handler.rb

@@ -0,0 +1,17 @@
+module Protobuf
+  module Rpc
+    class Handler
+      class <<self
+        attr_reader :request_class, :response_class
+
+        def request(request_class)
+          @request_class = request_class
+        end
+        
+        def response(response_class)
+          @response_class = response_class
+        end
+      end
+    end
+  end
+end

data/lib/protobuf/rpc/server.rb

@@ -0,0 +1,39 @@
+require 'webrick/config'
+require 'webrick/server'
+
+module Protobuf
+  module Rpc
+    class Server < WEBrick::GenericServer
+      def initialize(config={:Port => 9999}, default=WEBrick::Config::General)
+        super config, default
+        setup_handlers
+      end
+
+      def setup_handlers
+        @handlers = {}
+      end
+
+      def get_handler(socket)
+        @handlers[socket.readline.strip.to_sym]
+      end
+
+      def run(socket)
+        handler = get_handler socket
+        request = handler.request_class.new
+        request.parse_from socket
+        response = handler.response_class.new
+        begin
+          handler.process_request request, response
+        rescue StandardError => ex
+          @logger.error ex
+        ensure
+          begin
+            response.serialize_to socket
+          rescue Errno::EPIPE, Errno::ECONNRESET, Errno::ENOTCONN => ex
+            @logger.error ex
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby_protobuf.rb

@@ -0,0 +1,3 @@
+class RubyProtobuf
+  VERSION = '0.3.2.1'
+end

data/test/addressbook.rb

@@ -0,0 +1,98 @@
+### 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'
+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
+    
+    #extensions 100..200
+  end
+  
+  # see: addressbool_ext.rb
+  #class Person < ::Protobuf::Message
+  #  optional :int32, :age, 100, :extension => true
+  #end
+  
+  class AddressBook < ::Protobuf::Message
+    defined_in __FILE__
+    repeated :Person, :person, 1
+  end
+
+  #class SearchService < Protobuf::Service
+  #  rpc :Search, :request => :SearchRequest, :response => :SearchResponse
+  #end
+
+  #Protobuf::OPTIONS[:optimize_for] = :SPEED
+  #Protobuf::OPTIONS[:java_package] = :'com.example.foo'
+end
+
+=begin
+tutorial = Object.const_set :Tutorial, Module.new
+person = tutorial.const_set :Person, Class.new(Protobuf::Message)
+person.required :string, :name, 1
+person.required :int32, :id, 2
+person.optional :string, :email, 3
+phone_type = person.const_set :PhoneType, Class.new(Protobuf::Enum)
+phone_type.const_set :MOBILE, 0
+phone_type.const_set :HOME, 1
+phone_type.const_set :WORK, 2
+phone_number = person.const_set :PhoneNumber, Class.new(Protobuf::Message)
+phone_number.required :string, :number, 1
+phone_number.optional :PhoneType, :type, 2, {:default => :HOME}
+person.repeated :PhoneNumber, :phone, 4
+address_book = tutorial.const_set :AddressBook, Class.new(Protobuf::Message)
+address_book.repeated :Person, :person, 1
+=end

data/test/addressbook_base.rb

@@ -0,0 +1,62 @@
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+module TutorialExt
+  
+  class Person < ::Protobuf::Message
+    required :string, :name, 1
+    required :int32, :id, 2
+    optional :string, :email, 3
+    
+    class PhoneType < ::Protobuf::Enum
+      MOBILE = 0
+      HOME = 1
+      WORK = 2
+    end
+    
+    class PhoneNumber < ::Protobuf::Message
+      required :string, :number, 1
+      optional :PhoneType, :type, 2, {:default => :HOME}
+    end
+    
+    repeated :PhoneNumber, :phone, 4
+    
+    extensions 100..200
+  end
+  
+  # see: addressbool_ext.rb
+  #class Person < ::Protobuf::Message
+  #  optional :int32, :age, 100, :extension => true
+  #end
+  
+  class AddressBook < ::Protobuf::Message
+    repeated :Person, :person, 1
+  end
+
+  #class SearchService < Protobuf::Service
+  #  rpc :Search => :SearchRequest, :returns => :SearchResponse
+  #end
+
+  #Protobuf::OPTIONS[:optimize_for] = :SPEED
+  #Protobuf::OPTIONS[:java_package] = :'com.example.foo'
+end
+
+=begin
+tutorial = Object.const_set :Tutorial, Module.new
+person = tutorial.const_set :Person, Class.new(Protobuf::Message)
+person.required :string, :name, 1
+person.required :int32, :id, 2
+person.optional :string, :email, 3
+phone_type = person.const_set :PhoneType, Class.new(Protobuf::Enum)
+phone_type.const_set :MOBILE, 0
+phone_type.const_set :HOME, 1
+phone_type.const_set :WORK, 2
+phone_number = person.const_set :PhoneNumber, Class.new(Protobuf::Message)
+phone_number.required :string, :number, 1
+phone_number.optional :PhoneType, :type, 2, {:default => :HOME}
+person.repeated :PhoneNumber, :phone, 4
+address_book = tutorial.const_set :AddressBook, Class.new(Protobuf::Message)
+address_book.repeated :Person, :person, 1
+=end

data/test/addressbook_ext.rb

@@ -0,0 +1,12 @@
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+require 'addressbook_base'
+
+module TutorialExt
+  class Person < ::Protobuf::Message
+    optional :int32, :age, 100, :extension => true
+  end
+end

data/test/check_unbuild.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+$:.push "#{File.dirname(__FILE__)}/../lib"
+
+require 'test/unit'
+require 'protobuf/descriptor/descriptor_builder' 
+require 'protobuf/descriptor/descriptor_proto'
+
+class DescriptorTest < Test::Unit::TestCase
+  def test_unbuild
+    tutorial_proto = Google::Protobuf::FileDescriptorProto.new
+    tutorial_proto.parse_from_file 'person.bin'
+    Protobuf::Descriptor::DescriptorBuilder.build tutorial_proto
+
+    assert_nothing_raised {Tutorial::Person}
+    assert_nothing_raised {Tutorial::Person.new}
+    assert_equal ['email', 'id', 'name', 'phone'], 
+      Tutorial::Person.fields.map{|tag, field| field.name}.sort
+
+    assert_nothing_raised {Tutorial::Person::PhoneNumber}
+    assert_nothing_raised {Tutorial::Person::PhoneNumber.new}
+    assert_equal ['number', 'type'], 
+      Tutorial::Person::PhoneNumber.fields.map{|tag, field| field.name}.sort
+
+    assert_nothing_raised {Tutorial::Person::PhoneType}
+    assert_equal 0, Tutorial::Person::PhoneType::MOBILE
+    assert_equal 1, Tutorial::Person::PhoneType::HOME
+    assert_equal 2, Tutorial::Person::PhoneType::WORK
+  end
+end

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/data/data.bin

@@ -0,0 +1,3 @@
+
+John Doe�	jdoe@example.com"
+555-4321

data/test/data/data_source.py

@@ -0,0 +1,14 @@
+import addressbook_pb2
+import sys
+
+person = addressbook_pb2.Person()
+person.id = 1234
+person.name = "John Doe"
+person.email = "jdoe@example.com"
+phone = person.phone.add()
+phone.number = "555-4321"
+phone.type = addressbook_pb2.Person.HOME
+
+f = open('data.bin', 'wb')
+f.write(person.SerializeToString())
+f.close()