grimen-dry_scaffold 0.2.0 → 0.2.1

data/README.textile

@@ -6,7 +6,7 @@ h2. Description
 
 DryScaffold is a replacement for the Rails scaffold generator that generates code that most people end up deleting or rewriting anyway because of the unusable code. The scaffold concept is powerful, but it has more potential than generating messy and almost useless code. The goal with DryScaffold is to generate DRY, beautiful, and standards compliant code based on common patterns without adding a lot of magic.
 
-h3. Key concepts:
+h3. Key Concepts:
 
 * Controllers that are DRY, RESTful, no code-smells, following conventions, and implementing VERY common patterns.
 * Views that are DRY, semantic, standards compliant, valid, and more useful in development.
@@ -160,7 +160,7 @@ h3. More To Come... (TODO)
 These are things I have in mind:
 
 * Generation of Rails builder stubs automatically for formats atom/rss.
-* Read default scaffold options for current Rails porject from a config (say "config/scaffold.yml")
+* Make routing smarter; if route is already declared in _config/routes.rb_, then don't generate it (no duplication).
 * Break up into multiple generators as dependencies (like Rails generators): dry_controller, dry_views, dry_scaffold, ...
 
 h2. Setup
@@ -218,11 +218,15 @@ In: @config/environment.rb@
 
 h2. Usage
 
-<pre>./script/generate dry_scaffold ModelName [attribute:type attribute:type] [_actions:new,create,...] [_formats:html,json,...] [--skip-pagination] [--skip-resourceful] [--skip-formtastic] [--skip-views] [--skip-helpers] [--skip-tests] [--include-layout]</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-tests] [--include-layout] [--fixtures] [--fgirl] [--machinist] [--odaddy] [--skip-migration] [--skip-timestamps]</pre>
 
-...or use the alias (instead of @dry_scaffold@):
+...or use the alias @dscaffold@ instead of @dry_scaffold@.
 
-<pre>./script/generate dscaffold ...</pre>
+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>
+
+...or use the alias @dmodel@ instead of @dry_model@.
 
 h3. Model Name
 
@@ -242,7 +246,7 @@ Same as in the default scaffold/model generator; model attributes and database m
 
 h3. Controller Actions
 
-Usage:
+Example:
 
 <pre>_actions:new,create,quack,index,...</pre>
 
@@ -250,7 +254,7 @@ You can override what actions that should be generated directly - including cust
 
 NOTE: Sorry for the a bit ugly prefix (_), but I had to trick the Rails generator a bit to get this working for now. This is definitely something I want to fix sooner or later, but I skipped that for now with this small hack.
 
-h4. Default actions (REST)
+h4. Default Actions (REST)
 
 If no actions are specified, the following REST-actions will be generated by default:
 
@@ -269,13 +273,13 @@ These default actions can also be included using the alias symbol @*@, which mak
 <pre>_actions:quack     # => quack</pre>
 <pre>_actions:*,quack   # => show,index,new,edit,create,update,destroy,quack</pre>
 
-h4. Custom actions
+h4. Custom Actions
 
 The above REST actions are in many RESTful applications the only ones needed. Any other specified actions will generate empty action function stubs for manual implementation. No views will be generated for custom actions.
 
 h3. Controller Formats
 
-Usage:
+Example:
 
 <pre>_formats:html,xml,txt,...   # <=> _respond_to:html,xml,txt,...</pre>
 
@@ -283,7 +287,7 @@ You can override what respond_to-formats that should be generated directly - onl
 
 NOTE: Sorry for the a bit ugly prefix (_), but I had to trick the Rails generator a bit to get this working for now. This is definitely something I want to fix sooner or later, but I skipped that for now with this small hack.
 
-h4. Default formats
+h4. Default Formats
 
 If no formats are specified, the following formats will be generated by default:
 
@@ -299,7 +303,7 @@ Like for actions, these default respond_to-formats can also be included using th
 <pre>_formats:iphone     # => _formats:iphone</pre>
 <pre>_formats:*,iphone   # => _formats:html,js,xml,json,iphone</pre>
 
-h4. Additional formats
+h4. Additional Formats
 
 Also, default respond block stubs are generated for any of these formats - for each generated REST-action - if they are specified:
 
@@ -308,10 +312,28 @@ Also, default respond block stubs are generated for any of these formats - for e
 
 NOTE: Only for Non-InheritedResources controllers for now. 
 
-h4. Custom formats
+h4. Custom Formats
 
 The above formats are the most commonly used ones, and respond blocks are already implemented using Rails default dependencies. Any other specified formats (such as PDF, CSV, etc.) will generate empty respond block stubs for manual implementation with help of additional dependencies.
 
+h3. Model Indexes
+
+Example:
+
+If model attributes are specified as:
+
+<pre>name:string owner:reference</pre>
+
+...then we could do this (for polymorphic association):
+
+<pre>_indexes:owner_id                 # => (In migration:) add_index :duck, :owner_id</pre>
+
+...or in account for a polymorphic association:
+
+<pre>_indexes:owner_id+owner_type      # => (In migration:) add_index :duck, [:owner_id, :owner_type]</pre>
+
+NOTE: Of course...you need to specify indexes based on attributes that exists for this model, otherwise your migration will not be valid - DryScaffold is leaving this responsible to you.
+
 h3. Options/Flags
 
 Example:
@@ -339,6 +361,12 @@ h4. Model-specific
 
 As DryScaffold is built upon Rails generator, the default generator options is available as well. For more details; see Rails documentation.
 
+h3. Setting Defaults 
+
+You can set defaults for the generator args/options in @config/scaffold.yml@. To generate this file, simply do:
+
+<pre>rake dry_scaffold:config:generate</pre>
+
 h2. Examples
 
 No need for more samples here, just create a new Rails project, install DryScaffold and it's dependencies, and try it out!
@@ -349,8 +377,8 @@ For your inspiration, you could try the following:
 ./script/generate dry_scaffold Kangaroo name:string about:text --skip-formtastic
 ./script/generate dry_scaffold Duck name:string about:text _actions:new,create,index,quack
 ./script/generate dry_scaffold Parrot name:string about:text _formats:html,xml,yml
-./script/generate dry_scaffold Parrot name:string about:text _indexes:name --fgirl
-./script/generate dry_scaffold Parrot name:string about:text _indexes:name,name+about --fixtures</pre>
+./script/generate dry_scaffold GoldFish name:string about:text _indexes:name --fgirl
+./script/generate dry_scaffold Frog name:string about:text _indexes:name,name+about --fixtures</pre>
 
 ...or just go crazy!
 

data/TODO.textile

@@ -3,10 +3,10 @@ h1. TODO
 h2. Next
 
 * Feature: Generate Atom/RSS builder stubs for formats - if specified - atom/rss for index action. (Reference: http://gatezero.org/~tim/2008/04/22/generating-valid-atom-feeds-from-rails-202/)
-* Feature: Read default scaffold options from a config in: "RAILS_ROOT/config/scaffold.yml"
+* Feature: If route is already declared in config/routes.rb, then don't generate it.
 
 h2. Maybe later
 
 * Clean-up: Comment the code a bit more =)
-* Feature: Check for overridden templates in: RAILS_ROOT/lib/dry_scaffold/templates/
-* Refactor: Break up in different generators: dry_controller, dry_views, etc., and use as dependencies in dry_scaffold
+* 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/

data/generators/dry_model/dry_model_generator.rb

@@ -1,25 +1,35 @@
 require 'rubygems'
-begin
-  require 'factory_girl'
-  FACTORY_GIRL = true
-rescue MissingSourceFile
-  FACTORY_GIRL = false
-end
-begin
-  require 'machinist'
-  MACHINIST = true
-rescue MissingSourceFile
-  MACHINIST = false
-end
-begin
-  require 'object_daddy'
-  OBJECT_DADDY = true
-rescue MissingSourceFile
-  OBJECT_DADDY = false
+%w(factory_girl machinist object_daddy).each do |lib|
+  begin
+    require lib
+  rescue MissingSourceFile
+    eval("#{lib.upcase} = #{false}")
+  else
+    eval("#{lib.upcase} = #{false}")
+  end
 end
 
 class DryModelGenerator < Rails::Generator::NamedBase
   
+  # Load defaults from config file - default or custom.
+  begin
+    default_config_file = File.join(File.dirname(__FILE__), '..', '..', 'config', 'scaffold.yml')
+    custom_config_file = 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
+  
+  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['skip_timestamps'] || false,
+      :skip_migration => !CONFIG_OPTIONS['skip_migration'] || false,
+      :skip_tests => CONFIG_OPTIONS['skip_tests'] || false
+    }
+    
   MODELS_PATH =                 File.join('app', 'models').freeze
   MIGRATIONS_PATH =             File.join('db', 'migrate').freeze
   TESTS_PATH =                  File.join('test').freeze
@@ -29,15 +39,6 @@ class DryModelGenerator < Rails::Generator::NamedBase
   MACHINIST_FACTORIES_PATH =    File.join(TESTS_PATH, 'blueprints').freeze
   
   NON_ATTR_ARG_KEY_PREFIX =     '_'.freeze
-  
-  default_options :fixtures => false,
-                  :factory_girl => false,
-                  :machinist => false,
-                  :object_daddy => false,
-                  :faker => false,
-                  :skip_timestamps => false,
-                  :skip_migration => false,
-                  :skip_tests => false
                   
   attr_reader :indexes,
               :references
@@ -66,8 +67,10 @@ class DryModelGenerator < Rails::Generator::NamedBase
         args_for_model << arg
       end
     end
+    
     @args = args_for_model
     @references = attributes.select(&:reference?)
+    @options = DEFAULT_OPTIONS.merge(runtime_options)
   end
   
   def manifest

data/generators/dry_scaffold/dry_scaffold_generator.rb

@@ -1,25 +1,40 @@
 require 'rubygems'
-begin
-  require 'formtastic'
-  FORMTASTIC = true
-rescue
-  FORMTASTIC = false
-end
-begin
-  require 'inherited_resources'
-  INHERITED_RESOURCES = true
-rescue
-  INHERITED_RESOURCES = false
-end
-begin
-  require 'will_paginate'
-  WILL_PAGINATE = true
-rescue
-  WILL_PAGINATE = false
+%w(will_paginate formtastic inherited_resources).each do |lib|
+  begin
+    require lib
+  rescue MissingSourceFile
+    eval("#{lib.upcase} = #{false}")
+  else
+    eval("#{lib.upcase} = #{false}")
+  end
 end
 
 class DryScaffoldGenerator < Rails::Generator::NamedBase
   
+  # Load defaults from config file - default or custom.
+  begin
+    default_config_file = File.join(File.dirname(__FILE__), '..', '..', 'config', 'scaffold.yml')
+    custom_config_file = 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_ARGS = config['dry_scaffold']['args'] rescue nil
+    CONFIG_OPTIONS = config['dry_scaffold']['options'] rescue nil
+  end
+  
+  DEFAULT_ARGS = {
+      :actions => (CONFIG_ARGS['actions'].split(',').compact.uniq.collect { |v| v.downcase.to_sym } rescue nil),
+      :formats => (CONFIG_ARGS['formats'].split(',').compact.uniq.collect { |v| v.downcase.to_sym } rescue nil)
+    }
+  DEFAULT_OPTIONS = {
+      :resourceful => CONFIG_OPTIONS['resourceful'] || INHERITED_RESOURCES,
+      :formtastic => CONFIG_OPTIONS['formtastic'] || FORMTASTIC,
+      :pagination => CONFIG_OPTIONS['pagination'] || WILL_PAGINATE,
+      :skip_tests => !CONFIG_OPTIONS['tests'] || false,
+      :skip_helpers => !CONFIG_OPTIONS['helpers'] || false,
+      :skip_views => !CONFIG_OPTIONS['views'] || false,
+      :generate_layout => CONFIG_OPTIONS['layout'] || false
+    }
+    
   DEFAULT_RESPOND_TO_FORMATS =          [:html, :xml, :json].freeze
   DEFAULT_MEMBER_ACTIONS =              [:show, :new, :edit, :create, :update, :destroy].freeze
   DEFAULT_MEMBER_AUTOLOAD_ACTIONS =     (DEFAULT_MEMBER_ACTIONS - [:new, :create])
@@ -50,14 +65,6 @@ class DryScaffoldGenerator < Rails::Generator::NamedBase
     :edit   => [:form]
   }.freeze
   
-  default_options :resourceful => INHERITED_RESOURCES,
-                  :formtastic => FORMTASTIC,
-                  :pagination => WILL_PAGINATE,
-                  :skip_tests => false,
-                  :skip_helpers => false,
-                  :skip_views => false,
-                  :include_layout => false
-                  
   attr_reader   :controller_name,
                 :controller_class_path,
                 :controller_file_path,
@@ -72,7 +79,8 @@ class DryScaffoldGenerator < Rails::Generator::NamedBase
                 :model_plural_name,
                 :view_template_format,
                 :actions,
-                :formats
+                :formats,
+                :config
                 
   alias_method  :controller_file_name, :controller_underscore_name
   alias_method  :controller_table_name, :controller_plural_name
@@ -109,7 +117,9 @@ class DryScaffoldGenerator < Rails::Generator::NamedBase
           # Replace a '*' with default respond_to-formats
           arg_entities[1].gsub!(/\*/, DEFAULT_RESPOND_TO_FORMATS.join(','))
           arg_formats = arg_entities[1].split(',').compact.uniq
-          @formats = arg_formats.collect { |format| format.downcases.to_sym }
+          @formats = arg_formats.collect { |format| format.downcase.to_sym }
+        elsif arg =~ /^#{NON_ATTR_ARG_KEY_PREFIX}index/
+          @args_for_model << arg
         end
       else
         @attributes << Rails::Generator::GeneratedAttribute.new(*arg_entities)
@@ -117,8 +127,9 @@ class DryScaffoldGenerator < Rails::Generator::NamedBase
       end
     end
     
-    @actions ||= DEFAULT_CONTROLLER_ACTIONS
-    @formats ||= DEFAULT_RESPOND_TO_FORMATS
+    @actions ||= DEFAULT_ARGS[:actions] || DEFAULT_CONTROLLER_ACTIONS
+    @formats ||= DEFAULT_ARGS[:formats] || DEFAULT_RESPOND_TO_FORMATS
+    @options = DEFAULT_OPTIONS.merge(runtime_options)
   end
   
   def manifest
@@ -171,7 +182,7 @@ class DryScaffoldGenerator < Rails::Generator::NamedBase
       end
       
       # Layout.
-      if options[:include_layout]
+      if options[:generate_layout]
         m.template "view_layout.html.#{view_template_format}",
           File.join(LAYOUTS_PATH, "#{controller_file_name}.html.#{view_template_format}")
       end
@@ -180,17 +191,7 @@ class DryScaffoldGenerator < Rails::Generator::NamedBase
       m.route_resources controller_file_name
       
       # Models - use Rails default generator.
-      m.dependency 'dry_model',
-        [name] + @args_for_model +
-        options.slice(:skip_tests,
-            :fixtures,
-            :factory_girl,
-            :machinist,
-            :object_daddy,
-            :skip_timestamps,
-            :skip_migration
-          ),
-        :collision => :skip
+      m.dependency 'dry_model', [name] + @args_for_model, :collision => :skip
     end
   end
   
@@ -213,6 +214,8 @@ class DryScaffoldGenerator < Rails::Generator::NamedBase
       opt.separator ''
       opt.separator 'Options:'
       
+      ### CONTROLLERS + VIEWS
+      
       opt.on('--skip-pagination',
         "Skip 'will_paginate' for collections in controllers and views, wich requires gem 'mislav-will_paginate'.") do |v|
         options[:pagination] = !v
@@ -229,7 +232,7 @@ class DryScaffoldGenerator < Rails::Generator::NamedBase
       end
       
       opt.on('--layout', "Generate layout.") do |v|
-        options[:include_layout] = v
+        options[:generate_layout] = v
       end
       
       opt.on('--skip-views', "Skip generation of views.") do |v|
@@ -240,10 +243,14 @@ class DryScaffoldGenerator < Rails::Generator::NamedBase
         options[:skip_helpers] = v
       end
       
+      ### CONTROLLERS + MODELS
+      
       opt.on('--skip-tests', "Skip generation of tests.") do |v|
         options[:skip_tests] = v
       end
       
+      ### MODELS ONLY
+      
       opt.on('--fixtures', "Model: Generate fixtures.") do |v|
         options[:fixtures] = v
       end

data/tasks/dry_scaffold.rake

@@ -1,25 +1,47 @@
 namespace :dry_scaffold do
   
+  GEM_ROOT = File.join(File.dirname(__FILE__), '..').freeze
+  
   desc "Setup for this plugin/gem."
   task :setup => :environment do
     Rake::Task['dry_scaffold:dependencies:install'].invoke
+    Rake::Task['dry_scaffold:config:generate'].invoke
+  end
+  
+  namespace :config do
+    
+    desc "Generate a dry_scaffold config file as 'RAILS_ROOT/config/scaffold.yml'"
+    task :generate do
+      template = File.join(GEM_ROOT, 'config', 'scaffold.yml')
+      to_file = File.join(Rails.root, 'config', 'scaffold.yml')
+      
+      `cp #{template} #{to_file}`
+      
+      if  File.exists?(to_file)
+        puts "Generated config file: '#{to_file}'"
+      else
+        puts "Could not create the config file. Hint: Try with sudo." 
+      end
+    end
+    
   end
   
   namespace :dependencies do
     
-    require File.join(File.dirname(__FILE__), '..', 'lib', 'setup_helper')
+    require File.join(GEM_ROOT, 'lib', 'setup_helper')
     include SetupHelper
     
     GEMS = [:haml, :will_paginate, :'josevalim-inherited_resources', :'justinfrench-formtastic'].freeze
     PLUGINS = [].freeze
     
-    puts "---------------------------------------"
-    puts " Dependencies"
-    puts "---------------------------------------"
-    
     desc "Install dependencies for fully advantage of this generator."
-    puts "Installing gems..."
     task :install => :environment do
+      
+      puts "---------------------------------------"
+      puts " Dependencies"
+      puts "---------------------------------------"
+      puts "Installing gems..."
+      
       # Install gems
       unless GEMS.empty?
         puts "GEMS: #{GEMS.to_sentence}" 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: grimen-dry_scaffold
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Jonas Grimfelt
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-01 00:00:00 -07:00
+date: 2009-05-03 00:00:00 -07:00
 default_executable: 
 dependencies: []