protobuf 1.0.1 → 1.1.0.beta0

data/.gitignore

@@ -3,3 +3,6 @@ pkg/*
 .bundle
 .rvmrc
 *.log
+coverage
+doc
+.yardoc

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--hide-void-return
+
+--markup-provider=redcarpet
+--markup=markdown

data/Gemfile.lock

@@ -1,28 +1,43 @@
 PATH
   remote: .
   specs:
-    protobuf (1.0.1)
+    protobuf (1.1.0.beta0)
       eventmachine (~> 0.12.10)
+      eventually (~> 0.1.0)
+      json_pure (~> 1.6.4)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.2)
+    diff-lcs (1.1.3)
     eventmachine (0.12.10)
+    eventually (0.1.0)
+    json_pure (1.6.4)
+    multi_json (1.0.4)
     rake (0.8.7)
-    rspec (2.7.0)
-      rspec-core (~> 2.7.0)
-      rspec-expectations (~> 2.7.0)
-      rspec-mocks (~> 2.7.0)
-    rspec-core (2.7.1)
-    rspec-expectations (2.7.0)
+    redcarpet (1.17.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.7.0)
+    rspec-mocks (2.8.0)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    yard (0.7.4)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
   protobuf!
   rake (~> 0.8.7)
-  rspec (~> 2.7.0)
+  redcarpet (~> 1.17.2)
+  rspec (~> 2.8.0)
+  simplecov (~> 0.5.4)
+  yard (~> 0.7.4)

data/bin/rpc_server

@@ -3,16 +3,9 @@
 require 'optparse'
 require 'ostruct'
 require 'logger'
-require 'protobuf'
-require 'protobuf/rpc/server'
-
-[:INT, :QUIT, :TERM].each do |sig|
-  trap(sig) do
-    EventMachine.stop_event_loop if EventMachine.reactor_running?
-    Protobuf::Logger.info 'Shutdown complete'
-    $stdout.puts 'Shutdown complete'
-  end
-end
+require 'protobuf/version'
+require 'protobuf/rpc/servers/evented_runner'
+require 'protobuf/rpc/servers/socket_runner'
 
 # Default options
 server = OpenStruct.new({
@@ -20,8 +13,11 @@ server = OpenStruct.new({
   :env => ENV['RPC_SERVER_ENV'] || 'development',
   :host => '127.0.0.1',
   :port => 9595,
+  :backlog => 100,
+  :threshold => 100,
   :log => File.expand_path('./protobuf.log'),
   :level => ::Logger::INFO,
+  :runner => Protobuf::Rpc::EventedRunner, 
   :debug => false
 })
 
@@ -47,6 +43,23 @@ parser = OptionParser.new do |opts|
   opts.on("-v N", "--level=N", Integer, "Log level to use, 0-5 (see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/)") do |v|
     server.level = v.to_i
   end
+
+  opts.on("-b N", "--backlog=N", Integer, "Backlog for listening socket when using Socket Server") do |v|
+    server.backlog = v.to_i
+  end
+
+  opts.on("-t N", "--threshold=N", Integer, "Multi-threaded Socket Server cleanup threshold") do |v|
+    server.threshold = v.to_i
+  end
+
+  opts.on("-c", "--client_socket", "Socket Mode for client connections (No EventMachine)") do |v|
+    Protobuf::ConnectorType = "Socket"
+  end
+
+  opts.on("-s", "--socket", "Socket Server Mode (No EventMachine)") do |v|
+    Protobuf::ServerType = "SocketServer"
+    server.runner = Protobuf::Rpc::SocketRunner
+  end
   
   opts.on("-d", "--[no-]debug", "Debug Mode. Override log level to DEBUG.") do |v|
     server.debug = v
@@ -67,49 +80,41 @@ parser = OptionParser.new do |opts|
   end
 end
 
+parser.parse!
+require 'protobuf'
+
+[:INT, :QUIT, :TERM].each do |sig|
+  trap(sig) do
+    server.runner.stop
+  end
+end
+
 begin
-  parser.parse!
-  
   if ARGV.empty?
-    raise 'You must specify an app file to use.'
+    puts 'You must specify an app file to use.'
+    puts parser.help
+    exit
   else
     server.app = ARGV.pop
     raise 'Invalid app file specified (%s).' % server.app unless File.exists?(server.app)
   end
-  
+
   # Configure the Protobuf::Logger
   Protobuf::Logger.configure :file => server.log, :level => server.debug ? ::Logger::DEBUG : server.level
 
   # Output the server opts
   Protobuf::Logger.debug 'Debugging options:'
   Protobuf::Logger.debug server.inspect
-
-  # Ensure errors thrown within EM are caught and logged appropriately
-  EventMachine.error_handler do |error|
-    if error.message == 'no acceptor'
-      raise 'Failed binding to %s:%d (%s)' % [server.host, server.port, error.message]
-    else
-      Protobuf::Logger.error error.message
-      Protobuf::Logger.error error.backtrace.join("\n")
-    end
-  end
   
   # Set the name of the process
   $0 = 'rpc_server %s:%d %s' % [server.host, server.port, server.app]
   
   # Require the given application file
   require server.app
-  
-  # Startup and run the rpc server
-  EM.schedule do
-    EventMachine.start_server(server.host, server.port, Protobuf::Rpc::Server) && \
-      Protobuf::Logger.info('RPC Server listening at %s:%d in %s' % [server.host, server.port, server.env])
-  end
 
-  # Join or start the reactor
-  EM.reactor_running? ? EM.reactor_thread.join : EM.run
+  server.runner.run(server)
 rescue
-  msg = 'ERROR: RPC Server failed to start. %s' % $!.message
+  msg = 'ERROR: RPC Server failed to start. %s' % $!.inspect
   $stderr.puts msg, *($!.backtrace)
   Protobuf::Logger.error msg
   Protobuf::Logger.error $!.backtrace.join("\n")

data/lib/protobuf.rb

@@ -1,9 +1,28 @@
-require 'eventmachine'
-require 'protobuf/ext/eventmachine'
+require 'logger'
+require 'socket'
+require 'pp'
+require 'stringio'
 
 module Protobuf
 end
 
+# When setting up a client
+unless defined?(Protobuf::ConnectorType) && Protobuf::ConnectorType == "Socket"
+  Protobuf::ConnectorType = "EventMachine"
+  require 'eventmachine'
+  require 'protobuf/ext/eventmachine'
+  require 'protobuf/rpc/connectors/eventmachine'
+end
+
+# For running the rpc_server
+unless defined?(Protobuf::ServerType) && Protobuf::ServerType == "SocketServer"
+  Protobuf::ServerType = "EventedServer"
+  require 'eventmachine'
+  require 'protobuf/ext/eventmachine'
+  require 'protobuf/rpc/servers/evented_server'
+end
+
 require 'protobuf/rpc/client'
-require 'protobuf/rpc/server'
+require 'protobuf/rpc/connectors/socket'
 require 'protobuf/rpc/service'
+require 'protobuf/rpc/servers/socket_server'

data/lib/protobuf/common/logger.rb

@@ -1,5 +1,3 @@
-require 'logger'
-
 module Protobuf
   class Logger < ::Logger
     
@@ -7,15 +5,11 @@ module Protobuf
       attr_accessor :file, :level
       
       # One-line file/level configuration
-      def configure options
+      def configure(options)
         self.file = options[:file] if options[:file]
         self.level = options[:level] if options[:level]
       end
       
-      def configured?
-        ! instance.nil?
-      end
-      
       # Use to reset the instance
       def reset_device!
         self.file = self.level = @__instance = nil
@@ -58,7 +52,11 @@ module Protobuf
           Protobuf::Logger.__send__(m, *params, &block)
         end
       end
+
+      def self.included(base)
+        base.extend(LogMethods)
+      end
     end
     
   end
-end
+end

data/lib/protobuf/compiler/visitors.rb

@@ -110,15 +110,14 @@ module Protobuf
       end
 
       def create_files(filename, out_dir, file_create)
-        begin
-          $: << File.expand_path(out_dir)
-          Class.new.class_eval(to_s) # check the message
-          $:.delete File.expand_path(out_dir)
-        rescue LoadError
-          puts "Error creating file #{filename}"
-          puts $!.message
-          exit 1
-        end
+        $: << File.expand_path(out_dir)
+        Class.new.class_eval(to_s) # check the message
+        $:.delete File.expand_path(out_dir)
+      rescue LoadError
+        puts "Error creating file #{filename}"
+        puts $!.message
+        exit 1
+      else 
         
         file = File.basename(filename)
         message_module = Util.module_to_path(package.map{|p| p.to_s.capitalize}.join('::'))

data/lib/protobuf/descriptor/descriptor_builder.rb

@@ -107,12 +107,12 @@ module Protobuf
     def self.label2id(label)
       require 'protobuf/descriptor/descriptor_proto'
       case label
-      when :required
-        Google::Protobuf::FieldDescriptorProto::Label::LABEL_REQUIRED then
-      when :optional
-        Google::Protobuf::FieldDescriptorProto::Label::LABEL_OPTIONAL then
-      when :repeated
-        Google::Protobuf::FieldDescriptorProto::Label::LABEL_REPEATED then
+      when :required then
+        Google::Protobuf::FieldDescriptorProto::Label::LABEL_REQUIRED
+      when :optional then
+        Google::Protobuf::FieldDescriptorProto::Label::LABEL_OPTIONAL
+      when :repeated then
+        Google::Protobuf::FieldDescriptorProto::Label::LABEL_REPEATED
       else
         raise ArgumentError, "Invalid label: #{label}"
       end

data/lib/protobuf/ext/eventmachine.rb

@@ -1,6 +1,6 @@
 require 'fiber'
 
-# Method and concept from em-synchrony
+# Method from em-synchrony
 # https://github.com/igrigorik/em-synchrony
 #
 # A convenience method for wrapping EM.run body within
@@ -8,9 +8,7 @@ require 'fiber'
 # paused and resumed based on IO scheduling
 module EventMachine
   def self.fiber_run(blk=nil, tail=nil, &block)
-    blk ||= block
-    context = Proc.new{ Fiber.new{ blk.call }.resume }
-
+    context = Proc.new{ Fiber.new{ (b = blk || block) and b.call }.resume }
     self.run(context, tail)
   end
 end

data/lib/protobuf/message/message.rb

@@ -1,5 +1,3 @@
-require 'pp'
-require 'stringio'
 require 'protobuf/descriptor/descriptor'
 require 'protobuf/message/decoder'
 require 'protobuf/message/encoder'
@@ -27,7 +25,7 @@ module Protobuf
       end
     end
 
-    class <<self
+    class << self
       include Protoable
 
       # Reserve field numbers for extensions. Don't use this method directly.

data/lib/protobuf/rpc/buffer.rb

@@ -7,21 +7,21 @@ module Protobuf
       
       MODES = [:read, :write]
       
-      def initialize mode=:read, data=''
+      def initialize(mode=:read, data='')
         @data = data.is_a?(Protobuf::Message) ? data.serialize_to_string : data.to_s
         @flush = false
         self.mode = mode
       end
       
-      def mode= mode
-        if MODES.include? mode
+      def mode=(mode)
+        if MODES.include?(mode)
           @mode = mode
         else
           @mode = :read
         end
       end
       
-      def write force_mode=true
+      def write(force_mode=true)
         if force_mode and reading?
           mode = :write
         elsif not force_mode and reading?
@@ -32,7 +32,7 @@ module Protobuf
         '%d-%s' % [@size, @data]
       end
       
-      def << data
+      def <<(data)
         @data << data
         if reading?
           get_data_size
@@ -71,4 +71,4 @@ module Protobuf
       
     end
   end
-end
+end

data/lib/protobuf/rpc/client.rb

@@ -9,7 +9,7 @@ module Protobuf
       extend Forwardable
       include Protobuf::Logger::LogMethods
       
-      delegate [:options, :success_cb, :failure_cb, :async?] => :@connector
+      delegate [:options, :complete_cb, :success_cb, :failure_cb, :async?] => :@connector
       attr_reader :connector
       
       # Create a new client with default options (defined in ClientConnection)
@@ -25,22 +25,32 @@ module Protobuf
       #     :request => request
       #   })
       #
-      def initialize opts={}
-        raise "Invalid client configuration. Service must be defined." if !opts[:service] || opts[:service].nil?
-        @connector = Connector.connector_for_platform.new(opts)
-        log_debug '[client] Initialized with options: %s' % opts.inspect
+      def initialize(opts={})
+        raise "Invalid client configuration. Service must be defined." if opts[:service].nil?
+        @connector = Connector.connector_for_client.new(opts)
+        log_debug "[#{log_signature}] Initialized with options: %s" % opts.inspect
+      end
+
+      def log_signature
+        @log_signature ||= "client-#{self.class}"
       end
       
-      # Set a success callback on the client to return the
-      # successful response from the service when it is returned.
-      # If this callback is called, failure_cb will NOT be called.
+      # Set a complete callback on the client to return the object (self). 
       # Callback is called regardless of :async setting.
       # 
       #   client = Client.new(:service => WidgetService)
-      #   client.on_success {|res| ... }
+      #   client.on_complete {|obj| ... }
       # 
-      def on_success &success_cb
-        @connector.success_cb = success_cb
+      def on_complete(&complete_cb)
+        @connector.complete_cb = complete_cb 
+      end
+
+      def on_complete=(callable)
+        if callable != nil && !callable.respond_to?(:call) && callable.arity != 1
+          raise "callable must take a single argument and respond to :call"
+        end
+        
+        @connector.complete_cb = callable 
       end
       
       # Set a failure callback on the client to return the
@@ -51,9 +61,37 @@ module Protobuf
       #   client = Client.new(:service => WidgetService)
       #   client.on_failure {|err| ... }
       # 
-      def on_failure &failure_cb
+      def on_failure(&failure_cb)
         @connector.failure_cb = failure_cb
       end
+
+      def on_failure=(callable)
+        if callable != nil && !callable.respond_to?(:call) && callable.arity != 1
+          raise "callable must take a single argument and respond to :call"
+        end
+
+        @connector.failure_cb = callable 
+      end
+      
+      # Set a success callback on the client to return the
+      # successful response from the service when it is returned.
+      # If this callback is called, failure_cb will NOT be called.
+      # Callback is called regardless of :async setting.
+      # 
+      #   client = Client.new(:service => WidgetService)
+      #   client.on_success {|res| ... }
+      # 
+      def on_success(&success_cb)
+        @connector.success_cb = success_cb
+      end
+
+      def on_success=(callable)
+        if callable != nil && !callable.respond_to?(:call) && callable.arity != 1
+          raise "callable must take a single argument and respond to :call"
+        end
+
+        @connector.success_cb = callable 
+      end
       
       # Provides a mechanism to call the service method against the client
       # which will automatically setup the service_class and method_name
@@ -67,28 +105,28 @@ module Protobuf
       #     c.on_failure {|err| ... }
       #   end
       # 
-      def method_missing method, *params
+      def method_missing(method, *params)
         service = options[:service]
         unless service.rpcs[service].keys.include?(method)
-          log_error '[client] %s#%s not rpc method, passing to super' % [service.name, method.to_s]
-          super method, *params
+          log_error "[#{log_signature}] %s#%s not rpc method, passing to super" % [service.name, method.to_s]
+          super(method, *params)
         else
-          log_debug '[client] %s#%s' % [service.name, method.to_s]
+          log_debug "[#{log_signature}] %s#%s" % [service.name, method.to_s]
           rpc = service.rpcs[service][method.to_sym]
           options[:request_type] = rpc.request_type
-          log_debug '[client] Request Type: %s' % options[:request_type].name
+          log_debug "[#{log_signature}] Request Type: %s" % options[:request_type].name
           options[:response_type] = rpc.response_type
-          log_debug '[client] Response Type: %s' % options[:response_type].name
+          log_debug "[#{log_signature}] Response Type: %s" % options[:response_type].name
           options[:method] = method.to_s
           options[:request] = params[0].is_a?(Hash) ? options[:request_type].new(params[0]) : params[0]
-          log_debug '[client] Request Data: %s' % options[:request].inspect
+          log_debug "[#{log_signature}] Request Data: %s" % options[:request].inspect
           
           # Call client to setup on_success and on_failure event callbacks
           if block_given?
-            log_debug '[client] client setup callback given, invoking'
+            log_debug "[#{log_signature}] client setup callback given, invoking"
             yield(self)
           else
-            log_debug '[client] no callbacks given'
+            log_debug "[#{log_signature}] no block given for callbacks"
           end
       
           send_request