bson 2.0.0.rc-java → 2.1.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 307335e37546cd82f6e667451cc88adfe922f35a
+  data.tar.gz: baa7ca7c5d40dc61e37a1f0fbc32f337eadfee76
+SHA512:
+  metadata.gz: fabf976f05db48b58ed77e28bb5e3b7b34a3997b567314311644a68819cbcb3c24453dc761e855acab17a941c9a4145ebd77de79d231a0ce9d068895ce6775c0
+  data.tar.gz: 4aa797cefb195fa4e0046a2dc79a20b3fd0c5cf4691ecd1330681c9f5184834c39f432915ab368c09b1f60c6ee672c652642e9df644babefdb663742acbb7583

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/LICENSE

@@ -175,7 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   Copyright (C) 2008-2013 10gen, Inc.
+   Copyright (C) 2008-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.

data/NOTICE

@@ -1,2 +1,2 @@
 Ruby BSON
-Copyright (C) 2009-2013 10gen, Inc.
+Copyright (C) 2009-2013 MongoDB, Inc.

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
 -----------------
 
@@ -175,7 +181,7 @@ As of 2.0.0, this project adheres to the [Semantic Versioning Specification](htt
 License
 -------
 
-Copyright (C) 2013 10gen Inc.
+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.

data/Rakefile

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# 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.
@@ -56,27 +56,44 @@ end
 RSpec::Core::RakeTask.new(:spec)
 RSpec::Core::RakeTask.new(:rspec)
 
-task :build => :clean_all do
-  system "gem build bson.gemspec"
+if jruby?
+  task :build => [ :clean_all, :compile ] do
+    system "gem build bson.gemspec"
+  end
+else
+  task :build => :clean_all do
+    system "gem build bson.gemspec"
+  end
 end
 
 task :clean_all => :clean do
   begin
-    Dir.chdir(Pathname(__FILE__).dirname + "lib/bson") do
+    Dir.chdir(Pathname(__FILE__).dirname + "lib") do
       `rm native.#{extension}`
       `rm native.o`
-      `rm native.jar`
+      `rm bson-ruby.jar`
     end
   rescue Exception => e
     puts e.message
   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}'"
   system "git push --tags"
-  system "gem push bson-#{BSON::VERSION}.gem"
-  system "rm bson-#{BSON::VERSION}.gem"
+  if jruby?
+    system "gem push bson-#{BSON::VERSION}-java.gem"
+    system "rm bson-#{BSON::VERSION}-java.gem"
+  else
+    system "gem push bson-#{BSON::VERSION}.gem"
+    system "rm bson-#{BSON::VERSION}.gem"
+  end
 end
 
 namespace :benchmark do
@@ -94,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

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# 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.
@@ -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/array.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# 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.
@@ -51,6 +51,23 @@ module BSON
       end
     end
 
+    # Convert the array to an object id. This will only work for arrays of size
+    # 12 where the elements are all strings.
+    #
+    # @example Convert the array to an object id.
+    #   array.to_bson_object_id
+    #
+    # @note This is used for repairing legacy bson data.
+    #
+    # @raise [ InvalidObjectId ] If the array is not 12 elements.
+    #
+    # @return [ String ] The raw object id bytes.
+    #
+    # @since 2.0.0
+    def to_bson_object_id
+      ObjectId.repair(self) { pack("C*") }
+    end
+
     module ClassMethods
 
       # Deserialize the array from BSON.

data/lib/bson/binary.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# 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.
@@ -91,6 +91,7 @@ module BSON
     #
     # @since 2.0.0
     def initialize(data = "", type = :generic)
+      validate_type!(type)
       @data = data
       @type = type
     end
@@ -130,6 +131,60 @@ module BSON
       new(data, type)
     end
 
+    # Raised when providing an invalid type to the Binary.
+    #
+    # @since 2.0.0
+    class InvalidType < RuntimeError
+
+      # @!attribute type
+      #   @return [ Object ] The invalid type.
+      #   @since 2.0.0
+      attr_reader :type
+
+      # Instantiate the new error.
+      #
+      # @example Instantiate the error.
+      #   InvalidType.new(:error)
+      #
+      # @param [ Object ] type The invalid type.
+      #
+      # @since 2.0.0
+      def initialize(type)
+        @type = type
+      end
+
+      # Get the custom error message for the exception.
+      #
+      # @example Get the message.
+      #   error.message
+      #
+      # @return [ String ] The error message.
+      #
+      # @since 2.0.0
+      def message
+        "#{type.inspect} is not a valid binary type. " +
+          "Please use one of #{SUBTYPES.keys.map(&:inspect).join(", ")}."
+      end
+    end
+
+    private
+
+    # Validate the provided type is a valid type.
+    #
+    # @api private
+    #
+    # @example Validate the type.
+    #   binary.validate_type!(:user)
+    #
+    # @param [ Object ] type The provided type.
+    #
+    # @raise [ InvalidType ] The the type is invalid.
+    #
+    # @since 2.0.0
+    def validate_type!(type)
+      raise InvalidType.new(type) unless SUBTYPES.has_key?(type)
+    end
+
     # Register this type when the module is loaded.
     #
     # @since 2.0.0

data/lib/bson/boolean.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# 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.

data/lib/bson/code.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# 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.

data/lib/bson/code_with_scope.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# 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.
@@ -89,10 +89,13 @@ module BSON
     #
     # @since 2.0.0
     def to_bson(encoded = ''.force_encoding(BINARY))
-      encode_with_placeholder_and_null(BSON_ADJUST, encoded) do |encoded|
+      # -1 because we are removing an extra byte
+      out = encode_with_placeholder_and_null(BSON_ADJUST - 1, encoded) do |encoded|
         javascript.to_bson(encoded)
         scope.to_bson(encoded)
       end
+      # an extra null byte has been added; we must remove it
+      out.chop!
     end
 
     # Deserialize a code with scope from BSON.
@@ -105,9 +108,8 @@ module BSON
     #
     # @since 2.0.0
     def self.from_bson(bson)
-      code_with_scope = StringIO.new(bson.read(Int32.from_bson(bson)))
-      length = code_with_scope.read(4).unpack(Int32::PACK).first
-      new(code_with_scope.read(length).from_bson_string.chop!)
+      bson.read(4) # Throw away the total length.
+      new(bson.read(Int32.from_bson(bson)).from_bson_string.chop!, ::Hash.from_bson(bson))
     end
 
     # Register this type when the module is loaded.

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/document.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# 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.

data/lib/bson/encodable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# 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.

data/lib/bson/environment.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2013 10gen Inc.
+# 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.
@@ -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?