ruby-protocol-buffers 0.8.4 → 0.8.5

data/Changelog.md

@@ -0,0 +1,8 @@
+# ruby-protocol-buffers 0.8.5
+
+  * Add support for Microsoft Windows (tested on Windows 7)
+  * Fix StringIO encoding issues on Ruby 1.9.2 by explicitly setting binary encoding
+
+# ruby-protocol-buffers 0.8.4
+
+  * First gem release

data/LICENSE

@@ -1,22 +1,24 @@
-Copyright (c) 2009 Mozy, Inc.
+Copyright (c) 2009, Decho Corporation
+All rights reserved.
 
-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:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of Decho Corporation nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
 
-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.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/{README → README.md}

@@ -1,11 +1,11 @@
-= Ruby Protocol Buffers
+# 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
+This library has two components: a compiler to turn `.proto` definitions
+into Ruby modules (extension `.pb.rb`), 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.
@@ -19,9 +19,21 @@ 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
+## Installation
 
-=== Supported Features
+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
+`.pb.rb` files. You do need this Ruby library installed to use the
+`.pb.rb` files, for the runtime support.
+
+If you use RubyGems, you can install via:
+
+    $ sudo gem install ruby-protocol-buffers
+
+## Features
+
+### Supported Features
 
 * messages, enums, field types, all basic protobuf features
 * packages
@@ -29,54 +41,37 @@ code is generated.
 * nested types
 * passing on unknown fields when re-serializing a message
 
-=== Unsupported Features
+### Unsupported Features
 
 * extensions
 * packed option (could be useful)
 * accessing custom options
 
-=== Probably Never to be Supported
+### 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
 
-== 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
 
-  $ 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
+## 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
+## Source
 
 http://github.com/mozy/ruby-protocol-buffers
 
-== License
+## License
 
 See the LICENSE file included with the distribution for licensing and
 copyright details.

data/Rakefile

@@ -18,6 +18,8 @@ begin
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.required_ruby_version = ">=1.8.6"
     gem.require_path = 'lib'
+    gem.extra_rdoc_files << "Changelog.md"
+    gem.files << "Changelog.md"
     # 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?

data/VERSION

@@ -1 +1 @@
-0.8.4
+0.8.5

data/bin/ruby-protoc

@@ -33,6 +33,7 @@ require 'protocol_buffers'
 require 'protocol_buffers/compiler'
 
 protocfile = Tempfile.new("ruby-protoc")
+protocfile.binmode
 ProtocolBuffers::Compiler.compile(protocfile.path, filenames, :include_dirs => include_dirs)
 descriptor_set = FileDescriptorSet.parse(protocfile)
 protocfile.close(true)

data/lib/protocol_buffers.rb

@@ -1,5 +1,13 @@
 module ProtocolBuffers
   VERSION = File.read(File.join(File.dirname(__FILE__), "..", "VERSION")).chomp
+
+  require 'stringio'
+  # for 1.9.2 compatibility
+  def self.bin_sio(*args)
+    sio = StringIO.new(*args)
+    sio.set_encoding('binary') if sio.respond_to?(:set_encoding)
+    sio
+  end
 end
 
 require 'protocol_buffers/runtime/message'

data/lib/protocol_buffers/compiler.rb

@@ -22,12 +22,14 @@ module ProtocolBuffers
       require 'protocol_buffers/compiler/file_descriptor_to_ruby'
 
       tempfile = Tempfile.new("protocol_buffers_spec")
+      tempfile.binmode
       compile(tempfile.path, input_files, opts)
       descriptor_set = FileDescriptorSet.parse(tempfile)
       tempfile.close(true)
       descriptor_set.file.each do |file|
         parsed = FileDescriptorToRuby.new(file)
         output = Tempfile.new("protocol_buffers_spec_parsed")
+        output.binmode
         parsed.write(output)
         output.flush
         load output.path
@@ -39,6 +41,7 @@ module ProtocolBuffers
     def self.compile_and_load_string(input, opts = {})
       require 'tempfile'
       tempfile = Tempfile.new("protocol_buffers_load_string")
+      tempfile.binmode
       tempfile.write(input)
       tempfile.flush
       (opts[:include_dirs] ||= []) << File.dirname(tempfile.path)

data/lib/protocol_buffers/compiler/file_descriptor_to_ruby.rb

@@ -39,10 +39,6 @@ HEADER
       descriptor.message_type.each do |message|
         dump_message(message)
       end
-
-      descriptor.enum_type.each do |enum|
-        dump_enum(enum)
-      end
     end
 
   end
@@ -56,10 +52,16 @@ HEADER
     messages.each do |message|
       line %{class #{name([@package, message.name])} < ::ProtocolBuffers::Message; end}
     end
-    enums.each do |enum|
-      line %{module #{name([@package, enum.name])}; end}
+
+    if enums.empty?
+      line
+    else
+      line
+      line %{# enums}
+      enums.each do |enum|
+        dump_enum(enum)
+      end
     end
-    line
   end
 
   def line(str = nil)
@@ -119,9 +121,6 @@ HEADER
       line %{# nested messages} unless message.nested_type.empty?
       message.nested_type.each { |inner| dump_message(inner) }
 
-      line %{# nested enums} unless message.enum_type.empty?
-      message.enum_type.each { |inner| dump_enum(inner) }
-
       message.field.each do |field|
         typename = field_typename(field)
         fieldline = %{#{LABEL_MAPPING[field.label]} #{typename}, :#{field.name}, #{field.number}}

data/lib/protocol_buffers/runtime/decoder.rb

@@ -15,7 +15,7 @@ module ProtocolBuffers
         field = fields[tag]
 
         if field && wire_type != field.wire_type
-          raise(DecodeError, "incorrect wire type for tag: #{field.tag}")
+          raise(DecodeError, "incorrect wire type for tag: #{field.tag}, expected #{field.wire_type} but got #{wire_type}\n#{field.inspect}")
         end
 
         # replacing const lookups with hard-coded ints removed an entire 10%

data/lib/protocol_buffers/runtime/message.rb

@@ -58,7 +58,7 @@ module ProtocolBuffers
   #
   # === Singular Fields
   #
-  # If you have a singular (optional or repeated) field +foo+ of any non-message
+  # If you have a singular (optional or required) field +foo+ of any non-message
   # type, you can manipulate the field +foo+ as if it were a regular object
   # attribute.  For example, if +foo+'s type is <tt>int32</tt>, you can say:
   #
@@ -267,7 +267,7 @@ module ProtocolBuffers
 
     # Serialize this Message to a String and return it.
     def serialize_to_string
-      sio = StringIO.new
+      sio = ProtocolBuffers.bin_sio
       serialize(sio)
       return sio.string
     end
@@ -285,7 +285,7 @@ module ProtocolBuffers
     def parse(io_or_string)
       io = io_or_string
       if io.is_a?(String)
-        io = StringIO.new(io)
+        io = ProtocolBuffers.bin_sio(io)
       end
       Decoder.decode(io, self)
       return self
@@ -396,7 +396,7 @@ module ProtocolBuffers
     end
 
     def inspect
-      ret = StringIO.new
+      ret = ProtocolBuffers.bin_sio
       ret << "#<#{self.class.name}"
       fields.each do |tag, field|
         ret << " #{field.name}=#{field.inspect_value(self.__send__(field.name))}"

data/spec/fields_spec.rb

@@ -26,7 +26,7 @@ describe ProtocolBuffers, "fields" do
   it "properly encodes and decodes negative varints" do
     val = -2082844800000000
     str = "\200\300\313\274\236\265\246\374\377\001"
-    sio = StringIO.new
+    sio = ProtocolBuffers.bin_sio
     ProtocolBuffers::Varint.encode(sio, val)
     sio.string.should == str
     sio.rewind

data/spec/proto_files/top_level_enum.proto

@@ -0,0 +1,10 @@
+package foo;
+
+enum Bar {
+  A = 1;
+  B = 2;
+}
+
+message Baz {
+  optional Bar bar = 1;
+}

data/spec/runtime_spec.rb

@@ -20,7 +20,7 @@ describe ProtocolBuffers, "runtime" do
 
     msg1.test_field = "zomgkittenz"
 
-    ser = StringIO.new(msg1.to_s)
+    ser = ProtocolBuffers.bin_sio(msg1.to_s)
     msg2 = Simple::Test1.parse(ser)
     msg2.test_field.should == "zomgkittenz"
     msg2.should == msg1

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-protocol-buffers
 version: !ruby/object:Gem::Version 
-  hash: 55
   prerelease: false
   segments: 
   - 0
   - 8
-  - 4
-  version: 0.8.4
+  - 5
+  version: 0.8.5
 platform: ruby
 authors: 
 - Brian Palmer
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-20 00:00:00 -06:00
+date: 2010-12-19 00:00:00 -07:00
 default_executable: ruby-protoc
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
         segments: 
         - 1
         - 2
@@ -41,13 +39,14 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
+- Changelog.md
 - LICENSE
-- README
+- README.md
 files: 
 - .document
-- .gitignore
+- Changelog.md
 - LICENSE
-- README
+- README.md
 - Rakefile
 - VERSION
 - bin/ruby-protoc
@@ -81,6 +80,7 @@ files:
 - spec/proto_files/featureful.proto
 - spec/proto_files/no_package.proto
 - spec/proto_files/simple.proto
+- spec/proto_files/top_level_enum.proto
 - spec/runtime_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -89,8 +89,8 @@ homepage: http://github.com/mozy/ruby-protocol-buffers
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -98,7 +98,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 59
       segments: 
       - 1
       - 8
@@ -109,7 +108,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -121,8 +119,8 @@ signing_key:
 specification_version: 3
 summary: Ruby compiler and runtime for the google protocol buffers library.
 test_files: 
+- examples/json_protobuf.rb
 - spec/compiler_spec.rb
 - spec/fields_spec.rb
 - spec/runtime_spec.rb
 - spec/spec_helper.rb
-- examples/json_protobuf.rb

data/.gitignore

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