bson 2.0.0.beta → 2.0.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfc4e9e218bc9b71f1881192cfe7d4a647a085c2
-  data.tar.gz: 3b4f3a00ffb362383bb153471683ccb117d7bed6
+  metadata.gz: 51d0ffbb27a8a61c61ddb11362bedefc925bb93b
+  data.tar.gz: 704a6ba96297053bca1ca64bf4c3955636e3dda1
 SHA512:
-  metadata.gz: 2fe2667809ba737140cc19a02c75cee9e2a96c107ab99d3cd7b6b87f060b15cdfca75eba4ae43eec222a3da8f059a4f8fd5935baec018ea43d76473ac563378e
-  data.tar.gz: 88d6cd83e9f4160c12a433ff624932e4868d6605a3c8202587a5a89a1f8353fb86aecbc4e455e0b4b7eaa1be5cf63dc897774c2a56219d7a65504bd9e48e30d6
+  metadata.gz: da4ee6399c526058ab0448f91e9bac86d8ff1a239e080e4d4f1357689919e5056c987ead50f45b59aa2e7cff7fe5bea52479e6f94021d46729e9512297f51050
+  data.tar.gz: f3e9bd53a3bb5d43b0f07615c0a63b1aef057876fc319e50f8f584fddee3cd08ad3ebb522f3fb19cd69373df0e4fcc88af202fe8250035eaa673e5bd5a663aa5

data/CHANGELOG.md

@@ -0,0 +1,80 @@
+BSON Changelog
+==============
+
+## 2.0.0
+
+### Backwards Incompatible Changes
+
+* `BSON::DEFAULT_MAX_BSON_SIZE` has been removed, as the BSON specification does not
+  provide an upper limit on how large BSON documents can be.
+
+* `BSON.serialize` is no longer the entry point to serialize a BSON document into its
+  raw bytes.
+
+      For Ruby runtimes that support ordered hashes, you may simply call `to_bson` on
+      the hash instance (Alternatively a `BSON::Document` is also a hash:
+
+        { key: "value" }.to_bson
+        BSON::Document[:key, "value"].to_bson
+
+      For Ruby runtimes that do not support ordered hashes, then you must instantiate
+      an instance of a `BSON::Document` (which is a subclass of hash) and call `to_bson`
+      on that, since the BSON specification guarantees order of the fields:
+
+        BSON::Document[:key, "value"].to_bson
+
+* `BSON.deserialize` is no longer the entry point for raw byte deserialization into
+  a document.
+
+      For Ruby runtimes that support ordered hashes, you may simply call `from_bson` on
+      the `Hash` class if you want a `Hash` instance, or on `BSON::Document` if you
+      want an instance of that. The input must be a `StringIO` object:
+
+        Hash.from_bson(stringio)
+        BSON::Document.from_bson(stringio)
+
+      For Ruby runtimes that do not support ordered hashes, then `from_bson` must be
+      called on `BSON::Document` in order to guarantee order:
+
+        BSON::Document.from_bson(stringio)
+
+* Calling `to_json` on custom BSON objects now outputs different results from before, and
+  conforms the BSON specification:
+
+    - `BSON::Binary`: `{ "$binary" : "\x01", "$type" : "md5" }`
+    - `BSON::Code`: `{ "$code" : "this.v = 5 }`
+    - `BSON::CodeWithScope`: `{ "$code" : "this.v = value", "$scope" : { v => 5 }}`
+    - `BSON::MaxKey`: `{ "$maxKey" : 1 }`
+    - `BSON::MinKey`: `{ "$minKey" : 1 }`
+    - `BSON::ObjectId`: `{ "$oid" : "4e4d66343b39b68407000001" }`
+    - `BSON::Timestamp`: `{ "t" : 5, "i" : 30 }`
+    - `Regexp`: `{ "$regex" : "[abc]", "$options" : "i" }`
+
+### New Features
+
+* All Ruby objects that have a corresponding object defined in the BSON specification
+  can now have `to_bson` called on them to get the raw BSON bytes. These objects include:
+
+    - `Array`
+    - `FalseClass`
+    - `Float`
+    - `Hash`
+    - `Integer`
+    - `NilClass`
+    - `Regexp`
+    - `String`
+    - `Symbol` (deprecated)
+    - `Time`
+    - `TrueClass`
+
+* Custom types specific to the BSON specification that have Ruby objects defined for them
+  may also have `to_bson` called on them to get the raw bytes. These types are:
+
+    - `BSON::Binary`
+    - `BSON::Code`
+    - `BSON::CodeWithScope`
+    - `BSON::MaxKey`
+    - `BSON::MinKey`
+    - `BSON::ObjectId`
+    - `BSON::Timestamp`
+    - `BSON::Undefined`

data/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+Contributing
+============
+
+Code Conventions
+----------------
+
+Code style should fall in line with the style guide outlined by
+[Github](https://github.com/styleguide/ruby)
+
+Testing
+-------
+
+Bug fixes and new features should always have the appropriate specs, and the
+specs should follow the following guidelines:
+
+- Prefer `let` and `let!` over the use of instance variables and `subject`.
+- Prefer `expect(...).to eq(...) syntax over `...should eq(...)`.
+- Use shared examples to reduce duplication.
+- Use `describe "#method"` for instance method specs.
+- Use `describe ".method"` for class method specs.
+- Use `context` blocks to set up conditions.
+- Always provide descriptive specifications via `it`.
+
+Specs can be automatically run with Guard, via `bundle exec guard`
+
+Before commiting, run `rake` to ensure all specs pass with both pure Ruby and
+the native extensions.
+
+Git Etiquette
+-------------
+
+Please follow the commit message guidelines as outlined
+[in this blog post](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+If the commit fixes a bug, please add the JIRA number on the last line:
+
+```
+[ close RUBY-492 ]
+```
+
+Please ensure that only one feature/bug fix is in each pull request, and
+that it is squashed into a single commit.

data/LICENSE

@@ -0,0 +1,190 @@
+                                 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 10gen, 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.

data/NOTICE

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

data/README.md

@@ -1,4 +1,4 @@
-BSON [![Build Status](https://secure.travis-ci.org/mongodb/bson-ruby.png?branch=master&.png)](http://travis-ci.org/mongodb/bson-ruby) [![Code Climate](https://codeclimate.com/github/mongodb/bson-ruby.png)](https://codeclimate.com/github/mongodb/bson-ruby)
+BSON [![Build Status](https://secure.travis-ci.org/mongodb/bson-ruby.png?branch=master&.png)](http://travis-ci.org/mongodb/bson-ruby) [![Code Climate](https://codeclimate.com/github/mongodb/bson-ruby.png)](https://codeclimate.com/github/mongodb/bson-ruby) [![Coverage Status](https://coveralls.io/repos/mongodb/bson-ruby/badge.png?branch=master)](https://coveralls.io/r/mongodb/bson-ruby?branch=master)
 ====
 
 An implementation of the BSON specification in Ruby.
@@ -167,6 +167,11 @@ BSON Specification
 
 The [BSON specification](http://bsonspec.org) is at bsonspec.org.
 
+Versioning
+----------
+
+As of 2.0.0, this project adheres to the [Semantic Versioning Specification](http://semver.org/).
+
 License
 -------
 

data/Rakefile

@@ -1,3 +1,17 @@
+# Copyright (C) 2013 10gen 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 "bundler"
 Bundler.setup
 
@@ -42,7 +56,7 @@ end
 RSpec::Core::RakeTask.new(:spec)
 RSpec::Core::RakeTask.new(:rspec)
 
-task :build do
+task :build => :clean_all do
   system "gem build bson.gemspec"
 end
 

data/ext/bson/native.c

@@ -1,3 +1,19 @@
+/*
+ * Copyright (C) 2013 10gen 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.
+ */
+
 #include <arpa/inet.h>
 #include <ruby.h>
 #include <stdint.h>

data/lib/bson.rb

@@ -1,57 +1,19 @@
-# encoding: utf-8
-
-# Determine if we are using JRuby or not.
+# Copyright (C) 2013 10gen Inc.
 #
-# @example Are we running with JRuby?
-#   jruby?
+# 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
 #
-# @return [ true, false ] If JRuby is our vm.
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
-# @since 2.0.0
-def jruby?
-  defined?(JRUBY_VERSION)
-end
+# 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.
 
-# Does the Ruby runtime we are using support ordered hashes?
-#
-# @example Does the runtime support ordered hashes?
-#   ordered_hash_support?
-#
-# @return [ true, false ] If the runtime has ordered hashes.
-#
-# @since 2.0.0
-def ordered_hash_support?
-  jruby? || RUBY_VERSION > "1.9.1"
-end
+require "bson/environment"
 
-# Are we running in a ruby runtime that is version 1.8.x?
-#
-# @since 2.0.0
-def ruby_18?
-  RUBY_VERSION < "1.9"
-end
-
-# In the case where we don't have encoding, we need to monkey
-# patch string to ignore the encoding directives.
-#
-# @since 2.0.0
-if ruby_18?
-
-  class String
-
-    # In versions prior to 1.9 we need to ignore the encoding requests.
-    #
-    # @since 2.0.0
-    def chr; self; end
-    def force_encoding(*); self; end
-    def encode(*); self; end
-    def encode!(*); self; end
-  end
-
-  class EncodingError < RuntimeError; end
-end
-
-#
 # The core namespace for all BSON related behaviour.
 #
 # @since 0.0.0
@@ -113,7 +75,7 @@ require "bson/version"
 #
 # @since 2.0.0
 begin
-  if jruby?
+  if BSON::Environment.jruby?
     require "bson-ruby.jar"
     org.bson.NativeService.new.basicLoad(JRuby.runtime)
   else