protobuf 3.3.6 → 3.4.0

data/lib/protobuf/generators/message_generator.rb

@@ -23,7 +23,7 @@ module Protobuf
 
       def compile_declaration
         run_once(:compile_declaration) do
-          if is_printable?
+          if printable?
             print_class(descriptor.name, :message) do
               group = GroupGenerator.new(current_indent)
               group.add_enums(descriptor.enum_type, :namespace => type_namespace)
@@ -38,7 +38,7 @@ module Protobuf
 
       def compile_message
         run_once(:compile_message) do
-          if is_printable?
+          if printable?
             print_class(descriptor.name, nil) do
               group = GroupGenerator.new(current_indent)
               group.add_messages(descriptor.nested_type, :extension_fields => @extension_fields, :namespace => type_namespace)
@@ -52,7 +52,7 @@ module Protobuf
 
               group.add_extension_fields(message_extension_fields)
 
-              group.order = [ :message, :field, :extension_range, :extension_field ]
+              group.order = [:message, :field, :extension_range, :extension_field]
               print group.to_s
             end
           end
@@ -61,31 +61,31 @@ module Protobuf
 
       private
 
-      def has_extensions?
-        ! message_extension_fields.empty?
+      def extensions?
+        !message_extension_fields.empty?
       end
 
-      def has_fields?
+      def fields?
         descriptor.field.count > 0
       end
 
-      def has_nested_enums?
+      def nested_enums?
         descriptor.enum_type.count > 0
       end
 
-      def has_nested_messages?
+      def nested_messages?
         descriptor.nested_type.count > 0
       end
 
-      def has_nested_types?
-        has_nested_enums? || has_nested_messages?
+      def nested_types?
+        nested_enums? || nested_messages?
       end
 
-      def is_printable?
+      def printable?
         if @only_declarations
-          has_nested_types?
+          nested_types?
         else
-          has_fields? || has_nested_messages? || has_extensions?
+          fields? || nested_messages? || extensions?
         end
       end
 
@@ -96,4 +96,3 @@ module Protobuf
     end
   end
 end
-

data/lib/protobuf/generators/printable.rb

@@ -11,9 +11,13 @@ module Protobuf
       #
       def init_printer(indent_level)
         @io = ::StringIO.new
-        @_indent_level = indent_level.to_i || 0
+        self.current_indent = indent_level.to_i
       end
 
+      protected
+
+      attr_accessor :current_indent
+
       private
 
       # Print a one-line comment.
@@ -22,10 +26,6 @@ module Protobuf
         puts "# #{message}"
       end
 
-      def current_indent
-        @_indent_level
-      end
-
       # Print a "header" comment.
       #
       #   header("Lorem ipsum dolor")
@@ -43,7 +43,7 @@ module Protobuf
       # (after the block is finished).
       #
       def indent
-        @_indent_level += 1
+        self.current_indent += 1
         yield
         outdent
       end
@@ -68,7 +68,7 @@ module Protobuf
       # Decrease the indent level. Cannot be negative.
       #
       def outdent
-        @_indent_level -= 1 unless @_indent_level == 0
+        self.current_indent -= 1 unless current_indent.zero?
       end
 
       # Return the parent class for a given type.
@@ -84,7 +84,7 @@ module Protobuf
         when :service then
           PARENT_CLASS_SERVICE
         else
-          raise "Unknown parent class type #{type}: #{caller[0..5].join("\n")}"
+          fail "Unknown parent class type #{type}: #{caller[0..5].join("\n")}"
         end
       end
 
@@ -136,7 +136,7 @@ module Protobuf
       #
       def puts(message = nil)
         if message
-          @io.puts(("  " * @_indent_level) + message)
+          @io.puts(("  " * current_indent) + message)
         else
           @io.puts
         end
@@ -158,4 +158,3 @@ module Protobuf
     end
   end
 end
-

data/lib/protobuf/generators/service_generator.rb

@@ -18,10 +18,9 @@ module Protobuf
         name = method_descriptor.name
         request_klass = modulize(method_descriptor.input_type)
         response_klass = modulize(method_descriptor.output_type)
-        return "rpc :#{name.underscore}, #{request_klass}, #{response_klass}"
+        "rpc :#{name.underscore}, #{request_klass}, #{response_klass}"
       end
 
     end
   end
 end
-

data/lib/protobuf/lifecycle.rb

@@ -1,46 +1,33 @@
 module Protobuf
   class Lifecycle
-    include ::Protobuf::Logging
-
-    def self.register(event_name, &blk)
-      raise "Lifecycle register must have a block" unless block_given?
-      event_name = normalized_event_name(event_name)
+    class << self
+      def register(event_name, &blk)
+        fail "Lifecycle register must have a block" unless block_given?
+        event_name = normalized_event_name(event_name)
 
-      if ::Protobuf.print_deprecation_warnings?
-        $stderr.puts <<-ERROR
-            [DEPRECATED] ::Protobuf::Lifecycle has been deprecated and will be removed in a future version.
-                         Use ::ActiveSupport::Notifications.subscribe('#{event_name}')
-        ERROR
+        ::ActiveSupport::Notifications.subscribe(event_name) do |_name, _start, _finish, _id, args|
+          blk.call(*args)
+        end
       end
+      alias_method :on, :register
 
-      ::ActiveSupport::Notifications.subscribe(event_name) do |name, start, finish, id, args|
-        blk.call(*args)
-      end
-    end
+      def trigger(event_name, *args)
+        event_name = normalized_event_name(event_name)
 
-    def self.trigger( event_name, *args )
-      if ::Protobuf.print_deprecation_warnings?
-        $stderr.puts <<-ERROR
-            [DEPRECATED] ::Protobuf::Lifecycle has been deprecated and will be removed in a future version.
-                         Use ::ActiveSupport::Notifications.instrument(...)
-        ERROR
+        ::ActiveSupport::Notifications.instrument(event_name, args)
       end
 
-      event_name = normalized_event_name( event_name )
+      replacement = ::ActiveSupport::Notifications
 
-      ::ActiveSupport::Notifications.instrument(event_name, args)
-    end
+      ::Protobuf.deprecator.deprecate_methods(
+        self,
+        :register => "#{replacement}.#{replacement.method(:subscribe).name}".to_sym,
+        :trigger => "#{replacement}.#{replacement.method(:instrument).name}".to_sym,
+      )
 
-    def self.normalized_event_name(event_name)
-      return "#{event_name}".downcase
-    end
-
-    class << self
-      attr_accessor :lifecycle_events
-
-      alias_method :on, :register
+      def normalized_event_name(event_name)
+        event_name.to_s.downcase
+      end
     end
-
-    @lifecycle_events ||= {}
   end
 end

data/lib/protobuf/logging.rb

@@ -2,9 +2,7 @@ require 'logger'
 
 module Protobuf
   module Logging
-    def self.initialize_logger(log_target=$stdout, log_level=::Logger::INFO)
-      @counter ||= 0
-      @counter = @counter + 1
+    def self.initialize_logger(log_target = $stdout, log_level = ::Logger::INFO)
       @logger = Logger.new(log_target)
       @logger.level = log_level
       @logger
@@ -14,8 +12,8 @@ module Protobuf
       defined?(@logger) ? @logger : initialize_logger
     end
 
-    def self.logger=(new_logger)
-      @logger = new_logger
+    class << self
+      attr_writer :logger
     end
 
     def logger
@@ -29,7 +27,7 @@ module Protobuf
     end
 
     def log_signature
-      @_log_signature ||= "[#{self.class == Class ? self.name : self.class.name}]"
+      @_log_signature ||= "[#{self.class == Class ? name : self.class.name}]"
     end
 
     def sign_message(message)

data/lib/protobuf/message.rb

@@ -74,23 +74,28 @@ module Protobuf
         value = @values[field.getter]
 
         if value.nil?
-          raise ::Protobuf::SerializationError, "Required field #{self.class.name}##{field.name} does not have a value."
+          fail ::Protobuf::SerializationError, "Required field #{self.class.name}##{field.name} does not have a value."
         else
           yield(field, value)
         end
       end
     end
 
-    def has_field?(name)
-      @values.has_key?(name)
+    def field?(name)
+      @values.key?(name)
     end
+    ::Protobuf.deprecator.define_deprecated_methods(self, :has_field? => :field?)
 
     def inspect
-      to_hash.inspect
+      attrs = self.class.fields.map do |field|
+        [field.name, send(field.name).inspect].join('=')
+      end.join(' ')
+
+      "#<#{self.class} #{attrs}>"
     end
 
     def respond_to_has?(key)
-      respond_to?(key) && has_field?(key)
+      respond_to?(key) && field?(key)
     end
 
     def respond_to_has_and_present?(key)
@@ -100,7 +105,7 @@ module Protobuf
 
     # Return a hash-representation of the given fields for this message type.
     def to_hash
-      result = Hash.new
+      result = {}
 
       @values.keys.each do |field_name|
         value = __send__(field_name)
@@ -108,7 +113,7 @@ module Protobuf
         result.merge!(field_name => hashed_value)
       end
 
-      return result
+      result
     end
 
     def to_json(options = {})
@@ -119,26 +124,26 @@ module Protobuf
       self
     end
 
-    def ==(obj)
-      return false unless obj.is_a?(self.class)
+    def ==(other)
+      return false unless other.is_a?(self.class)
       each_field do |field, value|
-        return false unless value == obj.__send__(field.name)
+        return false unless value == other.__send__(field.name)
       end
       true
     end
 
     def [](name)
-      if field = self.class.get_field(name, true)
+      if (field = self.class.get_field(name, true))
         __send__(field.getter)
       end
     end
 
     def []=(name, value)
-      if field = self.class.get_field(name, true)
+      if (field = self.class.get_field(name, true))
         __send__(field.setter, value) unless value.nil?
       else
         unless ::Protobuf.ignore_unknown_fields?
-          raise ::Protobuf::FieldNotDefinedError, name
+          fail ::Protobuf::FieldNotDefinedError, name
         end
       end
     end
@@ -161,20 +166,21 @@ module Protobuf
     ##
     # Private Instance Methods
     #
+
     private
 
     def copy_to(object, method)
-      duplicate = proc { |obj|
+      duplicate = proc do |obj|
         case obj
         when Message, String then obj.__send__(method)
         else                      obj
         end
-      }
+      end
 
       object.__send__(:initialize)
       @values.each do |name, value|
         if value.is_a?(::Protobuf::Field::FieldArray)
-          object.__send__(name).replace(value.map {|v| duplicate.call(v)})
+          object.__send__(name).replace(value.map { |v| duplicate.call(v) })
         else
           object.__send__("#{name}=", duplicate.call(value))
         end

data/lib/protobuf/message/fields.rb

@@ -1,15 +1,15 @@
-require 'protobuf/deprecator'
-
 module Protobuf
   class Message
     module Fields
 
       def self.extended(other)
-        other.extend(::Protobuf::Deprecator)
-        other.deprecate_class_method(:get_ext_field_by_name, :get_extension_field)
-        other.deprecate_class_method(:get_ext_field_by_tag, :get_extension_field)
-        other.deprecate_class_method(:get_field_by_name, :get_field)
-        other.deprecate_class_method(:get_field_by_tag, :get_field)
+        ::Protobuf.deprecator.define_deprecated_methods(
+          other.singleton_class,
+          :get_ext_field_by_name => :get_extension_field,
+          :get_ext_field_by_tag => :get_extension_field,
+          :get_field_by_name => :get_field,
+          :get_field_by_tag => :get_field,
+        )
       end
 
       ##
@@ -45,7 +45,7 @@ module Protobuf
       #
 
       def all_fields
-        @all_fields ||= field_store.values.uniq
+        @all_fields ||= field_store.values.uniq.sort_by(&:tag)
       end
 
       def extension_fields
@@ -82,7 +82,7 @@ module Protobuf
         name_or_tag = name_or_tag.to_sym if name_or_tag.respond_to?(:to_sym)
         field = field_store[name_or_tag]
 
-        if field && (allow_extension || ! field.extension?)
+        if field && (allow_extension || !field.extension?)
           field
         else
           nil
@@ -97,26 +97,23 @@ module Protobuf
         field_store[field_name] = field
         field_store[tag] = field
 
-        class_eval(<<-RAW_GETTER, __FILE__, __LINE__ + 1)
-          define_method("#{field_name}!") do
-            @values[:#{field_name}]
-          end
-        RAW_GETTER
+        define_method("#{field_name}!") do
+          @values[field_name]
+        end
       end
 
       def raise_if_tag_collision(tag, field_name)
         if get_field(tag, true)
-          raise TagCollisionError, %!Field number #{tag} has already been used in "#{name}" by field "#{field_name}".!
+          fail TagCollisionError, %(Field number #{tag} has already been used in "#{name}" by field "#{field_name}".)
         end
       end
 
       def raise_if_name_collision(field_name)
         if get_field(field_name, true)
-          raise DuplicateFieldNameError, %!Field name #{field_name} has already been used in "#{name}".!
+          fail DuplicateFieldNameError, %(Field name #{field_name} has already been used in "#{name}".)
         end
       end
 
     end
   end
 end
-

data/lib/protobuf/message/serialization.rb

@@ -8,12 +8,12 @@ module Protobuf
 
       module ClassMethods
         def decode(bytes)
-          self.new.decode(bytes)
+          new.decode(bytes)
         end
 
         # Create a new object with the given values and return the encoded bytes.
         def encode(fields = {})
-          self.new(fields).encode
+          new(fields).encode
         end
       end
 
@@ -44,8 +44,10 @@ module Protobuf
       # Encode this message
       #
       def encode
-        stream = ::StringIO.new.set_encoding(::Protobuf::Field::BytesField::BYTES_ENCODING)
-        encode_to(stream).string
+        stream = ::StringIO.new
+        stream.set_encoding(::Protobuf::Field::BytesField::BYTES_ENCODING)
+        encode_to(stream)
+        stream.string
       end
 
       # Encode this message to the given stream.
@@ -81,4 +83,3 @@ module Protobuf
     end
   end
 end
-