Initial commit.

Author: fosrias

MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mark W. Foster, fosterinfo[z]gmail.com (replace [z] with @)
+
+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.

README

@@ -0,0 +1,71 @@
+seeded-generation plugin by Mark W. Foster
+==========================================
+
+This plugin extends any model and scaffold generators to stub individual seeds
+files that correspond to a model and its module directory structure. It also
+overrides rake db:seed so that models can be individually seeded 
+using rake db:seed with the model name as an option. The plugin also includes 
+a generator that just stubs seeds files for existing models.
+
+The db/seeds.rb file is updated when models are generated to require the individual
+model seeds files so that rake db:seed executes all the required seed files. Extended
+model and scaffold generators include an option --skip-seeds that blocks stubbing
+a seeds file for the model and an option --seeds-only that only stubs a 
+seeds file for the model.
+
+Two default seeded generators are built as part of the install: 
+
+seeded_model and seeded_scaffold.
+
+Type script/generate seeded, script/generate seeds_for, script/seeded_model or
+script/seeded_scaffold for more usage information.
+
+Uninstalling the plugin leaves any extended generators and the db:seed
+override working. To clear all plugin functionality, refer to the 
+notes in the ../lib/seeded_generation folder after uninstalling the plugin.
+
+The plugin also installs functionality from the plugin OverrideRakeTask 
+by Eugene Bolshakov found at: git://github.com/eugene bolshakov/override_rake_task.git
+
+and an updated version of ActiveRecord::Base.create_or_update by Michael Bleigh 
+
+http://www.intridea.com/2008/2/19/activerecord-base-create_or_update-on-steroids-2?blog=company
+
+Example
+=======
+
+script/generate seeded my_model_generator
+
+creates a new seeded_my_model_generator generator that can then be used just like the 
+my_model_generator generator it is based on in the following fashion:
+
+script/generate seeded_my_model_generator MyModule::MyModel 
+
+creates generates all the standard model directories and stubs and includes
+the stub ../db/seeds/my_module/my_model_seeds.rb and adds 
+require 'my_module/my_model_seeds' to the db/seeds.rb file.
+
+script/generate seeded_my_model_generator MyModule::MyModel --skip-seeds 
+
+is just the base generator.
+
+script/generate seeded_my_model_generator MyModule::MyModel --only-seeds 
+
+only adds the file ../db/seeds/my_module/my_model_seeds.rb and adds 
+require 'my_module/my_model_seeds' to the db/seeds.rb file.
+
+This has the same functionality of the included generator seeds_for:
+
+script/generate seeds_for MyModule::MyModel
+
+which creates only a file db/seeds/my_module/my_model_seeds.rb and 
+adds a require statement to seeds.db.
+
+rake db:seed runs all seed files required in db/seeds.rb and 
+any other seed code there.
+
+rake db:seed MODELS=MyModule1::MyModel1, MyModule1::MyModel2 only loads seeds for the 
+specified models if they have corresponding seeds.rb files generated.
+
+Copyright (c) 2009 Mark W. Foster, released under the MIT license 
+fosterinfo[z]gmail.com (replace [z] with @)

Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the seeded_generator plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the seeded_generator plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SeededGenerator'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

generators/seeded/USAGE

@@ -0,0 +1,22 @@
+Description:
+    Extends an existing model or scaffold generator to stub out
+    an individual seeds file for its model and adds it as a 
+    required file in seeds.db. Pass the underscored generator 
+    name to be converted to a seeded generator.
+
+Examples:
+    `./script/generate seeded model`
+
+        creates a seeded_model generator.
+        
+    `./script/generate seeded scaffold`
+
+        creates a seeded_scaffold generator.
+
+    `./script/generate seeded my_model_generator`
+
+        creates a seeded_my_model_generator.
+        
+    `./script/generate seeded my_scaffold_generator`
+
+        creates a seeded_my_scaffold_generator.

generators/seeded/lib/seeded_helper.rb

@@ -0,0 +1,43 @@
+# SeededGenerator Commands
+require 'rails_generator/base'
+
+# Name methods
+Rails::Generator::NamedBase.class_eval do
+  
+  #The path to the original generator.
+  def original_generator_path
+    # Only calculate the original path once
+    unless @original_path
+      #Find the source of the original generator
+      begin
+        @original_path = Rails::Generator::Base.instance(file_name, ['no_options'], {}).spec.path
+      rescue
+         raise_missing_generator(file_name)
+      end
+    end
+    @original_path
+  end
+  
+  def template_path
+    File.join('lib/generators', "seeded_#{file_name}", 'templates')
+  end
+  
+  def generator_path
+    File.join('lib/generators', "seeded_#{file_name}")
+  end
+  
+  def original_template_path
+    File.join(original_generator_path, 'templates')
+  end
+  
+  private
+  def raise_missing_generator(class_name)
+    message = <<-end_message
+      The generator '#{file_name}' does not exist in your application and is not used by Ruby on Rails.
+      Please choose an alternative and run this generator again.
+    end_message
+              
+    raise UsageError, message
+  end
+end
+

generators/seeded/seeded_generator.rb

@@ -0,0 +1,58 @@
+# Generator that modifies existing generators to create individual
+# model seeds stubs.
+require File.join(File.dirname(__FILE__), 'lib/seeded_helper')
+class SeededGenerator < Rails::Generator::NamedBase
+
+  def manifest
+    # Check for seeded generator class naming collisions.
+    if class_name.include?('Seeded')
+      raise "The generator #{class_name.underscore} is already seeded."
+    end
+      
+    record do |m|    
+      # Create generator and template directories.
+      m.directory generator_path
+      m.directory template_path
+
+      # Create generator
+      m.template 'generator.rb', File.join(generator_path, "seeded_#{file_name}_generator.rb")
+      
+      # Copy seeded generator templates
+      m.file 'seeds.rb', File.join(template_path, 'seeds.rb')
+      
+      # Copy base generator templates
+      Dir.foreach(original_template_path) do |f|
+        m.file file_name + ':' + f, File.join(template_path, f), :collision => :skip unless File.directory?(f)
+      end
+      
+      # Copy the usage file
+      m.file file_name + ':' + '../USAGE', File.join(generator_path, 'USAGE'), :collision => :skip
+    
+      unless options[:command] == :destroy
+        # Update it if it is a scaffold USAGE statement
+        m.gsub_file File.join(generator_path,'USAGE'), "from model and migration" do 
+          "from model, migration and seeds"
+        end 
+        
+        # Update it if it is a model USAGE statement
+        m.gsub_file File.join(generator_path,'USAGE'), ", and a migration in\n    db/migrate." do 
+          ", a migration in\n    db/migrate, and a seed in db/seeds."
+        end
+        
+        m.gsub_file File.join(generator_path,'USAGE'), "creates an Account model, test, fixture, and migration:" do 
+          "creates an Account model, test, fixture, migration, and seeds:"
+        end
+        
+        m.gsub_file File.join(generator_path,'USAGE'), "Migration:  db/migrate/XXX_add_accounts.rb" do 
+          "Migration:  db/migrate/XXX_add_accounts.rb\n            Seeds:      db/seeds/account_seeds.rb"
+        end
+      end
+    end
+  end
+  
+  protected
+  def banner
+    "Usage: #{$0} seeded generator_name"
+  end
+
+end

generators/seeded/templates/generator.rb

@@ -0,0 +1,46 @@
+# Extends functionality in the <%=file_name%> generator to create model
+# seeds files and directories.
+
+class Seeded<%=class_name%>Generator < <%=class_name%>Generator
+  
+  default_options[:skip_seeds] = false
+  default_options[:seeds_only] = false
+   
+  alias base_add_options! add_options!
+  alias base_manifest manifest
+   
+  def manifest
+    if !options[:seeds_only]
+      m = base_manifest
+    else
+      m = record {}
+    end
+    unless options[:skip_seeds]
+      # Generate the seeds stub directory mirroring the model directory structure.
+      m.directory File.join('db/seeds', class_path)
+      
+      # Generate the seeds stub
+      m.template 'seeds.rb', File.join('db/seeds/', class_path, "#{file_name}_seeds.rb")
+    end
+  
+    # Register the seeds stub in seeds.rb at the end of the file
+    m.gsub_file('db/seeds.rb', File.read(File.join(RAILS_ROOT, 'db/seeds.rb'))) do |s|
+      s + "\nrequire '#{file_path}_seeds'"
+    end if options[:command] == :create && !options[:skip_seeds]
+    m.gsub_file('db/seeds.rb', /\nrequire '#{file_path}_seeds'/mi, '') if options[:command] == :destroy
+    m
+  end
+  
+  protected
+  def banner
+    "Usage: #{$0} seeded_<%=file_name%> ModelName [field:type, field:type]"
+  end
+  
+  def add_options!(opt)
+    base_add_options!(opt)
+    opt.on("--skip-seeds",
+           "Don't generate a seeds file for this model.") { |v| options[:skip_seeds] = v }
+    opt.on("--seeds-only",
+           "Only generate a seeds file for this model.") { |v| options[:seeds_only] = v }
+  end
+end

generators/seeded/templates/seeded_generation_helper.rb

@@ -0,0 +1,33 @@
+#Creates commands accessed by the manifest method in seeded generators.
+Rails::Generator::Commands::Create.class_eval do
+  def require_seeds(seed_path)
+    logger.seeds "#{seed_path}_seeds"
+    unless options[:pretend]
+        seed_file = File.join(Rails.root, 'db', 'seeds.rb')
+        #Add to the end of the file
+        File.open(seed_file, 'a+') { |f| f.write("\nrequire '#{seed_path}_seeds'") }
+    end
+  end
+end
+      
+Rails::Generator::Commands::Destroy.class_eval do
+  include FileUtils
+  def require_seeds(*seed_path)
+    look_for = "\nrequire '#{seed_path}_seeds'"
+    logger.seeds "#{seed_path}_seeds"
+    gsub_file 'db/seeds.rb', /(#{look_for})/mi, ''
+  end
+end
+      
+Rails::Generator::Commands::List.class_eval do
+  def require_seeds(*seed_path)
+    logger.seeds "#{seed_path}_seeds"
+  end
+end
+
+# New name
+Rails::Generator::NamedBase.class_eval do
+  def seeds_path
+    class_path.empty? ? file_name : File.join(class_path, file_name)
+  end
+end

generators/seeded/templates/seeds.rb

@@ -0,0 +1,29 @@
+# This file should contain all the record creation needed to seed the database model with its default values.
+# The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+#
+# Examples (with ActiveRecord validation):
+#   
+#   Using controllers:
+#   cities = City.create([{ :name => 'Chicago' }, { :name => 'Copenhagen' }])
+#   <%=class_name%>.create(:name => 'Daley', :city => cities.first)
+#
+#   Using models:
+#   [ {:name => 'Bob',    :city => 'Seattle '},
+#     {:name => 'George', :city => 'Zurich'} ].each do |seed|  
+#     <%=class_name%>.create_or_update_by_name(seed)  
+#   end  
+#
+#   { 'employee' => ['Robert', 'Sales'],   
+#     'manager'  => ['Renee', 'Manufacturing'] }.each_pair do |key, val|  
+#     <%=class_name%>.create_or_update_by_key(:key => key, :name => val[0], :dept => val[1])  
+#   end 
+#
+#   Using comma delimited file with ActiveRecord validation:
+#   File.read(my_text_file).split("\n").each do |seed|
+#     val = seed.split(",")
+#     <%=class_name%>.create_or_update_by_name(:name => val[0], :dept => val[1])
+#   end
+#
+# To seed this model individually, run rake db:seed MODELS=<%=class_name%>
+#
+require '<%=file_path%>'

generators/seeds_for/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Stubs out a model seeds file in the directory db/seeds and adds 
+    it as a required file in ../db/seeds.db. Pass the model name, 
+    either CamelCased or under_scored.
+
+Examples:
+    `./script/generate seed_model account`
+
+        creates an Account seeds file:
+            Seeds:      db/seeds/account_seeds.rb
+
+    `./script/generate model post title:string body:text published:boolean`
+
+        creates a post_seeds file.