leveldb-native 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 239b4f05b8dfe841e93f81d3c173a0eed17c6c5a
+  data.tar.gz: 5fa95a754b9c3b86912e2564b6f93e62b43bf5c6
+SHA512:
+  metadata.gz: 2578c6532e99ccfb04b1111fc04d148f1ed5959c56d6ff3c10452b42f964d09ea813171662146782e2db35f647fa9e61a162192da84900cdf1927dcacb252613
+  data.tar.gz: 67f52e24344fb62ee720c680bb78eccb03b2044cdfd3e2f393a8e14493e8bada443d7ab8f6e0b5b327e1a8d2d4bab00658341c9a34dcd64818dcd256d4c3b1ab

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Joel VanderWerf
+
+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,68 @@
+ruby-leveldb-native
+===================
+
+A ruby binding to levelDB. It is native in two senses:
+
+1. Uses libleveldb as a C/C++ ruby extension, rather than through FFI.
+
+2. Uses the natively installed libleveldb, rather than trying to build and install libleveldb as part of the gem.
+
+LevelDB
+-------
+
+[LevelDB] (http://code.google.com/p/leveldb/) is a persistent key-value store developed at Google.
+
+Installation
+------------
+
+The gem installs in the normal way:
+
+    gem install leveldb-native
+
+However, you need to have libleveldb installed. It may be available as part of your OS (from debian repos, for example), or you may prefer to install from source. The source packages from google do not have install scripts, but that is easy to fix. Here is a git repo with the necessary fixes to the makefile:
+
+    https://github.com/vjoel/leveldb
+
+Just follow the instructions in that repo's README to build and install.
+
+FAQ
+---
+
+1.  Why not use the [leveldb gem] (https://github.com/DAddYE/leveldb) instead?
+
+    1.  Doesn't support the full functionality of snapshots. Snapshots in this gem can only be used to switch the state of the DB object, but not act as independent and concurrent readable views of the database at different points in time.
+
+    2.  Tries to maintain its own installation of libleveldb, which may be a different version from the system-wide installation.
+
+    3.  Accesses the lib using FFI, which is slower than ruby's native extension architecture. (See benchmarks at the link above.)
+
+2.  Why not use the [leveldb-ruby gem] (https://github.com/wmorgan/leveldb-ruby) instead?
+
+    1.  Not maintained regularly.
+
+    2.  Tries to maintain its own installation of libleveldb.
+
+    3.  No snapshots.
+
+This gem attempts to maintain compatibility with the leveldb-ruby gem, while adding more features.
+
+Acknowledgement
+---------------
+
+This gem owes much to William Morgan's gem, https://github.com/wmorgan/leveldb-ruby.
+
+Contact
+-------
+
+This project is hosted at https://github.com/vjoel/leveldb-native.
+
+Joel VanderWerf, vjoel@users.sourceforge.net.
+
+License and Copyright
+---------------------
+
+Copyright (c) 2013, Joel VanderWerf.
+
+Portions of ext/leveldb-native/leveldb-native.cc are copyright William Morgan.
+
+License for this project is MIT. See the LICENSE file for the standard MIT license.

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rake'
+require 'rake/testtask'
+
+PRJ = "leveldb-native"
+
+def version
+  @version ||= begin
+    require 'leveldb-native/version'
+    warn "LevelDBNative::VERSION not a string" unless
+      LevelDBNative::VERSION.kind_of? String
+    LevelDBNative::VERSION
+  end
+end
+
+def tag
+  @tag ||= "#{PRJ}-#{version}"
+end
+
+desc "Run unit tests"
+Rake::TestTask.new :test do |t|
+  t.libs << "lib"
+  t.libs << "ext"
+  t.test_files = FileList["test/*.rb"]
+end
+
+desc "Commit, tag, and push repo; build and push gem"
+task :release => "release:is_new_version" do
+  require 'tempfile'
+  
+  sh "gem build #{PRJ}.gemspec"
+
+  file = Tempfile.new "template"
+  begin
+    file.puts "release #{version}"
+    file.close
+    sh "git commit --allow-empty -a -v -t #{file.path}"
+  ensure
+    file.close unless file.closed?
+    file.unlink
+  end
+
+  sh "git tag #{tag}"
+  sh "git push"
+  sh "git push --tags"
+  
+  sh "gem push #{tag}.gem"
+end
+
+namespace :release do
+  desc "Diff to latest release"
+  task :diff do
+    latest = `git describe --abbrev=0 --tags --match '#{PRJ}-*'`.chomp
+    sh "git diff #{latest}"
+  end
+
+  desc "Log to latest release"
+  task :log do
+    latest = `git describe --abbrev=0 --tags --match '#{PRJ}-*'`.chomp
+    sh "git log #{latest}.."
+  end
+
+  task :is_new_version do
+    abort "#{tag} exists; update version!" unless `git tag -l #{tag}`.empty?
+  end
+end

data/example/snapshot.rb

@@ -0,0 +1,33 @@
+require 'leveldb-native'
+
+db = LevelDBNative::DB.new '/tmp/leveldb-example-snapshot'
+
+db["a"] = "1"
+db["b"] = "1"
+db.delete "c"
+puts "initialized database to #{db.to_a}"
+puts
+
+puts "snapshot:"
+db.snapshot do |sn|
+  puts "value at a is #{sn["a"]}"
+  sn.each {|k,v| puts "  #{k} => #{v}"}
+end
+puts
+
+sn = db.snapshot
+puts "taking new snapshot"
+db["b"] = "2"
+puts "put 'b' => #{db["b"].inspect}"
+db["c"] = "2"
+puts "put 'c' => #{db["c"].inspect}"
+
+puts "snapshot is: #{sn.to_a}"
+puts "database is: #{db.to_a}"
+puts
+
+sn.release
+puts "relasing snapshot (will now reflect current db state)"
+puts "snapshot is: #{sn.to_a}"
+puts "database is: #{db.to_a}"
+puts

data/ext/leveldb-native/extconf.rb

@@ -0,0 +1,5 @@
+require 'mkmf'
+
+have_library "leveldb" or abort "Can't find leveldb library."
+
+create_makefile "leveldb_native"

data/lib/leveldb-native.rb

@@ -0,0 +1,156 @@
+require 'leveldb-native/leveldb_native'
+
+module LevelDBNative
+  class DB
+    include Enumerable
+
+    class << self
+      # Loads or creates a database as necessary, stored on disk at
+      # +pathname+.
+      #
+      # See #make for possible options.
+      def new pathname, options={}
+        make path_string(pathname),
+             options.merge(:create_if_missing => true,
+                           :error_if_exists => false)
+      end
+
+      # Creates a new database stored on disk at +pathname+. Raises
+      # LevelDBNative::Error if the database already exists.
+      #
+      # See #make for possible options.
+      def create pathname, options={}
+        make path_string(pathname),
+             options.merge(:create_if_missing => true,
+                           :error_if_exists => true)
+      end
+
+      # Loads a database stored on disk at +pathname+. Raises
+      # LevelDBNative::Error unless the database already exists.
+      def load pathname
+        make path_string(pathname),
+             :create_if_missing => false, :error_if_exists => false
+      end
+
+      private
+
+      # Coerces the argument into a String for use as a filename/-path
+      def path_string pathname
+        File.respond_to?(:path) ? File.path(pathname) : pathname.to_str
+      end
+    end
+
+    attr_reader :pathname
+    attr_reader :options
+
+    alias :includes? :exists?
+    alias :contains? :exists?
+    alias :member? :exists?
+    alias :[] :get
+    alias :[]= :put
+    alias :close! :close
+
+    def each(*args, &block)
+      i = iterator(*args)
+      i.each(&block) if block
+      i
+    end
+
+    def iterator(*args); Iterator.new self, *args; end
+    def keys; map {|k, v| k} end
+    def values; map {|k, v| v} end
+
+    # If called with a block, yields a snapshot to the caller, and the
+    # snapshot is released after the block finishes. Otherwise, returns a
+    # snapshot and caller must call #release on the snapshot.
+    def snapshot(*args)
+      sn = Snapshot.new self, *args
+      if block_given?
+        begin
+          yield sn
+        ensure
+          sn.release
+        end
+      else
+        sn
+      end
+    end
+
+    def inspect
+      "<#{self.class} #{@pathname.inspect}>"
+    end
+  end
+
+  class Iterator
+    include Enumerable
+
+    attr_reader :db, :from, :to
+
+    def self.new(db, opts={})
+      make db, opts
+    end
+
+    def keys; map {|k, v| k} end
+    def values; map {|k, v| v} end
+
+    def reversed?; @reversed end
+    def inspect
+      "<#{self.class} #{db.inspect} " +
+      "@from=#{@from.inspect} @to=#{@to.inspect}#{' (reversed)' if @reversed}>"
+    end
+  end
+
+  class WriteBatch
+    class << self
+      private :new
+    end
+
+    alias :[]= :put
+  end
+
+  # Snapshot has the same API as DB, restricted to read access.
+  class Snapshot
+    include Enumerable
+
+    def self.new(db)
+      make db
+    end
+
+    def each(*args, &block)
+      i = iterator(*args)
+      i.each(&block) if block
+      i
+    end
+
+    def get(*args)
+      db.get(*args, snapshot: self)
+    end
+
+    alias :[] :get
+    alias :includes? :exists?
+    alias :contains? :exists?
+    alias :member? :exists?
+
+    def iterator(*args); db.iterator *args, snapshot: self; end
+    def keys; map {|k, v| k} end
+    def values; map {|k, v| v} end
+
+    def inspect
+      "<#{self.class} #{db.inspect} #{' (released)' if released?}>"
+    end
+  end
+
+  class Options
+    DEFAULT_MAX_OPEN_FILES = 1000
+    DEFAULT_WRITE_BUFFER_SIZE = 4 * 1024 * 1024
+    DEFAULT_BLOCK_SIZE = 4 * 1024
+    DEFAULT_BLOCK_RESTART_INTERVAL = 16
+    DEFAULT_COMPRESSION = LevelDBNative::CompressionType::SnappyCompression
+
+    attr_reader :create_if_missing, :error_if_exists,
+                :block_cache_size, :paranoid_checks,
+                :write_buffer_size, :max_open_files,
+                :block_size, :block_restart_interval,
+                :compression
+  end
+end

data/lib/leveldb-native/version.rb

@@ -0,0 +1,3 @@
+module LevelDBNative
+  VERSION = "0.1"
+end

data/test/test-db-options.rb

@@ -0,0 +1,156 @@
+require 'leveldb-native'
+require 'tmpdir'
+require 'minitest/autorun'
+
+class TestDBOptions < Minitest::Test
+  include LevelDBNative
+  
+  attr_reader :dir
+
+  def setup
+    @dir = Dir.mktmpdir "leveldb-test-db-options-"
+  end
+
+  def teardown
+    FileUtils.remove_entry @dir
+  end
+
+  def test_create_if_missing_behavior
+    assert_raises(Error) do
+      DB.make(dir, {}) # create_if_missing is false
+    end
+    db = DB.make dir, :create_if_missing => true
+    assert db.options.create_if_missing
+    db.close!
+
+    db2 = DB.make dir, {}
+    refute db2.options.create_if_missing
+    db2.close!
+
+    FileUtils.rm_rf dir
+
+    DB.new dir # by default should set create_if_missing to true
+  end
+
+  def test_error_if_exists_behavior
+    db = DB.make dir, :create_if_missing => true
+    refute db.options.error_if_exists
+    db.close!
+
+    assert_raises(Error) do
+      DB.make dir, :create_if_missing => true, :error_if_exists => true
+    end
+  end
+
+  def test_paranoid_check_default
+    db = DB.new dir
+    refute db.options.paranoid_checks
+  end
+
+  def test_paranoid_check_on
+    db = DB.new dir, :paranoid_checks => true
+    assert db.options.paranoid_checks
+  end
+
+  def test_paranoid_check_off
+    db = DB.new dir, :paranoid_checks => false
+    refute db.options.paranoid_checks
+  end
+
+  def test_write_buffer_size_default
+    db = DB.new dir
+    assert_equal Options::DEFAULT_WRITE_BUFFER_SIZE,
+      db.options.write_buffer_size
+  end
+
+  def test_write_buffer_size
+    db = DB.new dir, :write_buffer_size => 10 * 1042
+    assert_equal (10 * 1042), db.options.write_buffer_size
+  end
+
+  def test_write_buffer_size_invalid
+    assert_raises(TypeError) do
+      DB.new dir, :write_buffer_size => "1234"
+    end
+  end
+
+  def test_max_open_files_default
+    db = DB.new dir
+    assert_equal Options::DEFAULT_MAX_OPEN_FILES, db.options.max_open_files
+  end
+
+  def test_max_open_files
+    db = DB.new(dir, :max_open_files => 2000)
+    assert_equal db.options.max_open_files, 2000
+  end
+
+  def test_max_open_files_invalid
+    assert_raises(TypeError) do
+      DB.new dir, :max_open_files => "2000"
+    end
+  end
+
+  def test_cache_size_default
+    db = DB.new dir
+    assert_nil db.options.block_cache_size
+  end
+
+  def test_cache_size
+    db = DB.new dir, :block_cache_size => 10 * 1024 * 1024
+    assert_equal (10 * 1024 * 1024), db.options.block_cache_size
+  end
+
+  def test_cache_size_invalid
+    assert_raises(TypeError) do
+      DB.new dir, :block_cache_size => false
+    end
+  end
+
+  def test_block_size_default
+    db = DB.new dir
+    assert_equal Options::DEFAULT_BLOCK_SIZE, db.options.block_size
+  end
+
+  def test_block_size
+    db = DB.new dir, :block_size => (2 * 1024)
+    assert_equal (2 * 1024), db.options.block_size
+  end
+
+  def test_block_size_invalid
+    assert_raises(TypeError) do
+      DB.new dir, :block_size => true
+    end
+  end
+
+  def test_block_restart_interval_default
+    db = DB.new dir
+    assert_equal Options::DEFAULT_BLOCK_RESTART_INTERVAL,
+      db.options.block_restart_interval
+  end
+
+  def test_block_restart_interval
+    db = DB.new dir, :block_restart_interval => 32
+    assert_equal 32, db.options.block_restart_interval
+  end
+
+  def test_block_restart_interval_invalid
+    assert_raises(TypeError) do
+      DB.new dir, :block_restart_interval => "abc"
+    end
+  end
+
+  def test_compression_default
+    db = DB.new dir
+    assert_equal Options::DEFAULT_COMPRESSION, db.options.compression
+  end
+
+  def test_compression
+    db = DB.new dir, :compression => CompressionType::NoCompression
+    assert_equal CompressionType::NoCompression, db.options.compression
+  end
+
+  def test_compression_invalid_type
+    assert_raises(TypeError) { DB.new dir, :compression => "1234" }
+    assert_raises(TypeError) { DB.new dir, :compression => 999 }
+  end
+end

data/test/test-db.rb

@@ -0,0 +1,53 @@
+require 'leveldb-native'
+require 'tmpdir'
+require 'minitest/autorun'
+
+class TestDB < Minitest::Test
+  include LevelDBNative
+  
+  attr_reader :db
+
+  def setup
+    @dir = Dir.mktmpdir "leveldb-test-db-"
+    @db = DB.new @dir
+  end
+
+  def teardown
+    FileUtils.remove_entry @dir
+  end
+
+  def test_size
+    1000.times { |x| db.put x.to_s, "foo" }
+    assert_equal 1000, db.size
+    1000.times { |x| db.delete x.to_s}
+    assert_equal 0, db.size
+  end
+  
+  def test_operations
+    refute db.exists?("k")
+
+    db["k"] = "v"
+    assert_equal "v", db["k"]
+    assert db.exists?("k")
+
+    db.delete "k"
+    assert_equal nil, db["k"]
+    refute db.exists?("k")
+  end
+  
+  ## how to test that fill_cache, verify_checksums, sync are getting passed to
+  ## the C++ lib?
+
+  def test_batch
+    db['k0'] = '0'
+    db['k1'] = '0'
+
+    db.batch do |batch|
+      batch['k0'] = '1'
+      batch.delete 'k1'
+    end
+
+    assert_equal '1', db['k0']
+    refute db.exists? 'k1'
+  end
+end

data/test/test-iterator.rb

@@ -0,0 +1,104 @@
+require 'leveldb-native'
+require 'tmpdir'
+require 'minitest/autorun'
+
+class TestIterator < Minitest::Test
+  include LevelDBNative
+
+  attr_reader :db
+
+  KEYS = (0..9).map {|ki| ki.to_s}
+
+  def setup
+    @dir = Dir.mktmpdir "leveldb-test-iterator-"
+    @db = DB.new @dir
+
+    KEYS.each_with_index do |k, vi|
+      db[k] = vi.to_s
+    end
+  end
+
+  def teardown
+    FileUtils.remove_entry @dir
+  end
+
+  def test_each
+    db.each_with_index do |(k, v), i|
+      assert_equal i.to_s, k
+      assert_equal i.to_s, v
+    end
+  end
+
+  def test_from
+    k = 5
+    a = db.each(:from => k.to_s).keys
+    assert_equal KEYS[k..-1], a
+  end
+
+  def test_to
+    k = 5
+    a = db.each(:to => k.to_s).keys
+    assert_equal KEYS[0..k], a
+  end
+
+  def test_from_to
+    k0 = 5; k1 = 8
+    a = db.each(:from => k0.to_s, :to => k1.to_s).keys
+    assert_equal KEYS[k0..k1], a
+  end
+
+  def test_reverse_each
+    assert_equal KEYS.reverse, db.each(:reversed => true).keys
+  end
+
+  def test_reverse_from
+    k = 5
+    a = db.each(:reversed => true, :from => k.to_s).keys
+    assert_equal KEYS[0..k].reverse, a
+  end
+
+  def test_reverse_to
+    k = 5
+    a = db.each(:reversed => true, :to => k.to_s).keys
+    assert_equal KEYS[k..-1].reverse, a
+  end
+
+  def test_reverse_from_to
+    k0 = 5; k1 = 8
+    a = db.each(:reversed => true, :from => k1.to_s, :to => k0.to_s).keys
+    assert_equal KEYS[k0..k1].reverse, a
+  end
+
+  def test_iterator_peek
+    iter = db.iterator
+    assert_equal %w(0 0), iter.peek, iter.invalid_reason
+    assert_equal %w(0 0), iter.peek, iter.invalid_reason
+    assert_nil iter.scan
+    assert_equal %w(1 1), iter.peek, iter.invalid_reason
+  end
+
+  def test_iterator_init_with_default_options
+    iter = db.iterator
+    assert_equal db, iter.db
+    assert_nil iter.from
+    assert_nil iter.to
+    refute iter.reversed?
+  end
+
+  def test_iterator_init_with_options
+    iter = db.iterator :from => 'abc', :to => 'def', :reversed => true
+    assert_equal db,iter.db
+    assert_equal 'abc', iter.from
+    assert_equal 'def', iter.to
+    assert iter.reversed?
+  end
+  
+  def test_iterator_not_valid
+    iter = db.iterator from: KEYS[-1]
+    assert_nil iter.invalid_reason
+    assert_equal %w{9 9}, iter.next
+    assert_equal -1, iter.invalid_reason
+    assert_equal nil, iter.next
+    assert_equal -1, iter.invalid_reason
+  end
+end

data/test/test-snapshot.rb

@@ -0,0 +1,77 @@
+require 'leveldb-native'
+require 'tmpdir'
+require 'minitest/autorun'
+
+class TestSnapshot < Minitest::Test
+  include LevelDBNative
+  
+  attr_reader :db
+
+  KEYS = %w{ k1 k2 k3 }
+
+  def setup
+    @dir = Dir.mktmpdir "leveldb-test-snapshot-"
+    @db = DB.new @dir
+
+    KEYS.each do |k|
+      db[k] = "0"
+    end
+  end
+
+  def teardown
+    FileUtils.remove_entry @dir
+  end
+
+  def test_get
+    sn = db.snapshot
+    KEYS.each do |k|
+      db[k] = "1"
+    end
+    KEYS.each do |k|
+      assert_equal "0", sn[k]
+    end
+  end
+
+  def test_iterator
+    sn = db.snapshot
+    KEYS.each do |k|
+      db[k] = "1"
+    end
+    sn.each do |k,v|
+      assert_equal "0", v
+    end
+    assert_equal KEYS, sn.keys
+    assert_equal ["0"], sn.values.uniq
+  end
+
+  def test_exists
+    sn = db.snapshot
+    db["new"] = "new"
+    db.delete "k1"
+    assert_equal false, sn.exists?( "new" )
+    assert_equal true,  sn.exists?( "k1"  )
+    assert_equal true,  db.exists?( "new" )
+    assert_equal false, db.exists?( "k1"  )
+
+    sn.release
+    assert_equal true,  sn.exists?( "new" )
+    assert_equal false, sn.exists?( "k1"  )
+    assert_equal true,  db.exists?( "new" )
+    assert_equal false, db.exists?( "k1"  )
+  end
+
+  def test_release
+    sn = db.snapshot
+    KEYS.each do |k|
+      db[k] = "1"
+    end
+
+    assert_equal false, sn.released?
+    sn.release
+    assert_equal true, sn.released?
+
+    sn.each do |k,v|
+      assert_equal "1", v
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: leveldb-native
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Joel VanderWerf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-07 00:00:00.000000000 Z
+dependencies: []
+description: Ruby binding to LevelDB.
+email: vjoel@users.sourceforge.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- README.md
+- LICENSE
+- Rakefile
+- lib/leveldb-native.rb
+- lib/leveldb-native/version.rb
+- ext/leveldb-native/extconf.rb
+- example/snapshot.rb
+- test/test-db.rb
+- test/test-db-options.rb
+- test/test-snapshot.rb
+- test/test-iterator.rb
+homepage: https://github.com/vjoel/ruby-leveldb-native
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--quiet"
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- LevelDB Native
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: Ruby binding to LevelDB.
+test_files:
+- test/test-db.rb
+- test/test-db-options.rb
+- test/test-snapshot.rb
+- test/test-iterator.rb
+has_rdoc: