ruby_protobuf 0.2.0 → 0.3.0

data/History.txt

@@ -1,5 +1,10 @@
-=== 0.2.0 / 2008-08-05
+=== 0.3.0 / 2008-08-19
 
+* 0.3.0 RPC is available (rev.124)
+  * RPC is available
+  * New compiler using racc (ruby version of yacc)
+  * Rename `sample' directory to `example'
+* 0.2.1 extensions and import are available (rev.82)
 * 0.2.0 introduce descriptor (rev.75)
   * Message structures can be restored from encoded data by means a descriptor object
 * 0.1.0 fixed a small bug

data/Manifest.txt

@@ -3,9 +3,21 @@ Manifest.txt
 README.txt
 Rakefile
 bin/rprotoc
+examples/addressbook.proto
+examples/addressbook.rb
+examples/reading_a_message.rb
+examples/writing_a_message.rb
 lib/protobuf/common/wire_type.rb
 lib/protobuf/compiler/compiler.rb
-lib/protobuf/compiler/parser.y
+lib/protobuf/compiler/compiler_old.rb
+lib/protobuf/compiler/nodes.rb
+lib/protobuf/compiler/proto.y
+lib/protobuf/compiler/proto2.ebnf
+lib/protobuf/compiler/proto_parser.rb
+lib/protobuf/compiler/template/rpc_bin.erb
+lib/protobuf/compiler/template/rpc_client.erb
+lib/protobuf/compiler/template/rpc_service.erb
+lib/protobuf/compiler/visitors.rb
 lib/protobuf/descriptor/descriptor.proto
 lib/protobuf/descriptor/descriptor.rb
 lib/protobuf/descriptor/descriptor_builder.rb
@@ -20,22 +32,31 @@ lib/protobuf/message/extend.rb
 lib/protobuf/message/field.rb
 lib/protobuf/message/message.rb
 lib/protobuf/message/service.rb
+lib/protobuf/rpc/client.rb
+lib/protobuf/rpc/handler.rb
+lib/protobuf/rpc/server.rb
 lib/ruby_protobuf.rb
 test/addressbook.proto
 test/addressbook.rb
+test/addressbook_base.proto
+test/addressbook_base.rb
+test/addressbook_ext.proto
+test/addressbook_ext.rb
 test/check_unbuild.rb
 test/data/data.bin
-test/data/data2.bin
 test/data/data_source.py
 test/data/types.bin
 test/data/types_source.py
+test/rpc.proto
 test/test_addressbook.rb
 test/test_compiler.rb
 test/test_descriptor.rb
+test/test_extension.rb
 test/test_message.rb
 test/test_parse.rb
 test/test_ruby_protobuf.rb
 test/test_serialize.rb
+test/test_standard_message.rb
 test/test_types.rb
 test/types.proto
 test/types.rb

data/bin/rprotoc

@@ -1,13 +1,15 @@
-#!/usr/local/bin/ruby
+#!/usr/bin/ruby
 $: << "#{File.dirname(__FILE__)}/../lib"
 require 'optparse'
 require 'ruby_protobuf'
+#require 'protobuf/compiler/compiler_old'
+require 'protobuf/compiler/compiler'
 
 
 COMMAND_LINE = "#{$0} #{ARGV.join(' ')} PROTO_FILE"
 OPT = {}
 opts = OptionParser.new
-#opts.on('-p', '--proto_path <PATH>', 'Specify the directory in which to search for imports. The current directory is default.'){|v| OPT[:proto_path] = v}
+opts.on('-p', '--proto_path <PATH>', 'Specify the directory in which to search for imports. The current directory is default.'){|v| OPT[:proto_path] = v}
 opts.on('-o', '--out <OUT_DIR>', 'Specify the directory in which Ruby source file is generated. The current directory is default.'){|v| OPT[:out] = v}
 opts.on_tail('-v', '--version', 'Show version.'){puts(opts.ver); exit}
 opts.on_tail('-h', '--help', 'Show this message.'){puts(opts.help); exit}
@@ -16,6 +18,4 @@ opts.on_tail('-h', '--help', 'Show this message.'){puts(opts.help); exit}
 opts.order! ARGV
 PROTO_FILE = ARGV.shift
 
-RubyProtobuf.new.start PROTO_FILE, OPT
-
-
+Protobuf::Compiler.compile(PROTO_FILE, (OPT[:proto_path] or '.'), (OPT[:out] or '.'))

data/examples/addressbook.proto

@@ -0,0 +1,24 @@
+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;
+}
+
+message AddressBook {
+  repeated Person person = 1;
+}

data/examples/addressbook.rb

@@ -0,0 +1,30 @@
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+module Tutorial
+  
+  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
+  end
+  
+  class AddressBook < ::Protobuf::Message
+    repeated :Person, :person, 1
+  end
+end

data/examples/reading_a_message.rb

@@ -0,0 +1,32 @@
+#!/usr/local/bin/ruby
+
+require 'addressbook'
+
+def list_people(address_book)
+  address_book.person.each do |person|
+    puts "Person ID: #{person.id}"
+    puts "  Name: #{person.name}"
+    puts "  E-mail: #{person.email}" unless person.email.empty?
+    person.phone.each do |phone_number|
+      print(case phone_number.type
+            when Tutorial::Person::PhoneType::MOBILE
+              '  Mobile phone #: '
+            when Tutorial::Person::PhoneType::HOME
+              '  Home phone #: '
+            when Tutorial::Person::PhoneType::WORK
+              '  Work phone #: '
+            end)
+      puts phone_number.number
+    end
+  end
+end
+
+unless ARGV.size == 1
+  puts "Usage: #{$0} ADDRESS_BOOK_FILE"
+  exit
+end
+
+address_book = Tutorial::AddressBook.new
+address_book.parse_from_file ARGV[0]
+
+list_people address_book

data/examples/writing_a_message.rb

@@ -0,0 +1,46 @@
+#!/usr/local/bin/ruby
+
+require 'addressbook'
+
+def prompt_for_address(person)
+  print 'Enter person ID number: '
+  person.id = STDIN.gets.strip.to_i
+  print 'Enter name: '
+  person.name = STDIN.gets.strip
+  print 'Enter email address (blank for none): '
+  email = STDIN.gets.strip
+  person.email = email unless email.empty?
+
+  loop do
+    print 'Enter a phone number (or leave blank to finish): '
+    break if (number = STDIN.gets.strip).empty?
+
+    person.phone << Tutorial::Person::PhoneNumber.new
+    person.phone.last.number = number
+
+    print 'Is this a mobile, home, or work phone? '
+    person.phone.last.type = 
+      case type = STDIN.gets.strip
+      when 'mobile'
+        Tutorial::Person::PhoneType::MOBILE
+      when 'home'
+        Tutorial::Person::PhoneType::HOME
+      when 'work'
+        Tutorial::Person::PhoneType::WORK
+      else
+        puts 'Unknown phone type; leaving as default value.'
+        nil
+      end
+  end
+end
+
+unless ARGV.size == 1
+  puts "Usage: #{$0} ADDRESS_BOOK_FILE" 
+  exit
+end
+
+address_book = Tutorial::AddressBook.new
+address_book.parse_from_file ARGV[0] if File.exist? ARGV[0]
+address_book.person << Tutorial::Person.new
+prompt_for_address address_book.person.last
+address_book.serialize_to_file ARGV[0]

data/lib/protobuf/compiler/compiler.rb

@@ -1,90 +1,54 @@
-# This is a quite temporary implementation.
-# I'll create a compiler class using Racc.
+require 'fileutils'
+require 'protobuf/compiler/proto_parser'
+require 'protobuf/compiler/nodes'
+require 'protobuf/compiler/visitors'
 
 module Protobuf
   class Compiler
-    INDENT_UNIT = '  '
+    def self.compile(proto_file, proto_dir='.', out_dir='.', file_create=true)
+      self.new.compile proto_file, proto_dir, out_dir, file_create
+    end
 
-    def self.compile(filename)
-      self.new.compile filename
+    def compile(proto_file, proto_dir='.', out_dir='.', file_create=true)
+      create_message proto_file, proto_dir, out_dir, file_create
+      create_rpc proto_file, proto_dir, out_dir, file_create
     end
 
-    def initialize
-      @indent_level = 0
-      @ret = <<-eos
-require 'protobuf/message/message'
-require 'protobuf/message/enum'
-require 'protobuf/message/service'
-require 'protobuf/message/extend'
+    def create_message(proto_file, proto_dir='.', out_dir='.', file_create=true)
+      rb_file = "#{out_dir}/#{proto_file.sub(/\.proto$/, '.rb')}"
+      proto_path = validate_existence proto_file, proto_dir
 
-      eos
+      message_visitor = Protobuf::Visitor::CreateMessageVisitor.new proto_dir, out_dir
+      File.open proto_path, 'r' do |file|
+        message_visitor.visit Protobuf::ProtoParser.new.parse(file)
+      end
+      if file_create
+        puts "#{rb_file} writing..."
+        FileUtils.mkpath File.dirname(rb_file)
+        File.open(rb_file, 'w') {|f| f.write message_visitor.to_s}
+      else
+        message_visitor.to_s
+      end
     end
 
-    def indent
-      INDENT_UNIT * @indent_level
-    end
+    def create_rpc(proto_file, proto_dir='.', out_dir='.', file_create=true)
+      rb_file = "#{out_dir}/#{proto_file.sub(/\.proto$/, '.rb')}"
+      proto_path = validate_existence proto_file, proto_dir
 
-    def puts_with_indent(string)
-      #puts "#{indent}#{string}"
-      @ret += "#{indent}#{string}\n"
+      rpc_visitor = Protobuf::Visitor::CreateRpcVisitor.new# proto_dir, out_dir
+      File.open proto_path, 'r' do |file|
+        rpc_visitor.visit Protobuf::ProtoParser.new.parse(file)
+      end
+      rpc_visitor.create_files rb_file, out_dir, file_create
     end
-    alias putswi puts_with_indent
 
-    def compile(filename)
-      File.open filename, 'r' do |file|
-        file.each_line do |line|
-          line.sub!(/^(.*)\/\/.*/, '\1')
-          line.strip!
-          case line
-          when /^package\s+(\w+(\.\w+)?)\s*;$/
-            $1.split('.').each do |path|
-              putswi "module #{path.capitalize}"
-              @indent_level += 1
-            end
-          when /^message\s+(\w+)\s*\{$/
-            putswi "class #{$1} < ::Protobuf::Message"
-            @indent_level += 1
-          when /^(required|optional|repeated)\s+(\w+(\.\w+)?)\s+(\w+)\s*=\s*(\d+)\s*(\[\s*default\s*=\s*(\w+)\s*\])?\s*;$/
-            rule, type, name, tag, default = $1, $2, $4, $5, $7
-            if default
-              default = default =~ /\d+(\.\d+)/ \
-                ? ", {:default => #{default}}" \
-                : ", {:default => :#{default}}"
-            end
-            putswi "#{rule} :#{type}, :#{name}, #{tag}#{default}"
-          when /^enum\s+(\w+)\s*\{$/
-            putswi "class #{$1} < ::Protobuf::Enum"
-            @indent_level += 1
-          when /^(\w+)\s*=\s*(\w+)\s*;$/
-            putswi "#{$1} = #{$2}"
-          when /^extensions\s+(\w+)\s+to\s+(\w+)\s*;/
-            low, high = $1, $2
-            low = '::Protobuf::Extend.MIN' if low == 'min'
-            high = '::Protobuf::Extend.MAX' if high == 'max'
-            putswi "extensions #{min}..#{max}"
-          when /^extend\s+(\w+)\s*\{/
-            putswi "class #{$1} < ::Protobuf::Extend"
-            @indent_level += 1
-          when /^service\s+(\w+)\s*\{/
-            putswi "class #{$1} < ::Protobuf::Service"
-            @indent_level += 1
-          when /^rpc\s+(\w+)\s+\(\s*(\w+)\s*\)\s+returns\s+\(\s*(\w+)\s*\)\s*;/
-            putswi "rpc :#{$1} => :#{$2}, :#{$3} => :#{$4}"
-          when /^option\s+(\w+)\s*=\s*(.+)\s*;/
-            putswi "::Protobuf::OPTIONS[:#{$1}] = :#{$2}"
-          when /^\}\s*;?$/
-            @indent_level -= 1
-            putswi "end"
-          when ''
-            putswi ''
-          end
-        end
-        while 0 < @indent_level 
-          @indent_level -= 1
-          putswi "end"
-        end
+    def validate_existence(path, base_dir)
+      if File.exist? path
+      elsif File.exist?(path = "#{base_dir or '.'}/#{path}")
+      else
+        raise ArgumentError.new("File does not exist: #{path}")
       end
-      @ret
+      path
     end
   end
 end

data/lib/protobuf/compiler/compiler_old.rb

@@ -0,0 +1,123 @@
+# This is a quite temporary implementation.
+# I'll create a compiler class using Racc.
+
+require 'fileutils'
+
+module Protobuf
+  class Compiler
+    INDENT_UNIT = '  '
+
+    def self.compile(proto_file, proto_dir='.', out_dir='.', file_create=true)
+      self.new.compile proto_file, proto_dir, out_dir, file_create
+    end
+
+    def initialize
+      @indent_level = 0
+      @ret = <<-eos
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+
+      eos
+    end
+
+    def indent
+      INDENT_UNIT * @indent_level
+    end
+
+    def puts_with_indent(string)
+      #puts "#{indent}#{string}"
+      @ret += "#{indent}#{string}\n"
+    end
+    alias putswi puts_with_indent
+
+    def compile(proto_file, proto_dir='.', out_dir='.', file_create=true)
+      rb_file = "#{out_dir}/#{proto_file.sub(/\.proto$/, '.rb')}"
+      proto_path = validate_existence proto_file, proto_dir
+      File.open proto_path, 'r' do |file|
+        file.each_line do |line|
+          line.sub!(/^(.*)\/\/.*/, '\1')
+          line.strip!
+          case line
+          when /^package\s+(\w+(\.\w+)?)\s*;$/
+            $1.split('.').each do |path|
+              putswi "module #{path.capitalize}"
+              @indent_level += 1
+            end
+          when /^import\s+"((?:[^"\\]+|\\.)*)"\s*;$/
+            putswi "require '#{required_message_from_proto $1, proto_dir, out_dir}'"
+          when /^message\s+(\w+)\s*\{$/
+            putswi "class #{$1} < ::Protobuf::Message"
+            @extension = false
+            @indent_level += 1
+          when /^(required|optional|repeated)\s+(\w+(\.\w+)?)\s+(\w+)\s*=\s*(\d+)\s*(\[\s*default\s*=\s*(\w+)\s*\])?\s*;$/
+            rule, type, name, tag, default = $1, $2, $4, $5, $7
+            if default
+              default = default =~ /\d+(\.\d+)/ \
+                ? ", {:default => #{default}}" \
+                : ", {:default => :#{default}}"
+            end
+            extension = @extension ? ', :extension => true' : ''
+            putswi "#{rule} :#{type}, :#{name}, #{tag}#{default}#{extension}"
+          when /^enum\s+(\w+)\s*\{$/
+            putswi "class #{$1} < ::Protobuf::Enum"
+            @indent_level += 1
+          when /^(\w+)\s*=\s*(\w+)\s*;$/
+            putswi "#{$1} = #{$2}"
+          when /^extensions\s+(\w+)\s+to\s+(\w+)\s*;/
+            low, high = $1, $2
+            low = '::Protobuf::Extend.MIN' if low == 'min'
+            high = '::Protobuf::Extend.MAX' if high == 'max'
+            putswi "extensions #{low}..#{high}"
+          when /^extend\s+(\w+)\s*\{/
+            putswi "class #{$1} < ::Protobuf::Message"
+            @extension = true
+            @indent_level += 1
+          when /^service\s+(\w+)\s*\{/
+            putswi "class #{$1} < ::Protobuf::Service"
+            @indent_level += 1
+          when /^rpc\s+(\w+)\s+\(\s*(\w+)\s*\)\s+returns\s+\(\s*(\w+)\s*\)\s*;/
+            putswi "rpc :#{$1} => :#{$2}, :#{$3} => :#{$4}"
+          when /^option\s+(\w+)\s*=\s*(.+)\s*;/
+            putswi "::Protobuf::OPTIONS[:#{$1}] = :#{$2}"
+          when /^\}\s*;?$/
+            @indent_level -= 1
+            putswi "end"
+          when ''
+            putswi ''
+          end
+        end
+        while 0 < @indent_level 
+          @indent_level -= 1
+          putswi "end"
+        end
+      end
+      if file_create
+        puts "#{rb_file} writing..."
+        FileUtils.mkpath File.dirname(rb_file)
+        File.open(rb_file, 'w') {|f| f.write @ret}
+      end
+      @ret
+    end
+
+    def validate_existence(path, base_dir)
+      if File.exist? path
+      elsif File.exist?(path = "#{base_dir or '.'}/#{path}")
+      else
+        raise ArgumentError.new("File does not exist: #{path}")
+      end
+      path
+    end
+
+    def required_message_from_proto(proto_file, proto_dir, out_dir)
+      rb_path = proto_file.sub(/\.proto$/, '.rb')
+      proto_dir ||= '.'
+      out_dir ||= '.'
+      unless File.exist?("#{out_dir}/#{rb_path}")
+        Compiler.compile proto_file, proto_dir, out_dir
+      end
+      rb_path
+    end
+  end
+end

data/lib/protobuf/compiler/nodes.rb

@@ -0,0 +1,208 @@
+module Protobuf
+  module Node
+    class Base
+      def accept_rpc_creator(vistor)
+      end
+    end
+  
+    class ProtoNode < Base
+      attr_reader :children
+
+      def initialize(children)
+        @children = children
+      end
+
+      def accept_message_creator(visitor)
+        visitor.write <<-eos
+require 'protobuf/message/message'
+require 'protobuf/message/enum'
+require 'protobuf/message/service'
+require 'protobuf/message/extend'
+        eos
+        @children.map{|child| child.accept_message_creator visitor}
+        visitor.close_ruby
+      end
+
+      def accept_rpc_creator(visitor)
+        @children.map{|child| child.accept_rpc_creator visitor}
+      end
+    end
+  
+    class ImportNode < Base
+      def initialize(path)
+        @path = path
+      end
+
+      def accept_message_creator(visitor)
+        visitor.write "require '#{visitor.required_message_from_proto @path}'"
+      end
+    end
+
+    class PackageNode < Base
+      def initialize(path_list)
+        @path_list = path_list
+      end
+
+      def accept_message_creator(visitor)
+        @path_list.each do |path|
+          visitor.write "module #{path.to_s.capitalize}"
+          visitor.increment
+        end
+      end
+
+      def accept_rpc_creator(visitor)
+        visitor.package = @path_list.dup
+      end
+    end
+
+    class OptionNode < Base
+      def initialize(name_list, value)
+        @name_list, @value = name_list, value
+      end
+
+      def accept_message_creator(visitor)
+        visitor.write "::Protobuf::OPTIONS[:#{@name_list.join('.').inspect}] = #{@value.inspect}"
+      end
+    end
+
+    class MessageNode < Base
+      def initialize(name, children)
+        @name, @children = name, children
+      end
+
+      def accept_message_creator(visitor)
+        visitor.write "class #{@name} < ::Protobuf::Message"
+        visitor.in_context self.class do 
+          @children.each {|child| child.accept_message_creator visitor}
+        end
+        visitor.write "end"
+      end
+    end
+
+    class ExtendNode < Base
+      def initialize(name, children)
+        @name, @children = name, children
+      end
+
+      def accept_message_creator(visitor)
+        visitor.write "class #{@name} < ::Protobuf::Message"
+        visitor.in_context self.class do 
+          @children.each {|child| child.accept_message_creator visitor}
+        end
+        visitor.write "end"
+      end
+    end
+
+    class EnumNode < Base
+      def initialize(name, children)
+        @name, @children = name, children
+      end
+
+      def accept_message_creator(visitor)
+        visitor.write "class #{@name} < ::Protobuf::Enum"
+        visitor.in_context self.class do 
+          @children.each {|child| child.accept_message_creator visitor}
+        end
+        visitor.write "end"
+      end
+    end
+
+    class EnumFieldNode < Base
+      def initialize(name, value)
+        @name, @value = name, value
+      end
+
+      def accept_message_creator(visitor)
+        visitor.write "#{@name} = #{@value}"
+      end
+    end
+
+    class ServiceNode < Base
+      def initialize(name, children)
+        @name, @children = name, children
+      end
+
+      def accept_message_creator(visitor)
+        # do nothing
+        #visitor.write "class #{@name} < ::Protobuf::Service"
+        #visitor.in_context self.class do 
+        #  @children.each {|child| child.accept_message_creator visitor}
+        #end
+        #visitor.write "end"
+      end
+
+      def accept_rpc_creator(visitor)
+        visitor.current_service = @name
+        @children.each {|child| child.accept_rpc_creator visitor}
+      end
+    end
+
+    class RpcNode < Base
+      def initialize(name, request, response)
+        @name, @request, @response = name, request, response
+      end
+
+      def accept_message_creator(visitor)
+        # do nothing
+        #visitor.write "rpc :#{@name}, :request => :#{@request}, :response => :#{@response}"
+      end
+
+      def accept_rpc_creator(visitor)
+        visitor.add_rpc @name, @request, @response
+      end
+    end
+
+    class GroupNode < Base
+      def initialize(label, name, value, children)
+        @label, @name, @value, @children = label, name, value, children
+      end
+
+      def accept_message_creator(visitor)
+        raise ArgumentError.new('have not implement')
+      end
+    end
+
+    class FieldNode < Base
+      def initialize(label, type, name, value, opts=[])
+        @label, @type, @name, @value, @opts = label, type, name, value, opts
+      end
+
+      def accept_message_creator(visitor)
+        opts = @opts.empty? ? '' : ", #{@opts.map{|k, v| ":#{k} => :#{v}"}.join(', ')}"
+        if visitor.context.first == Protobuf::Node::ExtendNode
+          opts += ', :extension => true'
+        end
+        visitor.write "#{@label} :#{@type}, :#{@name}, #{@value}#{opts}"
+      end
+    end
+
+    class ExtensionsNode < Base
+      def initialize(range)
+        @range = range
+      end
+
+      def accept_message_creator(visitor)
+        visitor.write "extensions #{@range.to_s}"
+      end
+    end
+
+    class ExtensionRangeNode < Base
+      def initialize(low, high=nil)
+        @low, @high = low, high
+      end
+
+      #def accept_message_creator(visitor)
+      #end
+      
+      def to_s
+        if @high.nil?
+          @low.to_s
+        elsif @high == :max
+          "#{@low}..Protobuf::Extend::MAX"
+        else
+          "#{@low}..#{@high}"
+        end
+      end
+    end
+  end
+end