protobuf 3.3.6 → 3.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8975f51cd8e6d910cbe547b32bc5107fa4d197a5
+  data.tar.gz: 3f39633e344de3b196a11b8182e85884ddb678e1
+SHA512:
+  metadata.gz: 8b7ca982042d842556d2f239cd0f5a70c33905efa33b1269baf8c29f6db2cafc64ee9efdc114dc9b702a07d25c13a8ded348552f94e259483f36f4ca4253e889
+  data.tar.gz: dc741258194bc09864a45ff2d6824544095f60c7658fefeb4e062d2ccdfb9684bd511254c351c0e8e8574d30f75877bff1a4c7ad1f4ab569d5baae0857ebceb8

data/.rubocop.yml

@@ -0,0 +1,48 @@
+inherit_from: .rubocop_todo.yml
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Lint/Loop:
+  Enabled: false
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - '**/*.pb.rb'
+
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+Style/EmptyLines:
+  Exclude:
+    - '**/*.pb.rb'
+
+Style/FileName:
+  Exclude:
+    - '**/protoc-gen-ruby*'
+
+Style/GuardClause:
+  MinBodyLength: 4
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/TrailingBlankLines:
+  Exclude:
+    - '**/*.pb.rb'
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+Style/TrivialAccessors:
+  AllowDSLWriters: true
+  AllowPredicates: true

data/.rubocop_todo.yml

@@ -0,0 +1,79 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-11-24 09:44:26 -0800 using RuboCop version 0.27.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 28
+Metrics/AbcSize:
+  Max: 59
+
+# Offense count: 3
+Metrics/BlockNesting:
+  Max: 5
+
+# Offense count: 9
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 233
+
+# Offense count: 3
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+# Offense count: 508
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 196
+
+# Offense count: 48
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 45
+
+# Offense count: 2
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 12
+
+# Offense count: 216
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 15
+Style/DoubleNegation:
+  Enabled: false
+
+# Offense count: 100
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# Offense count: 66
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+# Offense count: 53
+# Cop supports --auto-correct.
+Style/NumericLiterals:
+  MinDigits: 21
+
+# Offense count: 464
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiterals:
+  Enabled: false
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: WordRegex.
+Style/WordArray:
+  MinSize: 2

data/.travis.yml

@@ -1,9 +1,17 @@
+before_install:
+  - sudo apt-get update -qq
+  - sudo apt-get install -y libzmq3-dev
+  - sudo ./install-protobuf.sh
 language: ruby
 rvm:
-  - "1.9.3"
-  - "2.0.0"
-  - "2.1.1"
-script: NO_COMPILE_TEST_PROTOS=1 bundle exec rake spec/lib
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - jruby
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: rbx-2
 notifications:
   webhooks:
     urls:

data/Rakefile

@@ -1,5 +1,5 @@
-$: << ::File.expand_path('../', __FILE__)
-$: << ::File.expand_path('../spec', __FILE__)
+$LOAD_PATH << ::File.expand_path('../', __FILE__)
+$LOAD_PATH << ::File.expand_path('../spec', __FILE__)
 
 require 'fileutils'
 require 'rubygems'
@@ -8,31 +8,34 @@ require 'bundler/gem_tasks'
 require 'benchmark/tasks'
 
 require 'rspec/core/rake_task'
-
-desc 'Default: run specs.'
-task :default => :spec
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task :default => ['compile:spec', 'compile:rpc', :spec, :rubocop]
 
 desc 'Run specs'
 namespace :compile do
 
   desc 'Compile spec protos in spec/supprt/ directory'
-  task :spec do |task, args|
+  task :spec do
     proto_path = ::File.expand_path('../spec/support/', __FILE__)
-    cmd = %Q{protoc --plugin=./bin/protoc-gen-ruby --ruby_out=#{proto_path} -I #{proto_path} #{File.join(proto_path, '**', '*.proto')}}
+    proto_files = Dir[File.join(proto_path, '**', '*.proto')]
+    cmd = %(protoc --plugin=./bin/protoc-gen-ruby --ruby_out=#{proto_path} -I #{proto_path} #{proto_files.join(' ')})
 
     puts cmd
-    exec(cmd)
+    system(cmd)
   end
 
   desc 'Compile rpc protos in protos/ directory'
-  task :rpc do |task, args|
+  task :rpc do
     proto_path = ::File.expand_path('../proto', __FILE__)
+    proto_files = Dir[File.join(proto_path, '**', '*.proto')]
     output_dir = ::File.expand_path('../tmp/rpc', __FILE__)
     ::FileUtils.mkdir_p(output_dir)
 
-    cmd = %Q{protoc --plugin=./bin/protoc-gen-ruby --ruby_out=#{output_dir} -I #{proto_path} #{File.join(proto_path, '**', '*.proto')}}
+    cmd = %(protoc --plugin=./bin/protoc-gen-ruby --ruby_out=#{output_dir} -I #{proto_path} #{proto_files.join(' ')})
 
     puts cmd
     system(cmd)
@@ -41,7 +44,7 @@ namespace :compile do
       'tmp/rpc/dynamic_discovery.pb.rb'               => 'lib/protobuf/rpc',
       'tmp/rpc/rpc.pb.rb'                             => 'lib/protobuf/rpc',
       'tmp/rpc/google/protobuf/descriptor.pb.rb'      => 'lib/protobuf/descriptors/google/protobuf',
-      'tmp/rpc/google/protobuf/compiler/plugin.pb.rb' => 'lib/protobuf/descriptors/google/protobuf/compiler'
+      'tmp/rpc/google/protobuf/compiler/plugin.pb.rb' => 'lib/protobuf/descriptors/google/protobuf/compiler',
     }
 
     files.each_pair do |source_file, destination_dir|

data/bin/protoc-gen-ruby

@@ -14,4 +14,3 @@ request_bytes = STDIN.read
 code_generator = ::Protobuf::CodeGenerator.new(request_bytes)
 response_bytes = code_generator.response_bytes
 STDOUT.print(response_bytes)
-

data/bin/rpc_server

@@ -2,3 +2,4 @@
 
 require 'protobuf/cli'
 ::Protobuf::CLI.start(ARGV)
+exit

data/install-protobuf.sh

@@ -0,0 +1,8 @@
+set -ex
+
+basename=protobuf-2.6.0
+tarball=$basename.tar.bz2
+
+wget https://protobuf.googlecode.com/svn/rc/$tarball
+tar -xvf $tarball
+cd $basename && ./configure --prefix=/usr && make && make install

data/lib/protobuf.rb

@@ -5,32 +5,32 @@ require 'stringio'
 
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/object/try'
-require 'active_support/notifications'
 require 'active_support/inflector'
 require 'active_support/json'
+require 'active_support/notifications'
+
+require 'protobuf/deprecation'
 
 module Protobuf
 
   # See Protobuf#connector_type documentation.
-  CONNECTORS = [ :socket, :zmq ].freeze
+  CONNECTORS = [:socket, :zmq].freeze
 
   # Default is Socket as it has no external dependencies.
   DEFAULT_CONNECTOR = :socket
 
   module_function
 
-  # Client Host
-  #
-  # Default: `hostname` of the system
-  #
-  # The name or address of the host to use during client RPC calls.
-  def self.client_host
-    @_client_host ||= `hostname`.chomp
+  class << self
+    # Client Host
+    #
+    # Default: `hostname` of the system
+    #
+    # The name or address of the host to use during client RPC calls.
+    attr_accessor :client_host
   end
 
-  def self.client_host=(host)
-    @_client_host = host
-  end
+  self.client_host = Socket.gethostname
 
   # Connector Type
   #
@@ -39,12 +39,12 @@ module Protobuf
   # Symbol value which denotes the type of connector to use
   # during client requests to an RPC server.
   def self.connector_type
-    @_connector_type ||= DEFAULT_CONNECTOR
+    @connector_type ||= DEFAULT_CONNECTOR
   end
 
   def self.connector_type=(type)
-    raise ArgumentError, 'Invalid connector type given' unless CONNECTORS.include?(type)
-    @_connector_type = type
+    fail ArgumentError, 'Invalid connector type given' unless CONNECTORS.include?(type)
+    @connector_type = type
   end
 
   # GC Pause during server requests
@@ -56,12 +56,19 @@ module Protobuf
   # Once the request is completed, the GC is enabled again.
   # This optomization provides a huge boost in speed to rpc requests.
   def self.gc_pause_server_request?
-    return @_gc_pause_server_request unless @_gc_pause_server_request.nil?
+    return @gc_pause_server_request unless @gc_pause_server_request.nil?
     self.gc_pause_server_request = false
   end
 
   def self.gc_pause_server_request=(value)
-    @_gc_pause_server_request = !!value
+    @gc_pause_server_request = !!value
+  end
+
+  def self.deprecator
+    @deprecator ||= Deprecation.new('4.0', to_s).tap do |deprecation|
+      deprecation.silenced = ENV.key?('PB_IGNORE_DEPRECATIONS')
+      deprecation.behavior = :stderr
+    end
   end
 
   # Print Deprecation Warnings
@@ -75,12 +82,11 @@ module Protobuf
   #
   # The rpc_server option will override the ENV setting.
   def self.print_deprecation_warnings?
-    return @_print_deprecation_warnings unless @_print_deprecation_warnings.nil?
-    self.print_deprecation_warnings = ENV.key?('PB_IGNORE_DEPRECATIONS') ? false : true
+    !deprecator.silenced
   end
 
   def self.print_deprecation_warnings=(value)
-    @_print_deprecation_warnings = !!value
+    deprecator.silenced = !value
   end
 
   # Permit unknown field on Message initialization
@@ -90,11 +96,11 @@ module Protobuf
   # Simple boolean to define whether we want to permit unknown fields
   # on Message intialization; otherwise a ::Protobuf::FieldNotDefinedError is thrown.
   def self.ignore_unknown_fields?
-    !defined?(@_ignore_unknown_fields) || @_ignore_unknown_fields
+    !defined?(@ignore_unknown_fields) || @ignore_unknown_fields
   end
 
   def self.ignore_unknown_fields=(value)
-    @_ignore_unknown_fields = !!value
+    @ignore_unknown_fields = !!value
   end
 end
 
@@ -102,9 +108,9 @@ unless ENV.key?('PB_NO_NETWORKING')
   require 'protobuf/rpc/client'
   require 'protobuf/rpc/service'
 
-  env_connector_type = ENV.fetch('PB_CLIENT_TYPE') {
+  env_connector_type = ENV.fetch('PB_CLIENT_TYPE') do
     ::Protobuf::DEFAULT_CONNECTOR
-  }.to_s.downcase.strip.to_sym
+  end.to_s.downcase.strip.to_sym
 
   if ::Protobuf::CONNECTORS.include?(env_connector_type)
     require "protobuf/#{env_connector_type}"

data/lib/protobuf/cli.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/hash/keys'
+
 require 'thor'
 require 'protobuf/version'
 require 'protobuf/logging'
@@ -9,7 +11,11 @@ module Protobuf
     include ::Thor::Actions
     include ::Protobuf::Logging
 
-    attr_accessor :runner, :mode
+    attr_accessor :runner, :mode, :exit_requested
+
+    no_commands do
+      alias_method :exit_requested?, :exit_requested
+    end
 
     default_task :start
 
@@ -100,33 +106,34 @@ module Protobuf
       # Re-write the $0 var to have a nice process name in ps.
       def configure_process_name(app_file)
         debug_say('Configuring process name')
-        $0 = "rpc_server --#{@runner_mode} #{options.host}:#{options.port} #{app_file}"
+        $0 = "rpc_server --#{mode} #{options.host}:#{options.port} #{app_file}"
       end
 
       # Configure the mode of the server and the runner class.
       def configure_runner_mode
         debug_say('Configuring runner mode')
 
-        if multi_mode?
+        self.mode = if multi_mode?
           say('WARNING: You have provided multiple mode options. Defaulting to socket mode.', :yellow)
-          @runner_mode = :socket
+          :socket
         elsif options.zmq?
-          @runner_mode = :zmq
-        else
+          :zmq
+        else # rubocop:disable Style/ElseAlignment
+          # above: https://github.com/bbatsov/rubocop/pull/1470/files
           case server_type = ENV["PB_SERVER_TYPE"]
           when nil, /socket/i
-            @runner_mode = :socket
+            :socket
           when /zmq/i
-            @runner_mode = :zmq
+            :zmq
           else
             say "WARNING: You have provided incorrect option 'PB_SERVER_TYPE=#{server_type}'. Defaulting to socket mode.", :yellow
-            @runner_mode = :socket
+            :socket
           end
         end
       end
 
       # Configure signal traps.
-      # TODO add signal handling for hot-reloading the application.
+      # TODO: add signal handling for hot-reloading the application.
       def configure_traps
         debug_say('Configuring traps')
 
@@ -137,7 +144,7 @@ module Protobuf
           debug_say("Registering trap for exit signal #{signal}", :blue)
 
           trap(signal) do
-            @exit_requested = true
+            self.exit_requested = true
             shutdown_server
           end
         end
@@ -145,15 +152,15 @@ module Protobuf
 
       # Create the runner for the configured mode
       def create_runner
-        debug_say("Creating #{@runner_mode} runner")
-        @runner = case @runner_mode
-                  when :zmq
-                    create_zmq_runner
-                  when :socket
-                    create_socket_runner
-                  else
-                    say_and_exit("Unknown runner mode: #{@runner_mode}")
-                  end
+        debug_say("Creating #{mode} runner")
+        self.runner = case mode
+        when :zmq
+          create_zmq_runner
+        when :socket
+          create_socket_runner
+        else
+          say_and_exit("Unknown runner mode: #{mode}")
+        end
       end
 
       # Say something if we're in debug mode.
@@ -161,10 +168,6 @@ module Protobuf
         say(message, color) if options.debug?
       end
 
-      def exit_requested?
-        !!@exit_requested
-      end
-
       # Internal helper to determine if the modes are multi-set which is not valid.
       def multi_mode?
         options.zmq? && options.socket?
@@ -179,8 +182,7 @@ module Protobuf
       end
 
       def runner_options
-        # Symbolize keys
-        opt = options.inject({}) { |h, (k, v)| h[k.to_sym] = v; h }
+        opt = options.symbolize_keys
 
         opt[:workers_only] = (!!ENV['PB_WORKERS_ONLY']) || options.workers_only
 
@@ -206,18 +208,18 @@ module Protobuf
       def create_socket_runner
         require 'protobuf/socket'
 
-        @runner = ::Protobuf::Rpc::SocketRunner.new(runner_options)
+        self.runner = ::Protobuf::Rpc::SocketRunner.new(runner_options)
       end
 
       def create_zmq_runner
         require 'protobuf/zmq'
 
-        @runner = ::Protobuf::Rpc::ZmqRunner.new(runner_options)
+        self.runner = ::Protobuf::Rpc::ZmqRunner.new(runner_options)
       end
 
       def shutdown_server
         logger.info { 'RPC Server shutting down...' }
-        @runner.try(:stop)
+        runner.stop
         ::Protobuf::Rpc::ServiceDirectory.instance.stop
       end
 
@@ -225,17 +227,15 @@ module Protobuf
       def start_server
         debug_say('Running server')
 
-        @runner.run do
-          logger.info {
-            "pid #{::Process.pid} -- #{@runner_mode} RPC Server listening at #{options.host}:#{options.port}"
-          }
+        runner.run do
+          logger.info do
+            "pid #{::Process.pid} -- #{mode} RPC Server listening at #{options.host}:#{options.port}"
+          end
 
           ::ActiveSupport::Notifications.instrument("after_server_bind")
         end
 
         logger.info { 'Shutdown complete' }
-
-        exit 0
       end
     end
   end