bson 4.8.0 → 4.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c37081fa823c2700f07a23ca6ecbec6fc67cffbf7915b4a21e59940b332b678d
-  data.tar.gz: 16d483a311c4252f4ef1463be2f86240450b82294a972d8bb5bb2bb332fd7b17
+  metadata.gz: ef5a31f0820c55727982451d554e05971480a6df19a3a959eea4731326193614
+  data.tar.gz: 8928dec44431fa67fba6f5b95a469ee5e8c8d17d12880ac5c35aa556acff697a
 SHA512:
-  metadata.gz: 1618b74348d155c904b2f24739d7b9403bc0b1c23e67cc6ce89a92ac19070dd5965dc1fccc6353c2eefb82993bf5fec30702bccaaf6bb8171777421253832cce
-  data.tar.gz: 1362710c9b36348437bf266a52c18347c1228ddd92231b520e6b068b1742f42895c2108a64cdff2487c5b874c12e3af5ce4d4435c00cebad942b83f1ea9e17ab
+  metadata.gz: 48e4afe1f4da2dd9161e326f05c9c3dcf0f287845eb46fb3eebfe08e761df0e73d36bf0745867fca70ace7345d8a243826da9a0f89f9b3c4a28e903b74817949
+  data.tar.gz: b40043516efec6952d2f83ffa84183ed4e7e23a545ed9b51e12729d65f6a944131468ea4278dccf4cdde5e6ec9f859bc9cad04aeae167f9a143ebe62731df9e3

checksums.yaml.gz.sig

@@ -1,2 +1,4 @@
-�}
-O��t���9�a���2)����=%Zf{ms	3VeB�L)¡o�crp�e��r��@�K�~�
+j4�}��=#��/M��%0L=�_J��WuZ��!7��/�2�3���D3�-�2�\)f$�uDr�2����Ѱ�����q?6���@
+齴F�|��Z�I�|^���漴�g�&�}�LtRK�Q��8����R��ʙɠI�OU�(��B�خ�RF�K�,neU��Jz�)��
+�uYƼ�FQ�4�>�s����R+�1�
�b9�0<l����#H�6
+��Q���'{��}F��+

data/lib/bson/ext_json.rb

@@ -256,7 +256,8 @@ module BSON
             unless value.keys.sort == %w($numberLong)
               raise Error::ExtJSONParseError, "Invalid value for $date: #{value}"
             end
-            ::Time.at(value.values.first.to_i.to_f / 1000)
+            sec, msec = value.values.first.to_i.divmod(1000)
+            ::Time.at(sec, msec*1000)
           else
             raise Error::ExtJSONParseError, "Invalid value for $date: #{value}"
           end

data/lib/bson/hash.rb

@@ -112,7 +112,13 @@ module BSON
           while (type = buffer.get_byte) != NULL_BYTE
             field = buffer.get_cstring
             cls = BSON::Registry.get(type, field)
-            value = cls.from_bson(buffer, **options)
+            value = if options.empty?
+              # Compatibility with the older Ruby driver versions which define
+              # a DBRef class with from_bson accepting a single argument.
+              cls.from_bson(buffer)
+            else
+              cls.from_bson(buffer, **options)
+            end
             hash.store(field, value)
           end
           hash

data/lib/bson/time.rb

@@ -17,6 +17,20 @@ module BSON
   # Injects behaviour for encoding and decoding time values to
   # and from raw bytes as specified by the BSON spec.
   #
+  # @note
+  #   Ruby time can have nanosecond precision:
+  #   +Time.utc(2020, 1, 1, 0, 0, 0, 999_999_999/1000r)+
+  #   +Time#usec+ returns the number of microseconds in the time, and
+  #   if the time has nanosecond precision the sub-microsecond part is
+  #   truncated (the value is floored to the nearest millisecond).
+  #   MongoDB only supports millisecond precision; we truncate the
+  #   sub-millisecond part of microseconds (floor to the nearest millisecond).
+  #   Note that if a time is constructed from a floating point value,
+  #   the microsecond value may round to the starting floating point value
+  #   but due to flooring, the time after serialization may end up to
+  #   be different than the starting floating point value.
+  #   It is recommended that time calculations use integer math only.
+  #
   # @see http://bsonspec.org/#/specification
   #
   # @since 2.0.0
@@ -29,6 +43,8 @@ module BSON
 
     # Get the time as encoded BSON.
     #
+    # @note The time is floored to the nearest millisecond.
+    #
     # @example Get the time as encoded BSON.
     #   Time.new(2012, 1, 1, 0, 0, 0).to_bson
     #
@@ -38,15 +54,15 @@ module BSON
     #
     # @since 2.0.0
     def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
-      # A previous version of this method used the following implementation:
-      # buffer.put_int64((to_i * 1000) + (usec / 1000))
-      # Turns out, usec returned incorrect value - 999 for 1 millisecond.
-      buffer.put_int64((to_f * 1000).round)
+      value = _bson_to_i * 1000 + usec.divmod(1000).first
+      buffer.put_int64(value)
     end
 
     # Converts this object to a representation directly serializable to
     # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
     #
+    # @note The time is floored to the nearest millisecond.
+    #
     # @option options [ true | false ] :relaxed Whether to produce relaxed
     #   extended JSON representation.
     #
@@ -55,12 +71,30 @@ module BSON
       utc_time = utc
       if options[:mode] == :relaxed && (1970..9999).include?(utc_time.year)
         if utc_time.usec != 0
+          if utc_time.respond_to?(:floor)
+            # Ruby 2.7+
+            utc_time = utc_time.floor(3)
+          else
+            utc_time -= utc_time.usec.divmod(1000).last.to_r / 1000000
+          end
           {'$date' => utc_time.strftime('%Y-%m-%dT%H:%M:%S.%LZ')}
         else
           {'$date' => utc_time.strftime('%Y-%m-%dT%H:%M:%SZ')}
         end
       else
-        {'$date' => {'$numberLong' => (utc_time.to_f * 1000).round.to_s}}
+        sec = utc_time._bson_to_i
+        msec = utc_time.usec.divmod(1000).first
+        {'$date' => {'$numberLong' => (sec * 1000 + msec).to_s}}
+      end
+    end
+
+    def _bson_to_i
+      # Workaround for JRuby's #to_i rounding negative timestamps up
+      # rather than down (https://github.com/jruby/jruby/issues/6104)
+      if BSON::Environment.jruby?
+        (self - usec.to_r/1000000).to_i
+      else
+        to_i
       end
     end
 

data/lib/bson/version.rb

@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module BSON
-  VERSION = "4.8.0".freeze
+  VERSION = "4.8.1".freeze
 end

data/spec/bson/time_spec.rb

@@ -43,7 +43,7 @@ describe Time do
       end
     end
 
-    context "when the time is pre epoch" do
+    context "when the time precedes epoch" do
 
       let(:obj)  { Time.utc(1969, 1, 1, 0, 0, 0) }
       let(:bson) { [ (obj.to_f * 1000).to_i ].pack(BSON::Int64::PACK) }
@@ -51,5 +51,208 @@ describe Time do
       it_behaves_like "a serializable bson element"
       it_behaves_like "a deserializable bson element"
     end
+
+    context 'when value has sub-millisecond precision' do
+      let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999) }
+
+      let(:expected_round_tripped_obj) do
+        Time.utc(2012, 1, 1, 0, 0, 0, 999_000)
+      end
+
+      let(:round_tripped_obj) do
+        Time.from_bson(obj.to_bson)
+      end
+
+      it 'truncates to milliseconds when round-tripping' do
+        round_tripped_obj.should == expected_round_tripped_obj
+      end
+    end
+  end
+
+  describe '#as_extended_json' do
+
+    context 'canonical mode' do
+      context 'when value has sub-millisecond precision' do
+        let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999) }
+
+        let(:expected_serialization) do
+          {'$date' => {'$numberLong' => '1325376000999'}}
+        end
+
+        let(:serialization) do
+          obj.as_extended_json
+        end
+
+        shared_examples_for 'truncates to milliseconds when serializing' do
+          it 'truncates to milliseconds when serializing' do
+            serialization.should == expected_serialization
+          end
+        end
+
+        it_behaves_like 'truncates to milliseconds when serializing'
+
+        context 'when value has sub-microsecond precision' do
+          let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999_999/1000r) }
+
+          it_behaves_like 'truncates to milliseconds when serializing'
+        end
+
+        context "when the time precedes epoch" do
+          let(:obj)  { Time.utc(1960, 1, 1, 0, 0, 0, 999_999) }
+
+          let(:expected_serialization) do
+            {'$date' => {'$numberLong' => '-315619199001'}}
+          end
+
+          it_behaves_like 'truncates to milliseconds when serializing'
+        end
+      end
+    end
+
+    context 'relaxed mode' do
+      context 'when value has sub-millisecond precision' do
+        let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999) }
+
+        let(:expected_serialization) do
+          {'$date' => '2012-01-01T00:00:00.999Z'}
+        end
+
+        let(:serialization) do
+          obj.as_extended_json(mode: :relaxed)
+        end
+
+        shared_examples_for 'truncates to milliseconds when serializing' do
+          it 'truncates to milliseconds when serializing' do
+            serialization.should == expected_serialization
+          end
+        end
+
+        it_behaves_like 'truncates to milliseconds when serializing'
+
+        context 'when value has sub-microsecond precision' do
+          let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999_999/1000r) }
+
+          it_behaves_like 'truncates to milliseconds when serializing'
+        end
+
+        context "when the time precedes epoch" do
+          let(:obj)  { Time.utc(1960, 1, 1, 0, 0, 0, 999_999) }
+
+          let(:expected_serialization) do
+            {'$date' => {'$numberLong' => '-315619199001'}}
+          end
+
+          it_behaves_like 'truncates to milliseconds when serializing'
+        end
+      end
+    end
+  end
+
+  describe '#to_extended_json' do
+
+    context 'canonical mode' do
+      context 'when value has sub-millisecond precision' do
+        let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999) }
+
+        let(:expected_serialization) do
+          %q`{"$date":{"$numberLong":"1325376000999"}}`
+        end
+
+        let(:serialization) do
+          obj.to_extended_json
+        end
+
+        shared_examples_for 'truncates to milliseconds when serializing' do
+          it 'truncates to milliseconds when serializing' do
+            serialization.should == expected_serialization
+          end
+        end
+
+        it_behaves_like 'truncates to milliseconds when serializing'
+
+        context 'when value has sub-microsecond precision' do
+          let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999_999/1000r) }
+
+          it_behaves_like 'truncates to milliseconds when serializing'
+        end
+
+        context "when the time precedes epoch" do
+          let(:obj)  { Time.utc(1960, 1, 1, 0, 0, 0, 999_999) }
+
+          let(:expected_serialization) do
+            %q`{"$date":{"$numberLong":"-315619199001"}}`
+          end
+
+          it_behaves_like 'truncates to milliseconds when serializing'
+        end
+      end
+    end
+
+    context 'relaxed mode' do
+      context 'when value has sub-millisecond precision' do
+        let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999) }
+
+        let(:expected_serialization) do
+          %q`{"$date":"2012-01-01T00:00:00.999Z"}`
+        end
+
+        let(:serialization) do
+          obj.to_extended_json(mode: :relaxed)
+        end
+
+        shared_examples_for 'truncates to milliseconds when serializing' do
+          it 'truncates to milliseconds when serializing' do
+            serialization.should == expected_serialization
+          end
+        end
+
+        it_behaves_like 'truncates to milliseconds when serializing'
+
+        context 'when value has sub-microsecond precision' do
+          let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999_999/1000r) }
+
+          it_behaves_like 'truncates to milliseconds when serializing'
+        end
+      end
+    end
+  end
+
+  describe '#to_json' do
+
+    context 'when value has sub-millisecond precision' do
+      let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999) }
+
+      let(:expected_serialization) do
+        %q`"2012-01-01 00:00:00 UTC"`
+      end
+
+      let(:serialization) do
+        obj.to_json
+      end
+
+      shared_examples_for 'truncates to milliseconds when serializing' do
+        it 'truncates to milliseconds when serializing' do
+          serialization.should == expected_serialization
+        end
+      end
+
+      it_behaves_like 'truncates to milliseconds when serializing'
+
+      context 'when value has sub-microsecond precision' do
+        let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999_999/1000r) }
+
+        it_behaves_like 'truncates to milliseconds when serializing'
+      end
+
+      context "when the time precedes epoch" do
+        let(:obj)  { Time.utc(1960, 1, 1, 0, 0, 0, 999_999) }
+
+        let(:expected_serialization) do
+          %q`"1960-01-01 00:00:00 UTC"`
+        end
+
+        it_behaves_like 'truncates to milliseconds when serializing'
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bson
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.8.1
 platform: ruby
 authors:
 - Tyler Brock
@@ -33,7 +33,7 @@ cert_chain:
   gpvfPNWMwyBDlHaNS3GfO6cRRxBOvEG05GUCsvtTY4Bpe8yjE64wg1ymb47LMOnv
   Qb1lGORmf/opg45mluKUYl7pQNZHD0d3
   -----END CERTIFICATE-----
-date: 2020-02-27 00:00:00.000000000 Z
+date: 2020-03-03 00:00:00.000000000 Z
 dependencies: []
 description: A fully featured BSON specification implementation in Ruby
 email: