bson 1.2.0-jruby

data/LICENSE.txt

@@ -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 2008-2010 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/bin/b2json

@@ -0,0 +1,65 @@
+#!/usr/bin/ruby
+# encoding: UTF-8
+
+# --
+# Copyright (C) 2008-2010 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 'rubygems'
+require 'bson'
+
+# Note that this will not properly round-trip in all cases
+# from the output generated by j2bson.
+begin
+require 'yajl'
+rescue LoadError
+  puts "This script requires yajl. Please install as follows:"
+  puts "  gem install yajl-ruby" 
+  Process.exit
+end
+
+# Convert all documents in an IO into JSON.
+def print_b2json(io)
+  while not io.eof? do
+    bsonobj = BSON.read_bson_document(io)
+    Yajl::Encoder.encode(bsonobj, STDOUT)
+    STDOUT << "\n"
+  end
+end
+
+# print usage
+def usage()
+    STDERR << <<END_OF_USAGE
+usage:  b2json [-h] [file1 [file2]]
+
+   Converts a BSON file to JSON on STDOUT.
+   You can pass multiple filenames.
+   If no filenames are passed, then STDIN is consumed.
+
+END_OF_USAGE
+    exit
+end
+
+# no arg, use STDIN
+# -h, print usage and exit
+# otherwise loop of filenames
+if ARGV.empty? then
+    print_b2json(STDIN)
+    exit
+elsif ARGV[0] == "-h" then
+    usage()
+else
+    ARGV.each { |fname| print_b2json(File.new(fname)) }
+end

data/bin/j2bson

@@ -0,0 +1,72 @@
+#!/usr/bin/ruby
+# encoding: UTF-8
+
+# --
+# Copyright (C) 2008-2010 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 'rubygems'
+require 'bson'
+
+# We don't use YAJL because we need to specify the class
+# to store the JSON object in.  BSON is ordered so we need BSON::OrderedHash
+#
+# We use json/pure because json/ext is broken with BSON::OrderedHash
+# (probably for the same reasons that we can't use YAJL).
+#
+# Note that, at the moment, this will not properly round-trip
+# in all cases from the output generated by b2json.
+begin
+require 'json/pure'  # broken with 'json/ext'
+rescue LoadError
+  puts "This script requires json/pure. Please install one of the following:"
+  puts "  gem install json_pure" 
+  puts "  gem install json" 
+  Process.exit
+end
+
+# Convert all JSON objects in an IO into BSON.
+def print_j2bson(io)
+  io.each_line do |line|
+    jsonobj = JSON.parse(line, { :object_class => BSON::OrderedHash } )
+    bsonobj = BSON.serialize(jsonobj)
+    STDOUT << bsonobj.to_s
+  end
+end
+
+# print usage
+def usage()
+    STDERR << <<END_OF_USAGE
+usage:  j2bson [-h] [file1 [file2]]
+
+   Converts a JSON file to BSON on STDOUT.
+   You can pass multiple filenames.
+   If no filenames are passed, then STDIN is consumed.
+
+END_OF_USAGE
+    exit
+end
+
+# no arg, use STDIN
+# -h, print usage and exit
+# otherwise loop of filenames
+if ARGV.empty? then
+    print_j2bson(STDIN)
+    exit
+elsif ARGV[0] == "-h" then
+    usage()
+else
+    ARGV.each { |fname| print_j2bson(File.new(fname)) }
+end

data/lib/bson.rb

@@ -0,0 +1,108 @@
+# encoding: UTF-8
+#
+# --
+# Copyright (C) 2008-2011 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.
+# ++
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+MINIMUM_BSON_EXT_VERSION = "1.2.0"
+
+module BSON
+  VERSION = "1.2.0"
+
+  if defined? Mongo::DEFAULT_MAX_BSON_SIZE
+    DEFAULT_MAX_BSON_SIZE = Mongo::DEFAULT_MAX_BSON_SIZE
+  else
+    DEFAULT_MAX_BSON_SIZE = 4 * 1024 * 1024
+  end
+
+  def self.serialize(obj, check_keys=false, move_id=false)
+    BSON_CODER.serialize(obj, check_keys, move_id)
+  end
+
+  def self.deserialize(buf=nil)
+    BSON_CODER.deserialize(buf)
+  end
+
+  # Reads a single BSON document from an IO object.
+  # This method is used in the executable b2json, bundled with
+  # the bson gem, for reading a file of bson documents.
+  #
+  # @param [IO] io an io object containing a bson object.
+  #
+  # @return [ByteBuffer]
+  def self.read_bson_document(io)
+    bytebuf = BSON::ByteBuffer.new
+    sz = io.read(4).unpack("V")[0]
+    bytebuf.put_int(sz)
+    bytebuf.put_array(io.read(sz-4).unpack("C*"))
+    bytebuf.rewind
+    return BSON.deserialize(bytebuf)
+  end
+end
+
+if RUBY_PLATFORM =~ /java/
+  jar_dir = File.join(File.dirname(__FILE__), '..', 'ext', 'java', 'jar')
+  require File.join(jar_dir, 'mongo-2.4.jar')
+  require File.join(jar_dir, 'bson-2.2.jar')
+  require File.join(jar_dir, 'jbson.jar')
+  require 'bson/bson_java'
+  module BSON
+    BSON_CODER = BSON_JAVA
+  end
+else
+  begin
+    # Need this for running test with and without c ext in Ruby 1.9.
+    raise LoadError if ENV['TEST_MODE'] && !ENV['C_EXT']
+
+    # Raise LoadError unless little endian
+    raise LoadError unless "\x01\x00\x00\x00".unpack("i").first == 1
+
+    require 'bson_ext/cbson'
+    raise LoadError unless defined?(CBson::VERSION)
+    if CBson::VERSION < MINIMUM_BSON_EXT_VERSION
+      puts "Able to load bson_ext version #{CBson::VERSION}, but >= #{MINIMUM_BSON_EXT_VERSION} is required."
+      raise LoadError
+    end
+    require 'bson/bson_c'
+    module BSON
+      BSON_CODER = BSON_C
+    end
+  rescue LoadError
+    require 'bson/bson_ruby'
+    module BSON
+      BSON_CODER = BSON_RUBY
+    end
+    unless ENV['TEST_MODE']
+      warn "\n**Notice: C extension not loaded. This is required for optimum MongoDB Ruby driver performance."
+      warn "  You can install the extension as follows:\n  gem install bson_ext\n"
+      warn "  If you continue to receive this message after installing, make sure that the"
+      warn "  bson_ext gem is in your load path and that the bson_ext and mongo gems are of the same version.\n"
+    end
+  end
+end
+
+require 'bson/types/binary'
+require 'bson/types/code'
+require 'bson/types/dbref'
+require 'bson/types/object_id'
+require 'bson/types/min_max_keys'
+
+require 'base64'
+require 'bson/ordered_hash'
+require 'bson/byte_buffer'
+require 'bson/bson_ruby'
+require 'bson/exceptions'

data/lib/bson/bson_c.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+
+# --
+# Copyright (C) 2008-2011 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.
+# ++
+
+# A thin wrapper for the CBson class
+module BSON
+  class BSON_C
+
+    def self.serialize(obj, check_keys=false, move_id=false)
+      ByteBuffer.new(CBson.serialize(obj, check_keys, move_id))
+    end
+
+    def self.deserialize(buf=nil)
+      CBson.deserialize(ByteBuffer.new(buf).to_s)
+    end
+
+    def self.max_bson_size
+      CBson.max_bson_size
+    end
+
+    def self.update_max_bson_size(connection)
+      CBson.update_max_bson_size(connection)
+    end
+  end
+end