plus2_seeder 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ben Askins
+
+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.md

@@ -0,0 +1,29 @@
+# Plus2Seeder
+
+Seed database with data
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'plus2_seeder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install plus2_seeder
+
+## Usage
+
+rake seed
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/plus2_seeder.rb

@@ -0,0 +1,4 @@
+require "plus2_seeder/version"
+require "plus2_seeder/seeder/base"
+require "plus2_seeder/seeder/spreadsheet"
+require "plus2_seeder/conductor"

data/lib/plus2_seeder/conductor.rb

@@ -0,0 +1,63 @@
+module Plus2Seeder
+  class Conductor
+    # Require all of the seeders
+    Dir[File.expand_path('lib/seeder/seeders/*.rb')].each { |file| require file }
+
+    @recorded = []
+
+
+    def self.seeders=(val)
+      @seeders = val
+    end
+
+    def self.seeders
+      @seeders
+    end
+
+    def self.all_seeders
+      @seeders.values.flatten.uniq
+    end
+
+
+    def self.record(seeder_name)
+      @recorded << seeder_name
+    end
+
+
+    # Runs a named seeder
+    def self.run(seeder_name)
+      return if @recorded.include? seeder_name
+
+      klass = "#{seeder_name}_seeder".classify.constantize
+      seeder = klass.new
+
+      seeder.run_dependencies
+
+      seeder.reset if reset? # Call the seeder's reset method if called with RESET=true
+
+      seeder.before
+
+      puts "Seeding #{seeder_name.pluralize}"
+      seeder.seed
+
+      record seeder_name
+
+      seeder.after
+    end
+
+
+    # Will run all seeders
+    def seed
+      self.class.seeders[Rails.env].each do |seeder|
+        self.class.run(seeder)
+      end
+    end
+
+
+    def self.reset?
+      @reset ||= (ENV['RESET'] == 'true')
+    end
+
+  end
+end
+

data/lib/plus2_seeder/seeder/base.rb

@@ -0,0 +1,62 @@
+module Plus2Seeder
+
+  module Seeder
+
+    class Base
+
+      # These seeders will be run before the subclass's seeder
+      def self.dependencies(dependency_list=nil)
+        @dependencies ||= dependency_list
+      end
+
+
+      def run(seeder_name)
+        Plus2Seeder.run(seeder_name)
+      end
+
+
+      def run_dependencies
+        if self.class.dependencies.try(:any?)
+          self.class.dependencies.each do |seeder_name|
+            run(seeder_name)
+          end
+        end
+      end
+
+
+      # Determines the model class to use based on the name of the seeder
+      def creator_class
+        @creator_class ||= self.class.name.gsub('Seeder', '').constantize
+      end
+
+
+      def reset
+        puts "Clearing #{creator_class.table_name}"
+        creator_class.delete_all
+      end
+
+
+      def before
+        #override if you want to do something before seeding
+      end
+
+
+      def after
+        #override if you want to do something after seeding
+      end
+
+
+      def debug?
+        @debug ||= (ENV['DEBUG'] == 'true')
+      end
+
+
+      def debug(val)
+        ap val if debug?
+      end
+
+    end
+
+  end
+
+end

data/lib/plus2_seeder/seeder/spreadsheet.rb

@@ -0,0 +1,103 @@
+# Superclass to be used for seeders that import data from a spreadsheet.
+# The subclass needs to specify the source file, sheet, and column names.
+# The subclass can optionally implement a pre_process and can_import? method. 
+#
+# e.g.
+#
+#   class PersonSeeder < SpreadsheetSeeder
+#     source 'people.xls' 
+#     sheet  'People'
+#     columns %w(name email phone)
+#   end
+#
+#   PersonSeeder.new.seed
+#
+#   Will create instances of Person from the data in the People sheet of db/seeds/people.xls.
+module Plus2Seeder
+  module Seeder
+
+    class Spreadsheet < Base
+
+      # Used to specify the spreadsheet to import. Assumed to be in db/seeds
+      def self.source(*filenames)
+        @filenames ||= filenames
+      end
+
+
+      # The sheet name to import from
+      def self.sheet(sheetname=nil)
+        @sheetname ||= sheetname
+      end
+
+
+      # The names of the columns - use the active record attribute names.
+      # These will be zipped up with the row values by row_to_hash to create an attributes hash that
+      # can be used to create a new ActiveRecord instance.
+      #
+      # To skip a column use '_', it will be deleted from the resulting hash
+      def self.columns(columns=nil)
+        @columns ||= columns
+      end
+
+
+      # Skip (n) rows before starting to import
+      def self.skip_rows(rows=nil)
+        @skip_rows ||= rows || 0
+      end
+
+
+      # Opens the spreadsheet and calls import for each row
+      def seed
+        self.class.source.each do |source|
+          book = ::Spreadsheet.open "./db/seeds/#{source}"
+
+          sheet = book.worksheet self.class.sheet
+
+          sheet.each self.class.skip_rows do |row|
+            import(row_to_hash(row))
+          end
+        end
+      end
+
+
+      # Creates a hash from the row values and column names
+      def row_to_hash(row)
+        Hash[self.class.columns.zip(row)].tap do |h|
+          pre_process(h, row) if respond_to?(:pre_process)
+
+          # Delete skipped columns
+          h.delete('_')
+        end
+      end
+
+
+      # Imports the row
+      def import(row)
+        if can_import?(row)
+          if object = object_available_to_update(row)
+            debug("Updating #{object}")
+            object.update_attributes(row)
+          else
+            debug("Creating new #{creator_class.name}")
+            creator_class.create!(row)
+          end
+        end
+      end
+
+
+      # Determines whether or not the row can be imported. Override this in your subclass if desired
+      def can_import?(row)
+        true
+      end
+
+
+      # Override this in your subclass if you wish to update existing data from your seeder. It will need to return
+      # an instance of the AR object to be updated
+      def object_available_to_update(row)
+        nil
+      end
+
+    end
+
+  end
+end

data/lib/plus2_seeder/version.rb

@@ -0,0 +1,3 @@
+module Plus2Seeder
+  VERSION = "0.0.1"
+end

data/plus2_seeder.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/plus2_seeder/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ben Askins"]
+  gem.email         = ["ben.askins@gmail.com"]
+  gem.description   = %q{database seeder}
+  gem.summary       = %q{database seeder}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "plus2_seeder"
+  gem.require_paths = ["lib"]
+  gem.version       = Plus2Seeder::VERSION
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: plus2_seeder
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben Askins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-24 00:00:00 Z
+dependencies: []
+
+description: database seeder
+email: 
+- ben.askins@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/plus2_seeder.rb
+- lib/plus2_seeder/conductor.rb
+- lib/plus2_seeder/seeder/base.rb
+- lib/plus2_seeder/seeder/spreadsheet.rb
+- lib/plus2_seeder/version.rb
+- plus2_seeder.gemspec
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: database seeder
+test_files: []
+