ffmike-db_populate 0.2.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,62 @@
+db_populate
+===========
+db_populate is an answer to the question "how do I get seed data into a Rails application?" 
+Seed data is normally the contents of lookup tables that are essential to the normal
+functioning of your application: lists of roles, administrative accounts, choices for
+dropdown boxes, and so on.
+
+The inspiration (and some of the code) for this plugin come from a blog entry by Luke
+Francl (http://railspikes.com/2008/2/1/loading-seed-data) that looked at some of the
+available alternatives for loading seed data. Some more of the code came from Josh
+Knowles' db_populate plugin (http://code.google.com/p/db-populate/). But I didn't like 
+having to assemble bits, and had some ideas to extend it, and...well, you know how it
+goes.
+
+Using db_populate
+=================
+The basic idea behind db_populate is simple: to put seed data in your application's
+tables, it executes ruby code. The code needs to be in a specific place, and there's a 
+helper to make it easier to create and update consistent seed data. Then there are a
+couple of rake tasks. That's it.
+
+Setting up for db_populate
+==========================
+
+To get started with db_populate, create the folder db/populate in your Rails application.
+Any code you put in this folder will be run by db_populate. Optionally, you can create
+subfolders for your Rails environments, just as you can with config files. db_populate
+executes all of the top-level populate files first, followed by any environment-specific
+populate files, sorting each list by name. So, for example, with 4 files in the production
+environment, db_populate would order this way:
+
+db/populate/01_roles.rb
+db/populate/02_services.rb
+db/populate/production/01_users.rb
+db/populate/production/02_options.rb
+
+Within each file, you can place whatever ruby code you like. To help create consistent
+records, db_populate adds create_or_populate to ActiveRecord::Base. This method looks up
+a record by ID; if the record exists, it is updated, and if it doesn't, it is created. Using
+this technique means that you can edit and re-run your db_populate tasks without damaging 
+data that have already been loaded once. For example, assuming your roles table has already
+been populated, a db_populate file to create an administrative user might look like this:
+
+user = User.create_or_update(:id => 1, :login => "admin", :email => "admin@example.com", 
+ :name => "Site Administrator", :password => "admin", :password_confirmation => "admin")
+role = Role.find_by_rolename('administrator')
+Permission.create_or_update(:id => 1, :role_id => role.id, :user_id => user.id)
+
+If you change your mind about the name for the site administrator, you can just edit the data
+and re-run the task.
+
+db_populate rake tasks
+======================
+db_populate includes two rake tasks:
+
+rake db:populate loads all of the data for the current environment
+rake db:migrate_and_populate is the same as calling rake db:migrate followed by rake db:populate
+
+History
+=======
+2009-03-21 Patch from Ahmed El-Daly to allow PKs with names other than id
+2008-10-11 Initial release

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the db_populate plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the db_populate plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DbPopulate'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/create_or_update.rb

@@ -0,0 +1,19 @@
+class ActiveRecord::Base
+  # given a hash of attributes including the ID, look up the record by ID.
+  # uses whatever the PK of the model is to do the lookup 
+  # If it does not exist, it is created with the rest of the options. 
+  # If it exists, it is updated with the given options. 
+  #
+  # Raises an exception if the record is invalid to ensure seed data is loaded correctly.
+  # 
+  # Returns the record.
+  def self.create_or_update(options = {})
+    id = options.delete(primary_key.to_sym)
+    record = send("find_by_#{primary_key}", id) || new
+    record.id = id
+    record.attributes = options
+    record.save!
+    
+    record
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require "create_or_update" 

data/tasks/db_populate_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :user_event_logger do
+#   # Task goes here
+# end

data/tasks/populate.rake

@@ -0,0 +1,21 @@
+namespace :db do
+  
+  desc "Loads initial database models for the current environment."
+  task :populate => :environment do
+    require File.join(File.dirname(__FILE__), '/../lib', 'create_or_update')
+    Dir[File.join(RAILS_ROOT, 'db', 'populate', '*.rb')].sort.each do |fixture| 
+      load fixture 
+      puts "Loaded #{fixture}"
+    end
+    Dir[File.join(RAILS_ROOT, 'db', 'populate', RAILS_ENV, '*.rb')].sort.each do |fixture| 
+      load fixture 
+      puts "Loaded #{fixture}"
+    end
+  end
+  
+  desc "Runs migrations and then loads seed data"
+  task :migrate_and_populate => [ 'db:migrate', 'db:populate' ]
+
+  task :migrate_and_load => [ 'db:migrate', 'db:populate' ]
+  
+end

data/test/database.yml

@@ -0,0 +1,18 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: db_populate_plugin.sqlite.db
+sqlite3:
+  :adapter: sqlite3
+  :dbfile: db_populate_plugin.sqlite3.db
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: db_populate_plugin_test
+  :min_messages: ERROR
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: rails
+  :password:
+  :database: db_populate_plugin_test

data/test/db_populate_test.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+
+class User < ActiveRecord::Base
+end
+
+class Customer < ActiveRecord::Base
+  set_primary_key "cust_id"
+end
+
+class DbPopulateTest < Test::Unit::TestCase
+  
+  def test_creates_new_record
+    User.delete_all
+    User.create_or_update(:id => 1, :name => "Fred")
+    assert_equal User.count, 1
+    u = User.find(:first)
+    assert_equal u.name, "Fred"
+  end
+  
+  def test_updates_existing_record
+    User.delete_all
+    User.create_or_update(:id => 1, :name => "Fred")
+    User.create_or_update(:id => 1, :name => "George")
+    assert_equal User.count, 1
+    u = User.find(:first)
+    assert_equal u.name, "George"
+  end
+  
+  def test_creates_new_record_with_nonstandard_pk
+    Customer.delete_all
+    Customer.create_or_update(:cust_id => 1, :name => "Fred")
+    assert_equal Customer.count, 1
+    c = Customer.find(:first)
+    assert_equal c.name, "Fred"
+  end
+  
+  def test_updates_existing_record
+    Customer.delete_all
+    Customer.create_or_update(:cust_id => 1, :name => "Fred")
+    Customer.create_or_update(:cust_id => 1, :name => "George")
+    assert_equal Customer.count, 1
+    c = Customer.find(:first)
+    assert_equal c.name, "George"
+  end
+  
+end
+

data/test/schema.rb

@@ -0,0 +1,11 @@
+ActiveRecord::Schema.define(:version => 0) do
+    
+  create_table "users", :force => true do |t|
+    t.string   "name"
+  end
+    
+  create_table "customers", :primary_key => 'cust_id', :force => true do |t|
+    t.string "name"
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,34 @@
+ENV['RAILS_ENV'] = 'test'
+
+require 'rubygems'
+require 'test/unit'
+require 'action_controller'
+require 'active_record'
+require 'action_view'
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+
+db_adapter = ENV['DB']
+
+# no db passed, try one of these fine config-free DBs before bombing. 
+db_adapter ||= begin 
+  require 'rubygems' 
+  require 'sqlite'
+  'sqlite' 
+  rescue MissingSourceFile 
+    begin 
+    require 'sqlite3' 
+    'sqlite3' 
+    rescue MissingSourceFile 
+  end 
+end
+
+if db_adapter.nil?
+  raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3." 
+end
+
+ActiveRecord::Base.establish_connection(config[db_adapter])
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+require File.dirname(__FILE__) + '/../init.rb'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: ffmike-db_populate
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- Mike Gunderloy
+- Josh Knowles
+- Luke Francl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-21 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: db_populate provides rake and code support for adding seed data to Rails projects. Forked from a rake task by Josh Knowles, plus code by Luke Francl.
+email: MikeG1@larkfarm.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- init.rb
+- install.rb
+- lib/create_or_update.rb
+- rails/init.rb
+- tasks/populate.rake
+- tasks/db_populate_tasks.rake
+- test/database.yml
+- test/schema.rb
+- test/test_helper.rb
+- test/db_populate_test.rb
+- uninstall.rb
+has_rdoc: false
+homepage: http://github.com/ffmike/db-populate/tree/master
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Seed data populator for Rails
+test_files: []
+