michel-dry_scaffold 0.3.5

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+NAME = "michel-dry_scaffold"
+SUMMARY = %Q{A DRYer scaffold generator for Rails. Generates dry semantic and standards compliant views, and dry RESTful controllers.}
+HOMEPAGE = "http://github.com/michel/#{NAME}/tree/master"
+AUTHOR = "Jonas Grimfelt,Michel de Graaf"
+EMAIL = "grimen@gmail.com, michel@re-invention.nl"
+SUPPORT_FILES = %w(README.textile TODO.textile CHANGELOG.textile)
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = NAME
+    gem.summary = SUMMARY
+    gem.description = SUMMARY
+    gem.homepage = HOMEPAGE
+    gem.author = AUTHOR
+    gem.email = EMAIL
+    
+    gem.require_paths = %w{lib}
+    gem.files = %w(MIT-LICENSE Rakefile) + SUPPORT_FILES + Dir.glob(File.join('{bin,config,generators,lib,rails,tasks}', '**', '*'))
+    gem.executables = %w(dscaffold dry_scaffold dmodel dry_model)
+    gem.extra_rdoc_files = SUPPORT_FILES
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc %Q{Run unit tests for "#{NAME}".}
+task :default => :test
+
+desc %Q{Run unit tests for "#{NAME}".}
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc %Q{Generate documentation for "#{NAME}".}
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = NAME
+  rdoc.options << '--line-numbers' << '--inline-source' << '--charset=UTF-8'
+  rdoc.rdoc_files.include(SUPPORT_FILES)
+  rdoc.rdoc_files.include(File.join('lib', '**', '*.rb'))
+end

data/TODO.textile

@@ -0,0 +1,40 @@
+h1. TODO
+
+h2. Next
+
+* 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, ...
+* Feature: Auto-detection of testing frameworks in working project.
+
+h2. Maybe
+
+* Feature: Check for overridden templates in: RAILS_ROOT/lib/dry_scaffold/templates/
+* 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:
+
+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

data/bin/dmodel

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+`ruby script/generate dmodel #{ARGV.join(' ')}`

data/bin/dry_model

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+`ruby script/generate dry_model #{ARGV.join(' ')}`

data/bin/dry_scaffold

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+`ruby script/generate dry_scaffold #{ARGV.join(' ')}`

data/bin/dscaffold

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+`ruby script/generate dscaffold #{ARGV.join(' ')}`

data/config/scaffold.yml

@@ -0,0 +1,34 @@
+---
+dry_scaffold:
+  args:
+    actions: index,show,new,edit,create,update,destroy
+    formats: html,js,xml,json
+  options:
+    formtastic: true
+    resourceful: true
+    search: true
+    pagination: true    
+    layout: false
+    views: true
+    helpers: true
+    tests: true
+    controller_tests: true
+    test_unit: true
+    shoulda: false
+    rspec: false
+    fixtures: true
+    fgirl: false
+    machinist: false
+    object_daddy: false
+dry_model:
+  options:
+    migration: true
+    timestamps: true
+    tests: true
+    test_unit: true
+    shoulda: false
+    rspec: false
+    fixtures: true
+    fgirl: false
+    machinist: false
+    object_daddy: false

data/generators/dmodel/dmodel_generator.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), '..', 'dry_model', 'dry_model_generator')
+
+class DmodelGenerator < DryModelGenerator
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    # Make Rails look for templates within generator "dry_model" path
+    @source_root = options[:source] || File.join(spec.path, '..', 'dry_model', 'templates')
+  end
+  
+  def usage_message
+    File.read(File.join(spec.path, '..', 'dry_model', 'USAGE')) rescue ''
+  end
+  
+end

data/generators/dry_model/USAGE

@@ -0,0 +1,9 @@
+NAME
+  dry_model/dmodel - A Rails scaffold generator that generates DRYer, cleaner, and more useful code - for models.
+  
+DESCRIPTION
+  A replacement for the Rails model generator - a part of the dry_generator toolset.
+  
+EXAMPLE
+  ./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

@@ -0,0 +1,134 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib', 'dry_generator'))
+
+class DryModelGenerator < DryGenerator
+  
+  # Banner: Generator arguments and options.
+  BANNER_ARGS = [
+      "[_indexes:field,field+field,field,...]"
+    ].freeze
+  BANNER_OPTIONS = [
+      "[--skip-timestamps]",
+      "[--skip-migration]"
+    ].freeze
+    
+  # Paths.
+  MODELS_PATH =           File.join('app', 'models').freeze
+  MIGRATIONS_PATH =       File.join('db', 'migrate').freeze
+  
+  attr_reader :indexes,
+              :references
+              
+  def initialize(runtime_args, runtime_options = {})
+    super(runtime_args, runtime_options)
+    
+    @attributes ||= []
+    args_for_model = []
+    
+    @args.each do |arg|
+      arg_entities = arg.split(':')
+      if arg =~ /^#{NON_ATTR_ARG_KEY_PREFIX}/
+        if arg =~ /^#{NON_ATTR_ARG_KEY_PREFIX}index/
+          arg_indexes = arg_entities[1].split(',').compact.uniq
+          @indexes = arg_indexes.collect do |index|
+            if index =~ /\+/
+              index.split('+').collect { |i| i.downcase.to_sym  }
+            else
+              index.downcase.to_sym
+            end
+          end
+        end
+      else
+        @attributes << Rails::Generator::GeneratedAttribute.new(*arg_entities)
+        args_for_model << arg
+      end
+    end
+    
+    @args = args_for_model
+    @references = attributes.select(&:reference?)
+    @options = DEFAULT_OPTIONS.merge(options)
+  end
+  
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_name, "#{class_name}Test"
+      
+      # Model.
+      m.directory File.join(MODELS_PATH, class_path)
+      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_TESTS_PATH[test_framework])
+        m.directory File.join(model_tests_path, class_path)
+        m.template File.join('models', 'tests', "#{test_framework}", 'unit_test.rb'),
+          File.join(model_tests_path, class_path, "#{file_name}_#{TEST_POST_FIX[test_framework]}.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, "#{table_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
+      
+      # Migration.
+      unless options[:skip_migration]
+        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
+    end
+  end
+  
+  protected
+    
+    def add_options!(opt)
+      super(opt)
+      
+      opt.separator ' '
+      opt.separator 'Model Options:'
+      
+      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
+      
+      opt.separator ' '
+    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

data/generators/dry_model/prototypes/active_record_migration.rb

@@ -0,0 +1,17 @@
+class CreateDucks < ActiveRecord::Migration
+  def self.up
+    create_table :resources, :force => true do |t|
+      t.string :name
+      t.text :description
+      
+      t.timestamps
+    end
+    
+    add_index :resources, :name
+    add_index :resources, [:name, :description]
+  end
+  
+  def self.down
+    drop_table :resources
+  end
+end

data/generators/dry_model/prototypes/active_record_model.rb

@@ -0,0 +1,9 @@
+class Duck < ActiveRecord::Base
+  
+  belongs_to :owner
+  
+  # object_daddy
+  generator_for(:name) { "AString" }
+  generator_for(:description) { "SomeText" }
+  
+end

data/generators/dry_model/prototypes/fixture_data/active_record_fixtures.yml

@@ -0,0 +1,3 @@
+default:
+  name: "AString"
+  description: "SomeText"

data/generators/dry_model/prototypes/fixture_data/factory_girl_factories.rb

@@ -0,0 +1,4 @@
+Factory.define :duck, :class => Duck do |f|
+  f.name "AString"
+  f.description "SomeText"
+end

data/generators/dry_model/prototypes/fixture_data/machinist_blueprints.rb

@@ -0,0 +1,8 @@
+Sham.define do
+  
+end
+
+Resource.blueprint do
+  name { "AString" }
+  description { "SomeText" }
+end

data/generators/dry_model/prototypes/tests/rspec/unit_test.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe DuckTest do
+  fixtures :ducks
+  
+  it "should be valid" do
+    DuckTest.new.should be_valid
+  end
+end

data/generators/dry_model/prototypes/tests/shoulda/unit_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class DuckTest < ActiveRecord::TestCase
+  
+  fixtures :ducks
+  
+  should_have_db_column :name
+  should_have_db_column :description
+  
+  context "A test context" do
+    setup do
+      
+    end
+    
+    should 'test something' do
+      assert true
+    end
+  end
+  
+end

data/generators/dry_model/prototypes/tests/test_unit/unit_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+class DuckTest < ActiveRecord::TestCase
+  
+  fixtures :ducks
+  
+  setup do
+    
+  end
+  
+  test 'something' do
+    assert true
+  end
+  
+end

data/generators/dry_model/templates/models/active_record_migration.rb

@@ -0,0 +1,23 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+      
+<% unless options[:skip_timestamps] -%>
+      t.timestamps
+<% end -%>
+    end
+<% unless indexes.blank? -%>
+    
+<% indexes.each do |index| -%>
+    add_index :<%= table_name %>, <%= index.is_a?(Array) ? "[:#{index.join(', :')}]" : ":#{index}" %>
+<% end -%>
+<% end -%>
+  end
+  
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/generators/dry_model/templates/models/active_record_model.rb

@@ -0,0 +1,15 @@
+class <%= class_name %> < ActiveRecord::Base
+  
+<% unless references.empty? -%>
+<% references.each do |attribute| -%>
+  belongs_to :<%= attribute.name %>
+<% end -%>
+  
+<% end -%>
+<% if options[:object_daddy] -%>
+<% attributes.each do |attribute| -%>
+  generator_for(:<%= attribute.name %>) { <%= attribute.default_for_factory %> }
+<% end -%>
+  
+<% end -%>
+end