jruby-mapdb 0.9.5-java

data/LICENSE-mapdb.txt

@@ -0,0 +1,202 @@
+
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Christian MICHON
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+# Jruby::Mapdb
+
+This is a jruby-only wrapper for MapDB. MapDB is a fast key-value store java library.
+
+Using this gem, MapDB trees are seen as hashes in jruby, making persistence easy and cheap.
+
+2 types of storage from MapDB are available through the API:
+* MemoryDB
+* FileDB
+
+Both MapDB types can co-exist in a same application provided their trees' names do not clash in Class namespace. Exceptions will be raised in such cases.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jruby-mapdb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jruby-mapdb
+
+## Usage
+
+* MemoryDB scenario:
+
+~~~ ruby
+
+require 'jruby-mapdb'
+
+db = Jruby::Mapdb::DB.new # the MemoryDB MapDB
+
+db.tree :People # this will derive a class 'People' from Jruby::Mapdb::Tree, usable as a Hash
+
+People[0] = 'CM'
+p People[0]
+
+People[1] = { :name => 'CM', :features => { :developer => true } }
+p People[1]
+
+~~~
+
+* FileDB scenario:
+
+~~~ ruby
+
+require 'jruby-mapdb'
+
+db = Jruby::Mapdb::DB.new(:foodb) # the FileDB MapDB => 2 files created ('foodb' and 'foodb.p')
+
+db.tree :People # this will derive a class 'People' from Jruby::Mapdb::Tree, usable as a Hash
+
+People[0] = 'CM'
+p People[0]
+
+People[1] = { :name => 'CM', :features => { :developer => true } }
+p People[1]
+
+~~~
+
+## Jruby::Mapdb::Tree API
+
+This API has been kept as simple as possible, compatible with Ruby Hash.
+
+It is compatible with most Enumerable methods: each, find_all, select, reject, entries, etc...
+
+~~~
+
+#[](key)                  retrieve the value stored in tree with key. If the key is not defined yet, return nil.
+
+#[]=(key, value)          store value with key in tree: key *cannot* be nil.
+
+#key?(key)                true if the key is defined in the tree, false otherwise.
+
+#keys                     returns array of all keys stored in tree
+
+#count                    returns count of all keys stored in tree
+#size                     returns count of all keys stored in tree
+
+#regexp(pattern)          returns array of matched keys with pattern (extended + ignorecase)
+
+~~~
+
+## Testing
+
+Testing is done with a single file 'test.rb' on top of this gem:
+* a hack purely based on Test::Unit::TestCase and Unit::Test::Assertions
+* test framework dependency removed
+
+~~~
+$ jruby test.rb
+~~~
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/jruby-mapdb.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jruby/mapdb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jruby-mapdb"
+  spec.version       = Jruby::Mapdb::VERSION
+  spec.platform      = "java"
+  spec.authors       = ["Christian MICHON"]
+  spec.email         = ["christian.michon@gmail.com"]
+  spec.description   = %q{MapDB wrapper for JRuby}
+  spec.summary       = %q{MapDB wrapper}
+  spec.homepage      = "http://github.com/cmichon/jruby-mapdb"
+  spec.license       = "MIT"
+
+  spec.files         = Dir['{**/*}']
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/jruby-mapdb.rb

@@ -0,0 +1,3 @@
+(%w[java] + Dir['**/*.jar']).each { |jar| require jar }
+
+require 'jruby/mapdb'

data/lib/jruby/mapdb.rb

@@ -0,0 +1,68 @@
+require "jruby/mapdb/version"
+
+module Jruby
+  module Mapdb
+    module ClassMethods
+      include Enumerable
+      def encode(key, value)
+        @tree.put key, Marshal.dump(value).to_java_bytes
+      end
+      def decode(key)
+        stored = @tree.get(key)
+        return nil if stored.nil?
+        Marshal.load String.from_java_bytes(stored)
+      end
+      def each
+        @tree.each_pair { |key,value| yield(key, Marshal.load(String.from_java_bytes(value))) }
+      end
+      def key?(key)
+        @tree.has_key? key
+      end
+      def keys
+        @tree.key_set.to_a
+      end
+      def count
+        @tree.size
+      end
+      def regexp(pattern)
+        re = Regexp.new "#{pattern}", Regexp::EXTENDED | Regexp::IGNORECASE
+        @tree.select{ |k,v| "#{k}" =~ re }.map(&:first)
+      end
+      alias :[]=  :encode
+      alias :[]   :decode
+      alias :size :count
+      private
+    end
+    class Tree
+      extend ClassMethods
+    end
+    class DB
+      attr_reader :mapdb, :trees, :type
+      def initialize(dbname=nil)
+        if dbname.nil?
+          @type = :MemoryDB
+          @trees = []
+          @mapdb = Java::OrgMapdb::DBMaker.
+            newMemoryDB().
+            closeOnJvmShutdown().
+            make()
+        else
+          @type = :FileDB
+          @trees = []
+          @mapdb = Java::OrgMapdb::DBMaker.
+            newFileDB(Java::JavaIo::File.new("#{dbname}")).
+            closeOnJvmShutdown().
+            writeAheadLogDisable().
+            make()
+        end
+      end
+      def tree(treename)
+        raise "Tree already defined" if @trees.include?(treename) || Object.const_defined?(treename)
+        trees << treename
+        Object.const_set treename, Class.new(Tree)
+        Object.const_get(treename).instance_variable_set :@mapdb, @mapdb
+        Object.const_get(treename).instance_variable_set :@tree, @mapdb.getTreeMap("#{treename}")
+      end
+    end
+  end
+end

data/lib/jruby/mapdb/version.rb

@@ -0,0 +1,5 @@
+module Jruby
+  module Mapdb
+    VERSION = "0.9.5"
+  end
+end

data/test.rb

@@ -0,0 +1,68 @@
+require 'test/unit'
+
+class TDD < Test::Unit::TestCase
+  def default_test
+    eval DATA.read
+  end
+end
+
+__END__
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+%w[rubygems tempfile jruby-mapdb].map &method(:require)
+
+f = Tempfile.new('testdb')
+
+types = [ :MemoryDB, :FileDB ]
+
+[ Jruby::Mapdb::DB.new,
+  Jruby::Mapdb::DB.new(f.path)
+].each_with_index do |db,i|
+  assert_instance_of Jruby::Mapdb::DB, db
+  assert_equal types[i], db.type
+
+  db.tree :People
+  assert People.is_a?(Enumerable)
+  assert_equal Jruby::Mapdb::Tree, People.superclass
+  assert_equal [:People], db.trees
+  assert_equal [], People.entries
+
+  People[0] = 'CM'
+  People[1] = {
+    :name => 'CM',
+    :features => {
+      :developer => true
+    }
+  }
+
+  assert People.key?(0)
+  assert People.key?(1)
+  assert_equal [1], People.regexp('^1$')
+  assert_equal 2, People.size
+  assert_equal 2, People.count
+  assert_equal [0,1], People.keys
+
+  assert_instance_of String, People[0]
+  assert_equal 'CM', People[0]
+
+  assert_instance_of Hash, People[1]
+  assert_equal 'CM', People[1][:name]
+  assert_instance_of Hash, People[1][:features]
+  assert People[1][:features][:developer]
+
+  assert_raise RuntimeError do
+    db.tree :People
+  end
+  Object.send(:remove_const, :People)
+
+  mapdb = db.instance_variable_get(:@mapdb)
+  mapdb.close
+  assert mapdb.closed?
+
+  if i == 1
+    File.delete(f.path + '.p')
+    f.unlink
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: jruby-mapdb
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.9.5
+platform: java
+authors: 
+  - Christian MICHON
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-09-24 00:00:00 Z
+dependencies: []
+
+description: MapDB wrapper for JRuby
+email: 
+  - christian.michon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - jruby-mapdb.gemspec
+  - LICENSE-mapdb.txt
+  - LICENSE.txt
+  - README.md
+  - test.rb
+  - lib/jruby-mapdb.rb
+  - lib/mapdb-0.9.5.jar
+  - lib/jruby/mapdb.rb
+  - lib/jruby/mapdb/version.rb
+homepage: http://github.com/cmichon/jruby-mapdb
+licenses: 
+  - MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: MapDB wrapper
+test_files: []
+