ruby-protocol-buffers 0.8.4

data/.document

@@ -0,0 +1,3 @@
+README
+lib/**/*.rb
+LICENSE

data/.gitignore

@@ -0,0 +1,11 @@
+/*.pb.rb
+/*.d
+/*.proto
+coverage
+rdoc
+pkg
+prof
+tests
+d/*
+*.gemspec
+tmp

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Mozy, Inc.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,82 @@
+= Ruby Protocol Buffers
+
+Protocol Buffers are a way of encoding structured data in an efficient yet
+extensible format. Google uses Protocol Buffers for almost all of its internal
+RPC protocols and file formats.
+
+This library has two components: a compiler to turn <tt>.proto</tt> definitions
+into Ruby modules (extension <tt>.pb.rb</tt>), and a runtime to use protocol
+buffers defined by these modules. The compiler relies on Google's C++ based
+compiler (+protoc+) for much of the heavy lifting -- this has huge advantages in
+ensuring compatibility and correctness.
+
+This library is heavily optimized for encoding and decoding speed. There is a
+small C extension available in the ext/ dir that will improve performance even
+further, but it is currently disabled to avoid rubygems having to compile a
+native extension. TODO: anybody know if we can make this optional?
+
+Because this is a tool for generating code, the RDoc documentation is a bit
+unusual. See the text in the ProtocolBuffers::Message class for details on what
+code is generated.
+
+== Features
+
+=== Supported Features
+
+* messages, enums, field types, all basic protobuf features
+* packages
+* imports
+* nested types
+* passing on unknown fields when re-serializing a message
+
+=== Unsupported Features
+
+* extensions
+* packed option (could be useful)
+* accessing custom options
+
+=== Probably Never to be Supported
+
+* RPC stubbing
+* deprecated protocol features (e.g. groups)
+* the unsupported options (java_*, optimize_for, message_set_wire_format, deprecated)
+
+=== Known Issues
+
+* not tested on Windows
+* lots of polish still needed in APIs, docs, calling out to +protoc+, etc
+
+== Simple Usage Example
+
+  $ echo "package Test; message MyMessage { optional string myField = 1; }" > test.proto
+  $ bin/ruby-protoc test.proto
+  $ irb -I./lib -rtest.pb
+  > msg = Test::MyMessage.new(:myField => 'zomgkittenz')
+  => #<Test::MyMessage myField="zomgkittenz">
+  > Test::MyMessage.parse(msg.to_s) == msg
+  => true
+
+== Authors
+
+Brian Palmer (http://github.com/codekitchen)
+
+== Installation
+
+You'll need protoc version >= 2.2 (the Google Protocol Buffer compiler)
+installed in the environment where you will be compiling protocol buffers. This
+is only needed for compiling, you don't need it installed to use the generated
+<tt>.pb.rb</tt> files. You do need this Ruby library installed to use the
+<tt>.pb.rb</tt> files, for the runtime support.
+
+If you use RubyGems, you can install via:
+
+  $ sudo gem install ruby-protocol-buffers
+
+== Source
+
+http://github.com/mozy/ruby-protocol-buffers
+
+== License
+
+See the LICENSE file included with the distribution for licensing and
+copyright details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+require 'spec'
+
+begin
+  require 'metric_fu'
+rescue LoadError
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ruby-protocol-buffers"
+    gem.summary = %Q{Ruby compiler and runtime for the google protocol buffers library.}
+    gem.homepage = "http://github.com/mozy/ruby-protocol-buffers"
+    gem.authors = ["Brian Palmer"]
+    gem.version = File.read('VERSION')
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.required_ruby_version = ">=1.8.6"
+    gem.require_path = 'lib'
+    # disabled to avoid needing to compile a C extension just to boost
+    # performance. TODO: is there a way to tell gems to make the extension
+    # optional?
+    # s.extensions << 'ext/extconf.rb'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-protocol-buffers #{version}"
+  rdoc.rdoc_files.include('README*', 'LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.8.4

data/bin/ruby-protoc

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'rubygems'
+rescue LoadError
+end
+
+require 'optparse'
+require 'tempfile'
+
+ruby_out = "."
+include_dirs = []
+
+opts = OptionParser.new
+opts.banner = <<BANNER
+Usage: #{opts.program_name} [OPTION] PROTO_FILES
+Parse PROTO_FILES and generate output based on the options given:
+BANNER
+
+opts.on("-o", "--ruby_out", "=OUT_DIR",
+        "generates ruby code in OUT_DIR", "[defaults to pwd]",
+        String) { |val| ruby_out = val }
+opts.on("-I", "--proto_path", "=PATH",
+        "Specify a directory to search for includes/imports.") { |val| include_dirs << val }
+opts.on_tail("-h", "--help") { puts opts; exit }
+
+rest = opts.parse(ARGV)
+filenames = rest
+
+(puts "Missing input file.\n\n"; puts opts; exit) if filenames.empty?
+
+require 'protocol_buffers'
+require 'protocol_buffers/compiler'
+
+protocfile = Tempfile.new("ruby-protoc")
+ProtocolBuffers::Compiler.compile(protocfile.path, filenames, :include_dirs => include_dirs)
+descriptor_set = FileDescriptorSet.parse(protocfile)
+protocfile.close(true)
+
+if ruby_out
+  require 'protocol_buffers/compiler/file_descriptor_to_ruby'
+end
+
+descriptor_set.file.each do |file_descriptor|
+
+  if ruby_out
+    path = File.join(ruby_out,
+                     File.basename(file_descriptor.name, ".proto") + ".pb.rb")
+    File.open(path, "wb") do |file|
+      dumper = FileDescriptorToRuby.new(file_descriptor)
+      dumper.write(file)
+    end
+  end
+
+end

data/debian/changelog

@@ -0,0 +1,105 @@
+protobuf-ruby (0.8.4) etch; urgency=low
+
+  * Fix decoding of varints into signed int32/int64 fields
+
+ -- Brian Palmer <brian@mozy.com>  Mon, 17 May 2010 22:10:42 +0000
+
+protobuf-ruby (0.8.3) etch; urgency=low
+
+  * fix for ruby 1.8 <-> 1.9 compat
+
+ -- Brian Palmer <brian@mozy.com>  Thu,  4 Feb 2010 00:02:23 +0000
+
+protobuf-ruby (0.8.2) etch; urgency=low
+
+  * Fix deb package for real. I think. Supporting both deb and gem is
+    tricky.
+
+ -- Brian Palmer <brian@mozy.com>  Tue,  2 Feb 2010 22:11:43 +0000
+
+protobuf-ruby (0.8.1) etch; urgency=low
+
+  * whoops fix deb install
+
+ -- Brian Palmer <brian@mozy.com>  Tue,  2 Feb 2010 21:35:43 +0000
+
+protobuf-ruby (0.8.0) etch; urgency=low
+
+  * fix whitespace
+  * Remove the pure-ruby experimental compiler.
+  * Updated bootstrapping step, and refactored enum support for easier
+    include.
+  * WIP D protobuf compiler
+  * Update README, add empty LICENSE, update Rakefile
+  * Remove support for compiling D protobufs from binary (no runtime
+    yet)
+  * gitignore update
+  * new name: s/protobuf/protocol_buffers and s/Protobuf/ProtocolBuffers
+  * update README with feature list
+  * add compiler helper methods and starting on some tests
+  * Add RDoc documentation to the Message class.
+  * More tests
+  * more tests
+  * More field and runtime tests
+  * Handle .proto files without a package specified
+  * update readme example
+  * more documentation
+  * Example: JSON-to-Protobuf and back
+  * test for unknown fields
+  * Drop InvalidFieldValue exception class, separate type checking/value
+    checking.
+  * validate required fields and improve validation on deserialization
+  * Refactor serialization/deserialization to not be so weird.
+  * dir rename: s/message/runtime
+  * Fix sub-message initialization to work like python.
+  * Type check repeated fields using an Array subclass as a proxy.
+  * make sure we always give protoc a -I option for the input file
+    dir(s)
+  * Version bump to 0.0.0
+  * clean up gem/rake/rdoc/rspec infrastructure using the Jeweler
+    library
+  * improved rcov test coverage, and prune a bit of unused code
+  * store and pass on unknown fields when re-serializing a message
+  * README update
+  * fixing deb dependency for ubuntu
+  * fix deb build
+
+ -- Brian Palmer <brian@mozy.com>  Fri, 29 Jan 2010 17:05:06 +0000
+
+protobuf-ruby (0.1.10) etch; urgency=low
+
+  * Support for imports.
+  * Merge branch 'master' of git@labs.dechocorp.com:ruby-protobufs
+  * maintenance work
+
+ -- Brian Palmer <brianp@decho.com>  Fri, 25 Sep 2009 21:26:05 +0000
+
+protobuf-ruby (0.1.9) unstable; urgency=low
+
+  * fix code generation outputting empty case statement (not allowed in ruby)
+
+ -- Brian Palmer <brianp@decho.com>  Fri, 11 Sep 2009 10:58:17 -0600
+
+protobuf-ruby (0.1.8) unstable; urgency=low
+
+  * support for float and double fields
+
+ -- Brian Palmer <brianp@decho.com>  Wed, 29 July 2009 16:36:15 -0600
+
+protobuf-ruby (0.1.7) unstable; urgency=low
+
+  * faster runtime and some code fixes
+
+ -- Brian Palmer <brianp@decho.com>  Wed, 29 July 2009 16:04:03 -0600
+
+protobuf-ruby (0.1.5) unstable; urgency=low
+
+  * deb fixes and generated file missing require fix
+
+ -- Brian Palmer <brian@cerebus.bds>  Sat, 30 May 2009 22:44:14 -0600
+
+protobuf-ruby (0.1.0) unstable; urgency=low
+
+  * First stab at packaging.
+
+ -- Brian Palmer <brian@mozy.com>  Sat, 30 May 2009 21:24:00 -0700

data/debian/compatability

@@ -0,0 +1 @@
+4

data/debian/control

@@ -0,0 +1,12 @@
+Source: protobuf-ruby
+Section: non-free/net
+Maintainer: Brian Palmer <brian@mozy.com>
+Priority: optional
+Architecture: all
+Build-Depends: debhelper (>= 4), ruby1.8, ruby1.8-dev
+
+Package: libprotobuf-ruby1.8
+Architecture: any
+Depends: ruby1.8, protobuf | protobuf-compiler
+Description: Ruby implementation of a compiler and runtime for Google Protocol
+ Buffers.

data/debian/libprotobuf-ruby1.8.install

@@ -0,0 +1,7 @@
+debian/protocol_buffers.rb /usr/lib/ruby/1.8/
+bin/ruby-protoc            /usr/bin
+VERSION                    /usr/lib/ruby/1.8/protocol_buffers
+LICENSE                    /usr/lib/ruby/1.8/protocol_buffers
+README                     /usr/lib/ruby/1.8/protocol_buffers
+examples                   /usr/lib/ruby/1.8/protocol_buffers
+lib                        /usr/lib/ruby/1.8/protocol_buffers

data/debian/protocol_buffers.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), "protocol_buffers", "lib")
+
+load(File.join(File.dirname(__FILE__), "protocol_buffers", "lib", "protocol_buffers.rb"))

data/debian/rules

@@ -0,0 +1,13 @@
+#!/usr/bin/make -f
+
+include /usr/share/cdbs/1/rules/debhelper.mk
+
+build/libprotobuf-ruby1.8::
+	-mv ext/extconf.disabled.rb ext/extconf.rb
+	cd ext && ruby1.8 extconf.rb --prefix=$(CURDIR)/debian/libprotobuf-ruby1.8/usr
+
+cleanbuilddir/libprotobuf-ruby1.8::
+	-cd ext && make clean && rm Makefile
+
+install/libprotobuf-ruby1.8::
+	cd ext && DESTDIR=$(CURDIR)/debian/libprotobuf-ruby1.8 make install

data/examples/json_protobuf.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+
+# Example JSON/Protocol Buffer conversion using reflection.
+# Requires the json gem.
+
+begin
+  require 'rubygems'
+rescue LoadError; end
+
+require 'json'
+$LOAD_PATH << File.dirname(__FILE__) + '/../lib'
+require 'protocol_buffers'
+require 'protocol_buffers/compiler'
+
+class ProtocolBuffers::Message
+
+  def to_json(*args)
+    hash = {'json_class' => self.class.name}
+
+    # simpler version, includes all fields in the output, using the default
+    # values if unset. also includes empty repeated fields as empty arrays.
+    # fields.each do |tag, field|
+    #   hash[field.name] = value_for_tag(field.tag)
+    # end
+
+    # prettier output, only includes non-empty repeated fields and set fields
+    fields.each do |tag, field|
+      if field.repeated?
+        value = value_for_tag(field.tag)
+        hash[field.name] = value unless value.empty?
+      else
+        hash[field.name] = value_for_tag(field.tag) if value_for_tag?(field.tag)
+      end
+    end
+    hash.to_json(*args)
+  end
+
+  def self.json_create(hash)
+    hash.delete('json_class')
+
+    # initialize takes a hash of { attribute_name => value } so you can just
+    # pass the hash into the constructor. but we're supposed to be showing off
+    # reflection, here. plus, that raises an exception if there is an unknown
+    # key in the hash.
+    # new(hash)
+
+    message = new
+    fields.each do |tag, field|
+      if value = hash[field.name.to_s]
+        message.set_value_for_tag(field.tag, value)
+      end
+    end
+    message
+  end
+end
+
+# and that's it... all the rest of this code is just to show it off
+
+ProtocolBuffers::Compiler.compile_and_load_string <<-EOS
+message Foo {
+  enum Bar {
+    A = 1;
+    B = 2;
+    C = 3;
+  };
+
+  message Baz {
+    optional string subby = 1;
+  };
+
+  repeated Bar bars = 1;
+  optional string name = 2;
+  repeated string bazzesses = 3;
+  optional Baz subbaz = 4;
+};
+EOS
+
+foo = Foo.new(:name => 'foo1')
+foo.bars += [Foo::Bar::A, Foo::Bar::A, Foo::Bar::C]
+foo.subbaz = Foo::Baz.new(:subby => "subby!")
+
+puts "Input protobuf:", foo.inspect, ""
+
+json = JSON.pretty_generate(foo)
+puts "JSON representation:", json, ""
+
+foo2 = JSON.parse(json)
+puts "Parsed from JSON:", foo2.inspect, ""
+
+puts "Are they equal: #{foo == foo2}"