seedlings 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.2@seedlings_gem

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in seedlings.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Matthew Wilson
+
+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.md

@@ -0,0 +1,71 @@
+# Seedlings
+
+A little project to make seeding data easier to deal with across multiple ORMs.
+
+**N.B.** This is early-release code that writes data to your database. While it is extracted from a live app, there may be cases where it blows up still :). Please test first. I don't want to hear about lost production data because you didn't try it in development first :).
+
+## Usage
+
+    gem "seedlings"
+
+Install the gem.
+
+There are two methods of note: `.plant` and `.plant_and_return`. They take 3 parameters:
+
+* the Class to use (must support `ActiveModel`ish interface, like MongoMapper, Mongoid, ActiveRecord)
+* options you want Seedlings to respect, of which there are two:
+  * `:constrain` which takes a column name or array of column names that will be used to find the records, and
+  * `:dont_update_existing`, which, if set to true, will cause Seedlings to skip updating existing records.
+* the third parameter is that data you want seeded. `.plant` takes however many attribute hashes you give it. `.plant_and_return` takes only a single hash, but returns the resulting object.
+
+Here's some examples:
+
+```ruby
+Seedlings.plant(Widget, { :constrain => :name }, 
+  # your seed data goes here, as a bunch of hashes.
+  # Make sure you include values for any constraint columns you've specified!
+  { :name => "Gizwidget", :context => "science!" },
+  { :name => "Somoflange", :context => "80s cartoons" },
+  # ...
+)
+```
+
+If some of your seed data depends on other records, switch up to `Seedlings.plant_and_return`, which only takes one attribute hash but returns the object so you can use it in other hashes later, e.g.
+
+```ruby
+parent_thing = Seedlings.plant_and_return(Thing, {}, { :name => "I'm a Parent!" })
+
+Seedlings.plant(ChildThing, {}, 
+  { :name => "Child Bit", :context => "docco", :parent => parent_thing },
+  # ...
+)
+```
+
+### Rails? Rails.
+
+"Integration" with rails is as simple as sticking the gem in your `Gemfile` and calling `Seedlings.plant(...)` in `db/seeds.rb`. Then you use rake per normal: `rake db:seed`. Yep.
+
+## Of Note
+
+This is early code, ripped out from an upcoming project. It probably has some rough edges.
+
+TODO:
+
+* more and better integration tests
+* a logging system that isn't `puts`-based :)
+* rake tasks
+* more options, etc, as desired
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Matt Wilson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/seedlings/version.rb

@@ -0,0 +1,3 @@
+class Seedlings
+  VERSION = "0.0.1"
+end

data/lib/seedlings.rb

@@ -0,0 +1,91 @@
+require "seedlings/version"
+
+# Seedlings.rb
+#
+# A Seeding system that handles all the annoying corner-cases for you.
+class Seedlings
+  attr_accessor :klass, :options, :data
+  
+  def self.plant klass, options, *data
+    thang = new(klass, options, data)
+    thang.plant!
+  end
+  
+  def self.plant_and_return klass, options, data
+    seedling = new(klass, options, [data])
+    seedling.plant_and_return data
+  end
+  
+  def initialize klass, options, data
+    self.klass = klass
+    self.options = options
+    self.data = data
+    adapt!
+  end
+  
+  #
+  # determine what manner of class we've been asked to seed and load the appropriate adapter.
+  # Yes, I know it only does one thing now.
+  # N.B. I'm open to more efficient suggestions here.
+  def adapt!
+    extend Seedlings::ActiveModel
+  end
+  
+  #
+  # Get this planting party started
+  def plant!
+    data.each do |the_data|
+      find_and_update_model_with the_data unless the_data.nil?
+    end
+  end
+  
+  def plant_and_return the_data
+    find_and_update_model_with the_data unless the_data.nil?
+  end
+
+  #
+  # The base plugin for Seedlings: ActiveModel.
+  # Use this if the class to be seeded has an AREL-like query interface
+  module ActiveModel
+    
+    def constraints_for the_data
+      constraints = []
+      constraint_columns = options[:constrain] ? [options[:constrain]].flatten : [:id]
+      unless the_data.keys & constraint_columns == constraint_columns
+        puts "Couldn't find necessary constraints #{constraint_columns.inspect} in #{the_data.inspect}, skipping"
+        return constraints
+      end
+      constraint_columns.each do |key|
+        constraints << { key => the_data[key] } if the_data[key]
+      end
+      constraints
+    end
+    
+    def find_model_with the_data
+      finder = constraints_for(the_data).inject(klass) { |k, constraint| k.where(constraint) }
+      finder.first
+    end
+    
+    def find_and_update_model_with the_data
+      object = find_model_with the_data
+      if object
+        puts "FOUND: #{object.inspect}"
+        if options[:dont_update_existing]
+          puts "  * skipping update as per options[:dont_update_existing]"
+        else
+          puts "  * updating with #{the_data}"
+          object.update_attributes(the_data)
+        end
+      else
+        puts "NEW OBJECT: #{klass}.new(#{the_data.inspect})"
+        object = klass.new(the_data)
+        object.save!
+      end
+      puts
+      object
+    end
+    
+  end
+  
+end
+

data/seedlings.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "seedlings/version"
+
+Gem::Specification.new do |s|
+  s.name        = "seedlings"
+  s.version     = Seedlings::VERSION
+  s.authors     = ["Matt Wilson"]
+  s.email       = ["mhw@hypomodern.com"]
+  s.homepage    = ""
+  s.summary     = "Simple seed data management"
+  s.description = "An ActiveModel (MongoMapper/Mongoid/ActiveRecord 3+) compliant seed data handler for any ruby project."
+
+  s.rubyforge_project = "seedlings"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("mongo_mapper")
+  s.add_development_dependency("mongoid")
+  s.add_development_dependency("bson_ext")
+  s.add_development_dependency("activerecord")
+  s.add_development_dependency("sqlite3")
+end

data/spec/README.md

@@ -0,0 +1,5 @@
+## Running Specs
+
+By default, we run the specs with mongomapper. To run them with mongoid or sqlite, use: `DB=mongoid rspec spec`. Make sure you have the requisite table set up for the SQL-based test.
+
+Taking our cues from seed-fu, I've placed the connection and model setup stuff out in `spec/connections/*`.

data/spec/connections/mongoid.rb

@@ -0,0 +1,20 @@
+require 'mongoid'
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db("seedlings_gem_test")
+end
+
+INVALID_DOCUMENT_ERROR = Mongoid::Errors::Validations
+
+class Widget
+  include Mongoid::Document
+  
+  CONTEXTS = %w(hero columns)
+
+  field :name, type: String
+  field :context, type: String
+    
+  validates :name, :presence => true, :uniqueness => true
+  validates :context, :inclusion => CONTEXTS
+
+end

data/spec/connections/mongomapper.rb

@@ -0,0 +1,20 @@
+require 'mongo_mapper'
+
+MongoMapper.connection = Mongo::Connection.new(ENV["MONGO_HOST"] || 'localhost')
+MongoMapper.database = "seedlings_gem_test"
+
+INVALID_DOCUMENT_ERROR = MongoMapper::DocumentNotValid
+
+class Widget
+  include MongoMapper::Document
+  
+  CONTEXTS = %w(hero columns)
+
+  key :name, String
+  key :context, String
+    
+  validates :name, :presence => true, :uniqueness => true
+  validates :context, :inclusion => CONTEXTS
+
+end
+

data/spec/connections/sqlite.rb

@@ -0,0 +1,24 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => File.dirname(__FILE__) + "/test.sqlite3"
+)
+
+INVALID_DOCUMENT_ERROR = ActiveRecord::RecordInvalid
+
+ActiveRecord::Schema.define :version => 0 do
+  create_table :widgets, :force => true do |t|
+    t.column :name, :string
+    t.column :context, :string
+  end
+end
+
+class Widget < ActiveRecord::Base
+
+  CONTEXTS = %w(hero columns)
+
+  validates :name, :presence => true, :uniqueness => true
+  validates :context, :inclusion => CONTEXTS
+
+end

data/spec/lib/seedlings_spec.rb

@@ -0,0 +1,154 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Seedlings do
+  let(:seeds) { Seedlings.new(Widget, { :constrain => :name }, []) }
+  
+  describe ".plant" do
+    it "accepts the class to be seeded, options, and the seed data itself" do
+      lambda {
+        Seedlings.plant(Widget, { :constrain => :name })
+      }.should_not raise_error
+    end
+    it "runs the seeding operation" do
+      Widget.all.should == []
+      Seedlings.plant(Widget, { :constrain => :name },
+        { :name => "Basic text elements", :context => "hero" },
+        { :name => "Social media", :context => "hero" },
+        { :name => "Networks", :context => "hero" }
+      )
+      Widget.all.map { |wg| wg.name }.sort.should == ["Basic text elements", "Networks", "Social media"]
+    end
+  end
+  
+  describe ".plant_and_return" do
+    let(:the_attrs) { { :name => "Basic text elements", :context => "hero" } }
+    
+    it "seeds and returns an object" do
+      obj = Seedlings.plant_and_return(Widget, { :constrain => :name }, the_attrs)
+      obj.should_not be_nil
+      obj.name.should == the_attrs[:name]
+      obj.context.should == the_attrs[:context]
+    end
+    it "doesn't create duplicates" do
+      alt = Widget.create(the_attrs)
+      neu = Seedlings.plant_and_return(Widget, { :constrain => :name }, the_attrs)
+      
+      neu.id.should == alt.id
+      Widget.all.map { |wg| wg.id }.should == [alt.id]
+    end
+  end
+  
+  describe "#initialize" do
+    it "stashes the class, options, and data as attributes" do
+      seeds.klass.should == Widget
+      seeds.options.should == { :constrain => :name }
+      seeds.data.should == []
+    end
+  end
+  
+  describe "#adapt!" do
+    it "extends the object with an appropriate adapter" do
+      seeds.should_receive(:extend).with(Seedlings::ActiveModel)
+      seeds.send(:adapt!)
+    end
+    describe "an adapter" do
+      it "implements #find_model_with" do
+        seeds.should respond_to(:find_model_with)
+      end
+      it "implements #find_and_update_model_with" do
+        seeds.should respond_to(:find_and_update_model_with)
+      end
+      it "implements #constraints_for" do
+        seeds.should respond_to(:constraints_for)
+      end
+    end
+  end
+  
+  describe "#plant!" do
+    it "plants a bunch of seedlings" do
+      Widget.all.should == []
+      seeds = Seedlings.new(Widget, { :constrain => :name }, [
+        { :name => "Basic text elements", :context => "hero" },
+        { :name => "Social media", :context => "hero" },
+        { :name => "Networks", :context => "hero" }
+      ])
+      seeds.plant!
+      Widget.all.map { |wg| wg.name }.sort.should == ["Basic text elements", "Networks", "Social media"]
+    end
+  end
+  
+end
+
+describe Seedlings::ActiveModel do
+  let(:seeds) { Seedlings.new(Widget, { :constrain => :name }, []) }
+  
+  describe "#constraints_for" do
+    # hey, it could happen
+    context "with no specified constraints" do
+      before do
+        seeds.options[:constrain] = nil
+      end
+      it "returns an empty array if given no data" do
+        seeds.constraints_for({}).should == []
+      end
+      it "returns only one constraint: { :id => data[:id] } if given that data" do
+        seeds.constraints_for({:id => 1}).should == [{ :id => 1 }]
+      end
+    end
+    context "with one constraint specified" do
+      it "returns an empty array if the data doesn't include the necessary constraint column" do
+        seeds.constraints_for({:bob => "baz"}).should == []
+      end
+      it "returns an array with the correct constraint otherwise" do
+        seeds.constraints_for({:name => "bar"}).should == [{:name => "bar"}]
+      end
+    end
+    context "with more than one constraint" do
+      before do
+        seeds.options[:constrain] = [:name, :id]
+      end
+      it "returns an empty array if it cannot locate sufficient data" do
+        seeds.constraints_for({:foo => "bar"}).should == []
+      end
+      it "returns correctly formatted constraints otherwise" do
+        seeds.constraints_for({:name => "bar", :id => 7}).should == [{:name=>"bar"}, {:id=>7}]
+      end
+    end
+  end
+  
+  describe "#find_and_update_model_with" do
+    let(:the_attrs) { { :name => "Basic text elements", :context => "hero" } }
+    let(:seedlings) { Seedlings.new(Widget, { :constrain => :name }, [] ) }
+
+    context "when the seedling already exists" do
+      before do
+        @alt = Widget.create(the_attrs.merge(:context => "columns"))
+      end
+      it "updates the attributes of the object to match the seed data by default" do
+        @alt.context.should == "columns"
+        seedlings.find_and_update_model_with the_attrs
+        Widget.where(name: "Basic text elements").first.context.should == "hero"
+      end
+      it "skips the update if you've given it the :dont_update_existing option" do
+        seeds = Seedlings.new(Widget, { :constrain => :name, :dont_update_existing => true }, the_attrs )
+        seeds.find_and_update_model_with the_attrs
+        Widget.where(name: "Basic text elements").first.context.should == "columns"
+      end
+    end
+    context "when the seedling doesn't exist" do
+      it "creates a new record" do
+        Widget.all.should == []
+        obj = seedlings.find_and_update_model_with( the_attrs )
+        obj.should be_valid
+        Widget.all.map { |wg| wg.id }.should == [obj.id]
+      end
+      it "blows up, halting everything, on error" do
+        lambda {
+          seedlings.find_and_update_model_with( the_attrs.merge(:context => "INVALID VALUE AHOY") )
+        }.should raise_error(INVALID_DOCUMENT_ERROR)
+      end
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'bundler'
+begin
+  Bundler.setup
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rspec'
+require 'seedlings'
+
+our_db = ENV["DB"] || 'mongomapper'
+puts "Running tests with #{our_db}."
+require File.dirname(__FILE__) + "/connections/#{our_db}.rb"
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  # clean the database before each test. Might need to switch up to DatabaseCleaner.
+  config.before do
+    Widget.delete_all
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: seedlings
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: An ActiveModel (MongoMapper/Mongoid/ActiveRecord 3+) compliant seed data handler for any ruby project.
+email: 
+- mhw@hypomodern.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/seedlings.rb
+- lib/seedlings/version.rb
+- seedlings.gemspec
+- spec/README.md
+- spec/connections/mongoid.rb
+- spec/connections/mongomapper.rb
+- spec/connections/sqlite.rb
+- spec/connections/test.sqlite3
+- spec/lib/seedlings_spec.rb
+- spec/spec_helper.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: seedlings
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Simple seed data management
+test_files: 
+- spec/README.md
+- spec/connections/mongoid.rb
+- spec/connections/mongomapper.rb
+- spec/connections/sqlite.rb
+- spec/connections/test.sqlite3
+- spec/lib/seedlings_spec.rb
+- spec/spec_helper.rb