beefcake 1.0.0 → 1.1.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4315b71a6cc3b6e07b3f92817359b4892c63019b
-  data.tar.gz: 01fcc7f8732015828e2add50835ab4e0b9c62c8a
+  metadata.gz: 30ed4bf45f17475a8deb5a11bf4b53cecae450b8
+  data.tar.gz: bd1faca7f9bb8691ef60b3c0a1b7ae0b4d08ec98
 SHA512:
-  metadata.gz: b24cd6f575087cdf58e640b8b9efa5c48b0b6c82472721a00a370287c85fb740d687c8e45066923b3611cbcfb5197bbc51e4051fd1d3e8c3177c9f58f2b592b3
-  data.tar.gz: e77014958359aac39ddaaf9483bb2d3d1f25ef7c7ababb023cd5a6a4239f75d9628a67f75e5fde1135e760f2b22a792c023a01aafb96905b1b8ef0835338a525
+  metadata.gz: 21fa7ab6f0d1dc688bda21ca235ccf4cafdcf642431923944661b591f336105f349ac52d06fe98d95cdbf5acb4582b7804dc79606c731e6366797f286fe8415a
+  data.tar.gz: 2c3e38af30b33354952d1fc7897db4a1bcc105e12e92ac73ec4fc8c5e70dcf4602959c8e6046bdbc31cc924621aa488683ed62a7d55c7160745f776d6899bd00

data/.travis.yml

@@ -3,6 +3,13 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-  - 2.1.1
-  - 2.1.2
+  - 2.1.5
+  - 2.2.0
   - jruby-19mode
+  - rbx-2.2.7
+  - ruby-head
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head

data/lib/beefcake.rb

@@ -33,6 +33,18 @@ module Beefcake
       def <=>(o)
         fn <=> o.fn
       end
+
+      def same_type?(obj)
+        type == obj
+      end
+
+      def is_protobuf?
+        type.is_a?(Class) and type.include?(Beefcake::Message)
+      end
+
+      def required? ; rule == :required end
+      def repeated? ; rule == :repeated end
+      def optional? ; rule == :optional end
     end
 
 
@@ -185,7 +197,8 @@ module Beefcake
             end
           elsif fld.rule == :repeated
             val = buf.read(fld.type)
-            (o[fld.name] ||= []) << val
+            o[fld.name] ||= []
+            o[fld.name] << val
           else
             val = buf.read(fld.type)
             o[fld.name] = val
@@ -224,10 +237,66 @@ module Beefcake
       o.send(:include, Encode)
     end
 
+    # (see #assign)
     def initialize(attrs={})
+      assign attrs
+    end
+
+    # Handles filling a protobuf message from a hash. Embedded messages can
+    # be passed in two ways, by a pure hash or as an instance of embedded class(es).
+    #
+    # @example By a pure hash.
+    #   {:field1 => 2, :embedded => {:embedded_f1 => 'lala'}}
+    #
+    # @example Repeated embedded message by a pure hash.
+    #   {:field1 => 2, :embedded => [
+    #     {:embedded_f1 => 'lala'},
+    #     {:embedded_f1 => 'lulu'}
+    #   ]}
+    #
+    # @example As an instance of embedded class.
+    #   {:field1 => 2, :embedded => EmbeddedMsg.new({:embedded_f1 => 'lala'})}
+    #
+    # @param [Hash] data to fill a protobuf message with.
+    def assign(attrs)
       __beefcake_fields__.values.each do |fld|
-        self[fld.name] = attrs[fld.name]
+        attribute = attrs[fld.name]
+
+        if attribute.nil?
+          self[fld.name] = nil
+          next
+        end
+
+        unless fld.is_protobuf?
+          self[fld.name] = attribute
+          next
+        end
+
+        if fld.repeated? && attribute.is_a?(Hash)
+          self[fld.name] = fld.type.new(attribute)
+          next
+        end
+
+        if fld.repeated? && attribute.is_a?(fld.type)
+          self[fld.name] = [attribute]
+          next
+        end
+
+        if fld.repeated?
+          self[fld.name] = attribute.map do |i|
+            fld.same_type?(i) ? i : fld.type.new(i)
+          end
+          next
+        end
+
+        if fld.same_type? attribute
+          self[fld.name] = attribute
+          next
+        end
+
+        self[fld.name] = fld.type.new(attribute)
       end
+      self
     end
 
     def __beefcake_fields__
@@ -270,10 +339,22 @@ module Beefcake
 
     def to_hash
       __beefcake_fields__.values.inject({}) do |h, fld|
-        value = self[fld.name]
-        unless value.nil?
-          h[fld.name] = value
-        end
+        v = self[fld.name]
+        next h if v.nil?
+
+        h[fld.name] =
+          case
+          when v.respond_to?(:to_hash)
+            # A nested protobuf message, so let's call its 'to_hash' method.
+            v.to_hash
+          when v.is_a?(Array)
+            # There can be two field types stored in array.
+            # Primitive type or nested another protobuf message.
+            # The later one has got a 'to_hash' method.
+            v.map { |i| i.respond_to?(:to_hash) ? i.to_hash : i }
+          else
+            v
+          end
         h
       end
     end

data/lib/beefcake/version.rb

@@ -1,3 +1,3 @@
 module Beefcake
-  VERSION = "1.0.0"
+  VERSION = "1.1.0.pre1"
 end

data/test/message_test.rb

@@ -102,6 +102,70 @@ class FieldsMessage
   repeated :fields, :string, 1
 end
 
+class FieldTest < Minitest::Test
+  FIELD = Beefcake::Message::Field
+
+  def test_required?
+    f = FIELD.new :required, :field1, :string, 1
+    assert f.required?
+    refute f.optional?
+    refute f.repeated?
+
+    f = FIELD.new :optional, :field1, :int32, 1
+    refute f.required?
+
+    f = FIELD.new :repeated, :field1, :int32, 1
+    refute f.required?
+  end
+
+  def test_optional?
+    f = FIELD.new :optional, :field1, :string, 1
+    assert f.optional?
+    refute f.required?
+    refute f.repeated?
+
+    f = FIELD.new :required, :field1, :int32, 1
+    refute f.optional?
+
+    f = FIELD.new :repeated, :field1, :int32, 1
+    refute f.optional?
+  end
+
+  def test_repeated?
+    f = FIELD.new :repeated, :field1, :string, 1
+    assert f.repeated?
+    refute f.required?
+    refute f.optional?
+
+    f = FIELD.new :optional, :field1, :int32, 1
+    refute f.repeated?
+
+    f = FIELD.new :required, :field1, :int32, 1
+    refute f.optional?
+  end
+
+  def test_same_type
+    f = FIELD.new(:required, :field1, :int32, 1)
+    assert f.same_type?(:int32)
+    refute f.same_type?(:int64)
+    refute f.same_type?(SimpleMessage)
+
+    f = FIELD.new(:required, :field1, SimpleMessage, 1)
+    assert f.same_type?(SimpleMessage)
+    refute f.same_type?(:int32)
+    refute f.same_type?(:string)
+    refute f.same_type?(NumericsMessage)
+  end
+
+  def test_is_protobuf?
+    f = FIELD.new(:required, :field1, SimpleMessage, 1)
+    assert f.is_protobuf?
+
+    f = FIELD.new(:required, :field1, :string, 1)
+    refute f.is_protobuf?
+  end
+end
+
 class MessageTest < Minitest::Test
   B = Beefcake::Buffer
 
@@ -163,6 +227,12 @@ class MessageTest < Minitest::Test
     )
 
     assert_equal buf2.to_s, msg.encode.to_s
+
+    msg = CompositeMessage.new(
+        :encodable => {:a => 123}
+    )
+    assert_equal buf2.to_s, msg.encode.to_s
+
   end
 
   def test_encode_to_string
@@ -196,6 +266,9 @@ class MessageTest < Minitest::Test
 
     msg = EnumsMessage.new :a => EnumsMessage::X::A
     assert_equal "\b\001", msg.encode.to_s
+
+    msg = EnumsMessage.new :a => 1
+    assert_equal "\b\001", msg.encode.to_s
   end
 
   def test_encode_invalid_enum_value
@@ -269,6 +342,16 @@ class MessageTest < Minitest::Test
     msg.encode.to_s
   end
 
+  def test_repeated_with_hash
+    before = { simple: { b: 'hello' } }
+    RepeatedNestedMessage.new before
+  end
+
+  def test_repeated_with_scalar
+    inner = SimpleMessage.new(b: 'hello')
+    RepeatedNestedMessage.new simple: inner
+  end
+
   ## Decoding
   def test_decode_numerics
     msg = NumericsMessage.new({
@@ -361,6 +444,16 @@ class MessageTest < Minitest::Test
     assert_equal 2, got.simple.size
     assert_equal 1, got.simple[0].a
     assert_equal "hello", got.simple[1].b
+
+    simple_pure = [
+      {:a => 1},
+      {:b => "hello"}
+    ]
+    msg = RepeatedNestedMessage.new(:simple => simple_pure).encode
+    got = RepeatedNestedMessage.decode(msg)
+    assert_equal 2, got.simple.size
+    assert_equal 1, got.simple[0].a
+    assert_equal "hello", got.simple[1].b
   end
 
   def test_equality
@@ -409,7 +502,23 @@ class MessageTest < Minitest::Test
   def test_to_hash
     msg =  SimpleMessage.new :a => 1
     exp = { :a => 1 }
-    assert_equal(exp, msg.to_hash)
+    assert_equal exp, msg.to_hash
+
+    msg = RepeatedNestedMessage.new(
+      :simple => [
+        SimpleMessage.new(:a => 1),
+        SimpleMessage.new(:b => 'abc dfg'),
+        SimpleMessage.new(:a => 2, :b => 'ijk lmn')
+      ]
+    )
+    exp = {
+      :simple =>[
+        {:a => 1},
+        {:b => 'abc dfg'},
+        {:a => 2, :b => 'ijk lmn'}
+      ]
+    }
+    assert_equal exp, msg.to_hash
   end
 
   def test_duplicate_index

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beefcake
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.pre1
 platform: ruby
 authors:
 - Blake Mizerany
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-05 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -89,12 +89,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A sane protobuf library for Ruby