seedster 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 468b8c6fc14489ca306402904281050c991ab991
-  data.tar.gz: 59cf2ae2eb89467266ad9d9d507318b4cf9f6604
+  metadata.gz: 43fbeb4071f54875cbbc8228d0c36b663a1dc656
+  data.tar.gz: ed258b43a623c4fb04724c91ab9c3ebbe14d6eb3
 SHA512:
-  metadata.gz: 89ae08729c0184f4a8cd7ce1096b2a2148763fb7e2125f12824756c6cec3f9af0107369a6d80855a0e380ec40b2313f581acb5c766192e0cffa05f96d69ae7cb
-  data.tar.gz: 60fe5fc13cc95c498acef17d47ac08f193267f926a01830b28690afbe6e57f79dc0ac18206bcda2bb2124f16e8ec119b788ca046aa05542bff5eb180ba910b9d
+  metadata.gz: 4f55fc4569508eaeffcd84c3d7272846eaefc46467ff37476a1397f1521d7e59902cff42f9324daa4291a582ba8cf0f8e52dc0f126aea3e855c05cd0997cbcda
+  data.tar.gz: f84db4a58dca3c716b77ffa491779d89097382d1dd2c738b102368f6f29139966694fa4e105ec53279eb26a497de9af54be5bb9be8d7c0fce69dd82c10409de8

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [0.1.5] - 2019-07-16
+
+### Added
+  - Feature: Rails initializer. Run with `rails generate seedster:initializer`
+

data/README.md

@@ -41,8 +41,19 @@ To download, extract, and load the data file:
 dev_shell> rake seedster:load
 ```
 
+## Table of Contents
 
-## Installation
+* [Installation](#installation)
+* [Initializer](#initializer)
+* [Configuration Options](#configuration-options)
+* [Seedster Development](#seedster-development)
+ 	* [Testing](#testing)
+	* [Contributing](#contributing)
+	* [Releasing a new version](#releasing-a-new-version)
+	* [License](#contributing)
+	* [Code of Conduct](#code-of-conduct)
+
+### Installation
 
 ```ruby
 gem 'seedster'
@@ -56,11 +67,17 @@ Or install it yourself as:
 
     $ gem install seedster
 
-## Initializer
+### Initializer
 
 An initializer is required to make Seedster work with your hosts, database, ssh config, and really drives everything that is unique to your application.
 
-Create a file `config/initializers/seedster.rb` with content like this:
+The gem provides an initializer. Run:
+
+`rails generate seedster:initializer`
+
+This will create a file `config/initializers/seedster.rb` where you can begin putting in values for your application. The configuration is both for DB credentials, SSH credentials, but also the configuration of the tables you wish to dump.
+
+The initializer looks like this:
 
 ```ruby
 Seedster.configure do |c|
@@ -85,7 +102,7 @@ end
 ```
 
 
-### Initializer config options
+### Configuration Options
 
 ##### `db_host`
 
@@ -127,19 +144,19 @@ The tables option is where each query is stored. This is currently an array of h
 
 
 
-## Development
+## Seedster Development
 
 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).
 
-## Testing
+### Testing
 
 Run the test suite with `rake test`.
 
-## Contributing
+### Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/groupon/seedster. 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.
 
-## Releasing a new version
+### Releasing a new version
 
 1. Update the version in `seedster.gemspec`
 2. `git commit seedster.gemspec` with the following message format:
@@ -151,10 +168,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/groupo
         * Some new bug fix
 3. `rake release`
 
-## License
+### License
 
 The gem is available as open source under the terms of the [APACHE LICENSE, VERSION 2.0](https://www.apache.org/licenses/LICENSE-2.0).
 
-## Code of Conduct
+### Code of Conduct
 
 Everyone interacting in the Seedster project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/groupon/seedster/blob/master/CODE_OF_CONDUCT.md).

data/lib/generators/seedster/initializer_generator.rb

@@ -0,0 +1,14 @@
+# https://guides.rubyonrails.org/generators.html
+module Seedster
+  module Generators
+    class InitializerGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_initializer_file
+        copy_file \
+          'initializer.rb',
+          'config/initializers/seedster.rb'
+      end
+    end
+  end
+end

data/lib/generators/seedster/templates/initializer.rb

@@ -0,0 +1,33 @@
+Seedster.configure do |c|
+  c.db_host = 'host.com' # DB host. Fill this in, or reference Rails config/development.yml database values or ar-octopus config
+  c.db_name = 'db_nameXXX'
+  c.db_username = 'db_usernameXXX'
+  c.db_password = 'passwordXXX'
+
+  c.remote_host_path = "/var/company/www/app/current" # where the root of the app is deployed on the host
+
+  c.query_params = { } # pass in values to interpolate into queries,
+                       # e.g. USER_ID=XXX would be {user_id: ENV['USER_ID']}
+
+  c.ssh_user = 'ssh_userXXX' # which user will connect to the host
+
+  c.dump_host = 'app.host.com' # host where app is deployed
+
+  #
+  # Help:
+  # Comma-separated list of hashes, with keys `query` and `name`, one hash per DB table
+  #
+  # Keys:
+  # query: the SQL query for the table to be dumped. Add a parameter like `user_id` to be passed in.
+  # name: the name of the database table
+  #
+  c.tables = [
+    # BEGIN example ---
+    # {
+    #   query: %{SELECT u.* FROM users
+    #       where u.id = '%{user_id}'},
+    #   name: 'users'
+    # }
+    # END example -----
+  ]
+end

data/lib/seedster/version.rb

@@ -14,5 +14,5 @@
 # limitations under the License.
 #
 module Seedster
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/seedster.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Work with real content in development}
   spec.description   = %q{Easily load real application content for local development}
-  spec.homepage      = ""
-  spec.license       = "Apache2"
+  spec.homepage      = "https://github.com/groupon/seedster"
+  spec.license       = "Apache-2.0"
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seedster
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Groupon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-24 00:00:00.000000000 Z
+date: 2019-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -69,6 +70,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/seedster/initializer_generator.rb
+- lib/generators/seedster/templates/initializer.rb
 - lib/seedster.rb
 - lib/seedster/data_dumper.rb
 - lib/seedster/data_loader.rb
@@ -77,9 +80,9 @@ files:
 - lib/seedster/tasks/seedster.rb
 - lib/seedster/version.rb
 - seedster.gemspec
-homepage: ''
+homepage: https://github.com/groupon/seedster
 licenses:
-- Apache2
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []