isomorfeus-hamster 0.6.0

data/lib/isomorfeus/hamster/database.rb

@@ -0,0 +1,137 @@
+module Isomorfeus
+  module Hamster
+    class Database
+      include Enumerable
+
+      # Iterate through the records in a database
+      # @yield [i] Gives a record [key, value] to the block
+      # @yieldparam [Array] i The key, value pair for each record
+      # @example
+      #    db.each do |record|
+      #      key, value = record
+      #      puts "at #{key}: #{value}"
+      #    end
+      def each
+        env.transaction true do
+          cursor do |c|
+            while i = c.next
+              yield(i)
+            end
+          end
+        end
+      end
+
+      # Retrieve the value of a record from a database
+      # @param key the record key to retrieve
+      # @return value of the record for that key, or nil if there is
+      #      no record with that key
+      # @see #get(key)
+      def [](key)
+        get(key)
+      end
+
+      # Set (write or update) a record in a database.
+      # @param key key for the record
+      # @param value the value of the record
+      # @return returns the value of the record
+      # @see #put(key, value)
+      # @example
+      #      db['a'] = 'b'     #=> 'b'
+      #      db['b'] = 1234    #=> 1234
+      #      db['a']           #=> 'b'
+      def []=(key, value)
+        put(key, value)
+        value
+      end
+
+      # Get the keys as an array.
+      # @return [Array] of keys.
+      def keys
+        each_key.to_a
+      end
+
+      # Iterate over each key in the database, skipping over duplicate records.
+      #
+      # @yield key [String] the next key in the database.
+      # @return [Enumerator] in lieu of a block.
+      def each_key(&block)
+        return enum_for :each_key unless block_given?
+        env.transaction true do
+          cursor do |c|
+            while (rec = c.next true)
+              yield rec.first
+            end
+          end
+        end
+      end
+
+      # Iterate over the duplicate values of a given key, using an
+      # implicit cursor. Works whether +:dupsort+ is set or not.
+      #
+      # @param key [#to_s] The key in question.
+      # @yield value [String] the next value associated with the key.
+      # @return [Enumerator] in lieu of a block.
+      def each_value(key, &block)
+        return enum_for :each_value, key unless block_given?
+
+        value = get(key) or return
+        unless dupsort?
+          yield value
+          return
+        end
+
+        env.transaction true do
+          cursor do |c|
+            method = :set
+            while rec = c.send(method, key)
+              method = :next_range
+              yield rec[1]
+            end
+          end
+        end
+      end
+
+      # Return the cardinality (number of duplicates) of a given
+      # key. Works whether +:dupsort+ is set or not.
+      # @param key [#to_s] The key in question.
+      # @return [Integer] The number of entries under the key.
+      def cardinality(key)
+        env.transaction true do
+          return 0 unless get key
+          return 1 unless dupsort?
+          cursor do |c|
+            c.set key
+            return c.count
+          end
+        end
+      end
+
+      # Test if the database has a given key (or, if opened in
+      # +:dupsort+, value)
+      def has? key, value = nil
+        v = get(key) or return false
+        return true if value.nil? or value.to_s == v
+        return false unless dupsort?
+
+        env.transaction true do
+          cursor do |c|
+            return !!c.set(key, value)
+          end
+        end
+      end
+
+      # Delete the key (and optional value pair) if it exists; do not
+      # complain about missing keys.
+      # @param key [#to_s] The key.
+      # @param value [#to_s] The optional value.
+      def delete?(key, value = nil)
+        delete key, value if has? key, value
+      end
+
+      # @return the number of records in this database
+      def size
+        stat[:entries]
+      end
+    end
+  end
+end

data/lib/isomorfeus/hamster/marshal.rb

@@ -0,0 +1,63 @@
+module Isomorfeus
+  module Hamster
+    module Marshal
+      class << self
+        def dump(db, key, obj)
+          db.env.transaction { db.put(key, Oj.dump(obj)) }
+        end
+
+        def load(db, key)
+          obj_j = db.get(key)
+          return nil unless obj_j
+          Oj.load(obj_j)
+        end
+
+        def structured_dump(db, obj)
+          kv = []
+          oc = obj.class.to_s
+          ky = obj.key
+          as = obj.attributes
+          kv << [ats_key(oc, ky), Oj.dump(as)]
+          as.each do |at|
+            kv << [at_key(oc, ky, at), Oj.dump(obj.send(at))]
+          end
+          db.env.transaction do
+            kv.each do |k, v|
+              db.put(k, v)
+            end
+          end
+        end
+
+        def structured_load(db, oc, ky)
+          if oc.class = String
+            oC = const_get(oc)
+          else
+            oC = oc
+            oc = oc.to_s
+          end
+          ak = ats_key(oc, ky)
+          oh = {}
+          db.env.transaction do
+            as_j = db.get(ak)
+            as = Oj.load(as_j)
+            as.each do |at|
+              v_j = db.get(at_key(oc, ky, at))
+              oh[at] = Oj.load(v_j)
+            end
+          end
+          oC.instance_from_hash(oh)
+        end
+
+        private
+
+        def ats_key(oc, ky)
+          "#{oc}|#{ky}|attributes"
+        end
+
+        def at_key(oc, ky, at)
+          "#{oc}|#{ky}|:|#{at}"
+        end
+      end
+    end
+  end
+end

data/lib/isomorfeus/hamster/version.rb

@@ -0,0 +1,5 @@
+module Isomorfeus
+  module Hamster
+    VERSION = '0.6.0'
+  end
+end

data/lib/isomorfeus-hamster.rb

@@ -0,0 +1,4 @@
+require 'isomorfeus_hamster_ext'
+require 'isomorfeus/hamster/version'
+require 'isomorfeus/hamster/database'
+require 'isomorfeus/hamster/marshal'

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: isomorfeus-hamster
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Jan Biedermann
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.9
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: KV store and ObjectDB for Isomorfeus.
+email:
+- jan@kursator.com
+executables: []
+extensions:
+- ext/isomorfeus_hamster_ext/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- ext/isomorfeus_hamster_ext/cursor_delete_flags.h
+- ext/isomorfeus_hamster_ext/cursor_put_flags.h
+- ext/isomorfeus_hamster_ext/dbi_flags.h
+- ext/isomorfeus_hamster_ext/env_flags.h
+- ext/isomorfeus_hamster_ext/errors.h
+- ext/isomorfeus_hamster_ext/extconf.rb
+- ext/isomorfeus_hamster_ext/flag_parser.h
+- ext/isomorfeus_hamster_ext/isomorfeus_hamster.c
+- ext/isomorfeus_hamster_ext/isomorfeus_hamster.h
+- ext/isomorfeus_hamster_ext/lmdb/.gitignore
+- ext/isomorfeus_hamster_ext/lmdb/COPYRIGHT
+- ext/isomorfeus_hamster_ext/lmdb/LICENSE
+- ext/isomorfeus_hamster_ext/lmdb/lmdb.h
+- ext/isomorfeus_hamster_ext/lmdb/mdb.c
+- ext/isomorfeus_hamster_ext/lmdb/midl.c
+- ext/isomorfeus_hamster_ext/lmdb/midl.h
+- ext/isomorfeus_hamster_ext/prototypes.sh
+- ext/isomorfeus_hamster_ext/put_flags.h
+- lib/isomorfeus-hamster.rb
+- lib/isomorfeus/hamster/database.rb
+- lib/isomorfeus/hamster/marshal.rb
+- lib/isomorfeus/hamster/version.rb
+homepage: http://isomorfeus.com
+licenses:
+- MIT
+metadata:
+  github_repo: ssh://github.com/isomorfeus/gems
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: KV store and ObjectDB for Isomorfeus.
+test_files: []