ruby-protocol-buffers 1.0.0 → 1.0.1

data/.gitignore

@@ -1,6 +1,9 @@
 /*.pb.rb
 /*.d
 /*.proto
+.yardoc/
+Gemfile.lock
+doc/*
 coverage
 rdoc
 pkg

data/Changelog.md

@@ -1,3 +1,7 @@
+# ruby-protocol-buffers 1.0.1
+
+  * Treat unknown enum values as unknown fields
+
 # ruby-protocol-buffers 1.0.0
 
   * The library has reached to 1.0 status, hurrah

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ruby-protocol-buffers.gemspec
+gemspec

data/Rakefile

@@ -1,56 +1,20 @@
-require 'rubygems'
-require 'rake'
-require 'spec'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-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'
-    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?
-    # 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
-  # You'll need to install Jeweler to build packages
-end
+task :default => 'spec'
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "-c -f d"
 end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rspec_opts = "-c -f d"
+  t.rcov = true
+  t.rcov_opts = ["--exclude", "spec,gems/,rubygems/"]
 end
 
-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')
+require 'yard'
+YARD::Rake::YardocTask.new(:doc) do |t|
+  version = ProtocolBuffers::VERSION
+  t.options = ["--title", "ruby protocol buffers #{version}", "--files", "LICENSE,Changelog.md"]
 end

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/bin/ruby-protoc

@@ -11,11 +11,15 @@ require 'tempfile'
 ruby_out = "."
 include_dirs = []
 
+require 'protocol_buffers'
+require 'protocol_buffers/compiler'
+
 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.version = ProtocolBuffers::VERSION
 
 opts.on("-o", "--ruby_out", "=OUT_DIR",
         "generates ruby code in OUT_DIR", "[defaults to pwd]",
@@ -29,9 +33,6 @@ 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")
 protocfile.binmode
 ProtocolBuffers::Compiler.compile(protocfile.path, filenames, :include_dirs => include_dirs)

data/lib/protocol_buffers/runtime/decoder.rb

@@ -38,10 +38,21 @@ module ProtocolBuffers
         end
 
         if field
-          deserialized = field.deserialize(value)
-          # merge_field handles repeated field logic
-          message.merge_field(tag, deserialized, field)
-        else
+          begin
+            deserialized = field.deserialize(value)
+            # merge_field handles repeated field logic
+            message.merge_field(tag, deserialized, field)
+          rescue ArgumentError
+            # for enum fields, treat bad values as unknown fields
+            if field.is_a?(Field::EnumField)
+              field = nil
+            else
+              raise
+            end
+          end
+        end
+
+        unless field
           # ignore unknown fields, pass them on when re-serializing this message
 
           # special handling -- if it's a LENGTH_DELIMITED field, we need to

data/lib/protocol_buffers/runtime/message.rb

@@ -480,6 +480,10 @@ module ProtocolBuffers
       @unknown_fields.each { |tag_int, value| yield tag_int, value }
     end
 
+    def unknown_field_count
+      (@unknown_fields || []).size
+    end
+
     # Generate the initialize method using reflection, to improve speed. This is
     # called by the generated .pb.rb code, it's not necessary to call this
     # method directly.

data/ruby-protocol-buffers.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "protocol_buffers"
+
+Gem::Specification.new do |s|
+  s.name        = "ruby-protocol-buffers"
+  s.version     = ProtocolBuffers::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brian Palmer"]
+  s.email       = ["brian@codekitchen.net"]
+  s.homepage    = "https://github.com/mozy/ruby-protocol-buffers"
+  s.summary     = %{Ruby compiler and runtime for the google protocol buffers library.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.extra_rdoc_files << "Changelog.md"
+
+  s.add_development_dependency "rspec", "~> 2.5"
+  s.add_development_dependency "autotest-standalone"
+  s.add_development_dependency "autotest-growl"
+  s.add_development_dependency "rcov"
+  s.add_development_dependency "yard"
+end

data/spec/proto_files/featureful.proto

@@ -1,5 +1,7 @@
 package featureful;
 
+option optimize_for = LITE_RUNTIME;
+
 message A {
   message Sub {
     enum Payloads {

data/spec/runtime_spec.rb

@@ -6,12 +6,13 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 require 'protocol_buffers'
 require 'protocol_buffers/compiler'
 
-ProtocolBuffers::Compiler.compile_and_load(
-  File.join(File.dirname(__FILE__), "proto_files", "simple.proto"))
-ProtocolBuffers::Compiler.compile_and_load(
-  File.join(File.dirname(__FILE__), "proto_files", "featureful.proto"))
-
 describe ProtocolBuffers, "runtime" do
+  before(:each) do
+    ProtocolBuffers::Compiler.compile_and_load(
+      File.join(File.dirname(__FILE__), "proto_files", "simple.proto"))
+    ProtocolBuffers::Compiler.compile_and_load(
+      File.join(File.dirname(__FILE__), "proto_files", "featureful.proto"))
+  end
 
   it "can handle basic operations" do
 
@@ -354,18 +355,17 @@ describe ProtocolBuffers, "runtime" do
     ProtocolBuffers::Compiler.compile_and_load_string <<-EOS
       package tehUnknown;
       message MyResult {
-        optional int32 field_1 = 1;
+        optional int64 field_1 = 1;
       }
     EOS
 
-    res1 = TehUnknown::MyResult.new(:field_1 => 5)
+    res1 = TehUnknown::MyResult.new(:field_1 => (2**33))
     buf = res1.to_s
 
     ProtocolBuffers::Compiler.compile_and_load_string <<-EOS
       package tehUnknown;
       message MyResult {
-        enum E { A = 1; }
-        optional E field_1 = 1;
+        optional int32 field_1 = 1;
       }
     EOS
 
@@ -427,4 +427,56 @@ describe ProtocolBuffers, "runtime" do
     res3.field_4.should == 0xfffc
   end
 
+  it "ignores and passes on unknown enum values" do
+    ProtocolBuffers::Compiler.compile_and_load_string <<-EOS
+      package tehUnknown;
+      message MyResult {
+        enum E {
+          V1 = 1;
+          V2 = 2;
+        }
+        optional E field_1 = 1;
+      }
+    EOS
+
+    res1 = TehUnknown::MyResult.new(:field_1 => TehUnknown::MyResult::E::V2)
+    serialized = res1.to_s
+
+    # remove field_2 to pretend we never knew about it
+    ProtocolBuffers::Compiler.compile_and_load_string <<-EOS
+      package tehUnknown;
+      message MyResult {
+        enum E {
+          V1 = 1;
+        }
+        optional E field_1 = 1;
+      }
+    EOS
+
+    res2 = nil
+    proc do
+      res2 = TehUnknown::MyResult.parse(serialized)
+    end.should_not raise_error()
+
+    res2.value_for_tag?(1).should be_false
+    res2.unknown_field_count.should == 1
+
+    serialized2 = res2.to_s
+
+    # now we know about field_2 again
+    ProtocolBuffers::Compiler.compile_and_load_string <<-EOS
+      package tehUnknown;
+      message MyResult {
+        enum E {
+          V1 = 1;
+          V2 = 2;
+        }
+        optional E field_1 = 1;
+      }
+    EOS
+
+    res3 = TehUnknown::MyResult.parse(serialized2)
+    res3.field_1.should == 2
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,8 +1,6 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'protocol_buffers'
-require 'spec'
-require 'spec/autorun'
 
-Spec::Runner.configure do |config|
+require 'rspec'
+
+RSpec.configure do |config|
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-protocol-buffers
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Brian Palmer
@@ -15,8 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-07 00:00:00 -07:00
-default_executable: ruby-protoc
+date: 2011-03-20 00:00:00 -06:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -24,30 +24,85 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 9
         segments: 
-        - 1
         - 2
-        - 9
-        version: 1.2.9
+        - 5
+        version: "2.5"
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: autotest-standalone
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: autotest-growl
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: 
 email: 
+- brian@codekitchen.net
 executables: 
 - ruby-protoc
 extensions: []
 
 extra_rdoc_files: 
 - Changelog.md
-- LICENSE
-- README.md
 files: 
 - .document
 - .gitignore
 - Changelog.md
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
@@ -77,6 +132,7 @@ files:
 - lib/protocol_buffers/runtime/message.rb
 - lib/protocol_buffers/runtime/service.rb
 - lib/protocol_buffers/runtime/varint.rb
+- ruby-protocol-buffers.gemspec
 - spec/compiler_spec.rb
 - spec/fields_spec.rb
 - spec/proto_files/depends.proto
@@ -88,12 +144,12 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/mozy/ruby-protocol-buffers
+homepage: https://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 
@@ -101,12 +157,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 59
+      hash: 3
       segments: 
-      - 1
-      - 8
-      - 6
-      version: 1.8.6
+      - 0
+      version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
@@ -126,6 +180,11 @@ summary: Ruby compiler and runtime for the google protocol buffers library.
 test_files: 
 - spec/compiler_spec.rb
 - spec/fields_spec.rb
+- spec/proto_files/depends.proto
+- 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
-- examples/json_protobuf.rb