0.0
No commit activity in last 3 years
No release in over 3 years
Simple reporting for Ruby on Rails seed files.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.10
~> 10.0
>= 0
 Project Readme

Code Climate

SeedReport

The Deliverable

A readable summary of your Rails seed results. Doesn't disrupt your Seed file; takes care of the accounting.

Country  initial count: 0, 1 created
Region   initial count: 0, 5 created
Agency   initial count: 0, 5 created

Step 1. Place your create's and save's in a request for a seed report:

SeedReport.for_model Model_class do
  # A block which creates the Model_class seed instances.
end

For example:

SeedReport.for_model Country do
  Country.find_or_create_by!(
    name:        'United States',
    alpha_2:     'us',
    alpha_3:     'usa',
    region_meta_name: 'state'
  )
end

SeedReport.for_model Region do
  us = Country.find_by! alpha_2: 'us'

  Region.find_or_create_by!(
    name:    'California',
    slug:    'ca',
    country:  us
  )
  Region.find_or_create_by!(
    name:    'Nevada',
    slug:    'nv',
    country:  us
  )
end

# etc.

Step 2. Run your seeds in the usual way: with rake db:reset (my favorite), rake db:setup, or rake db:seed.

Step 3. See a concise summary output of the changes made.

Installation

Add this line to your Rails application's Gemfile:

gem 'seed_report', group: :development

And then execute:

$ bundle

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.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dogweather/seed_report.

License

The gem is available as open source under the terms of the MIT License.