fake_pipe 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12b4fbe781cae0694881681c54759347c3aa6f7f
-  data.tar.gz: 31b8a828b0ceb197988aecb655bbd9baa9211741
+  metadata.gz: c07b29d1ab2b3d32b98fab8942abe59e0ce45559
+  data.tar.gz: 0726decc0dc8929f3de8d5502ec9f4d0ab530eda
 SHA512:
-  metadata.gz: 9f9b1f9ead0f631a875b6bcfba1573d6dedb77a83ebb1e0b05362bb6a07bf1063d52835e37559a361db97474feec1bf879c77c978b60ce5fb9b7765c8324a332
-  data.tar.gz: b9ea9be17454c4ac8ec51c59207c9c510e0a6d7da7029e126f9579e5e2f65fa667b9dd3d5caa4d38f33788f8142f22c4a1ea4db04b111edda165d011ea5595b3
+  metadata.gz: 9f0a8dfc6281091f53a60b2aef2ca19716eb076c3a891b114d60ef6460bcc7f34313041732f97654c10d353e6bf0e67909d2a22ca7e820855aa0d8a23395ac28
+  data.tar.gz: 57a1e3265c29828b8ef43933724921e0b1a752e706a1689a072905099a67feea9ba090c88598ffcf371f78162610b5935fff8c68f73240eea43a7edebf4f0604

data/README.md

@@ -5,42 +5,21 @@ for exporting to various departments for analytics and troubleshooting.  This to
 allows us to annotate a DB schema with special comments that can trigger
 different data mutations
 
-FakePipe
+## Workflow with Fake Pipe
 
-## Workflow with FakePipe
-
-Here's how FakePipe could work in a projects lifecycle. These steps assume a
-Postgres database:
+Here's how FakePipe could work in a project's lifecycle. These steps assume
+you're using Postgres database:
 
 1. Add comment to table column: `COMMENT ON COLUMN user.phone IS 'anon: phone_number';`.
 2. Pipe DB dump to fake_pipe: `pg_dump my_db | fake_pipe > anon-db-dump.sql`.
 3. Send `anon-db-dump.sql` to needy people.
 
 
-## Basic Class Diagram
-
-TODO This is subject to change!
-
-    +---------------+       +----------------------------------+
-    | Piper         |       | DatabaseAdapter/PostgresAdapter  |
-    | * stdin       |       | * match comments                 |
-    | * stdout      +-------> * match dml                      |
-    | * main loop   |       |   * delegate.on_cell(name, cell) |
-    | * def on_cell |       |                                  |
-    |               |       +----------------------------------+
-    |               |
-    |               |       +-----------------+
-    |               |       | Mutator         |
-    |               +-------> * phone_number  |
-    +---------------+       | * email         |
-                            |                 |
-                            +-----------------+
-
 # Comment Dialect
 
 Schema columns comments are in [YAML format](http://www.yaml.org/start.html).
 Using some of it's option quoting, it can look very much like JSON. The reason
-it was chosen over JSON is due for the optional quotes. That means the following
+it was chosen over JSON is for the optional quotes. That means the following
 syntax will resolve to the same Ruby definition:
 
 ```
@@ -59,20 +38,43 @@ Any keys unknown by FakePipe will be ignored. So annotations from other system
 shouldn't interfere. We do hope the abbreviated YAML syntax is simple to parse
 by all systems.
 
-## Currently Support FakePipe Methods
+## Currently Support Mutation Methods
 
 To get a current list try running `rake methods` from terminal.
 
 ```sh
 $ rake methods
-anon: email         # Faker email
-anon: md5           # MD5 hash of cell contents
-anon: phone_number  # Faker::PhoneNumber with digits only
+anon: address_city          # Faker::Address.city
+anon: address_country       # Faker::Address.country
+anon: address_line_1        # Faker::Address.street_address
+anon: address_line_2        # Faker::Address.secondary_address
+anon: address_postcode      # Faker::Address.postcode
+anon: address_state         # Faker::Address.state
+anon: bcrypt_password       # bcrypt password as 'password'
+anon: bcrypt_salt           # bcrypt salt used to generate password
+anon: clean_phone_number    # Faker::PhoneNumber 10-digits only
+anon: company_catch_phrase  # Faker::Company.catch_phrase
+anon: company_name          # Faker::Company.name
+anon: email                 # Faker email
+anon: empty_bracket         # an empty bracket '[]' - good for json::array objects
+anon: empty_curly           # an empty curly brace '{}' - good for json object and array fields
+anon: empty_string          # an empty String
+anon: first_name            # Faker::Name.first_name
+anon: full_name             # Faker::Name.full_name
+anon: guid                  # UUID
+anon: last_name             # Faker::Name.last_name
+anon: lorem_paragraph       # Faker::Lorem.paragraph
+anon: lorem_sentence        # Faker::Lorem.sentence
+anon: lorem_word            # Faker::Lorem.word
+anon: md5                   # MD5 hash of cell contents
+anon: phone_ext             # Faker::PhoneNumber.extension
+anon: phone_number          # Faker::PhoneNumber with punctuation and extensions
+anon: ugcid                 # Six random uppercase letters followed by four random numbers - ex. 'ABCDEF1234'
+anon: url                   # Faker::Internet.url
+anon: user_name             # Faker::Internet.user_name
+anon: uuid                  # UUID
 ```
 
-TODO clean up README. The following is default stock from `bundle gem ...`
-
-
 # Decisions
 - 2016-06-08
   - parsing SQL file is okay for now. Reconsider using a temp DB when
@@ -114,7 +116,7 @@ git commits and tags, and push the `.gem` file to
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/centro/fake_pipe.
+https://github.com/ddrscott/fake_pipe.
 
 
 ## License

data/fake_pipe.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Scott Pierce']
   spec.email         = ['ddrscott@gmail.com']
 
-  spec.summary       = 'db_dump.sql | fake_pipe > fake_dump.sql'
+  spec.summary       = 'Anonymize a database SQL dump file by adding schema comments and piping through `fake_pipe`'
   spec.homepage      = 'https://github.com/centro/fake_pipe'
   spec.license       = 'MIT'
 

data/lib/fake_pipe/version.rb

@@ -1,3 +1,3 @@
 module FakePipe
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fake_pipe
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Scott Pierce
@@ -133,5 +133,6 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: db_dump.sql | fake_pipe > fake_dump.sql
+summary: Anonymize a database SQL dump file by adding schema comments and piping through
+  `fake_pipe`
 test_files: []