bson 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 427eb56de42fe66eb7da537b77dcdd777237199b
-  data.tar.gz: 6d10bc6abbdbb32525bf9064b51144496406fbba
+  metadata.gz: 8be09f9cb1bd6762863501239ee0323d4ee1f11f
+  data.tar.gz: b73d08e67f59e63f2b4584cba967ce15f35d2f61
 SHA512:
-  metadata.gz: c365ed81760d6aade3b76f9f715b46075e5453f2d1a1169253f924eef9a659fd6268732a52a6f55e4ceda11ba96b976c9aa781b1cdd9fb4fcc2953b4b74311ca
-  data.tar.gz: 6bf2da1bcc20b527f295ce7cd4d6522e090097b49be85c88c52646a005ea6f7451ce86439e2bee2a34858d0259cb091702c2346cbd85d7012d788fb70bf51ab4
+  metadata.gz: ad29967f35277e6f4774c98eb4067129c6485fffaf1720259c7b1f2067bd1fef4a4e59078fe690ea15b696350dfdb5fd247e2fc36ffdcabb1d45c628da8fb356
+  data.tar.gz: 4c2404caac6a17e1f329f6f82b6837c312d5c6522c5e357e07a6f8bf7bd1f332ddbe5c6695db421374fbb1e4b7d2eb1ace89da41a8747661f8c41e4d7a16a8af

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 BSON Changelog
 ==============
 
+## 2.1.0
+
+### New Features
+
+* `Date` and `DateTime` objects in Ruby can now be serialized into BSON. `Date` is
+  converted to a UTC `Time` at midnight and serialized, while `DateTime` is simply
+  converted to the identical `Time` before serialization. Note that these objects
+  will be deserialized into `Time` objects.
+
 ## 2.0.0
 
 ### Backwards Incompatible Changes

data/README.md

@@ -156,6 +156,12 @@ them.
 - `BSON::Timestamp`: `{ "t" : 5, "i" : 30 }`
 - `Regexp`: `{ "$regex" : "[abc]", "$options" : "i" }`
 
+### Notes on Special Ruby Date Classes
+
+As of 2.1.0, Ruby's `Date` and `DateTime` are able to be serialized, but when
+they are deserialized they will always be returned as a `Time` since the BSON
+specification only has a `Time` type and knows nothing about Ruby.
+
 API Documentation
 -----------------
 

data/Rakefile

@@ -78,6 +78,11 @@ task :clean_all => :clean do
   end
 end
 
+task :ext_spec => :compile do
+  ENV["WITH_EXT"] = "C"
+  Rake::Task["rspec"].invoke
+end
+
 # Run bundle exec rake release with mri and jruby.
 task :release => :build do
   system "git tag -a v#{BSON::VERSION} -m 'Tagging release: #{BSON::VERSION}'"
@@ -106,4 +111,4 @@ namespace :benchmark do
   end
 end
 
-task :default => [ :clean_all, :spec, :compile, :rspec ]
+task :default => [ :clean_all, :spec, :ext_spec ]

data/lib/bson.rb

@@ -52,6 +52,8 @@ require "bson/binary"
 require "bson/boolean"
 require "bson/code"
 require "bson/code_with_scope"
+require "bson/date"
+require "bson/date_time"
 require "bson/document"
 require "bson/false_class"
 require "bson/float"

data/lib/bson/date.rb

@@ -0,0 +1,44 @@
+# Copyright (C) 2009-2013 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module BSON
+
+  # Injects behaviour for encoding date values to raw bytes as specified by
+  # the BSON spec for time.
+  #
+  # @see http://bsonspec.org/#/specification
+  #
+  # @since 2.1.0
+  module Date
+
+    # Get the date as encoded BSON.
+    #
+    # @example Get the date as encoded BSON.
+    #   Date.new(2012, 1, 1).to_bson
+    #
+    # @return [ String ] The encoded string.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.1.0
+    def to_bson(encoded = ''.force_encoding(BINARY))
+      ::Time.utc(year, month, day).to_bson(encoded)
+    end
+  end
+
+  # Enrich the core Date class with this module.
+  #
+  # @since 2.1.0
+  ::Date.send(:include, Date)
+end

data/lib/bson/date_time.rb

@@ -0,0 +1,65 @@
+# Copyright (C) 2009-2013 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module BSON
+
+  # Injects behaviour for encoding date time values to raw bytes as specified by
+  # the BSON spec for time.
+  #
+  # @see http://bsonspec.org/#/specification
+  #
+  # @since 2.1.0
+  module DateTime
+
+    # Get the date time as encoded BSON.
+    #
+    # @example Get the date time as encoded BSON.
+    #   DateTime.new(2012, 1, 1, 0, 0, 0).to_bson
+    #
+    # @return [ String ] The encoded string.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.1.0
+    def to_bson(encoded = ''.force_encoding(BINARY))
+      to_time.to_bson(encoded)
+    end
+
+    if Environment.ree?
+
+      # Constant to multiple the seconds fraction my for millis in REE.
+      #
+      # @since 2.1.0
+      FACTOR = 86400000000
+
+      # REE does not define a to_time on DateTime, so if we are using REE we
+      # define it ourselves.
+      #
+      # @example Conver the DateTime to a time.
+      #   date_time.to_time
+      #
+      # @return [ Time ] The converted time.
+      #
+      # @since 2.1.0
+      def to_time
+        ::Time.utc(year, mon, mday, hour, min, sec, (sec_fraction * FACTOR).to_i).getlocal
+      end
+    end
+  end
+
+  # Enrich the core DateTime class with this module.
+  #
+  # @since 2.1.0
+  ::DateTime.send(:include, DateTime)
+end

data/lib/bson/environment.rb

@@ -33,6 +33,18 @@ module BSON
       defined?(JRUBY_VERSION)
     end
 
+    # Determine if we are using REE or not.
+    #
+    # @example Are we running with REE?
+    #   Environment.ree?
+    #
+    # @return [ true, false ] If our vm is REE.
+    #
+    # @since 2.1.0
+    def ree?
+      RUBY_ENGINE == "ruby" && RUBY_DESCRIPTION =~ /Enterprise/
+    end
+
     # Does the Ruby runtime we are using support ordered hashes?
     #
     # @example Does the runtime support ordered hashes?

data/lib/bson/version.rb

@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module BSON
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/spec/bson/binary_spec.rb

@@ -38,7 +38,10 @@ describe BSON::Binary do
       it "raises an error" do
         expect {
           described_class.new("testing", :error)
-        }.to raise_error(BSON::Binary::InvalidType)
+        }.to raise_error { |error|
+          error.should be_a(BSON::Binary::InvalidType)
+          error.message.should match /is not a valid binary type/
+        }
       end
     end
   end

data/spec/bson/code_with_scope_spec.rb

@@ -16,6 +16,29 @@ require "spec_helper"
 
 describe BSON::CodeWithScope do
 
+  describe "#==" do
+
+    let(:object) do
+      BSON::CodeWithScope.new("this.value = val", "test")
+    end
+
+    context "when the objects are equal" do
+      let(:other) { described_class.new("this.value = val", "test") }
+
+      it "returns true" do
+        expect(object).to eq(other)
+      end
+    end
+
+    context "when the other object is not equal" do
+      let(:other) { described_class.new("this.value = otherVal", "test") }
+
+      it "returns false" do
+        expect(object).to_not eq(other)
+      end
+    end
+  end
+
   describe "#as_json" do
 
     let(:object) do

data/spec/bson/date_spec.rb

@@ -0,0 +1,39 @@
+# Copyright (C) 2009-2013 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "spec_helper"
+
+describe Date do
+
+  describe "#to_bson" do
+
+    context "when the date is post epoch" do
+
+      let(:obj)  { Date.new(2012, 1, 1) }
+      let(:time) { Time.utc(2012, 1, 1) }
+      let(:bson) { [ (time.to_f * 1000).to_i ].pack(BSON::Int64::PACK) }
+
+      it_behaves_like "a serializable bson element"
+    end
+
+    context "when the date is pre epoch" do
+
+      let(:obj)  { Date.new(1969, 1, 1) }
+      let(:time) { Time.utc(1969, 1, 1) }
+      let(:bson) { [ (time.to_f * 1000).to_i ].pack(BSON::Int64::PACK) }
+
+      it_behaves_like "a serializable bson element"
+    end
+  end
+end

data/spec/bson/date_time_spec.rb

@@ -0,0 +1,37 @@
+# Copyright (C) 2009-2013 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "spec_helper"
+
+describe DateTime do
+
+  describe "#to_bson" do
+
+    context "when the date time is post epoch" do
+
+      let(:obj)  { DateTime.new(2012, 1, 1, 0, 0, 0) }
+      let(:bson) { [ (obj.to_time.to_f * 1000).to_i ].pack(BSON::Int64::PACK) }
+
+      it_behaves_like "a serializable bson element"
+    end
+
+    context "when the date time is pre epoch" do
+
+      let(:obj)  { DateTime.new(1969, 1, 1, 0, 0, 0) }
+      let(:bson) { [ (obj.to_time.to_f * 1000).to_i ].pack(BSON::Int64::PACK) }
+
+      it_behaves_like "a serializable bson element"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -15,7 +15,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
-if ENV["CI"]
+if ENV["CI"] && !ENV["WITH_EXT"]
   require "simplecov"
   require "coveralls"
   SimpleCov.formatter = Coveralls::SimpleCov::Formatter

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bson
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Tyler Brock
@@ -33,7 +33,7 @@ cert_chain:
   8v7zLF2XliYbfurYIwkcXs8yPn8ggApBIy9bX6VJxRs/l2+UvqzaHIFaFy/F8/GP
   RNTuXsVG5NDACo7Q
   -----END CERTIFICATE-----
-date: 2013-12-02 00:00:00.000000000 Z
+date: 2014-01-10 00:00:00.000000000 Z
 dependencies: []
 description: A full featured BSON specification implementation, in Ruby
 email:
@@ -43,17 +43,22 @@ extensions:
 - ext/bson/extconf.rb
 extra_rdoc_files: []
 files:
-- CONTRIBUTING.md
 - CHANGELOG.md
+- CONTRIBUTING.md
 - LICENSE
 - NOTICE
 - README.md
 - Rakefile
+- ext/bson/extconf.rb
+- ext/bson/native.c
+- lib/bson.rb
 - lib/bson/array.rb
 - lib/bson/binary.rb
 - lib/bson/boolean.rb
 - lib/bson/code.rb
 - lib/bson/code_with_scope.rb
+- lib/bson/date.rb
+- lib/bson/date_time.rb
 - lib/bson/document.rb
 - lib/bson/encodable.rb
 - lib/bson/environment.rb
@@ -78,14 +83,13 @@ files:
 - lib/bson/true_class.rb
 - lib/bson/undefined.rb
 - lib/bson/version.rb
-- lib/bson.rb
-- ext/bson/native.c
-- ext/bson/extconf.rb
 - spec/bson/array_spec.rb
 - spec/bson/binary_spec.rb
 - spec/bson/boolean_spec.rb
 - spec/bson/code_spec.rb
 - spec/bson/code_with_scope_spec.rb
+- spec/bson/date_spec.rb
+- spec/bson/date_time_spec.rb
 - spec/bson/document_spec.rb
 - spec/bson/false_class_spec.rb
 - spec/bson/float_spec.rb
@@ -119,17 +123,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: bson
-rubygems_version: 2.1.11
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Ruby Implementation of the BSON specification
@@ -139,6 +143,8 @@ test_files:
 - spec/bson/boolean_spec.rb
 - spec/bson/code_spec.rb
 - spec/bson/code_with_scope_spec.rb
+- spec/bson/date_spec.rb
+- spec/bson/date_time_spec.rb
 - spec/bson/document_spec.rb
 - spec/bson/false_class_spec.rb
 - spec/bson/float_spec.rb