prepor-beefcake 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b05eb3a8400e0af12563f45411a2e95cfb762ab6
-  data.tar.gz: ea1e377af18cbfb73ee824731e2ecbb0b3550d98
+  metadata.gz: 14f8f3b9ce47e2ce5d95ffbc30ac2cb85c9d16a9
+  data.tar.gz: b8438b597123b5a75e3e261255d93b36c959aff0
 SHA512:
-  metadata.gz: 21a7d5536ea0f5181357987ccfb8a9e4ff20757e2ee5e34a52b450d966cc62f5330b0d7b11c2aadbcbc92b22656d2afb8c1ed4ecd77ba9953deef87d8e46a052
-  data.tar.gz: 40ae3e963de1fbcad69d9f8b48fbdaf5bfdfbea1de6b99b8e8c3e8803487d965b142a24e27ddc5d76a95902c448627329571fba5cd0aa2d9b95d0e45b91343ae
+  metadata.gz: ef80c4dc456a091607a1626987d794a0c0ecf81ef7b6f3dcfa6d8e84562bb7ead6941a6d05cd399c1db72bcb64a7ccc6efc4781aae82898de28f40bb10a327e3
+  data.tar.gz: f4916f34a41889d77a55893f5f8160143bfe47af18e37f920c6ff1cc4ae2db35239d91fca0b8078b2d8f22f8b77dfe5231d39cffe0a0eeb0f68a70833bfee871

data/.travis.yml

@@ -3,6 +3,16 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-  - 2.1.1
-  - 2.1.2
+  - 2.1.6
+  - 2.2.0
+  - 2.2.1
+  - 2.2.2
   - jruby-19mode
+  - rbx-2.2.7
+  - jruby-9.0.0.0.pre2
+  - ruby-head
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head

data/README.md

@@ -1,7 +1,6 @@
 # Beefcake
 
-A sane Google Protocol Buffers library for Ruby. It's all about being Buf;
-ProtoBuf.
+A pure-Ruby Google Protocol Buffers library. It's all about being Buf; ProtoBuf.
 
 ## Installation
 

data/RELEASE_NOTES.md

@@ -1,6 +1,17 @@
 # Beefcake Release Notes
 
-# 0.1.0 - 2014-09-05
+# 1.1.0 - 2015-05-26
+
+Release 1.1.0 includes improvements and bug fixes.
+
+* Correct message-hash conversion behavior, fixed by Peter "kybu" Vrabel.
+* Remove trailing whitespace in generator output without package name.
+* Allow a Hash instead of an Array<Hash> when assigning a repeated field that's
+  only repeated once.
+* Ensure object identities are persisted through message initialization,
+  reported by Peter Neubauer.
+
+# 1.0.0 - 2014-09-05
 
 Release 1.0.0 includes changes and improvements.
 
@@ -21,7 +32,7 @@ Release 0.5.0 corrects a few behaviors.
 * Don't crash when attempting to reencode frozen strings,
   found thanks to Kyle "Aphyr" Kingsbury
 * Return `nil` instead of raising a generic Ruby error when trying to
-  decode a zero-length buffer, fixed by Tobias "grobie" Schmidt 
+  decode a zero-length buffer, fixed by Tobias "grobie" Schmidt
 
 # 0.4.0 - 2013-10-10
 

data/beefcake.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Blake Mizerany", "Matt Proud", "Bryce Kerley"]
   s.email       = ["blake.mizerany@gmail.com", "matt.proud@gmail.com", "bkerley@brycekerley.net"]
   s.homepage    = "https://github.com/protobuf-ruby/beefcake"
-  s.summary     = %q{A sane protobuf library for Ruby}
-  s.description = %q{A sane protobuf library for Ruby}
+  s.summary     = %q{A pure-Ruby protobuf library}
+  s.description = %q{A pure-Ruby Protocol Buffers library}
   s.license     = 'MIT'
 
   s.files         = `git ls-files`.split("\n")

data/lib/beefcake.rb

@@ -33,6 +33,22 @@ module Beefcake
       def <=>(o)
         fn <=> o.fn
       end
+
+      def same_type?(obj)
+        type == obj
+      end
+
+      def matches_type?(obj)
+        obj.is_a? type
+      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 +201,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 +241,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.matches_type?(i) ? i : fld.type.new(i)
+          end
+          next
+        end
+
+        if fld.matches_type? attribute
+          self[fld.name] = attribute
+          next
+        end
+
+        self[fld.name] = fld.type.new(attribute)
       end
+      self
     end
 
     def __beefcake_fields__
@@ -270,10 +343,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.1.0"
+  VERSION = "1.1.1"
 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
@@ -378,6 +471,13 @@ class MessageTest < Minitest::Test
     refute_equal :symbol, d
   end
 
+  def test_object_identity
+    inside = [SimpleMessage.new(a: 12345)]
+    outside = RepeatedNestedMessage.new simple: inside
+
+    assert_equal outside.simple.first.object_id, inside.first.object_id
+  end
+
   def test_inspect
     msg = SimpleMessage.new :a => 1
     assert_equal "<SimpleMessage a: 1>", msg.inspect
@@ -409,7 +509,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: prepor-beefcake
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Blake Mizerany
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-07 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -40,7 +40,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.3'
-description: A sane protobuf library for Ruby
+description: A pure-Ruby Protocol Buffers library
 email:
 - blake.mizerany@gmail.com
 - matt.proud@gmail.com
@@ -97,7 +97,7 @@ rubyforge_project:
 rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
-summary: A sane protobuf library for Ruby
+summary: A pure-Ruby protobuf library
 test_files:
 - test/benchmark_test.rb
 - test/buffer_decode_test.rb