autoloaded 1.6.0 → 2.0.0

data/lib/autoloaded.rb

@@ -5,53 +5,13 @@
 module Autoloaded
 
   autoload :Autoloader,          'autoloaded/autoloader'
-  autoload :Constant,            'autoloaded/constant'
-  autoload :Deprecation,         'autoloaded/deprecation'
   autoload :Inflection,          'autoloaded/inflection'
   autoload :LoadPathedDirectory, 'autoloaded/load_pathed_directory'
-  autoload :Refine,              'autoloaded/refine'
   autoload :Specification,       'autoloaded/specification'
   autoload :Specifications,      'autoloaded/specifications'
   autoload :VERSION,             'autoloaded/version'
   autoload :Warning,             'autoloaded/warning'
 
-  def self.extended(other_module)
-    caller_file_path = caller_locations.first.absolute_path
-    Deprecation.deprecate deprecated_usage: "extend #{name}",
-                          sanctioned_usage: "#{name}.module { }",
-                          source_filename:  caller_file_path
-    dir_path = "#{::File.dirname caller_file_path}/#{::File.basename caller_file_path, '.rb'}"
-    other_module.module_eval <<-end_module_eval, __FILE__, __LINE__
-      def self.autoload?(symbol)
-        if (old_school = super)
-          return old_school
-        end
-
-        require 'autoloaded/constant'
-        filenames = []
-        ::Autoloaded::Constant.new(symbol).each_matching_filename_in #{dir_path.inspect} do |filename|
-          filenames << filename
-        end
-        (filenames.length <= 1) ? filenames.first : filenames
-      end
-
-      def self.const_missing(symbol)
-        require 'autoloaded/constant'
-        ::Autoloaded::Constant.new(symbol).each_matching_filename_in #{dir_path.inspect} do |filename|
-          require filename
-          if const_defined?(symbol)
-            begin
-              return const_get(symbol)
-            rescue ::NameError
-            end
-          end
-        end
-
-        super
-      end
-    end_module_eval
-  end
-
   # @!method self.module
   #   Autoloads constants that match files in the source directory.
   #

data/lib/autoloaded/autoloader.rb

@@ -1,9 +1,3 @@
-require 'autoloaded/inflection'
-require 'autoloaded/load_pathed_directory'
-require 'autoloaded/specification'
-require 'autoloaded/specifications'
-require 'autoloaded/warning'
-
 module Autoloaded
 
   # Autoloads files in a source directory.
@@ -13,7 +7,7 @@ module Autoloaded
 
     # The source code context in which autoloading is to occur.
     #
-    # @return [Binding]
+    # @return [Binding] the source code context in which autoloading is to occur.
     #
     # @see #autoload!
     #
@@ -41,8 +35,8 @@ module Autoloaded
     # @return [Array of Array] the arguments passed to each +autoload+ statement
     #                          made
     #
-    # @see https://ruby-doc.org/core/Module.html#method-i-autoload Module#autoload
-    # @see https://ruby-doc.org/core/Kernel.html#method-i-autoload Kernel#autoload
+    # @see http://ruby-doc.org/core/Module.html#method-i-autoload Module#autoload
+    # @see http://ruby-doc.org/core/Kernel.html#method-i-autoload Kernel#autoload
     # @see #from
     # @see #except
     # @see #only
@@ -85,11 +79,6 @@ module Autoloaded
           constant_names.each do |const|
             next unless existing_constant?(const)
 
-            # Don't warn about an existing MyAwesomeGem::VERSION constant since
-            # probably it was loaded by a `require 'my_awesome_gem/version'`
-            # statement in 'my_awesome_gem.gemspec'.
-            next if (const == :VERSION)
-
             Warning.existing_constant constant_name:        constant_full_name(const),
                                       source_filename:      source_filename,
                                       host_source_location: host_source_location
@@ -177,7 +166,7 @@ module Autoloaded
     #
     #   @see #autoload!
     #   @see #from
-    %i(except only with).each do |attr|
+    [:except, :only, :with].each do |attr|
       define_method attr do |*arguments|
         attr_specs = specifications.send(attr)
         if arguments.empty?
@@ -213,10 +202,7 @@ module Autoloaded
     # @see #autoload!
     # @see #host_binding
     def from(value=nil)
-      if value.nil?
-        return (instance_variable_defined?(:@from) && @from && @from.path) ||
-               default_from
-      end
+      return((@from && @from.path) || default_from) if value.nil?
 
       # Validate value.
       @from = LoadPathedDirectory.new(value)
@@ -252,8 +238,7 @@ module Autoloaded
     end
 
     def from_load_pathed_directory
-      (instance_variable_defined?(:@from) && @from) ||
-        LoadPathedDirectory.new(default_from)
+      @from || LoadPathedDirectory.new(default_from)
     end
 
     def host_eval(statement)
@@ -263,19 +248,11 @@ module Autoloaded
     end
 
     def host_source_filename
-      if host_binding.respond_to?(:source_location)
-        host_eval "::File.expand_path '#{host_binding.source_location.first}'"
-      else
-        host_eval '::File.expand_path __FILE__'
-      end
+      host_eval '::File.expand_path __FILE__'
     end
 
     def host_source_location
-      if host_binding.respond_to?(:source_location)
-        host_binding.source_location
-      else
-        host_eval('[__FILE__, __LINE__]')
-      end.collect(&:to_s).join ':'
+      host_eval('[__FILE__, __LINE__]').collect(&:to_s).join ':'
     end
 
   end

data/lib/autoloaded/deprecation.rb

@@ -1,3 +1,5 @@
+module Autoloaded; end
+
 # Prints deprecation messages to _stderr_.
 #
 # @since 1.3
@@ -22,21 +24,28 @@ module Autoloaded::Deprecation
     # Prints a deprecation message to _#io_ regarding the specified
     # _deprecated_usage_.
     #
-    # @param [String] deprecated_usage API usage that is soon to be discontinued
-    # @param [String] sanctioned_usage API usage that will succeed
-    #                                  _deprecated_usage_
-    # @param [String] source_filename  the file path of the source invoking the
-    #                                  deprecated API
+    # @param [Hash] keywords the parameters of the deprecation message
+    # @option keywords [String] :deprecated_usage API usage that is soon to be
+    #                                             discontinued
+    # @option keywords [String] :sanctioned_usage API usage that will succeed
+    #                                             _:deprecated_usage_
+    # @option keywords [String] :source_filename  the file path of the source
+    #                                             invoking the deprecated API
     #
     # @return [Module] _Deprecation_
     #
     # @raise [ArgumentError] one or more keywords are missing
-    def deprecate(deprecated_usage: raise(::ArgumentError,
-                                          'missing keyword: deprecated_usage'),
-                  sanctioned_usage: raise(::ArgumentError,
-                                          'missing keyword: sanctioned_usage'),
-                  source_filename:  raise(::ArgumentError,
-                                          'missing keyword: source_filename'))
+    def deprecate(keywords)
+      deprecated_usage = keywords.fetch :deprecated_usage do
+        raise ::ArgumentError, 'missing keyword: deprecated_usage'
+      end
+      sanctioned_usage = keywords.fetch :sanctioned_usage do
+        raise ::ArgumentError, 'missing keyword: sanctioned_usage'
+      end
+      source_filename = keywords.fetch :source_filename do
+        raise ::ArgumentError, 'missing keyword: source_filename'
+      end
+
       deprecation = "\e[33m*** \e[7m DEPRECATED \e[0m "     +
                     "\e[4m#{deprecated_usage}\e[0m -- use " +
                     "\e[4m#{sanctioned_usage}\e[0m instead in #{source_filename}"

data/lib/autoloaded/inflection.rb

@@ -1,6 +1,8 @@
+module Autoloaded; end
+
 # Translates source filenames into constants.
-#
-# @since 1.3
+  #
+  # @since 1.3
 #
 # @api private
 module Autoloaded::Inflection
@@ -19,11 +21,11 @@ module Autoloaded::Inflection
     source_filename = source_filename.to_s
     raise(::ArgumentError, "can't be blank") if source_filename.empty?
 
-    translate(source_filename, *%i(file_basename
-                                   camelize_if_lowercase
-                                   nonalphanumeric_to_underscore
-                                   delete_leading_nonalphabetic
-                                   capitalize_first)).to_sym
+    translate(source_filename, *[:file_basename,
+                                 :camelize_if_lowercase,
+                                 :nonalphanumeric_to_underscore,
+                                 :delete_leading_nonalphabetic,
+                                 :capitalize_first]).to_sym
   end
 
 private

data/lib/autoloaded/load_pathed_directory.rb

@@ -1,5 +1,7 @@
 require 'pathname'
 
+module Autoloaded; end
+
 # Enumerates the source files in a directory, relativizing their paths using the
 # Ruby load path.
 #
@@ -61,7 +63,7 @@ public
   # @return [LoadPathedDirectory] the _LoadPathedDirectory_
   #
   # @see #path
-  # @see https://ruby-doc.org/core/Kernel.html#method-i-require Kernel#require
+  # @see http://ruby-doc.org/core/Kernel.html#method-i-require Kernel#require
   def each_source_filename
     if (ruby_load_path = closest_ruby_load_path)
       ::Dir.chdir ruby_load_path do
@@ -95,7 +97,7 @@ private
     # Don't use Pathname#relative_path_from because we want to avoid introducing
     # double dots. The intent is to render the path as relative, if and only if
     # it is a subdirectory of 'other_path'.
-    pattern = /^#{::Regexp.escape other_path.to_s.chomp(::File::SEPARATOR)}#{::Regexp.escape ::File::SEPARATOR}?/
+    pattern = /^#{::Regexp.escape other_path.chomp(::File::SEPARATOR)}#{::Regexp.escape ::File::SEPARATOR}?/
     path.gsub pattern, ''
   end
 

data/lib/autoloaded/specification.rb

@@ -1,5 +1,3 @@
-require 'autoloaded/inflection'
-
 module Autoloaded
 
   # Describes regulations for autoloading.

data/lib/autoloaded/specifications.rb

@@ -1,3 +1,5 @@
+module Autoloaded; end
+
 # Holds regulations for autoloading.
 #
 # @since 1.3
@@ -6,40 +8,32 @@
 class Autoloaded::Specifications
 
   # @!method except
-  #   _Specifications_ for excluding source files from being autoloaded.
-  #
-  #   @return [Array of Specification]
+  #   Specifications for excluding source files from being autoloaded.
   #
-  #   @see Specification
+  #   @return [Array of Specification] a list of specifications
   #
   #   @api private
   #
   # @!method only
-  #   _Specifications_ for narrowing the set of source files being autoloaded as
+  #   Specifications for narrowing the set of source files being autoloaded as
   #   well as optionally renaming and/or reorganizing their corresponding
   #   constants.
   #
-  #   @return [Array of Specification]
-  #
-  #   @see Specification
+  #   @return [Array of Specification] a list of specifications
   #
   #   @api private
   #
   # @!method with
-  #   _Specifications_ for renaming and/or reorganizing the constants corresponding
+  #   Specifications for renaming and/or reorganizing the constants corresponding
   #   to source files being autoloaded.
   #
-  #   @return [Array of Specification]
-  #
-  #   @see Specification
+  #   @return [Array of Specification] a list of specifications
   #
   #   @api private
-  %i(except only with).each do |attribute_name|
+  [:except, :only, :with].each do |attribute_name|
     define_method attribute_name do
       variable_name = "@#{attribute_name}"
-      ((instance_variable_defined?(variable_name) &&
-        instance_variable_get(variable_name)) ||
-       []).tap do |value|
+      (instance_variable_get(variable_name) || []).tap do |value|
         instance_variable_set variable_name, value
       end
     end

data/lib/autoloaded/version.rb

@@ -3,6 +3,6 @@ module Autoloaded
   # The current version of the _Autoloaded_ project.
   #
   # @since 0.0.1
-  VERSION = '1.6.0'
+  VERSION = '2.0.0'
 
 end

data/lib/autoloaded/warning.rb

@@ -1,3 +1,5 @@
+module Autoloaded; end
+
 # Prints warning messages to _stderr_.
 #
 # @since 1.3
@@ -22,25 +24,33 @@ module Autoloaded::Warning
     # Prints a warning message to _#io_ concerning an existing autoloaded
     # constant for which the autoloaded source file is being changed.
     #
-    # @param [Symbol] constant_name        the name of the constant
-    # @param [String] old_source_filename  the name of the existing autoloaded
-    #                                      source file
-    # @param [String] new_source_filename  the name of the new autoloaded source
-    #                                      file
-    # @param [String] host_source_location the file and line number of the source
-    #                                      establishing autoloading
+    # @param [Hash] keywords the parameters of the warning message
+    # @option keywords [Symbol] :constant_name        the name of the constant
+    # @option keywords [String] :old_source_filename  the name of the existing
+    #                                                 autoloaded source file
+    # @option keywords [String] :new_source_filename  the name of the new
+    #                                                 autoloaded source file
+    # @option keywords [String] :host_source_location the file and line number of
+    #                                                 the source establishing
+    #                                                 autoloading
     #
     # @return [Module] _Warning_
     #
     # @raise [ArgumentError] one or more keywords are missing
-    def changing_autoload(constant_name:        raise(::ArgumentError,
-                                                      'missing keyword: constant_name'),
-                          old_source_filename:  raise(::ArgumentError,
-                                                      'missing keyword: old_source_filename'),
-                          new_source_filename:  raise(::ArgumentError,
-                                                      'missing keyword: new_source_filename'),
-                          host_source_location: raise(::ArgumentError,
-                                                      'missing keyword: host_source_location'))
+    def changing_autoload(keywords)
+      constant_name = keywords.fetch :constant_name do
+        raise ::ArgumentError, 'missing keyword: constant_name'
+      end
+      old_source_filename = keywords.fetch :old_source_filename do
+        raise ::ArgumentError, 'missing keyword: old_source_filename'
+      end
+      new_source_filename = keywords.fetch :new_source_filename do
+        raise ::ArgumentError, 'missing keyword: new_source_filename'
+      end
+      host_source_location = keywords.fetch :host_source_location do
+        raise ::ArgumentError, 'missing keyword: host_source_location'
+      end
+
       message = "Existing autoload of \e[4m#{constant_name}\e[0m from "       +
                 "#{old_source_filename.inspect} is being overridden to "      +
                 "autoload from #{new_source_filename.inspect} -- avoid this " +
@@ -62,7 +72,7 @@ module Autoloaded::Warning
     #
     # @see .enabled?
     def enable(enabling)
-      previous_value = instance_variable_defined?(:@disabled) && @disabled
+      previous_value = @disabled
       @disabled = not!(enabling)
       if block_given?
         begin
@@ -88,20 +98,28 @@ module Autoloaded::Warning
     # Prints a warning message to _#io_ concerning a defined constant for which
     # autoloading is being established.
     #
-    # @param [Symbol] constant_name        the name of the constant
-    # @param [String] source_filename      the name of the autoloaded source file
-    # @param [String] host_source_location the file and line number of the source
-    #                                      establishing autoloading
+    # @param [Hash] keywords the parameters of the warning message
+    # @option keywords [Symbol] :constant_name        the name of the constant
+    # @option keywords [String] :source_filename      the name of the autoloaded
+    #                                                 source file
+    # @option keywords [String] :host_source_location the file and line number of
+    #                                                 the source establishing
+    #                                                 autoloading
     #
     # @return [Module] _Warning_
     #
     # @raise [ArgumentError] one or more keywords are missing
-    def existing_constant(constant_name:        raise(::ArgumentError,
-                                                      'missing keyword: constant_name'),
-                          source_filename:      raise(::ArgumentError,
-                                                      'missing keyword: source_filename'),
-                          host_source_location: raise(::ArgumentError,
-                                                      'missing keyword: host_source_location'))
+    def existing_constant(keywords)
+      constant_name = keywords.fetch :constant_name do
+        raise ::ArgumentError, 'missing keyword: constant_name'
+      end
+      source_filename = keywords.fetch :source_filename do
+        raise ::ArgumentError, 'missing keyword: source_filename'
+      end
+      host_source_location = keywords.fetch :host_source_location do
+        raise ::ArgumentError, 'missing keyword: host_source_location'
+      end
+
       message = "Existing definition of \e[4m#{constant_name}\e[0m obviates " +
                 "autoloading from #{source_filename.inspect} -- avoid this "  +
                 "warning by using an \e[4monly\e[0m or an \e[4mexcept\e[0m "  +

data/lib/tasks/lib_each.rake

@@ -1,25 +1,13 @@
 namespace :lib do
-  desc "Check the source for missing 'require' statements. Set the 'VERBOSE' " +
-       'environment variable to "t[rue]" to display the name of each file as ' +
-       'it is loaded.'
+  desc "Load each library file individually, looking for missing 'require' statements"
   task :each do
-    def verbose?
-      ENV['VERBOSE'].to_s =~ /^T/i
-    end
-
     Dir.chdir 'lib' do
       Dir.glob( '**/*.rb' ) do |f|
         next if f == 'tasks.rb'
 
-        if verbose?
-          puts "* #{f}"
-        else
-          print "\e[32m.\e[0m"
-        end
-        command = "/usr/bin/env ruby -e 'require File.expand_path(#{f.inspect})'"
-        break unless system(command)
+        puts "Loading #{f} ..."
+        fail unless system( "/usr/bin/env bundle exec ruby -e 'require #{f.inspect}'" )
       end
     end
-    puts unless verbose?
   end
 end

data/lib/tasks/spec.rake

@@ -44,8 +44,7 @@ else
       else
         noun_phrase = "#{uncommitted_spec_files.length} uncommitted spec file#{(uncommitted_spec_files.length == 1) ? nil : 's'}"
         desc = "Run #{noun_phrase}"
-        define_spec_task :uncommitted, desc:    desc,
-                                       pattern: uncommitted_spec_files
+        define_spec_task :uncommitted, desc: desc, pattern: uncommitted_spec_files
       end
     else
       noun_phrase = "#{uncommitted_files_in_spec.length} uncommitted file#{uncommitted_files_in_spec.length == 1 ? nil : 's'}"
@@ -53,12 +52,16 @@ else
       define_spec_task :uncommitted, desc: desc, pattern: 'spec'
     end
 
-    define_spec_task :warnings, desc:     'Run specs with Ruby warnings enabled',
+    define_spec_task :warnings, desc: 'Run specs with Ruby warnings enabled',
                                 format:   :progress,
                                 profile:  false,
                                 warnings: true
   end
 
+  desc 'Run specs'
+  task ''       => :spec
+  task :default => :spec
+
   # Support the 'gem test' command.
   define_spec_task :test, desc: '', backtrace: true,
                                     debug:     false,