activesupport 1.2.4 → 8.1.2

data/lib/active_support/core_ext/hash/keys.rb

@@ -1,53 +1,143 @@
-module ActiveSupport #:nodoc:
-  module CoreExtensions #:nodoc:
-    module Hash #:nodoc:
-      module Keys
-        # Return a new hash with all keys converted to strings.
-        def stringify_keys
-          inject({}) do |options, (key, value)|
-            options[key.to_s] = value
-            options
-          end
-        end
+# frozen_string_literal: true
 
-        # Destructively convert all keys to strings.
-        def stringify_keys!
-          keys.each do |key|
-            unless key.class.to_s == "String" # weird hack to make the tests run when string_ext_test.rb is also running
-              self[key.to_s] = self[key]
-              delete(key)
-            end
-          end
-          self
-        end
+class Hash
+  # Returns a new hash with all keys converted to strings.
+  #
+  #   hash = { name: 'Rob', age: '28' }
+  #
+  #   hash.stringify_keys
+  #   # => {"name"=>"Rob", "age"=>"28"}
+  def stringify_keys
+    transform_keys { |k| Symbol === k ? k.name : k.to_s }
+  end
 
-        # Return a new hash with all keys converted to symbols.
-        def symbolize_keys
-          inject({}) do |options, (key, value)|
-            options[key.to_sym] = value
-            options
-          end
-        end
+  # Destructively converts all keys to strings. Same as
+  # +stringify_keys+, but modifies +self+.
+  def stringify_keys!
+    transform_keys! { |k| Symbol === k ? k.name : k.to_s }
+  end
 
-        # Destructively convert all keys to symbols.
-        def symbolize_keys!
-          keys.each do |key|
-            unless key.is_a?(Symbol)
-              self[key.to_sym] = self[key]
-              delete(key)
-            end
-          end
-          self
-        end
+  # Returns a new hash with all keys converted to symbols, as long as
+  # they respond to +to_sym+.
+  #
+  #   hash = { 'name' => 'Rob', 'age' => '28' }
+  #
+  #   hash.symbolize_keys
+  #   # => {:name=>"Rob", :age=>"28"}
+  def symbolize_keys
+    transform_keys { |key| key.to_sym rescue key }
+  end
+  alias_method :to_options,  :symbolize_keys
 
-        alias_method :to_options,  :symbolize_keys
-        alias_method :to_options!, :symbolize_keys!
+  # Destructively converts all keys to symbols, as long as they respond
+  # to +to_sym+. Same as +symbolize_keys+, but modifies +self+.
+  def symbolize_keys!
+    transform_keys! { |key| key.to_sym rescue key }
+  end
+  alias_method :to_options!, :symbolize_keys!
 
-        def assert_valid_keys(*valid_keys)
-          unknown_keys = keys - [valid_keys].flatten
-          raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(", ")}") unless unknown_keys.empty?
-        end
+  # Validates all keys in a hash match <tt>*valid_keys</tt>, raising
+  # +ArgumentError+ on a mismatch.
+  #
+  # Note that keys are treated differently than HashWithIndifferentAccess,
+  # meaning that string and symbol keys will not match.
+  #
+  #   { name: 'Rob', years: '28' }.assert_valid_keys(:name, :age) # => raises "ArgumentError: Unknown key: :years. Valid keys are: :name, :age"
+  #   { name: 'Rob', age: '28' }.assert_valid_keys('name', 'age') # => raises "ArgumentError: Unknown key: :name. Valid keys are: 'name', 'age'"
+  #   { name: 'Rob', age: '28' }.assert_valid_keys(:name, :age)   # => passes, raises nothing
+  def assert_valid_keys(*valid_keys)
+    valid_keys.flatten!
+    each_key do |k|
+      unless valid_keys.include?(k)
+        raise ArgumentError.new("Unknown key: #{k.inspect}. Valid keys are: #{valid_keys.map(&:inspect).join(', ')}")
       end
     end
   end
+
+  # Returns a new hash with all keys converted by the block operation.
+  # This includes the keys from the root hash and from all
+  # nested hashes and arrays.
+  #
+  #   hash = { person: { name: 'Rob', age: '28' } }
+  #
+  #   hash.deep_transform_keys{ |key| key.to_s.upcase }
+  #   # => {"PERSON"=>{"NAME"=>"Rob", "AGE"=>"28"}}
+  def deep_transform_keys(&block)
+    _deep_transform_keys_in_object(self, &block)
+  end
+
+  # Destructively converts all keys by using the block operation.
+  # This includes the keys from the root hash and from all
+  # nested hashes and arrays.
+  def deep_transform_keys!(&block)
+    _deep_transform_keys_in_object!(self, &block)
+  end
+
+  # Returns a new hash with all keys converted to strings.
+  # This includes the keys from the root hash and from all
+  # nested hashes and arrays.
+  #
+  #   hash = { person: { name: 'Rob', age: '28' } }
+  #
+  #   hash.deep_stringify_keys
+  #   # => {"person"=>{"name"=>"Rob", "age"=>"28"}}
+  def deep_stringify_keys
+    deep_transform_keys { |k| Symbol === k ? k.name : k.to_s }
+  end
+
+  # Destructively converts all keys to strings.
+  # This includes the keys from the root hash and from all
+  # nested hashes and arrays.
+  def deep_stringify_keys!
+    deep_transform_keys! { |k| Symbol === k ? k.name : k.to_s }
+  end
+
+  # Returns a new hash with all keys converted to symbols, as long as
+  # they respond to +to_sym+. This includes the keys from the root hash
+  # and from all nested hashes and arrays.
+  #
+  #   hash = { 'person' => { 'name' => 'Rob', 'age' => '28' } }
+  #
+  #   hash.deep_symbolize_keys
+  #   # => {:person=>{:name=>"Rob", :age=>"28"}}
+  def deep_symbolize_keys
+    deep_transform_keys { |key| key.to_sym rescue key }
+  end
+
+  # Destructively converts all keys to symbols, as long as they respond
+  # to +to_sym+. This includes the keys from the root hash and from all
+  # nested hashes and arrays.
+  def deep_symbolize_keys!
+    deep_transform_keys! { |key| key.to_sym rescue key }
+  end
+
+  private
+    # Support methods for deep transforming nested hashes and arrays.
+    def _deep_transform_keys_in_object(object, &block)
+      case object
+      when Hash
+        object.each_with_object(self.class.new) do |(key, value), result|
+          result[yield(key)] = _deep_transform_keys_in_object(value, &block)
+        end
+      when Array
+        object.map { |e| _deep_transform_keys_in_object(e, &block) }
+      else
+        object
+      end
+    end
+
+    def _deep_transform_keys_in_object!(object, &block)
+      case object
+      when Hash
+        object.keys.each do |key|
+          value = object.delete(key)
+          object[yield(key)] = _deep_transform_keys_in_object!(value, &block)
+        end
+        object
+      when Array
+        object.map! { |e| _deep_transform_keys_in_object!(e, &block) }
+      else
+        object
+      end
+    end
 end

data/lib/active_support/core_ext/hash/reverse_merge.rb

@@ -1,25 +1,25 @@
-module ActiveSupport #:nodoc:
-  module CoreExtensions #:nodoc:
-    module Hash #:nodoc:
-      # Allows for reverse merging where its the keys in the calling hash that wins over those in the <tt>other_hash</tt>.
-      # This is particularly useful for initializing an incoming option hash with default values:
-      #
-      #   def setup(options = {})
-      #     options.reverse_merge! :size => 25, :velocity => 10
-      #   end
-      #
-      # The default :size and :velocity is only set if the +options+ passed in doesn't already have those keys set.
-      module ReverseMerge
-        def reverse_merge(other_hash)
-          other_hash.merge(self)
-        end
+# frozen_string_literal: true
 
-        def reverse_merge!(other_hash)
-          replace(reverse_merge(other_hash))
-        end
+class Hash
+  # Merges the caller into +other_hash+. For example,
+  #
+  #   options = options.reverse_merge(size: 25, velocity: 10)
+  #
+  # is equivalent to
+  #
+  #   options = { size: 25, velocity: 10 }.merge(options)
+  #
+  # This is particularly useful for initializing an options hash
+  # with default values.
+  def reverse_merge(other_hash)
+    other_hash.merge(self)
+  end
+  alias_method :with_defaults, :reverse_merge
 
-        alias_method :reverse_update, :reverse_merge
-      end
-    end
+  # Destructive +reverse_merge+.
+  def reverse_merge!(other_hash)
+    replace(reverse_merge(other_hash))
   end
-end
+  alias_method :reverse_update, :reverse_merge!
+  alias_method :with_defaults!, :reverse_merge!
+end

data/lib/active_support/core_ext/hash/slice.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class Hash
+  # Replaces the hash with only the given keys.
+  # Returns a hash containing the removed key/value pairs.
+  #
+  #   hash = { a: 1, b: 2, c: 3, d: 4 }
+  #   hash.slice!(:a, :b)  # => {:c=>3, :d=>4}
+  #   hash                 # => {:a=>1, :b=>2}
+  def slice!(*keys)
+    omit = slice(*self.keys - keys)
+    hash = slice(*keys)
+    hash.default      = default
+    hash.default_proc = default_proc if default_proc
+    replace(hash)
+    omit
+  end
+
+  # Removes and returns the key/value pairs matching the given keys.
+  #
+  #   hash = { a: 1, b: 2, c: 3, d: 4 }
+  #   hash.extract!(:a, :b) # => {:a=>1, :b=>2}
+  #   hash                  # => {:c=>3, :d=>4}
+  def extract!(*keys)
+    keys.each_with_object(self.class.new) { |key, result| result[key] = delete(key) if has_key?(key) }
+  end
+end

data/lib/active_support/core_ext/hash.rb

@@ -1,9 +1,10 @@
-require File.dirname(__FILE__) + '/hash/keys'
-require File.dirname(__FILE__) + '/hash/indifferent_access'
-require File.dirname(__FILE__) + '/hash/reverse_merge'
+# frozen_string_literal: true
 
-class Hash #:nodoc:
-  include ActiveSupport::CoreExtensions::Hash::Keys
-  include ActiveSupport::CoreExtensions::Hash::IndifferentAccess
-  include ActiveSupport::CoreExtensions::Hash::ReverseMerge
-end
+require_relative "hash/conversions"
+require_relative "hash/deep_merge"
+require_relative "hash/deep_transform_values"
+require_relative "hash/except"
+require_relative "hash/indifferent_access"
+require_relative "hash/keys"
+require_relative "hash/reverse_merge"
+require_relative "hash/slice"

data/lib/active_support/core_ext/integer/inflections.rb

@@ -1,15 +1,31 @@
-require File.dirname(__FILE__) + '/../../inflector'
-module ActiveSupport #:nodoc:
-  module CoreExtensions #:nodoc:
-    module Integer #:nodoc:
-      module Inflections
-        # 1.ordinalize  # => "1st"
-        # 3.ordinalize  # => "3rd"
-        # 10.ordinalize # => "10th"
-        def ordinalize
-          Inflector.ordinalize(self)
-        end
-      end
-    end
+# frozen_string_literal: true
+
+require "active_support/inflector"
+
+class Integer
+  # Ordinalize turns a number into an ordinal string used to denote the
+  # position in an ordered sequence such as 1st, 2nd, 3rd, 4th.
+  #
+  #   1.ordinalize     # => "1st"
+  #   2.ordinalize     # => "2nd"
+  #   1002.ordinalize  # => "1002nd"
+  #   1003.ordinalize  # => "1003rd"
+  #   -11.ordinalize   # => "-11th"
+  #   -1001.ordinalize # => "-1001st"
+  def ordinalize
+    ActiveSupport::Inflector.ordinalize(self)
+  end
+
+  # Ordinal returns the suffix used to denote the position
+  # in an ordered sequence such as 1st, 2nd, 3rd, 4th.
+  #
+  #   1.ordinal     # => "st"
+  #   2.ordinal     # => "nd"
+  #   1002.ordinal  # => "nd"
+  #   1003.ordinal  # => "rd"
+  #   -11.ordinal   # => "th"
+  #   -1001.ordinal # => "st"
+  def ordinal
+    ActiveSupport::Inflector.ordinal(self)
   end
 end

data/lib/active_support/core_ext/integer/multiple.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Integer
+  # Check whether the integer is evenly divisible by the argument.
+  #
+  #   0.multiple_of?(0)  # => true
+  #   6.multiple_of?(5)  # => false
+  #   10.multiple_of?(2) # => true
+  def multiple_of?(number)
+    number == 0 ? self == 0 : self % number == 0
+  end
+end

data/lib/active_support/core_ext/integer/time.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "active_support/duration"
+require "active_support/core_ext/numeric/time"
+
+class Integer
+  # Returns a Duration instance matching the number of months provided.
+  #
+  #   2.months # => 2 months
+  def months
+    ActiveSupport::Duration.months(self)
+  end
+  alias :month :months
+
+  # Returns a Duration instance matching the number of years provided.
+  #
+  #   2.years # => 2 years
+  def years
+    ActiveSupport::Duration.years(self)
+  end
+  alias :year :years
+end

data/lib/active_support/core_ext/integer.rb

@@ -1,7 +1,5 @@
-require File.dirname(__FILE__) + '/integer/even_odd'
-require File.dirname(__FILE__) + '/integer/inflections'
+# frozen_string_literal: true
 
-class Integer #:nodoc:
-  include ActiveSupport::CoreExtensions::Integer::EvenOdd
-  include ActiveSupport::CoreExtensions::Integer::Inflections
-end
+require_relative "integer/multiple"
+require_relative "integer/inflections"
+require_relative "integer/time"

data/lib/active_support/core_ext/kernel/concern.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/module/concerning"
+
+module Kernel
+  module_function
+
+  # A shortcut to define a toplevel concern, not within a module.
+  #
+  # See Module::Concerning for more.
+  def concern(topic, &module_definition)
+    Object.concern topic, &module_definition
+  end
+end

data/lib/active_support/core_ext/kernel/reporting.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Kernel
+  module_function
+
+  # Sets $VERBOSE to +nil+ for the duration of the block and back to its original
+  # value afterwards.
+  #
+  #   silence_warnings do
+  #     value = noisy_call # no warning voiced
+  #   end
+  #
+  #   noisy_call # warning voiced
+  def silence_warnings(&block)
+    with_warnings(nil, &block)
+  end
+
+  # Sets $VERBOSE to +true+ for the duration of the block and back to its
+  # original value afterwards.
+  def enable_warnings(&block)
+    with_warnings(true, &block)
+  end
+
+  # Sets $VERBOSE for the duration of the block and back to its original
+  # value afterwards.
+  def with_warnings(flag)
+    old_verbose, $VERBOSE = $VERBOSE, flag
+    yield
+  ensure
+    $VERBOSE = old_verbose
+  end
+
+  # Blocks and ignores any exception passed as argument if raised within the block.
+  #
+  #   suppress(ZeroDivisionError) do
+  #     1/0
+  #     puts 'This code is NOT reached'
+  #   end
+  #
+  #   puts 'This code gets executed and nothing related to ZeroDivisionError was seen'
+  def suppress(*exception_classes)
+    yield
+  rescue *exception_classes
+  end
+end

data/lib/active_support/core_ext/kernel/singleton_class.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Kernel
+  # class_eval on an object acts like +singleton_class.class_eval+.
+  def class_eval(*args, &block)
+    singleton_class.class_eval(*args, &block)
+  end
+end

data/lib/active_support/core_ext/kernel.rb

@@ -1,79 +1,5 @@
-class Object
-  # A Ruby-ized realization of the K combinator, courtesy of Mikael Brockman.
-  #
-  #   def foo
-  #     returning values = [] do
-  #       values << 'bar'
-  #       values << 'baz'
-  #     end
-  #   end
-  #
-  #   foo # => ['bar', 'baz']
-  #
-  def returning(value)
-    yield
-    value
-  end
-  
-  # Sets $VERBOSE to nil for the duration of the block and back to its original value afterwards.
-  #
-  #   silence_warnings do
-  #     value = noisy_call # no warning voiced
-  #   end
-  #
-  #   noisy_call # warning voiced
-  def silence_warnings
-    old_verbose, $VERBOSE = $VERBOSE, nil
-    yield
-  ensure
-    $VERBOSE = old_verbose
-  end
+# frozen_string_literal: true
 
-  # Silences stderr for the duration of the block.
-  #
-  #   silence_stderr do
-  #     $stderr.puts 'This will never be seen'
-  #   end
-  #
-  #   $stderr.puts 'But this will'
-  def silence_stderr
-    old_stderr = STDERR.dup
-    STDERR.reopen(RUBY_PLATFORM =~ /mswin/ ? 'NUL:' : '/dev/null')
-    STDERR.sync = true
-    yield
-  ensure
-    STDERR.reopen(old_stderr)
-  end
-
-  # Makes backticks behave (somewhat more) similarly on all platforms.
-  # On win32 `nonexistent_command` raises Errno::ENOENT; on Unix, the
-  # spawned shell prints a message to stderr and sets $?.  We emulate
-  # Unix on the former but not the latter.
-  def `(command) #:nodoc:
-    super
-  rescue Errno::ENOENT => e
-    STDERR.puts "#$0: #{e}"
-  end
-  
-  # Method that requires a library, ensuring that rubygems is loaded
-  def require_library_or_gem(library_name)
-    begin
-      require library_name
-    rescue LoadError => cannot_require
-      # 1. Requiring the module is unsuccessful, maybe it's a gem and nobody required rubygems yet. Try.
-      begin
-        require 'rubygems'
-      rescue LoadError => rubygems_not_installed
-        raise cannot_require
-      end
-      # 2. Rubygems is installed and loaded. Try to load the library again
-      begin
-        require library_name
-      rescue LoadError => gem_not_installed
-        raise cannot_require
-      end
-    end
-  end
-
-
-end
+require_relative "kernel/concern"
+require_relative "kernel/reporting"
+require_relative "kernel/singleton_class"

data/lib/active_support/core_ext/load_error.rb

@@ -1,38 +1,9 @@
-class MissingSourceFile < LoadError #:nodoc:
-  attr_reader :path
-  def initialize(message, path)
-    super(message)
-    @path = path
-  end
-
-  def is_missing?(path)
-    path.gsub(/\.rb$/, '') == self.path.gsub(/\.rb$/, '')
-  end
-  
-  def self.from_message(message)
-    REGEXPS.each do |regexp, capture|
-      match = regexp.match(message)
-      return MissingSourceFile.new(message, match[capture]) unless match.nil?
-    end
-    nil
-  end
-  
-  REGEXPS = [
-    [/^no such file to load -- (.+)$/i, 1],
-    [/^Missing \w+ (file\s*)?([^\s]+.rb)$/i, 2],
-    [/^Missing API definition file in (.+)$/i, 1]
-  ]
-end
+# frozen_string_literal: true
 
-module ActiveSupport #:nodoc:
-  module CoreExtensions #:nodoc:
-    module LoadErrorExtensions #:nodoc:
-      module LoadErrorClassMethods #:nodoc:
-        def new(*args)
-          (self == LoadError && MissingSourceFile.from_message(args.first)) || super
-        end
-      end
-      ::LoadError.extend(LoadErrorClassMethods)
-    end
+class LoadError
+  # Returns true if the given path name (except perhaps for the ".rb"
+  # extension) is the missing file which caused the exception to be raised.
+  def is_missing?(location)
+    location.delete_suffix(".rb") == path.to_s.delete_suffix(".rb")
   end
 end

data/lib/active_support/core_ext/module/aliasing.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Module
+  # Allows you to make aliases for attributes, which includes
+  # getter, setter, and a predicate.
+  #
+  #   class Content < ActiveRecord::Base
+  #     # has a title attribute
+  #   end
+  #
+  #   class Email < Content
+  #     alias_attribute :subject, :title
+  #   end
+  #
+  #   e = Email.find(1)
+  #   e.title    # => "Superstars"
+  #   e.subject  # => "Superstars"
+  #   e.subject? # => true
+  #   e.subject = "Megastars"
+  #   e.title    # => "Megastars"
+  def alias_attribute(new_name, old_name)
+    # The following reader methods use an explicit `self` receiver in order to
+    # support aliases that start with an uppercase letter. Otherwise, they would
+    # be resolved as constants instead.
+    module_eval <<-STR, __FILE__, __LINE__ + 1
+      def #{new_name}; self.#{old_name}; end          # def subject; self.title; end
+      def #{new_name}?; self.#{old_name}?; end        # def subject?; self.title?; end
+      def #{new_name}=(v); self.#{old_name} = v; end  # def subject=(v); self.title = v; end
+    STR
+  end
+end

data/lib/active_support/core_ext/module/anonymous.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class Module
+  # A module may or may not have a name.
+  #
+  #   module M; end
+  #   M.name # => "M"
+  #
+  #   m = Module.new
+  #   m.name # => nil
+  #
+  # +anonymous?+ method returns true if module does not have a name, false otherwise:
+  #
+  #   Module.new.anonymous? # => true
+  #
+  #   module M; end
+  #   M.anonymous?          # => false
+  #
+  # A module gets a name when it is first assigned to a constant. Either
+  # via the +module+ or +class+ keyword or by an explicit assignment:
+  #
+  #   m = Module.new # creates an anonymous module
+  #   m.anonymous?   # => true
+  #   M = m          # m gets a name here as a side-effect
+  #   m.name         # => "M"
+  #   m.anonymous?   # => false
+  def anonymous?
+    name.nil?
+  end
+end