ambitious_seeder 0.0.1 → 0.1.0

data/README.md

@@ -0,0 +1,63 @@
+# AmbitiousSeeder
+
+Very, very alpha version of gem to add seeds to rails app. At the moment this is very much something I can use - which I may make a bit more production friendly in the future.
+
+## Installation
+
+This gem only works with Rails 3. To install, add it to your gemfile:
+
+    gem 'ambitious_seeder'
+
+## Seeding
+    
+To generate a seed:
+
+    rails generate seed [seed_name]
+    
+Say your seed_name was 'rooms', this will create a seed at:
+
+    [app-root]/db/seeds/rooms_seeds.rb
+
+You can add any logic to this file that would work elsewhere in your rails app.
+
+To run, go with:
+
+    rake db:seed:up
+    
+Once run, this seed cannot be run again - you'll need to reverse it and then run it another time :)
+
+To reverse, try:
+
+    rake db:seed:down SEED=[seed_name]
+    
+To get a list of all available seeds:
+
+    rake db:seed:list
+
+## Upcoming features
+
+Stuff I guess I'll need, and notes:
+
+* Provision in generator to stop duplicated seeds 
+* Probably need the ability to depend on a certain version of the schema - this can be added when the seed is created?
+* Transactions?
+* Why isn't query logging going to the normal rails logs?
+* Add better information logging to STDOUT
+
+# 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 Sam Phillips. See LICENSE for details.
+
+## AmbitionIsGood (tm)
+
+Well... it is!

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/ambitious_seeder.gemspec

@@ -5,25 +5,29 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ambitious_seeder}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sam Phillips"]
-  s.date = %q{2011-02-20}
+  s.date = %q{2011-03-06}
   s.description = %q{Create seeds for rails apps and load them in. Make it easier to manage data between your different environments.}
   s.email = %q{sam@samdanavia.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.md"
   ]
   s.files = [
     ".document",
      "LICENSE",
-     "README.rdoc",
+     "README.md",
      "Rakefile",
      "VERSION",
      "ambitious_seeder.gemspec",
      "lib/ambitious_seeder.rb",
+     "lib/generators/rails/seed/seed_generator.rb",
+     "lib/generators/rails/seed/templates/template_seed.rb",
+     "lib/tasks/ambitious_seeder.rake",
+     "lib/tasks/support/rake_task_helpers.rb",
      "test/helper.rb",
      "test/test_ambitious_seeder.rb"
   ]

data/lib/ambitious_seeder.rb

@@ -0,0 +1,108 @@
+module AmbitiousSeeder
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/ambitious_seeder.rake'
+    end
+  end
+
+  class NoSeedUpError < Exception
+  end
+
+  class NoSeedDownError < Exception
+  end
+  
+  module Seeder
+    def self.up(seeds)
+      self.initialize_schema_seeds_table
+            
+      if seeds.kind_of?(Array)
+        seeds.each { |seed| self.up(seed) }
+        return
+      end
+
+      seed = seeds
+
+      return if seed_already_up?(seed)
+
+      begin
+        seed.send(:up)
+      rescue AmbitiousSeeder::NoSeedUpError
+        abort "No upwards method for #{seed}!"
+      end
+
+      record_seed(seed)
+    end
+    
+    def self.down(seed)
+      self.initialize_schema_seeds_table
+
+      return unless seed_already_up?(seed)
+
+      begin
+        seed.send(:down)
+      rescue AmbitiousSeeder::NoSeedDownError
+        abort "No downwards method for #{seed}!"
+      end
+
+      expunge_seed(seed)
+    end
+    
+    private
+    def self.db
+      @db ||= setup_db
+    end
+    
+    def self.setup_db
+      ActiveRecord::Base.configurations = Rails.application.config.database_configuration
+      ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations[Rails.env])
+      ActiveRecord::Base.connection      
+    end
+    
+    def self.seeds_table_name
+      'schema_seeds'      
+    end
+    
+    def self.seeds_table
+      Arel::Table.new(seeds_table_name)
+    end
+    
+    def self.initialize_schema_seeds_table
+      seeds_table = seeds_table_name
+      unless db.table_exists?(seeds_table)
+        db.create_table(seeds_table, :id => false) do |table|
+          table.column :seed, :string, :null => false
+        end
+      end
+    end
+    
+    def self.seed_already_up?(seed)
+      self.completed_seeds.include? seed.seed_name
+    end
+
+    def self.record_seed(seed)
+      seeds_table.insert seeds_table["seed"] => seed.seed_name
+    end
+    
+    def self.expunge_seed(seed)
+      seeds_table.where(seeds_table["seed"].eq(seed.seed_name)).delete
+    end
+    
+    def self.completed_seeds
+      db.select_values(seeds_table.project(seeds_table['seed']).to_sql)
+    end   
+  end
+  
+  class Seed
+    def self.seed_name
+      self.to_s.gsub(/seed$/i, '').underscore
+    end
+    
+    def self.up
+      raise AmbitiousSeeder::NoSeedUpError
+    end
+    
+    def self.down
+      raise AmbitiousSeeder::NoSeedDownError
+    end    
+  end  
+end

data/lib/generators/rails/seed/seed_generator.rb

@@ -0,0 +1,20 @@
+module Rails
+  module Generators
+    class SeedGenerator < Rails::Generators::NamedBase
+      desc <<DESC
+Description:
+  Create a seed file
+
+DESC
+
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+
+      def create_seed
+        empty_directory 'db/seeds'
+        template "template_seed.rb", "db/seeds/#{file_name}.rb"
+      end
+    end 
+  end
+end

data/lib/generators/rails/seed/templates/template_seed.rb

@@ -0,0 +1,14 @@
+class <%= file_name.camelize %>Seed < AmbitiousSeeder::Seed
+  def self.up
+    # Interact with classes as normal here, eg:
+    # Product.create(:sku => '1234')
+  end
+  
+  def self.down
+    # If possible, reverse the migration.
+    # Product.delete(Product.where(:sku => '1234'))
+    
+    # You may also want to consider any associations, and whether they should deleted automatically, or manually in this method.
+    # If it's not possible (or not a good idea) to reverse this migration, remove the method :)
+  end
+end

data/lib/tasks/ambitious_seeder.rake

@@ -0,0 +1,35 @@
+load 'tasks/support/rake_task_helpers.rb'
+
+namespace :db do
+  include RakeTaskHelpers
+  
+  namespace :seed do
+    desc "List all available seeds"
+    task :list do
+      puts seeds.inspect
+    end
+    
+    desc "Up all seeds, or a seed specified in the SEED environment variable"
+    task :up => :environment do
+      if ENV["SEED"]
+        seed_name = ENV["SEED"]
+        verify_seed(seed_name)      
+
+        seed_klass = seeds[seed_name]        
+        AmbitiousSeeder::Seeder.up(seed_klass)
+      else      
+        AmbitiousSeeder::Seeder.up(seeds.values)
+      end
+    end
+
+    desc "Down the seed specific in the SEED environment variable"
+    task :down => :environment do
+      seed = ENV["SEED"]
+      abort "Specify the seed to down: 'rake db:seed:down SEED=seed_name'" unless seed
+      verify_seed(seed)
+
+      seed_klass = seeds[seed]      
+      AmbitiousSeeder::Seeder.down(seed_klass)
+    end
+  end
+end

data/lib/tasks/support/rake_task_helpers.rb

@@ -0,0 +1,24 @@
+module RakeTaskHelpers  
+  def seeds
+    @seeds ||= get_seeds
+  end
+  
+  def get_seeds
+    Dir[File.join(Rails.root, 'db','seeds', '*')].reduce({}) do |seeds, seed|
+      load(seed)
+        
+      seed_klass = seed_klass_from_path(seed)
+      seeds[seed_klass.seed_name] = seed_klass
+      seeds
+    end
+  end
+  
+  def verify_seed(seed)
+    abort "Unknown seed #{seed}" unless seeds[seed]
+  end
+  
+  def seed_klass_from_path(path)
+    puts path
+    (path.split("/").last.gsub(/\.rb/,'') + 'Seed').classify.constantize    
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Sam Phillips
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-20 00:00:00 +00:00
+date: 2011-03-06 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -26,15 +26,19 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - ambitious_seeder.gemspec
 - lib/ambitious_seeder.rb
+- lib/generators/rails/seed/seed_generator.rb
+- lib/generators/rails/seed/templates/template_seed.rb
+- lib/tasks/ambitious_seeder.rake
+- lib/tasks/support/rake_task_helpers.rb
 - test/helper.rb
 - test/test_ambitious_seeder.rb
 has_rdoc: true

data/README.rdoc

@@ -1,17 +0,0 @@
-= ambitious_seeder
-
-Description goes here.
-
-== 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 Sam Phillips. See LICENSE for details.