bson 1.12.5 → 2.0.0.alpha

data/lib/bson/time.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+module BSON
+
+  # Injects behaviour for encoding and decoding time values to
+  # and from raw bytes as specified by the BSON spec.
+  #
+  # @see http://bsonspec.org/#/specification
+  #
+  # @since 2.0.0
+  module Time
+
+    # A time is type 0x09 in the BSON spec.
+    #
+    # @since 2.0.0
+    BSON_TYPE = 9.chr.force_encoding(BINARY).freeze
+
+    # Get the time as encoded BSON.
+    #
+    # @example Get the time as encoded BSON.
+    #   Time.new(2012, 1, 1, 0, 0, 0).to_bson
+    #
+    # @return [ String ] The encoded string.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.0.0
+    def to_bson(encoded = ''.force_encoding(BINARY))
+      encoded << [ (to_f * 1000.0).to_i ].pack(Int64::PACK)
+    end
+
+    module ClassMethods
+
+      # Deserialize UTC datetime from BSON.
+      #
+      # @param [ BSON ] bson The bson representing UTC datetime.
+      #
+      # @return [ Time ] The decoded UTC datetime.
+      #
+      # @see http://bsonspec.org/#/specification
+      #
+      # @since 2.0.0
+      def from_bson(bson)
+        seconds, fragment = Int64.from_bson(bson).divmod(1000)
+        at(seconds, fragment * 1000).utc
+      end
+    end
+
+    # Register this type when the module is loaded.
+    #
+    # @since 2.0.0
+    Registry.register(BSON_TYPE, ::Time)
+  end
+
+  # Enrich the core Time class with this module.
+  #
+  # @since 2.0.0
+  ::Time.send(:include, Time)
+  ::Time.send(:extend, Time::ClassMethods)
+end

data/lib/bson/timestamp.rb

@@ -0,0 +1,100 @@
+# encoding: utf-8
+module BSON
+
+  # Represents a timestamp type, which is predominately used for sharding.
+  #
+  # @see http://bsonspec.org/#/specification
+  #
+  # @since 2.0.0
+  class Timestamp
+    include JSON
+
+    # A timestamp is type 0x11 in the BSON spec.
+    #
+    # @since 2.0.0
+    BSON_TYPE = 17.chr.force_encoding(BINARY).freeze
+
+    # @!attribute seconds
+    #   @return [ Integer ] The number of seconds.
+    #   @since 2.0.0
+    #
+    # @!attribute increment
+    #   @return [ Integer ] The incrementing value.
+    #   @since 2.0.0
+    #
+    attr_reader :seconds, :increment
+
+    # Determine if this timestamp is equal to another object.
+    #
+    # @example Check the timestamp equality.
+    #   timestamp == other
+    #
+    # @param [ Object ] other The object to compare against.
+    #
+    # @return [ true, false ] If the objects are equal.
+    #
+    # @since 2.0.0
+    def ==(other)
+      return false unless other.is_a?(Timestamp)
+      seconds == other.seconds && increment == other.increment
+    end
+
+    # Get the timestamp as JSON hash data.
+    #
+    # @example Get the timestamp as a JSON hash.
+    #   timestamp.as_json
+    #
+    # @return [ Hash ] The timestamp as a JSON hash.
+    #
+    # @since 2.0.0
+    def as_json(*args)
+      { "t" => seconds, "i" => increment }
+    end
+
+    # Instantiate the new timestamp.
+    #
+    # @example Instantiate the timestamp.
+    #   BSON::Timestamp.new(5, 30)
+    #
+    # @param [ Integer ] seconds The number of seconds.
+    # @param [ Integer ] increment The increment value.
+    #
+    # @since 2.0.0
+    def initialize(seconds, increment)
+      @seconds, @increment = seconds, increment
+    end
+
+    # Get the timestamp as its encoded raw BSON bytes.
+    #
+    # @example Get the timestamp as BSON.
+    #   timestamp.to_bson
+    #
+    # @return [ String ] The raw BSON bytes.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.0.0
+    def to_bson(encoded = ''.force_encoding(BINARY))
+      increment.to_bson_int32(encoded)
+      seconds.to_bson_int32(encoded)
+    end
+
+    # Deserialize timestamp from BSON.
+    #
+    # @param [ BSON ] bson The bson representing a timestamp.
+    #
+    # @return [ Timestamp ] The decoded timestamp.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.0.0
+    def self.from_bson(bson)
+      new(*bson.read(8).unpack(Int32::PACK * 2).reverse)
+    end
+
+    # Register this type when the module is loaded.
+    #
+    # @since 2.0.0
+    Registry.register(BSON_TYPE, self)
+  end
+end

data/lib/bson/true_class.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+module BSON
+
+  # Injects behaviour for encoding and decoding true values to and from
+  # raw bytes as specified by the BSON spec.
+  #
+  # @see http://bsonspec.org/#/specification
+  #
+  # @since 2.0.0
+  module TrueClass
+
+    # A true value in the BSON spec is 0x01.
+    #
+    # @since 2.0.0
+    TRUE_BYTE = 1.chr.force_encoding(BINARY).freeze
+
+    # The BSON type for true values is the general boolean type of 0x08.
+    #
+    # @example Get the bson type.
+    #   false.bson_type
+    #
+    # @return [ String ] The character 0x08.
+    #
+    # @since 2.0.0
+    def bson_type
+      Boolean::BSON_TYPE
+    end
+
+    # Get the true boolean as encoded BSON.
+    #
+    # @example Get the true boolean as encoded BSON.
+    #   true.to_bson
+    #
+    # @return [ String ] The encoded string.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.0.0
+    def to_bson(encoded = ''.force_encoding(BINARY))
+      encoded << TRUE_BYTE
+    end
+  end
+
+  # Enrich the core TrueClass class with this module.
+  #
+  # @since 2.0.0
+  ::TrueClass.send(:include, TrueClass)
+end

data/lib/bson/undefined.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+module BSON
+
+  # Represents the Undefined BSON type
+  #
+  # @see http://bsonspec.org/#/specification
+  #
+  # @since 2.0.0
+  class Undefined
+
+    # Undefined is type 0x06 in the BSON spec.
+    #
+    # @since 2.0.0
+    BSON_TYPE = 6.chr.force_encoding(BINARY).freeze
+
+    # Determine if undefined is equal to another object.
+    #
+    # @example Check undefined equality.
+    #   BSON::Undefined.new == object
+    #
+    # @param [ Object ] other The object to check against.
+    #
+    # @return [ true, false ] If the objects are equal.
+    #
+    # @since 2.0.0
+    def ==(other)
+      self.class == other.class
+    end
+
+    # Encode the Undefined field - has no value since it only needs the type 
+    # and field name when being encoded.
+    #
+    # @example Encode the undefined value.
+    #   Undefined.to_bson
+    #
+    # @return [ String ] An empty string.
+    #
+    # @since 2.0.0
+    def to_bson(encoded = ''.force_encoding(BINARY))
+      encoded
+    end
+
+    # Deserialize undefined BSON type from BSON.
+    #
+    # @param [ BSON ] bson The encoded undefined value.
+    #
+    # @return [ Undefined ] The decoded undefined value.
+    #
+    # @see http://bsonspec.org/#/specification
+    #
+    # @since 2.0.0
+    def self.from_bson(bson)
+      new
+    end
+
+    # Register this type when the module is loaded.
+    #
+    # @since 2.0.0
+    Registry.register(BSON_TYPE, self)
+  end
+end

data/lib/bson/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module BSON
+  VERSION = "2.0.0.alpha"
+end

metadata

@@ -1,50 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: bson
 version: !ruby/object:Gem::Version
-  version: 1.12.5
+  version: 2.0.0.alpha
 platform: ruby
 authors:
-- Emily Stolfo
-- Durran Jordan
-- Gary Murakami
 - Tyler Brock
+- Durran Jordan
 - Brandon Black
+- Emily Stolfo
+- Gary Murakami
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-01 00:00:00.000000000 Z
+date: 2013-05-08 00:00:00.000000000 Z
 dependencies: []
-description: A Ruby BSON implementation for MongoDB. For more information about Mongo,
-  see http://www.mongodb.org. For more information on BSON, see http://www.bsonspec.org.
-email: mongodb-dev@googlegroups.com
-executables:
-- b2json
-- j2bson
-extensions: []
+description: A full featured BSON specification implementation, in Ruby
+email:
+- mongodb-dev@googlegroups.com
+executables: []
+extensions:
+- ext/bson/extconf.rb
 extra_rdoc_files: []
 files:
-- LICENSE
-- VERSION
-- bin/b2json
-- bin/j2bson
-- bson.gemspec
+- CONTRIBUTING.md
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/bson/array.rb
+- lib/bson/binary.rb
+- lib/bson/boolean.rb
+- lib/bson/code.rb
+- lib/bson/code_with_scope.rb
+- lib/bson/document.rb
+- lib/bson/encodable.rb
+- lib/bson/false_class.rb
+- lib/bson/float.rb
+- lib/bson/hash.rb
+- lib/bson/int32.rb
+- lib/bson/int64.rb
+- lib/bson/integer.rb
+- lib/bson/json.rb
+- lib/bson/max_key.rb
+- lib/bson/min_key.rb
+- lib/bson/nil_class.rb
+- lib/bson/object_id.rb
+- lib/bson/regexp.rb
+- lib/bson/registry.rb
+- lib/bson/specialized.rb
+- lib/bson/string.rb
+- lib/bson/symbol.rb
+- lib/bson/time.rb
+- lib/bson/timestamp.rb
+- lib/bson/true_class.rb
+- lib/bson/undefined.rb
+- lib/bson/version.rb
 - lib/bson.rb
-- lib/bson/bson_c.rb
-- lib/bson/bson_java.rb
-- lib/bson/bson_ruby.rb
-- lib/bson/byte_buffer.rb
-- lib/bson/exceptions.rb
-- lib/bson/grow.rb
-- lib/bson/ordered_hash.rb
-- lib/bson/support/hash_with_indifferent_access.rb
-- lib/bson/types/binary.rb
-- lib/bson/types/code.rb
-- lib/bson/types/dbref.rb
-- lib/bson/types/min_max_keys.rb
-- lib/bson/types/object_id.rb
-- lib/bson/types/regex.rb
-- lib/bson/types/timestamp.rb
-homepage: http://www.mongodb.org
+- ext/bson/extconf.rb
+homepage: http://bsonspec.org
 licenses:
 - Apache License Version 2.0
 metadata: {}
@@ -54,19 +67,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.6
 requirements: []
 rubyforge_project: bson
-rubygems_version: 2.4.6
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Ruby implementation of BSON
+summary: Ruby Implementation of the BSON specification
 test_files: []
-has_rdoc: yard

data/LICENSE

@@ -1,190 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   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.
-   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.