railties 4.1.0 → 4.2.10

data/lib/rails/generators/rails/model/USAGE

@@ -6,6 +6,11 @@ Description:
     model's attributes. Timestamps are added by default, so you don't have to
     specify them by hand as 'created_at:datetime updated_at:datetime'.
 
+    As a special case, specifying 'password:digest' will generate a
+    password_digest field of string type, and configure your generated model and
+    tests for use with ActiveModel has_secure_password (assuming the default ORM
+    and test framework are being used).
+
     You don't have to think up every attribute up front, but it helps to
     sketch out a few so you can start working with the model immediately.
 
@@ -17,7 +22,7 @@ Description:
 
     If you pass a namespaced model name (e.g. admin/account or Admin::Account)
     then the generator will create a module with a table_name_prefix method
-    to prefix the model's table name with the module name (e.g. admin_account)
+    to prefix the model's table name with the module name (e.g. admin_accounts)
 
 Available field types:
 
@@ -27,7 +32,8 @@ Available field types:
         `rails generate model post title:string body:text`
 
     will generate a title column with a varchar type and a body column with a text
-    type. You can use the following types:
+    type. If no type is specified the string type will be used by default.
+    You can use the following types:
 
         integer
         primary_key
@@ -40,7 +46,6 @@ Available field types:
         date
         time
         datetime
-        timestamp
 
     You can also consider `references` as a kind of type. For instance, if you run:
 
@@ -73,6 +78,10 @@ Available field types:
         `rails generate model user username:string{30}:uniq`
         `rails generate model product supplier:references{polymorphic}:index`
 
+    If you require a `password_digest` string column for use with
+    has_secure_password, you should specify `password:digest`:
+
+        `rails generate model user password:digest`
 
 Examples:
     `rails generate model account`

data/lib/rails/generators/rails/model/model_generator.rb

@@ -1,6 +1,10 @@
+require 'rails/generators/model_helpers'
+
 module Rails
   module Generators
     class ModelGenerator < NamedBase # :nodoc:
+      include Rails::Generators::ModelHelpers
+
       argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
       hook_for :orm, required: true
     end

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

@@ -241,7 +241,7 @@ task default: :test
         build(:leftovers)
       end
 
-      public_task :apply_rails_template, :run_bundle
+      public_task :apply_rails_template
 
       def name
         @name ||= begin
@@ -288,6 +288,10 @@ task default: :test
         options[:mountable]
       end
 
+      def skip_git?
+        options[:skip_git]
+      end
+
       def with_dummy_app?
         options[:skip_test_unit].blank? || options[:dummy_path] != 'test/dummy'
       end
@@ -304,6 +308,24 @@ task default: :test
         @camelized ||= name.gsub(/\W/, '_').squeeze('_').camelize
       end
 
+      def author
+        default = "TODO: Write your name"
+        if skip_git?
+          @author = default
+        else
+          @author = `git config user.name`.chomp rescue default
+        end
+      end
+
+      def email
+        default = "TODO: Write your email address"
+        if skip_git?
+          @email = default
+        else
+          @email = `git config user.email`.chomp rescue default
+        end
+      end
+
       def valid_const?
         if original_name =~ /[^0-9a-zA-Z_]+/
           raise Error, "Invalid plugin name #{original_name}. Please give a name which use only alphabetic or numeric or \"_\" characters."

data/lib/rails/generators/rails/plugin/templates/%name%.gemspec

@@ -7,8 +7,8 @@ require "<%= name %>/version"
 Gem::Specification.new do |s|
   s.name        = "<%= name %>"
   s.version     = <%= camelized %>::VERSION
-  s.authors     = ["TODO: Your name"]
-  s.email       = ["TODO: Your email"]
+  s.authors     = ["<%= author %>"]
+  s.email       = ["<%= email %>"]
   s.homepage    = "TODO"
   s.summary     = "TODO: Summary of <%= camelized %>."
   s.description = "TODO: Description of <%= camelized %>."
@@ -22,6 +22,6 @@ Gem::Specification.new do |s|
   <%= '# ' if options.dev? || options.edge? -%>s.add_dependency "rails", "~> <%= Rails::VERSION::STRING %>"
 <% unless options[:skip_active_record] -%>
 
-  s.add_development_dependency "<%= gem_for_database %>"
+  s.add_development_dependency "<%= gem_for_database[0] %>"
 <% end -%>
 end

data/lib/rails/generators/rails/plugin/templates/Gemfile

@@ -1,7 +1,7 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 <% if options[:skip_gemspec] -%>
-<%= '# ' if options.dev? || options.edge? -%>gem "rails", "~> <%= Rails::VERSION::STRING %>"
+<%= '# ' if options.dev? || options.edge? -%>gem 'rails', '~> <%= Rails::VERSION::STRING %>'
 <% else -%>
 # Declare your gem's dependencies in <%= name %>.gemspec.
 # Bundler will treat runtime dependencies like base dependencies, and
@@ -11,7 +11,7 @@ gemspec
 
 <% if options[:skip_gemspec] -%>
 group :development do
-  gem "<%= gem_for_database %>"
+  gem '<%= gem_for_database[0] %>'
 end
 <% else -%>
 # Declare any dependencies that are still in development here instead of in
@@ -31,13 +31,21 @@ end
 <% end -%>
 <%= gem.commented_out ? '# ' : '' %>gem '<%= gem.name %>'<%= %(, '#{gem.version}') if gem.version -%>
 <% if gem.options.any? -%>
-,<%= gem.padding(max_width) %><%= gem.options.map { |k,v|
+, <%= gem.options.map { |k,v|
   "#{k}: #{v.inspect}" }.join(', ') %>
 <% end -%>
 <% end -%>
 
 <% end -%>
 <% unless defined?(JRUBY_VERSION) -%>
-# To use debugger
-# gem 'debugger'
+# To use a debugger
+  <%- if RUBY_VERSION < '2.0.0' -%>
+# gem 'debugger', group: [:development, :test]
+  <%- else -%>
+# gem 'byebug', group: [:development, :test]
+  <%- end -%>
+<% end -%>
+
+<% if RUBY_PLATFORM.match(/bccwin|cygwin|emx|mingw|mswin|wince|java/) -%>
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
 <% end -%>

data/lib/rails/generators/rails/plugin/templates/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright <%= Date.today.year %> YOURNAME
+Copyright <%= Date.today.year %> <%= author %>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

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

@@ -19,6 +19,10 @@ APP_RAKEFILE = File.expand_path("../<%= dummy_path -%>/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 <% end %>
 
+<% if engine? -%>
+load 'rails/tasks/statistics.rake'
+<% end %>
+
 <% unless options[:skip_gemspec] -%>
 
 Bundler::GemHelper.install_tasks

data/lib/rails/generators/rails/plugin/templates/app/controllers/%name%/application_controller.rb.tt

@@ -1,4 +1,5 @@
 module <%= camelized %>
   class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
   end
 end

data/lib/rails/generators/rails/plugin/templates/rails/application.rb

@@ -7,7 +7,7 @@ require 'rails/all'
 <%= comment_if :skip_active_record %>require "active_record/railtie"
 require "action_controller/railtie"
 require "action_mailer/railtie"
-<%= comment_if :skip_action_view %>require "action_view/railtie"
+require "action_view/railtie"
 <%= comment_if :skip_sprockets %>require "sprockets/railtie"
 <%= comment_if :skip_test_unit %>require "rails/test_unit/railtie"
 <% end -%>

data/lib/rails/generators/rails/plugin/templates/rails/javascripts.js

@@ -2,12 +2,12 @@
 // listed below.
 //
 // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
 //
 // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
 // compiled file.
 //
-// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
 //= require_tree .

data/lib/rails/generators/rails/plugin/templates/rails/stylesheets.css

@@ -3,7 +3,7 @@
  * listed below.
  *
  * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
  *
  * You're free to add application-wide styles to this file and they'll appear at the bottom of the
  * compiled file so the styles you add here take precedence over styles defined in any styles

data/lib/rails/generators/rails/plugin/templates/test/integration/navigation_test.rb

@@ -1,10 +1,6 @@
 require 'test_helper'
 
 class NavigationTest < ActionDispatch::IntegrationTest
-<% unless options[:skip_active_record] -%>
-  fixtures :all
-<% end -%>
-
   # test "the truth" do
   #   assert true
   # end

data/lib/rails/generators/rails/plugin/templates/test/test_helper.rb

@@ -1,15 +1,25 @@
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require File.expand_path("../../<%= options[:dummy_path] -%>/config/environment.rb",  __FILE__)
+<% unless options[:skip_active_record] -%>
+ActiveRecord::Migrator.migrations_paths = [File.expand_path("../../<%= options[:dummy_path] -%>/db/migrate", __FILE__)]
+<% if options[:mountable] -%>
+ActiveRecord::Migrator.migrations_paths << File.expand_path('../../db/migrate', __FILE__)
+<% end -%>
+<% end -%>
 require "rails/test_help"
 
-Rails.backtrace_cleaner.remove_silencers!
+# Filter out Minitest backtrace while allowing backtrace from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
 
 # Load support files
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 # Load fixtures from the engine
-if ActiveSupport::TestCase.method_defined?(:fixture_path=)
+if ActiveSupport::TestCase.respond_to?(:fixture_path=)
   ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+  ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
+  ActiveSupport::TestCase.fixtures :all
 end

data/lib/rails/generators/rails/resource_route/resource_route_generator.rb

@@ -29,8 +29,10 @@ module Rails
           write("end", route_length - index)
         end
 
-        # route prepends two spaces onto the front of the string that is passed, this corrects that
-        route route_string[2..-1]
+        # route prepends two spaces onto the front of the string that is passed, this corrects that.
+        # Also it adds a \n to the end of each line, as route already adds that
+        # we need to correct that too.
+        route route_string[2..-2]
       end
 
       private

data/lib/rails/generators/rails/scaffold/USAGE

@@ -9,11 +9,16 @@ Description:
 
     Attributes are field arguments specifying the model's attributes. You can
     optionally pass the type and an index to each field. For instance:
-    "title body:text tracking_id:integer:uniq" will generate a title field of
+    'title body:text tracking_id:integer:uniq' will generate a title field of
     string type, a body with text type and a tracking_id as an integer with an
     unique index. "index" could also be given instead of "uniq" if one desires
     a non unique index.
 
+    As a special case, specifying 'password:digest' will generate a
+    password_digest field of string type, and configure your generated model,
+    controller, views, and test suite for use with ActiveModel
+    has_secure_password (assuming they are using Rails defaults).
+
     Timestamps are added by default, so you don't have to specify them by hand
     as 'created_at:datetime updated_at:datetime'.
 
@@ -33,3 +38,4 @@ Examples:
     `rails generate scaffold post`
     `rails generate scaffold post title body:text published:boolean`
     `rails generate scaffold purchase amount:decimal tracking_id:integer:uniq`
+    `rails generate scaffold user email:uniq password:digest`

data/lib/rails/generators/rails/scaffold_controller/scaffold_controller_generator.rb

@@ -7,6 +7,7 @@ module Rails
 
       check_class_collision suffix: "Controller"
 
+      class_option :helper, type: :boolean
       class_option :orm, banner: "NAME", type: :string, required: true,
                          desc: "ORM to generate the controller for"
 

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

@@ -1,5 +1,5 @@
 <% if namespaced? -%>
-require_dependency "<%= namespaced_file_path %>/application_controller"
+require_dependency "<%= namespaced_path %>/application_controller"
 
 <% end -%>
 <% module_namespacing do -%>

data/lib/rails/generators/resource_helpers.rb

@@ -1,14 +1,14 @@
 require 'rails/generators/active_model'
+require 'rails/generators/model_helpers'
 
 module Rails
   module Generators
     # Deal with controller names on scaffold and add some helpers to deal with
     # ActiveModel.
     module ResourceHelpers # :nodoc:
-      mattr_accessor :skip_warn
 
       def self.included(base) #:nodoc:
-        base.class_option :force_plural, type: :boolean, desc: "Forces the use of a plural ModelName"
+        base.send :include, Rails::Generators::ModelHelpers
         base.class_option :model_name, type: :string, desc: "ModelName to be used"
       end
 
@@ -21,15 +21,6 @@ module Rails
           assign_names!(self.name)
         end
 
-        if name == name.pluralize && name.singularize != name.pluralize && !options[:force_plural]
-          unless ResourceHelpers.skip_warn
-            say "Plural version of the model detected, using singularized version. Override with --force-plural."
-            ResourceHelpers.skip_warn = true
-          end
-          name.replace name.singularize
-          assign_names!(name)
-        end
-
         assign_controller_names!(controller_name.pluralize)
       end
 

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

@@ -2,6 +2,12 @@ require 'test_helper'
 
 <% module_namespacing do -%>
 class <%= class_name %>ControllerTest < ActionController::TestCase
+<% if mountable_engine? -%>
+  setup do
+    @routes = Engine.routes
+  end
+
+<% end -%>
 <% if actions.empty? -%>
   # test "the truth" do
   #   assert true

data/lib/rails/generators/test_unit/helper/helper_generator.rb

@@ -3,11 +3,7 @@ require 'rails/generators/test_unit'
 module TestUnit # :nodoc:
   module Generators # :nodoc:
     class HelperGenerator < Base # :nodoc:
-      check_class_collision suffix: "HelperTest"
-
-      def create_helper_files
-        template 'helper_test.rb', File.join('test/helpers', class_path, "#{file_name}_helper_test.rb")
-      end
+      # Rails does not generate anything here.
     end
   end
 end

data/lib/rails/generators/test_unit/job/job_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/test_unit'
+
+module TestUnit # :nodoc:
+  module Generators # :nodoc:
+    class JobGenerator < Base # :nodoc:
+      check_class_collision suffix: 'JobTest'
+
+      def create_test_file
+        template 'unit_test.rb.erb', File.join('test/jobs', class_path, "#{file_name}_job_test.rb")
+      end
+    end
+  end
+end

data/lib/rails/generators/test_unit/job/templates/unit_test.rb.erb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+<% module_namespacing do -%>
+class <%= class_name %>JobTest < ActiveJob::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end
+<% end -%>

data/lib/rails/generators/test_unit/scaffold/scaffold_generator.rb

@@ -15,6 +15,15 @@ module TestUnit # :nodoc:
                  File.join("test/controllers", controller_class_path, "#{controller_file_name}_controller_test.rb")
       end
 
+      def fixture_name
+        @fixture_name ||=
+          if mountable_engine?
+            "%s_%s" % [namespaced_path, table_name]
+          else
+            table_name
+          end
+      end
+
       private
 
         def attributes_hash

data/lib/rails/generators/test_unit/scaffold/templates/functional_test.rb

@@ -3,7 +3,10 @@ require 'test_helper'
 <% module_namespacing do -%>
 class <%= controller_class_name %>ControllerTest < ActionController::TestCase
   setup do
-    @<%= singular_table_name %> = <%= table_name %>(:one)
+    @<%= singular_table_name %> = <%= fixture_name %>(:one)
+<% if mountable_engine? -%>
+    @routes = Engine.routes
+<% end -%>
   end
 
   test "should get index" do

data/lib/rails/generators/testing/assertions.rb

@@ -1,3 +1,5 @@
+require 'shellwords'
+
 module Rails
   module Generators
     module Testing
@@ -21,7 +23,7 @@ module Rails
         #     end
         #   end
         def assert_file(relative, *contents)
-          absolute = File.expand_path(relative, destination_root).shellescape
+          absolute = File.expand_path(relative, destination_root)
           assert File.exist?(absolute), "Expected file #{relative.inspect} to exist, but does not"
 
           read = File.read(absolute) if block_given? || !contents.empty?

data/lib/rails/generators/testing/behaviour.rb

@@ -50,7 +50,7 @@ module Rails
         #   class AppGeneratorTest < Rails::Generators::TestCase
         #     tests AppGenerator
         #     destination File.expand_path("../tmp", File.dirname(__FILE__))
-        #     teardown :cleanup_destination_root
+        #     setup :prepare_destination
         #
         #     test "database.yml is not created when skipping Active Record" do
         #       run_generator %w(myapp --skip-active-record)
@@ -100,6 +100,23 @@ module Rails
             dirname, file_name = File.dirname(absolute), File.basename(absolute).sub(/\.rb$/, '')
             Dir.glob("#{dirname}/[0-9]*_*.rb").grep(/\d+_#{file_name}.rb$/).first
           end
+
+          def capture(stream)
+            stream = stream.to_s
+            captured_stream = Tempfile.new(stream)
+            stream_io = eval("$#{stream}")
+            origin_stream = stream_io.dup
+            stream_io.reopen(captured_stream)
+
+            yield
+
+            stream_io.rewind
+            return captured_stream.read
+          ensure
+            captured_stream.close
+            captured_stream.unlink
+            stream_io.reopen(origin_stream)
+          end
       end
     end
   end

data/lib/rails/generators.rb

@@ -156,10 +156,20 @@ module Rails
         args << "--help" if args.empty? && klass.arguments.any? { |a| a.required? }
         klass.start(args, config)
       else
-        puts "Could not find generator #{namespace}."
+        options     = sorted_groups.map(&:last).flatten
+        suggestions = options.sort_by {|suggested| levenshtein_distance(namespace.to_s, suggested) }.first(3)
+        msg =  "Could not find generator '#{namespace}'. "
+        msg << "Maybe you meant #{ suggestions.map {|s| "'#{s}'"}.to_sentence(last_word_connector: " or ") }\n"
+        msg << "Run `rails generate --help` for more options."
+        puts msg
       end
     end
 
+    # Returns an array of generator namespaces that are hidden.
+    # Generator namespaces may be hidden for a variety of reasons.
+    # Some are aliased such as "rails:migration" and can be
+    # invoked with the shorter "migration", others are private to other generators
+    # such as "css:scaffold".
     def self.hidden_namespaces
       @hidden_namespaces ||= begin
         orm      = options[:rails][:orm]
@@ -199,17 +209,6 @@ module Rails
 
     # Show help message with available generators.
     def self.help(command = 'generate')
-      lookup!
-
-      namespaces = subclasses.map{ |k| k.namespace }
-      namespaces.sort!
-
-      groups = Hash.new { |h,k| h[k] = [] }
-      namespaces.each do |namespace|
-        base = namespace.split(':').first
-        groups[base] << namespace
-      end
-
       puts "Usage: rails #{command} GENERATOR [args] [options]"
       puts
       puts "General options:"
@@ -222,20 +221,72 @@ module Rails
       puts "Please choose a generator below."
       puts
 
-      # Print Rails defaults first.
+      print_generators
+    end
+
+    def self.public_namespaces
+      lookup!
+      subclasses.map { |k| k.namespace }
+    end
+
+    def self.print_generators
+      sorted_groups.each { |b, n| print_list(b, n) }
+    end
+
+    def self.sorted_groups
+      namespaces = public_namespaces
+      namespaces.sort!
+      groups = Hash.new { |h,k| h[k] = [] }
+      namespaces.each do |namespace|
+        base = namespace.split(':').first
+        groups[base] << namespace
+      end
       rails = groups.delete("rails")
       rails.map! { |n| n.sub(/^rails:/, '') }
       rails.delete("app")
       rails.delete("plugin")
-      print_list("rails", rails)
 
       hidden_namespaces.each { |n| groups.delete(n.to_s) }
 
-      groups.sort.each { |b, n| print_list(b, n) }
+      [["rails", rails]] + groups.sort.to_a
     end
 
     protected
 
+      # This code is based directly on the Text gem implementation
+      # Returns a value representing the "cost" of transforming str1 into str2
+      def self.levenshtein_distance str1, str2
+        s = str1
+        t = str2
+        n = s.length
+        m = t.length
+
+        return m if (0 == n)
+        return n if (0 == m)
+
+        d = (0..m).to_a
+        x = nil
+
+        str1.each_char.each_with_index do |char1,i|
+          e = i+1
+
+          str2.each_char.each_with_index do |char2,j|
+            cost = (char1 == char2) ? 0 : 1
+            x = [
+                 d[j+1] + 1, # insertion
+                 e + 1,      # deletion
+                 d[j] + cost # substitution
+                ].min
+            d[j] = e
+            e = x
+          end
+
+          d[m] = x
+        end
+
+        return x
+      end
+
       # Prints a list of generators.
       def self.print_list(base, namespaces) #:nodoc:
         namespaces = namespaces.reject do |n|