hardbap-coulda 0.4.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2008 Mike Breen
+
+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.markdown

@@ -0,0 +1,128 @@
+# Coulda generator
+
+Inspired by [technicalpickles'](http://technicalpickles.com/) [shoulda\_generator](http://github.com/technicalpickles/shoulda_generator) (okay blatantly ripped off from ;)
+
+What you'll need:
+
+* [shoulda](http://github.com/thoughtbot/shoulda)
+* [factory\_girl](http://github.com/thoughtbot/factory_girl)
+
+## What it does
+
+### coulda\_model
+
+* a new model
+* a migration (skip using --skip-migration)
+* a factory defined with [factory\_girl](http://github.com/thoughtbot/factory_girl) (skip using --skip-factory)
+* a [shoulda](http://github.com/thoughtbot/shoulda) unit test with some tests
+
+
+### coulda\_scaffold
+
+* a coulda\_model
+* a RESTful controller
+* a helper
+* ERB templates
+* a [shoulda](http://github.com/thoughtbot/shoulda) functional test using a [factory\_girl](http://github.com/thoughtbot/factory_girl) factory
+* a helper test in test/unit/helper
+
+
+## Example usage
+
+Use these just like the standard Rails generators.
+
+    $ script/generate coulda_model post title:string body:text published:boolean
+    $ script/generate coulda_scaffold post title:string body:text published:boolean
+    
+    
+## Other stuff
+
+### belongs\_to
+
+Using "belongs\_to" as the field type provides some extra goodness.
+
+* "add\_index" in the migration
+* "belongs\_to" in the model
+* "should\_belong\_to" in unit test
+* association in the factory
+
+### example
+
+    $ script/generate coulda_model post title:string body:text user:belongs_to
+    
+will give you this migration:
+
+    class CreatePosts < ActiveRecord::Migration
+      def self.up
+        create_table :posts do |t|
+          t.string :title
+          t.text :body
+          t.belongs_to :user
+          
+          t.timestamps
+        end
+
+        add_index :posts, :user_id
+      end
+
+      def self.down
+        remove_index :posts, :user_id
+        drop_table :posts
+      end
+    end
+    
+for this model:
+
+    class Post < ActiveRecord::Base
+      belongs_to :user
+    end
+    
+with this unit test:
+
+    require File.dirname(__FILE__) + '/../test_helper'
+
+    class PostTest < ActiveSupport::TestCase
+  
+      should_have_db_column :title, :type => "string"
+      should_have_db_column :body, :type => "text"
+      
+      should_belong_to :user
+      should_have_index :user_id
+      
+    end
+    
+and finally our factory:
+
+    Factory.define :post do |f|
+      f.title 'MyString'
+      f.body 'MyString'
+      f.user {|f| f.association(:user)}
+    end
+
+## Authors
+
+Mike Breen and [Dan Croak](http://github.com/dancroak)
+
+## License
+
+The MIT License
+ 
+Copyright (c) 2008 Mike Breen
+ 
+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/Rakefile

@@ -0,0 +1,27 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+desc "Run the test suite"
+task :default => 'test'
+
+begin
+  require 'rubygems'
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name        = "coulda"
+    s.summary     = "Rails generators that create Shoulda & Factory Girl tests."
+    s.email       = "hardbap@gmail.com"
+    s.homepage    = "http://github.com/hardbap/coulda"
+    s.description = "Rails generators that create Shoulda & Factory Girl tests."
+    s.authors     = ["Mike Breen", "Dan Croak"]
+    s.files       = FileList["[A-Z]*", "{generators,lib,test}/**/*"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/TODO

@@ -0,0 +1,3 @@
+* remove xml in controller? or add default xml builder?
+* use each iterator instead of for loops
+* no table in index view, use something cleaner

data/VERSION.yml

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

data/generators/coulda_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 factory in test/factories/singular_name_factory.rb, and a migration in
+    db/migrate.
+ 
+Examples:
+    `./script/generate coulda_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 coulda_model post title:string body:text published:boolean`
+ 
+        creates a Post model with a string title, text body, and published flag.

data/generators/coulda_model/coulda_model_generator.rb

@@ -0,0 +1,65 @@
+class CouldaModelGenerator < 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)
+    line = "factory.#{attribute.name} " 
+    line << (if attribute.reference? 
+             then "{ |#{attribute.name}| #{attribute.name}.association(:#{attribute.name}) }"
+             else "'#{attribute.default}'"
+             end)  
+  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") { |option| 
+               options[:skip_timestamps] = option 
+      }
+      opt.on("--skip-migration",
+             "Don't generate a migration file for this model") { |option| 
+               options[:skip_migration] = option 
+      }
+      opt.on("--skip-factory",
+             "Don't generation a fixture file for this model") { |option| 
+               options[:skip_factory] = option
+      }
+    end
+
+end

data/generators/coulda_model/templates/factory.rb

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

data/generators/coulda_model/templates/migration.rb

@@ -0,0 +1,23 @@
+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
+    
+<% attributes.select(&:reference?).each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.name %>_id
+<% end -%>  
+  end
+
+  def self.down
+<% attributes.select(&:reference?).each do |attribute| -%>
+    remove_index :<%= table_name %>, :<%= attribute.name %>_id
+<% end %>
+    drop_table :<%= table_name %>
+  end
+end

data/generators/coulda_model/templates/model.rb

@@ -0,0 +1,5 @@
+class <%= class_name %> < ActiveRecord::Base
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %>
+<% end -%>  
+end

data/generators/coulda_model/templates/unit_test.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../test_helper'
+ 
+class <%= class_name %>Test < ActiveSupport::TestCase
+<% for attribute in attributes -%>
+  <% if attribute.reference? %>
+  should_belong_to  :<%= attribute.name %>
+  should_have_index :<%= attribute.name %>_id
+  <% else %>
+  should_have_db_column :<%= attribute.name %>, :type => "<%= attribute.type %>"
+  <% end -%>
+<% end -%> 
+end

data/generators/coulda_scaffold/USAGE

@@ -0,0 +1,25 @@
+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, `coulda_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.
+    
+Examples:
+    `./script/generate coulda_scaffold post` # no attributes, view will be anemic
+    `./script/generate coulda_scaffold post title:string body:text published:boolean`
+    `./script/generate coulda_scaffold purchase order_id:integer amount:decimal`

data/generators/coulda_scaffold/coulda_scaffold_generator.rb

@@ -0,0 +1,107 @@
+class CouldaScaffoldGenerator < Rails::Generator::NamedBase
+
+  default_options :skip_timestamps => false, 
+                  :skip_migration  => false, 
+                  :skip_factory    => false
+ 
+  attr_reader :controller_name,
+              :controller_class_path,
+              :controller_file_path,
+              :controller_class_nesting,
+              :controller_class_nesting_depth,
+              :controller_class_name,
+              :controller_underscore_name,
+              :controller_singular_name,
+              :controller_plural_name
+  
+  alias_method :controller_file_name,  :controller_underscore_name
+  alias_method :controller_table_name, :controller_plural_name
+ 
+  def initialize(runtime_args, runtime_options = {})
+    super
+        
+    if @name == @name.pluralize && !options[:force_plural]
+      logger.warning "Plural version of the model detected, using singularized version.  Override with --force-plural."
+      @name = @name.singularize
+    end
+
+    @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 = base_name.singularize
+    
+    if @controller_class_nesting.empty?
+      @controller_class_name = @controller_class_name_without_nesting
+    else
+      @controller_class_name = 
+        "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
+    end 
+  end
+ 
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions(controller_class_path, 
+        "#{controller_class_name}Controller", "#{controller_class_name}Helper")
+      m.class_collisions(class_path, "#{class_name}")
+ 
+      # Controller, helper, views, and test directories.
+      m.directory(File.join('app/models', class_path))
+      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('test/functional', controller_class_path))
+      m.directory(File.join('test/unit', class_path))
+      m.directory(File.join('test/unit/helper', class_path))
+      
+      for view in scaffold_views
+        m.template(
+          "view/#{view}.html.erb",
+          File.join('app/views', controller_class_path, controller_file_name, "#{view}.html.erb")
+        )
+      end
+ 
+      m.template(
+        'controller.rb', File.join('app/controllers', controller_class_path, "#{controller_file_name}_controller.rb")
+      )
+ 
+      m.template("functional_test/shoulda_controller.rb", File.join('test/functional', 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.template('helper_test.rb', File.join('test/unit/helper', class_path, "#{controller_file_name}_helper_test.rb"))
+ 
+      m.route_resources controller_file_name
+ 
+      m.dependency 'coulda_model', [name] + @args, :collision => :skip
+    end
+  end  
+ 
+  protected
+
+    # Override with your own usage banner.
+    def banner
+      "Usage: #{$0} coulda_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("--skip-factory",
+              "Don't generation a fixture file for this model") { |v| options[:skip_factory] = v}
+    end
+ 
+    def scaffold_views
+      %w[ index show new edit _form ]
+    end
+ 
+    def model_name
+      class_name.demodulize
+    end
+
+end