protobuffy 3.1.0

data/lib/protobuf/field/base_field.rb

@@ -0,0 +1,280 @@
+require 'protobuf/wire_type'
+require 'protobuf/field/field_array'
+
+module Protobuf
+  module Field
+    class BaseField
+
+      ##
+      # Constants
+      #
+
+      PACKED_TYPES = [
+        ::Protobuf::WireType::VARINT,
+        ::Protobuf::WireType::FIXED32,
+        ::Protobuf::WireType::FIXED64
+      ].freeze
+
+      ##
+      # Attributes
+      #
+
+      attr_reader :default, :default_value, :deprecated, :extension,
+                  :getter_method_name, :message_class, :name, :optional,
+                  :packed, :repeated, :required, :rule, :setter_method_name,
+                  :tag, :type_class
+
+      ##
+      # Class Methods
+      #
+
+      def self.default
+        nil
+      end
+
+      ##
+      # Constructor
+      #
+
+      def initialize(message_class, rule, type_class, name, tag, options)
+        @message_class, @rule, @type_class, @name, @tag = \
+          message_class, rule, type_class, name, tag
+
+        set_rule_predicates
+
+        @getter_method_name = name
+        @setter_method_name = "#{name}="
+        @default   = options.delete(:default)
+        @extension = options.delete(:extension)
+        @packed    = repeated? && options.delete(:packed)
+        @deprecated = options.delete(:deprecated)
+
+        set_default_value
+        warn_excess_options(options) unless options.empty?
+        validate_packed_field if packed?
+        define_accessor
+      end
+
+      ##
+      # Public Instance Methods
+      #
+
+      def acceptable?(value)
+        true
+      end
+
+      def enum?
+        false
+      end
+
+      def message?
+        false
+      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 ::Protobuf::WireType::FIXED32 then :read_fixed32
+            when ::Protobuf::WireType::FIXED64 then :read_fixed64
+            when ::Protobuf::WireType::VARINT  then :read_varint
+            end
+          stream = StringIO.new(bytes)
+
+          until stream.eof?
+            array << decode(::Protobuf::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?
+        !! repeated
+      end
+
+      # Is this a repeated message field?
+      def repeated_message?
+        repeated? && message?
+      end
+
+      # Is this a required field?
+      def required?
+        !! required
+      end
+
+      # Is this a optional field?
+      def optional?
+        !! optional
+      end
+
+      # Is this a deprecated field?
+      def deprecated?
+        !! deprecated
+      end
+
+      # Is this a packed repeated field?
+      def packed?
+        !! packed
+      end
+
+      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
+
+      private
+
+      ##
+      # Private Instance Methods
+      #
+
+      def define_accessor
+        if repeated?
+          define_array_getter
+          define_array_setter
+        else
+          define_getter
+          define_setter
+        end
+      end
+
+      def define_array_getter
+        field = self
+        message_class.class_eval do
+          define_method(field.getter_method_name) do
+            field.warn_if_deprecated
+            @values[field.name] ||= ::Protobuf::Field::FieldArray.new(field)
+          end
+        end
+      end
+
+      def define_array_setter
+        field = self
+        message_class.class_eval do
+          define_method(field.setter_method_name) do |val|
+            field.warn_if_deprecated
+
+            if val.is_a?(Array)
+              val = val.dup
+              val.compact!
+            else
+              raise TypeError, <<-TYPE_ERROR
+                Expected repeated value of type '#{field.type_class}'
+                Got '#{val.class}' for repeated protobuf field #{field.name}
+              TYPE_ERROR
+            end
+
+            if val.nil? || (val.respond_to?(:empty?) && val.empty?)
+              @values.delete(field.name)
+            else
+              @values[field.name] ||= ::Protobuf::Field::FieldArray.new(field)
+              @values[field.name].replace(val)
+            end
+          end
+        end
+      end
+
+      def define_getter
+        field = self
+        message_class.class_eval do
+          define_method(field.getter_method_name) do
+            field.warn_if_deprecated
+            @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|
+            field.warn_if_deprecated
+
+            if val.nil? || (val.respond_to?(:empty?) && val.empty?)
+              @values.delete(field.name)
+            elsif field.acceptable?(val)
+              @values[field.name] = val
+            else
+              raise TypeError, "Unacceptable value #{val} for field #{field.name} of type #{field.type_class}"
+            end
+          end
+        end
+      end
+
+      def set_default_value
+        @default_value = case
+                         when repeated? then ::Protobuf::Field::FieldArray.new(self).freeze
+                         when required? then nil
+                         when optional? then typed_default_value
+                         end
+      end
+
+      def set_rule_predicates
+        case rule
+        when :repeated then
+          @required = @optional = false
+          @repeated = true
+        when :required then
+          @repeated = @optional = false
+          @required = true
+        when :optional then
+          @repeated = @required = false
+          @optional = true
+        end
+      end
+
+      def typed_default_value
+        if default.nil?
+          self.class.default
+        else
+          default
+        end
+      end
+
+      def validate_packed_field
+        if packed? && ! ::Protobuf::Field::BaseField::PACKED_TYPES.include?(wire_type)
+          raise "Can't use packed encoding for '#{type_class}' type"
+        end
+      end
+
+      def warn_excess_options(options)
+        warn "WARNING: Invalid options: #{options.inspect} (in #{message_class.name}##{name})"
+      end
+
+    end
+  end
+end
+

data/lib/protobuf/field/bool_field.rb

@@ -0,0 +1,53 @@
+require 'protobuf/field/varint_field'
+
+module Protobuf
+  module Field
+    class BoolField < VarintField
+
+      ##
+      # Class Methods
+      #
+
+      def self.default
+        false
+      end
+
+
+      ##
+      # Public Instance Methods
+      # #
+
+      def acceptable?(val)
+        [true, false].include?(val)
+      end
+
+      def decode(value)
+        value == 1
+      end
+
+      def encode(value)
+        [value ? 1 : 0].pack('C')
+      end
+
+      private
+
+      ##
+      # Private Instance Methods
+      #
+
+      def define_getter
+        super
+
+        field = self
+        message_class.class_eval do
+          define_method("#{field.getter_method_name}?") do
+            field.warn_if_deprecated
+            @values.fetch(field.name, field.default_value)
+          end
+        end
+      end
+
+    end
+  end
+end
+

data/lib/protobuf/field/bytes_field.rb

@@ -0,0 +1,81 @@
+require 'protobuf/wire_type'
+
+module Protobuf
+  module Field
+    class BytesField < BaseField
+
+      ##
+      # Constants
+      #
+
+      BYTES_ENCODING = "ASCII-8BIT".freeze
+
+      ##
+      # Class Methods
+      #
+
+      def self.default
+        ''
+      end
+
+      ##
+      # Public Instance Methods
+      #
+
+      def acceptable?(val)
+        val.nil? || val.is_a?(String) || val.is_a?(Symbol) || val.is_a?(::Protobuf::Message)
+      end
+
+      def decode(bytes)
+        bytes_to_decode = bytes.dup
+        bytes_to_decode.force_encoding(::Protobuf::Field::BytesField::BYTES_ENCODING)
+        bytes_to_decode
+      end
+
+      def encode(value)
+        value_to_encode = value.dup
+        value_to_encode = value.encode if value.is_a?(::Protobuf::Message)
+        value_to_encode.force_encoding(::Protobuf::Field::BytesField::BYTES_ENCODING)
+
+        string_size = ::Protobuf::Field::VarintField.encode(value_to_encode.size)
+        string_size << value_to_encode
+      end
+
+      def wire_type
+        ::Protobuf::WireType::LENGTH_DELIMITED
+      end
+
+      private
+
+      ##
+      # Private Instance Methods
+      #
+
+      def define_setter
+        field = self
+        message_class.class_eval do
+          define_method(field.setter_method_name) do |val|
+            begin
+              field.warn_if_deprecated
+              val = "#{val}" if val.is_a?(Symbol)
+
+              if val.nil?
+                @values.delete(field.name)
+              elsif field.acceptable?(val)
+                @values[field.name] = val.dup
+              else
+                raise TypeError, "Unacceptable value #{val} for field #{field.name} of type #{field.type_class}"
+              end
+            rescue NoMethodError => ex
+              ::Protobuf::Logger.error { ex.message }
+              ::Protobuf::Logger.error { ex.backtrace.join("\n") }
+              raise TypeError, "Got NoMethodError attempting to set #{val} for field #{field.name} of type #{field.type_class}: #{ex.message}"
+            end
+          end
+        end
+      end
+
+    end
+  end
+end
+

data/lib/protobuf/field/double_field.rb

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

data/lib/protobuf/field/enum_field.rb

@@ -0,0 +1,57 @@
+require 'protobuf/field/varint_field'
+
+module Protobuf
+  module Field
+    class EnumField < VarintField
+
+      ##
+      # Public Instance Methods
+      #
+
+      def acceptable?(val)
+        ! type_class.fetch(val).nil?
+      end
+
+      def encode(value)
+        super(value.to_i)
+      end
+
+      def enum?
+        true
+      end
+
+      private
+
+      ##
+      # Private Instance Methods
+      #
+
+      def define_setter
+        field = self
+        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_class.fetch(value)
+              raise TypeError, "Invalid Enum value: #{orig_value.inspect} for #{field.name}" unless value
+
+              @values[field.name] = value
+            end
+          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
+