beefcake 0.5.0 → 1.0.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c8b59ed31faa70fbb239a3e2409237196ce148f
-  data.tar.gz: 8a67dfdb73a449209b12e359ea07e1d3703afb46
+  metadata.gz: 9b7cab784e70b3c3800d45d9d109687848a2d429
+  data.tar.gz: e00c7156ab112921ec2ad56e412a4121e9106f52
 SHA512:
-  metadata.gz: af0890820ca418b3207f8670027eb905b6453e583b590fefaf8a9f28ce6da221e5110a4f6fdaf52750083ab2675d5d5492238a30547521d63fbb130c3b2af146
-  data.tar.gz: 01a872f9dcbd8f182639b3a054ab10f818f57565d700baa38e46c4fd2adc61abe47ddfdd055f0f934cfa79df26f59593392d56c6bc4c17080195012815180119
+  metadata.gz: 3c4c02406d0afc4bf7cd3788c7387bae133264167371ff530eee11d4b9565ef1595824247a9556e4409354cbc1e741829e99e216bc175804afc3285498f60447
+  data.tar.gz: 3219554a0b7023643d795ebd5cd21cb3c89da8669b7d5a5d1eb1920a4ba8904c1291be1ba120be01852679f8ebcfa9b1253e10350d430305aa6827f1f30335e2

data/.gitignore

@@ -1,2 +1,3 @@
 *.gem
 Gemfile.lock
+bench/beefcake.prof.*

data/.travis.yml

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

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in beefcake.gemspec
 gemspec

data/README.md

@@ -141,7 +141,7 @@ http://code.google.com/apis/protocolbuffers/docs/encoding.html
     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).
+The current build status for HEAD is [![Build Status](https://travis-ci.org/protobuf-ruby/beefcake.png?branch=master)](https://travis-ci.org/protobuf-ruby/beefcake).
 
 All pull requests automatically trigger a build request.  Please ensure that
 tests succeed.

data/Rakefile

@@ -4,7 +4,7 @@ require 'bundler/gem_tasks'
 Bundler::GemHelper.install_tasks
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
+  t.libs << 'minitest'
   t.test_files = FileList['test/*_test.rb']
   t.verbose = true
 end

data/beefcake.gemspec

@@ -13,12 +13,13 @@ Gem::Specification.new do |s|
   s.description = %q{A sane protobuf library for Ruby}
   s.license     = 'MIT'
 
-  s.rubyforge_project = "beefcake"
-
   s.files         = `git ls-files`.split("\n")
   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')
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_development_dependency('rake', '~> 10.1.0')
+  s.add_development_dependency('minitest', '~> 5.3')
 end

data/bench/simple.rb

@@ -10,7 +10,10 @@ class MyMessage
   required :float,  :float,  5
 end
 
-if ARGV[0] == 'pprof'
+ITERS = 100_000
+
+case ARGV[0]
+when 'pprof'
   # profile message creation/encoding/decoding w/ perftools.rb
   # works on 1.8 and 1.9
   #   ruby bench/simple.rb pprof
@@ -20,7 +23,7 @@ if ARGV[0] == 'pprof'
   require 'rubygems'
   require 'perftools'
   PerfTools::CpuProfiler.start(File.expand_path("../beefcake.prof", __FILE__)) do
-    100_000.times do
+    ITERS.times do
       str = MyMessage.new(
         :number => 12345,
         :chars  => 'hello',
@@ -35,6 +38,31 @@ if ARGV[0] == 'pprof'
     `pprof.rb beefcake.prof --gif > beefcake.prof.gif`
   end
 
+when 'ruby-prof'
+  # profile message creation/encoding/decoding w/ ruby-prof
+  # works on 1.8 and 1.9
+  #   ruby bench/simple.rb ruby-prof
+  #   open bench/beefcake.prof.html
+
+  require 'ruby-prof'
+  result = RubyProf.profile do
+    ITERS.times do
+      str = MyMessage.new(
+        :number => 12345,
+        :chars  => 'hello',
+        :raw    => 'world',
+        :bool   => true,
+        :float  => 1.2345
+      ).encode
+      MyMessage.decode(str)
+    end
+  end
+
+  filename = File.expand_path('beefcake.prof.html', File.dirname(__FILE__))
+  File.open(filename, 'w') do |file|
+    RubyProf::GraphHtmlPrinter.new(result).print(file)
+  end
+
 else
   # benchmark message creation/encoding/decoding
   #   rvm install 1.8.7 1.9.2 jruby rbx
@@ -42,8 +70,6 @@ else
 
   require 'benchmark'
 
-  ITERS = 100_000
-
   Benchmark.bmbm do |x|
     x.report 'object creation' do
       ITERS.times do

data/lib/beefcake.rb

@@ -23,6 +23,11 @@ module Beefcake
       end
     end
 
+    class DuplicateFieldNumber < StandardError
+      def initialize(num, name)
+        super("Field number #{num} (#{name}) was already used")
+      end
+    end
 
     class Field < Struct.new(:rule, :name, :type, :fn, :opts)
       def <=>(o)
@@ -45,6 +50,9 @@ module Beefcake
       end
 
       def field(rule, name, type, fn, opts)
+        if fields.include?(fn)
+          raise DuplicateFieldNumber.new(fn, name)
+        end
         fields[fn] = Field.new(rule, name, type, fn, opts)
         attr_accessor name
       end
@@ -69,7 +77,7 @@ module Beefcake
 
         # TODO: Error if any required fields at nil
 
-        fields.values.sort.each do |fld|
+        __beefcake_fields__.values.sort.each do |fld|
           if fld.opts[:packed]
             bytes = encode!(Buffer.new, fld, 0)
             buf.append_info(fld.fn, Buffer.wire_for(fld.type))
@@ -134,7 +142,7 @@ module Beefcake
       end
 
       def validate!
-        fields.values.each do |fld|
+        __beefcake_fields__.values.each do |fld|
           if fld.rule == :required && self[fld.name].nil?
             raise RequiredFieldNotSetError, fld.name
           end
@@ -217,12 +225,12 @@ module Beefcake
     end
 
     def initialize(attrs={})
-      fields.values.each do |fld|
+      __beefcake_fields__.values.each do |fld|
         self[fld.name] = attrs[fld.name]
       end
     end
 
-    def fields
+    def __beefcake_fields__
       self.class.fields
     end
 
@@ -236,11 +244,12 @@ module Beefcake
 
     def ==(o)
       return false if (o == nil) || (o == false)
-      fields.values.all? {|fld| self[fld.name] == o[fld.name] }
+      return false unless o.is_a? self.class
+      __beefcake_fields__.values.all? {|fld| self[fld.name] == o[fld.name] }
     end
 
     def inspect
-      set = fields.values.select {|fld| self[fld.name] != nil }
+      set = __beefcake_fields__.values.select {|fld| self[fld.name] != nil }
 
       flds = set.map do |fld|
         val = self[fld.name]
@@ -260,7 +269,7 @@ module Beefcake
     end
 
     def to_hash
-      fields.values.inject({}) do |h, fld|
+      __beefcake_fields__.values.inject({}) do |h, fld|
         value = self[fld.name]
         unless value.nil?
           h[fld.name] = value

data/lib/beefcake/buffer/base.rb

@@ -3,31 +3,42 @@ module Beefcake
   class Buffer
 
     MinUint32 =  0
-    MaxUint32 =  (1<<32)-1
-    MinInt32  = -(1<<31)
-    MaxInt32  =  (1<<31)-1
+    MaxUint32 =  (1 << 32)-1
+    MinInt32  = -(1 << 31)
+    MaxInt32  =  (1 << 31)-1
 
     MinUint64 =  0
-    MaxUint64 =  (1<<64)-1
-    MinInt64  = -(1<<63)
-    MaxInt64  =  (1<<63)-1
+    MaxUint64 =  (1 << 64)-1
+    MinInt64  = -(1 << 63)
+    MaxInt64  =  (1 << 63)-1
+
+    WIRES = {
+      :int32    => 0,
+      :uint32   => 0,
+      :sint32   => 0,
+      :int64    => 0,
+      :uint64   => 0,
+      :sint64   => 0,
+      :bool     => 0,
+      :fixed64  => 1,
+      :sfixed64 => 1,
+      :double   => 1,
+      :string   => 2,
+      :bytes    => 2,
+      :fixed32  => 5,
+      :sfixed32 => 5,
+      :float    => 5,
+    }
 
     def self.wire_for(type)
-      case type
-      when Class
-        if encodable?(type)
-          2
-        else
-          raise UnknownType, type
-        end
-      when :int32, :uint32, :sint32, :int64, :uint64, :sint64, :bool, Module
-        0
-      when :fixed64, :sfixed64, :double
-        1
-      when :string, :bytes
+      wire = WIRES[type]
+
+      if wire
+        wire
+      elsif Class === type && encodable?(type)
         2
-      when :fixed32, :sfixed32, :float
-        5
+      elsif Module === type
+        0
       else
         raise UnknownType, type
       end
@@ -35,11 +46,10 @@ module Beefcake
 
     def self.encodable?(type)
       return false if ! type.is_a?(Class)
-      pims = type.public_instance_methods
-      pims.include?(:encode) || pims.include?("encode")
+      type.public_method_defined?(:encode)
     end
 
-    attr_accessor :buf
+    attr_reader :buf
 
     alias :to_s   :buf
     alias :to_str :buf
@@ -66,14 +76,14 @@ module Beefcake
       self.buf = buf
     end
 
-    if ''.respond_to?(:force_encoding)
-      def buf=(buf)
-        @buf = buf.force_encoding('BINARY')
-      end
+    def buf=(new_buf)
+      @buf = new_buf.force_encoding('BINARY')
+      @cursor = 0
     end
 
     def length
-      @buf.respond_to?(:bytesize) ? @buf.bytesize : @buf.length
+      remain = buf.slice(@cursor..-1)
+      remain.bytesize
     end
 
     def <<(bytes)
@@ -90,7 +100,9 @@ module Beefcake
       when Module
         read_uint64
       else
-        buf.slice!(0, n)
+        read_slice = buf.byteslice(@cursor, n)
+        @cursor += n
+        return read_slice
       end
     end
 

data/lib/beefcake/buffer/decode.rb

@@ -43,12 +43,7 @@ module Beefcake
         if shift >= 64
           raise BufferOverflowError, "varint"
         end
-        b = buf.slice!(0)
-
-        ## 1.8.6 to 1.9 Compat
-        if b.respond_to?(:ord)
-          b = b.ord
-        end
+        b = read(1).ord
 
         n |= ((b & 0x7F) << shift)
         shift += 7

data/lib/beefcake/buffer/encode.rb

@@ -106,11 +106,7 @@ module Beefcake
 
     def append_string(s)
       actual_string = thaw_string s
-      if actual_string.respond_to? :force_encoding
-        encoded = actual_string.force_encoding 'binary'
-      else
-        encoded = actual_string
-      end
+      encoded = actual_string.force_encoding 'binary'
       append_uint64(encoded.length)
       self << encoded
     end

data/lib/beefcake/version.rb

@@ -1,3 +1,3 @@
 module Beefcake
-  VERSION = "0.5.0"
+  VERSION = "1.0.0.pre2"
 end

data/test/benchmark_test.rb

@@ -0,0 +1,42 @@
+require 'minitest/autorun'
+require 'minitest/benchmark'
+require 'beefcake'
+
+class Inner
+  include Beefcake::Message
+
+  required :content, :string, 1
+end
+
+class Outer
+  include Beefcake::Message
+
+  repeated :inner, Inner, 1
+end
+
+class BenchmarkTest < Minitest::Benchmark
+  def setup
+    @buf = Beefcake::Buffer.new
+  end
+
+  def bench_read_string
+    assert_performance_linear 0.75 do |n|
+      candidate = 'x' * (n * 1_000)
+      @buf.append_string candidate
+      assert_equal candidate, @buf.read_string
+    end
+  end
+
+  def bench_decode
+    assert_performance_linear 0.75 do |n|
+      inners = n.times.map{ Inner.new :content => 'x' * 100 }
+      outer = Outer.new :inner => inners
+
+      encoded = outer.encode.to_s
+
+      decoded = Outer.decode encoded
+
+      assert_equal n, decoded.inner.length
+    end
+  end
+end

data/test/buffer_decode_test.rb

@@ -1,7 +1,7 @@
-require 'test/unit'
+require 'minitest/autorun'
 require 'beefcake/buffer'
 
-class BufferDecodeTest < Test::Unit::TestCase
+class BufferDecodeTest < Minitest::Test
 
   B = Beefcake::Buffer
 

data/test/buffer_encode_test.rb

@@ -1,8 +1,8 @@
 # encoding: ASCII-8BIT
-require 'test/unit'
+require 'minitest/autorun'
 require 'beefcake/buffer/encode'
 
-class BufferEncodeTest < Test::Unit::TestCase
+class BufferEncodeTest < Minitest::Test
 
   B = Beefcake::Buffer
 
@@ -211,9 +211,14 @@ class BufferEncodeTest < Test::Unit::TestCase
     assert_equal "\376\377\377\377\377\377\377\377", @buf.to_s
   end
 
-  def test_append_string
-    @buf.append_string("testing")
-    assert_equal "\007testing", @buf.to_s
+  def test_append_unicode_string
+    ingest = "\u{1f63a}" * 5
+    assert_equal 5, ingest.chars.to_a.length
+    expected = ingest.bytes.to_a.length.chr + ingest
+    @buf.append_string(ingest)
+    actual = @buf.to_s
+    assert_equal expected.bytes.to_a.length, actual.bytes.to_a.length
+    assert_equal expected.bytes.to_a, actual.bytes.to_a
   end
 
   def test_append_bytes

data/test/buffer_test.rb

@@ -1,7 +1,7 @@
-require 'test/unit'
+require 'minitest/autorun'
 require 'beefcake/buffer'
 
-class BufferTest < Test::Unit::TestCase
+class BufferTest < Minitest::Test
 
   def setup
     @buf = Beefcake::Buffer.new

data/test/generator_test.rb

@@ -1,7 +1,7 @@
-require 'test/unit'
+require 'minitest/autorun'
 require 'beefcake/generator'
 
-class GeneratorTest < Test::Unit::TestCase
+class GeneratorTest < Minitest::Test
 
   def setup
     # Load up the generator request for the addressbook.proto example
@@ -39,11 +39,7 @@ class GeneratorTest < Test::Unit::TestCase
   # Encoding::CompatibilityError: incompatible character encodings: ASCII-8BIT and US-ASCII
   def test_encode_decode_generated_response
     @res = Beefcake::Generator.compile([], @req)
-    assert_nothing_raised { @res.encode }
-  end
 
-  def test_encode_decode_generated_response
-    @res = Beefcake::Generator.compile([], @req)
     assert_equal(CodeGeneratorResponse, @res.class)
 
     round_trip = CodeGeneratorResponse.decode(@res.encode)

data/test/message_test.rb

@@ -1,4 +1,4 @@
-require 'test/unit'
+require 'minitest/autorun'
 require 'beefcake'
 
 class NumericsMessage
@@ -96,7 +96,13 @@ class LargeFieldNumberMessage
   required :field_2, :string, 100
 end
 
-class MessageTest < Test::Unit::TestCase
+class FieldsMessage
+  include Beefcake::Message
+
+  repeated :fields, :string, 1
+end
+
+class MessageTest < Minitest::Test
   B = Beefcake::Buffer
 
   ## Encoding
@@ -258,6 +264,11 @@ class MessageTest < Test::Unit::TestCase
     assert_equal buf.to_s, msg.encode.to_s
   end
 
+  def test_encode_unknown_field
+    msg = SimpleMessage.new :mystery_field => 'asdf'
+    msg.encode.to_s
+  end
+
   ## Decoding
   def test_decode_numerics
     msg = NumericsMessage.new({
@@ -276,7 +287,7 @@ class MessageTest < Test::Unit::TestCase
 
     got = NumericsMessage.decode(msg.encode)
 
-    msg.fields.values.each do |fld|
+    msg.__beefcake_fields__.values.each do |fld|
       assert_equal msg[fld.name], got[fld.name], fld.name
     end
   end
@@ -357,7 +368,14 @@ class MessageTest < Test::Unit::TestCase
     b = SimpleMessage.new :a => 1
     assert_equal a, b
     c = SimpleMessage.new :a => 2
-    assert_not_equal b, c
+    refute_equal b, c
+
+    d = EnumsMessage.new :a => 5
+    e = EnumsDefaultMessage.new :a => 5
+
+    refute_equal d, e
+    refute_equal d, :symbol
+    refute_equal :symbol, d
   end
 
   def test_inspect
@@ -394,6 +412,17 @@ class MessageTest < Test::Unit::TestCase
     assert_equal(exp, msg.to_hash)
   end
 
+  def test_duplicate_index
+    assert_raises Beefcake::Message::DuplicateFieldNumber do
+      Class.new do
+        include Beefcake::Message
+
+        required :clever_name, :int32, 1
+        required :naughty_field, :string, 1
+      end
+    end
+  end
+
   def test_bool_to_hash
     true_message = BoolMessage.new :bool => true
     true_expectation = { :bool => true }
@@ -404,4 +433,14 @@ class MessageTest < Test::Unit::TestCase
     assert_equal false_expectation, false_message.to_hash
   end
 
+  def test_fields_named_fields
+    contents = %w{fields named fields}
+    msg = FieldsMessage.new fields: contents
+    assert_equal 1, msg.__beefcake_fields__.length
+    assert_equal contents, msg.fields
+
+    assert_equal msg, FieldsMessage.decode(msg.encode)
+
+    assert_equal "<FieldsMessage fields: [\"fields\", \"named\", \"fields\"]>", msg.inspect
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beefcake
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0.pre2
 platform: ruby
 authors:
 - Blake Mizerany
@@ -10,22 +10,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-20 00:00:00.000000000 Z
+date: 2014-06-16 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
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
 description: A sane protobuf library for Ruby
 email:
 - blake.mizerany@gmail.com
@@ -36,8 +50,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -54,6 +68,7 @@ files:
 - lib/beefcake/buffer/encode.rb
 - lib/beefcake/generator.rb
 - lib/beefcake/version.rb
+- test/benchmark_test.rb
 - test/buffer_decode_test.rb
 - test/buffer_encode_test.rb
 - test/buffer_test.rb
@@ -69,21 +84,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      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: beefcake
-rubygems_version: 2.0.14
+rubyforge_project: 
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A sane protobuf library for Ruby
 test_files:
+- test/benchmark_test.rb
 - test/buffer_decode_test.rb
 - test/buffer_encode_test.rb
 - test/buffer_test.rb