From 3a68aec1a1c6329bfcbf0f87bdc2fbd75cb98feb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jos=C3=A9=20Valim?= <jose.valim@gmail.com>
Date: Sun, 17 Apr 2011 11:44:52 +0200
Subject: Make generators more modular, add hooks and improve test suite.

---
 Gemfile                                            |  1 +
 actionpack/lib/sprockets/railtie.rb                | 17 +++++++
 railties/lib/rails/generators.rb                   |  9 +++-
 .../generators/rails/assets/assets_generator.rb    | 48 +++++++++---------
 .../rails/scaffold/scaffold_generator.rb           | 21 +++++++-
 .../rails/scaffold/templates/scaffold.css          | 56 +++++++++++++++++++++
 .../rails/scaffold/templates/scaffold.css.scss     | 58 ++++++++++++++++++++++
 .../lib/rails/generators/rails/stylesheets/USAGE   |  5 --
 .../rails/stylesheets/stylesheets_generator.rb     | 23 ---------
 .../rails/stylesheets/templates/scaffold.css       | 56 ---------------------
 .../rails/stylesheets/templates/scaffold.css.scss  | 58 ----------------------
 .../test/generators/scaffold_generator_test.rb     | 52 ++++++++++++++++---
 .../test/generators/stylesheets_generator_test.rb  | 23 ---------
 13 files changed, 228 insertions(+), 199 deletions(-)
 create mode 100644 railties/lib/rails/generators/rails/scaffold/templates/scaffold.css
 create mode 100644 railties/lib/rails/generators/rails/scaffold/templates/scaffold.css.scss
 delete mode 100644 railties/lib/rails/generators/rails/stylesheets/USAGE
 delete mode 100644 railties/lib/rails/generators/rails/stylesheets/stylesheets_generator.rb
 delete mode 100644 railties/lib/rails/generators/rails/stylesheets/templates/scaffold.css
 delete mode 100644 railties/lib/rails/generators/rails/stylesheets/templates/scaffold.css.scss
 delete mode 100644 railties/test/generators/stylesheets_generator_test.rb

diff --git a/Gemfile b/Gemfile
index 6e5247d2b5..a94f3689bc 100644
--- a/Gemfile
+++ b/Gemfile
@@ -13,6 +13,7 @@ gem "rack-test", :git => "git://github.com/brynary/rack-test.git"
 
 gem "sprockets", :git => "git://github.com/sstephenson/sprockets.git"
 gem "coffee-script"
+gem "sass", ">= 3.0"
 
 gem "rake",  ">= 0.8.7"
 gem "mocha", ">= 0.9.8"
diff --git a/actionpack/lib/sprockets/railtie.rb b/actionpack/lib/sprockets/railtie.rb
index 5006a3a575..e87382f29d 100644
--- a/actionpack/lib/sprockets/railtie.rb
+++ b/actionpack/lib/sprockets/railtie.rb
@@ -3,6 +3,23 @@ require "sprockets"
 # TODO: Move this to sprockets-rails
 # If so, we can move the require to a Gemfile and remove assets.enabled
 class Sprockets::Railtie < Rails::Railtie
+  def self.using_coffee?
+    require 'coffee-script'
+    defined?(CoffeeScript)
+  rescue LoadError
+    false
+  end
+
+  def self.using_scss?
+    require 'sass'
+    defined?(Sass)
+  rescue LoadError
+    false
+  end
+
+  config.app_generators.javascript_engine :coffee if using_coffee?
+  config.app_generators.stylesheet_engine :scss   if using_scss?
+
   # Configure ActionController to use sprockets.
   initializer "sprockets.set_configs", :after => "action_controller.set_configs" do |app|
     ActiveSupport.on_load(:action_controller) do
diff --git a/railties/lib/rails/generators.rb b/railties/lib/rails/generators.rb
index be61b087f9..82171d0832 100644
--- a/railties/lib/rails/generators.rb
+++ b/railties/lib/rails/generators.rb
@@ -24,9 +24,11 @@ module Rails
       :rails => {
         :actions => '-a',
         :orm => '-o',
+        :javascript_engine => '-je',
         :resource_controller => '-c',
         :scaffold_controller => '-c',
         :stylesheets => '-y',
+        :stylesheet_engine => '-se',
         :template_engine => '-e',
         :test_framework => '-t'
       },
@@ -43,15 +45,18 @@ module Rails
 
     DEFAULT_OPTIONS = {
       :rails => {
+        :assets => true,
         :force_plural => false,
         :helper => true,
-        :assets => true,
-        :orm => nil,
         :integration_tool => nil,
+        :javascripts => true,
+        :javascript_engine => nil,
+        :orm => nil,
         :performance_tool => nil,
         :resource_controller => :controller,
         :scaffold_controller => :scaffold_controller,
         :stylesheets => true,
+        :stylesheet_engine => nil,
         :test_framework => nil,
         :template_engine => :erb
       },
diff --git a/railties/lib/rails/generators/rails/assets/assets_generator.rb b/railties/lib/rails/generators/rails/assets/assets_generator.rb
index 59239d1a03..80beb7abfe 100644
--- a/railties/lib/rails/generators/rails/assets/assets_generator.rb
+++ b/railties/lib/rails/generators/rails/assets/assets_generator.rb
@@ -1,36 +1,38 @@
 module Rails
   module Generators
-    # TODO: Add hooks for using other asset pipelines, like Less
     class AssetsGenerator < NamedBase
-      def create_asset_files
+      class_option :javascripts, :type => :boolean, :desc => "Generate javascripts"
+      class_option :stylesheets, :type => :boolean, :desc => "Generate stylesheets"
+
+      class_option :javascript_engine, :desc => "Engine for javascripts"
+      class_option :stylesheet_engine, :desc => "Engine for stylesheets"
+
+      def create_javascript_files
+        return unless options.javascripts?
         copy_file "javascript.#{javascript_extension}",
-          File.join('app/assets/javascripts', "#{file_name}.#{javascript_extension}")
+          File.join('app/assets/javascripts', class_path, "#{asset_name}.#{javascript_extension}")
+      end
 
+      def create_stylesheet_files
+        return unless options.stylesheets?
         copy_file "stylesheet.#{stylesheet_extension}",
-          File.join('app/assets/stylesheets', "#{file_name}.#{stylesheet_extension}")
+          File.join('app/assets/stylesheets', class_path, "#{asset_name}.#{stylesheet_extension}")
       end
-      
-    private
-      def javascript_extension
-        using_coffee? ? "js.coffee" : "js"
+
+      protected
+
+      def asset_name
+        file_name
       end
-    
-      def using_coffee?
-        require 'coffee-script'
-        defined?(CoffeeScript)
-      rescue LoadError
-        false
+
+      def javascript_extension
+        options.javascript_engine.present? ?
+          "js.#{options.javascript_engine}" : "js"
       end
-      
+
       def stylesheet_extension
-        using_sass? ? "css.scss" : "css"
-      end
-      
-      def using_sass?
-        require 'sass'
-        defined?(Sass)
-      rescue LoadError
-        false
+        options.stylesheet_engine.present? ?
+          "css.#{options.stylesheet_engine}" : "css"
       end
     end
   end
diff --git a/railties/lib/rails/generators/rails/scaffold/scaffold_generator.rb b/railties/lib/rails/generators/rails/scaffold/scaffold_generator.rb
index 779f933785..6eef0dbe5b 100644
--- a/railties/lib/rails/generators/rails/scaffold/scaffold_generator.rb
+++ b/railties/lib/rails/generators/rails/scaffold/scaffold_generator.rb
@@ -6,8 +6,27 @@ module Rails
       remove_hook_for :resource_controller
       remove_class_option :actions
 
+      class_option :stylesheets, :type => :boolean, :desc => "Generate stylesheets"
+      class_option :stylesheet_engine, :desc => "Engine for stylesheets"
+
       hook_for :scaffold_controller, :required => true
-      hook_for :stylesheets
+
+      def copy_stylesheets_file
+        if behavior == :invoke && options.stylesheets?
+          template "scaffold.#{stylesheet_extension}", "app/assets/stylesheets/scaffold.#{stylesheet_extension}"
+        end
+      end
+
+      hook_for :assets do |assets|
+        invoke assets, [controller_name]
+      end
+
+      private
+
+      def stylesheet_extension
+        options.stylesheet_engine.present? ?
+          "css.#{options.stylesheet_engine}" : "css"
+      end
     end
   end
 end
diff --git a/railties/lib/rails/generators/rails/scaffold/templates/scaffold.css b/railties/lib/rails/generators/rails/scaffold/templates/scaffold.css
new file mode 100644
index 0000000000..1ae7000299
--- /dev/null
+++ b/railties/lib/rails/generators/rails/scaffold/templates/scaffold.css
@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
diff --git a/railties/lib/rails/generators/rails/scaffold/templates/scaffold.css.scss b/railties/lib/rails/generators/rails/scaffold/templates/scaffold.css.scss
new file mode 100644
index 0000000000..45116b53f6
--- /dev/null
+++ b/railties/lib/rails/generators/rails/scaffold/templates/scaffold.css.scss
@@ -0,0 +1,58 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { 
+  color: #000;
+  &:visited { color: #666; }
+  &:hover { color: #fff; background-color:#000; }
+}
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+  
+  h2 {
+    text-align: left;
+    font-weight: bold;
+    padding: 5px 5px 5px 15px;
+    font-size: 12px;
+    margin: -7px;
+    margin-bottom: 0px;
+    background-color: #c00;
+    color: #fff;
+  }
+  
+  ul li {
+    font-size: 12px;
+    list-style: square;
+  }
+}
\ No newline at end of file
diff --git a/railties/lib/rails/generators/rails/stylesheets/USAGE b/railties/lib/rails/generators/rails/stylesheets/USAGE
deleted file mode 100644
index 59e5495d0b..0000000000
--- a/railties/lib/rails/generators/rails/stylesheets/USAGE
+++ /dev/null
@@ -1,5 +0,0 @@
-Description:
-    Copies scaffold stylesheets to public/stylesheets/.
-
-Examples:
-    `rails generate stylesheets`
diff --git a/railties/lib/rails/generators/rails/stylesheets/stylesheets_generator.rb b/railties/lib/rails/generators/rails/stylesheets/stylesheets_generator.rb
deleted file mode 100644
index d06db25292..0000000000
--- a/railties/lib/rails/generators/rails/stylesheets/stylesheets_generator.rb
+++ /dev/null
@@ -1,23 +0,0 @@
-module Rails
-  module Generators
-    class StylesheetsGenerator < Base
-      def copy_stylesheets_file
-        if behavior == :invoke
-          template "scaffold.#{stylesheet_extension}", "app/assets/stylesheets/scaffold.#{stylesheet_extension}"
-        end
-      end
-
-    private
-      def stylesheet_extension
-        using_sass? ? "css.scss" : "css"
-      end
-
-      def using_sass?
-        require 'sass'
-        defined?(Sass)
-      rescue LoadError
-        false
-      end
-    end
-  end
-end
diff --git a/railties/lib/rails/generators/rails/stylesheets/templates/scaffold.css b/railties/lib/rails/generators/rails/stylesheets/templates/scaffold.css
deleted file mode 100644
index 1ae7000299..0000000000
--- a/railties/lib/rails/generators/rails/stylesheets/templates/scaffold.css
+++ /dev/null
@@ -1,56 +0,0 @@
-body { background-color: #fff; color: #333; }
-
-body, p, ol, ul, td {
-  font-family: verdana, arial, helvetica, sans-serif;
-  font-size:   13px;
-  line-height: 18px;
-}
-
-pre {
-  background-color: #eee;
-  padding: 10px;
-  font-size: 11px;
-}
-
-a { color: #000; }
-a:visited { color: #666; }
-a:hover { color: #fff; background-color:#000; }
-
-div.field, div.actions {
-  margin-bottom: 10px;
-}
-
-#notice {
-  color: green;
-}
-
-.field_with_errors {
-  padding: 2px;
-  background-color: red;
-  display: table;
-}
-
-#error_explanation {
-  width: 450px;
-  border: 2px solid red;
-  padding: 7px;
-  padding-bottom: 0;
-  margin-bottom: 20px;
-  background-color: #f0f0f0;
-}
-
-#error_explanation h2 {
-  text-align: left;
-  font-weight: bold;
-  padding: 5px 5px 5px 15px;
-  font-size: 12px;
-  margin: -7px;
-  margin-bottom: 0px;
-  background-color: #c00;
-  color: #fff;
-}
-
-#error_explanation ul li {
-  font-size: 12px;
-  list-style: square;
-}
diff --git a/railties/lib/rails/generators/rails/stylesheets/templates/scaffold.css.scss b/railties/lib/rails/generators/rails/stylesheets/templates/scaffold.css.scss
deleted file mode 100644
index 45116b53f6..0000000000
--- a/railties/lib/rails/generators/rails/stylesheets/templates/scaffold.css.scss
+++ /dev/null
@@ -1,58 +0,0 @@
-body { background-color: #fff; color: #333; }
-
-body, p, ol, ul, td {
-  font-family: verdana, arial, helvetica, sans-serif;
-  font-size:   13px;
-  line-height: 18px;
-}
-
-pre {
-  background-color: #eee;
-  padding: 10px;
-  font-size: 11px;
-}
-
-a { 
-  color: #000;
-  &:visited { color: #666; }
-  &:hover { color: #fff; background-color:#000; }
-}
-
-div.field, div.actions {
-  margin-bottom: 10px;
-}
-
-#notice {
-  color: green;
-}
-
-.field_with_errors {
-  padding: 2px;
-  background-color: red;
-  display: table;
-}
-
-#error_explanation {
-  width: 450px;
-  border: 2px solid red;
-  padding: 7px;
-  padding-bottom: 0;
-  margin-bottom: 20px;
-  background-color: #f0f0f0;
-  
-  h2 {
-    text-align: left;
-    font-weight: bold;
-    padding: 5px 5px 5px 15px;
-    font-size: 12px;
-    margin: -7px;
-    margin-bottom: 0px;
-    background-color: #c00;
-    color: #fff;
-  }
-  
-  ul li {
-    font-size: 12px;
-    list-style: square;
-  }
-}
\ No newline at end of file
diff --git a/railties/test/generators/scaffold_generator_test.rb b/railties/test/generators/scaffold_generator_test.rb
index df787f61ba..4b07f8bcbe 100644
--- a/railties/test/generators/scaffold_generator_test.rb
+++ b/railties/test/generators/scaffold_generator_test.rb
@@ -79,8 +79,10 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
     assert_file "app/helpers/product_lines_helper.rb"
     assert_file "test/unit/helpers/product_lines_helper_test.rb"
 
-    # Stylesheets
-    assert_file "public/stylesheets/scaffold.css"
+    # Assets
+    assert_file "app/assets/stylesheets/scaffold.css.scss"
+    assert_file "app/assets/javascripts/product_lines.js.coffee"
+    assert_file "app/assets/stylesheets/product_lines.css.scss"
   end
 
   def test_scaffold_on_revoke
@@ -110,8 +112,10 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
     assert_no_file "app/helpers/product_lines_helper.rb"
     assert_no_file "test/unit/helpers/product_lines_helper_test.rb"
 
-    # Stylesheets (should not be removed)
-    assert_file "public/stylesheets/scaffold.css"
+    # Assets
+    assert_file "app/assets/stylesheets/scaffold.css.scss", /&:visited/
+    assert_no_file "app/assets/javascripts/product_lines.js.coffee"
+    assert_no_file "app/assets/stylesheets/product_lines.css.scss"
   end
 
   def test_scaffold_with_namespace_on_invoke
@@ -184,8 +188,10 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
     assert_file "app/helpers/admin/roles_helper.rb"
     assert_file "test/unit/helpers/admin/roles_helper_test.rb"
 
-    # Stylesheets
-    assert_file "public/stylesheets/scaffold.css"
+    # Assets
+    assert_file "app/assets/stylesheets/scaffold.css.scss", /&:visited/
+    assert_file "app/assets/javascripts/admin/roles.js.coffee"
+    assert_file "app/assets/stylesheets/admin/roles.css.scss"
   end
 
   def test_scaffold_with_namespace_on_revoke
@@ -216,8 +222,10 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
     assert_no_file "app/helpers/admin/roles_helper.rb"
     assert_no_file "test/unit/helpers/admin/roles_helper_test.rb"
 
-    # Stylesheets (should not be removed)
-    assert_file "public/stylesheets/scaffold.css"
+    # Assets
+    assert_file "app/assets/stylesheets/scaffold.css.scss"
+    assert_no_file "app/assets/javascripts/admin/roles.js.coffee"
+    assert_no_file "app/assets/stylesheets/admin/roles.css.scss"
   end
 
   def test_scaffold_generator_on_revoke_does_not_mutilate_legacy_map_parameter
@@ -235,6 +243,34 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
     assert_file "config/routes.rb", /\.routes\.draw do\s*\|map\|\s*$/
   end
 
+  def test_scaffold_generator_no_assets
+    run_generator [ "posts", "--no-assets" ]
+    assert_file "app/assets/stylesheets/scaffold.css.scss"
+    assert_no_file "app/assets/javascripts/posts.js.coffee"
+    assert_no_file "app/assets/stylesheets/posts.css.scss"
+  end
+
+  def test_scaffold_generator_no_stylesheets
+    run_generator [ "posts", "--no-stylesheets" ]
+    assert_no_file "app/assets/stylesheets/scaffold.css.scss"
+    assert_file "app/assets/javascripts/posts.js.coffee"
+    assert_no_file "app/assets/stylesheets/posts.css.scss"
+  end
+
+  def test_scaffold_generator_no_javascripts
+    run_generator [ "posts", "--no-javascripts" ]
+    assert_file "app/assets/stylesheets/scaffold.css.scss"
+    assert_no_file "app/assets/javascripts/posts.js.coffee"
+    assert_file "app/assets/stylesheets/posts.css.scss"
+  end
+
+  def test_scaffold_generator_no_negines
+    run_generator [ "posts", "--no-javascript-engine", "--no-stylesheet-engine" ]
+    assert_file "app/assets/stylesheets/scaffold.css"
+    assert_file "app/assets/javascripts/posts.js"
+    assert_file "app/assets/stylesheets/posts.css"
+  end
+
   def test_scaffold_generator_outputs_error_message_on_missing_attribute_type
     content = capture(:stderr) { run_generator ["post", "title:string", "body"]}
     assert_match(/Missing type for attribute 'body'/, content)
diff --git a/railties/test/generators/stylesheets_generator_test.rb b/railties/test/generators/stylesheets_generator_test.rb
deleted file mode 100644
index 4b86cdd1c7..0000000000
--- a/railties/test/generators/stylesheets_generator_test.rb
+++ /dev/null
@@ -1,23 +0,0 @@
-require 'generators/generators_test_helper'
-require 'rails/generators/rails/stylesheets/stylesheets_generator'
-
-class StylesheetsGeneratorTest < Rails::Generators::TestCase
-  include GeneratorsTestHelper
-
-  def test_copy_scss_stylesheet
-    self.generator_class.any_instance.stubs(:using_sass?).returns(true)
-    run_generator
-    assert_file "app/assets/stylesheets/scaffold.css.scss"
-  end
-
-  def test_copy_css_stylesheet
-    run_generator
-    assert_file "app/assets/stylesheets/scaffold.css"
-  end
-
-  def test_stylesheets_are_not_deleted_on_revoke
-    run_generator
-    run_generator [], :behavior => :revoke
-    assert_file "app/assets/stylesheets/scaffold.css"
-  end
-end
-- 
cgit v1.2.3