geode 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2cee541c81d7d38fd8d62c651238ac0912cca0ba29ae04aed482d1e0420c20b
-  data.tar.gz: bb5925419f0579dc023a3bb79b917b0b78ab37c5ef35282cbeb0c50b82cfc642
+  metadata.gz: 7c1357dd8aadd830b705e45dcee476fdd473222574269373691ff6f91964da95
+  data.tar.gz: 1cc2d1a5129a238c25d89dc75a33c9edacdc79b45d9f7768ffc5912c4068e97d
 SHA512:
-  metadata.gz: 5b608bb22211b633c66d9c0eb2f9f396b948856bf9447a82737407c2806253b86356b65dcb570345c09b4f144f8f30dbe8064959a08daccd3f236797a8d938da
-  data.tar.gz: 363bd2f82a7b8732dcd53b8eeab4f341c48e8b839139d152ea16b0a5ec705a55be8f99aaac9987d8afef2cc526109f20918aacb2533e411d4da403a1b8fc87f5
+  metadata.gz: 982b9ab60e0e287bdc79b431074ac3a65afffe306d49e79d99add358a3401babc36ba2a77dca01d92b0f46f1f72c2ce052d3eb52d4fec1a147c7ce70f966e4dc
+  data.tar.gz: 33237585799704b24e0634335d5a84a9cc75ec95340b7d24be6b1befe5a671f27884a82cbfb3099ed1a5a3d5218b3b3f127ae4aea52ec0127d0f8b9c1af7fa34

data/lib/geode/redis.rb

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

data/lib/geode/sequel.rb

@@ -3,14 +3,20 @@ require 'sequel'
 require_relative '../geode'
 
 module Geode
-  # Uses a relational database as the store rather than Redis.
+  # 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.
+  # Unless you have a similarly good reason to use this class, use `RedisStore` instead.
   class SequelStore < Store
-    def initialize(name, connection = { adapter: 'postgres' })
+    # 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
         primary_key :id

data/lib/geode.rb

@@ -3,15 +3,15 @@ module Geode
   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)
+    # @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.
-    # @yield a block
+    # @yield a block which receives `table` as its sole parameter
     # @yieldparam table [Hash] The table belonging to `@name`
-    # @return [Object] The result of the block.
+    # @return [Object] The return value of the block
     def open
       raise NotImplementedError
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geode
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - biqqles
@@ -53,8 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 description: 
-email:
-- biqqles@protonmail.com
+email: biqqles@protonmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -87,5 +86,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Elegantly store Ruby objects in Redis or SQL
+summary: Elegantly store Ruby objects in Redis or Sequel
 test_files: []