beefcake 0.3.7 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f4e5e1cfae47692b962d140248d78882d2c7f5f
+  data.tar.gz: 5022dd602b952ccb3bfd27e73f2932a4032e2507
+SHA512:
+  metadata.gz: b68af37acfc3a3ec1c18222781ff3281f0fff1e5310cb18eda7748d1f58d696970f92815ada66c8e9b242b187a07393b6be3e3d7932f5cf65649bb80b97154aa
+  data.tar.gz: ced3ff677e2234915b09add7fda412cee0c2afc90fd440d75e79bf73300c9260c4122140520f59d538229bda358207459bf57f5ef5cd7085a3494b6b8dde791b

data/.gitignore

@@ -1 +1,2 @@
 *.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-18mode
+  - jruby-19mode

data/README.md

@@ -3,64 +3,90 @@
 
 # Install
 
-    $ gem install beefcake
+```shell
+$ gem install beefcake
+```
 
 # Example
 
-    require 'beefcake'
+```ruby
+require 'beefcake'
 
-    class Variety
-      include Beefcake::Message
+class Variety
+  include Beefcake::Message
 
-      # Required
-      required :x, :int32, 1
-      required :y, :int32, 2
+  # Required
+  required :x, :int32, 1
+  required :y, :int32, 2
 
-      # Optional
-      optional :tag, :string, 3
+  # Optional
+  optional :tag, :string, 3
 
-      # Repeated
-      repeated :ary,  :fixed64, 4
-      repeated :pary, :fixed64, 5, :packed => true
+  # Repeated
+  repeated :ary,  :fixed64, 4
+  repeated :pary, :fixed64, 5, :packed => true
 
-      # Enums - Simply use a Module (NOTE: defaults are optional)
-      module Foonum
-        A = 1
-        B = 2
-      end
+  # Enums - Simply use a Module (NOTE: defaults are optional)
+  module Foonum
+    A = 1
+    B = 2
+  end
 
-      # As per the spec, defaults are only set at the end
-      # of decoding a message, not on object creation.
-      optional :foo, Foonum, 6, :default => Foonum::B
-    end
+  # As per the spec, defaults are only set at the end
+  # of decoding a message, not on object creation.
+  optional :foo, Foonum, 6, :default => Foonum::B
+end
 
-    x = Variety.new :x => 1, :y => 2
-    # or
-    x = Variety.new
-    x.x = 1
-    x.y = 2
+# You can create a new message with hash arguments:
+x = Variety.new :x => 1, :y => 2
+
+# You can set fields individually using accessor methods:
+x = Variety.new
+x.x = 1
+x.y = 2
+
+# And you can access fields using Hash syntax:
+x[:x] # => 1
+x[:y] = 4
+x # => <Variety x: 1, y: 4>
+```
 
 ## Encoding
 
 Any object responding to `<<` can accept encoding
 
-    s = ""
-    x.encode(s)
-    p [:s, s]
-    # or (because encode returns the string/stream)
-    p [:s, x.encode]
-    # or
-    open("x.dat") do |f|
-      x.encode(f)
-    end
+```ruby
+x # => <Variety x: 1, y: 2>
+
+# For example, you can encode into a String:
+s = ""
+x.encode(s)
+s # => "\b\x01\x10\x02)\0"
+
+# If you don't encode into anything, a new Beefcake::Buffer will be returned:
+x.encode # => #<Beefcake::Buffer:0x007fbfe1867ab0 @buf="\b\x01\x10\x02)\0">
+
+# And that buffer can be converted to a String:
+x.encode.to_s # => "\b\x01\x10\x02)\0"
+```
 
-    # decode
-    encoded = x.encode
-    decoded = Variety.decode(encoded)
-    p [:x, decoded]
+### Decoding
 
-    # decode merge
-    Variety.decoded(more_data, decoded)
+```ruby
+x # => <Variety x: 1, y: 2>
+
+# You can decode from a Beefcake::Buffer
+encoded = x.encode
+Variety.decode(encoded) # => <Variety x: 1, y: 2, pary: [], foo: B(2)>
+
+# Decoding from a String works the same way:
+Variety.decode(encoded.to_s) # => <Variety x: 1, y: 2, pary: [], foo: B(2)>
+
+# You can update a Beefcake::Message instance with new data too:
+new_data = Variety.new(x: 12345, y: 2).encode
+Variety.decoded(new_data, x)
+x # => <Variety x: 12345, y: 2, pary: [], foo: B(2)>
+```
 
 # Why?
 
@@ -82,13 +108,17 @@ desired namespace. (i.e. App::Foo::Bar)
 
 Source:
 
-    $ git clone git://github.com/bmizerany/beefcake
+    $ git clone https://github.com/protobuf-ruby/beefcake.git
 
 ## Testing:
 
-    $ gem install turn
-    $ cd /path/to/beefcake
-    $ turn
+    $ 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).
+
+All pull requests automatically trigger a build request.  Please ensure that
+tests succeed.
 
 ## VMs:
 
@@ -97,6 +127,7 @@ 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
 
@@ -110,11 +141,12 @@ Currently Beefcake is tested and working on:
 * Varint fields
 * 32-bit fields
 * 64-bit fields
-* Length delemited fields
-* Embeded Messages
+* 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

data/RELEASE_NOTES.md

@@ -0,0 +1,15 @@
+# Beefcake Release Notes
+
+# 0.4.0 - 2013-10-10
+
+Release 0.4.0 is the first with new maintainers.
+
+* Modernize tests
+* Add Travis CI monitoring
+* Support varint-encoded length-delimited buffers
+* Support generation with recursive definitions
+* Support Ruby 2.0
+* Support encoded buffers
+* Support false but non-nil values
+* Support top-level enums, added by Kim Altintop:
+  https://github.com/protobuf-ruby/beefcake/pull/23

data/Rakefile

@@ -1,2 +1,12 @@
-require 'bundler'
+require 'rake'
+require 'rake/testtask'
+require 'bundler/gem_tasks'
 Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/beefcake.gemspec

@@ -6,11 +6,12 @@ Gem::Specification.new do |s|
   s.name        = "beefcake"
   s.version     = Beefcake::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Blake Mizerany"]
-  s.email       = ["blake.mizerany@gmail.com"]
-  s.homepage    = ""
+  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.license     = 'MIT'
 
   s.rubyforge_project = "beefcake"
 
@@ -18,4 +19,6 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+
+  s.add_development_dependency('rake', '10.1.0')
 end

data/lib/beefcake.rb

@@ -106,6 +106,20 @@ module Beefcake
         buf
       end
 
+      def write_delimited(buf = Buffer.new)
+        if ! buf.respond_to?(:<<)
+          raise ArgumentError, "buf doesn't respond to `<<`"
+        end
+
+        if ! buf.is_a?(Buffer)
+          buf = Buffer.new(buf)
+        end
+
+        buf.append_bytes(encode)
+
+        buf
+      end
+
       def valid_enum?(mod, val)
         !!name_for(mod, val)
       end
@@ -180,6 +194,17 @@ module Beefcake
 
         o
       end
+
+      def read_delimited(buf, o=self.new)
+        if ! buf.is_a?(Buffer)
+          buf = Buffer.new(buf)
+        end
+
+        n = buf.read_int64
+        tmp = Buffer.new(buf.read(n))
+
+        decode(tmp, o)
+      end
     end
 
 
@@ -234,8 +259,9 @@ module Beefcake
 
     def to_hash
       fields.values.inject({}) do |h, fld|
-        if v = self[fld.name]
-          h[fld.name] = v
+        value = self[fld.name]
+        unless value.nil?
+          h[fld.name] = value
         end
         h
       end

data/lib/beefcake/buffer/base.rb

@@ -77,6 +77,7 @@ module Beefcake
     end
 
     def <<(bytes)
+      bytes = bytes.force_encoding('BINARY') if bytes.respond_to? :force_encoding
       buf << bytes
     end
 

data/lib/beefcake/buffer/encode.rb

@@ -105,8 +105,14 @@ module Beefcake
     end
 
     def append_string(s)
-      append_uint64(s.length)
-      self << s
+      actual_string = s.to_s
+      if actual_string.respond_to? :force_encoding
+        encoded = actual_string.force_encoding 'binary'
+      else
+        encoded = actual_string
+      end
+      append_uint64(encoded.length)
+      self << encoded
     end
     alias :append_bytes :append_string
 

data/lib/beefcake/generator.rb

@@ -109,7 +109,8 @@ class CodeGeneratorRequest
     optional :name, :string, 1       # file name, relative to root of source tree
     optional :package, :string, 2    # e.g. "foo", "foo.bar", etc.
 
-    repeated :message_type, DescriptorProto, 4;
+    repeated :message_type, DescriptorProto,     4;
+    repeated :enum_type,    EnumDescriptorProto, 5;
   end
 
 
@@ -161,14 +162,6 @@ module Beefcake
       @n = 0
     end
 
-    def file!(file)
-      puts "## Generated from #{file.name} for #{file.package}"
-
-      file.message_type.each do |mt|
-        message!("", mt)
-      end
-    end
-
     def indent(&blk)
       @n += 1
       blk.call
@@ -179,35 +172,48 @@ module Beefcake
       @n = n
     end
 
-    def message!(pkg, mt)
+    def define!(mt)
       puts
       puts "class #{mt.name}"
 
       indent do
         puts "include Beefcake::Message"
-        puts
 
+        ## Enum Types
         Array(mt.enum_type).each do |et|
           enum!(et)
         end
 
+        ## Nested Types
+        Array(mt.nested_type).each do |nt|
+          define!(nt)
+        end
+      end
+      puts "end"
+    end
+
+    def message!(pkg, mt)
+      puts
+      puts "class #{mt.name}"
+
+      indent do
         ## Generate Types
         Array(mt.nested_type).each do |nt|
           message!(pkg, nt)
         end
-        puts
 
-        ## Generate fields
+        ## Generate Fields
         Array(mt.field).each do |f|
           field!(pkg, f)
         end
-        puts
       end
 
       puts "end"
+      puts
     end
 
     def enum!(et)
+      puts
       puts "module #{et.name}"
       indent do
         et.value.each do |v|
@@ -229,7 +235,9 @@ module Beefcake
         # We have a type_name so we will use it after converting to a
         # Ruby friendly version
         t = f.type_name
-        t = t.gsub(pkg, "") # Remove the leading package name
+        if pkg
+          t = t.gsub(pkg, "") # Remove the leading package name
+        end
         t = t.gsub(/^\.*/, "")       # Remove leading `.`s
 
         t.gsub(".", "::")  # Convert to Ruby namespacing syntax
@@ -267,6 +275,14 @@ module Beefcake
       puts
 
       ns!(ns) do
+        Array(file.enum_type).each do |et|
+          enum!(et)
+        end
+
+        file.message_type.each do |mt|
+          define! mt
+        end
+
         file.message_type.each do |mt|
           message!(file.package, mt)
         end

data/lib/beefcake/version.rb

@@ -1,3 +1,3 @@
 module Beefcake
-  VERSION = "0.3.7"
+  VERSION = "0.4.0"
 end

data/test/buffer_decode_test.rb

@@ -1,3 +1,4 @@
+require 'test/unit'
 require 'beefcake/buffer'
 
 class BufferDecodeTest < Test::Unit::TestCase

data/test/buffer_encode_test.rb

@@ -1,3 +1,5 @@
+# encoding: ASCII-8BIT
+require 'test/unit'
 require 'beefcake/buffer/encode'
 
 class BufferEncodeTest < Test::Unit::TestCase

data/test/buffer_test.rb

@@ -1,3 +1,4 @@
+require 'test/unit'
 require 'beefcake/buffer'
 
 class BufferTest < Test::Unit::TestCase

data/test/generator_test.rb

@@ -1,3 +1,4 @@
+require 'test/unit'
 require 'beefcake/generator'
 
 class GeneratorTest < Test::Unit::TestCase

data/test/message_test.rb

@@ -1,3 +1,4 @@
+require 'test/unit'
 require 'beefcake'
 
 class NumericsMessage
@@ -165,6 +166,20 @@ class MessageTest < Test::Unit::TestCase
     assert_equal "\b{", str
   end
 
+  def test_delimited_end_to_end
+    msg = SimpleMessage.new :a => 123, :b => "hi mom!"
+    str = ""
+
+    1000.times do
+      msg.write_delimited(str)
+    end
+
+    1000.times do
+      dec = SimpleMessage.read_delimited(str)
+      assert_equal msg, dec
+    end
+  end
+
   def test_encode_enum
     buf = Beefcake::Buffer.new
     buf.append(:int32, 2, 1)
@@ -375,4 +390,14 @@ class MessageTest < Test::Unit::TestCase
     assert_equal(exp, msg.to_hash)
   end
 
+  def test_bool_to_hash
+    true_message = BoolMessage.new :bool => true
+    true_expectation = { :bool => true }
+    assert_equal true_expectation, true_message.to_hash
+
+    false_message = BoolMessage.new :bool => false
+    false_expectation = { :bool => false }
+    assert_equal false_expectation, false_message.to_hash
+  end
+
 end

metadata

@@ -1,38 +1,47 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: beefcake
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 7
-  version: 0.3.7
+version: !ruby/object:Gem::Version
+  version: 0.4.0
 platform: ruby
-authors: 
+authors:
 - Blake Mizerany
+- Matt Proud
+- Bryce Kerley
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-29 00:00:00 -07:00
-default_executable: 
-dependencies: []
-
+date: 2013-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.1.0
 description: A sane protobuf library for Ruby
-email: 
+email:
 - blake.mizerany@gmail.com
-executables: 
+- matt.proud@gmail.com
+- bkerley@brycekerley.net
+executables:
 - protoc-gen-beefcake
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
+- RELEASE_NOTES.md
 - Rakefile
 - beefcake.gemspec
 - bench/simple.rb
@@ -50,41 +59,31 @@ files:
 - test/buffer_test.rb
 - test/generator_test.rb
 - test/message_test.rb
-has_rdoc: true
-homepage: ""
-licenses: []
-
+homepage: https://github.com/protobuf-ruby/beefcake
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: beefcake
-rubygems_version: 1.5.2
+rubygems_version: 2.1.4
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A sane protobuf library for Ruby
-test_files: 
+test_files:
 - test/buffer_decode_test.rb
 - test/buffer_encode_test.rb
 - test/buffer_test.rb