protobuf 2.8.13 → 3.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 450f953345bf0510126fb5bbd1fe8e1e432b1713
-  data.tar.gz: d61858293423248cfa6fa535b7b85a265971c292
+  metadata.gz: 7f5adb66133630992323a9997d949111915d8829
+  data.tar.gz: 7e38efbe7179f878ba6851d7b959e2c4e9227399
 SHA512:
-  metadata.gz: 94314fef1e4ec9e3d52dc02c58c1d24425c486080393da52eb722c49955688655f6f5543041fadd5df098fb96575198cd12da95cf4adf66f0c0ac48c49db2fd9
-  data.tar.gz: 798d0d104e6ab490fadda832837bcece0b19ff9f7509dd54d50162cfe9ce76c24d47a4af78915651135ba5153cc5da2c1c44b85476b3d5a9f8a5369620e14e7e
+  metadata.gz: a5753795f4b427bad944603d34eacd68ba6f649104f841ffbd6f32ba09413206f0113087b588023ffaa5390ab96ddc4b669cb72a8dde924eb3b9818f9283ad79
+  data.tar.gz: 9144fc91254485e6af4bb9d25db6b2401a50a63920d2749ef262069802a2d0787020a65f81ac098b0f16f0fa6ac4b1a28a231d3997c8c6b3d5a5727e0e82a563

data/CHANGES.md

@@ -1,7 +1,86 @@
-2.8.13
+# Unstable
+
+3.0.0.rc1
 ---------
 
-- Backport #190 to 2.8 stable series. [#192]
+A lot has changed leading up to the release of 3.0. For all the relevant changes,
+see the closed [pull requests and issues list in github](https://github.com/localshred/protobuf/issues?milestone=1&state=closed).
+Below is a high-level list of fixes, deprecations, breaking changes, and new APIs.
+
+### EventMachine is dead, Long live EventMachine
+
+The EventMachine client and server have been removed from this gem. They code was far
+too error prone and flawed to feasibly support going forward. It's recommended
+to switch to the socket implementation (using `PB_CLIENT_TYPE` and `PB_SERVER_TYPE` of `socket`)
+for a painless switchover. The ZMQ implementation is much more performant but
+does have a dependency on libzmq.
+
+### Server Middlewares
+
+The server/dispatcher stack has been converted to the Middleware pattern!
+Exception handling (#162, #164), Request decoding (#160, #166), Response encoding (#161, #167),
+Logging and stats (#163), and Method dispatch (#159) have all been extracted into their
+own Middlewares to greatly simplify testing and further development of the server
+stack, furthering our preparations for removing the socket implementations (zmq, socket)
+into their own gems in version 4.0. Major props to @liveh2o for [tackling this beast](https://github.com/localshred/protobuf/tree/master/lib/protobuf/rpc/middleware).
+
+#### Bug Fixes
+
+- Resolve DNS names (e.g. localhost) when using ZMQ server. [#46, reported by @reddshack]
+- Switched to hash based value storage for messages to fix large field tag memory issues. [#118, #165]
+- `Enum.fetch` used to return an enum of any type if that is the value passed in. [#168]
+
+#### Deprecations
+
+__!! NOTE: These deprecated methods will be removed in v3.1. !!__
+
+- Deprecated `BaseField#type` in favor of `#type_class`.
+- Deprecated `Message.get_ext_field_by_name` in favor of `.get_extension_field` or `.get_field(name_or_tag, true)`.
+- Deprecated `Message.get_ext_field_by_tag,` in favor of `.get_extension_field` or `.get_field(name_or_tag, true)`.
+- Deprecated `Message.get_field_by_name,` in favor of `.get_field`.
+- Deprecated `Message.get_field_by_tag,` in favor of `.get_field`.
+- Deprecated `Enum.enum_by_value` in favor of `.enum_for_tag`.
+- Deprecated `Enum.name_by_value` in favor of `.name_for_tag`.
+- Deprecated `Enum.get_name_by_tag` in favor of `.name_for_tag`.
+- Deprecated `Enum.value_by_name` in favor of `.enum_for_name`.
+- Deprecated `Enum.values` in favor of `.enums`. Beware that `.enums` returns an array where `.values` returns a hash.
+   Use `.all_tags` if you just need all the valid tag numbers. In other words, don't do this anymore: `MyEnum.values.values.map(&:to_i).uniq`.
+
+#### Breaking Changes
+
+- All files/classes relating to the EventMachine client and server are gone. Use `PB_CLIENT_TYPE` and `PB_SERVER_TYPE` of `socket` instead. [#116]
+- Cleaned up the `Enum` class, deprecating/renaming most methods. tl;dr, just use `MyEnum.fetch`.
+   See #134 for more comprehensive documentation about which methods are going and away and which are being renamed. [#134]
+- Pulled `EnumValue` into `Enum`. The `EnumValue` class no longer exists. Use `Enum` for type-checking instead. [#168].
+- Removed previously deprecated `bin/rprotoc` executable. Use `protoc --ruby_out=...` instead. [13fbdb9]
+- Removed previously deprecated `Service#rpc` method. Use `Service#env#method_name` instead. [f391294]
+- Changed the `Service#initialize` to take an `Env` object instead of separate request, method, and client parameters. [6c61bf72]
+- Removed attribute readers for `Service#method_name` and `Service#client_host`. Use `Service#env` to get them instead.
+- Removed `lib/protobuf/message/message.rb`. Use `lib/protobuf/message.rb` instead.
+- Removed field getters from Message instances (e.g. `Message#get_field_by_name`).
+   Use class-level getters instead (see Deprecations section).
+- Moved `lib/protobuf/message/decoder.rb` to `lib/protobuf/decoder.rb`. The module is still named `Protobuf::Decoder`.
+- Removed `Protobuf::Field::ExtensionFields` class.
+- Removed instance-level `max` and `min` methods from all relevant Field classes (e.g. Int32Field, Uint64Field, etc).
+   Use class-level methods of the same names instead. [#176, 992eb051]
+- `PbError#to_response` no longer receives an argument, instead returning a new `Socketrpc::Response` object. [#147, @liveh2o]
+- The Server module has been stripped of almost all methods, now simply invokes the Middleware stack for each request. [#159, @liveh2o]
+- Removed `Protobuf::PROTOC_VERSION` constant now that the compiler supports any protoc version.
+
+#### New APIs
+
+- Added support for [enum `allow_alias` option](https://developers.google.com/protocol-buffers/docs/proto#enum). [#134]
+- `Enum.all_tags` returns an array of unique tags. Use it to replace `Enum.values.values.map(&:to_i)` (`Enum.values` is deprecated).
+- `Enum.enums` returns an array of all defined enums for that class (including any aliased Enums).
+- Reinstated support for symbol primitive field types in generated Message code. [#170]
+- `Message.get_field` accepts a second boolean parameter (default false) to return an extension field if found. [#169]
+- Mirror existing `Decoder#decode_from(stream)` with `Encoder#encode_to(stream)`. [#169]
+- `Server` now invokes the [middleware stack](https://github.com/localshred/protobuf/tree/master/lib/protobuf/rpc/middleware) for request handling. [#159, @liveh2o]
+- Added `protobuf:compile` and `protobuf:clean` rake tasks. Simply `load 'protobuf/tasks/compile.rake'` in your Rakefile (see `compile.rake` for arguments and usage). [#142, #143]
+- Add `Protobuf::Deprecator` module to alias deprecated methods. [#165]
+
+
+# Stable (2.x)
 
 2.8.12
 ---------
@@ -19,14 +98,14 @@
 2.8.10
 ---------
 
-- Allow passing a file extension to compile/clean rake tasks. [#143, @localshred]
+- Allow passing a file extension to compile/clean rake tasks. [#143]
 
 2.8.9
 ---------
 
 - Deprecated Protobuf::Lifecycle module in favor of using ActiveSupport::Notifications. [#139, @devin-c]
-- Modify `$LOAD_PATH` inside descriptors.rb to make it easier for other libraries to write their own compiler plugins using our pre-compiled descriptors. [#141, @localshred]
-- Add protobuf:clean and protobuf:compile rake tasks for use in external libraries to compile source definitions to a destination. [#142, @localshred]
+- Modify `$LOAD_PATH` inside descriptors.rb to make it easier for other libraries to write their own compiler plugins using our pre-compiled descriptors. [#141]
+- Add protobuf:clean and protobuf:compile rake tasks for use in external libraries to compile source definitions to a destination. [#142]
 
 2.8.8
 ---------

data/CONTRIBUTING.md

@@ -6,11 +6,11 @@ your code merged.
 
 1. Use GitHub Issues or Pull Requests over sending an email. It's much easier for me to keep track of your issue through GitHub.
 2. For __compiler issues__, please provide both a gist for the __source definition(s)__ as well as the __generated output__ (if any).
-3. For __pull requests__ for __existing issues or functionality__, please use the __base branch `2-7-stable`__ for the pull request. This helps us maintain a stable gem release strategy. All commits merged to `2-7-stable` will also be merged down to `master`.
-4. For __pull requests__ for __new functionality__, please use the __base branch `master`__ for the pull request. The `master` branch is used to stage all "next iteration" work.
+3. For __existing issues or functionality__, please use __`2-8-stable`__ as the base branch for the pull request. This helps us maintain a stable gem release strategy. All commits merged to `2-8-stable` will also be merged down to `master`.
+4. For __new functionality__, please use __`master`__ as the base branch for the pull request. The `master` branch is used to stage all "next iteration" work.
 5. Be patient with me as I work on your issue.
 
 Following these simple guidelines really will help me help you. And really,
-that's what we're here for. :)
+that's what we're here for. I'm on @localshred on twitter, let's be friends. :)
 
 ## Happy Contributing!

data/Rakefile

@@ -1,19 +1,58 @@
 $: << ::File.expand_path('../', __FILE__)
 $: << ::File.expand_path('../spec', __FILE__)
 
-require "rubygems"
-require "rubygems/package_task"
-require "bundler/gem_tasks"
-# require "benchmark/tasks"
+require 'fileutils'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'bundler/gem_tasks'
+require 'benchmark/tasks'
 
-require "rspec/core/rake_task"
+require 'rspec/core/rake_task'
 
-desc "Default: run specs."
+desc 'Default: run specs.'
 task :default => :spec
 
-desc "Run specs"
 RSpec::Core::RakeTask.new(:spec)
 
+desc 'Run specs'
+namespace :compile do
+
+  desc 'Compile spec protos in spec/supprt/ directory'
+  task :spec do |task, args|
+    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')}}
+
+    puts cmd
+    exec(cmd)
+  end
+
+  desc 'Compile rpc protos in protos/ directory'
+  task :rpc do |task, args|
+    proto_path = ::File.expand_path('../proto', __FILE__)
+    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')}}
+
+    puts cmd
+    system(cmd)
+
+    files = {
+      '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'
+    }
+
+    files.each_pair do |source_file, destination_dir|
+      source_file = ::File.expand_path("../#{source_file}", __FILE__)
+      destination_dir = ::File.expand_path("../#{destination_dir}", __FILE__)
+      ::FileUtils::Verbose.cp(source_file, destination_dir)
+    end
+  end
+
+end
+
 task :console do
   require 'pry'
   require 'protobuf'

data/lib/protobuf/cli.rb

@@ -1,7 +1,6 @@
 require 'thor'
 require 'protobuf/version'
 require 'protobuf/logger'
-require 'protobuf/rpc/servers/evented_runner'
 require 'protobuf/rpc/servers/socket_runner'
 require 'protobuf/rpc/servers/zmq_runner'
 
@@ -26,7 +25,6 @@ module Protobuf
     option :level,                      :type => :numeric, :default => ::Logger::INFO, :aliases => %w(-v), :desc => 'Log level to use, 0-5 (see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/)'
 
     option :socket,                     :type => :boolean, :aliases => %w(-s), :desc => 'Socket Mode for server and client connections.'
-    option :evented,                    :type => :boolean, :aliases => %w(-m), :desc => 'Evented Mode for server and client connections (uses EventMachine).'
     option :zmq,                        :type => :boolean, :aliases => %w(-z), :desc => 'ZeroMQ Socket Mode for server and client connections.'
 
     option :beacon_interval,            :type => :numeric, :desc => 'Broadcast beacons every N seconds. (default: 5)'
@@ -59,7 +57,7 @@ module Protobuf
 
     desc 'version', 'Print ruby and protoc versions and exit.'
     def version
-      say("Ruby Protobuf v#{::Protobuf::VERSION}, protoc v#{::Protobuf::PROTOC_VERSION}")
+      say("Ruby Protobuf v#{::Protobuf::VERSION}")
     end
 
     no_tasks do
@@ -111,16 +109,12 @@ module Protobuf
           @runner_mode = :socket
         elsif options.zmq?
           @runner_mode = :zmq
-        elsif options.evented?
-          @runner_mode = :evented
         else
           case server_type = ENV["PB_SERVER_TYPE"]
           when nil, /socket/i
             @runner_mode = :socket
           when /zmq/i
             @runner_mode = :zmq
-          when /evented/i
-            @runner_mode = :evented
           else
             say "WARNING: You have provided incorrect option 'PB_SERVER_TYPE=#{server_type}'. Defaulting to socket mode.", :yellow
             @runner_mode = :socket
@@ -150,8 +144,6 @@ module Protobuf
       def create_runner
         debug_say("Creating #{@runner_mode} runner")
         @runner = case @runner_mode
-                  when :evented
-                    create_evented_runner
                   when :zmq
                     create_zmq_runner
                   when :socket
@@ -172,11 +164,7 @@ module Protobuf
 
       # Internal helper to determine if the modes are multi-set which is not valid.
       def multi_mode?
-        [
-          options.zmq?,
-          options.evented?,
-          options.socket?,
-        ].count(true) > 1
+        options.zmq? && options.socket?
       end
 
       # Require the application file given, exiting if the file doesn't exist.
@@ -211,12 +199,6 @@ module Protobuf
         exit(1)
       end
 
-      def create_evented_runner
-        require 'protobuf/evented'
-
-        @runner = ::Protobuf::Rpc::EventedRunner.new(runner_options)
-      end
-
       def create_socket_runner
         require 'protobuf/socket'
 

data/lib/protobuf/decoder.rb

@@ -0,0 +1,74 @@
+require 'protobuf/wire_type'
+require 'protobuf/exceptions'
+
+module Protobuf
+  class Decoder
+
+    # Read bytes from +stream+ and pass to +message+ object.
+    def self.decode_each_field(stream, &block)
+      until stream.eof?
+        tag, bytes = read_field(stream)
+        block.call(tag, bytes)
+      end
+    end
+
+    def self.read_field(stream)
+      tag, wire_type = read_key(stream)
+      bytes = case wire_type
+              when ::Protobuf::WireType::VARINT then
+                read_varint(stream)
+              when ::Protobuf::WireType::FIXED64 then
+                read_fixed64(stream)
+              when ::Protobuf::WireType::LENGTH_DELIMITED then
+                read_length_delimited(stream)
+              when ::Protobuf::WireType::FIXED32 then
+                read_fixed32(stream)
+              when ::Protobuf::WireType::START_GROUP then
+                raise NotImplementedError, 'Group is deprecated.'
+              when ::Protobuf::WireType::END_GROUP then
+                raise NotImplementedError, 'Group is deprecated.'
+              else
+                raise InvalidWireType, wire_type
+              end
+
+      return tag, bytes
+    end
+
+    # Read 32-bit string value from +stream+.
+    def self.read_fixed32(stream)
+      stream.read(4)
+    end
+
+    # Read 64-bit string value from +stream+.
+    def self.read_fixed64(stream)
+      stream.read(8)
+    end
+
+    # Read key pair (tag and wire-type) from +stream+.
+    def self.read_key(stream)
+      bits = read_varint(stream)
+      wire_type = bits & 0x07
+      tag = bits >> 3
+      [tag, wire_type]
+    end
+
+    # Read length-delimited string value from +stream+.
+    def self.read_length_delimited(stream)
+      value_length = read_varint(stream)
+      stream.read(value_length)
+    end
+
+    # Read varint integer value from +stream+.
+    def self.read_varint(stream)
+      value = index = 0
+      begin
+        byte = stream.readbyte
+        value |= (byte & 0x7f) << (7 * index)
+        index += 1
+      end while (byte & 0x80).nonzero?
+      value
+    end
+
+  end
+end
+

data/lib/protobuf/deprecator.rb

@@ -0,0 +1,42 @@
+module Protobuf
+  module Deprecator
+
+    def warn_deprecated(old_method, new_method)
+      $stderr.puts %Q{[DEPRECATED] #{self.name}.#{old_method} is deprecated and will disappear in a future version.
+              Please use #{self.name}.#{new_method} instead.\n}
+    end
+
+    # Given deprecations should be a hash whose keys are the new methods
+    # and values are a list of deprecated methods that should send to t
+    def deprecate_method(old_method, new_method)
+      class_eval(<<-DEPRECATED, __FILE__, __LINE__ + 1)
+        def #{old_method}(*args)
+          warn_deprecated("#{old_method}", "#{new_method}")
+          new_meth = method("#{new_method}")
+          if new_meth.arity == 0
+            __send__("#{new_method}")
+          else
+            __send__("#{new_method}", *args)
+          end
+        end
+      DEPRECATED
+    end
+
+    # Given deprecations should be a hash whose keys are the new methods
+    # and values are a list of deprecated methods that should send to t
+    def deprecate_class_method(old_method, new_method)
+      class_eval(<<-DEPRECATED, __FILE__, __LINE__ + 1)
+        def self.#{old_method}(*args)
+          warn_deprecated("#{old_method}", "#{new_method}")
+          new_meth = method("#{new_method}")
+          if new_meth.arity == 0
+            __send__("#{new_method}")
+          else
+            __send__("#{new_method}", *args)
+          end
+        end
+      DEPRECATED
+    end
+
+  end
+end

data/lib/protobuf/descriptors/google/protobuf/compiler/plugin.pb.rb

@@ -3,49 +3,50 @@
 #
 require 'protobuf/message'
 
+
 ##
 # Imports
 #
 require 'google/protobuf/descriptor.pb'
 
 module Google
-
   module Protobuf
-  
     module Compiler
-    
+
       ##
       # Message Classes
       #
       class CodeGeneratorRequest < ::Protobuf::Message; end
       class CodeGeneratorResponse < ::Protobuf::Message
         class File < ::Protobuf::Message; end
+
       end
-      
+
+
+
       ##
       # Message Fields
       #
       class CodeGeneratorRequest
-        repeated ::Protobuf::Field::StringField, :file_to_generate, 1
-        optional ::Protobuf::Field::StringField, :parameter, 2
+        repeated :string, :file_to_generate, 1
+        optional :string, :parameter, 2
         repeated ::Google::Protobuf::FileDescriptorProto, :proto_file, 15
       end
-      
+
       class CodeGeneratorResponse
         class File
-          optional ::Protobuf::Field::StringField, :name, 1
-          optional ::Protobuf::Field::StringField, :insertion_point, 2
-          optional ::Protobuf::Field::StringField, :content, 15
+          optional :string, :name, 1
+          optional :string, :insertion_point, 2
+          optional :string, :content, 15
         end
-        
-        optional ::Protobuf::Field::StringField, :error, 1
+
+        optional :string, :error, 1
         repeated ::Google::Protobuf::Compiler::CodeGeneratorResponse::File, :file, 15
       end
-      
-      
+
     end
-    
+
   end
-  
+
 end