db_stager 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7144864a030786eac584c002945d972aebf2c2f9
-  data.tar.gz: 5322fb8b234927617f4696ae6d4d5dfbcd3c5fa1
+  metadata.gz: afc0778cda3b7cf0e73f56f748a14f6fa0adc6ae
+  data.tar.gz: c195aec4e4d0ad80d47bae96f64218880b57a723
 SHA512:
-  metadata.gz: 3102262cec9d51155b1e83cfd56649b552e700c872ab2f5a23fe70f8cf641d14ec35b77ca5d1df351dc8d07f535cdb83e7fa027cf53654e179d1ab6289577bef
-  data.tar.gz: fe5e70470b372f04ed99a6cd2ba0d3a77f6fd285805dfa5c7619160e0ff7254ce71f89c9724a83129c95b375dc29c1b2334a037e89af2d89ab4394567c406511
+  metadata.gz: c7d89ea1be63280715cde99ce4a19d0770526cf0daea4023f7265bf32d37c7dda365dfcffb9ed12f6342a1644be7045ef15bf4983a630fdc68a39c40d0b48e3f
+  data.tar.gz: 39cdf412e03565a8b5bd23e5007569f011ca7d8d87ac546a4214cb76e6d8b390f501e7adf3d8c98a2d2072f8cda116cd329c60449ad46c75cfb9fce98c244efd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    db_stager (0.2.1)
+    db_stager (1.0.0)
       dotenv (~> 2.2)
       faker (~> 1.9)
       hashie (~> 3.5)

data/README.md

@@ -1,6 +1,5 @@
-# DbStager
+# This gem has been renamed to stage_hand. Find it at [Rubygems.org](https://rubygems.org/gems/stage_hand) or [Gitlab](https://gitlab.com/notch8/stage_hand)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/db_stager`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 Perform backups and restores of databases, scrubbing records along the way. This allows taking limited snapshots of large databases and keeps customer info out of your staging site.
 
@@ -9,7 +8,7 @@ Perform backups and restores of databases, scrubbing records along the way. This
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'db_stager'
+gem 'db_stager', require: false
 ```
 
 And then execute:
@@ -22,7 +21,50 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Generate an example config file
+
+`db_stager install`
+
+Create a new, modified copy of the production database
+
+`db_stager capture -e production`
+
+Load the current database file, currently just does `rake db:structure:load` but may be exapnded in the future
+
+`db_stager load -e staging`
+
+## Configuration
+
+DbStager uses a configuration file found in config/stage_hand.yml.  There are two sections of this file.
+
+### excluded_tables
+
+This is a list of all the tables to exclude. These tables are skipped by data insertion, but they are reset to the current schema currently. schema_migrations is always in the excluded list, though the structure load will set the values of that table to the most recent migration.
+
+```yaml
+excluded_tables:
+  - sites
+  - secrets
+```
+
+### fields
+
+Here is where the real magic happens. You can specify fields to either be set to blank (by using nil or false) or by evaluating code.  [Faker](https://github.com/stympy/faker) is included to make doing so easy. There is also a special variable called `existing_value` which contains the value before any changes. These fields will be changed in flight to the sql file and thus sensitive data can be removed from the production data dump.
+
+```yaml
+fields:
+  users:
+    email: "existing_value.match('notch8.com') ? existing_value : Faker::Internet.unique.email"
+    zip: false
+  action_items:
+    name: "Faker::Name.unique.name"
+```
+
+## TODO
+
+-[ ] File upload
+-[ ] File Download
+-[ ] Ability to limit the number of rows to insert per table
 
 ## Development
 
@@ -32,7 +74,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/db_stager. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/notch8/db_stager. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/db_stager.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.email         = ["rob@notch8.com"]
 
   spec.summary       = %q{DB Stager backups and restores databases for staging. Allows scrubbing of records.}
-  spec.description   = %q{Perform backups and restores of databases, scrubbing records along the way. This allows taking limited snapshots of large databases and keeps customer info out of your staging site.}
-  spec.homepage      = "https://gitlab.com/notch8/db_stager"
+  spec.description   = %q{This gem has been renamed to stage_hand. Find it at [Rubygems.org](https://rubygems.org/gems/stage_hand) or [Gitlab](https://gitlab.com/notch8/stage_hand)}
+  spec.homepage      = "https://gitlab.com/notch8/stage_hand"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/lib/db_stager/cli.rb

@@ -34,7 +34,8 @@ module DbStager
             if fields[table_name]
               fields[table_name].each do |field_name, task|
                 if task
-                  item[field_name.to_sym] = send(task)
+                  existing_value = item[field_name.to_sym]
+                  item[field_name.to_sym] = eval(task)
                 else
                   item[field_name.to_sym] = nil
                 end
@@ -74,7 +75,7 @@ module DbStager
       return @config_file if @config_file
       config_file_path = File.join(Dir.pwd, 'config', 'stage_hand.yml')
       if File.exists?(config_file_path)
-        @config_file = Hashie::Mash.load(ERB.new(File.read(config_file_path)))
+        @config_file = Hashie::Mash.load(config_file_path)
       else
         @config_file = {}
       end

data/lib/db_stager/version.rb

@@ -1,3 +1,3 @@
 module DbStager
-  VERSION = "0.2.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db_stager
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Rob Kaufman
@@ -136,9 +136,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
-description: Perform backups and restores of databases, scrubbing records along the
-  way. This allows taking limited snapshots of large databases and keeps customer
-  info out of your staging site.
+description: This gem has been renamed to stage_hand. Find it at [Rubygems.org](https://rubygems.org/gems/stage_hand)
+  or [Gitlab](https://gitlab.com/notch8/stage_hand)
 email:
 - rob@notch8.com
 executables:
@@ -162,7 +161,7 @@ files:
 - lib/db_stager.rb
 - lib/db_stager/cli.rb
 - lib/db_stager/version.rb
-homepage: https://gitlab.com/notch8/db_stager
+homepage: https://gitlab.com/notch8/stage_hand
 licenses:
 - MIT
 metadata: {}