beefcake 0.4.0 → 0.5.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f4e5e1cfae47692b962d140248d78882d2c7f5f
-  data.tar.gz: 5022dd602b952ccb3bfd27e73f2932a4032e2507
+  metadata.gz: d36ababf16022319e4fb8c312f566f814f08e316
+  data.tar.gz: f2e5b2510755f3c2e49ec4dd04ae5b87ce01e4fe
 SHA512:
-  metadata.gz: b68af37acfc3a3ec1c18222781ff3281f0fff1e5310cb18eda7748d1f58d696970f92815ada66c8e9b242b187a07393b6be3e3d7932f5cf65649bb80b97154aa
-  data.tar.gz: ced3ff677e2234915b09add7fda412cee0c2afc90fd440d75e79bf73300c9260c4122140520f59d538229bda358207459bf57f5ef5cd7085a3494b6b8dde791b
+  metadata.gz: 904fa81bb6175ed7ecbc6f02eebd5a17f41370439732ebc849c8e9cc173010a39a7fb495b3fe5e095d5b26c7ddea75dc2a86b8af3815f553b1883b288ae0e3e0
+  data.tar.gz: 335132b6e83dbd0d1045c2a07cefb5efb55fd58e32d3c30449505e2f8325fb914506e90499f235d175172318fff348d5a1c8d639335bdd1ff89d69e3f7b638e8

data/README.md

@@ -1,13 +1,15 @@
-# Beefcake (A sane Google Protocol Buffers library for Ruby)
-## It's all about being Buf; ProtoBuf.
+# Beefcake
 
-# Install
+A sane Google Protocol Buffers library for Ruby. It's all about being Buf;
+ProtoBuf.
+
+## Installation
 
 ```shell
-$ gem install beefcake
+gem install beefcake
 ```
 
-# Example
+## Usage
 
 ```ruby
 require 'beefcake'
@@ -38,7 +40,7 @@ class Variety
 end
 
 # You can create a new message with hash arguments:
-x = Variety.new :x => 1, :y => 2
+x = Variety.new(:x => 1, :y => 2)
 
 # You can set fields individually using accessor methods:
 x = Variety.new
@@ -51,12 +53,13 @@ x[:y] = 4
 x # => <Variety x: 1, y: 4>
 ```
 
-## Encoding
+### Encoding
 
 Any object responding to `<<` can accept encoding
 
 ```ruby
-x # => <Variety x: 1, y: 2>
+# see code example above for the definition of Variety
+x = Variety.new(:x => 1, :y => 2)
 
 # For example, you can encode into a String:
 s = ""
@@ -73,7 +76,8 @@ x.encode.to_s # => "\b\x01\x10\x02)\0"
 ### Decoding
 
 ```ruby
-x # => <Variety x: 1, y: 2>
+# see code example above for the definition of Variety
+x = Variety.new(:x => 1, :y => 2)
 
 # You can decode from a Beefcake::Buffer
 encoded = x.encode
@@ -88,31 +92,53 @@ Variety.decoded(new_data, x)
 x # => <Variety x: 12345, y: 2, pary: [], foo: B(2)>
 ```
 
-# Why?
+### Generate code from `.proto` file
 
-  Ruby deserves and needs first-class ProtoBuf support.
-  Other libs didn't feel very "Ruby" to me and were hard to parse.
+```shell
+protoc --beefcake_out output/path -I path/to/proto/files/dir path/to/file.proto
+```
 
-# Generate code from `.proto` file
+You can set the `BEEFCAKE_NAMESPACE` variable to generate the classes under a
+desired namespace. (i.e. App::Foo::Bar)
 
-    $ protoc --beefcake_out output/path -I path/to/proto/files/dir path/to/proto/file
+## About
 
-You can set the BEEFCAKE_NAMESPACE variable to generate the classes under a
-desired namespace. (i.e. App::Foo::Bar)
+Ruby deserves and needs first-class ProtoBuf support. Other libs didn't feel
+very "Ruby" to me and were hard to parse.
 
-# Misc
+This library was built with EventMachine in mind.  Not just blocking-IO.
 
-  This library was built with EventMachine in mind.  Not just blocking-IO.
+Source: https://github.com/protobuf-ruby/beefcake
 
-# Dev
+### Support Features
 
-Source:
+  * Optional fields
+  * Required fields
+  * Repeated fields
+  * Packed Repeated Fields
+  * Varint fields
+  * 32-bit fields
+  * 64-bit fields
+  * Length-delimited fields
+  * Embedded Messages
+  * Unknown fields are ignored (as per spec)
+  * Enums
+  * Defaults (i.e. `optional :foo, :string, :default => "bar"`)
+  * Varint-encoded length-delimited message streams
 
-    $ git clone https://github.com/protobuf-ruby/beefcake.git
+### Future
 
-## Testing:
+  * Imports
+  * Use package in generation
+  * Groups (would be nice for accessing older protos)
 
-    $ rake test
+### Further Reading
+
+http://code.google.com/apis/protocolbuffers/docs/encoding.html
+
+## Testing
+
+    rake test
 
 Beefcake conducts continuous integration on [Travis CI](http://travis-ci.org).
 The current build status for HEAD is [![Build Status](https://travis-ci.org/protobuf-ruby/beefcake.png)](https://travis-ci.org/protobuf-ruby/beefcake).
@@ -120,46 +146,16 @@ The current build status for HEAD is [![Build Status](https://travis-ci.org/prot
 All pull requests automatically trigger a build request.  Please ensure that
 tests succeed.
 
-## VMs:
-
 Currently Beefcake is tested and working on:
 
-* Ruby 1.8.6
-* Ruby 1.8.7
-* Ruby 1.9.2
-* Ruby 2.0.0
-* JRuby 1.5.6
-* Rubinius edge
-
-
-## Support Features
-
-* Optional fields
-* Required fields
-* Repeated fields
-* Packed Repeated Fields
-* Varint fields
-* 32-bit fields
-* 64-bit fields
-* Length-delimited fields
-* Embedded Messages
-* Unknown fields are ignored (as per spec)
-* Enums
-* Defaults (i.e. `optional :foo, :string, :default => "bar"`)
-* Varint-encoded length-delimited message streams
-
-
-## Future
-
-* Imports
-* Use package in generation
-* Groups (would be nice for accessing older protos)
-
-# Further Reading
-
-http://code.google.com/apis/protocolbuffers/docs/encoding.html
+  * Ruby 1.8.6
+  * Ruby 1.8.7
+  * Ruby 1.9.2
+  * Ruby 2.0.0
+  * JRuby 1.5.6
+  * Rubinius edge
 
-# Thank You
+## Thank You
 
-Keith Rarick (kr) for help with encoding/decoding.
-Aman Gupta (tmm1) for help with cross VM support and performance enhancements.
+  * Keith Rarick (kr) for help with encoding/decoding.
+  * Aman Gupta (tmm1) for help with cross VM support and performance enhancements.

data/RELEASE_NOTES.md

@@ -1,5 +1,16 @@
 # Beefcake Release Notes
 
+# 0.5.0 - 2013-12-20
+
+Release 0.5.0 corrects a few behaviors.
+
+* Drastically revised README, written by Tobias "grobie" Schmidt
+* Output fewer newlines in generated files, fixed by Tobias "grobie" Schmidt
+* 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 
+
 # 0.4.0 - 2013-10-10
 
 Release 0.4.0 is the first with new maintainers.

data/lib/beefcake.rb

@@ -200,6 +200,8 @@ module Beefcake
           buf = Buffer.new(buf)
         end
 
+        return if buf.length == 0
+
         n = buf.read_int64
         tmp = Buffer.new(buf.read(n))
 

data/lib/beefcake/buffer/encode.rb

@@ -105,7 +105,7 @@ module Beefcake
     end
 
     def append_string(s)
-      actual_string = s.to_s
+      actual_string = thaw_string s
       if actual_string.respond_to? :force_encoding
         encoded = actual_string.force_encoding 'binary'
       else
@@ -116,6 +116,14 @@ module Beefcake
     end
     alias :append_bytes :append_string
 
+
+    private
+    def thaw_string(s)
+      if s.frozen?
+        s = s.dup
+      end
+      s.to_s
+    end
   end
 
 end

data/lib/beefcake/generator.rb

@@ -209,7 +209,6 @@ module Beefcake
       end
 
       puts "end"
-      puts
     end
 
     def enum!(et)

data/lib/beefcake/version.rb

@@ -1,3 +1,3 @@
 module Beefcake
-  VERSION = "0.4.0"
+  VERSION = "0.5.0.pre1"
 end

data/test/buffer_encode_test.rb

@@ -221,4 +221,9 @@ class BufferEncodeTest < Test::Unit::TestCase
     assert_equal "\007testing", @buf.to_s
   end
 
+  def test_append_frozen_string
+    @buf.append_string "testing".freeze
+    assert_equal "\007testing", @buf.to_s
+  end
+
 end

data/test/message_test.rb

@@ -180,6 +180,10 @@ class MessageTest < Test::Unit::TestCase
     end
   end
 
+  def test_empty_buffer_delimited_read
+    assert_equal SimpleMessage.read_delimited(""), nil
+  end
+
   def test_encode_enum
     buf = Beefcake::Buffer.new
     buf.append(:int32, 2, 1)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beefcake
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0.pre1
 platform: ruby
 authors:
 - Blake Mizerany
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2013-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -74,12 +74,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: beefcake
-rubygems_version: 2.1.4
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A sane protobuf library for Ruby
@@ -89,3 +89,4 @@ test_files:
 - test/buffer_test.rb
 - test/generator_test.rb
 - test/message_test.rb
+has_rdoc: