protobuf 1.4.2 → 2.0.0.rc1

data/lib/protobuf/field/base_field.rb

@@ -0,0 +1,210 @@
+require 'protobuf/common/wire_type'
+require 'protobuf/field/field_array'
+
+module Protobuf
+  module Field
+    class BaseField
+      ##
+      # Attributes
+      #
+      attr_reader :message_class, :rule, :type, :name, :tag, :default, :default_value, :setter_method_name, :getter_method_name
+      
+      ##
+      # Class Methods
+      #
+      def self.default
+        nil
+      end
+
+      ##
+      # Constructor
+      #
+      def initialize(message_class, rule, type, name, tag, options)
+        @message_class, @rule, @type, @name, @tag = \
+          message_class, rule, type, name, tag
+
+        @getter_method_name = name
+        @setter_method_name = "#{name}=".to_sym
+        @default   = options.delete(:default)
+        @extension = options.delete(:extension)
+        @packed    = repeated? && options.delete(:packed)
+        unless options.empty?
+          warn "WARNING: Invalid options: #{options.inspect} (in #{@message_class.name.split('::').last}.#{@name})"
+        end
+
+        if packed? && ! [WireType::VARINT, WireType::FIXED32, WireType::FIXED64].include?(wire_type)
+          raise "Can't use packed encoding for `#{@type}' type"
+        end
+
+        @default_value = \
+          case @rule
+          when :repeated then
+            FieldArray.new(self).freeze
+          when :required then
+            nil
+          when :optional then
+            typed_default_value
+          end
+
+        define_accessor
+      end
+
+      ##
+      # Public Instance Methods
+      #
+      def acceptable?(value)
+        true
+      end
+
+      def enum?
+        return @_enum unless @_enum.nil?
+        @_enum = (self.class < ::Protobuf::Field::EnumField)
+      end
+
+      def message?
+        return @_message unless @_message.nil?
+        @_message = (self.class < ::Protobuf::Field::MessageField)
+      end
+
+      def initialized?(message_instance)
+        value = message_instance.__send__(getter_method_name)
+        case @rule
+        when :required then
+          ! value.nil? && (! kind_of?(MessageField) || value.initialized?)
+        when :repeated then
+          value.all? {|msg| ! kind_of?(MessageField) || msg.initialized? }
+        when :optional then
+          value.nil? || ! kind_of?(MessageField) || value.initialized?
+        end
+      end
+
+      # Decode +bytes+ and pass to +message_instance+.
+      def set(message_instance, bytes)
+        if packed?
+          array = message_instance.__send__(getter_method_name)
+          method = \
+            case wire_type
+            when WireType::FIXED32 then :read_fixed32
+            when WireType::FIXED64 then :read_fixed64
+            when WireType::VARINT  then :read_varint
+            end
+          stream = StringIO.new(bytes)
+          until stream.eof?
+            array << decode(Decoder.__send__(method, stream))
+          end
+        else
+          value = decode(bytes)
+          if repeated?
+            message_instance.__send__(getter_method_name) << value
+          else
+            message_instance.__send__(setter_method_name, value)
+          end
+        end
+      end
+
+      # Decode +bytes+ and return a field value.
+      def decode(bytes)
+        raise NotImplementedError, "#{self.class.name}\#decode"
+      end
+
+      # Encode +value+ and return a byte string.
+      def encode(value)
+        raise NotImplementedError, "#{self.class.name}\#encode"
+      end
+
+      def extension?
+        !!@extension
+      end
+
+      # Is this a repeated field?
+      def repeated?
+        return @_repeated unless @_repeated.nil?
+        @_repeated = (@rule == :repeated)
+      end
+
+      # Is this a required field?
+      def required?
+        return @_required unless @_required.nil?
+        @_required = (@rule == :required)
+      end
+
+      # Is this a optional field?
+      def optional?
+        return @_optional unless @_optional.nil?
+        @_optional = (@rule == :optional)
+      end
+
+      # Is this a packed repeated field?
+      def packed?
+        !!@packed
+      end
+
+      # Upper limit for this field.
+      def max
+        self.class.max
+      end
+
+      # Lower limit for this field.
+      def min
+        self.class.min
+      end
+
+      def to_s
+        "#{@rule} #{@type} #{@name} = #{@tag} #{@default ? "[default=#{@default.inspect}]" : ''}"
+      end
+
+      private
+
+      ## 
+      # Private Instance Methods
+      #
+      def define_accessor
+        define_getter
+        if repeated?
+          define_array_setter
+        else
+          define_setter
+        end
+      end
+
+      def define_array_setter
+        field = self
+        @message_class.class_eval do
+          define_method(field.setter_method_name) do |val|
+            @values[field.name].replace(val)
+          end
+        end
+      end
+
+      def define_getter
+        field = self
+        @message_class.class_eval do
+          define_method(field.getter_method_name) do
+            @values.fetch(field.name, field.default_value)
+          end
+        end
+      end
+
+      def define_setter
+        field = self
+        @message_class.class_eval do
+          define_method(field.setter_method_name) do |val|
+            if val.nil?
+              @values.delete(field.name)
+            elsif field.acceptable?(val)
+              @values[field.name] = val
+            end
+          end
+        end
+      end
+
+      def typed_default_value
+        if @default.nil?
+          self.class.default
+        else
+          @default
+        end
+      end
+    end 
+  end
+end

data/lib/protobuf/field/bool_field.rb

@@ -0,0 +1,24 @@
+require 'protobuf/field/varint_field'
+
+module Protobuf
+  module Field
+    class BoolField < VarintField
+      def self.default
+        false
+      end
+
+      def acceptable?(val)
+        raise TypeError unless [true, false].include?(val)
+        true
+      end
+
+      def decode(value)
+        value == 1
+      end
+
+      def encode(value)
+        [value ? 1 : 0].pack('C')
+      end
+    end
+  end
+end

data/lib/protobuf/field/bytes_field.rb

@@ -0,0 +1,38 @@
+module Protobuf
+  module Field
+    class BytesField < BaseField
+      def self.default
+        ''
+      end
+
+      def wire_type
+        WireType::LENGTH_DELIMITED
+      end
+
+      def acceptable?(val)
+        if val.is_a?(::Protobuf::Message) || val.instance_of?(String)
+          return true
+        end
+
+        raise TypeError
+      end
+
+      def decode(bytes)
+        bytes.force_encoding(::Protobuf::Message::STRING_ENCODING) if bytes.respond_to?(:force_encoding)
+        bytes
+      end
+
+      def encode(value)
+        if value.is_a?(::Protobuf::Message)
+          value = value.serialize_to_string
+        else
+          value = value.dup
+          value.force_encoding(::Protobuf::Message::STRING_ENCODING) if value.respond_to?(:force_encoding)
+        end
+
+        string_size = VarintField.encode(value.size)
+        string_size << value
+      end
+    end
+  end
+end

data/lib/protobuf/field/double_field.rb

@@ -0,0 +1,19 @@
+require 'protobuf/field/float_field'
+
+module Protobuf
+  module Field
+    class DoubleField < FloatField
+      def wire_type
+        WireType::FIXED64
+      end
+
+      def decode(bytes)
+        bytes.unpack('E').first
+      end
+
+      def encode(value)
+        [value].pack('E')
+      end
+    end
+  end
+end

data/lib/protobuf/field/enum_field.rb

@@ -0,0 +1,58 @@
+require 'protobuf/field/varint_field'
+
+module Protobuf
+  module Field
+    class EnumField < VarintField
+      def acceptable?(val)
+        case val
+        when Symbol then
+          raise TypeError unless @type.const_defined?(val)
+        when EnumValue then
+          raise TypeError if val.parent_class != @type
+        else
+          raise TypeError unless @type.valid_tag?(val)
+        end
+        true
+      end
+
+      def encode(value)
+        super(value.to_i)
+      end
+
+      private
+
+      def typed_default_value
+        if @default.is_a?(Symbol)
+          @type.const_get(@default)
+        else
+          self.class.default
+        end
+      end
+
+      def define_setter
+        field = self
+        @message_class.class_eval do
+          define_method("#{field.name}=") do |val|
+            if val.nil?
+              @values.delete(field.name)
+            else
+              val = \
+                case val
+                when Symbol then
+                  field.type.const_get(val) rescue nil
+                when Integer then
+                  field.type.const_get(field.type.name_by_value(val)) rescue nil
+                when EnumValue then
+                  raise TypeError, "Invalid value: #{val.inspect} for #{field.name}" if val.parent_class != field.type
+                  val
+                end
+              raise TypeError, "Invalid value: #{val.inspect} for #{field.name}" unless val
+
+              @values[field.name] = val
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/protobuf/field/extension_fields.rb

@@ -0,0 +1,24 @@
+module Protobuf
+  module Field
+    class ExtensionFields < Hash
+      ##
+      # Constructor
+      #
+      def initialize(key_range=0..-1)
+        @key_range = key_range
+      end
+
+      ##
+      # Public Instance Methods
+      #
+      def []=(key, value)
+        raise RangeError, "#{key} is not in #{@key_range}" unless @key_range.include?(key)
+        super
+      end
+
+      def include_tag?(tag)
+        @key_range.include?(tag)
+      end
+    end
+  end
+end

data/lib/protobuf/field/field_array.rb

@@ -0,0 +1,55 @@
+module Protobuf
+  module Field
+    class FieldArray < Array
+      ##
+      # Constructor
+      #
+      def initialize(field)
+        @field = field
+      end
+
+      ## 
+      # Public Instance Methods
+      #
+      def []=(nth, val)
+        super(nth, normalize(val))
+      end
+
+      def <<(val)
+        super(normalize(val))
+      end
+
+      def push(val)
+        super(normalize(val))
+      end
+
+      def unshift(val)
+        super(normalize(val))
+      end
+
+      def replace(val)
+        raise TypeError unless val.is_a?(Array)
+        val = val.map {|v| normalize(v)}
+        super(val)
+      end
+
+      def to_s
+        "[#{@field.name}]"
+      end
+      
+      private
+
+      ##
+      # Private Instance Methods
+      #
+      def normalize(val)
+        raise TypeError unless @field.acceptable?(val)
+        if @field.is_a?(::Protobuf::Field::MessageField) && val.is_a?(Hash)
+          @field.type.new(val)
+        else
+          val
+        end
+      end
+    end
+  end
+end

data/lib/protobuf/field/fixed32_field.rb

@@ -0,0 +1,19 @@
+require 'protobuf/field/uint32_field.rb'
+
+module Protobuf
+  module Field
+    class Fixed32Field < Uint32Field
+      def wire_type
+       ::Protobuf::WireType::FIXED32
+      end
+
+      def decode(bytes)
+        bytes.unpack('V').first
+      end
+
+      def encode(value)
+        [value].pack('V')
+      end
+    end
+  end
+end