railties 4.2.11.3 → 5.0.0.beta1

data/lib/rails/generators/named_base.rb

@@ -18,8 +18,8 @@ module Rails
         parse_attributes! if respond_to?(:attributes)
       end
 
-      # Defines the template that would be used for the migration file.
-      # The arguments include the source template file, the migration filename etc.
+      # Overrides <tt>Thor::Actions#template</tt> so it can tell if
+      # a template is currently being created.
       no_tasks do
         def template(source, *args, &block)
           inside_template do
@@ -99,7 +99,7 @@ module Rails
         end
 
         def class_name
-          (class_path + [file_name]).map!{ |m| m.camelize }.join('::')
+          (class_path + [file_name]).map!(&:camelize).join('::')
         end
 
         def human_name
@@ -129,6 +129,18 @@ module Rails
           uncountable? ? "#{plural_table_name}_index" : plural_table_name
         end
 
+        def show_helper
+          "#{singular_table_name}_url(@#{singular_table_name})"
+        end
+
+        def edit_helper
+          "edit_#{show_helper}"
+        end
+
+        def new_helper
+          "new_#{singular_table_name}_url"
+        end
+
         def singular_table_name
           @singular_table_name ||= (pluralize_table_names? ? table_name.singularize : table_name)
         end
@@ -141,11 +153,15 @@ module Rails
           @plural_file_name ||= file_name.pluralize
         end
 
+        def fixture_file_name
+          @fixture_file_name ||= (pluralize_table_names? ? plural_file_name : file_name)
+        end
+
         def route_url
           @route_url ||= class_path.collect {|dname| "/" + dname }.join + "/" + plural_file_name
         end
 
-        # Tries to retrieve the application name or simple return application.
+        # Tries to retrieve the application name or simply return application.
         def application_name
           if defined?(Rails) && Rails.application
             Rails.application.class.name.split('::').first.underscore
@@ -156,7 +172,7 @@ module Rails
 
         def assign_names!(name) #:nodoc:
           @class_path = name.include?('/') ? name.split('/') : name.split('::')
-          @class_path.map! { |m| m.underscore }
+          @class_path.map!(&:underscore)
           @file_name = @class_path.pop
         end
 

data/lib/rails/generators/rails/app/USAGE

@@ -12,4 +12,3 @@ Example:
     rails new ~/Code/Ruby/weblog
 
     This generates a skeletal Rails installation in ~/Code/Ruby/weblog.
-    See the README in the newly created application to get going.

data/lib/rails/generators/rails/app/app_generator.rb

@@ -38,7 +38,7 @@ module Rails
     end
 
     def readme
-      copy_file "README.rdoc", "README.rdoc"
+      copy_file "README.md", "README.md"
     end
 
     def gemfile
@@ -57,8 +57,7 @@ module Rails
       directory 'app'
 
       keep_file  'app/assets/images'
-      keep_file  'app/mailers'
-      keep_file  'app/models'
+      keep_file  'app/assets/javascripts/channels' unless options[:skip_action_cable]
 
       keep_file  'app/controllers/concerns'
       keep_file  'app/models/concerns'
@@ -83,21 +82,27 @@ module Rails
         directory "environments"
         directory "initializers"
         directory "locales"
+        directory "redis" unless options[:skip_action_cable]
       end
     end
 
     def config_when_updating
       cookie_serializer_config_exist = File.exist?('config/initializers/cookies_serializer.rb')
-      to_time_preserves_timezone_config_exist = File.exist?('config/initializers/to_time_preserves_timezone.rb')
+      callback_terminator_config_exist = File.exist?('config/initializers/callback_terminator.rb')
+      active_record_belongs_to_required_by_default_config_exist = File.exist?('config/initializers/active_record_belongs_to_required_by_default.rb')
 
       config
 
+      unless callback_terminator_config_exist
+        remove_file 'config/initializers/callback_terminator.rb'
+      end
+
       unless cookie_serializer_config_exist
         gsub_file 'config/initializers/cookies_serializer.rb', /json/, 'marshal'
       end
 
-      unless to_time_preserves_timezone_config_exist
-        remove_file 'config/initializers/to_time_preserves_timezone.rb'
+      unless active_record_belongs_to_required_by_default_config_exist
+        remove_file 'config/initializers/active_record_belongs_to_required_by_default.rb'
       end
     end
 
@@ -125,6 +130,7 @@ module Rails
 
     def test
       empty_directory_with_keep_file 'test/fixtures'
+      empty_directory_with_keep_file 'test/fixtures/files'
       empty_directory_with_keep_file 'test/controllers'
       empty_directory_with_keep_file 'test/mailers'
       empty_directory_with_keep_file 'test/models'
@@ -135,6 +141,7 @@ module Rails
     end
 
     def tmp
+      empty_directory_with_keep_file "tmp"
       empty_directory "tmp/cache"
       empty_directory "tmp/cache/assets"
     end
@@ -168,6 +175,9 @@ module Rails
       class_option :version, type: :boolean, aliases: "-v", group: :rails,
                              desc: "Show Rails version number and quit"
 
+      class_option :api, type: :boolean,
+                         desc: "Preconfigure smaller stack for API only apps"
+
       def initialize(*args)
         super
 
@@ -178,6 +188,10 @@ module Rails
         if !options[:skip_active_record] && !DATABASES.include?(options[:database])
           raise Error, "Invalid value for --database option. Supported for preconfiguration are: #{DATABASES.join(", ")}."
         end
+
+        # Force sprockets to be skipped when generating API only apps.
+        # Can't modify options hash as it's frozen by default.
+        self.options = options.merge(skip_sprockets: true, skip_javascript: true).freeze if options[:api]
       end
 
       public_task :set_default_accessors!
@@ -234,7 +248,7 @@ module Rails
       end
 
       def create_test_files
-        build(:test) unless options[:skip_test_unit]
+        build(:test) unless options[:skip_test]
       end
 
       def create_tmp_files
@@ -245,6 +259,28 @@ module Rails
         build(:vendor)
       end
 
+      def delete_app_assets_if_api_option
+        if options[:api]
+          remove_dir 'app/assets'
+          remove_dir 'lib/assets'
+          remove_dir 'tmp/cache/assets'
+          remove_dir 'vendor/assets'
+        end
+      end
+
+      def delete_app_helpers_if_api_option
+        if options[:api]
+          remove_dir 'app/helpers'
+          remove_dir 'test/helpers'
+        end
+      end
+
+      def delete_app_views_if_api_option
+        if options[:api]
+          remove_dir 'app/views'
+        end
+      end
+
       def delete_js_folder_skipping_javascript
         if options[:skip_javascript]
           remove_dir 'app/assets/javascripts'
@@ -257,6 +293,34 @@ module Rails
         end
       end
 
+      def delete_application_record_skipping_active_record
+        if options[:skip_active_record]
+          remove_file 'app/models/application_record.rb'
+        end
+      end
+
+      def delete_action_mailer_files_skipping_action_mailer
+        if options[:skip_action_mailer]
+          remove_file 'app/mailers/application_mailer.rb'
+          remove_file 'app/views/layouts/mailer.html.erb'
+          remove_file 'app/views/layouts/mailer.text.erb'
+        end
+      end
+
+      def delete_active_record_initializers_skipping_active_record
+        if options[:skip_active_record]
+          remove_file 'config/initializers/active_record_belongs_to_required_by_default.rb'
+        end
+      end
+
+      def delete_non_api_initializers_if_api_option
+        if options[:api]
+          remove_file 'config/initializers/session_store.rb'
+          remove_file 'config/initializers/cookies_serializer.rb'
+          remove_file 'config/initializers/request_forgery_protection.rb'
+        end
+      end
+
       def finish_template
         build(:leftovers)
       end
@@ -265,9 +329,7 @@ module Rails
       public_task :generate_spring_binstubs
 
       def run_after_bundle_callbacks
-        @after_bundle_callbacks.each do |callback|
-          callback.call
-        end
+        @after_bundle_callbacks.each(&:call)
       end
 
     protected
@@ -309,7 +371,9 @@ module Rails
         if app_const =~ /^\d/
           raise Error, "Invalid application name #{app_name}. Please give a name which does not start with numbers."
         elsif RESERVED_NAMES.include?(app_name)
-          raise Error, "Invalid application name #{app_name}. Please give a name which does not match one of the reserved rails words."
+          raise Error, "Invalid application name #{app_name}. Please give a " \
+                       "name which does not match one of the reserved rails " \
+                       "words: #{RESERVED_NAMES.join(", ")}"
         elsif Object.const_defined?(app_const_base)
           raise Error, "Invalid application name #{app_name}, constant #{app_const_base} is already in use. Please choose another application name."
         end

data/lib/rails/generators/rails/app/templates/Gemfile

@@ -12,37 +12,41 @@ source 'https://rubygems.org'
 <% end -%>
 <% end -%>
 
+# Use Puma as the app server
+gem 'puma'
+
 # Use ActiveModel has_secure_password
 # gem 'bcrypt', '~> 3.1.7'
 
-# Use Unicorn as the app server
-# gem 'unicorn'
-
 # Use Capistrano for deployment
 # gem 'capistrano-rails', group: :development
 
-<% unless defined?(JRUBY_VERSION) -%>
+<%- if options.api? -%>
+# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
+# gem 'rack-cors'
+
+<%- end -%>
+<% if RUBY_ENGINE == 'ruby' -%>
 group :development, :test do
-  <%- if RUBY_VERSION < '2.0.0' -%>
-  # Call 'debugger' anywhere in the code to stop execution and get a debugger console
-  gem 'debugger'
-  <%- else -%>
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'byebug'
-  <%- end -%>
 end
 
 group :development do
+<%- unless options.api? -%>
   # Access an IRB console on exception pages or by using <%%= console %> in views
-  gem 'web-console', '~> 2.0'
-<%- if spring_install? %>
+  <%- if options.dev? || options.edge? -%>
+  gem 'web-console', github: 'rails/web-console'
+  <%- else -%>
+  gem 'web-console', '~> 3.0'
+  <%- end -%>
+<%- end -%>
+<% if spring_install? -%>
   # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
   gem 'spring'
 <% end -%>
 end
 <% end -%>
 
-<% if RUBY_PLATFORM.match(/bccwin|cygwin|emx|mingw|mswin|wince|java/) -%>
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
-<% end -%>

data/lib/rails/generators/rails/app/templates/{README.rdoc → README.md}

@@ -1,4 +1,4 @@
-== README
+## README
 
 This README would normally document whatever steps are necessary to get the
 application up and running.
@@ -22,7 +22,3 @@ Things you may want to cover:
 * Deployment instructions
 
 * ...
-
-
-Please feel free to use a different markup language if you do not plan to run
-<tt>rake doc:app</tt>.

data/lib/rails/generators/rails/app/templates/app/assets/config/manifest.js.tt

@@ -0,0 +1,7 @@
+<% unless options.api? -%>
+//= link_tree ../images
+<% end -%>
+<% unless options.skip_javascript -%>
+//= link_directory ../javascripts .js
+<% end -%>
+//= link_directory ../stylesheets .css

data/lib/rails/generators/rails/app/templates/app/assets/javascripts/application.js.tt

@@ -5,7 +5,7 @@
 // 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.
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
 //
 // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.

data/lib/rails/generators/rails/app/templates/app/assets/javascripts/cable.coffee

@@ -0,0 +1,11 @@
+# Action Cable provides the framework to deal with WebSockets in Rails. 
+# You can generate new channels where WebSocket features live using the rails generate channel command.
+#
+# Turn on the cable connection by removing the comments after the require statements (and ensure it's also on in config/routes.rb).
+#
+#= require action_cable
+#= require_self
+#= require_tree ./channels
+#
+# @App ||= {}
+# App.cable = ActionCable.createConsumer()

data/lib/rails/generators/rails/app/templates/app/assets/stylesheets/application.css

@@ -6,9 +6,9 @@
  * 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
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
  *
  *= require_tree .
  *= require_self

data/lib/rails/generators/rails/app/templates/app/channels/application_cable/channel.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file. Action Cable runs in an EventMachine loop that does not support auto reloading.
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/lib/rails/generators/rails/app/templates/app/channels/application_cable/connection.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file. Action Cable runs in an EventMachine loop that does not support auto reloading.
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

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

@@ -1,5 +1,7 @@
-class ApplicationController < ActionController::Base
+class ApplicationController < ActionController::<%= options[:api] ? "API" : "Base" %>
+<%- unless options[:api] -%>
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.
   protect_from_forgery with: :exception
+<%- end -%>
 end

data/lib/rails/generators/rails/app/templates/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/lib/rails/generators/rails/app/templates/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/lib/rails/generators/rails/app/templates/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/lib/rails/generators/rails/app/templates/app/views/layouts/application.html.erb.tt

@@ -1,23 +1,26 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title><%= camelized %></title>
-  <%- if options[:skip_javascript] -%>
-  <%%= stylesheet_link_tag    'application', media: 'all' %>
-  <%- else -%>
-    <%- if gemfile_entries.any? { |m| m.name == 'turbolinks' } -%>
-  <%%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
-  <%%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
-    <%- else -%>
-  <%%= stylesheet_link_tag    'application', media: 'all' %>
-  <%%= javascript_include_tag 'application' %>
+  <head>
+    <title><%= camelized %></title>
+    <%%= csrf_meta_tags %>
+    <%- unless options[:skip_action_cable] -%>
+    <%%= action_cable_meta_tag %>
     <%- end -%>
-  <%- end -%>
-  <%%= csrf_meta_tags %>
-</head>
-<body>
 
-<%%= yield %>
+    <%- if options[:skip_javascript] -%>
+    <%%= stylesheet_link_tag    'application', media: 'all' %>
+    <%- else -%>
+      <%- if gemfile_entries.any? { |m| m.name == 'turbolinks' } -%>
+    <%%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+    <%%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+      <%- else -%>
+    <%%= stylesheet_link_tag    'application', media: 'all' %>
+    <%%= javascript_include_tag 'application' %>
+      <%- end -%>
+    <%- end -%>
+  </head>
 
-</body>
+  <body>
+    <%%= yield %>
+  </body>
 </html>

data/lib/rails/generators/rails/app/templates/app/views/layouts/mailer.html.erb.tt

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%%= yield %>
+  </body>
+</html>