ruby-protocol-buffers 1.5.1 → 1.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8b90d97ac7aaee3386bb7610307da62ca99b7e4
+  data.tar.gz: b79d0e1cf4b047363dffef09fdc2560cb91d5a86
+SHA512:
+  metadata.gz: 330587548c9be9afb403acd7ad1ea86b1d5689056180808ad2b10d3ced970e261c0cfc7c91174fd65e58df238c7c054b99b86695597f57d81260f54c59777e78
+  data.tar.gz: 62361ed0fdd8f8926243610d23aef2618f8cc97196076b5fa6e66f306b26244daab81bc86d7ff893c8762cac1cb8795e889277654d5b576c89bc79fa0d4e2bea

data/.gitignore

@@ -12,3 +12,4 @@ prof
 rdoc
 tests
 tmp
+/lib/protocol_buffers/runtime/text_parser.rb

data/.travis.yml

@@ -4,20 +4,16 @@ gemfile:
   # i can't find a way to use the same Gemfile and just specify --without varint
   - Gemfile.no_varint
 rvm:
-  - "1.8.7"
   - "1.9.3"
   - "2.0.0"
-  - jruby-18mode # JRuby in 1.8 mode
+  - "2.1.0"
   - jruby-19mode # JRuby in 1.9 mode
-  - rbx-18mode
-  - rbx-19mode
+  - rbx-2.1.1
 matrix:
   exclude:
     # can't use the varint extension in jruby runs
-    - rvm: jruby-18mode
-      gemfile: Gemfile
     - rvm: jruby-19mode
       gemfile: Gemfile
   allow_failures:
-    # https://github.com/rubinius/rubinius/issues/2215
-    - rvm: rbx-19mode
+    - rvm: rbx-2.1.1
+

data/CHANGELOG.md

@@ -0,0 +1,80 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## 1.6.0 - 2014-09-22
+### Added
+- More metaprogramming support via `get_expected_field`, `get_optional_field`.
+- Ruby 2.1 support.
+- Protocol Buffers text format support.
+
+### Changed
+- Fixed Windows line ending bug in encoder.
+- README syntax highlighting.
+
+### Removed
+- Dropped Ruby 1.8.7 support.
+
+## 1.5.1 - 2013-10-28
+### Added
+- Better value semantics for `Message`, including `==`, `eql?`, and `hash`.
+
+## 1.5.0 - 2013-09-19
+### Added
+- `Message#to_hash`
+- Service and RPC classes, as a common interface for other libraries to build on.
+
+### Changed
+- Fix for repeated fields being set to itself.
+
+## 1.4.1 - 2013-07-19
+### Changed
+- Fix for frozen strings as input.
+
+## 1.4.0 - 2013-06-18
+### Added
+- Support protobuf groups.
+- Add new executable protoc-gen-ruby, for the new protoc plugin support.
+
+## 1.3.3 - 2013-03-22
+### Added
+- Validate UTF8 while encoding.
+- Support packed fields.
+
+## 1.3.1 - 2013-02-17
+### Added
+- Move deactivated varint c extension to a separate gem.
+- Use the varint gem, if it has been loaded.
+
+## 1.3.0 - 2013-01-17
+### Added
+- Improved documentation and README.
+
+## 1.2.3.beta2 - 2012-12-18
+### Added
+- Better error reporting while parsing invalid messages.
+- UTF-8 validation of string fields in ruby 1.9+.
+
+### Changed
+- Fixed 32-bit negative numbers.
+- Fix encoding of strings in parsed messages.
+- Fix for recursive message types.
+
+## 1.2.1 - 2011-10-01
+### Added
+- Translate package names to submodules.
+- Mirror packages as directory structure.
+
+## 1.1.0 - 2011-09-19
+### Removed
+- Remove package unloading support.
+
+## 1.0.1 - 2011-03-20
+### Added
+- Treat unknown enum values as unknown fields.
+
+## 1.0.0
+
+## 0.8.5
+### Added
+- Add support for Microsoft Windows (tested on Windows 7)
+- Fix StringIO encoding issues on Ruby 1.9.2 by explicitly setting binary encoding.

data/Changelog.md

@@ -1,16 +1,80 @@
-# ruby-protocol-buffers 1.0.1
+# Change Log
+All notable changes to this project will be documented in this file.
 
-  * Treat unknown enum values as unknown fields
+## 1.6.0 - 2014-09-22
+### Added
+- More metaprogramming support via `get_expected_field`, `get_optional_field`.
+- Ruby 2.1 support.
+- Protocol Buffers text format support.
 
-# ruby-protocol-buffers 1.0.0
+### Changed
+- Fixed Windows line ending bug in encoder.
+- README syntax highlighting.
 
-  * The library has reached to 1.0 status, hurrah
+### Removed
+- Dropped Ruby 1.8.7 support.
 
-# ruby-protocol-buffers 0.8.5
+## 1.5.1 - 2013-10-28
+### Added
+- Better value semantics for `Message`, including `==`, `eql?`, and `hash`.
 
-  * Add support for Microsoft Windows (tested on Windows 7)
-  * Fix StringIO encoding issues on Ruby 1.9.2 by explicitly setting binary encoding
+## 1.5.0 - 2013-09-19
+### Added
+- `Message#to_hash`
+- Service and RPC classes, as a common interface for other libraries to build on.
 
-# ruby-protocol-buffers 0.8.4
+### Changed
+- Fix for repeated fields being set to itself.
 
-  * First gem release
+## 1.4.1 - 2013-07-19
+### Changed
+- Fix for frozen strings as input.
+
+## 1.4.0 - 2013-06-18
+### Added
+- Support protobuf groups.
+- Add new executable protoc-gen-ruby, for the new protoc plugin support.
+
+## 1.3.3 - 2013-03-22
+### Added
+- Validate UTF8 while encoding.
+- Support packed fields.
+
+## 1.3.1 - 2013-02-17
+### Added
+- Move deactivated varint c extension to a separate gem.
+- Use the varint gem, if it has been loaded.
+
+## 1.3.0 - 2013-01-17
+### Added
+- Improved documentation and README.
+
+## 1.2.3.beta2 - 2012-12-18
+### Added
+- Better error reporting while parsing invalid messages.
+- UTF-8 validation of string fields in ruby 1.9+.
+
+### Changed
+- Fixed 32-bit negative numbers.
+- Fix encoding of strings in parsed messages.
+- Fix for recursive message types.
+
+## 1.2.1 - 2011-10-01
+### Added
+- Translate package names to submodules.
+- Mirror packages as directory structure.
+
+## 1.1.0 - 2011-09-19
+### Removed
+- Remove package unloading support.
+
+## 1.0.1 - 2011-03-20
+### Added
+- Treat unknown enum values as unknown fields.
+
+## 1.0.0
+
+## 0.8.5
+### Added
+- Add support for Microsoft Windows (tested on Windows 7)
+- Fix StringIO encoding issues on Ruby 1.9.2 by explicitly setting binary encoding.

data/README.md

@@ -3,36 +3,36 @@
 [![Build Status](https://travis-ci.org/codekitchen/ruby-protocol-buffers.png?branch=master)](https://travis-ci.org/codekitchen/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.
+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 `.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. If you don't need cross-language
-interoperability you can create Message classes directly in ruby,
-in which case `protoc` is not needed. See "Writing Message Classes
-Directly" below.
+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. If you don't need cross-language interoperability you can
+create Message classes directly in ruby, in which case `protoc` is not
+needed. See "Writing Message Classes Directly" below.
 
 This library is heavily optimized for encoding and decoding speed.
 
 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.
+unusual. See the text in the ProtocolBuffers::Message class for details on
+what code is generated.
 
 ## Installation
 
     $ gem install ruby-protocol-buffers
 
-If you want to compile .proto files to ruby, you'll need `protoc` version >= 2.2 (the Google Protocol Buffer compiler)
-installed in the environment where you will be compiling them.
-You do not need `protoc` installed to use the generated `.pb.rb` files.
+If you want to compile .proto files to ruby, you'll need `protoc` version >=
+2.2 (the Google Protocol Buffer compiler) installed in the environment where
+you will be compiling them.  You do not need `protoc` installed to use the
+generated `.pb.rb` files.
 
-For greater performance, consider installing the varint gem as well.
-This optional gem builds a small C extension to make parsing protocol buffers
+For greater performance, consider installing the varint gem as well.  This
+optional gem builds a small C extension to make parsing protocol buffers
 faster. If your application uses a Gemfile, add varint to the Gemfile
 alongside ruby-protocol-buffers.
 
@@ -40,11 +40,10 @@ alongside ruby-protocol-buffers.
 
 Given the file test.proto:
 
-```
+```protobuf
 package Test;
 
-message MyMessage
-{
+message MyMessage {
   optional string myField = 1;
 }
 ```
@@ -67,11 +66,11 @@ Test::MyMessage.parse(encoded) == msg # true
 
 ## Writing Message Classes Directly
 
-Protocol Buffer definitions are often shared between applications
-written in different programming languages, and so are normally defined
-in .proto files and translated to ruby using the `ruby-protoc` binary.
+Protocol Buffer definitions are often shared between applications written in
+different programming languages, and so are normally defined in .proto files
+and translated to ruby using the `ruby-protoc` binary.
 
-However, it's quite simple to write ProtocolBuffers::Message classes
+However, it's quite simple to write `ProtocolBuffers::Message` classes
 directly when a .proto file isn't needed.
 
 ```ruby
@@ -97,19 +96,17 @@ class Group < ProtocolBuffers::Message
 end
 ```
 
-This code is essentially equivalent to the code `ruby-protoc` will
-generate if given this .proto file:
+This code is essentially equivalent to the code `ruby-protoc` will generate
+if given this .proto file:
 
-```
-message User
-{
+```protobuf
+message User {
   required string name = 1;
   required string email = 2;
   optional int32 logins = 3;
 }
 
-message Group
-{
+message Group {
   repeated User users = 1;
   repeated Group subgroups = 2;
 
@@ -123,8 +120,8 @@ message Group
 
 ```
 
-Using a hand-written Message subclass is the same as using a Message
-class generated by `ruby-protoc`.
+Using a hand-written Message subclass is the same as using a Message class
+generated by `ruby-protoc`.
 
 ```ruby
 group = Group.new(:group_type => Group::GroupType::Play)
@@ -145,6 +142,7 @@ end
 * passing on unknown fields when re-serializing a message
 * groups
 * RPC stubbing
+* formatting to and parsing from text format
 
 ### Unsupported Features
 
@@ -154,7 +152,8 @@ end
 
 ### Probably Never to be Supported
 
-* the unsupported options (java_*, optimize_for, message_set_wire_format, deprecated)
+* the unsupported options (java_*, optimize_for, message_set_wire_format,
+  deprecated)
 
 ## Authors
 

data/Rakefile

@@ -3,3 +3,11 @@ require "bundler/gem_tasks"
 Dir['tasks/**/*.rake'].each { |t| load t }
 
 task :default => [:spec]
+
+file 'lib/protocol_buffers/runtime/text_parser.rb' => 'lib/protocol_buffers/runtime/text_parser.ry' do |t|
+  sh 'racc', '-o', t.name, *t.prerequisites
+end
+
+task :text_parser => 'lib/protocol_buffers/runtime/text_parser.rb'
+task :spec => :text_parser
+task :build => :text_parser

data/bin/protoc-gen-ruby

@@ -26,5 +26,6 @@ rescue => error
   ]
   $stderr.puts response.error
 else
-  print response.to_s
+  $stdout.binmode
+  $stdout.print response.to_s
 end

data/lib/protocol_buffers.rb

@@ -1,12 +1,23 @@
 require 'stringio'
 
+if RUBY_VERSION < "1.9"
+  raise("This version of ruby-protocol-buffers no longer supports Ruby 1.8.7")
+end
+
 module ProtocolBuffers
-  # for 1.9.2 compatibility
   def self.bin_sio(*args)
     sio = StringIO.new(*args)
-    sio.set_encoding('binary') if 
+    sio.set_encoding(Encoding::BINARY) if
+      sio.respond_to?(:set_encoding) and
+      sio.external_encoding != Encoding::BINARY
+    sio
+  end
+
+  def self.utf8_sio(*args)
+    sio = StringIO.new(*args)
+    sio.set_encoding('utf-8') if
       sio.respond_to?(:set_encoding) and
-      sio.external_encoding != Encoding::ASCII_8BIT
+      sio.external_encoding != Encoding::UTF_8
     sio
   end
 end

data/lib/protocol_buffers/runtime/encoder.rb

@@ -26,7 +26,7 @@ module ProtocolBuffers
             # encode packed field in a LENGTH_DELIMITED wire
             wire_type = 2
             tag = (field.tag << 3) | wire_type
-            buf = StringIO.new
+            buf = ProtocolBuffers.bin_sio
             value.each { |i| serialize_field_value(buf, field.wire_type, field.serialize(i)) }
             Varint.encode(io, tag)
             Varint.encode(io, buf.size)

data/lib/protocol_buffers/runtime/field.rb

@@ -242,6 +242,10 @@ module ProtocolBuffers
       value
     end
 
+    def text_format(io, value, options = nil)
+      io.write value.to_s
+    end
+
     module WireFormats
       module LENGTH_DELIMITED
         def wire_type
@@ -304,6 +308,11 @@ module ProtocolBuffers
       def deserialize(value)
         value.read
       end
+
+      def text_format(io, value, options = nil)
+        value = value.unpack("C*").map { |b| "\\x%02x" % b }.join(nil)
+        io.write "\"#{value}\""
+      end
     end
 
     class StringField < BytesField
@@ -332,6 +341,14 @@ module ProtocolBuffers
           read_value
         end
       end
+
+      def text_format(io, value, options = nil)
+        if HAS_ENCODING
+          io.write value.dup.force_encoding(Encoding::ASCII_8BIT).dump
+        else
+          io.write value.dump
+        end
+      end
     end
 
     class NumericField < Field
@@ -583,9 +600,18 @@ module ProtocolBuffers
         @opts[:default] || @valid_values.first
       end
 
+      def value_from_name(name)
+        @proxy_enum.name_to_value_map[name.to_sym]
+      end
+
       def inspect_value(value)
         "#{@value_to_name[value]}(#{value})"
       end
+
+      def text_format(io, value, options = nil)
+        formatted = @value_to_name[value] || value.to_s
+        io.write formatted 
+      end
     end
 
     class AggregateField < Field
@@ -614,6 +640,24 @@ module ProtocolBuffers
       def deserialize(io)
         @proxy_class.parse(io)
       end
+
+      def text_format(io, value, options = nil)
+        options = options.dup
+        options[:nest] ||= 0
+        if options[:short]
+          indent = ""
+          newline = " "
+        else
+          indent = "  " * options[:nest]
+          newline = "\n"
+        end
+        options[:nest] += 1
+
+        io.write "{#{newline}"
+        value.text_format(io, options)
+        io.write " " if options[:short]
+        io.write "#{indent}}"
+      end
     end
 
     class MessageField < AggregateField