table_saw 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50a0284603206abc2575bac6cbbe322d5b2fe846db944865946ca97d01e5ac0b
-  data.tar.gz: 0611b668edaacdbc0a8f69dcebaa9c33be46f02defac7f95c054e3b08490d12f
+  metadata.gz: d488fbc1065d74a9ee27d2197634b8caa66859f0658a83e268e44c9b9a8534f4
+  data.tar.gz: 269976846ca8d1a75282cc22228953ae798e65287f559ccb5881093311fd5252
 SHA512:
-  metadata.gz: afb11fe237a477e0dd3b350f92cc22ac4beeb774ea44203df7051cc41fac55a8040b4714ebac471977e204f0069392eb1a89d43bd0e0af79b88b63e3e8a7c820
-  data.tar.gz: 25f021cfa55c5bf09aceab3cd61297697991585dd991c7b45c92d4c0e2961276190ca60895a280d1212ab2d3ea1877faf1f1fc2319e5e51789596652c10b33db
+  metadata.gz: e275dc24ffa5107f9512c90deaf803bfcda080b277bb4f25049dc4f0ea1b84d75f7dbad9a3b5b5168871644356beec801ede7203464ea86a99d0964e7c29d790
+  data.tar.gz: 31f5764301e19166431bd9f9ee055f33de9f57488b4e4184e4f4a79a6d1ab962690e0cd46fb7976e948b2aded7f89eda5620ef4f9bc4c749af7782c820bff57e

data/.travis.yml

@@ -1,8 +1,19 @@
 ---
 sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=5432d4e95a7749f237cf9e659c44ba28c5c91fa65436b15c5bc849d6d9ebc049
 language: ruby
 cache: bundler
 rvm:
   - 2.5.5
   - 2.6.3
 before_install: gem install bundler -v 2.0.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    table_saw (0.2.0)
+    table_saw (0.2.1)
       connection_pool
       pg
       thor
@@ -40,7 +40,7 @@ GEM
       railties (>= 3.0.0)
       thor (>= 0.14.6)
     concurrent-ruby (1.1.5)
-    connection_pool (2.2.1)
+    connection_pool (2.2.2)
     crass (1.0.4)
     database_cleaner (1.7.0)
     diff-lcs (1.3)

data/README.md

@@ -1,9 +1,14 @@
 [![Build Status](https://travis-ci.org/hasghari/table_saw.svg?branch=master)](https://travis-ci.org/hasghari/table_saw)
+[![Maintainability](https://api.codeclimate.com/v1/badges/abd5b5451c764d3249f1/maintainability)](https://codeclimate.com/github/hasghari/table_saw/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/abd5b5451c764d3249f1/test_coverage)](https://codeclimate.com/github/hasghari/table_saw/test_coverage)
+
 # TableSaw
 
-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/table_saw`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem creates a PSQL dump file (data only) from a Postgres database by only dumping a subset of data defined by a 
+manifest file.
 
-TODO: Delete this and the text above, and describe your gem
+It will automatically retrieve the foreign key dependencies of your tables as long as the foreign key constraints are
+defined.
 
 ## Installation
 
@@ -23,17 +28,89 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+table-saw dump -m manifest.yml
+```
+
+The command above will read your configuration from `manifest.yml` and create a dump file `output.dump`. The database
+connection properties can be supplied similar to the `pg_dump` tool provided by Postgres:
+
+```
+Usage:
+  table-saw dump -m, --manifest=MANIFEST
+
+Options:
+  -u, [--url=URL]             # Default value is $DATABASE_URL
+  -d, [--dbname=DBNAME]       # Default value is $PGDATABASE
+  -h, [--host=HOST]           # Default value is $PGHOST
+  -p, [--port=PORT]           # Default value is $PGPORT
+  -U, [--user=USER]           # Default value is $PGUSER
+      [--password=PASSWORD]   # Default value is $PGPASSWORD
+  -m, --manifest=MANIFEST
+  -o, [--output=OUTPUT]       # Default value is 'output.dump'
+```
+
+The manifest file describes which tables you want to dump from your Postgres database:
+
+```yaml
+variables:
+  author_id: 24
+tables:
+  - table: books
+    query: "select * from books where author_id = %{author_id}"
+```
+
+This will only fetch records from the `books` table where `author_id = 24` and will also fetch the record from the
+`authors` table where `id = 24`.
+
+Assuming there is a `chapters` table with a foreign key reference of `book_id` to the `books` table, the above manifest
+file will **not** automatically retrieve those records. If `chapters` records are also desired, there a couple ways to 
+accomplish this:
+
+```yaml
+variables:
+  author_id: 24
+tables:
+  - table: books
+    query: "select * from books where author_id = %{author_id}"
+    has_many:
+      - chapters
+```
+
+or
+
+```yaml
+variables:
+  author_id: 24
+tables:
+  - table: chapters
+    query: "select * from chapters inner join books on books.id = chapters.book_id where books.author_id = %{author_id}"
+```
+
+The output of the 2 manifest files above are exactly the same. The dump file will contain all the relevant records from
+the `authors`, `books` and `chapters` tables.
+
+Once your dump file has been created, you can import the data using `psql`:
+
+```bash
+table-saw dump -m manifest.yml -o chapters.dump
+psql -h localhost -U postgres -d library < chapters.dump
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can 
+also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the 
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, 
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/table_saw. 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://github.com/hasghari/table_saw. 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
 
@@ -41,4 +118,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the TableSaw project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/table_saw/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the TableSaw project’s codebases, issue trackers, chat rooms and mailing lists is expected to 
+follow the [code of conduct](https://github.com/[USERNAME]/table_saw/blob/master/CODE_OF_CONDUCT.md).

data/exe/table-saw

@@ -16,14 +16,15 @@ class CLI < Thor
   end
 
   desc 'dump', 'Create a postgres dump file'
-  method_option :url, aliases: '-u', default: ENV['DATABASE_URL']
+  method_option :url, aliases: '-u', default: ENV['DATABASE_URL'],
+                      desc: 'This option overrides all other connection properties.'
   method_option :dbname, aliases: '-d', default: ENV['PGDATABASE']
   method_option :host, aliases: '-h', default: ENV['PGHOST']
   method_option :port, aliases: '-p', default: ENV['PGPORT']
   method_option :user, aliases: '-U', default: ENV['PGUSER']
   method_option :password, default: ENV['PGPASSWORD']
   method_option :manifest, aliases: '-m', required: true
-  method_option :output, aliases: '-o', default: 'psql.dump'
+  method_option :output, aliases: '-o', default: 'output.dump'
   def dump
     TableSaw.configure(options.to_hash)
     records = TableSaw::BuildDependencyGraph.new(TableSaw::Manifest.instance).call

data/lib/table_saw/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: table_saw
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Hamed Asghari