Privatize unneededly protected methods in Railties

Author: amatsuda

railties/lib/rails/application_controller.rb

@@ -2,7 +2,7 @@ class Rails::ApplicationController < ActionController::Base # :nodoc:
   self.view_paths = File.expand_path("../templates", __FILE__)
   layout "application"
 
-  protected
+  private
 
     def require_local!
       unless local_request?

railties/lib/rails/command.rb

@@ -82,16 +82,16 @@ def sorted_groups # :nodoc:
         [[ "rails", rails ]] + groups.sort.to_a
       end
 
-      protected
-        def command_type
+      private
+        def command_type # :doc:
           @command_type ||= "command"
         end
 
-        def lookup_paths
+        def lookup_paths # :doc:
           @lookup_paths ||= %w( rails/commands commands )
         end
 
-        def file_lookup_paths
+        def file_lookup_paths # :doc:
           @file_lookup_paths ||= [ "{#{lookup_paths.join(',')}}", "**", "*_command.rb" ]
         end
     end

railties/lib/rails/command/behavior.rb

@@ -16,13 +16,13 @@ def subclasses
           @subclasses ||= []
         end
 
-        protected
+        private
 
           # This code is based directly on the Text gem implementation.
           # Copyright (c) 2006-2013 Paul Battley, Michael Neumann, Tim Fletcher.
           #
           # Returns a value representing the "cost" of transforming str1 into str2.
-          def levenshtein_distance(str1, str2)
+          def levenshtein_distance(str1, str2) # :doc:
             s = str1
             t = str2
             n = s.length
@@ -58,7 +58,7 @@ def levenshtein_distance(str1, str2)
           end
 
           # Prints a list of generators.
-          def print_list(base, namespaces) #:nodoc:
+          def print_list(base, namespaces)
             return if namespaces.empty?
             puts "#{base.camelize}:"
 
@@ -71,7 +71,7 @@ def print_list(base, namespaces) #:nodoc:
 
           # Receives namespaces in an array and tries to find matching generators
           # in the load path.
-          def lookup(namespaces) #:nodoc:
+          def lookup(namespaces)
             paths = namespaces_to_paths(namespaces)
 
             paths.each do |raw_path|
@@ -91,7 +91,7 @@ def lookup(namespaces) #:nodoc:
           end
 
           # This will try to load any command in the load path to show in help.
-          def lookup! #:nodoc:
+          def lookup!
             $LOAD_PATH.each do |base|
               Dir[File.join(base, *file_lookup_paths)].each do |path|
                 begin
@@ -107,7 +107,7 @@ def lookup! #:nodoc:
           # Convert namespaces to paths by replacing ":" for "/" and adding
           # an extra lookup. For example, "rails:model" should be searched
           # in both: "rails/model/model_generator" and "rails/model_generator".
-          def namespaces_to_paths(namespaces) #:nodoc:
+          def namespaces_to_paths(namespaces)
             paths = []
             namespaces.each do |namespace|
               pieces = namespace.split(":")

railties/lib/rails/commands/dbconsole/dbconsole_command.rb

@@ -99,14 +99,14 @@ def environment
       Rails.respond_to?(:env) ? Rails.env : Rails::Command.environment
     end
 
-    protected
-      def configurations
+    private
+      def configurations # :doc:
         require APP_PATH
         ActiveRecord::Base.configurations = Rails.application.config.database_configuration
         ActiveRecord::Base.configurations
       end
 
-      def find_cmd_and_exec(commands, *args)
+      def find_cmd_and_exec(commands, *args) # :doc:
         commands = Array(commands)
 
         dirs_on_path = ENV["PATH"].to_s.split(File::PATH_SEPARATOR)

railties/lib/rails/engine.rb

@@ -643,18 +643,20 @@ def routes? #:nodoc:
 
     protected
 
-      def load_config_initializer(initializer)
-        ActiveSupport::Notifications.instrument("load_config_initializer.railties", initializer: initializer) do
-          load(initializer)
-        end
-      end
-
       def run_tasks_blocks(*) #:nodoc:
         super
         paths["lib/tasks"].existent.sort.each { |ext| load(ext) }
       end
 
-      def has_migrations? #:nodoc:
+    private
+
+      def load_config_initializer(initializer) # :doc:
+        ActiveSupport::Notifications.instrument("load_config_initializer.railties", initializer: initializer) do
+          load(initializer)
+        end
+      end
+
+      def has_migrations?
         paths["db/migrate"].existent.any?
       end
 
@@ -671,24 +673,22 @@ def self.find_root_with_flag(flag, root_path, default = nil) #:nodoc:
         Pathname.new File.realpath root
       end
 
-      def default_middleware_stack #:nodoc:
+      def default_middleware_stack
         ActionDispatch::MiddlewareStack.new
       end
 
-      def _all_autoload_once_paths #:nodoc:
+      def _all_autoload_once_paths
         config.autoload_once_paths
       end
 
-      def _all_autoload_paths #:nodoc:
+      def _all_autoload_paths
         @_all_autoload_paths ||= (config.autoload_paths + config.eager_load_paths + config.autoload_once_paths).uniq
       end
 
-      def _all_load_paths #:nodoc:
+      def _all_load_paths
         @_all_load_paths ||= (config.paths.load_paths + _all_autoload_paths).uniq
       end
 
-    private
-
       def build_request(env)
         env.merge!(env_config)
         req = ActionDispatch::Request.new env

railties/lib/rails/generators/actions.rb

@@ -260,12 +260,12 @@ def after_bundle(&block)
         @after_bundle_callbacks << block
       end
 
-      protected
+      private
 
         # Define log for backwards compatibility. If just one argument is sent,
         # invoke say, otherwise invoke say_status. Differently from say and
         # similarly to say_status, this method respects the quiet? option given.
-        def log(*args)
+        def log(*args) # :doc:
           if args.size == 1
             say args.first.to_s unless options.quiet?
           else
@@ -276,15 +276,15 @@ def log(*args)
 
         # Runs the supplied command using either "rake ..." or "rails ..."
         # based on the executor parameter provided.
-        def execute_command(executor, command, options = {})
+        def execute_command(executor, command, options = {}) # :doc:
           log executor, command
           env  = options[:env] || ENV["RAILS_ENV"] || "development"
           sudo = options[:sudo] && !Gem.win_platform? ? "sudo " : ""
           in_root { run("#{sudo}#{extify(executor)} #{command} RAILS_ENV=#{env}", verbose: false) }
         end
 
         # Add an extension to the given name based on the platform.
-        def extify(name)
+        def extify(name) # :doc:
           if Gem.win_platform?
             "#{name}.bat"
           else
@@ -294,7 +294,7 @@ def extify(name)
 
         # Surround string with single quotes if there is no quotes.
         # Otherwise fall back to double quotes
-        def quote(value)
+        def quote(value) # :doc:
           return value.inspect unless value.is_a? String
 
           if value.include?("'")

railties/lib/rails/generators/actions/create_migration.rb

@@ -37,9 +37,9 @@ def existing_migration
         end
         alias :exists? :existing_migration
 
-        protected
+        private
 
-          def on_conflict_behavior
+          def on_conflict_behavior # :doc:
             options = base.options.merge(config)
             if identical?
               say_status :identical, :blue, relative_existing_migration
@@ -60,7 +60,7 @@ def on_conflict_behavior
             end
           end
 
-          def say_status(status, color, message = relative_destination)
+          def say_status(status, color, message = relative_destination) # :doc:
             base.shell.say_status(status, message, color) if config[:verbose]
           end
       end

railties/lib/rails/generators/app_base.rb

@@ -108,9 +108,9 @@ def initialize(*args)
         convert_database_option_for_jruby
       end
 
-    protected
+    private
 
-      def gemfile_entry(name, *args)
+      def gemfile_entry(name, *args) # :doc:
         options = args.extract_options!
         version = args.first
         github = options[:github]
@@ -126,7 +126,7 @@ def gemfile_entry(name, *args)
         self
       end
 
-      def gemfile_entries
+      def gemfile_entries # :doc:
         [rails_gemfile_entry,
          database_gemfile_entry,
          webserver_gemfile_entry,
@@ -139,38 +139,38 @@ def gemfile_entries
          @extra_entries].flatten.find_all(&@gem_filter)
       end
 
-      def add_gem_entry_filter
+      def add_gem_entry_filter # :doc:
         @gem_filter = lambda { |next_filter, entry|
           yield(entry) && next_filter.call(entry)
         }.curry[@gem_filter]
       end
 
-      def builder
+      def builder # :doc:
         @builder ||= begin
           builder_class = get_builder_class
           builder_class.include(ActionMethods)
           builder_class.new(self)
         end
       end
 
-      def build(meth, *args)
+      def build(meth, *args) # :doc:
         builder.send(meth, *args) if builder.respond_to?(meth)
       end
 
-      def create_root
+      def create_root # :doc:
         valid_const?
 
         empty_directory "."
         FileUtils.cd(destination_root) unless options[:pretend]
       end
 
-      def apply_rails_template
+      def apply_rails_template # :doc:
         apply rails_template if rails_template
       rescue Thor::Error, LoadError, Errno::ENOENT => e
         raise Error, "The template [#{rails_template}] could not be loaded. Error: #{e}"
       end
 
-      def set_default_accessors!
+      def set_default_accessors! # :doc:
         self.destination_root = File.expand_path(app_path, destination_root)
         self.rails_template = \
           case options[:template]
@@ -183,32 +183,32 @@ def set_default_accessors!
           end
       end
 
-      def database_gemfile_entry
+      def database_gemfile_entry # :doc:
         return [] if options[:skip_active_record]
         gem_name, gem_version = gem_for_database
         GemfileEntry.version gem_name, gem_version,
                             "Use #{options[:database]} as the database for Active Record"
       end
 
-      def webserver_gemfile_entry
+      def webserver_gemfile_entry # :doc:
         return [] if options[:skip_puma]
         comment = "Use Puma as the app server"
         GemfileEntry.new("puma", "~> 3.0", comment)
       end
 
-      def include_all_railties?
+      def include_all_railties? # :doc:
         options.values_at(:skip_active_record, :skip_action_mailer, :skip_test, :skip_sprockets, :skip_action_cable).none?
       end
 
-      def comment_if(value)
+      def comment_if(value) # :doc:
         options[value] ? "# " : ""
       end
 
-      def keeps?
+      def keeps? # :doc:
         !options[:skip_keeps]
       end
 
-      def sqlite3?
+      def sqlite3? # :doc:
         !options[:skip_active_record] && options[:database] == "sqlite3"
       end