beefcake 0.1.0

data/test/buffer_test.rb

@@ -0,0 +1,44 @@
+require 'beefcake/buffer'
+
+class BufferTest < Test::Unit::TestCase
+
+  def setup
+    @buf = Beefcake::Buffer.new
+  end
+
+  def test_simple
+    assert_equal "", @buf.to_s
+
+    @buf << "asdf"
+    assert_equal "asdf", @buf.to_s
+    assert_equal "asdf", @buf.to_str
+
+    @buf.buf = ""
+    assert_equal "", @buf.to_s
+  end
+
+  def test_wire_for
+    assert_equal 0, Beefcake::Buffer.wire_for(:int32)
+    assert_equal 0, Beefcake::Buffer.wire_for(:uint32)
+    assert_equal 0, Beefcake::Buffer.wire_for(:sint32)
+    assert_equal 0, Beefcake::Buffer.wire_for(:int64)
+    assert_equal 0, Beefcake::Buffer.wire_for(:uint64)
+    assert_equal 0, Beefcake::Buffer.wire_for(:sint64)
+
+    assert_equal 1, Beefcake::Buffer.wire_for(:fixed64)
+    assert_equal 1, Beefcake::Buffer.wire_for(:sfixed64)
+    assert_equal 1, Beefcake::Buffer.wire_for(:double)
+
+    assert_equal 2, Beefcake::Buffer.wire_for(:string)
+    assert_equal 2, Beefcake::Buffer.wire_for(:bytes)
+
+    assert_equal 5, Beefcake::Buffer.wire_for(:fixed32)
+    assert_equal 5, Beefcake::Buffer.wire_for(:sfixed32)
+    assert_equal 5, Beefcake::Buffer.wire_for(:float)
+
+    assert_raises Beefcake::Buffer::UnknownType do
+      Beefcake::Buffer.wire_for(:asdf)
+    end
+  end
+
+end

data/test/message_test.rb

@@ -0,0 +1,280 @@
+require 'beefcake'
+
+class NumericsMessage
+  include Beefcake::Message
+
+  required :int32,    :int32,    1
+  required :uint32,   :uint32,   2
+  required :sint32,   :sint32,   3
+  required :fixed32,  :fixed32,  4
+  required :sfixed32, :sfixed32, 5
+
+  required :int64,    :int64,    6
+  required :uint64,   :uint64,   7
+  required :sint64,   :sint64,   8
+  required :fixed64,  :fixed64,  9
+  required :sfixed64, :sfixed64, 10
+end
+
+
+class LendelsMessage
+  include Beefcake::Message
+
+  required :string, :string, 1
+  required :bytes,  :bytes,  2
+end
+
+
+class SimpleMessage
+  include Beefcake::Message
+
+  optional :a, :int32, 1
+end
+
+
+class CompositeMessage
+  include Beefcake::Message
+
+  required :encodable, SimpleMessage, 1
+end
+
+
+class EnumsMessage
+  include Beefcake::Message
+
+  module X
+    A = 1
+  end
+
+  required :a, X, 1
+end
+
+
+class EnumsDefaultMessage
+  include Beefcake::Message
+
+  module X
+    A = 1
+    B = 2
+  end
+
+  optional :a, X, 1, :default => X::B
+end
+
+
+class RepeatedMessage
+  include Beefcake::Message
+
+  repeated :a, :int32, 1
+end
+
+
+class PackedRepeatedMessage
+  include Beefcake::Message
+
+  repeated :a, :int32, 1, :packed => true
+end
+
+
+class MessageTest < Test::Unit::TestCase
+  B = Beefcake::Buffer
+
+  ## Encoding
+  def test_encode_numerics
+    buf = Beefcake::Buffer.new
+
+    buf.append(:int32, B::MaxInt32, 1)
+    buf.append(:uint32, B::MaxUint32, 2)
+    buf.append(:sint32, B::MinInt32, 3)
+    buf.append(:fixed32, B::MaxInt32, 4)
+    buf.append(:sfixed32, B::MinInt32, 5)
+    buf.append(:int64, B::MaxInt64, 6)
+    buf.append(:uint64, B::MaxUint64, 7)
+    buf.append(:sint64, B::MinInt64, 8)
+    buf.append(:fixed64, B::MaxInt64, 9)
+    buf.append(:sfixed64, B::MinInt64, 10)
+
+    msg = NumericsMessage.new({
+      :int32     => B::MaxInt32,
+      :uint32    => B::MaxUint32,
+      :sint32    => B::MinInt32,
+      :fixed32   => B::MaxInt32,
+      :sfixed32  => B::MinInt32,
+
+      :int64     => B::MaxInt64,
+      :uint64    => B::MaxUint64,
+      :sint64    => B::MinInt64,
+      :fixed64   => B::MaxInt64,
+      :sfixed64  => B::MinInt64
+    })
+
+    assert_equal buf.to_s, msg.encode.to_s
+  end
+
+  def test_encode_strings
+    buf = Beefcake::Buffer.new
+
+    buf.append(:string, "testing", 1)
+    buf.append(:bytes, "unixisawesome", 2)
+
+    msg = LendelsMessage.new({
+      :string => "testing",
+      :bytes  => "unixisawesome"
+    })
+
+    assert_equal buf.to_s, msg.encode.to_s
+  end
+
+  def test_encode_string_composite
+    buf1 = Beefcake::Buffer.new
+    buf1.append(:int32, 123, 1)
+
+    buf2 = Beefcake::Buffer.new
+    buf2.append(:string, buf1, 1)
+
+    msg = CompositeMessage.new(
+      :encodable => SimpleMessage.new(:a => 123)
+    )
+
+    assert_equal buf2.to_s, msg.encode.to_s
+  end
+
+  def test_encode_to_string
+    msg = SimpleMessage.new :a => 123
+    str = ""
+    msg.encode(str)
+    assert_equal "\b{", str
+  end
+
+  def test_encode_enum
+    buf = Beefcake::Buffer.new
+    buf.append(:int32, 2, 1)
+
+    msg = EnumsMessage.new :a => EnumsMessage::X::A
+    assert_equal "\b\001", msg.encode.to_s
+  end
+
+  def test_encode_invalid_enum_value
+    assert_raises Beefcake::Message::InvalidValueError do
+      EnumsMessage.new(:a => 99).encode
+    end
+  end
+
+  def test_encode_unset_required_field
+    assert_raises Beefcake::Message::RequiredFieldNotSetError do
+      NumericsMessage.new.encode
+    end
+  end
+
+  def test_encode_repeated_field
+    buf = Beefcake::Buffer.new
+
+    buf.append(:int32, 1, 1)
+    buf.append(:int32, 2, 1)
+    buf.append(:int32, 3, 1)
+    buf.append(:int32, 4, 1)
+    buf.append(:int32, 5, 1)
+
+    msg = RepeatedMessage.new :a => [1, 2, 3, 4, 5]
+
+    assert_equal buf.to_s, msg.encode.to_s
+  end
+
+  def test_encode_packed_repeated_field
+    buf = Beefcake::Buffer.new
+
+    # Varint
+    buf.append_info(1, 0)
+
+    # Give size in bytes
+    buf.append_uint64 5
+
+    # Values
+    buf.append_int32 1
+    buf.append_int32 2
+    buf.append_int32 3
+    buf.append_int32 4
+    buf.append_int32 5
+
+    msg = PackedRepeatedMessage.new :a => [1, 2, 3, 4, 5]
+
+    assert_equal buf.to_s, msg.encode.to_s
+  end
+
+  ## Decoding
+  def test_decode_numerics
+    msg = NumericsMessage.new({
+      :int32     => B::MaxInt32,
+      :uint32    => B::MaxUint32,
+      :sint32    => B::MinInt32,
+      :fixed32   => B::MaxInt32,
+      :sfixed32  => B::MinInt32,
+
+      :int64     => B::MaxInt64,
+      :uint64    => B::MaxUint64,
+      :sint64    => B::MinInt64,
+      :fixed64   => B::MaxInt64,
+      :sfixed64  => B::MinInt64
+    })
+
+    got = NumericsMessage.decode(msg.encode)
+
+    msg.fields.values.each do |fld|
+      assert_equal msg[fld.name], got[fld.name], fld.name
+    end
+  end
+
+  def test_wire_does_not_match_decoded_info
+    buf = Beefcake::Buffer.new
+    buf.append(:string, "testing", 1)
+
+    assert_raises Beefcake::Message::WrongTypeError do
+      SimpleMessage.decode(buf)
+    end
+  end
+
+  def test_decode_unknown_field_number
+    buf = Beefcake::Buffer.new
+    buf.append(:string, "testing", 2)
+
+    msg = SimpleMessage.decode(buf)
+
+    assert_equal nil, msg.a
+  end
+
+  def test_decode_repeated_field
+    msg = RepeatedMessage.new :a => [1, 2, 3, 4, 5]
+    got = RepeatedMessage.decode(msg.encode)
+
+    assert_equal msg.a, got.a
+  end
+
+  def test_decode_packed_repeated_field
+    msg = PackedRepeatedMessage.new :a => [1, 2, 3, 4, 5]
+    got = PackedRepeatedMessage.decode(msg.encode)
+
+    assert_equal msg.a, got.a
+  end
+
+  def test_decode_merge
+    a = SimpleMessage.new :a => 1
+    b = SimpleMessage.new :a => 2
+
+    x = SimpleMessage.decode(a.encode)
+    SimpleMessage.decode(b.encode, x)
+
+    assert_equal b.a, x.a
+  end
+
+  def test_decode_default
+    got = EnumsDefaultMessage.decode("")
+    assert_equal EnumsDefaultMessage.fields[1].opts[:default], got.a
+  end
+
+  def test_decode_unset_required_fields
+    assert_raises Beefcake::Message::RequiredFieldNotSetError do
+      NumericsMessage.decode("")
+    end
+  end
+
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: beefcake
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Blake Mizerany
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-21 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: crack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 4
+        version: 0.1.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-hmac
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 2
+        version: 0.3.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: contest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
+  type: :development
+  version_requirements: *id003
+description: A sane protobuf library for Ruby
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE
+files: 
+- LICENSE
+- README.md
+- lib/beefcake/buffer/base.rb
+- lib/beefcake/buffer/decode.rb
+- lib/beefcake/buffer/encode.rb
+- lib/beefcake/buffer.rb
+- lib/beefcake.rb
+- test/buffer_decode_test.rb
+- test/buffer_encode_test.rb
+- test/buffer_test.rb
+- test/message_test.rb
+has_rdoc: true
+homepage: http://github.com/bmizerany/beefcake
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Sinatra
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: beefcake
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 2
+summary: A sane protobuf library for Ruby
+test_files: 
+- test/buffer_decode_test.rb
+- test/buffer_encode_test.rb
+- test/buffer_test.rb
+- test/message_test.rb