railties 5.0.7.2 → 5.1.0.beta1

data/lib/rails/railtie.rb

@@ -1,7 +1,7 @@
-require 'rails/initializable'
-require 'active_support/inflector'
-require 'active_support/core_ext/module/introspection'
-require 'active_support/core_ext/module/delegation'
+require "rails/initializable"
+require "active_support/inflector"
+require "active_support/core_ext/module/introspection"
+require "active_support/core_ext/module/delegation"
 
 module Rails
   # <tt>Rails::Railtie</tt> is the core of the Rails framework and provides
@@ -111,7 +111,7 @@ module Rails
   #
   # Be sure to look at the documentation of those specific classes for more information.
   class Railtie
-    autoload :Configuration, 'rails/railtie/configuration'
+    autoload :Configuration, "rails/railtie/configuration"
 
     include Initializable
 
@@ -132,27 +132,19 @@ module Rails
       end
 
       def rake_tasks(&blk)
-        @rake_tasks ||= []
-        @rake_tasks << blk if blk
-        @rake_tasks
+        register_block_for(:rake_tasks, &blk)
       end
 
       def console(&blk)
-        @load_console ||= []
-        @load_console << blk if blk
-        @load_console
+        register_block_for(:load_console, &blk)
       end
 
       def runner(&blk)
-        @load_runner ||= []
-        @load_runner << blk if blk
-        @load_runner
+        register_block_for(:runner, &blk)
       end
 
       def generators(&blk)
-        @generators ||= []
-        @generators << blk if blk
-        @generators
+        register_block_for(:generators, &blk)
       end
 
       def abstract_railtie?
@@ -181,8 +173,8 @@ module Rails
         instance.configure(&block)
       end
 
-      protected
-        def generate_railtie_name(string) #:nodoc:
+      private
+        def generate_railtie_name(string)
           ActiveSupport::Inflector.underscore(string).tr("/", "_")
         end
 
@@ -195,6 +187,16 @@ module Rails
             super
           end
         end
+
+        # receives an instance variable identifier, set the variable value if is
+        # blank and append given block to value, which will be used later in
+        # `#each_registered_block(type, &block)`
+        def register_block_for(type, &blk)
+          var_name = "@#{type}"
+          blocks = instance_variable_defined?(var_name) ? instance_variable_get(var_name) : instance_variable_set(var_name, [])
+          blocks << blk if blk
+          blocks
+        end
     end
 
     delegate :railtie_name, to: :class
@@ -222,31 +224,32 @@ module Rails
 
     protected
 
-    def run_console_blocks(app) #:nodoc:
-      each_registered_block(:console) { |block| block.call(app) }
-    end
+      def run_console_blocks(app) #:nodoc:
+        each_registered_block(:console) { |block| block.call(app) }
+      end
 
-    def run_generators_blocks(app) #:nodoc:
-      each_registered_block(:generators) { |block| block.call(app) }
-    end
+      def run_generators_blocks(app) #:nodoc:
+        each_registered_block(:generators) { |block| block.call(app) }
+      end
 
-    def run_runner_blocks(app) #:nodoc:
-      each_registered_block(:runner) { |block| block.call(app) }
-    end
+      def run_runner_blocks(app) #:nodoc:
+        each_registered_block(:runner) { |block| block.call(app) }
+      end
 
-    def run_tasks_blocks(app) #:nodoc:
-      extend Rake::DSL
-      each_registered_block(:rake_tasks) { |block| instance_exec(app, &block) }
-    end
+      def run_tasks_blocks(app) #:nodoc:
+        extend Rake::DSL
+        each_registered_block(:rake_tasks) { |block| instance_exec(app, &block) }
+      end
 
     private
 
-    def each_registered_block(type, &block)
-      klass = self.class
-      while klass.respond_to?(type)
-        klass.public_send(type).each(&block)
-        klass = klass.superclass
+      # run `&block` in every registered block in `#register_block_for`
+      def each_registered_block(type, &block)
+        klass = self.class
+        while klass.respond_to?(type)
+          klass.public_send(type).each(&block)
+          klass = klass.superclass
+        end
       end
-    end
   end
 end

data/lib/rails/railtie/configurable.rb

@@ -1,4 +1,4 @@
-require 'active_support/concern'
+require "active_support/concern"
 
 module Rails
   class Railtie
@@ -9,7 +9,7 @@ module Rails
         delegate :config, to: :instance
 
         def inherited(base)
-          raise "You cannot inherit from a #{self.superclass.name} child"
+          raise "You cannot inherit from a #{superclass.name} child"
         end
 
         def instance
@@ -24,11 +24,11 @@ module Rails
           class_eval(&block)
         end
 
-        protected
+        private
 
-        def method_missing(*args, &block)
-          instance.send(*args, &block)
-        end
+          def method_missing(*args, &block)
+            instance.send(*args, &block)
+          end
       end
     end
   end

data/lib/rails/railtie/configuration.rb

@@ -1,4 +1,4 @@
-require 'rails/configuration'
+require "rails/configuration"
 
 module Rails
   class Railtie

data/lib/rails/ruby_version_check.rb

@@ -1,4 +1,4 @@
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2.2') && RUBY_ENGINE == 'ruby'
+if RUBY_VERSION < "2.2.2" && RUBY_ENGINE == "ruby"
   desc = defined?(RUBY_DESCRIPTION) ? RUBY_DESCRIPTION : "ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE})"
   abort <<-end_message
 

data/lib/rails/secrets.rb

@@ -0,0 +1,111 @@
+require "yaml"
+
+module Rails
+  # Greatly inspired by Ara T. Howard's magnificent sekrets gem. 😘
+  class Secrets # :nodoc:
+    class MissingKeyError < RuntimeError
+      def initialize
+        super(<<-end_of_message.squish)
+          Missing encryption key to decrypt secrets with.
+          Ask your team for your master key and put it in ENV["RAILS_MASTER_KEY"]
+        end_of_message
+      end
+    end
+
+    @read_encrypted_secrets = false
+    @root = File # Wonky, but ensures `join` uses the current directory.
+
+    class << self
+      attr_writer   :root
+      attr_accessor :read_encrypted_secrets
+
+      def parse(paths, env:)
+        paths.each_with_object(Hash.new) do |path, all_secrets|
+          require "erb"
+
+          secrets = YAML.load(ERB.new(preprocess(path)).result) || {}
+          all_secrets.merge!(secrets["shared"].deep_symbolize_keys) if secrets["shared"]
+          all_secrets.merge!(secrets[env].deep_symbolize_keys) if secrets[env]
+        end
+      end
+
+      def generate_key
+        cipher = new_cipher
+        SecureRandom.hex(cipher.key_len)[0, cipher.key_len]
+      end
+
+      def key
+        ENV["RAILS_MASTER_KEY"] || read_key_file || handle_missing_key
+      end
+
+      def encrypt(text)
+        cipher(:encrypt, text)
+      end
+
+      def decrypt(data)
+        cipher(:decrypt, data)
+      end
+
+      def read
+        decrypt(IO.binread(path))
+      end
+
+      def write(contents)
+        IO.binwrite("#{path}.tmp", encrypt(contents))
+        FileUtils.mv("#{path}.tmp", path)
+      end
+
+      def read_for_editing
+        tmp_path = File.join(Dir.tmpdir, File.basename(path))
+        IO.binwrite(tmp_path, read)
+
+        yield tmp_path
+
+        write(IO.binread(tmp_path))
+      ensure
+        FileUtils.rm(tmp_path) if File.exist?(tmp_path)
+      end
+
+      private
+        def handle_missing_key
+          raise MissingKeyError
+        end
+
+        def read_key_file
+          if File.exist?(key_path)
+            IO.binread(key_path).strip
+          end
+        end
+
+        def key_path
+          @root.join("config", "secrets.yml.key")
+        end
+
+        def path
+          @root.join("config", "secrets.yml.enc").to_s
+        end
+
+        def preprocess(path)
+          if path.end_with?(".enc")
+            if @read_encrypted_secrets
+              decrypt(IO.binread(path))
+            else
+              ""
+            end
+          else
+            IO.read(path)
+          end
+        end
+
+        def new_cipher
+          OpenSSL::Cipher.new("aes-256-cbc")
+        end
+
+        def cipher(mode, data)
+          cipher = new_cipher.public_send(mode)
+          cipher.key = key
+          cipher.update(data) << cipher.final
+        end
+    end
+  end
+end

data/lib/rails/source_annotation_extractor.rb

@@ -1,9 +1,9 @@
 # Implements the logic behind the rake tasks for annotations like
 #
-#   rake notes
-#   rake notes:optimize
+#   rails notes
+#   rails notes:optimize
 #
-# and friends. See <tt>rake -T notes</tt> and <tt>railties/lib/rails/tasks/annotations.rake</tt>.
+# and friends. See <tt>rails -T notes</tt> and <tt>railties/lib/rails/tasks/annotations.rake</tt>.
 #
 # Annotation objects are triplets <tt>:line</tt>, <tt>:tag</tt>, <tt>:text</tt> that
 # represent the line where the annotation lives, its tag, and its text. Note
@@ -13,9 +13,15 @@
 # start with the tag optionally followed by a colon. Everything up to the end
 # of the line (or closing ERB comment tag) is considered to be their text.
 class SourceAnnotationExtractor
-  class Annotation < Struct.new(:line, :tag, :text)
+  Annotation = Struct.new(:line, :tag, :text) do
     def self.directories
-      @@directories ||= %w(app config db lib test) + (ENV['SOURCE_ANNOTATION_DIRECTORIES'] || '').split(',')
+      @@directories ||= %w(app config db lib test) + (ENV["SOURCE_ANNOTATION_DIRECTORIES"] || "").split(",")
+    end
+
+    # Registers additional directories to be included
+    #  SourceAnnotationExtractor::Annotation.register_directories("spec","another")
+    def self.register_directories(*dirs)
+      directories.push(*dirs)
     end
 
     def self.extensions
@@ -38,7 +44,7 @@ class SourceAnnotationExtractor
     #
     # If +options+ has a flag <tt>:tag</tt> the tag is shown as in the example above.
     # Otherwise the string contains just line and text.
-    def to_s(options={})
+    def to_s(options = {})
       s = "[#{line.to_s.rjust(options[:indent])}] "
       s << "[#{tag}] " if options[:tag]
       s << text
@@ -60,7 +66,7 @@ class SourceAnnotationExtractor
   # See <tt>#find_in</tt> for a list of file extensions that will be taken into account.
   #
   # This class method is the single entry point for the rake tasks.
-  def self.enumerate(tag, options={})
+  def self.enumerate(tag, options = {})
     extractor = new(tag)
     dirs = options.delete(:dirs) || Annotation.directories
     extractor.display(extractor.find(dirs), options)
@@ -110,7 +116,7 @@ class SourceAnnotationExtractor
   # Otherwise it returns an empty hash.
   def extract_annotations_from(file, pattern)
     lineno = 0
-    result = File.readlines(file).inject([]) do |list, line|
+    result = File.readlines(file, encoding: Encoding::BINARY).inject([]) do |list, line|
       lineno += 1
       next list unless line =~ pattern
       list << Annotation.new(lineno, $1, $2)
@@ -120,7 +126,7 @@ class SourceAnnotationExtractor
 
   # Prints the mapping from filenames to annotations in +results+ ordered by filename.
   # The +options+ hash is passed to each annotation's +to_s+.
-  def display(results, options={})
+  def display(results, options = {})
     options[:indent] = results.flat_map { |f, a| a.map(&:line) }.max.to_s.size
     results.keys.sort.each do |file|
       puts "#{file}:"

data/lib/rails/tasks.rb

@@ -1,4 +1,4 @@
-require 'rake'
+require "rake"
 
 # Load Rails Rakefile extensions
 %w(
@@ -12,8 +12,9 @@ require 'rake'
   restart
   routes
   tmp
+  yarn
 ).tap { |arr|
-  arr << 'statistics' if Rake.application.current_scope.empty?
+  arr << "statistics" if Rake.application.current_scope.empty?
 }.each do |task|
   load "rails/tasks/#{task}.rake"
 end

data/lib/rails/tasks/annotations.rake

@@ -1,4 +1,4 @@
-require 'rails/source_annotation_extractor'
+require "rails/source_annotation_extractor"
 
 desc "Enumerate all annotations (use notes:optimize, :fixme, :todo for focus)"
 task :notes do
@@ -15,6 +15,6 @@ namespace :notes do
 
   desc "Enumerate a custom annotation, specify with ANNOTATION=CUSTOM"
   task :custom do
-    SourceAnnotationExtractor.enumerate ENV['ANNOTATION']
+    SourceAnnotationExtractor.enumerate ENV["ANNOTATION"]
   end
-end
+end

data/lib/rails/tasks/dev.rake

@@ -1,7 +1,7 @@
-require 'rails/dev_caching'
+require "rails/dev_caching"
 
 namespace :dev do
-  desc 'Toggle development mode caching on/off'
+  desc "Toggle development mode caching on/off"
   task :cache do
     Rails::DevCaching.enable_by_file
   end

data/lib/rails/tasks/engine.rake

@@ -2,7 +2,7 @@ task "load_app" do
   namespace :app do
     load APP_RAKEFILE
   end
-  task :environment => "app:environment"
+  task environment: "app:environment"
 
   if !defined?(ENGINE_ROOT) || !ENGINE_ROOT
     ENGINE_ROOT = find_engine_path(APP_RAKEFILE)
@@ -26,11 +26,11 @@ namespace :db do
   desc "Display status of migrations"
   app_task "migrate:status"
 
-  desc 'Create the database from config/database.yml for the current Rails.env (use db:create:all to create all databases in the config)'
+  desc "Create the database from config/database.yml for the current Rails.env (use db:create:all to create all databases in the config)"
   app_task "create"
   app_task "create:all"
 
-  desc 'Drops the database for the current Rails.env (use db:drop:all to drop all databases)'
+  desc "Drops the database for the current Rails.env (use db:drop:all to drop all databases)"
   app_task "drop"
   app_task "drop:all"
 
@@ -65,7 +65,7 @@ def find_engine_path(path)
   if Rails::Engine.find(path)
     path
   else
-    find_engine_path(File.expand_path('..', path))
+    find_engine_path(File.expand_path("..", path))
   end
 end
 

data/lib/rails/tasks/framework.rake

@@ -1,5 +1,3 @@
-require 'active_support/deprecation'
-
 namespace :app do
   desc "Update configs and some other initially generated files (or use just update:configs or update:bin)"
   task update: [ "update:configs", "update:bin", "update:upgrade_guide_info" ]
@@ -9,8 +7,8 @@ namespace :app do
     template = ENV["LOCATION"]
     raise "No LOCATION value given. Please set LOCATION either as path to a file or a URL" if template.blank?
     template = File.expand_path(template) if template !~ %r{\A[A-Za-z][A-Za-z0-9+\-\.]*://}
-    require 'rails/generators'
-    require 'rails/generators/rails/app/app_generator'
+    require "rails/generators"
+    require "rails/generators/rails/app/app_generator"
     generator = Rails::Generators::AppGenerator.new [Rails.root], {}, destination_root: Rails.root
     generator.apply template, verbose: false
   end
@@ -45,8 +43,8 @@ namespace :app do
 
       def self.app_generator
         @app_generator ||= begin
-          require 'rails/generators'
-          require 'rails/generators/rails/app/app_generator'
+          require "rails/generators"
+          require "rails/generators/rails/app/app_generator"
           gen = Rails::Generators::AppGenerator.new ["rails"],
                                                     { api: !!Rails.application.config.api_only, update: true },
                                                     destination_root: Rails.root
@@ -73,15 +71,3 @@ namespace :app do
     end
   end
 end
-
-namespace :rails do
-  %i(update template templates:copy update:configs update:bin).each do |task_name|
-    task "#{task_name}" do
-      ActiveSupport::Deprecation.warn(<<-MSG.squish)
-        Running #{task_name} with the rails: namespace is deprecated in favor of app: namespace.
-        Run bin/rails app:#{task_name} instead.
-      MSG
-      Rake.application.invoke_task("app:#{task_name}")
-    end
-  end
-end