protopuffs 0.3.0

data/lib/protopuffs/message/wire_type.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+
+module Protopuffs
+  class WireType
+    VARINT = 0
+    FIXED64 = 1
+    LENGTH_DELIMITED = 2
+    START_GROUP = 3
+    END_GROUP = 4
+    FIXED32 = 5
+  end
+end

data/lib/protopuffs/parser/parser.rb

@@ -0,0 +1,24 @@
+module Protopuffs
+
+  # The Protopuffs::Parser module holds wrapper classes that parse input
+  # strings using Treetop. They also set off the building of an abstract
+  # syntax tree from Treetop's parse tree.
+  module Parser
+
+    class ProtocolBufferDescriptor
+      def initialize
+        Treetop.load File.join(File.dirname(__FILE__), "protocol_buffer")
+        @parser = Protopuffs::ProtocolBufferParser.new
+      end
+
+      def parse(input)
+        parse_tree = @parser.parse(input)
+        parse_tree.build
+        parse_tree
+      rescue
+        raise ParseError
+      end
+    end
+
+  end
+end

data/lib/protopuffs/parser/protocol_buffer.treetop

@@ -0,0 +1,124 @@
+module Protopuffs
+  grammar ProtocolBuffer
+
+    rule proto
+      s? proto_entries s? {
+        def messages
+          proto_entries.entries.select { |p| p.respond_to?(:message?) }
+        end
+
+        def build
+          messages.each { |message| message.build }
+        end
+      }
+    end
+
+    rule proto_entries
+      proto_entry rest:(s? proto_entry)* {
+        def entries
+          rest.elements.inject([proto_entry]) { |a, s_and_pe| a << s_and_pe.proto_entry }
+        end
+      }
+    end
+
+    rule proto_entry
+      message {
+        def message?
+          true
+        end
+      }
+    end
+
+    rule message
+      "message" s identifier s "{" s? body:message_body? s? "}" {
+        def name
+          identifier.text_value
+        end
+        
+        def build
+          Message::Base.define_message_class(name, body.empty? ? [] : body.build)
+        end
+      }
+    end
+
+    rule message_body
+      field rest:(s? field)* {
+        def fields
+          rest.elements.inject([field]) { |a, s_and_field| a << s_and_field.field }
+        end
+
+        def build
+          fields.map { |field| field.build }
+        end
+      }
+    end
+
+    rule field
+      modifier s type s identifier s "=" s integer s? option:field_option? ";" {
+        def default
+          option.empty? ? nil : option.literal.obj
+        end
+
+        def build
+          MessageField.factory(type.text_value, modifier.text_value, identifier.text_value,
+                               integer.text_value.to_i, default)
+        end
+      }
+    end
+
+    rule field_option
+      "[" s? "default" s? "=" s? literal s? "]"
+    end
+
+    rule modifier
+      "required" / "optional" / "repeated"
+    end
+
+    rule type
+      "double" / "float" / "int32" / "int64" / "uint32" / "uint64" /
+      "sint32" / "sint64" / "fixed32" / "fixed64" / "sfixed32" /
+      "sfixed64" / "bool" / "string" / "bytes" / identifier
+    end
+
+    rule literal
+      integer / string
+    end
+
+    rule integer
+      [\d]+ {
+        def obj
+          text_value.to_i
+        end
+      }
+    end
+
+    rule string
+      quote chars:[\w]* quote {
+        def obj
+          chars.text_value
+        end
+      }
+    end
+
+    rule quote
+      ["']
+    end
+
+    rule identifier
+      [A-Za-z_] [\w_]*
+    end
+
+    rule s
+      (whitespace / comment_to_eol)+
+    end
+
+    rule comment_to_eol
+      '//' (!"\n" .)*
+    end
+
+    rule whitespace
+      [ \t\n\r]
+    end
+
+  end
+end

data/protopuffs.gemspec

@@ -0,0 +1,78 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{protopuffs}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Kampmeier"]
+  s.date = %q{2009-09-21}
+  s.description = %q{A new implementation of Protocol Buffers in Ruby}
+  s.email = %q{chris@kampers.net}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     ".specification",
+     "LICENSE.txt",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "lib/protopuffs.rb",
+     "lib/protopuffs/message/base.rb",
+     "lib/protopuffs/message/field.rb",
+     "lib/protopuffs/message/wire_type.rb",
+     "lib/protopuffs/parser/parser.rb",
+     "lib/protopuffs/parser/protocol_buffer.treetop",
+     "protopuffs.gemspec",
+     "test/abstract_syntax_tree_test.rb",
+     "test/fixtures/proto/person.proto",
+     "test/message_base_test.rb",
+     "test/message_field_test.rb",
+     "test/parse_tree_test.rb",
+     "test/protopuffs_test.rb",
+     "test/test_helper.rb",
+     "test/text_format_test.rb",
+     "test/wire_format_test.rb"
+  ]
+  s.homepage = %q{http://github.com/chrisk/protopuffs}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{protopuffs}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Sex, drugs, and protocol buffers}
+  s.test_files = [
+    "test/abstract_syntax_tree_test.rb",
+     "test/message_base_test.rb",
+     "test/message_field_test.rb",
+     "test/parse_tree_test.rb",
+     "test/protopuffs_test.rb",
+     "test/test_helper.rb",
+     "test/text_format_test.rb",
+     "test/wire_format_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<treetop>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<treetop>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<treetop>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end

data/test/abstract_syntax_tree_test.rb

@@ -0,0 +1,153 @@
+# encoding: UTF-8
+
+require File.dirname(__FILE__) + '/test_helper'
+
+class AbstractSyntaxTreeTest < Test::Unit::TestCase
+
+  context "a protocol buffer descriptor" do
+    setup do
+      @parser = Protopuffs::Parser::ProtocolBufferDescriptor.new
+    end
+
+    context "with an empty Person message" do
+      setup do
+        @descriptor = "message Person {}"
+      end
+
+      should "create one message class" do
+        Protopuffs::Message::Base.expects(:define_message_class).once.with("Person", [])
+        @parser.parse(@descriptor)
+      end
+
+      should "not create any MessageFields" do
+        Protopuffs::MessageField.expects(:factory).never
+        @parser.parse(@descriptor)
+      end
+    end
+
+
+    context "with two empty messages Apple and Orange" do
+      setup do
+        @descriptor = <<-proto
+          message Apple {}
+          message Orange {}
+        proto
+      end
+
+      should "create two message classes" do
+        Protopuffs::Message::Base.expects(:define_message_class).once.with("Apple", []).in_sequence
+        Protopuffs::Message::Base.expects(:define_message_class).once.with("Orange", []).in_sequence
+        @parser.parse(@descriptor)
+      end
+
+      should "not create any MessageFields" do
+        Protopuffs::MessageField.expects(:factory).never
+        @parser.parse(@descriptor)
+      end
+    end
+
+
+    context "with a Person message including a name field" do
+      setup do
+        @descriptor = <<-proto
+          message Person {
+            required string name = 1;
+          }
+        proto
+      end
+
+      should "create one 'Person' message class with one field" do
+        Protopuffs::Message::Base.expects(:define_message_class).once.with("Person", responds_with(:size, 1))
+        @parser.parse(@descriptor)
+      end
+
+      should "create one MessageField with correct options" do
+        Protopuffs::MessageField.expects(:factory).once.with("string", "required", "name", 1, nil).
+          returns(stub(:tag => 1, :identifier => "name"))
+        @parser.parse(@descriptor)
+      end
+    end
+
+
+    context "with a Person message including three fields" do
+      setup do
+        @descriptor = <<-proto
+          message Person {
+            required string name = 1;
+            required int32 id = 2;
+            optional string email = 3;
+          }
+        proto
+      end
+
+      should "create one 'Person' message class with three fields" do
+        Protopuffs::Message::Base.expects(:define_message_class).once.with("Person", responds_with(:size, 3))
+        @parser.parse(@descriptor)
+      end
+
+      should "create three MessageFields with correct options" do
+        Protopuffs::MessageField.expects(:factory).once.with("string", "required", "name", 1, nil).in_sequence.
+          returns(stub(:tag => 1, :identifier => "name"))
+        Protopuffs::MessageField.expects(:factory).once.with("int32", "required", "id", 2, nil).in_sequence.
+          returns(stub(:tag => 2, :identifier => "id"))
+        Protopuffs::MessageField.expects(:factory).once.with("string", "optional", "email", 3, nil).in_sequence.
+          returns(stub(:tag => 3, :identifier => "email"))
+        @parser.parse(@descriptor)
+      end
+    end
+
+
+    context "with a message including two fields with defaults and one without" do
+      setup do
+        @descriptor = <<-proto
+          message Person {
+            required string name = 1;
+            optional string language = 2 [default = "en"];
+            optional int32 account_code = 3 [default = 0];
+          }
+        proto
+      end
+
+      should "create one 'Person' message class with three fields" do
+        Protopuffs::Message::Base.expects(:define_message_class).once.with("Person", responds_with(:size, 3))
+        @parser.parse(@descriptor)
+      end
+
+      should "create three MessageFields with correct options" do
+        Protopuffs::MessageField.expects(:factory).once.with("string", "required", "name", 1, nil).in_sequence.
+          returns(stub(:tag => 1, :identifier => "name"))
+        Protopuffs::MessageField.expects(:factory).once.with("string", "optional", "language", 2, "en").in_sequence.
+          returns(stub(:tag => 2, :identifier => "language"))
+        Protopuffs::MessageField.expects(:factory).once.with("int32", "optional", "account_code", 3, 0).in_sequence.
+          returns(stub(:tag => 3, :identifier => "account_code"))
+        @parser.parse(@descriptor)
+      end
+    end
+
+
+    context "with a message including a user-typed field" do
+      setup do
+        @descriptor = <<-proto
+          message Person {
+            required string name = 1;
+            repeated Address addresses = 2;
+          }
+        proto
+      end
+
+      should "create one 'Person' message class with two fields" do
+        Protopuffs::Message::Base.expects(:define_message_class).once.with("Person", responds_with(:size, 2))
+        @parser.parse(@descriptor)
+      end
+
+      should "create two MessageFields with correct options" do
+        Protopuffs::MessageField.expects(:factory).once.with("string", "required", "name", 1, nil).in_sequence.
+          returns(stub(:tag => 1, :identifier => "name"))
+        Protopuffs::MessageField.expects(:factory).once.with("Address", "repeated", "addresses", 2, nil).in_sequence.
+          returns(stub(:tag => 2, :identifier => "addresses"))
+        @parser.parse(@descriptor)
+      end
+    end
+  end
+
+end

data/test/fixtures/proto/person.proto

@@ -0,0 +1,5 @@
+message Person {
+  required string name = 1;
+  required int32 id = 2;
+  optional string email = 3;
+}

data/test/message_base_test.rb

@@ -0,0 +1,202 @@
+# encoding: UTF-8
+
+require File.dirname(__FILE__) + '/test_helper'
+
+class MessageBaseTest < Test::Unit::TestCase
+
+  context ".define_message_class using 'Person' and two fields" do
+    should "create a Message::Person class" do
+      fields = [Protopuffs::String.new("optional", "name", 1),
+                Protopuffs::String.new("optional", "address", 2)]
+      Protopuffs::Message::Base.define_message_class("Person", fields)
+      Protopuffs::Message::Person
+    end
+
+    should "create a class with accessors for each field" do
+      fields = [Protopuffs::String.new("optional", "name", 1),
+                Protopuffs::String.new("optional", "address", 2)]
+      Protopuffs::Message::Base.define_message_class("Person", fields)
+      person = Protopuffs::Message::Person.new
+      person.name = "Chris"
+      person.address = "61 Carmelita St."
+      assert_equal person.name, "Chris"
+      assert_equal person.address, "61 Carmelita St."
+    end
+  end
+
+
+  context ".define_message_class with fields that have duplicate tags" do
+    should "raise a Protopuffs::ParseError" do
+      fields = [Protopuffs::Int32.new("optional", "name", 1),
+                Protopuffs::String.new("optional", "address", 1)]
+      assert_raises Protopuffs::ParseError do
+        Protopuffs::Message::Base.define_message_class("Person", fields)
+      end
+    end
+  end
+
+
+  context ".define_message_class with fields that have invalid tags" do
+    should "raise a Protopuffs::ParseError when a tag is too large" do
+      fields = [Protopuffs::Int32.new("optional", "name", 1),
+                Protopuffs::String.new("optional", "address", 536_870_912)]
+      assert_raises Protopuffs::ParseError do
+        Protopuffs::Message::Base.define_message_class("Person", fields)
+      end
+    end
+
+    should "raise a Protopuffs::ParseError when a tag is too small" do
+      fields = [Protopuffs::Int32.new("optional", "name", 0),
+                Protopuffs::String.new("optional", "address", 1)]
+      assert_raises Protopuffs::ParseError do
+        Protopuffs::Message::Base.define_message_class("Person", fields)
+      end
+    end
+
+    should "raise a Protopuffs::ParseError when a tag is reserved" do
+      fields = [Protopuffs::String.new("optional", "name", 19050)]
+      assert_raises Protopuffs::ParseError do
+        Protopuffs::Message::Base.define_message_class("Person", fields)
+      end
+    end
+  end
+
+
+  context ".define_message_class with a message name that's Camel_Scored" do
+    # violates the Google style guide, but the other implementations handle this
+    should "strip the underscore when creating the class" do
+      Protopuffs::Message::Base.define_message_class("User_Image", [])
+      assert !Protopuffs::Message.const_defined?("User_Image")
+      assert Protopuffs::Message.const_defined?("UserImage")
+    end
+
+    context "and an embedded-message field that's Camel_Scored" do
+      should "strip the underscore when instantiating the class of the field" do
+        child_fields = [Protopuffs::String.new("optional", "street", 1)]
+        Protopuffs::Message::Base.define_message_class("User_Address", child_fields)
+        parent_fields = [Protopuffs::Embedded.new("User_Address", "required", "user_address", 1)]
+        Protopuffs::Message::Base.define_message_class("User_Info", parent_fields)
+
+        child = Protopuffs::Message::UserAddress.new(:street => "400 2nd Street")
+        parent = Protopuffs::Message::UserInfo.new(child.to_wire_format)
+
+        assert_equal Protopuffs::Message::UserAddress, parent.user_address.class
+      end
+    end
+  end
+
+
+  should "not allow you to instantiate Message::Base directly" do
+    assert_raises RuntimeError do
+      Protopuffs::Message::Base.new
+    end
+  end
+
+
+  context "comparing messages with #==" do
+    should "return false when the messages have different types" do
+      Protopuffs::Message::Base.define_message_class("Dog", [])
+      Protopuffs::Message::Base.define_message_class("Cat", [])
+      assert_not_equal Protopuffs::Message::Dog.new, Protopuffs::Message::Cat.new
+    end
+
+    should "return false when the messages' fields have different values" do
+      fields = [Protopuffs::String.new("optional", "name", 1)]
+      Protopuffs::Message::Base.define_message_class("Person", fields)
+      alice = Protopuffs::Message::Person.new
+      alice.name = "Alice"
+      bob = Protopuffs::Message::Person.new
+      bob.name = "Bob"
+      assert_not_equal alice, bob
+    end
+
+    should "return true when messages of the same type have the same field values" do
+      fields = [Protopuffs::String.new("optional", "name", 1)]
+      Protopuffs::Message::Base.define_message_class("Sheep", fields)
+      sheep = Protopuffs::Message::Sheep.new
+      sheep.name = "Dolly"
+      sheep2 = Protopuffs::Message::Sheep.new
+      sheep2.name = "Dolly"
+      assert_equal sheep, sheep2
+    end
+  end
+
+
+  context "instantiating a message class" do
+    setup do
+      fields = [Protopuffs::String.new("required", "title", 2)]
+      Protopuffs::Message::Base.define_message_class("Book", fields)
+    end
+
+    should "optionally accept a wire-format encoded IO-style object and populate the fields" do
+      input = StringIO.new([0x12, 0x07, 0x74, 0x65, 0x73, 0x74, 0x69, 0x6E, 0x67].pack("C*"))
+      message = Protopuffs::Message::Book.new(input)
+      assert_equal "testing", message.title
+    end
+
+    should "optionally accept a wire-format encoded string and populate the fields" do
+      input = [0x12, 0x07, 0x74, 0x65, 0x73, 0x74, 0x69, 0x6E, 0x67].pack("C*")
+      message = Protopuffs::Message::Book.new(input)
+      assert_equal "testing", message.title
+    end
+
+    should "not populate the fields if no argument is present" do
+      message = Protopuffs::Message::Book.new
+      assert_nil message.title
+    end
+
+    should "optionally accept a hash of field values and mass-assign them" do
+      message = Protopuffs::Message::Book.new(:title => "testing")
+      assert_equal "testing", message.title
+    end
+  end
+
+
+  context "mass-assignment of field values via #attributes=" do
+    setup do
+      fields = [Protopuffs::String.new("required", "title", 1),
+                Protopuffs::String.new("required", "author", 2),
+                Protopuffs::Int32.new("optional", "edition", 3)]
+      Protopuffs::Message::Base.define_message_class("Book", fields)
+    end
+
+    should "set each field value to the corresponding entry in the argument hash" do
+      message = Protopuffs::Message::Book.new
+      message.attributes = {:title   => "You Shall Know Our Velocity",
+                            :author  => "Dave Eggers",
+                            :edition => 2}
+      assert_equal "You Shall Know Our Velocity", message.title
+      assert_equal "Dave Eggers", message.author
+      assert_equal 2, message.edition
+    end
+
+    should "ignore unknown fields in the argument hash" do
+      message = Protopuffs::Message::Book.new
+      message.attributes = {:title   => "You Shall Know Our Velocity",
+                            :author  => "Dave Eggers",
+                            :edition => 2,
+                            :isbn    => "0970335555"}
+      assert_equal "You Shall Know Our Velocity", message.title
+      assert_equal "Dave Eggers", message.author
+      assert_equal 2, message.edition
+    end
+
+    should "only assign fields present in the argument hash" do
+      message = Protopuffs::Message::Book.new
+      message.title = "You Shall Know Our Velocity"
+      message.attributes = {:author => "Dave Eggers"}
+      assert_equal "Dave Eggers", message.author
+      assert_equal "You Shall Know Our Velocity", message.title
+      assert_nil message.edition
+    end
+
+    should "not assign defaults for optional fields missing from the argument hash" do
+      message = Protopuffs::Message::Book.new
+      message.attributes = {:author => "Dave Eggers"}
+      assert_equal "Dave Eggers", message.author
+      assert_nil message.title
+      assert_nil message.edition
+    end
+  end
+
+end