github-ds 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19e5298765d4c64c5b96a860463b3ffbc804b71388cc328a08c39acfbdce5b4b
-  data.tar.gz: 42e94eb85be200d4f9183f406f9c0de52f4d5fd00fa007f82f50f159816b4152
+  metadata.gz: 235c233b2750caaa258c1fc172f6b2b14d117d533f247fbce0cb34ca83779b96
+  data.tar.gz: 88caf6d96cce86f1ad841e22397e2f21ed63982a00fc3469009ed230126001a1
 SHA512:
-  metadata.gz: 0d0ace44595e6add1f4570b7d22dc9fe01e56172f8f3b63584d558353a1f25afec0ad744f788271b43b0d0e3b8c609d8d720cef5ee12072ab8843dcb70f52b85
-  data.tar.gz: a9c3918434873b9bae164ecf5042cd87154965380d95f476a2ad6b793b8d8200fd529b1d9df0ea8552734379a12ed948844675e0c9e24ea0d2bb814c871948d3
+  metadata.gz: 47af7f674f862f846be53c0546cbb76ec38f9d96c8043b0107a7406a5bbf8bdfa7773fcbdf0071165d18105327471f7b06ee41c7e46f3464ea1c621d0f9dac0e
+  data.tar.gz: 5a73591ab5bd465376ec8d2e849aaf1fd10f269121eb50bc1428f1f7c42c91d9a4305299f70b21df1aecb9757c16de516ceab7594ba8f290d5e37d491615986b

data/README.md

@@ -37,6 +37,14 @@ rails generate github:ds:active_record
 rails db:migrate
 ```
 
+If you need to change the name of the table used for storing the key-values, you can configure your table name as such, before running the migration:
+
+```
+GitHub::KV.configure do |config|
+  config.table_name = "new_key_values_table"
+end
+```
+
 Once you have created and executed the migration, KV can do neat things like this:
 
 ```ruby

data/lib/generators/github/ds/active_record_generator.rb

@@ -26,6 +26,14 @@ module Github
         def migration_version
           self.class.migration_version
         end
+
+        def self.table_name
+          ":#{GitHub::KV.config.table_name}"
+        end
+
+        def table_name
+          self.class.table_name
+        end
       end
     end
   end

data/lib/generators/github/ds/templates/migration.rb

@@ -1,19 +1,19 @@
 class CreateKeyValuesTable < ActiveRecord::Migration<%= migration_version %>
   def self.up
-    create_table :key_values do |t|
+    create_table <%= table_name %> do |t|
       t.string :key, :null => false
       t.binary :value, :null => false
       t.datetime :expires_at, :null => true
       t.timestamps :null => false
     end
 
-    add_index :key_values, :key, :unique => true
-    add_index :key_values, :expires_at
+    add_index  <%= table_name %>, :key, :unique => true
+    add_index  <%= table_name %>, :expires_at
 
-    change_column :key_values, :id, "bigint(20) NOT NULL AUTO_INCREMENT"
+    change_column  <%= table_name %>, :id, "bigint(20) NOT NULL AUTO_INCREMENT"
   end
 
   def self.down
-    drop_table :key_values
+    drop_table  <%= table_name %>
   end
 end

data/lib/github/ds/version.rb

@@ -1,5 +1,5 @@
 module GitHub
   module DS
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/github/kv.rb

@@ -1,3 +1,4 @@
+require_relative "kv/config"
 require_relative "result"
 require_relative "sql"
 
@@ -53,6 +54,19 @@ module GitHub
     class MissingConnectionError < StandardError; end
 
     attr_accessor :use_local_time
+    attr_writer :config
+
+    def self.config
+      @config ||= Config.new
+    end
+
+    def self.reset
+      @config = Config.new
+    end
+
+    def self.configure
+      yield(config)
+    end
 
     # initialize :: [Exception], Boolean, Proc -> nil
     #
@@ -67,9 +81,10 @@ module GitHub
     # &conn_block         - A block to call to open a new database connection.
     #
     # Returns nothing.
-    def initialize(encapsulated_errors = [SystemCallError], use_local_time: false, &conn_block)
-      @encapsulated_errors = encapsulated_errors
-      @use_local_time = use_local_time
+    def initialize(config: GitHub::KV.config, &conn_block)
+      @encapsulated_errors = config.encapsulated_errors
+      @use_local_time = config.use_local_time
+      @table_name = config.table_name
       @conn_block = conn_block
     end
 
@@ -111,7 +126,7 @@ module GitHub
 
       Result.new {
         kvs = GitHub::SQL.results(<<-SQL, :keys => keys, :now => now, :connection => connection).to_h
-          SELECT `key`, value FROM key_values WHERE `key` IN :keys AND (`expires_at` IS NULL OR `expires_at` > :now)
+          SELECT `key`, value FROM #{@table_name} WHERE `key` IN :keys AND (`expires_at` IS NULL OR `expires_at` > :now)
         SQL
 
         keys.map { |key| kvs[key] }
@@ -159,7 +174,7 @@ module GitHub
 
       encapsulate_error do
         GitHub::SQL.run(<<-SQL, :rows => GitHub::SQL::ROWS(rows), :connection => connection)
-          INSERT INTO key_values (`key`, value, created_at, updated_at, expires_at)
+          INSERT INTO #{@table_name} (`key`, value, created_at, updated_at, expires_at)
           VALUES :rows
           ON DUPLICATE KEY UPDATE
             value = VALUES(value),
@@ -204,7 +219,7 @@ module GitHub
 
       Result.new {
         existing_keys = GitHub::SQL.values(<<-SQL, :keys => keys, :now => now, :connection => connection).to_set
-          SELECT `key` FROM key_values WHERE `key` IN :keys AND (`expires_at` IS NULL OR `expires_at` > :now)
+          SELECT `key` FROM #{@table_name} WHERE `key` IN :keys AND (`expires_at` IS NULL OR `expires_at` > :now)
         SQL
 
         keys.map { |key| existing_keys.include?(key) }
@@ -240,12 +255,12 @@ module GitHub
         # query, but then we would not be able to rely on affected_rows
 
         GitHub::SQL.run(<<-SQL, :key => key, :now => now, :connection => connection)
-          DELETE FROM key_values WHERE `key` = :key AND expires_at <= :now
+          DELETE FROM #{@table_name} WHERE `key` = :key AND expires_at <= :now
         SQL
 
         value = value.is_a?(GitHub::SQL::Literal) ? value : GitHub::SQL::BINARY(value)
         sql = GitHub::SQL.run(<<-SQL, :key => key, :value => value, :now => now, :expires => expires || GitHub::SQL::NULL, :connection => connection)
-          INSERT IGNORE INTO key_values (`key`, value, created_at, updated_at, expires_at)
+          INSERT IGNORE INTO #{@table_name} (`key`, value, created_at, updated_at, expires_at)
           VALUES (:key, :value, :now, :now, :expires)
         SQL
 
@@ -293,7 +308,7 @@ module GitHub
       # same and we raise an error.
       encapsulate_error {
         sql = GitHub::SQL.run(<<-SQL, key: key, amount: amount, now: now, expires: expires, touch: !touch_on_insert, connection: connection)
-          INSERT INTO key_values (`key`, `value`, `created_at`, `updated_at`, `expires_at`)
+          INSERT INTO #{@table_name} (`key`, `value`, `created_at`, `updated_at`, `expires_at`)
           VALUES(:key, :amount, :now, :now, :expires)
           ON DUPLICATE KEY UPDATE
             `value`=IF(
@@ -378,7 +393,7 @@ module GitHub
 
       encapsulate_error do
         GitHub::SQL.run(<<-SQL, :keys => keys, :connection => connection)
-          DELETE FROM key_values WHERE `key` IN :keys
+          DELETE FROM #{@table_name} WHERE `key` IN :keys
         SQL
       end
 
@@ -402,7 +417,7 @@ module GitHub
 
       Result.new {
         GitHub::SQL.value(<<-SQL, :key => key, :now => now, :connection => connection)
-          SELECT expires_at FROM key_values
+          SELECT expires_at FROM #{@table_name}
           WHERE `key` = :key AND (expires_at IS NULL OR expires_at > :now)
         SQL
       }
@@ -422,7 +437,7 @@ module GitHub
 
       Result.new {
         kvs = GitHub::SQL.results(<<-SQL, :keys => keys, :now => now, :connection => connection).to_h
-          SELECT `key`, expires_at FROM key_values
+          SELECT `key`, expires_at FROM #{@table_name}
           WHERE `key` in :keys AND (expires_at IS NULL OR expires_at > :now)
         SQL
 

data/lib/github/kv/config.rb

@@ -0,0 +1,13 @@
+module GitHub
+  class KV
+    class Config
+      attr_accessor :table_name, :encapsulated_errors, :use_local_time
+
+      def initialize
+        @table_name = 'key_values'
+        @encapsulated_errors = [SystemCallError]
+        @use_local_time = false
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-ds
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - GitHub Open Source
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-26 00:00:00.000000000 Z
+date: 2019-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -183,6 +183,7 @@ files:
 - lib/github/ds.rb
 - lib/github/ds/version.rb
 - lib/github/kv.rb
+- lib/github/kv/config.rb
 - lib/github/result.rb
 - lib/github/sql.rb
 - lib/github/sql/errors.rb