protobuf 2.8.13 → 3.0.0.rc1

data/lib/protobuf/field/double_field.rb

@@ -3,9 +3,10 @@ require 'protobuf/field/float_field'
 module Protobuf
   module Field
     class DoubleField < FloatField
-      def wire_type
-        WireType::FIXED64
-      end
+
+      ##
+      # Public Instance Methods
+      #
 
       def decode(bytes)
         bytes.unpack('E').first
@@ -14,6 +15,12 @@ module Protobuf
       def encode(value)
         [value].pack('E')
       end
+
+      def wire_type
+        WireType::FIXED64
+      end
+
     end
   end
 end
+

data/lib/protobuf/field/enum_field.rb

@@ -3,16 +3,13 @@ require 'protobuf/field/varint_field'
 module Protobuf
   module Field
     class EnumField < VarintField
+
+      ##
+      # Public Instance Methods
+      #
+
       def acceptable?(val)
-        case val
-        when Symbol then
-          raise TypeError, "Enum #{val} is not known for type #{@type}" unless @type.const_defined?(val)
-        when EnumValue then
-          raise TypeError, "Enum #{val} is not owned by #{@type}" if val.parent_class != @type
-        else
-          raise TypeError, "Tag #{val} is not valid for Enum #{@type}" unless @type.valid_tag?(val)
-        end
-        true
+        ! type_class.fetch(val).nil?
       end
 
       def encode(value)
@@ -25,23 +22,19 @@ module Protobuf
 
       private
 
-      def typed_default_value
-        if @default.is_a?(Symbol)
-          @type.const_get(@default)
-        else
-          self.class.default
-        end
-      end
+      ##
+      # Private Instance Methods
+      #
 
       def define_setter
         field = self
-        @message_class.class_eval do
+        message_class.class_eval do
           define_method("#{field.name}=") do |value|
             orig_value = value
             if value.nil?
               @values.delete(field.name)
             else
-              value = field.type.fetch(value)
+              value = field.type_class.fetch(value)
               raise TypeError, "Invalid Enum value: #{orig_value.inspect} for #{field.name}" unless value
 
               @values[field.name] = value
@@ -49,6 +42,16 @@ module Protobuf
           end
         end
       end
+
+      def typed_default_value
+        if default.is_a?(Symbol)
+          type_class.const_get(default)
+        else
+          self.class.default
+        end
+      end
+
     end
   end
 end
+

data/lib/protobuf/field/field_array.rb

@@ -1,9 +1,17 @@
 module Protobuf
   module Field
     class FieldArray < Array
+
+      ##
+      # Attributes
+      #
+
+      attr_reader :field
+
       ##
       # Constructor
       #
+
       def initialize(field)
         @field = field
       end
@@ -11,6 +19,7 @@ module Protobuf
       ##
       # Public Instance Methods
       #
+
       def []=(nth, val)
         super(nth, normalize(val)) unless val.nil?
       end
@@ -23,13 +32,9 @@ module Protobuf
         super(normalize(val)) unless val.nil?
       end
 
-      def unshift(val)
-        super(normalize(val)) unless val.nil?
-      end
-
       def replace(val)
         raise_type_error(val) unless val.is_a?(Array)
-        val = val.map! { |v| normalize(v) }
+        val.map! { |v| normalize(v) }
         super(val)
       end
 
@@ -42,7 +47,11 @@ module Protobuf
       end
 
       def to_s
-        "[#{@field.name}]"
+        "[#{field.name}]"
+      end
+
+      def unshift(val)
+        super(normalize(val)) unless val.nil?
       end
 
       private
@@ -50,27 +59,28 @@ module Protobuf
       ##
       # Private Instance Methods
       #
+
       def normalize(value)
         value = value.to_proto if value.respond_to?(:to_proto)
-        raise TypeError, "Unacceptable value #{value} for field #{@field.name} of type #{@field.type}" unless @field.acceptable?(value)
+        raise TypeError, "Unacceptable value #{value} for field #{field.name} of type #{field.type_class}" unless field.acceptable?(value)
 
-        if @field.is_a?(::Protobuf::Field::EnumField)
-          @field.type.fetch(value)
-        elsif @field.is_a?(::Protobuf::Field::MessageField) && value.respond_to?(:to_hash)
-          @field.type.new(value.to_hash)
+        if field.is_a?(::Protobuf::Field::EnumField)
+          field.type_class.fetch(value)
+        elsif field.is_a?(::Protobuf::Field::MessageField) && value.respond_to?(:to_hash)
+          field.type_class.new(value.to_hash)
         else
           value
         end
       end
 
       def raise_type_error(val)
-        error_text = <<-TYPE_ERROR
-          Expected repeated value of type '#{@field.type}'
-          Got '#{val.class}' for repeated protobuf field #{@field.name}
+        raise TypeError, <<-TYPE_ERROR
+          Expected repeated value of type '#{field.type_class}'
+          Got '#{val.class}' for repeated protobuf field #{field.name}
         TYPE_ERROR
-
-        raise TypeError, error_text
       end
+
     end
   end
 end
+

data/lib/protobuf/field/fixed32_field.rb

@@ -1,11 +1,12 @@
-require 'protobuf/field/uint32_field.rb'
+require 'protobuf/field/uint32_field'
 
 module Protobuf
   module Field
     class Fixed32Field < Uint32Field
-      def wire_type
-       ::Protobuf::WireType::FIXED32
-      end
+
+      ##
+      # Public Instance Methods
+      #
 
       def decode(bytes)
         bytes.unpack('V').first
@@ -14,6 +15,11 @@ module Protobuf
       def encode(value)
         [value].pack('V')
       end
+
+      def wire_type
+       ::Protobuf::WireType::FIXED32
+      end
+
     end
   end
 end

data/lib/protobuf/field/fixed64_field.rb

@@ -3,9 +3,10 @@ require 'protobuf/field/uint64_field'
 module Protobuf
   module Field
     class Fixed64Field < Uint64Field
-      def wire_type
-        ::Protobuf::WireType::FIXED64
-      end
+
+      ##
+      # Public Instance Methods
+      #
 
       def decode(bytes)
         # we don't use 'Q' for pack/unpack. 'Q' is machine-dependent.
@@ -17,6 +18,12 @@ module Protobuf
         # we don't use 'Q' for pack/unpack. 'Q' is machine-dependent.
         [value & 0xffff_ffff, value >> 32].pack('VV')
       end
+
+      def wire_type
+        ::Protobuf::WireType::FIXED64
+      end
+
     end
   end
 end
+

data/lib/protobuf/field/float_field.rb

@@ -3,10 +3,21 @@ require 'protobuf/field/base_field'
 module Protobuf
   module Field
     class FloatField < BaseField
-      def self.default; 0.0; end
 
-      def wire_type
-        WireType::FIXED32
+      ##
+      # Class Methods
+      #
+
+      def self.default
+        0.0
+      end
+
+      ##
+      # Public Instance Methods
+      #
+
+      def acceptable?(val)
+        val.respond_to?(:to_f)
       end
 
       def decode(bytes)
@@ -17,9 +28,11 @@ module Protobuf
         [value].pack('e')
       end
 
-      def acceptable?(val)
-        val.respond_to?(:to_f)
+      def wire_type
+        WireType::FIXED32
       end
+
     end
   end
 end
+

data/lib/protobuf/field/int32_field.rb

@@ -3,10 +3,20 @@ require 'protobuf/field/integer_field'
 module Protobuf
   module Field
     class Int32Field < IntegerField
-      def self.max; INT32_MAX; end
-      def self.min; INT32_MIN; end
-      def max; INT32_MAX; end
-      def min; INT32_MIN; end
+
+      ##
+      # Class Methods
+      #
+
+      def self.max
+        INT32_MAX
+      end
+
+      def self.min
+        INT32_MIN
+      end
+
     end
   end
 end
+

data/lib/protobuf/field/int64_field.rb

@@ -3,10 +3,20 @@ require 'protobuf/field/integer_field'
 module Protobuf
   module Field
     class Int64Field < IntegerField
-      def self.max; INT64_MAX; end
-      def self.min; INT64_MIN; end
-      def max; INT64_MAX; end
-      def min; INT64_MIN; end
+
+      ##
+      # Class Methods
+      #
+
+      def self.max
+        INT64_MAX
+      end
+
+      def self.min
+        INT64_MIN
+      end
+
     end
   end
 end
+

data/lib/protobuf/field/integer_field.rb

@@ -4,16 +4,21 @@ module Protobuf
   module Field
     class IntegerField < VarintField
 
-      def encode(value)
-        # original Google's library uses 64bits integer for negative value
-        VarintField.encode(value & 0xffff_ffff_ffff_ffff)
-      end
+      ##
+      # Public Instance Methods
+      #
 
       def decode(value)
         value -= 0x1_0000_0000_0000_0000 if (value & 0x8000_0000_0000_0000).nonzero?
         value
       end
 
+      def encode(value)
+        # original Google's library uses 64bits integer for negative value
+        ::Protobuf::Field::VarintField.encode(value & 0xffff_ffff_ffff_ffff)
+      end
+
     end
   end
 end
+

data/lib/protobuf/field/message_field.rb

@@ -3,18 +3,21 @@ require 'protobuf/field/base_field'
 module Protobuf
   module Field
     class MessageField < BaseField
-      RAISE_TYPE = lambda { |field, val| raise TypeError, "Expected value of type '#{field.type}' for field #{field.name}, but got '#{val.class}'" }
 
       ##
       # Public Instance Methods
       #
+
       def acceptable?(val)
-        RAISE_TYPE.call(self, val) unless val.instance_of?(type) || val.respond_to?(:to_hash)
+        unless val.instance_of?(type_class) || val.respond_to?(:to_hash)
+          raise TypeError, "Expected value of type '#{type_class}' for field #{name}, but got '#{val.class}'"
+        end
+
         true
       end
 
       def decode(bytes)
-        type.decode(bytes)
+        type_class.decode(bytes)
       end
 
       def encode(value)
@@ -33,25 +36,31 @@ module Protobuf
 
       private
 
+      ##
+      # Private Instance Methods
+      #
+
       def define_setter
         field = self
-        @message_class.class_eval do
+        message_class.class_eval do
           define_method("#{field.name}=") do |val|
             case
             when val.nil? then
               @values.delete(field.name)
-            when val.is_a?(field.type) then
+            when val.is_a?(field.type_class) then
               @values[field.name] = val
             when val.respond_to?(:to_proto) then
               @values[field.name] = val.to_proto
             when val.respond_to?(:to_hash) then
-              @values[field.name] = field.type.new(val.to_hash)
+              @values[field.name] = field.type_class.new(val.to_hash)
             else
-              RAISE_TYPE.call(field, val)
+              raise TypeError, "Expected value of type '#{field.type_class}' for field #{field.name}, but got '#{val.class}'"
             end
           end
         end
       end
+
     end
   end
 end
+

data/lib/protobuf/field/sfixed32_field.rb

@@ -3,9 +3,10 @@ require 'protobuf/field/int32_field'
 module Protobuf
   module Field
     class Sfixed32Field < Int32Field
-      def wire_type
-        ::Protobuf::WireType::FIXED32
-      end
+
+      ##
+      # Public Instance Methods
+      #
 
       def decode(bytes)
         value  = bytes.unpack('V').first
@@ -16,6 +17,12 @@ module Protobuf
       def encode(value)
         [value].pack('V')
       end
+
+      def wire_type
+        ::Protobuf::WireType::FIXED32
+      end
+
     end
   end
 end
+

data/lib/protobuf/field/sfixed64_field.rb

@@ -3,22 +3,27 @@ require 'protobuf/field/int64_field'
 module Protobuf
   module Field
     class Sfixed64Field < Int64Field
-      def wire_type
-        ::Protobuf::WireType::FIXED64
-      end
+
+      ##
+      # Public Instance Methods
+      #
 
       def decode(bytes)
-        # we don't use 'Q' for pack/unpack. 'Q' is machine-dependent.
-        values = bytes.unpack('VV')
+        values = bytes.unpack('VV') # 'Q' is machine-dependent, don't use
         value  = values[0] + (values[1] << 32)
         value -= 0x1_0000_0000_0000_0000 if (value & 0x8000_0000_0000_0000).nonzero?
         value
       end
 
       def encode(value)
-        # we don't use 'Q' for pack/unpack. 'Q' is machine-dependent.
-        [value & 0xffff_ffff, value >> 32].pack('VV')
+        [value & 0xffff_ffff, value >> 32].pack('VV') # 'Q' is machine-dependent, don't use
+      end
+
+      def wire_type
+        ::Protobuf::WireType::FIXED64
       end
+
     end
   end
 end
+

data/lib/protobuf/field/signed_integer_field.rb

@@ -3,6 +3,11 @@ require 'protobuf/field/varint_field'
 module Protobuf
   module Field
     class SignedIntegerField < VarintField
+
+      ##
+      # Public Instance Methods
+      #
+
       def decode(value)
         if (value & 1).zero?
           value >> 1   # positive value
@@ -18,6 +23,8 @@ module Protobuf
           VarintField.encode(~(value << 1))
         end
       end
+
     end
   end
 end
+

data/lib/protobuf/field/sint32_field.rb

@@ -3,10 +3,20 @@ require 'protobuf/field/signed_integer_field'
 module Protobuf
   module Field
     class Sint32Field < SignedIntegerField
-      def self.max; INT32_MAX; end
-      def self.min; INT32_MIN; end
-      def max; INT32_MAX; end
-      def min; INT32_MIN; end
+
+      ##
+      # Class Methods
+      #
+
+      def self.max
+        INT32_MAX
+      end
+
+      def self.min
+        INT32_MIN
+      end
+
     end
   end
 end
+

data/lib/protobuf/field/sint64_field.rb

@@ -3,10 +3,20 @@ require 'protobuf/field/signed_integer_field'
 module Protobuf
   module Field
     class Sint64Field < SignedIntegerField
-      def self.max; INT64_MAX; end
-      def self.min; INT64_MIN; end
-      def max; INT64_MAX; end
-      def min; INT64_MIN; end
+
+      ##
+      # Class Methods
+      #
+
+      def self.max
+        INT64_MAX
+      end
+
+      def self.min
+        INT64_MIN
+      end
+
     end
   end
 end
+

data/lib/protobuf/field/string_field.rb

@@ -3,15 +3,23 @@ require 'protobuf/field/bytes_field'
 module Protobuf
   module Field
     class StringField < BytesField
+
+      ##
+      # Constants
+      #
+
       ENCODING = 'UTF-8'.freeze
 
+      ##
+      # Public Instance Methods
+      #
+
       def decode(bytes)
         bytes_to_decode = bytes.dup
         bytes_to_decode.force_encoding(::Protobuf::Field::StringField::ENCODING)
         bytes_to_decode
       end
 
-      # TODO: make replace character configurable?
       def encode(value)
         value_to_encode = value.dup
         value_to_encode.encode!(::Protobuf::Field::StringField::ENCODING, :invalid => :replace, :undef => :replace, :replace => "")
@@ -20,6 +28,8 @@ module Protobuf
         string_size = ::Protobuf::Field::VarintField.encode(value_to_encode.size)
         string_size << value_to_encode
       end
+
     end
   end
 end
+

data/lib/protobuf/field/uint32_field.rb

@@ -3,10 +3,20 @@ require 'protobuf/field/varint_field'
 module Protobuf
   module Field
     class Uint32Field < VarintField
-      def self.max; UINT32_MAX; end
-      def self.min; 0; end
-      def max; UINT32_MAX; end
-      def min; 0; end
+
+      ##
+      # Class Methods
+      #
+
+      def self.max
+        UINT32_MAX
+      end
+
+      def self.min
+        0
+      end
+
     end
   end
 end
+

data/lib/protobuf/field/uint64_field.rb

@@ -3,10 +3,20 @@ require 'protobuf/field/varint_field'
 module Protobuf
   module Field
     class Uint64Field < VarintField
-      def self.max; UINT64_MAX; end
-      def self.min; 0; end
-      def max; UINT64_MAX; end
-      def min; 0; end
+
+      ##
+      # Class Methods
+      #
+
+      def self.max
+        UINT64_MAX
+      end
+
+      def self.min
+        0
+      end
+
     end
   end
 end
+

data/lib/protobuf/field/varint_field.rb

@@ -3,6 +3,11 @@ require 'protobuf/field/base_field'
 module Protobuf
   module Field
     class VarintField < BaseField
+
+      ##
+      # Constants
+      #
+
       INT32_MAX  =  2**31 - 1
       INT32_MIN  = -2**31
       INT64_MAX  =  2**63 - 1
@@ -13,18 +18,11 @@ module Protobuf
       ##
       # Class Methods
       #
+
       def self.default
         0
       end
 
-      def self.decode(bytes)
-        value = 0
-        bytes.each_with_index do |byte, index|
-          value |= byte << (7 * index)
-        end
-        value
-      end
-
       def self.encode(value)
         bytes = []
         until value < 128
@@ -37,8 +35,11 @@ module Protobuf
       ##
       # Public Instance Methods
       #
+
       def acceptable?(val)
-        (val > min || val < max) rescue false
+        (val > self.class.min || val < self.class.max)
+      rescue
+        false
       end
 
       def decode(value)
@@ -64,3 +65,4 @@ module Protobuf
     end
   end
 end
+