revo-seed-fu 1.0.0

data/README

@@ -0,0 +1,66 @@
+Seed Fu
+=======
+
+Seed Fu is an attempt to once and for all solve the problem of inserting and
+maintaining seed data in a database. It uses a variety of techniques gathered
+from various places around the web and combines them to create what is 
+hopefully the most robust seed data system around.
+
+If you have suggestions or come across problems, please report them on
+the Lighthouse project for Seed Fu:
+http://mbleigh.lighthouseapp.com/projects/10223-seed-fu/overview
+
+Usage
+=======
+
+Seed data is taken from the db/fixtures directory. Simply make descriptive .rb
+files in that directory (they can be named anything, but users.rb for the User
+model seed data makes sense, etc.). These scripts will be run whenever the
+db:seed rake task is called. You can put arbitrary Ruby code in these files,
+but remember that it will be executed every time the rake task is called, so
+it needs to be runnable multiple times on the same database.
+
+You can also have environment-specific seed data placed in 
+db/fixtures/ENVIRONMENT that will only be loaded if that is the current
+environment.
+
+Let's say we want to populate a few default users. In db/fixtures/users.rb we
+write the following code:
+
+    User.seed(:login, :email) do |s|
+      s.login = "bob"
+      s.email = "bob@bobson.com"
+      s.first_name = "Bob"
+      s.last_name = "Bobson"
+    end
+    
+    User.seed(:login, :email) do |s|
+      s.login = "bob"
+      s.email = "bob@stevenson.com"
+      s.first_name = "Bob"
+      s.last_name = "Stevenson"
+    end
+
+That's all you have to do! You will now have two users created in the system
+and you can change their first and last names in the users.rb file and it will
+be updated as such.
+
+The arguments passed to the <ActiveRecord>.seed method are the constraining
+attributes: these must remain unchanged between db:seed calls to avoid data
+duplication. By default, seed data will constrain to the id like so:
+
+    Category.seed do |s|
+      s.id = 1
+      s.name = "Buttons"
+    end
+    
+    Category.seed do |s|
+      s.id = 2
+      s.name = "Bobbins"
+      s.parent_id = 1
+    end
+    
+Note that any constraints that are passed in must be present in the subsequent
+seed data setting.
+
+Copyright (c) 2008 Michael Bleigh, released under the MIT license

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run specs.'
+task :default => :spec

data/init.rb

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

data/lib/seed-fu.rb

@@ -0,0 +1,90 @@
+module SeedFu
+  class Seeder
+    def self.plant(model_class, *constraints, &block)
+      constraints = [:id] if constraints.empty?
+      seed = Seeder.new(model_class)
+      insert_only = constraints.last.is_a? TrueClass
+      constraints.delete_at(*constraints.length-1) if (constraints.last.is_a? TrueClass or constraints.last.is_a? FalseClass)
+      seed.set_constraints(*constraints)
+      yield seed
+      seed.plant!(insert_only)
+    end
+
+    def initialize(model_class)
+      @model_class = model_class
+      @constraints = [:id]
+      @data = {}
+    end
+
+    def set_constraints(*constraints)
+      raise "You must set at least one constraint." if constraints.empty?
+      @constraints = []
+      constraints.each do |constraint|
+        raise "Your constraint `#{constraint}` is not a column in #{@model_class}. Valid columns are `#{@model_class.column_names.join("`, `")}`." unless @model_class.column_names.include?(constraint.to_s)
+        @constraints << constraint.to_sym
+      end
+    end
+
+    def set_attribute(name, value)
+      @data[name.to_sym] = value
+    end
+
+    def plant! insert_only=false
+      record = get
+      return if !record.new_record? and insert_only
+      @data.each do |k, v|
+        record.send("#{k}=", v)
+      end
+      record.save!
+      puts " - #{@model_class} #{condition_hash.inspect}"      
+      record
+    end
+
+    def method_missing(method_name, *args) #:nodoc:
+      if (match = method_name.to_s.match(/(.*)=$/)) && args.size == 1
+        set_attribute(match[1], args.first)
+      else
+        super
+      end
+    end
+
+    protected
+
+    def get
+      records = @model_class.find(:all, :conditions => condition_hash)
+      raise "Given constraints yielded multiple records." unless records.size < 2
+      if records.any?
+        return records.first
+      else
+        return @model_class.new
+      end
+    end
+
+    def condition_hash
+      @data.reject{|a,v| !@constraints.include?(a)}
+    end
+  end
+end
+
+
+class ActiveRecord::Base
+  # Creates a single record of seed data for use
+  # with the db:seed rake task. 
+  # 
+  # === Parameters
+  # constraints :: Immutable reference attributes. Defaults to :id
+  def self.seed(*constraints, &block)
+    SeedFu::Seeder.plant(self, *constraints, &block)
+  end
+
+  def self.seed_many(*constraints)
+    seeds = constraints.pop
+    seeds.each do |seed_data|
+      seed(*constraints) do |s|
+        seed_data.each_pair do |k,v|
+          s.send "#{k}=", v
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'seed-fu'

data/revo-seed-fu.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name = 'revo-seed-fu'
+  s.version = '1.0.0'
+  s.date = '2008-08-16'
+  
+  s.summary = "Allows easier database seeding of tables."
+  s.description = "Seed Fu is an attempt to once and for all solve the problem of inserting and maintaining seed data in a database. It uses a variety of techniques gathered from various places around the web and combines them to create what is hopefully the most robust seed data system around."
+  
+  s.authors = ["Michael Bleigh","Revo Pty. Ltd."]
+  s.email = "michael@intridea.com"
+  s.homepage = 'http://github.com/mbleigh/seed-fu'
+  
+  s.has_rdoc = true
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README"]
+
+  s.add_dependency 'rails', ['>= 2.1']
+  
+  s.files = ["README",
+             "Rakefile",
+             "init.rb",
+             "lib/seed-fu.rb",
+             "rails/init.rb",
+             "revo-seed-fu.gemspec",
+             "spec/schema.rb",
+             "spec/seed_fu_spec.rb",
+             "spec/spec_helper.rb",
+             "tasks/seed_fu_tasks.rake"]
+
+end

data/spec/schema.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table :seeded_models, :force => true do |t|
+    t.column :login, :string
+    t.column :first_name, :string
+    t.column :last_name, :string
+    t.column :title, :string
+  end
+end

data/spec/seed_fu_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+load(File.dirname(__FILE__) + '/schema.rb')
+
+describe SeedFu::Seeder do
+  it "should create a model if one doesn't exist" do
+    SeededModel.seed(:id) do |s|
+      s.id = 1
+      s.login = "bob"
+      s.first_name = "Bob"
+      s.last_name = "Bobson"
+      s.title = "Peon"
+    end
+    
+    bob = SeededModel.find_by_id(1)
+    bob.first_name.should == "Bob"
+    bob.last_name.should == "Bobson"
+  end
+  
+  it "should be able to handle multiple constraints" do
+    SeededModel.seed(:title, :login) do |s|
+      s.login = "bob"
+      s.title = "Peon"
+      s.first_name = "Bob"
+    end
+    
+    SeededModel.count.should == 1
+    
+    SeededModel.seed(:title, :login) do |s|
+      s.login = "frank"
+      s.title = "Peon"
+      s.first_name = "Frank"
+    end
+    
+    SeededModel.count.should == 2
+    
+    SeededModel.find_by_login("bob").first_name.should == "Bob"
+    SeededModel.seed(:title, :login) do |s|
+      s.login = "bob"
+      s.title = "Peon"
+      s.first_name = "Steve"
+    end
+    SeededModel.find_by_login("bob").first_name.should == "Steve"
+  end
+  
+  it "should be able to create models from an array of seed attributes" do
+    SeededModel.seed_many(:title, :login, [
+      {:login => "bob", :title => "Peon", :first_name => "Steve"},
+      {:login => "frank", :title => "Peasant", :first_name => "Francis"},
+      {:login => "harry", :title => "Noble", :first_name => "Harry"}
+    ])
+    
+    SeededModel.find_by_login("bob").first_name.should == "Steve"
+    SeededModel.find_by_login("frank").first_name.should == "Francis"
+    SeededModel.find_by_login("harry").first_name.should == "Harry"
+  end
+  
+  #it "should raise an error if constraints are not unique" do
+  #  SeededModel.create(:login => "bob", :first_name => "Bob", :title => "Peon")
+  #  SeededModel.create(:login => "bob", :first_name => "Robert", :title => "Manager")
+  #  
+  #  SeededModel.seed(:login) do |s|
+  #    s.login = "bob"
+  #    s.title = "Overlord"
+  #  end
+  #end
+  
+  it "should default to an id constraint"
+  it "should update, not create, if constraints are met"
+  it "should require that all constraints are defined"
+  it "should raise an error if validation fails"
+  it "should retain fields that aren't specifically altered in the seeding"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+
+plugin_spec_dir = File.dirname(__FILE__)
+ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+
+class SeededModel < ActiveRecord::Base
+  validates_presence_of :title
+end

data/tasks/seed_fu_tasks.rake

@@ -0,0 +1,44 @@
+namespace :db do
+  desc <<-EOS
+    Loads seed data for the current environment. It will look for
+    ruby seed files in <RAILS_ROOT>/db/fixtures/ and 
+    <RAILS_ROOT>/db/fixtures/<RAILS_ENV>/.
+
+    By default it will load any ruby files found. You can filter the files
+    loaded by passing in the SEED environment variable with a comma-delimited
+    list of patterns to include. Any files not matching the pattern will
+    not be loaded.
+    
+    You can also change the directory where seed files are looked for
+    with the FIXTURE_PATH environment variable. 
+    
+    Examples:
+      # default, to load all seed files for the current environment
+      rake db:seed
+      
+      # to load seed files matching orders or customers
+      rake db:seed SEED=orders,customers
+      
+      # to load files from RAILS_ROOT/features/fixtures
+      rake db:seed FIXTURE_PATH=features/fixtures 
+  EOS
+  task :seed => :environment do
+    fixture_path = ENV["FIXTURE_PATH"] ? ENV["FIXTURE_PATH"] : "db/fixtures"
+
+    global_seed_files = Dir[File.join(RAILS_ROOT, fixture_path, '*.rb')].sort
+    env_specific_seed_files = Dir[File.join(RAILS_ROOT, fixture_path, RAILS_ENV, '*.rb')]
+    potential_seed_files = (global_seed_files + env_specific_seed_files).uniq
+    
+    if ENV["SEED"]
+      filter = ENV["SEED"].gsub(/,/, "|")
+      potential_seed_files.reject!{ |file| true unless file =~ /#{filter}/ }
+      puts "\n == Filtering seed files against regexp: #{filter}"
+    end
+
+    potential_seed_files.each do |file|
+      pretty_name = file.sub("#{RAILS_ROOT}/", "")
+      puts "\n== Seed from #{pretty_name} "
+      load file
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: revo-seed-fu
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+  - Michael Bleigh
+  - Revo Pty. Ltd.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-16 00:00:00 +10:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rails
+    type: :runtime
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "2.1"
+      version: 
+description: Seed Fu is an attempt to once and for all solve the problem of inserting and maintaining seed data in a database. It uses a variety of techniques gathered from various places around the web and combines them to create what is hopefully the most robust seed data system around.
+email: michael@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - README
+files: 
+  - README
+  - Rakefile
+  - init.rb
+  - lib/seed-fu.rb
+  - rails/init.rb
+  - revo-seed-fu.gemspec
+  - spec/schema.rb
+  - spec/seed_fu_spec.rb
+  - spec/spec_helper.rb
+  - tasks/seed_fu_tasks.rake
+has_rdoc: true
+homepage: http://github.com/mbleigh/seed-fu
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+  - --main
+  - README
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Allows easier database seeding of tables.
+test_files: []
+