geode 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9d2e925a8364400b6115a4223c5856f12e2c24b56f1ef8bf1720e4d00e1e4c9
-  data.tar.gz: 8d6419d449bb81d08ea6eead65910120ec0e157d925b046847e8b191a4adf084
+  metadata.gz: 40101d539252b136e868fd1a800b063480f900d2d6950fdb49692b9b46f2d840
+  data.tar.gz: c5169f3c0240530b10c7ecf479dec602d6ac4c1edfffb85fa93ba3713a97a6ed
 SHA512:
-  metadata.gz: 851f343021aa0a78e16cda8669ccacba8b40a608504352d59e87985287882da06b376de9fd99c918e89d4a0c30ecb61e9c7718a1ceb7ce340721886ba75f5a09
-  data.tar.gz: 62ab42620321c4e6c5c9c88a422d411732b31b6d01dad4cf9e1415338ad192da2e6870aa2f4826d73c566f3b063082feb42338d4288eb9ca1a47ce8c22024b3c
+  metadata.gz: d92a44091dd02cf1c9a406cf642dc6e906b40177d07081b2f898c0a0c3153d2e43850c4391900f4bc8dcd9294c4f9e7c71306c2467ad5a60a0f84855deeee328
+  data.tar.gz: a44edfb5d28948066504fa7d65bf9c331a7b6dc2abb19001a96a9bfcb329a48218412262bbf4fb539a01934d0dbcec7b0392421236ab87666e8fe9146bd977f4

data/lib/geode/redis.rb

@@ -0,0 +1,35 @@
+require 'redis'
+
+require_relative '../geode'
+
+module Geode
+  # A store implemented using Redis.
+  class RedisStore < Store
+    # Connect to a store held in Redis.
+    # @param name [Symbol, String] The name of the store
+    # @param connection [Hash, String] Connection parameters passed to `Redis.new`.
+    #                                  Defaults to empty hash
+    def initialize(name, connection = nil)
+      super
+      connection ||= {}
+      @redis = Redis.new(connection)
+    end
+
+    def open
+      table = if @redis.exists? @name
+                Marshal.load(@redis.get @name)
+              else
+                {}
+              end
+
+      (yield table).tap do
+        @redis.set @name, Marshal.dump(table)
+      end
+    end
+
+    def destroy
+      @redis.del @name
+      nil
+    end
+  end
+end

data/lib/geode/sequel.rb

@@ -0,0 +1,48 @@
+require 'sequel'
+
+require_relative '../geode'
+
+module Geode
+  # A store that uses a relational database supported by Sequel instead of Redis.
+  # This is mainly useful for Heroku, where persistent Postgres is free, but
+  # the same is not true of Redis.
+  # Unless you have a similarly good reason to use this class, use `RedisStore` instead.
+  class SequelStore < Store
+    # Connect to a store held in a relational database supported by Sequel.
+    # A table named `geode` will be created and used to store the data.
+    # @param name [Symbol, String] The name of the store
+    # @param connection [Hash, String] Connection parameters passed to `Sequel.connect`.
+    #                                  Defaults to `{ adapter: 'postgres' }`
+    def initialize(name, connection = nil)
+      super
+
+      connection ||= { adapter: 'postgres' }
+      db = Sequel.connect(connection)
+      db.create_table? :geode do
+        String :name, primary_key: true
+        File :value
+      end
+
+      @db = db[:geode]
+    end
+
+    def open
+      store = @db.where(name: @name)
+      table = if store.empty?
+                store.insert(name: @name, value: '')
+                {}
+              else
+                Marshal.load(store.first[:value])
+              end
+
+      (yield table).tap do
+        store.update(value: Sequel.blob(Marshal.dump(table)))
+      end
+    end
+
+    def destroy
+      @db.where(name: @name).delete
+      nil
+    end
+  end
+end

data/lib/geode.rb

@@ -1,57 +1,54 @@
-# frozen_string_literal: true
-
-require 'redis'
-
-require 'sequel'
-
 module Geode
-  class RedisStore
-    def initialize(name)
-      @name = name
-      @redis = Redis.new
+  # Subclass this to implement your own stores.
+  class Store
+    # Connect to a store.
+    # @param name [Symbol, String] The name of the store
+    # @param connection [Hash, String] Connection parameters passed to the DB client
+    def initialize(name, connection = nil)
+      @name = name.to_s
     end
 
     # "Open" the store for reading and/or writing.
-    # Returns the result of the block.
+    # @yield a block which receives `table` as its sole parameter
+    # @yieldparam table [Hash] The store's table. Changes to this Hash will
+    # be persisted in the store
+    # When in doubt, use this method.
+    # @example
+    #   "store.open { |table| table[:key] = 5 }"
+    # @example
+    #   "store.open { |table| table[:key] } #=> 5"
+    # @return [Object] The return value of the block
     def open
-      table = if @redis.exists? @name
-                Marshal.load(@redis.get @name)
-              else
-                {}
-              end
-
-      (yield table).tap do
-        @redis.set(@name, Marshal.dump(table))
-      end
+      raise 'subclasses must implement #open'
     end
-  end
-
-  class PostgresStore
-    def initialize(name, connection=nil)
-      @name = name
-      @db = connection.nil? ? Sequel.postgres : Sequel.connect(connection)
-      @db.create_table? :geode do
-        primary_key :id
-        String :name
-        File :value
-      end
 
+    # "Peek" inside the store, returning a copy of its table.
+    # Changes to this copy will NOT be persisted in the store.
+    # Use this if you simply want to view the store's table.
+    # @example
+    #   "store.peek.key?(:test) #=> false"
+    # @return [Hash] A copy of the store's table
+    def peek
+      open(&:itself)
     end
 
-    def open
-      geode = @db[:geode]
-      store = geode.where(name: @name)
-      table = if store.first.nil?
-                store.insert(name: @name, value: '')
-                {}
-              else
-                Marshal.load(store.first[:value])
-              end
+    # Retrieve the object at `key` from the store.
+    # This is implemented using `#peek` and therefore
+    # changes to the object returned by this method will NOT
+    # be persisted in the store.
+    # Use this if you simply need to fetch a value from the store.
+    # @example
+    #   "store[:key] #=> 5"
+    # @param key [Object] The key to look up
+    # @return [Object] The object at `key`
+    def [](key)
+      peek[key]
+    end
 
-      (yield table).tap do
-        dumped = Marshal.dump(table)
-        store.update(value: Sequel.blob(dumped))
-      end
+    # "Destroy" the store, deleting all data.
+    # The store can be opened again, recreating it in a blank state.
+    def destroy
+      raise 'subclasses must implement #destroy'
     end
   end
 end

metadata

@@ -1,65 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: geode
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - biqqles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-14 00:00:00.000000000 Z
+date: 2021-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 description: 
-email:
-- biqqles@protonmail.com
+email: biqqles@protonmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/geode.rb
+- lib/geode/redis.rb
+- lib/geode/sequel.rb
 homepage: https://github.com/biqqles/geode
 licenses:
 - MPL-2.0
@@ -75,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -85,5 +86,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: A simple hierarchical key-store for Ruby
+summary: Store Ruby objects in Redis or Sequel
 test_files: []