pgdice 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3fb2d5818d5b0042ad5509989c68728bc4cf308a6776d2e4e86f098e54f0eca
-  data.tar.gz: 878e00f3882170077962bbd486164f529ffe03cfb3a90a3c82fbb93ad4f91062
+  metadata.gz: fba36c27ddb14e741a76b835c50b0174e01aaaa5dda17eec6bb2932320c34908
+  data.tar.gz: 02a619304426969341ede31c4882b4deac9b21380b362900fad4a03d9a368ed2
 SHA512:
-  metadata.gz: 391d851ca34559bae050ce7a3e4ea5d980fa85c215438252c08842af2d409535170e14951538d665168851260cf182a2705901682b5adad9b9b30928d054e49d
-  data.tar.gz: bab98688c55400ff18ea5f94a0fc29ad94752c13fa5fcf410a058c71c4c82bcb588df0ccf97f1bc1447e9e59f4d9877ffff00ef2aea67c016a66a2fa8995979a
+  metadata.gz: 9667cfbb816a7bb7b5f962b646fdab43fdd6fbcc2c5e8017e8523ce160819bfd4b88b45a444a8654bf627eb282c5d139e515dddfd64efa926204ac103bc80c57
+  data.tar.gz: 2965757a70d340024a67971ec6a9dd5ca0218454d6dab363876a1ef7ea9493cf5681f478bd95ae8b294349cb75b40c1e43266ce714b731813b74b2ad146e5471

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [v0.3.0] : 2018-10-21
+### Changes
+  - Delegate methods from the management classes onto the `PgDice` module itself.
+    - This means the api for this project is significantly more simple to use.
 
 ## [v0.2.1] : 2018-10-21
 ### Changes

data/README.md

@@ -54,6 +54,9 @@ require 'pgdice'
 PgDice.configure do |config|
   # This defaults to STDOUT if you don't specify a logger
   config.logger_factory = proc { Sidekiq.logger }
+  
+  # database_url *must be set*
+  # Rails users: see FAQ for method on how to generate this from your Rails config. 
   config.database_url = ENV['PGDICE_DATABASE_URL'] # postgresql://[user[:password]@][host][:port][/dbname][?param1=value1&...]
  
   # Set a config file or build the tables manually
@@ -69,8 +72,9 @@ end
 
 ### Configuration Parameters
 
-- `database_url` - Required: The postgres database url to connect to. 
+- `database_url` - **Required**: The postgres database url to connect to. 
   - This is required since `pgslice` requires a postgres `url`.
+  - `PgDice` will throw an error if this value is not a valid postgres url.
 
 - `logger_factory` - Optional: A factory that will return a logger to use.
   - Defaults to `proc { Logger.new(STDOUT) }`
@@ -146,7 +150,7 @@ For more information on what's going on in the background see
 
 
 ```ruby
-PgDice.partition_helper.partition_table('comments')
+PgDice.partition_table('comments')
 ```
 
 
@@ -160,7 +164,7 @@ PgDice.partition_helper.partition_table('comments')
 If you mess up, again you shouldn't use this in production, you can call:
  
 ```ruby
-PgDice.partition_helper.undo_partitioning!('comments')
+PgDice.undo_partitioning!('comments')
 ```
 
 This method will revert the changes made by partitioning a table. Don't rely on this 
@@ -174,7 +178,7 @@ in production if you mess up; you need to test everything thoroughly.
 If you have existing tables that need to periodically have more tables added you can run:
 
 ```ruby
-PgDice.partition_manager.add_new_partitions('comments')
+PgDice.add_new_partitions('comments')
 ```
 
 #### Notes on `add_new_partitions`
@@ -190,12 +194,12 @@ Sometimes you just want to know what's out there and if there are tables ready t
 
 To list all eligible tables for dropping you can run:
 ```ruby
-PgDice.partition_manager.list_droppable_partitions('comments')
+PgDice.list_droppable_partitions('comments')
 ```
 
 If you want to know _exactly_ which partitions will be dropped you can call:
 ```ruby
-PgDice.partition_manager.list_droppable_partitions_by_batch_size('comments')
+PgDice.list_droppable_partitions_by_batch_size('comments')
 ```
 
 This method will show partitions that are within the configured `batch_size`.
@@ -213,7 +217,7 @@ _Dropping tables is irreversible! Do this at your own risk!!_
 If you want to drop old tables (after backing them up of course) you can run:
 
 ```ruby
-PgDice.partition_manager.drop_old_partitions(table_name: 'comments')
+PgDice.drop_old_partitions(table_name: 'comments')
 ```
 
 #### Notes on `drop_old_partitions`
@@ -231,7 +235,7 @@ ensure they are actually working correctly.
 
 To validate that your expected number of tables exist, you can run:
 ```ruby
-PgDice.validation.assert_tables('comments')
+PgDice.assert_tables('comments')
 ```
 
 An [InsufficientTablesError](lib/pgdice.rb) will be raised if any conditions are not met.

data/lib/pgdice/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgDice
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/pgdice.rb

@@ -50,6 +50,12 @@ module PgDice
   SUPPORTED_PERIODS = { 'day' => 'YYYYMMDD', 'month' => 'YYYYMM', 'year' => 'YYYY' }.freeze
 
   class << self
+    extend Forwardable
+    def_delegators :partition_manager, :add_new_partitions, :drop_old_partitions, :list_partitions,
+                   :list_droppable_partitions, :list_droppable_partitions_by_batch_size
+    def_delegators :partition_helper, :partition_table, :undo_partitioning, :undo_partitioning!
+    def_delegators :validation, :assert_tables
+
     def partition_manager
       raise PgDice::NotConfiguredError, 'partition_manager' unless configuration
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pgdice
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Newell