protobuf 3.3.6 → 3.4.0

data/lib/protobuf/code_generator.rb

@@ -6,7 +6,7 @@ module Protobuf
     CodeGeneratorFatalError = Class.new(RuntimeError)
 
     def self.fatal(message)
-      raise CodeGeneratorFatalError, message
+      fail CodeGeneratorFatalError, message
     end
 
     def self.print_tag_warning_suppress
@@ -18,24 +18,27 @@ module Protobuf
       STDERR.puts("[WARN] #{message}")
     end
 
+    private
+
+    attr_accessor :request
+
+    public
+
     def initialize(request_bytes)
-      @request = ::Google::Protobuf::Compiler::CodeGeneratorRequest.decode(request_bytes)
-      @generated_files = []
+      self.request = ::Google::Protobuf::Compiler::CodeGeneratorRequest.decode(request_bytes)
     end
 
     def generate_file(file_descriptor)
-      file_generator = ::Protobuf::Generators::FileGenerator.new(file_descriptor)
-      @generated_files << file_generator.generate_output_file
+      ::Protobuf::Generators::FileGenerator.new(file_descriptor).generate_output_file
     end
 
     def response_bytes
-      @request.proto_file.each do |file_descriptor|
+      generated_files = request.proto_file.map do |file_descriptor|
         generate_file(file_descriptor)
       end
 
-      return ::Google::Protobuf::Compiler::CodeGeneratorResponse.encode(:file => @generated_files)
+      ::Google::Protobuf::Compiler::CodeGeneratorResponse.encode(:file => generated_files)
     end
 
   end
 end
-

data/lib/protobuf/decoder.rb

@@ -24,14 +24,14 @@ module Protobuf
               when ::Protobuf::WireType::FIXED32 then
                 read_fixed32(stream)
               when ::Protobuf::WireType::START_GROUP then
-                raise NotImplementedError, 'Group is deprecated.'
+                fail NotImplementedError, 'Group is deprecated.'
               when ::Protobuf::WireType::END_GROUP then
-                raise NotImplementedError, 'Group is deprecated.'
+                fail NotImplementedError, 'Group is deprecated.'
               else
-                raise InvalidWireType, wire_type
+                fail InvalidWireType, wire_type
               end
 
-      return tag, bytes
+      [tag, bytes]
     end
 
     # Read 32-bit string value from +stream+.
@@ -71,4 +71,3 @@ module Protobuf
 
   end
 end
-

data/lib/protobuf/deprecation.rb

@@ -0,0 +1,20 @@
+require 'active_support/deprecation'
+
+module Protobuf
+  class Deprecation < ::ActiveSupport::Deprecation
+    def deprecate_methods(*args)
+      args.last.merge!(:deprecator => self) if args.last.is_a?(Hash)
+      super
+    end
+
+    def define_deprecated_methods(target_module, method_hash)
+      target_module.module_eval do
+        method_hash.each do |old_method, new_method|
+          alias_method old_method, new_method
+        end
+      end
+
+      deprecate_methods(target_module, method_hash)
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 ##
 # This file is auto-generated. DO NOT EDIT!
 #

data/lib/protobuf/descriptors/google/protobuf/descriptor.pb.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 ##
 # This file is auto-generated. DO NOT EDIT!
 #

data/lib/protobuf/encoder.rb

@@ -5,15 +5,21 @@ module Protobuf
       new(stream, message).encode
     end
 
+    private
+
+    attr_writer :message, :stream
+
+    public
+
     attr_reader :message, :stream
 
     def initialize(message, stream)
       unless message.respond_to?(:each_field_for_serialization)
-        raise ArgumentError, "Message instance must respond to :each_field_for_serialization"
+        fail ArgumentError, "Message instance must respond to :each_field_for_serialization"
       end
 
-      @message = message
-      @stream = stream
+      self.message = message
+      self.stream = stream
     end
 
     def encode
@@ -59,4 +65,3 @@ module Protobuf
 
   end
 end
-

data/lib/protobuf/enum.rb

@@ -1,38 +1,20 @@
 require 'delegate'
 require 'protobuf/optionable'
-require 'protobuf/deprecator'
 
 ##
 # Adding extension to Numeric until
 # we can get people to stop calling #value
 # on Enum instances.
 #
-class Numeric
-  unless method_defined?(:value)
-    def value
-      $stderr.puts <<-DEPRECATION
-[DEPRECATED] Enum#value is deprecated and will be removed in the next release.
-              Use Enum#to_i instead.
-DEPRECATION
-      self
-    end
-  end
-end
+::Protobuf.deprecator.define_deprecated_methods(Numeric, :value => :to_int)
 
 module Protobuf
   class Enum < SimpleDelegator
-
-    ##
-    # Deprecations
-    #
-
-    extend ::Protobuf::Deprecator
-
     # Public: Allows setting Options on the Enum class.
     include ::Protobuf::Optionable
 
     def self.aliases_allowed?
-      self.get_option(:allow_alias)
+      get_option(:allow_alias)
     end
 
     # Public: Get all integer tags defined by this enum.
@@ -51,7 +33,7 @@ module Protobuf
     # Returns an array of unique integers.
     #
     def self.all_tags
-      @all_tags ||= self.enums.map(&:to_i).uniq
+      @all_tags ||= enums.map(&:to_i).uniq
     end
 
     # Internal: DSL method to create a new Enum. The given name will
@@ -70,7 +52,7 @@ module Protobuf
     # Returns nothing.
     #
     def self.define(name, tag)
-      enum = self.new(self, name, tag)
+      enum = new(self, name, tag)
       @enums ||= []
       @enums << enum
       const_set(name, enum)
@@ -78,8 +60,8 @@ module Protobuf
 
     # Public: All defined enums.
     #
-    def self.enums
-      @enums
+    class << self
+      attr_reader :enums
     end
 
     # Public: Get an array of Enum objects with the given tag.
@@ -101,9 +83,9 @@ module Protobuf
     # Returns an array with zero or more Enum objects or nil.
     #
     def self.enums_for_tag(tag)
-      self.enums.select { |enum|
+      enums.select do |enum|
         enum.to_i == tag.to_i
-      }
+      end
     end
 
     # Public: Get the Enum associated with the given name.
@@ -125,7 +107,7 @@ module Protobuf
     # Returns the Enum object with the given name or nil.
     #
     def self.enum_for_name(name)
-      self.const_get(name)
+      const_get(name)
     rescue ::NameError
       nil
     end
@@ -138,7 +120,7 @@ module Protobuf
     #   Enums, the first enum defined will be returned.
     #
     def self.enum_for_tag(tag)
-      self.enums_for_tag(tag).first
+      enums_for_tag(tag).first
     end
 
     # Public: Get an Enum by a variety of type-checking mechanisms.
@@ -206,7 +188,7 @@ module Protobuf
     #   the first defined name will be returned.
     #
     def self.name_for_tag(tag)
-      self.enum_for_tag(tag).try(:name)
+      enum_for_tag(tag).try(:name)
     end
 
     # Public: Check if the given tag is defined by this Enum.
@@ -216,37 +198,43 @@ module Protobuf
     # Returns a boolean.
     #
     def self.valid_tag?(tag)
-      tag.respond_to?(:to_i) && self.all_tags.include?(tag.to_i)
+      tag.respond_to?(:to_i) && all_tags.include?(tag.to_i)
     end
 
     # Public: [DEPRECATED] Return a hash of Enum objects keyed
     # by their :name.
     #
     def self.values
-      self.warn_deprecated(:values, :enums)
-
-      @values ||= begin
-                    self.enums.inject({}) do |hash, enum|
-                      hash[enum.name] = enum
-                      hash
-                    end
-                  end
+      @values ||= enums.each_with_object({}) do |enum, hash|
+        hash[enum.name] = enum
+      end
     end
 
     ##
     # Class Deprecations
     #
+    class << self
+      ::Protobuf.deprecator.define_deprecated_methods(
+        self,
+        :enum_by_value => :enum_for_tag,
+        :name_by_value => :name_for_tag,
+        :get_name_by_tag => :name_for_tag,
+        :value_by_name => :enum_for_name,
+      )
 
-    deprecate_class_method :enum_by_value,   :enum_for_tag
-    deprecate_class_method :name_by_value,   :name_for_tag
-    deprecate_class_method :get_name_by_tag, :name_for_tag
-    deprecate_class_method :value_by_name,   :enum_for_name
-
+      ::Protobuf.deprecator.deprecate_methods(self, :values => :enums)
+    end
 
     ##
     # Attributes
     #
 
+    private
+
+    attr_writer :parent_class, :name, :tag
+
+    public
+
     attr_reader :parent_class, :name, :tag
 
     ##
@@ -254,10 +242,10 @@ module Protobuf
     #
 
     def initialize(parent_class, name, tag)
-      @parent_class = parent_class
-      @name = name
-      @tag = tag
-      super(@tag)
+      self.parent_class = parent_class
+      self.name = name
+      self.tag = tag
+      super(tag)
     end
 
     # Overriding the class so ActiveRecord/Arel visitor will visit the enum as a Fixnum
@@ -281,11 +269,11 @@ module Protobuf
     def to_s(format = :tag)
       case format
       when :tag then
-        self.to_i.to_s
+        to_i.to_s
       when :name then
         name.to_s
       else
-        self.to_i.to_s
+        to_i.to_s
       end
     end
 
@@ -305,10 +293,7 @@ module Protobuf
       end
     end
 
-    def value
-      parent_class.warn_deprecated(:value, :to_i)
-      to_i
-    end
+    ::Protobuf.deprecator.define_deprecated_methods(self, :value => :to_i)
 
     ##
     # Instance Aliases
@@ -316,4 +301,3 @@ module Protobuf
     alias_method :to_hash_value, :to_i
   end
 end
-

data/lib/protobuf/field.rb

@@ -38,7 +38,7 @@ module Protobuf
       :sfixed64 => ::Protobuf::Field::Sfixed64Field,
       :string   => ::Protobuf::Field::StringField,
       :bytes    => ::Protobuf::Field::BytesField,
-      :bool     => ::Protobuf::Field::BoolField
+      :bool     => ::Protobuf::Field::BoolField,
     }.freeze
 
     def self.build(message_class, rule, type, name, tag, options = {})
@@ -59,7 +59,7 @@ module Protobuf
       elsif type < ::Protobuf::Field::BaseField
         type
       else
-        raise ArgumentError, "Invalid field type #{type}"
+        fail ArgumentError, "Invalid field type #{type}"
       end
     end
 

data/lib/protobuf/field/base_field.rb

@@ -14,7 +14,7 @@ module Protobuf
       PACKED_TYPES = [
         ::Protobuf::WireType::VARINT,
         ::Protobuf::WireType::FIXED32,
-        ::Protobuf::WireType::FIXED64
+        ::Protobuf::WireType::FIXED64,
       ].freeze
 
       ##
@@ -51,7 +51,7 @@ module Protobuf
       # Public Instance Methods
       #
 
-      def acceptable?(value)
+      def acceptable?(_value)
         true
       end
 
@@ -59,8 +59,8 @@ module Protobuf
         value
       end
 
-      def decode(bytes)
-        raise NotImplementedError, "#{self.class.name}\#decode"
+      def decode(_bytes)
+        fail NotImplementedError, "#{self.class.name}##{__method__}"
       end
 
       def default
@@ -79,8 +79,8 @@ module Protobuf
         options.key?(:deprecated)
       end
 
-      def encode(value)
-        raise NotImplementedError, "#{self.class.name}\#encode"
+      def encode(_value)
+        fail NotImplementedError, "#{self.class.name}##{__method__}"
       end
 
       def extension?
@@ -119,7 +119,7 @@ module Protobuf
         rule == :required
       end
 
-      # FIXME need to cleanup (rename) this warthog of a method.
+      # FIXME: need to cleanup (rename) this warthog of a method.
       def set(message_instance, bytes)
         if packed?
           array = message_instance.__send__(getter)
@@ -148,21 +148,12 @@ module Protobuf
         @setter ||= "#{name}="
       end
 
-      # FIXME add packed, deprecated, extension options to to_s output
+      # FIXME: add packed, deprecated, extension options to to_s output
       def to_s
         "#{rule} #{type_class} #{name} = #{tag} #{default ? "[default=#{default.inspect}]" : ''}"
       end
 
-      def type
-        $stderr.puts("[DEPRECATED] #{self.class.name}#type usage is deprecated.\nPlease use #type_class instead.")
-        type_class
-      end
-
-      def warn_if_deprecated
-        if ::Protobuf.print_deprecation_warnings? && deprecated?
-          $stderr.puts("[WARNING] #{message_class.name}##{name} field usage is deprecated.")
-        end
-      end
+      ::Protobuf.deprecator.define_deprecated_methods(self, :type => :type_class)
 
       def wire_type
         ::Protobuf::WireType::VARINT
@@ -186,25 +177,27 @@ module Protobuf
 
       def define_array_getter
         field = self
+        method_name = field.getter
+
         message_class.class_eval do
-          define_method(field.getter) do
-            field.warn_if_deprecated
+          define_method(method_name) do
             @values[field.name] ||= ::Protobuf::Field::FieldArray.new(field)
           end
+          ::Protobuf.deprecator.deprecate_methods(method_name)
         end
       end
 
       def define_array_setter
         field = self
-        message_class.class_eval do
-          define_method(field.setter) do |val|
-            field.warn_if_deprecated
+        method_name = field.setter
 
+        message_class.class_eval do
+          define_method(method_name) do |val|
             if val.is_a?(Array)
               val = val.dup
               val.compact!
             else
-              raise TypeError, <<-TYPE_ERROR
+              fail TypeError, <<-TYPE_ERROR
                 Expected repeated value of type '#{field.type_class}'
                 Got '#{val.class}' for repeated protobuf field #{field.name}
               TYPE_ERROR
@@ -217,33 +210,37 @@ module Protobuf
               @values[field.name].replace(val)
             end
           end
+          ::Protobuf.deprecator.deprecate_methods(method_name)
         end
       end
 
       def define_getter
         field = self
+        method_name = field.getter
+
         message_class.class_eval do
-          define_method(field.getter) do
-            field.warn_if_deprecated
+          define_method(method_name) do
             @values.fetch(field.name, field.default_value)
           end
+          ::Protobuf.deprecator.deprecate_methods(method_name)
         end
       end
 
       def define_setter
         field = self
-        message_class.class_eval do
-          define_method(field.setter) do |val|
-            field.warn_if_deprecated
+        method_name = field.setter
 
+        message_class.class_eval do
+          define_method(method_name) do |val|
             if val.nil? || (val.respond_to?(:empty?) && val.empty?)
               @values.delete(field.name)
             elsif field.acceptable?(val)
               @values[field.name] = field.coerce!(val)
             else
-              raise TypeError, "Unacceptable value #{val} for field #{field.name} of type #{field.type_class}"
+              fail TypeError, "Unacceptable value #{val} for field #{field.name} of type #{field.type_class}"
             end
           end
+          ::Protobuf.deprecator.deprecate_methods(method_name)
         end
       end
 
@@ -257,11 +254,10 @@ module Protobuf
 
       def validate_packed_field
         if packed? && ! ::Protobuf::Field::BaseField::PACKED_TYPES.include?(wire_type)
-          raise "Can't use packed encoding for '#{type_class}' type"
+          fail "Can't use packed encoding for '#{type_class}' type"
         end
       end
 
     end
   end
 end
-