grimen-dry_scaffold 0.2.6 → 0.3.0

data/CHANGELOG.textile

@@ -1,3 +1,9 @@
+h1. 0.3.0 (2009-07-23)
+
+* Major refactoring of the code.
+* Test/Fixture-stuff re-written from the ground, now tested thoroughly and considered stable - was not before. Plenty sloppy bugs squashed.
+* Added Shoulda tests generation.
+
 h1. 0.2.5 (2009-06-12)
 
 * Fixed typo: Gem configuration instructions in README.

data/README.textile

@@ -24,15 +24,19 @@ h3. Optional:
  
 h4. Controllers/Views
  
-* "*will_paginate*":http://github.com/mislav/will_paginate - Pagination
-* "*formtastic*":http://github.com/justinfrench/formtastic - DRY and semantic forms
 * "*inherited_resources*":http://github.com/josevalim/inherited_resources - DRY/Resourceful controllers
+* "*formtastic*":http://github.com/justinfrench/formtastic - DRY and semantic forms
+* "*will_paginate*":http://github.com/mislav/will_paginate - Pagination
  
 h4. Models
  
 * "*factory_girl*":http://github.com/thoughtbot/factory_girl - Fixture-replacement
 * "*machinist*":http://github.com/notahat/machinist - Fixture-replacement
 * "*object_daddy*":http://github.com/flogic/object_daddy - Fixture-replacement
+ 
+h4. Testing
+ 
+* "*Shoulda*":http://github.com/thoughtbot/shoulda - Testing framework
 
 h2. Features
 
@@ -47,7 +51,7 @@ The most characteristic features:
 * Collection pagination using will_paginate by default. Note: Can be turned off.
 * Optionally specify what actions/views to generate (stubs for specified REST-actions will be generated).
 * Optionally specify what respond_to-formats to generate (stubs for the most common respond_to-formats will be generated).
-* Generates default helpers/models/migrations, and REST-routes.
+* Generates default helpers/models/migrations, and REST-routes (if not already defined).
 
 h3. Formtastic Forms
 
@@ -172,7 +176,7 @@ h3. More To Come... (TODO)
 These are things I have in mind:
 
 * Handle belongs_to, i.e. specify MODEL --belongs-to PARENT_MODEL, which generates proper routes, proper before-filters if inherited_resources-controller, adding belongs_to-association in model, and correct form_for arguments.
-* Choose test suits: testunit/shoulda/rspec
+* RSpec-support?
 
 h2. Setup
 
@@ -211,7 +215,7 @@ h4. Manual
 Get the gems...you want:
 
 <pre>sudo gem install haml
-sudo gem install will_paginate
+sudo gem install mislav-will_paginate
 sudo gem install justinfrench-formtastic
 sudo gem install josevalim-inherited_resources</pre>
 
@@ -219,18 +223,18 @@ sudo gem install josevalim-inherited_resources</pre>
 
 <pre>config.gem 'haml'
 config.gem 'will_paginate'
-config.gem 'justinfrench-formtastic', :lib => 'formtastic, :source => 'http://gems.github.com'
+config.gem 'justinfrench-formtastic', :lib => 'formtastic', :source => 'http://gems.github.com'
 config.gem 'josevalim-inherited_resources', :lib => 'inherited_resources', :source => 'http://gems.github.com'</pre>
 
 h2. Usage
 
-<pre>./script/generate dry_scaffold ModelName [attribute:type attribute:type] [_actions:new,create,...] [_formats:html,json,...] [_indexes:attribute,...] [--skip-pagination] [--skip-resourceful] [--skip-formtastic] [--skip-views] [--skip-helpers] [--skip-tests] [--include-layout] [--fixtures] [--fgirl] [--machinist] [--odaddy] [--skip-migration] [--skip-timestamps]</pre>
+<pre>./script/generate dry_scaffold ModelName [attribute:type attribute:type] [_actions:new,create,...] [_formats:html,json,...] [_indexes:attribute,...] [--skip-pagination] [--skip-resourceful] [--skip-formtastic] [--skip-views] [--skip-helpers] [--skip-migration] [--skip-timestamps] [--skip-tests] [--layout] [--tunit] [--shoulda] [--fixtures] [--fgirl] [--machinist] [--odaddy]</pre>
 
 ...or use the alias @dscaffold@ instead of @dry_scaffold@.
 
 For generating just a *model*, then use:
 
-<pre>./script/generate dry_model ModelName [attribute:type attribute:type] [_indexes:attribute,...] [--fixtures] [--fgirl] [--machinist] [--odaddy] [--skip-migration] [--skip-timestamps] [--skip-tests]</pre>
+<pre>./script/generate dry_model ModelName [attribute:type attribute:type] [_indexes:attribute,...] [--skip-migration] [--skip-timestamps] [--skip-tests] [--tunit] [--shoulda] [--fixtures] [--fgirl] [--machinist] [--odaddy]</pre>
 
 ...or use the alias @dmodel@ instead of @dry_model@.
 
@@ -380,7 +384,6 @@ These are the options for the scaffold-generator.
 * @--skip-formtastic@   - Don't generate formtastic forms in views, i.e. don't use *formtastic*.
 * @--skip-views@        - Don't generate views.
 * @--skip-helpers@      - Don't generate helpers.
-* @--skip-tests@        - Don't generate tests (functional/unit/...).
 * @--skip-builders@     - Don't generate builders.
 * @--layout@            - Generate layout.
  
@@ -388,16 +391,22 @@ h4. Model
 
 These are the options for the model/scaffold-generators.
 
-* @--fixtures@          - Generate fixtures.
-* @--fgirl@             - Generate *factory_girl* factories.
-* @--machinist@         - Generate *machinist* blueprints (factories).
-* @--odaddy@            - Generate *object_daddy* generator/factory methods.
 * @--skip-timestamps@   - Don't add timestamps to the migration file.
 * @--skip-migration@    - Skip generation of migration file.
+ 
+h4. All
+
+* @--skip-tests@        - Don't generate tests (functional/unit/...).
+* @--tunit@             - Generate/Use test_unit tests. Note: Rails default.
+* @--shoulda@           - Generate/Use *shoulda* tests.
+* @--fixtures@          - Generate/Use fixtures. Note: Rails default.
+* @--fgirl@             - Generate/Use *factory_girl* factories.
+* @--machinist@         - Generate/Use *machinist* blueprints (factories).
+* @--odaddy@            - Generate/Use *object_daddy* generator/factory methods.
 
 As DryScaffold is built upon Rails generator, the default generator options is available as well. For more details; see Rails documentation.
 
-h3. Setting Defaults 
+h3. Setting Defaults
 
 You can set defaults for the generator args/options in @config/scaffold.yml@. To generate this file, simply do:
 
@@ -410,11 +419,11 @@ No need for more samples here, just create a new Rails project, install DryScaff
 For your inspiration, you could try the following:
 
 <pre>./script/generate dry_scaffold Zebra name:string about:text --skip-resourceful
-./script/generate dry_scaffold Kangaroo name:string about:text --skip-formtastic
+./script/generate dscaffold Kangaroo name:string about:text --skip-formtastic
 ./script/generate dscaffold Duck name:string about:text _actions:new,create,index,quack
 ./script/generate dscaffold Parrot name:string about:text _formats:html,xml,yml
-./script/generate dscaffold GoldFish name:string about:text _indexes:name --fgirl
-./script/generate dry_model Frog name:string about:text _indexes:name,name+about --fixtures</pre>
+./script/generate dmodel GoldFish name:string about:text _indexes:name --fgirl
+./script/generate dmodel Frog name:string about:text _indexes:name,name+about --fixtures</pre>
 
 ...or just go crazy!
 

data/TODO.textile

@@ -2,12 +2,49 @@ h1. TODO
 
 h2. Next
 
-* Feature: Handle belongs_to, i.e. specify MODEL --belongs-to PARENT_MODEL, which generates proper routes, proper before-filters if inherited_resources-controller, adding belongs_to-association in model, and correct form_for arguments.
-* Choose test suits: testunit/shoulda/rspec
+* Bug/Issue: InheritedResources functional testing issue.
+* Feature: RSpec-templates?
+* Optimization: Write even better functional tests for REST-actions. Goal: Killer-tests, i.e. "best practice"-tests. Suggestion: Routing, formats, ...
 
-h2. Maybe later
+h2. Maybe
 
-* Clean-up: Comment the code a bit more =)
-* Refactor: Break up in different generators: dry_controller, dry_views, etc., and use as dependencies in dry_scaffold?
 * Feature: Check for overridden templates in: RAILS_ROOT/lib/dry_scaffold/templates/
-* Feature: Builder for podcast-feed, similar to RSS/Atom-builders. http://wiki.github.com/radiant/radiant/host-a-podcast
+* Feature: Handle belongs_to, i.e. specify MODEL --belongs-to PARENT_MODEL, which generates proper routes, proper before-filters if inherited_resources-controller, adding belongs_to-association in model, and correct form_for arguments.
+* Feature: Builder for podcast-feed, similar to RSS/Atom-builders. http://wiki.github.com/radiant/radiant/host-a-podcast
+* Tests: Generator tests. =P (Not very straightforward...)
+
+h2. Issues
+
+* Contact José regarding the InheritedResources-issue:
+
+1) ActionController::RoutingError: parrot_url failed to generate from {:controller=>"parrots", :id=>#<Parrot id: nil, name: "Hello", created_at: "2009-07-21 18:53:25", updated_at: "2009-07-21 18:53:25">, :action=>"show"}, expected: {:controller=>"parrots", :action=>"show"}, diff: {:id=>#<Parrot id: nil, name: "Hello", created_at: "2009-07-21 18:53:25", updated_at: "2009-07-21 18:53:25">}
+  (eval):16:in `parrot_url'
+/opt/local/lib/ruby/gems/1.8/gems/josevalim-inherited_resources-0.7.3/lib/inherited_resources/url_helpers.rb:194:in `resource_url'
+/opt/local/lib/ruby/gems/1.8/gems/josevalim-inherited_resources-0.7.3/lib/inherited_resources/base_helpers.rb:311:in `send'
+/opt/local/lib/ruby/gems/1.8/gems/josevalim-inherited_resources-0.7.3/lib/inherited_resources/base_helpers.rb:311:in `parse_redirect_url'
+/opt/local/lib/ruby/gems/1.8/gems/josevalim-inherited_resources-0.7.3/lib/inherited_resources/base.rb:79:in `create'
+/opt/local/lib/ruby/gems/1.8/gems/josevalim-inherited_resources-0.7.3/lib/inherited_resources/respond_to.rb:301:in `call'
+/opt/local/lib/ruby/gems/1.8/gems/josevalim-inherited_resources-0.7.3/lib/inherited_resources/respond_to.rb:301:in `respond_any'
+/opt/local/lib/ruby/gems/1.8/gems/josevalim-inherited_resources-0.7.3/lib/inherited_resources/respond_to.rb:233:in `respond_to'
+/opt/local/lib/ruby/gems/1.8/gems/josevalim-inherited_resources-0.7.3/lib/inherited_resources/base_helpers.rb:283:in `respond_to_with_dual_blocks'
+/opt/local/lib/ruby/gems/1.8/gems/josevalim-inherited_resources-0.7.3/lib/inherited_resources/base.rb:78:in `create'
+    haml (2.0.9) rails/./lib/sass/plugin/rails.rb:19:in `process'
+    /test/functional/donkeys_controller_test.rb:8:in `test_create'
+    
+  test 'create' do
+    Donkey.any_instance.expects(:save).returns(true)
+    @donkey = donkeys(:basic)
+    post :create, :donkey => @donkey.attributes   # <<<<<<<<<<<<< donkeys_controller_test.rb:8
+    assert_response :redirect
+  end
+  
+2) test_destroy_with_failure(DonkeysControllerTest) [/test/functional/donkeys_controller_test.rb:45]:
+<nil> expected to not be nil.
+  
+  test 'destroy with failure' do
+    Donkey.any_instance.expects(:destroy).returns(false)
+    @donkey = donkeys(:basic)
+    delete :destroy, :id => @donkey.to_param
+    assert_not_nil flash[:error]                  # <<<<<<<<<<<<< donkeys_controller_test.rb:45
+    assert_response :redirect
+  end

data/config/scaffold.yml

@@ -5,18 +5,26 @@ dry_scaffold:
     formats: html,js,xml,json
   options:
     formtastic: true
-    resourceful: true
+    resourceful: false
     pagination: true
+    layout: false
     views: true
     helpers: true
     tests: true
-    layout: false
-dry_model:
-  options:
-    fixtures: false
+    tunit: true
+    shoulda: false
+    fixtures: true
     fgirl: false
     machinist: false
     object_daddy: false
+dry_model:
+  options:
     migration: true
     timestamps: true
-    tests: true
+    tests: true
+    tunit: true
+    shoulda: false
+    fixtures: true
+    fgirl: false
+    machinist: false
+    object_daddy: false

data/generators/dry_model/USAGE

@@ -5,8 +5,5 @@ DESCRIPTION
   A replacement for the Rails model generator - a part of the dry_generator toolset.
   
 EXAMPLE
-  ./script/generate dry_model ModelName [attribute:type attribute:type] [_index:name,owner_id+owner_type,active,...] [--fixtures] [--fgirl] [--machinist] [--odaddy] [--skip-timestamps] [--skip-migration] [--skip-tests]
-  
-  ...or the shortcut version:
-  
-  ./script/generate dmodel ...
+  ./script/generate dmodel GoldFish name:string about:text _indexes:name --fgirl
+  ./script/generate dmodel Frog name:string about:text _indexes:name,name+about --fixtures

data/generators/dry_model/dry_model_generator.rb

@@ -1,55 +1,25 @@
-require 'rubygems'
-%w(factory_girl machinist object_daddy).each do |lib|
-  begin
-    require lib
-  rescue MissingSourceFile
-    eval("#{lib.upcase} = #{false}")
-  else
-    eval("#{lib.upcase} = #{true}")
-  end
-end
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib', 'dry_generator'))
 
-class DryModelGenerator < Rails::Generator::NamedBase
-  
-  # Load defaults from config file - default or custom.
-  begin
-    default_config_file = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'config', 'scaffold.yml'))
-    custom_config_file = File.expand_path(File.join(Rails.root, 'config', 'scaffold.yml'))
-    config_file = File.join(File.exist?(custom_config_file) ? custom_config_file : default_config_file)
-    config = YAML::load(File.open(config_file))
-    CONFIG_OPTIONS = config['dry_model']['options'] rescue nil
-  end
+class DryModelGenerator < DryGenerator
   
-  DEFAULT_OPTIONS = {
-      :fixtures => CONFIG_OPTIONS['fixtures'] || false,
-      :factory_girl => CONFIG_OPTIONS['factory_girl'] || false,
-      :machinist => CONFIG_OPTIONS['machinist'] || false,
-      :object_daddy => CONFIG_OPTIONS['object_daddy'] || false,
-      :skip_timestamps => !CONFIG_OPTIONS['timestamps'] || false,
-      :skip_migration => !CONFIG_OPTIONS['migration'] || false,
-      :skip_tests => !CONFIG_OPTIONS['tests'] || false
-    }
+  # Banner: Generator arguments and options.
+  BANNER_ARGS = [
+      "[_indexes:field,field+field,field,...]"
+    ].freeze
+  BANNER_OPTIONS = [
+      "[--skip-timestamps]",
+      "[--skip-migration]"
+    ].freeze
     
-  DEFAULT_TEST_FRAMEWORK =      :test_unit
+  # Paths.
+  MODELS_PATH =           File.join('app', 'models').freeze
+  MIGRATIONS_PATH =       File.join('db', 'migrate').freeze
   
-  MODELS_PATH =                 File.join('app', 'models').freeze
-  MIGRATIONS_PATH =             File.join('db', 'migrate').freeze
-  TESTS_PATH =                  File.join('test').freeze
-  UNIT_TESTS_PATH =             File.join(TESTS_PATH, 'unit').freeze
-  FIXTURES_PATH =               File.join(TESTS_PATH, 'fixtures').freeze
-  FACTORY_GIRL_FACTORIES_PATH = File.join(TESTS_PATH, 'factories').freeze
-  MACHINIST_FACTORIES_PATH =    File.join(TESTS_PATH, 'blueprints').freeze
-  
-  NON_ATTR_ARG_KEY_PREFIX =     '_'.freeze
-                  
   attr_reader :indexes,
-              :references,
-              :test_framework
+              :references
               
   def initialize(runtime_args, runtime_options = {})
-    super
-    
-    @test_framework = DEFAULT_TEST_FRAMEWORK
+    super(runtime_args, runtime_options)
     
     @attributes ||= []
     args_for_model = []
@@ -83,41 +53,43 @@ class DryModelGenerator < Rails::Generator::NamedBase
       # Check for class naming collisions.
       m.class_collisions class_name, "#{class_name}Test"
       
-      # Directories.
+      # Model.
       m.directory File.join(MODELS_PATH, class_path)
-      m.directory File.join(UNIT_TESTS_PATH, class_path) unless options[:skip_tests]
-      m.directory File.join(FIXTURES_PATH, class_path) if options[:fixtures]
-      m.directory File.join(FACTORY_GIRL_FACTORIES_PATH, class_path) if options[:factory_girl]
-      m.directory File.join(MACHINIST_FACTORIES_PATH, class_path) if options[:machinist]
-      
-      # Model
       m.template File.join('models', 'active_record_model.rb'),
         File.join(MODELS_PATH, class_path, "#{file_name}.rb")
         
       # Model Tests.
       unless options[:skip_tests]
+        model_tests_path = File.join(TEST_PATHS[test_framework], 'unit')
+        m.directory File.join(model_tests_path, class_path)
         m.template File.join('models', 'tests', "#{test_framework}", 'unit_test.rb'),
-          File.join(UNIT_TESTS_PATH, class_path, "#{file_name}_test.rb")
-      end
-      
-      # Fixtures/Factories.
-      if options[:fixtures]
-        m.template File.join('models', 'test_data', 'active_record_fixtures.yml'),
-          File.join(FIXTURES_PATH, "#{file_name}.yml")
-      end
-      if options[:factory_girl]
-        m.template File.join('models', 'test_data', 'factory_girl_factories.rb'),
-          File.join(FACTORY_GIRL_FACTORIES_PATH, "#{file_name}.rb")
-      end
-      if options[:machinist]
-        m.template File.join('models', 'test_data', 'machinist_factories.rb'),
-          File.join(MACHINIST_FACTORIES_PATH, "#{file_name}.rb")
+          File.join(model_tests_path, class_path, "#{file_name}_test.rb")
+          
+        # Fixtures/Factories.
+        if options[:fixtures]
+          fixtures_path = File.join(TEST_PATHS[test_framework], 'fixtures')
+          m.directory File.join(fixtures_path, class_path)
+          m.template File.join('models', 'fixture_data', 'active_record_fixtures.yml'),
+            File.join(fixtures_path, class_path, "#{plural_name}.yml")
+        end
+        if options[:factory_girl]
+          factory_girl_path = File.join(TEST_PATHS[test_framework], 'factories')
+          m.directory File.join(factory_girl_path, class_path)
+          m.template File.join('models', 'fixture_data', 'factory_girl_factories.rb'),
+            File.join(factory_girl_path, class_path, "#{plural_name}.rb")
+        end
+        if options[:machinist]
+          machinist_path = File.join(TEST_PATHS[test_framework], 'blueprints')
+          m.directory File.join(machinist_path, class_path)
+          m.template File.join('models', 'fixture_data', 'machinist_blueprints.rb'),
+            File.join(machinist_path, class_path, "#{plural_name}.rb")
+        end
+        # NOTE: :object_daddy handled in model
       end
-      # NOTE: :object_daddy handled in model
       
       # Migration.
       unless options[:skip_migration]
-        m.migration_template File.join('models', 'active_record_migration.rb') , MIGRATIONS_PATH,
+        m.migration_template File.join('models', 'active_record_migration.rb'), MIGRATIONS_PATH,
           :assigns => {:migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}"},
           :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
       end
@@ -125,87 +97,38 @@ class DryModelGenerator < Rails::Generator::NamedBase
   end
   
   protected
+    
+    def add_options!(opt)
+      super(opt)
       
-      def add_options!(opt)
-        opt.separator ''
-        opt.separator 'Options:'
-        
-        opt.on("--fixtures", "Generate fixtures.") do |v|
-          options[:fixtures] = v
-        end
-        
-        opt.on("--fgirl", "Generate \"factory_girl\" factories.") do |v|
-          options[:factory_girl] = v
-        end
-        
-        opt.on("--machinist", "Generate \"machinist\" blueprints (factories).") do |v|
-          options[:machinist] = v
-        end
-        
-        opt.on("--odaddy", "Generate \"object_daddy\" generator/factory methods.") do |v|
-          options[:object_daddy] = v
-        end
-        
-        opt.on("--skip-timestamps", "Don't add timestamps to the migration file.") do |v|
-          options[:skip_timestamps] = v
-        end
-        
-        opt.on("--skip-migration", "Skip generation of migration file.") do |v|
-          options[:skip_migration] = v
-        end
-        
-        opt.on("--skip-tests", "Skip generation of tests.") do |v|
-          options[:skip_tests] = v
-        end
-      end
+      opt.separator ' '
+      opt.separator 'Model Options:'
       
-      def banner
-        ["Usage: #{$0} #{spec.name} ModelName",
-          "[field:type field:type]",
-          "[_indexes:name,owner_id+owner_type,active,...]",
-          "[--fixtures]",
-          "[--fgirl]",
-          "[--machinist]",
-          "[--odaddy]",
-          "[--skip_timestamps]",
-          "[--skip-migration]",
-          "[--skip-tests]"
-        ].join(' ')
+      opt.on("--skip-timestamps", "Don't add timestamps to the migration file.") do |v|
+        options[:skip_timestamps] = v
       end
       
-end
-
-module Rails
-  module Generator
-    class GeneratedAttribute
-      def default_for_fixture
-        @default ||= case type
-        when :integer                     then 1
-        when :float                       then 1.5
-        when :decimal                     then '9.99'
-        when :datetime, :timestamp, :time then Time.now.to_s(:db)
-        when :date                        then Date.today.to_s(:db)
-        when :string                      then 'Hello'
-        when :text                        then 'Lorem ipsum dolor sit amet...'
-        when :boolean                     then false
-        else
-          ''
-        end
+      opt.on("--skip-migration", "Skip generation of migration file.") do |v|
+        options[:skip_migration] = v
       end
-      def default_for_factory
-        @default ||= case type
-        when :integer                     then 1
-        when :float                       then 1.5
-        when :decimal                     then '9.99'
-        when :datetime, :timestamp, :time then 'Time.now'
-        when :date                        then 'Date.today'
-        when :string                      then '"Hello"'
-        when :text                        then '"Lorem ipsum dolor sit amet..."'
-        when :boolean                     then false
-        else
-          ''
-        end
+      
+      opt.on("--skip-tests", "Skip generation of tests.") do |v|
+        options[:skip_tests] = v
       end
+      
+      opt.separator ' '
     end
-  end
+    
+    def banner_args
+      [BANNER_ARGS, super].flatten.join(' ')
+    end
+    
+    def banner_options
+      [BANNER_OPTIONS, super].flatten.join(' ')
+    end
+    
+    def banner
+      [super, banner_args, banner_options].join(' ')
+    end
+    
 end