railties 3.0.20 → 3.1.0.beta1

data/lib/rails/generators/rails/assets/USAGE

@@ -0,0 +1,20 @@
+Description:
+    Stubs out a new asset placeholders. Pass the asset name, either CamelCased
+    or under_scored.
+
+    To create assets within a folder, specify the assets name as a
+    path like 'parent/name'.
+
+    This generates a JavaScript stub in app/assets/javascripts and a stylesheet
+    stub in app/assets/stylesheets.
+    
+    If CoffeeScript is available, JavaScripts will be generated with the .coffee extension.
+    If Sass 3 is available, stylesheets will be generated with the .scss extension.
+
+Example:
+    `rails generate assets posts`
+
+    Posts assets.
+        Javascript:     app/assets/javascripts/posts.js
+        Stylesheet:     app/assets/stylesheets/posts.css
+

data/lib/rails/generators/rails/assets/assets_generator.rb

@@ -0,0 +1,39 @@
+module Rails
+  module Generators
+    class AssetsGenerator < NamedBase
+      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', 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', class_path, "#{asset_name}.#{stylesheet_extension}")
+      end
+
+      protected
+
+      def asset_name
+        file_name
+      end
+
+      def javascript_extension
+        options.javascript_engine.present? ?
+          "js.#{options.javascript_engine}" : "js"
+      end
+
+      def stylesheet_extension
+        options.stylesheet_engine.present? ?
+          "css.#{options.stylesheet_engine}" : "css"
+      end
+    end
+  end
+end

data/lib/rails/generators/rails/assets/templates/javascript.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/lib/rails/generators/rails/assets/templates/javascript.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/

data/lib/rails/generators/rails/assets/templates/stylesheet.css

@@ -0,0 +1,4 @@
+/* 
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/lib/rails/generators/rails/assets/templates/stylesheet.css.scss

@@ -0,0 +1,5 @@
+/* 
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+  You can use Sass (SCSS) here: http://sass-lang.com/
+*/

data/lib/rails/generators/rails/controller/controller_generator.rb

@@ -14,7 +14,7 @@ module Rails
         end
       end
 
-      hook_for :template_engine, :test_framework, :helper
+      hook_for :template_engine, :test_framework, :helper, :assets
     end
   end
 end

data/lib/rails/generators/rails/controller/templates/controller.rb

@@ -1,3 +1,4 @@
+<% module_namespacing do -%>
 class <%= class_name %>Controller < ApplicationController
 <% for action in actions -%>
   def <%= action %>
@@ -5,3 +6,4 @@ class <%= class_name %>Controller < ApplicationController
 
 <% end -%>
 end
+<% end -%>

data/lib/rails/generators/rails/generator/generator_generator.rb

@@ -14,9 +14,9 @@ module Rails
 
         def generator_dir
           if options[:namespace]
-            File.join("lib", "generators", file_name)
+            File.join("lib", "generators", regular_class_path, file_name)
           else
-            File.join("lib", "generators")
+            File.join("lib", "generators", regular_class_path)
           end
         end
 

data/lib/rails/generators/rails/helper/templates/helper.rb

@@ -1,2 +1,4 @@
+<% module_namespacing do -%>
 module <%= class_name %>Helper
 end
+<% end -%>

data/lib/rails/generators/rails/plugin/plugin_generator.rb

@@ -1,3 +1,4 @@
+
 require 'rails/generators/rails/generator/generator_generator'
 
 module Rails
@@ -5,6 +6,12 @@ module Rails
     class PluginGenerator < NamedBase
       class_option :tasks, :desc => "When supplied creates tasks base files."
 
+      def show_deprecation
+        return unless behavior == :invoke
+        message = "Plugin generator is deprecated, please use 'rails plugin new' command to generate plugin structure."
+        ActiveSupport::Deprecation.warn message
+      end
+
       check_class_collision
 
       def create_root_files

data/lib/rails/generators/rails/plugin/templates/Rakefile.tt

@@ -1,6 +1,6 @@
-require 'rake'
+#!/usr/bin/env rake
 require 'rake/testtask'
-require 'rdoc/task'
+require 'rake/rdoctask'
 
 desc 'Default: run unit tests.'
 task :default => :test
@@ -14,10 +14,10 @@ Rake::TestTask.new(:test) do |t|
 end
 
 desc 'Generate documentation for the <%= file_name %> plugin.'
-RDoc::Task.new(:rdoc) do |rdoc|
+Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = '<%= class_name %>'
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/lib/rails/generators/rails/plugin_new/USAGE

@@ -0,0 +1,10 @@
+Description:
+    The 'rails plugin new' command creates a skeleton for developing any
+    kind of Rails extension with ability to run tests using dummy Rails
+    application.
+
+Example:
+    rails plugin new ~/Code/Ruby/blog
+
+    This generates a skeletal Rails plugin in ~/Code/Ruby/blog.
+    See the README in the newly created plugin to get going.

data/lib/rails/generators/rails/plugin_new/plugin_new_generator.rb

@@ -0,0 +1,303 @@
+require 'active_support/core_ext/hash/slice'
+require "rails/generators/rails/app/app_generator"
+require 'date'
+
+module Rails
+  class PluginBuilder
+    def rakefile
+      template "Rakefile"
+    end
+
+    def app
+      if mountable?
+        directory "app"
+        template "#{app_templates_dir}/app/views/layouts/application.html.erb.tt",
+                 "app/views/layouts/#{name}/application.html.erb"
+        empty_directory_with_gitkeep "app/assets/images"
+      elsif full?
+        empty_directory_with_gitkeep "app/models"
+        empty_directory_with_gitkeep "app/controllers"
+        empty_directory_with_gitkeep "app/views"
+        empty_directory_with_gitkeep "app/helpers"
+        empty_directory_with_gitkeep "app/assets/images"
+      end
+    end
+
+    def readme
+      template "README.rdoc"
+    end
+
+    def gemfile
+      template "Gemfile"
+    end
+
+    def license
+      template "MIT-LICENSE"
+    end
+
+    def gemspec
+      template "%name%.gemspec"
+    end
+
+    def gitignore
+      copy_file "gitignore", ".gitignore"
+    end
+
+    def lib
+      template "lib/%name%.rb"
+      template "lib/tasks/%name%_tasks.rake"
+      if full?
+        template "lib/%name%/engine.rb"
+      end
+    end
+
+    def config
+      template "config/routes.rb" if full?
+    end
+
+    def test
+      template "test/test_helper.rb"
+      template "test/%name%_test.rb"
+      append_file "Rakefile", <<-EOF
+#{rakefile_test_tasks}
+
+task :default => :test
+      EOF
+      if full?
+        template "test/integration/navigation_test.rb"
+      end
+    end
+
+    PASSTHROUGH_OPTIONS = [
+      :skip_active_record, :skip_javascript, :database, :javascript, :quiet, :pretend, :force, :skip
+    ]
+
+    def generate_test_dummy(force = false)
+      opts = (options || {}).slice(*PASSTHROUGH_OPTIONS)
+      opts[:force] = force
+
+      invoke Rails::Generators::AppGenerator,
+        [ File.expand_path(dummy_path, destination_root) ], opts
+    end
+
+    def test_dummy_config
+      template "rails/boot.rb", "#{dummy_path}/config/boot.rb", :force => true
+      template "rails/application.rb", "#{dummy_path}/config/application.rb", :force => true
+      if mountable?
+        template "rails/routes.rb", "#{dummy_path}/config/routes.rb", :force => true
+      end
+    end
+
+    def test_dummy_clean
+      inside dummy_path do
+        remove_file ".gitignore"
+        remove_file "db/seeds.rb"
+        remove_file "doc"
+        remove_file "Gemfile"
+        remove_file "lib/tasks"
+        remove_file "app/assets/images/rails.png"
+        remove_file "public/index.html"
+        remove_file "public/robots.txt"
+        remove_file "README"
+        remove_file "test"
+        remove_file "vendor"
+      end
+    end
+
+    def stylesheets
+      if mountable?
+        copy_file "#{app_templates_dir}/app/assets/stylesheets/application.css",
+                  "app/assets/stylesheets/application.css"
+      elsif full?
+        empty_directory_with_gitkeep "app/assets/stylesheets"
+      end
+    end
+
+    def javascripts
+      return if options.skip_javascript?
+
+      if mountable?
+        copy_file "#{app_templates_dir}/app/assets/javascripts/application.js.tt",
+                  "app/assets/javascripts/application.js"
+      elsif full?
+        empty_directory_with_gitkeep "app/assets/javascripts"
+      end
+    end
+
+    def script(force = false)
+      directory "script", :force => force do |content|
+        "#{shebang}\n" + content
+      end
+      chmod "script", 0755, :verbose => false
+    end
+  end
+
+  module Generators
+    class PluginNewGenerator < AppBase
+      add_shared_options_for "plugin"
+
+      alias_method :plugin_path, :app_path
+
+      class_option :dummy_path,   :type => :string, :default => "test/dummy",
+                                  :desc => "Create dummy application at given path"
+
+      class_option :full,         :type => :boolean, :default => false,
+                                  :desc => "Generate rails engine with integration tests"
+
+      class_option :mountable,    :type => :boolean, :default => false,
+                                  :desc => "Generate mountable isolated application"
+
+      class_option :skip_gemspec, :type => :boolean, :default => false,
+                                  :desc => "Skip gemspec file"
+
+      def initialize(*args)
+        raise Error, "Options should be given after the plugin name. For details run: rails plugin --help" if args[0].blank?
+
+        @dummy_path = nil
+        super
+      end
+
+      public_task :create_root
+
+      def create_root_files
+        build(:readme)
+        build(:rakefile)
+        build(:gemspec)   unless options[:skip_gemspec]
+        build(:license)
+        build(:gitignore) unless options[:skip_git]
+        build(:gemfile)   unless options[:skip_gemfile]
+      end
+
+      def create_app_files
+        build(:app)
+      end
+
+      def create_config_files
+        build(:config)
+      end
+
+      def create_lib_files
+        build(:lib)
+      end
+
+      def create_public_stylesheets_files
+        build(:stylesheets)
+      end
+
+      def create_javascript_files
+        build(:javascripts)
+      end
+
+      def create_images_directory
+        build(:images)
+      end
+
+      def create_script_files
+        build(:script)
+      end
+
+      def create_test_files
+        build(:test) unless options[:skip_test_unit]
+      end
+
+      def create_test_dummy_files
+        return if options[:skip_test_unit]
+        create_dummy_app
+      end
+
+      def finish_template
+        build(:leftovers)
+      end
+
+      public_task :apply_rails_template, :bundle_if_dev_or_edge
+
+    protected
+
+      def app_templates_dir
+        "../../app/templates"
+      end
+
+      def create_dummy_app(path = nil)
+        dummy_path(path) if path
+
+        say_status :vendor_app, dummy_path
+        mute do
+          build(:generate_test_dummy)
+          store_application_definition!
+          build(:test_dummy_config)
+          build(:test_dummy_clean)
+          # ensure that script/rails has proper dummy_path
+          build(:script, true)
+        end
+      end
+
+      def full?
+        options[:full] || options[:mountable]
+      end
+
+      def mountable?
+        options[:mountable]
+      end
+
+      def self.banner
+        "rails plugin new #{self.arguments.map(&:usage).join(' ')} [options]"
+      end
+
+      def name
+        @name ||= File.basename(destination_root)
+      end
+
+      def camelized
+        @camelized ||= name.gsub(/\W/, '_').squeeze('_').camelize
+      end
+
+      def valid_const?
+        if camelized =~ /^\d/
+          raise Error, "Invalid plugin name #{name}. Please give a name which does not start with numbers."
+        elsif RESERVED_NAMES.include?(name)
+          raise Error, "Invalid plugin name #{name}. Please give a name which does not match one of the reserved rails words."
+        elsif Object.const_defined?(camelized)
+          raise Error, "Invalid plugin name #{name}, constant #{camelized} is already in use. Please choose another application name."
+        end
+      end
+
+      def application_definition
+        @application_definition ||= begin
+
+          dummy_application_path = File.expand_path("#{dummy_path}/config/application.rb", destination_root)
+          unless options[:pretend] || !File.exists?(dummy_application_path)
+            contents = File.read(dummy_application_path)
+            contents[(contents.index("module Dummy"))..-1]
+          end
+        end
+      end
+      alias :store_application_definition! :application_definition
+
+      def get_builder_class
+        defined?(::PluginBuilder) ? ::PluginBuilder : Rails::PluginBuilder
+      end
+
+      def rakefile_test_tasks
+        <<-RUBY
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+        RUBY
+      end
+
+      def dummy_path(path = nil)
+        @dummy_path = path if path
+        @dummy_path || options[:dummy_path]
+      end
+
+      def mute(&block)
+        shell.mute(&block)
+      end
+    end
+  end
+end