shah-seed_data 0.5.1

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 0
+:minor: 5

data/lib/seed_data.rb

@@ -0,0 +1,59 @@
+module SeedData
+
+    class SeedColumnMissing < Exception
+    end
+    
+    def self.included(base)
+        base.extend ClassMethods
+    end
+ 
+    module ClassMethods
+
+        def create_or_update_seed(options = {})
+            seed_info = options.delete(:SEED) || { :key => "seed_name" }
+            keys = seed_info[:keys] || seed_info[:key]
+            keys = [keys] if keys.is_a?(String)  # in case it's just one column, convert it to an array         
+            
+            # make sure each seed key value's column is present (it's ok to be Nil, it just must be present)
+            conditions = {}
+            keys.each do |c|
+              unless options.key?(c) || options.key?(c.to_sym)
+                raise SeedColumnMissing, "Seed column #{c} is missing from seed data in #{self.class.name}.create_or_update_seed(#{options.keys.join(', ')})."
+              end
+              conditions[c.to_sym] = (options[c] || options[c.to_sym])
+            end
+
+            updated = true
+            record = find(:first, :conditions => conditions)
+            if ! record 
+                record = new
+                updated = false
+            end
+            record.attributes = options
+
+            # run through the passed in attributes and see if there's anything dynamic required for any of them
+            # this is useful only if the seed data was read from an import file like a CSV or something
+            eval_code = ""
+            options.each_pair {|k,v|
+                if(v && v.match(/^EVAL:(.*)/))
+                    eval_code += "record.#{k} = #{$1}\n";  # prepare the eval string with some ruby code
+                end            
+            }
+            eval(eval_code) if eval_code
+
+            record.save!    
+
+            if seed_info.member?(:log)
+                seed_info[:log].push("#{updated ? 'Updated' : 'Created'} #{record.class.name} seed for #{keys.join(', ')} = #{keys.collect{|k| v = record[k.to_sym]; v.nil? ? 'NULL' : v}.join(', ')}.")
+            end
+
+            record
+        end
+
+    end
+  
+end
+
+class ActiveRecord::Base
+    include SeedData
+end

data/test/database.yml

@@ -0,0 +1,7 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: seed_data.sqlite.db
+sqlite3:
+  :adapter: sqlite3
+  :dbfile: seed_data.sqlite3.db
+

data/test/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table :first_seed_data_test_table, :force => true do |t|
+    t.string  :seed_name, :null => false
+    t.string  :attr_1
+    t.integer :attr_2
+    t.boolean :attr_3
+  end
+
+  create_table :second_seed_data_test_table, :force => true do |t|
+    t.string  :seed_name, :null => false
+    t.string  :seed_scope
+    t.string  :attr_1
+    t.integer :attr_2
+  end
+  
+end
+

data/test/seed_data_test.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class FirstSeedDataTestTable < ActiveRecord::Base 
+end
+
+class SecondSeedDataTestTable < ActiveRecord::Base 
+end
+
+class SeedDataTest < Test::Unit::TestCase
+    context "ActiveRecord" do
+      should "respond to create_or_update_seed" do
+        assert FirstSeedDataTestTable.respond_to?('create_or_update_seed')
+      end
+    end
+
+    context "FirstSeedDataTestTable" do
+      should "create the first seed row" do
+        log = []
+        record = FirstSeedDataTestTable.create_or_update_seed(:SEED => { :key => "seed_name", :log => log }, :seed_name => "ROW_1", :attr_1 => "ATTR_1 Test Value 01")
+        assert_equal "Created FirstSeedDataTestTable seed for seed_name = ROW_1.", log[0]
+        assert_equal "ATTR_1 Test Value 01", record.attr_1
+      end
+
+      should "update the first seed row" do
+        log = []
+        record = FirstSeedDataTestTable.create_or_update_seed(:SEED => { :key => "seed_name", :log => log }, :seed_name => "ROW_1", :attr_1 => "ATTR_1 Test Value 02", :attr_2 => "EVAL:1+1")
+        assert_equal "Updated FirstSeedDataTestTable seed for seed_name = ROW_1.", log[0]
+        assert_equal "ATTR_1 Test Value 02", record.attr_1
+        assert_equal 2, record.attr_2
+      end
+    end
+
+    context "SecondSeedDataTestTable" do
+      should "create the first seed row with no scope" do
+        log = []
+        record = SecondSeedDataTestTable.create_or_update_seed(:SEED => { :keys => ["seed_name", "seed_scope"], :log => log }, :seed_name => "ROW_1", :seed_scope => nil, :attr_1 => "ATTR_1 Test Value 01")
+        assert_equal "Created SecondSeedDataTestTable seed for seed_name, seed_scope = ROW_1, NULL.", log[0]
+        assert_equal "ATTR_1 Test Value 01", record.attr_1
+      end
+
+      should "update the first seed row with no scope" do
+        log = []
+        record = SecondSeedDataTestTable.create_or_update_seed(:SEED => { :keys => ["seed_name", "seed_scope"], :log => log }, :seed_name => "ROW_1", :seed_scope => nil, :attr_1 => "ATTR_1 Test Value 02", :attr_2 => "EVAL:5*5")
+        assert_equal "Updated SecondSeedDataTestTable seed for seed_name, seed_scope = ROW_1, NULL.", log[0]
+        assert_equal "ATTR_1 Test Value 02", record.attr_1
+        assert_equal 25, record.attr_2
+      end
+
+      should "create the first seed row with a scope" do
+        log = []
+        record = SecondSeedDataTestTable.create_or_update_seed(:SEED => { :keys => ["seed_name", "seed_scope"], :log => log }, :seed_name => "ROW_1", :seed_scope => 'SCOPE_1', :attr_1 => "ATTR_1 Test Value 01")
+        assert_equal "Created SecondSeedDataTestTable seed for seed_name, seed_scope = ROW_1, SCOPE_1.", log[0]
+        assert_equal "ATTR_1 Test Value 01", record.attr_1
+      end
+
+      should "update the first seed row with a scope" do
+        log = []
+        record = SecondSeedDataTestTable.create_or_update_seed(:SEED => { :keys => ["seed_name", "seed_scope"], :log => log }, :seed_name => "ROW_1", :seed_scope => 'SCOPE_1', :attr_1 => "ATTR_1 Test Value 02", :attr_2 => "EVAL:2+3")
+        assert_equal "Updated SecondSeedDataTestTable seed for seed_name, seed_scope = ROW_1, SCOPE_1.", log[0]
+        assert_equal "ATTR_1 Test Value 02", record.attr_1
+        assert_equal 5, record.attr_2
+      end
+    end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+RAILS_ROOT = File.dirname(__FILE__)
+
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'shoulda'
+require 'mocha'
+require "#{File.dirname(__FILE__)}/../init"
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite3'])
+ActiveRecord::Base.pluralize_table_names = false
+
+load(File.dirname(__FILE__) + "/schema.rb") if File.exist?(File.dirname(__FILE__) + "/schema.rb")
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: shah-seed_data
+version: !ruby/object:Gem::Version 
+  version: 0.5.1
+platform: ruby
+authors: 
+- Shahid N. Shah
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-18 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Create seed data rake tasks and use the new Model.create_or_update_seed() method to manage default data.
+email: shahid@shah.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- lib/seed_data.rb
+- test/seed_data_test.rb
+- test/test_helper.rb
+- test/database.yml
+- test/schema.rb
+- test/debug.log
+- test/seed_data.sqlite3.db
+has_rdoc: false
+homepage: http://github.com/shah/seed_data
+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: Adds methods to ActiveRecord to manage seed data that should be loaded into the database.
+test_files: []
+