railties 5.1.7 → 5.2.0.beta1

data/lib/rails/generators/rails/app/templates/config/storage.yml.tt

@@ -0,0 +1,35 @@
+test:
+  service: Disk
+  root: <%%= Rails.root.join("tmp/storage") %>
+
+local:
+  service: Disk
+  root: <%%= Rails.root.join("storage") %>
+
+# Use rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
+# amazon:
+#   service: S3
+#   access_key_id: <%%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+#   secret_access_key: <%%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+#   region: us-east-1
+#   bucket: your_own_bucket
+
+# Remember not to checkin your GCS keyfile to a repository
+# google:
+#   service: GCS
+#   project: your_project
+#   keyfile: <%%= Rails.root.join("path/to/gcs.keyfile") %>
+#   bucket: your_own_bucket
+
+# Use rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
+# microsoft:
+#   service: AzureStorage
+#   path: your_azure_storage_path
+#   storage_account_name: your_account_name
+#   storage_access_key: <%%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
+#   container: your_container_name
+
+# mirror:
+#   service: Mirror
+#   primary: local
+#   mirrors: [ amazon, google, microsoft ]

data/lib/rails/generators/rails/app/templates/{gitignore → gitignore.tt}

@@ -21,9 +21,17 @@
 !/tmp/.keep
 <% end -%>
 
-<% unless options[:skip_yarn] -%>
+<% unless skip_active_storage? -%>
+# Ignore uploaded files in development
+/storage/*
+
+<% end -%>
+<% unless options.skip_yarn? -%>
 /node_modules
 /yarn-error.log
 
+<% end -%>
+<% unless options.api? -%>
+/public/assets
 <% end -%>
 .byebug_history

data/lib/rails/generators/rails/app/templates/ruby-version.tt

@@ -0,0 +1 @@
+<%= RUBY_VERSION -%>

data/lib/rails/generators/rails/app/templates/test/{test_helper.rb → test_helper.rb.tt}

@@ -1,5 +1,4 @@
-ENV['RAILS_ENV'] ||= 'test'
-require File.expand_path('../../config/environment', __FILE__)
+require_relative '../config/environment'
 require 'rails/test_help'
 
 class ActiveSupport::TestCase

data/lib/rails/generators/rails/application_record/application_record_generator.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rails
+  module Generators
+    class ApplicationRecordGenerator < Base # :nodoc:
+      hook_for :orm, required: true, desc: "ORM to be invoked"
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rails
   module Generators
     class AssetsGenerator < NamedBase # :nodoc:

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

@@ -1,4 +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/controller/controller_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rails
   module Generators
     class ControllerGenerator < NamedBase # :nodoc:
@@ -13,12 +15,8 @@ module Rails
       end
 
       def add_routes
-        unless options[:skip_routes]
-          actions.reverse_each do |action|
-            # route prepends two spaces onto the front of the string that is passed, this corrects that.
-            route indent(generate_routing_code(action), 2)[2..-1]
-          end
-        end
+        return if options[:skip_routes]
+        route generate_routing_code
       end
 
       hook_for :template_engine, :test_framework, :helper, :assets
@@ -26,14 +24,15 @@ module Rails
       private
 
         # This method creates nested route entry for namespaced resources.
-        # For eg. rails g controller foo/bar/baz index
+        # For eg. rails g controller foo/bar/baz index show
         # Will generate -
         # namespace :foo do
         #   namespace :bar do
         #     get 'baz/index'
+        #     get 'baz/show'
         #   end
         # end
-        def generate_routing_code(action)
+        def generate_routing_code
           depth = 0
           lines = []
 
@@ -47,7 +46,10 @@ module Rails
 
           # Create route
           #     get 'baz/index'
-          lines << indent(%{get '#{file_name}/#{action}'\n}, depth * 2)
+          #     get 'baz/show'
+          actions.each do |action|
+            lines << indent(%{get '#{file_name}/#{action}'\n}, depth * 2)
+          end
 
           # Create `end` ladder
           #   end

data/lib/rails/generators/rails/credentials/credentials_generator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+require "rails/generators/rails/master_key/master_key_generator"
+require "active_support/encrypted_configuration"
+
+module Rails
+  module Generators
+    class CredentialsGenerator < Base
+      def add_credentials_file
+        unless credentials.exist?
+          template = credentials_template
+
+          say "Adding #{credentials.content_path} to store encrypted credentials."
+          say ""
+          say "The following content has been encrypted with the Rails master key:"
+          say ""
+          say template, :on_green
+          say ""
+
+          add_credentials_file_silently(template)
+
+          say "You can edit encrypted credentials with `bin/rails credentials:edit`."
+          say ""
+        end
+      end
+
+      def add_credentials_file_silently(template = nil)
+        credentials.write(credentials_template)
+      end
+
+      private
+        def credentials
+          ActiveSupport::EncryptedConfiguration.new(
+            config_path: "config/credentials.yml.enc",
+            key_path: "config/master.key",
+            env_key: "RAILS_MASTER_KEY"
+          )
+        end
+
+        def credentials_template
+          "# aws:\n#  access_key_id: 123\n#  secret_access_key: 345\n\n" +
+          "# Used as the base secret for all MessageVerifiers in Rails, including the one protecting cookies.\n" +
+          "secret_key_base: #{SecureRandom.hex(64)}"
+        end
+    end
+  end
+end

data/lib/rails/generators/rails/encrypted_file/encrypted_file_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+require "active_support/encrypted_file"
+
+module Rails
+  module Generators
+    class EncryptedFileGenerator < Base
+      def add_encrypted_file(file_path, key_path)
+        unless File.exist?(file_path)
+          say "Adding #{file_path} to store encrypted content."
+          say ""
+          say "The following content has been encrypted with the encryption key:"
+          say ""
+          say template, :on_green
+          say ""
+
+          add_encrypted_file_silently(file_path, key_path)
+
+          say "You can edit encrypted file with `bin/rails encrypted:edit #{file_path}`."
+          say ""
+        end
+      end
+
+      def add_encrypted_file_silently(file_path, key_path, template = encrypted_file_template)
+        unless File.exist?(file_path)
+          setup = { content_path: file_path, key_path: key_path, env_key: "RAILS_MASTER_KEY" }
+          ActiveSupport::EncryptedFile.new(setup).write(template)
+        end
+      end
+
+      private
+        def encrypted_file_template
+          "# aws:\n#  access_key_id: 123\n#  secret_access_key: 345\n\n"
+        end
+    end
+  end
+end

data/lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "rails/generators/base"
+require "active_support/encrypted_file"
+
+module Rails
+  module Generators
+    class EncryptionKeyFileGenerator < Base
+      def add_key_file(key_path)
+        key_path = Pathname.new(key_path)
+
+        unless key_path.exist?
+          key = ActiveSupport::EncryptedFile.generate_key
+
+          log "Adding #{key_path} to store the encryption key: #{key}"
+          log ""
+          log "Save this in a password manager your team can access."
+          log ""
+          log "If you lose the key, no one, including you, can access anything encrypted with it."
+
+          log ""
+          add_key_file_silently(key_path, key)
+          log ""
+        end
+      end
+
+      def add_key_file_silently(key_path, key = nil)
+        create_file key_path, key || ActiveSupport::EncryptedFile.generate_key
+      end
+
+      def ignore_key_file(key_path, ignore: key_ignore(key_path))
+        if File.exist?(".gitignore")
+          unless File.read(".gitignore").include?(ignore)
+            log "Ignoring #{key_path} so it won't end up in Git history:"
+            log ""
+            append_to_file ".gitignore", ignore
+            log ""
+          end
+        else
+          log "IMPORTANT: Don't commit #{key_path}. Add this to your ignore file:"
+          log ignore, :on_green
+          log ""
+        end
+      end
+
+      def ignore_key_file_silently(key_path, ignore: key_ignore(key_path))
+        append_to_file ".gitignore", ignore if File.exist?(".gitignore")
+      end
+
+      private
+        def key_ignore(key_path)
+          [ "", "/#{key_path}", "" ].join("\n")
+        end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rails
   module Generators
     class GeneratorGenerator < NamedBase # :nodoc:

data/lib/rails/generators/rails/generator/templates/%file_name%_generator.rb.tt

@@ -1,3 +1,3 @@
 class <%= class_name %>Generator < Rails::Generators::NamedBase
-  source_root File.expand_path('../templates', __FILE__)
+  source_root File.expand_path('templates', __dir__)
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rails
   module Generators
     class HelperGenerator < NamedBase # :nodoc:

data/lib/rails/generators/rails/integration_test/integration_test_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rails
   module Generators
     class IntegrationTestGenerator < NamedBase # :nodoc:

data/lib/rails/generators/rails/master_key/master_key_generator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "rails/generators/base"
+require "rails/generators/rails/encryption_key_file/encryption_key_file_generator"
+require "active_support/encrypted_file"
+
+module Rails
+  module Generators
+    class MasterKeyGenerator < Base
+      MASTER_KEY_PATH = Pathname.new("config/master.key")
+
+      def add_master_key_file
+        unless MASTER_KEY_PATH.exist?
+          key = ActiveSupport::EncryptedFile.generate_key
+
+          log "Adding #{MASTER_KEY_PATH} to store the master encryption key: #{key}"
+          log ""
+          log "Save this in a password manager your team can access."
+          log ""
+          log "If you lose the key, no one, including you, can access anything encrypted with it."
+
+          log ""
+          add_master_key_file_silently(key)
+          log ""
+        end
+      end
+
+      def add_master_key_file_silently(key = nil)
+        key_file_generator.add_key_file_silently(MASTER_KEY_PATH, key)
+      end
+
+      def ignore_master_key_file
+        key_file_generator.ignore_key_file(MASTER_KEY_PATH, ignore: key_ignore)
+      end
+
+      def ignore_master_key_file_silently
+        key_file_generator.ignore_key_file_silently(MASTER_KEY_PATH, ignore: key_ignore)
+      end
+
+      private
+        def key_file_generator
+          EncryptionKeyFileGenerator.new([], options)
+        end
+
+        def key_ignore
+          [ "", "# Ignore master key for decrypting credentials and more.", "/#{MASTER_KEY_PATH}", "" ].join("\n")
+        end
+    end
+  end
+end

data/lib/rails/generators/rails/migration/migration_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rails
   module Generators
     class MigrationGenerator < NamedBase # :nodoc:

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails/generators/model_helpers"
 
 module Rails

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

@@ -1,4 +1,5 @@
-require "active_support/core_ext/hash/slice"
+# frozen_string_literal: true
+
 require "rails/generators/rails/app/app_generator"
 require "date"
 
@@ -60,7 +61,12 @@ module Rails
       template "lib/%namespaced_name%.rb"
       template "lib/tasks/%namespaced_name%_tasks.rake"
       template "lib/%namespaced_name%/version.rb"
-      template "lib/%namespaced_name%/engine.rb" if engine?
+
+      if engine?
+        template "lib/%namespaced_name%/engine.rb"
+      else
+        template "lib/%namespaced_name%/railtie.rb"
+      end
     end
 
     def config
@@ -71,8 +77,8 @@ module Rails
       template "test/test_helper.rb"
       template "test/%namespaced_name%_test.rb"
       append_file "Rakefile", <<-EOF
-#{rakefile_test_tasks}
 
+#{rakefile_test_tasks}
 task default: :test
       EOF
       if engine?
@@ -81,18 +87,18 @@ task default: :test
     end
 
     PASSTHROUGH_OPTIONS = [
-      :skip_active_record, :skip_action_mailer, :skip_javascript, :skip_sprockets, :database,
-      :javascript, :quiet, :pretend, :force, :skip
+      :skip_active_record, :skip_active_storage, :skip_action_mailer, :skip_javascript, :skip_action_cable, :skip_sprockets, :database,
+      :javascript, :skip_yarn, :api, :quiet, :pretend, :skip
     ]
 
     def generate_test_dummy(force = false)
-      opts = (options || {}).slice(*PASSTHROUGH_OPTIONS)
+      opts = (options.dup || {}).keep_if { |k, _| PASSTHROUGH_OPTIONS.map(&:to_s).include?(k) }
       opts[:force] = force
       opts[:skip_bundle] = true
-      opts[:api] = options.api?
       opts[:skip_listen] = true
       opts[:skip_git] = true
       opts[:skip_turbolinks] = true
+      opts[:dummy_app] = true
 
       invoke Rails::Generators::AppGenerator,
         [ File.expand_path(dummy_path, destination_root) ], opts
@@ -115,7 +121,6 @@ task default: :test
     def test_dummy_clean
       inside dummy_path do
         remove_file "db/seeds.rb"
-        remove_file "doc"
         remove_file "Gemfile"
         remove_file "lib/tasks"
         remove_file "public/robots.txt"
@@ -162,7 +167,7 @@ task default: :test
 
       gemfile_in_app_path = File.join(rails_app_path, "Gemfile")
       if File.exist? gemfile_in_app_path
-        entry = "gem '#{name}', path: '#{relative_path}'"
+        entry = "\ngem '#{name}', path: '#{relative_path}'"
         append_file gemfile_in_app_path, entry
       end
     end
@@ -258,6 +263,10 @@ task default: :test
       public_task :apply_rails_template
 
       def run_after_bundle_callbacks
+        unless @after_bundle_callbacks.empty?
+          ActiveSupport::Deprecation.warn("`after_bundle` is deprecated and will be removed in the next version of Rails. ")
+        end
+
         @after_bundle_callbacks.each do |callback|
           callback.call
         end