sob-shoulda_generator 0.2.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Josh Nichols
+
+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/Manifest

@@ -0,0 +1,32 @@
+rails_generators/shoulda_model/shoulda_model_generator.rb
+rails_generators/shoulda_model/templates/factory.rb
+rails_generators/shoulda_model/templates/fixtures.yml
+rails_generators/shoulda_model/templates/migration.rb
+rails_generators/shoulda_model/templates/model.rb
+rails_generators/shoulda_model/templates/unit_test.rb
+rails_generators/shoulda_model/USAGE
+rails_generators/shoulda_scaffold/shoulda_scaffold_generator.rb
+rails_generators/shoulda_scaffold/templates/blueprint/ie.css
+rails_generators/shoulda_scaffold/templates/blueprint/print.css
+rails_generators/shoulda_scaffold/templates/blueprint/screen.css
+rails_generators/shoulda_scaffold/templates/controller.rb
+rails_generators/shoulda_scaffold/templates/erb/_form.html.erb
+rails_generators/shoulda_scaffold/templates/erb/edit.html.erb
+rails_generators/shoulda_scaffold/templates/erb/index.html.erb
+rails_generators/shoulda_scaffold/templates/erb/layout.html.erb
+rails_generators/shoulda_scaffold/templates/erb/new.html.erb
+rails_generators/shoulda_scaffold/templates/erb/show.html.erb
+rails_generators/shoulda_scaffold/templates/functional_test/basic.rb
+rails_generators/shoulda_scaffold/templates/functional_test/should_be_restful.rb
+rails_generators/shoulda_scaffold/templates/haml/_form.html.haml
+rails_generators/shoulda_scaffold/templates/haml/edit.html.haml
+rails_generators/shoulda_scaffold/templates/haml/index.html.haml
+rails_generators/shoulda_scaffold/templates/haml/layout.html.haml
+rails_generators/shoulda_scaffold/templates/haml/new.html.haml
+rails_generators/shoulda_scaffold/templates/haml/show.html.haml
+rails_generators/shoulda_scaffold/templates/helper.rb
+rails_generators/shoulda_scaffold/USAGE
+Rakefile
+README.markdown
+shoulda_generator.gemspec
+Manifest

data/README.markdown

@@ -0,0 +1,81 @@
+# Shoulda generators
+
+One night at a Boston Ruby hackfest, I finally got sick of using the Rails default generators, and then having to twiddle them to meet my needs and tastes. This includes using things like:
+
+ * [shoulda](http://thoughtbot.com/projects/shoulda)
+ * [factory\_girl](http://github.com/thoughtbot/factory_girl)
+ * [haml](http://haml.hamptoncatlin.com/)
+ * [blueprint](http://code.google.com/p/blueprintcss/)
+
+The next morning, I was struck awake at 5am with the inspiration to start implementing it. shoulda\_generator is the result of this effort.
+
+## What you get
+
+### shoulda\_model
+
+ * A new model
+ * A migration for the model
+  * Skip using --skip-migration
+ * A factory defined with [factory_girl](http://github.com/thoughtbot/factory_girl)
+  * Skip using --skip-factory
+ * A [shoulda](http://thoughtbot.com/projects/shoulda) unit test with a few simple 'should's
+
+#### Prereqs:
+
+ * [shoulda](http://thoughtbot.com/projects/shoulda) installed as a plugin
+ * [factory\_girl](http://github.com/thoughtbot/factory_girl) gem installed
+ * [factory\_girl\_on\_rails](http://github.com/technicalpickles/factory_girl_on_rails) installed as a plugin
+
+### shoulda\_scaffold
+
+ * Everything included in shoulda_model
+ * A controller (sans unnecessary comments)
+ * Choice of [haml](http://haml.hamptoncatlin.com/) (default) or ERB 
+   * Specify which with the --templating option
+ * Simple layout styled with blueprint
+   * Skip using --skip-layout
+ * A helper
+ * A shoulda functional test using factory_girl factory
+   * Specify with --functional-test-style, accepts basic only for now
+* A basic performance test
+
+#### Prereqs:
+
+ * [shoulda](http://thoughtbot.com/projects/shoulda) installed as a plugin
+ * [factory\_girl](http://github.com/thoughtbot/factory_girl) gem installed
+ * [factory\_girl\_on\_rails](http://github.com/technicalpickles/factory_girl_on_rails) installed as a plugin
+ * [haml](http://haml.hamptoncatlin.com/) gem installed on the system, and the project has been hamlified using  `haml --rails`
+ * [mocha](http://github.com/floehopper/mocha) gem installed
+
+## Getting it
+
+shoulda\_generator is available as a gem via [GitHub](http://github.com). If you haven't done so already, you need to setup GitHub as a gem source:
+
+    $ gem sources -a http://gems.github.com
+    
+Now you can install it:
+    
+    $ sudo gem install sob-shoulda_generator
+
+## Example usage
+
+Usage is the same as the default Rails generators.
+
+    $ script/generate shoulda_model post title:string body:text published:boolean 
+    $ script/generate shoulda_scaffold post title:string body:text published:boolean
+
+
+## Configuring it
+
+You can override the default values for templating and functional\_test\_style by placing a .shoulda\_generator  file in your home directory.
+
+Here's an example `.shoulda_generator`:
+
+    :templating: erb              # supported options: haml|erb
+    :functional_test_syle: basic  # supported options: should_be_restful|basic
+
+## Developing it
+
+Source is hosted on GitHub: [http://github.com/technicalpickles/shoulda_generator/tree/master](http://github.com/technicalpickles/shoulda_generator/tree/master)
+
+You can do the usual fork/commit cycle until you have something ready to share. Send pull requests my way.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rake'
+require 'rake/testtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "shoulda_generator"
+    s.summary = "Generators which create tests using shoulda"
+    s.email = "josh@technicalpickles.com"
+    s.homepage = "http://github.com/technicalpickles/shoulda_generator"
+    s.description = "Generators which create tests using shoulda"
+    s.authors = ["Josh Nichols"]
+    s.files =  FileList["[A-Z]*", "{rails_generators,lib,test}/**/*"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+desc 'Test by default'
+task :default => :test

data/TODO

@@ -0,0 +1,8 @@
+ * When installing, there's an warning:
+ 
+    Successfully installed shoulda_generator-0.2.0
+    1 gem installed
+    Installing ri documentation for shoulda_generator-0.2.0...
+    File not found: lib
+ 
+ * Support using resource_controller?

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 0
+:minor: 2

data/rails_generators/shoulda_model/USAGE

@@ -0,0 +1,27 @@
+Description:
+    Stubs out a new model. Pass the model name, either CamelCased or
+    under_scored, and an optional list of attribute pairs as arguments.
+
+    Attribute pairs are column_name:sql_type arguments specifying the
+    model's attributes. Timestamps are added by default, so you don't have to
+    specify them by hand as 'created_at:datetime updated_at:datetime'.
+
+    You don't have to think up every attribute up front, but it helps to
+    sketch out a few so you can start working with the model immediately.
+
+    This generates a model class in app/models, a unit test in test/unit,
+    a test fixture in test/fixtures/singular_name.yml, and a migration in
+    db/migrate.
+
+Examples:
+    `./script/generate shoulda_model account`
+
+        creates an Account model, test, factory, and migration:
+            Model:      app/models/account.rb
+            Test:       test/unit/account_test.rb
+            Factory:    test/factories/account_factory.rb
+            Migration:  db/migrate/XXX_add_accounts.rb
+
+    `./script/generate shoulda_model post title:string body:text published:boolean`
+
+        creates a Post model with a string title, text body, and published flag.

data/rails_generators/shoulda_model/shoulda_model_generator.rb

@@ -0,0 +1,49 @@
+class ShouldaModelGenerator < Rails::Generator::NamedBase
+  default_options :skip_timestamps => false, :skip_migration => false, :skip_factory => false
+
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, class_name, "#{class_name}Test"
+
+      # Model, test, and fixture directories.
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('test/unit', class_path)
+      m.directory File.join('test/factories', class_path)
+
+      # Model class, unit test, and fixtures.
+      m.template 'model.rb',      File.join('app/models', class_path, "#{file_name}.rb")
+      m.template 'unit_test.rb',  File.join('test/unit', class_path, "#{file_name}_test.rb")
+
+      unless options[:skip_factory] 
+        m.template 'factory.rb',  File.join('test/factories', class_path, "#{file_name}_factory.rb")
+      end
+
+      unless options[:skip_migration]
+        m.migration_template 'migration.rb', 'db/migrate', :assigns => {
+          :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}"
+        }, :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
+      end
+    end
+  end
+
+  def factory_line(attribute)
+    "#{file_name}.#{attribute.name} '#{attribute.default}'"
+  end
+
+  protected
+    def banner
+      "Usage: #{$0} #{spec.name} ModelName [field:type, field:type]"
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--skip-timestamps",
+             "Don't add timestamps to the migration file for this model") { |v| options[:skip_timestamps] = v }
+      opt.on("--skip-migration", 
+             "Don't generate a migration file for this model") { |v| options[:skip_migration] = v }
+      opt.on("--skip-factory",
+             "Don't generation a fixture file for this model") { |v| options[:skip_factory] = v}
+    end
+end

data/rails_generators/shoulda_model/templates/factory.rb

@@ -0,0 +1,5 @@
+Factory.define :<%= file_name %> do |<%= file_name %>|
+<% for attribute in attributes -%>
+  <%= factory_line(attribute) %>
+<% end -%>
+end

data/rails_generators/shoulda_model/templates/fixtures.yml

@@ -0,0 +1,19 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+<% unless attributes.empty? -%>
+one:
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+
+two:
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+<% else -%>
+# one:
+#   column: value
+#
+# two:
+#   column: value
+<% end -%>

data/rails_generators/shoulda_model/templates/migration.rb

@@ -0,0 +1,16 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+<% for attribute in attributes -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+<% unless options[:skip_timestamps] %>
+      t.timestamps
+<% end -%>
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/rails_generators/shoulda_model/templates/model.rb

@@ -0,0 +1,2 @@
+class <%= class_name %> < ActiveRecord::Base
+end

data/rails_generators/shoulda_model/templates/unit_test.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class <%= class_name %>Test < ActiveSupport::TestCase
+<% for attribute in attributes -%>
+  should_have_db_column :<%= attribute.name %>
+<% end -%>
+end

data/rails_generators/shoulda_scaffold/USAGE

@@ -0,0 +1,34 @@
+Description:
+    Scaffolds an entire resource, from model and migration to controller and
+    views, along with a full test suite. The resource is ready to use as a
+    starting point for your restful, resource-oriented application.
+
+    Pass the name of the model, either CamelCased or under_scored, as the first
+    argument, and an optional list of attribute pairs.
+
+    Attribute pairs are column_name:sql_type arguments specifying the
+    model's attributes. Timestamps are added by default, so you don't have to
+    specify them by hand as 'created_at:datetime updated_at:datetime'.
+
+    You don't have to think up every attribute up front, but it helps to
+    sketch out a few so you can start working with the resource immediately.
+
+    For example, `scaffold post title:string body:text published:boolean`
+    gives you a model with those three attributes, a controller that handles
+    the create/show/update/destroy, forms to create and edit your posts, and
+    an index that lists them all, as well as a map.resources :posts
+    declaration in config/routes.rb.
+    
+    You can override the default values for templating and
+    functional\_test\_style by placing a .shoulda\_generator file in your home
+    directory.
+
+    Here's an example `.shoulda_generator`:
+
+        :templating: erb              # supported options: haml|erb
+        :functional_test_syle: basic  # supported options: basic
+
+Examples:
+    `./script/generate shoulda_scaffold post` # no attributes, view will be anemic
+    `./script/generate shoulda_scaffold post title:string body:text published:boolean`
+    `./script/generate shoulda_scaffold purchase order_id:integer amount:decimal`

data/rails_generators/shoulda_scaffold/shoulda_scaffold_generator.rb

@@ -0,0 +1,163 @@
+#--
+# ShouldaScaffoldGeneratorConfig based on rubygems code.
+# Thank you Chad Fowler, Rich Kilmer, Jim Weirich and others.
+#++
+class ShouldaScaffoldGeneratorConfig
+  
+  DEFAULT_TEMPLATING = 'haml'
+  DEFAULT_FUNCTIONAL_TEST_STYLE = 'basic'
+  
+  def initialize()
+    @config = load_file(config_file)
+    
+    @templating = @config[:templating] || DEFAULT_TEMPLATING
+    @functional_test_style = @config[:functional_test_style] || DEFAULT_FUNCTIONAL_TEST_STYLE
+  end
+  
+  attr_reader :templating, :functional_test_style
+   
+  private
+   
+  def load_file(filename)
+    begin
+      YAML.load(File.read(filename)) if filename and File.exist?(filename)
+    rescue ArgumentError
+      warn "Failed to load #{config_file_name}"
+    rescue Errno::EACCES
+      warn "Failed to load #{config_file_name} due to permissions problem."
+    end or {}
+  end
+  
+  def config_file
+     File.join(find_home, '.shoulda_generator')
+  end
+  
+  ##
+  # Finds the user's home directory.
+  
+  def find_home
+    ['HOME', 'USERPROFILE'].each do |homekey|
+      return ENV[homekey] if ENV[homekey]
+    end
+
+    if ENV['HOMEDRIVE'] && ENV['HOMEPATH'] then
+      return "#{ENV['HOMEDRIVE']}:#{ENV['HOMEPATH']}"
+    end
+
+    begin
+      File.expand_path("~")
+    rescue
+      if File::ALT_SEPARATOR then
+          "C:/"
+      else
+          "/"
+      end
+    end
+  end
+end
+
+class ShouldaScaffoldGenerator < Rails::Generator::NamedBase
+  default_options :skip_timestamps => false, :skip_migration => false, :skip_layout => true
+
+  attr_reader   :controller_name,
+                :controller_class_path,
+                :controller_file_path,
+                :controller_class_nesting,
+                :controller_class_nesting_depth,
+                :controller_class_name,
+                :controller_class_name_without_nesting,
+                :controller_underscore_name,
+                :controller_singular_name,
+                :controller_plural_name,
+                :controller_member_path,
+                :controller_collection_path
+  alias_method  :controller_file_name,  :controller_underscore_name
+  alias_method  :controller_table_name, :controller_plural_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    
+    @configuration = ShouldaScaffoldGeneratorConfig.new
+    
+    @controller_name = @name.pluralize
+
+    base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
+    @controller_class_name_without_nesting, @controller_underscore_name, @controller_plural_name = inflect_names(base_name)
+    @controller_singular_name = @controller_plural_name.singularize
+    if @controller_class_nesting.empty?
+      @controller_class_name = @controller_class_name_without_nesting
+      @class_name = @controller_class_name.singularize
+    else
+      @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
+      @class_name = @controller_class_name_without_nesting.singularize
+    end
+    @controller_member_path = @controller_class_name.underscore.gsub('/', '_').singularize
+    @controller_collection_path = @controller_class_name.underscore.gsub('/', '_').pluralize
+  end
+
+  def manifest
+    record do |m|
+      # Controller, helper, views, and test directories.
+      m.directory(File.join('app/controllers', controller_class_path))
+      m.directory(File.join('app/helpers', controller_class_path))
+      m.directory(File.join('app/views', controller_class_path, controller_file_name))
+      m.directory(File.join('app/views/layouts', controller_class_path))
+      m.directory(File.join('test/functional', controller_class_path))
+      m.directory(File.join('test', 'performance', controller_class_path))
+      m.directory(File.join('test', 'unit'))
+
+      for view in scaffold_views
+        m.template("#{templating}/#{view}.html.#{templating}",File.join('app/views', controller_class_path, controller_file_name, "#{view}.html.#{templating}"))
+      end
+
+      # Layout and stylesheet.
+      m.template("#{templating}/layout.html.#{templating}", File.join('app', 'views', 'layouts', "application.html.#{templating}"), :collision => :skip)
+      m.template("yui/reset-fonts-grids.css", File.join('public', 'stylesheets', 'reset-fonts-grids.css'))
+      m.file("stylesheets/basic.css", File.join('public', 'stylesheets', 'scaffold.css'), :collision => :skip)
+      
+      # controller with associated tests
+      m.template('controller.rb', File.join('app', 'controllers', controller_class_path, "#{controller_file_name}_controller.rb"))
+      m.template("functional_test/#{functional_test_style}.rb", File.join('test', 'functional', controller_class_path, "#{controller_file_name}_controller_test.rb"))
+      m.template("performance_test/browser_test.rb", File.join('test', 'performance', controller_class_path, "#{controller_file_name}_controller_test.rb"))
+      m.template('helper.rb', File.join('app', 'helpers', controller_class_path, "#{controller_file_name}_helper.rb"))
+
+      m.route_resources controller_file_name
+
+      m.dependency 'shoulda_model', [@controller_singular_name] + @args, :collision => :skip
+    end
+  end
+
+  def templating
+    options[:templating] || @configuration.templating
+  end
+
+  def functional_test_style
+    options[:functional_test_style] || @configuration.functional_test_style
+  end
+
+  protected
+    # Override with your own usage banner.
+    def banner
+      "Usage: #{$0} scaffold ModelName [field:type, field:type]"
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--skip-timestamps",
+             "Don't add timestamps to the migration file for this model") { |v| options[:skip_timestamps] = v }
+      opt.on("--skip-migration",
+             "Don't generate a migration file for this model") { |v| options[:skip_migration] = v }
+      opt.on("--templating [erb|haml]", "Specify the templating to use (haml by default)") { |v| options[:templating] = v }
+      opt.on("--functional-test-style [basic]", "Specify the style of the functional test (basic by default)") { |v| options[:functional_test_style] = v }
+      
+     end
+
+    def scaffold_views
+      %w[ index show new edit _form ]
+    end
+
+    def model_name
+      class_name.demodulize.singularize
+    end
+end