merb_seed 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Michael Bleigh, released under the MIT license
+
+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,102 @@
+merb_seed
+=======
+
+merb_seed 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.
+
+
+Support
+=======
+
+merb_seed 0.1 currently only supports datamapper. ActiveRecord and Sequel support 
+
+
+Usage
+=======
+
+rake db:seed
+
+
+Setting up Seed Data
+=======
+Seed data is taken from the schema/data 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 
+schema/data/ENVIRONMENT that will only be loaded if that is the current
+environment.
+
+Let's say we want to populate a few default users. In schema/data/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.
+
+
+Callbacks
+=======
+
+Seed data can also define callbacks that will run after the record is created
+
+Category.seed do |s|
+  s.id = 2
+  s.name = "Bobbins"
+  s.parent_id = 1
+  
+  # run code after creation (record is the newly created model)
+  s.after_seed do |record|
+    record.enable! 
+  end
+end
+
+Source Code
+=======
+
+Need a change? Help out by forking and doing a pull request. I'll merge in any new features or bug fixes that you make.
+http://github.com/merbjedi/merb_seed
+
+
+Seed Fu
+=======
+merb_seed is a port of seed-fu to Merb
+
+http://github.com/mbleigh/seed-fu

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "merb_seed"
+GEM_VERSION = "0.1.0"
+AUTHOR = "Jacques Crocker"
+EMAIL = "merbjedi@gmil.com"
+HOMEPAGE = "http://merbjedi.com/"
+SUMMARY = "Merb plugin that provides RAKE tasks to easily initialize seed data in your database"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+
+  # todo: allow merb_seed to support activerecord and sequel
+  s.add_dependency('merb_datamapper', '>= 1.0.8')
+
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile) + Dir.glob("{lib,spec}/**/*")
+  
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the plugin as a gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/lib/merb_seed.rb

@@ -0,0 +1,19 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+
+  # Merb gives you a Merb::Plugins.config hash...feel free to put your stuff in your piece of it
+  Merb::Plugins.config[:merb_seed] = {
+    :seed_path => "schema/data"
+  }
+  
+  Merb::BootLoader.before_app_loads do
+    # require code that must be loaded before the application
+  end
+  
+  Merb::BootLoader.after_app_loads do
+    # code that can be required after the application loads
+  end
+  
+  Merb::Plugins.add_rakefiles "merb_seed/merbtasks"
+end
+

data/lib/merb_seed/merbtasks.rb

@@ -0,0 +1,24 @@
+namespace :db do
+  desc "Loads seed data from schema/data for the current environment."
+  task :seed => :merb_env do
+    require File.join( File.dirname(__FILE__), "seeder")
+    
+    # load ruby seed files
+    seed_path = ENV["SEED_PATH"] ? ENV["SEED_PATH"] : (Merb::Plugins.config[:merb_seed][:seed_path] || "schema/data")
+    Dir[File.join(Merb.root, seed_path, '*.rb')].sort.each { |seed| 
+      puts "\n== Seeding from #{File.split(seed).last} " + ("=" * (60 - (17 + File.split(seed).last.length)))
+      load seed 
+      puts "=" * 60 + "\n"
+    }
+    
+    # load environment specific seed files
+    Dir[File.join(Merb.root, seed_path, Merb.env, '*.rb')].sort.each { |seed| 
+      puts "\n== [#{Merb.env}] Seeding from #{File.split(seed).last} " + ("=" * (60 - (20 + File.split(seed).last.length + Merb.env.length)))
+      load seed 
+      puts "=" * 60 + "\n"
+    }
+    
+    # load seed files from yml
+    # TODO
+  end
+end

data/lib/merb_seed/orm/ar_ext.rb

@@ -0,0 +1 @@
+# TODO

data/lib/merb_seed/orm/dm_ext.rb

@@ -0,0 +1,27 @@
+require 'datamapper'
+
+module DataMapper::Model
+  # Creates a single record of seed data for use
+  # with the db:seed rake task. 
+  # 
+  # === Parameters
+  # constraints :: Immutable reference attributes. Defaults to :id
+  def seed(*constraints, &block)
+    MerbSeed::Seeder.plant(self, *constraints, &block)
+  end
+
+  def 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
+  
+  def column_names
+    properties.map{|i| i.field }
+  end
+end

data/lib/merb_seed/orm/sequel_ext.rb

@@ -0,0 +1 @@
+# TODO

data/lib/merb_seed/seeder.rb

@@ -0,0 +1,87 @@
+require File.join( File.dirname(__FILE__), "orm", "dm_ext")
+
+module MerbSeed
+  class Seeder
+    def self.plant(model_class, *constraints, &block)
+      constraints = [:id] if constraints.empty?
+      seed = Seeder.new(model_class)
+
+      options = constraints.last if (constraints.last.is_a? Hash)
+      constraints.delete_at(*constraints.length-1) if (constraints.last.is_a? Hash)
+
+      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 => insert_only}.merge(options||{}))
+    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 after_seed(&block)
+      if block
+        @after_seed_block = block
+      else
+        @after_seed_block
+      end
+    end
+
+    def plant!(options)
+      insert_only = options[:insert_only].nil? ? false : options[:insert_only]
+
+      record = get
+      return if !record.new_record? and insert_only
+      @data.each do |k, v|
+        record.send("#{k}=", v)
+      end
+      record.save || raise("Validation Failed. Use :validate => false in order to skip this:\n#{record.errors.inspect}")
+      puts " - #{@model_class} #{condition_hash.inspect}"      
+      
+      # fire off after_seed event
+      self.after_seed.call(record) if self.after_seed
+      
+      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.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

data/spec/fixtures/dm_models.rb

@@ -0,0 +1,17 @@
+require 'datamapper'
+
+# setup repository
+DataMapper.setup(:default, "sqlite3::memory:")
+
+# setup models
+class User
+  include DataMapper::Resource
+
+  property :id,         Serial
+  property :login,      String
+  property :first_name, String
+  property :last_name,  String
+  property :title,      String
+end
+
+User.auto_migrate!

data/spec/merb_seed_spec.rb

@@ -0,0 +1,63 @@
+require File.join( File.dirname(__FILE__), "spec_helper")
+
+describe "merb_seed" do
+  
+  describe "datamapper support" do  
+    before(:each) do
+      load File.join( File.dirname(__FILE__), "fixtures", "dm_models.rb")
+    end
+
+    it "should create a model if one doesn't exist" do
+      User.seed(:id) do |s|
+        s.id = 1
+        s.login = "bob"
+        s.first_name = "Bob"
+        s.last_name = "Bobson"
+        s.title = "Peon"
+      end
+
+      bob = User.get(1)
+      bob.first_name.should == "Bob"
+      bob.last_name.should == "Bobson"
+    end
+
+    it "should be able to handle multiple constraints" do
+      User.seed(:title, :login) do |s|
+        s.login = "bob"
+        s.title = "Peon"
+        s.first_name = "Bob"
+      end
+
+      User.count.should == 1
+
+      User.seed(:title, :login) do |s|
+        s.login = "frank"
+        s.title = "Peon"
+        s.first_name = "Frank"
+      end
+
+      User.count.should == 2
+
+      User.first(:first_name => "Bob").first_name.should == "Bob"
+      User.seed(:title, :login) do |s|
+        s.login = "bob"
+        s.title = "Peon"
+        s.first_name = "Steve"
+      end
+      User.first(:first_name => "Steve").first_name.should == "Steve"
+    end
+
+    it "should be able to create models from an array of seed attributes" do
+      User.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"}
+      ])
+
+      User.first(:login => "bob").first_name.should == "Steve"
+      User.first(:login => "frank").first_name.should == "Francis"
+      User.first(:login => "harry").first_name.should == "Harry"
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+require 'spec'
+
+require 'merb_seed/seeder'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: merb_seed
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jacques Crocker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-15 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb_datamapper
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.8
+    version: 
+description: Merb plugin that provides RAKE tasks to easily initialize seed data in your database
+email: merbjedi@gmil.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- LICENSE
+- README
+- Rakefile
+- lib/merb_seed
+- lib/merb_seed/merbtasks.rb
+- lib/merb_seed/orm
+- lib/merb_seed/orm/ar_ext.rb
+- lib/merb_seed/orm/dm_ext.rb
+- lib/merb_seed/orm/sequel_ext.rb
+- lib/merb_seed/seeder.rb
+- lib/merb_seed.rb
+- spec/fixtures
+- spec/fixtures/dm_models.rb
+- spec/merb_seed_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://merbjedi.com/
+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: merb
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Merb plugin that provides RAKE tasks to easily initialize seed data in your database
+test_files: []
+