Skip to content

Commit 1d75a2a

Browse files
committed
initial commit
0 parents  commit 1d75a2a

11 files changed

Lines changed: 165 additions & 0 deletions

File tree

.gitignore

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
*.gem
2+
*.rbc
3+
.bundle
4+
.config
5+
.yardoc
6+
Gemfile.lock
7+
InstalledFiles
8+
_yardoc
9+
coverage
10+
doc/
11+
lib/bundler/man
12+
pkg
13+
rdoc
14+
spec/reports
15+
test/tmp
16+
test/version_tmp
17+
tmp

Gemfile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
source 'https://rubygems.org'
2+
3+
# Specify your gem's dependencies in reference_data.gemspec
4+
gemspec

LICENSE.txt

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Copyright (c) 2012 Nigel Ramsay
2+
3+
MIT License
4+
5+
Permission is hereby granted, free of charge, to any person obtaining
6+
a copy of this software and associated documentation files (the
7+
"Software"), to deal in the Software without restriction, including
8+
without limitation the rights to use, copy, modify, merge, publish,
9+
distribute, sublicense, and/or sell copies of the Software, and to
10+
permit persons to whom the Software is furnished to do so, subject to
11+
the following conditions:
12+
13+
The above copyright notice and this permission notice shall be
14+
included in all copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Easy Reference Data
2+
3+
Used for creating a predefined set of model instances, similar to db:seed, but will update records if entries already exist.
4+
5+
## Installation
6+
7+
Add this line to your application's Gemfile:
8+
9+
gem 'easy_reference_data'
10+
11+
And then execute:
12+
13+
$ bundle
14+
15+
Or install it yourself as:
16+
17+
$ gem install easy_reference_data
18+
19+
## Usage
20+
21+
Place references in 'db/reference/'
22+
23+
References will be loaded in ascending order, so if an order is desired, prepend 000, 001, 002... etc to the filename.
24+
25+
Run with:
26+
rake easy:reference_data:load
27+
28+
## Example
29+
30+
The below example ensures that there are 3 users existing in the database after running the 'rake reference_data:load'
31+
32+
### db/reference/000_users.rb
33+
Easy::ReferenceData.refresh User, :system_code, 'nigel', name: 'Nigel Ramsay', email: 'nigel.ramsay@mailinator.com'
34+
Easy::ReferenceData.refresh User, :system_code, 'fred', name: 'Fred Schmitt', email: 'fred.schmitt@mailinator.com'
35+
Easy::ReferenceData.refresh User, :system_code, 'bert', name: 'Bert Symthe', email: 'bert.smythe@mailinator.com'
36+
37+
## Contributing
38+
39+
1. Fork it
40+
2. Create your feature branch (`git checkout -b my-new-feature`)
41+
3. Commit your changes (`git commit -am 'Added some feature'`)
42+
4. Push to the branch (`git push origin my-new-feature`)
43+
5. Create new Pull Request

Rakefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
require "bundler/gem_tasks"

easy_reference_data.gemspec

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# -*- encoding: utf-8 -*-
2+
lib = File.expand_path('../lib', __FILE__)
3+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4+
require 'easy/reference_data/version'
5+
6+
Gem::Specification.new do |gem|
7+
gem.name = "easy_reference_data"
8+
gem.version = Easy::ReferenceData::VERSION
9+
gem.authors = ["Nigel Ramsay"]
10+
gem.email = ["nigel.ramsay@abletech.co.nz"]
11+
gem.description = %q{Used to create a predefined set of model instances}
12+
gem.summary = %q{Loads files from db/reference/*.rb}
13+
gem.homepage = "http://github.com/AbleTech/easy_reference_data"
14+
15+
gem.files = `git ls-files`.split($/)
16+
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
17+
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
18+
gem.require_paths = ["lib"]
19+
20+
gem.add_runtime_dependency 'rails', '>= 3.0.0'
21+
end

lib/easy/reference_data/railtie.rb

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
require 'rails'
2+
3+
module Easy
4+
module ReferenceData
5+
class Railtie < Rails::Railtie
6+
rake_tasks do
7+
load "tasks/easy_reference_data.rake"
8+
end
9+
end
10+
end
11+
end

lib/easy/reference_data/refresh.rb

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
module Easy
2+
module ReferenceData
3+
def self.refresh(clazz, unique_attribute_symbol, unique_attribute_value, attributes)
4+
record = clazz.where(unique_attribute_symbol => unique_attribute_value).first
5+
6+
if record.nil?
7+
record = clazz.new(unique_attribute_symbol => unique_attribute_value)
8+
end
9+
10+
attributes.each_pair do |key, value|
11+
record.send "#{key}=", value
12+
end
13+
14+
begin
15+
record.save!
16+
rescue
17+
puts "Save failed for #{record.class}[#{unique_attribute_symbol}: #{unique_attribute_value}] with attributes #{attributes.inspect}"
18+
raise
19+
end
20+
21+
record
22+
end
23+
end
24+
end

lib/easy/reference_data/version.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module Easy
2+
module ReferenceData
3+
VERSION = "0.0.1"
4+
end
5+
end

lib/easy_reference_data.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
require 'easy/reference_data/version'
2+
require 'easy/reference_data/railtie'
3+
require 'easy/reference_data/refresh'

0 commit comments

Comments
 (0)