macks-ruby_protobuf 0.3.2.1

data/History.txt

@@ -0,0 +1,14 @@
+=== 0.3.1 / 2008-08-22
+
+* 0.3.1 fixed bugs concerning RPC (rev.146)
+* 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
+* 0.0.1 major enhancement
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,74 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/mk_parser
+bin/rprotoc
+examples/addressbook.proto
+examples/addressbook.pb.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/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
+lib/protobuf/descriptor/descriptor_proto.rb
+lib/protobuf/descriptor/enum_descriptor.rb
+lib/protobuf/descriptor/field_descriptor.rb
+lib/protobuf/descriptor/file_descriptor.rb
+lib/protobuf/message/decoder.rb
+lib/protobuf/message/encoder.rb
+lib/protobuf/message/enum.rb
+lib/protobuf/message/extend.rb
+lib/protobuf/message/field.rb
+lib/protobuf/message/message.rb
+lib/protobuf/message/protoable.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.rb
+test/addressbook_base.rb
+test/addressbook_ext.rb
+test/check_unbuild.rb
+test/collision.rb
+test/data/data.bin
+test/data/data_source.py
+test/data/types.bin
+test/data/types_source.py
+test/data/unk.png
+test/ext_collision.rb
+test/ext_range.rb
+test/merge.rb
+test/nested.rb
+test/proto/addressbook.proto
+test/proto/addressbook_base.proto
+test/proto/addressbook_ext.proto
+test/proto/collision.proto
+test/proto/ext_collision.proto
+test/proto/ext_range.proto
+test/proto/merge.proto
+test/proto/nested.proto
+test/proto/rpc.proto
+test/proto/types.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.rb

data/README.txt

@@ -0,0 +1,58 @@
+= RubyProtobuf
+
+* http://github.com/macks/ruby-protobuf
+* http://code.google.com/p/ruby-protobuf
+
+== DESCRIPTION:
+
+Protocol Buffers for Ruby.
+
+== FEATURES/PROBLEMS:
+
+* Compile .proto file to ruby script
+* Parse the binary wire format for protocol buffer
+* Serialize data to the binary wire format for protocol buffer
+
+== SYNOPSIS:
+
+  rprotoc examples/addressbook.proto
+
+== REQUIREMENTS:
+
+* All you need are included.
+
+== INSTALL:
+
+* rake gem; sudo gem install pkg/ruby_protobuf-*.gem
+
+== AUTHOR:
+
+MATSUYAMA Kengo <macksx@gmail.com>
+
+Original Author:
+ ANDO Yasushi <andyjpn@gmail.com>
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+$:.push(File.dirname(__FILE__) + '/lib')
+require 'rubygems'
+require 'hoe'
+require 'ruby_protobuf'
+
+Hoe.new('ruby_protobuf', RubyProtobuf::VERSION) do |p|
+  p.rubyforge_name = nil
+  p.author = 'MATSUYAMA Kengo'
+  p.email = 'macksx@gmail.com'
+  p.summary = 'Protocol Buffers for Ruby'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=ruby

data/bin/mk_parser

@@ -0,0 +1,2 @@
+#!/bin/sh
+racc -E lib/protobuf/compiler/proto.y -o lib/protobuf/compiler/proto_parser.rb

data/bin/rprotoc

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require 'optparse'
+if File.exist? "#{File.dirname(__FILE__)}/../lib"
+  $: << "#{File.dirname(__FILE__)}/../lib"
+else
+  require 'rubygems'
+  gem 'ruby_protobuf'
+end
+require 'ruby_protobuf'
+require 'protobuf/compiler/compiler'
+
+
+OPT = {}
+opts = OptionParser.new("#{$0} [OPTIONS] PROTO_FILE")
+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}
+
+::Version = RubyProtobuf::VERSION
+
+begin
+  opts.order! ARGV
+rescue OptionParser::ParseError
+  $stderr.puts $!.to_s
+  exit 1
+end
+
+PROTO_FILE = ARGV.shift
+
+unless PROTO_FILE
+  puts opts
+  exit
+end
+
+Protobuf::Compiler.compile(PROTO_FILE, (OPT[:proto_path] or '.'), (OPT[:out] or '.'))

data/examples/addressbook.pb.rb

@@ -0,0 +1,56 @@
+### Generated by rprotoc. DO NOT EDIT!
+### <proto file: examples/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;
+# }
+# 
+# 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
+  end
+  class AddressBook < ::Protobuf::Message
+    defined_in __FILE__
+    repeated :Person, :person, 1
+  end
+end

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/reading_a_message.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'addressbook.pb'
+
+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/bin/env ruby
+
+require 'addressbook.pb'
+
+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/common/wire_type.rb

@@ -0,0 +1,10 @@
+module Protobuf
+  class WireType
+    VARINT = 0
+    FIXED64 = 1
+    LENGTH_DELIMITED = 2
+    START_GROUP = 3
+    END_GROUP = 4
+    FIXED32 = 5
+  end
+end

data/lib/protobuf/compiler/compiler.rb

@@ -0,0 +1,54 @@
+require 'fileutils'
+require 'protobuf/compiler/proto_parser'
+require 'protobuf/compiler/nodes'
+require 'protobuf/compiler/visitors'
+
+module Protobuf
+  class Compiler
+    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 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 create_message(proto_file, proto_dir='.', out_dir='.', file_create=true)
+      out_dir.sub! %r{/$}, ''
+      proto_dir.sub! %r{/$}, ''
+      rb_file = 
+        if proto_file =~ %r{^/} 
+        then "#{out_dir}/#{proto_file.split('/').last.sub(/\.proto$/, '')}.pb.rb"  
+        else "#{out_dir}/#{proto_file.sub(/\.proto$/, '')}.pb.rb" end
+      proto_path = validate_existence proto_file, proto_dir
+
+      message_visitor = Protobuf::Visitor::CreateMessageVisitor.new proto_file, proto_dir, out_dir
+      File.open proto_path, 'r' do |file|
+        message_visitor.visit Protobuf::ProtoParser.new.parse(file)
+      end
+      message_visitor.create_files rb_file, out_dir, file_create
+    end
+
+    def create_rpc(proto_file, proto_dir='.', out_dir='.', file_create=true)
+      message_file = "#{out_dir}/#{proto_file.sub(/\.proto$/, '')}.pb.rb"
+      out_dir = "#{out_dir}/#{File.dirname proto_file}"
+      proto_path = validate_existence proto_file, proto_dir
+
+      rpc_visitor = Protobuf::Visitor::CreateRpcVisitor.new
+      File.open proto_path, 'r' do |file|
+        rpc_visitor.visit Protobuf::ProtoParser.new.parse(file)
+      end
+      rpc_visitor.create_files message_file, out_dir, file_create
+    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
+  end
+end