Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 2.46 KB

README.md

File metadata and controls

65 lines (38 loc) · 2.46 KB
Raw

Easy Reference Data

Used for creating a predefined set of model instances, similar to db:seed, but will update records if entries already exist.

Installation

Add this line to your application's Gemfile:

gem 'easy_reference_data'

And then execute:

$ bundle

Or install it yourself as:

$ gem install easy_reference_data

Usage

Place references in 'db/reference/'

References will be loaded in ascending order, so if an order is desired, prepend 000, 001, 002... etc to the filename.

If an unhandled error occurs during the loading of a specific file, then all the data loaded prior to the error will remain.

Run with:

rake easy:reference_data:refresh

To have all the reference data files loaded in one transaction, run with:

rake easy:reference_data:refresh[wrap_in_transaction]

The wrap_in_transaction parameter will wrap the entire load process in a single transaction. This means any unhandled errors will result in all the data loaded prior to the error being rolled back.

Deployment

Add this line to your application's deploy.rb file:

require 'easy/reference_data/capistrano'

Example

The below example ensures that there are 3 users existing in the database after running the 'rake reference_data:load'

### db/reference/000_users.rb
Easy::ReferenceData.update_or_create User, {system_code: 'nigel', name: 'Nigel Ramsay', email: '[email protected]'}, keys: [:system_code]
Easy::ReferenceData.update_or_create User, {system_code: 'fred', name: 'Fred Schmitt', email: '[email protected]'}, keys: [:system_code]
Easy::ReferenceData.update_or_create User, {system_code: 'bert', name: 'Bert Symthe', email: '[email protected]'}, keys: [:system_code]

Multiple keys can be used to identify records that would otherwise not have a unique attribute

### db/reference/000_prices.rb
Easy::ReferenceData.update_or_create Price, {product_id: 1, type: "Price::RetailPrice", price: 5}, keys: [:product_id, :type]
Easy::ReferenceData.update_or_create Price, {product_id: 1, type: "Price::CostPrice", price: 4}, keys: [:product_id, :type]
Easy::ReferenceData.update_or_create Price, {product_id: 2, type: "Price::RetailPrice", price: 5}, keys: [:product_id, :type]

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request