geode 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9d2e925a8364400b6115a4223c5856f12e2c24b56f1ef8bf1720e4d00e1e4c9
-  data.tar.gz: 8d6419d449bb81d08ea6eead65910120ec0e157d925b046847e8b191a4adf084
+  metadata.gz: f2cee541c81d7d38fd8d62c651238ac0912cca0ba29ae04aed482d1e0420c20b
+  data.tar.gz: bb5925419f0579dc023a3bb79b917b0b78ab37c5ef35282cbeb0c50b82cfc642
 SHA512:
-  metadata.gz: 851f343021aa0a78e16cda8669ccacba8b40a608504352d59e87985287882da06b376de9fd99c918e89d4a0c30ecb61e9c7718a1ceb7ce340721886ba75f5a09
-  data.tar.gz: 62ab42620321c4e6c5c9c88a422d411732b31b6d01dad4cf9e1415338ad192da2e6870aa2f4826d73c566f3b063082feb42338d4288eb9ca1a47ce8c22024b3c
+  metadata.gz: 5b608bb22211b633c66d9c0eb2f9f396b948856bf9447a82737407c2806253b86356b65dcb570345c09b4f144f8f30dbe8064959a08daccd3f236797a8d938da
+  data.tar.gz: 363bd2f82a7b8732dcd53b8eeab4f341c48e8b839139d152ea16b0a5ec705a55be8f99aaac9987d8afef2cc526109f20918aacb2533e411d4da403a1b8fc87f5

data/lib/geode/redis.rb

@@ -0,0 +1,26 @@
+require 'redis'
+
+require_relative '../geode'
+
+module Geode
+  # A store implemented using Redis.
+  class RedisStore < Store
+    def initialize(name, connection = {})
+      super
+
+      @redis = Redis.new
+    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
+  end
+end

data/lib/geode/sequel.rb

@@ -0,0 +1,38 @@
+require 'sequel'
+
+require_relative '../geode'
+
+module Geode
+  # Uses a relational database as the store rather than 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
+    def initialize(name, connection = { adapter: 'postgres' })
+      super
+
+      db = Sequel.connect(connection)
+      db.create_table? :geode do
+        primary_key :id
+        String :name
+        File :value
+      end
+
+      @db = db[:geode]
+    end
+
+    def open
+      store = @db.where(name: @name)
+      table = if store.first.nil?
+                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
+  end
+end

data/lib/geode.rb

@@ -1,57 +1,19 @@
-# 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] DB connection parameters passed to the DB client
+    def initialize(name, connection)
+      @name = name.to_s
     end
 
     # "Open" the store for reading and/or writing.
-    # Returns the result 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
-    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
-
-    end
-
+    # @yield a block
+    # @yieldparam table [Hash] The table belonging to `@name`
+    # @return [Object] The result of the block.
     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
-
-      (yield table).tap do
-        dumped = Marshal.dump(table)
-        store.update(value: Sequel.blob(dumped))
-      end
+      raise NotImplementedError
     end
   end
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: geode
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - biqqles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-14 00:00:00.000000000 Z
+date: 2021-10-15 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
@@ -60,6 +60,8 @@ 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 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -85,5 +87,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: A simple hierarchical key-store for Ruby
+summary: Elegantly store Ruby objects in Redis or SQL
 test_files: []