autoloaded 1.6.0 → 2.0.0

data/spec/autoloaded_macro_sharedspec.rb

@@ -0,0 +1,24 @@
+RSpec.shared_examples_for "an #{Autoloaded.name} macro" do |macro|
+  before :each do
+    allow(autoloader_class).to receive(:new).and_return(autoloader)
+    allow_any_instance_of(autoloader_class).to receive(:autoload!)
+  end
+
+  let(:autoloaded_module) { Autoloaded }
+
+  let(:autoloader) { autoloader_class.new binding }
+
+  let(:autoloader_class) { autoloaded_module::Autoloader }
+
+  specify("yields an #{Autoloaded::Autoloader.name}") {
+    autoloaded_module.send macro do |autoloaded|
+      expect(autoloaded).to equal(autoloader)
+    end
+  }
+
+  specify("calls #{Autoloaded::Autoloader.name}#autoload!") {
+    expect(autoloader).to receive(:autoload!)
+    autoloaded_module.send macro do |autoloaded|
+    end
+  }
+end

data/spec/autoloaded_spec.rb

@@ -0,0 +1,173 @@
+require 'autoloaded_macro_sharedspec'
+require 'matchers'
+require 'stringio'
+
+RSpec.describe Autoloaded do
+  let(:autoloaded_module) { described_class }
+
+  let(:warning_module) { autoloaded_module::Warning }
+
+  describe '.class' do
+    it_behaves_like "an #{Autoloaded.name} macro", :class
+  end
+
+  describe '.module' do
+    it_behaves_like "an #{Autoloaded.name} macro", :module
+  end
+
+  describe '.warn' do
+    describe 'simple form' do
+      before :each do
+        allow(warning_module).to receive(:enable).
+                                 and_return(:warning_enable_result)
+      end
+
+      specify("delegates to #{Autoloaded::Warning.name}.enable") {
+        expect(warning_module).to receive(:enable).
+                                  with('foo').
+                                  and_return(:warning_enable_result)
+        autoloaded_module.warn 'foo'
+      }
+
+      specify("returns #{Autoloaded.name}") {
+        expect(autoloaded_module.warn('foo')).to eq(autoloaded_module)
+      }
+    end
+
+    describe 'block form' do
+      specify("delegates to #{Autoloaded::Warning.name}.enable") {
+        expect(warning_module).to receive(:enable).
+                                  with('foo').
+                                  and_yield.
+                                  and_return(:warning_enable_result)
+        result = autoloaded_module.warn('foo') do
+          :block_result
+        end
+        expect(result).to eq(:warning_enable_result)
+      }
+    end
+  end
+
+  describe '.warn?' do
+    specify("delegates to #{Autoloaded::Warning.name}.enabled?") {
+      expect(warning_module).to receive(:enabled?).
+                                and_return(:warning_enabled_result)
+      expect(autoloaded_module.warn?).to eq(:warning_enabled_result)
+    }
+  end
+
+  describe 'integration' do
+    before :each do
+      class << self
+        alias_method :define_constant, :define_constants
+      end
+    end
+
+    begin
+      fork do
+        # The codeclimate-test-reporter RubyGem uses Kernel#at_exit to hook the
+        # end of test/spec runs for sending coverage statistics to their web
+        # service. We need to skip that hook in this process fork because this is
+        # not the end of a test/spec run, only of a process fork.
+        exit!(true) if ENV['CODECLIMATE_REPO_TOKEN']
+      end
+    rescue NotImplementedError => e
+      pending "[pending because #{e.message}]"
+    else
+      describe 'not extending a namespace' do
+        subject(:source_file) { 'spec/fixtures/not_autoloaded.rb' }
+
+        it { is_expected.to define_constant(:NotAutoloaded) }
+
+        it { is_expected.to define_constant('NotAutoloaded::OldSchoolAutoload') }
+
+        it { is_expected.not_to define_constant('NotAutoloaded::Nested') }
+
+        it {
+          is_expected.to set_up_autoload_for_constant('NotAutoloaded::OldSchoolAutoload').
+                         from_file('fixtures/not_autoloaded/old_school_autoload')
+        }
+
+        it {
+          is_expected.not_to set_up_autoload_for_constant('NotAutoloaded::Nested')
+        }
+      end
+
+      describe 'extending a namespace whose constituent source files include' do
+        describe 'a conventional source filename used for autoloading' do
+          subject(:source_file) {
+            'spec/fixtures/autoloaded_with_conventional_filename.rb'
+          }
+
+          it {
+            is_expected.to define_constant(:AutoloadedWithConventionalFilename)
+          }
+
+          it {
+            is_expected.to define_constant('AutoloadedWithConventionalFilename::OldSchoolAutoload')
+          }
+
+          it {
+            is_expected.to define_constant('AutoloadedWithConventionalFilename::Nested')
+          }
+
+          it {
+            is_expected.not_to define_constant('AutoloadedWithConventionalFilename::NONEXISTENT')
+          }
+
+          it {
+            is_expected.to set_up_autoload_for_constant('AutoloadedWithConventionalFilename::OldSchoolAutoload').
+                           from_file('fixtures/autoloaded_with_conventional_filename/old_school_autoload')
+          }
+
+          it {
+            is_expected.to set_up_autoload_for_constant('AutoloadedWithConventionalFilename::Nested').
+                           from_file('fixtures/autoloaded_with_conventional_filename/nested')
+          }
+
+          it {
+            is_expected.not_to set_up_autoload_for_constant('AutoloadedWithConventionalFilename::NONEXISTENT')
+          }
+        end
+
+        describe 'unconventional source filenames' do
+          subject(:source_file) {
+            'spec/fixtures/autoloaded_with_unconventional_filename.rb'
+          }
+
+          it {
+            is_expected.to define_constant(:AutoloadedWithUnconventionalFilename)
+          }
+
+          it {
+            is_expected.to define_constant('AutoloadedWithUnconventionalFilename::OldSchoolAutoload')
+          }
+
+          it {
+            is_expected.to define_constants('AutoloadedWithUnconventionalFilename::Nested1',
+                                            'AutoloadedWithUnconventionalFilename::Nested2')
+          }
+
+          it {
+            is_expected.to set_up_autoload_for_constant('AutoloadedWithUnconventionalFilename::OldSchoolAutoload').
+                           from_file('fixtures/autoloaded_with_unconventional_filename/old_school_autoload')
+          }
+
+          it {
+            is_expected.to set_up_autoload_for_constant('AutoloadedWithUnconventionalFilename::Nested1').
+                           from_file('fixtures/autoloaded_with_unconventional_filename/N-est-ed')
+          }
+
+          it {
+            is_expected.to set_up_autoload_for_constant('AutoloadedWithUnconventionalFilename::Nested2').
+                           from_file('fixtures/autoloaded_with_unconventional_filename/N-est-ed')
+          }
+
+          it {
+            is_expected.not_to set_up_autoload_for_constant('AutoloadedWithUnconventionalFilename::NONEXISTENT')
+          }
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/autoloaded_with_conventional_filename.rb

@@ -0,0 +1,12 @@
+require 'autoloaded'
+
+module AutoloadedWithConventionalFilename
+
+  autoload :OldSchoolAutoload,
+           'fixtures/autoloaded_with_conventional_filename/old_school_autoload'
+
+  ::Autoloaded.module do |autoloaded|
+    autoloaded.except 'N-est-ed', 'nest_ed'
+  end
+
+end

data/spec/fixtures/autoloaded_with_conventional_filename/N-est-ed.rb

@@ -0,0 +1 @@
+raise "The file #{__FILE__} should not have been loaded"

data/spec/fixtures/autoloaded_with_conventional_filename/nest_ed.rb

@@ -0,0 +1 @@
+raise "The file #{__FILE__} should not have been loaded"

data/spec/fixtures/autoloaded_with_conventional_filename/nested.rb

@@ -0,0 +1,16 @@
+require 'autoloaded'
+
+module AutoloadedWithConventionalFilename
+
+  module Nested
+
+    # module DoublyNested; end
+    # autoload :DoublyNested, 'somewhere/else'
+
+    ::Autoloaded.module { }
+
+    DoublyNested
+
+  end
+
+end

data/spec/fixtures/autoloaded_with_conventional_filename/nested/doubly_nested.rb

@@ -0,0 +1,9 @@
+module AutoloadedWithConventionalFilename
+
+  module Nested
+
+    module DoublyNested; end
+
+  end
+
+end

data/spec/fixtures/autoloaded_with_conventional_filename/old_school_autoload.rb

@@ -0,0 +1,5 @@
+module AutoloadedWithConventionalFilename
+
+  module OldSchoolAutoload; end
+
+end

data/spec/fixtures/autoloaded_with_unconventional_filename.rb

@@ -0,0 +1,12 @@
+require 'autoloaded'
+
+module AutoloadedWithUnconventionalFilename
+
+  autoload :OldSchoolAutoload,
+           'fixtures/autoloaded_with_unconventional_filename/old_school_autoload'
+
+  ::Autoloaded.module do |autoloaded|
+    autoloaded.only 'N-est-ed' => [:Nested1, :Nested2]
+  end
+
+end

data/spec/fixtures/autoloaded_with_unconventional_filename/N-est-ed.rb

@@ -0,0 +1,7 @@
+module AutoloadedWithUnconventionalFilename
+
+  module Nested1; end
+
+  module Nested2; end
+
+end

data/spec/fixtures/autoloaded_with_unconventional_filename/nest_ed.rb

@@ -0,0 +1 @@
+raise "The file #{__FILE__} should not have been loaded"

data/spec/fixtures/autoloaded_with_unconventional_filename/old_school_autoload.rb

@@ -0,0 +1,5 @@
+module AutoloadedWithUnconventionalFilename
+
+  module OldSchoolAutoload; end
+
+end

data/spec/fixtures/not_autoloaded.rb

@@ -0,0 +1,5 @@
+module NotAutoloaded
+
+  autoload :OldSchoolAutoload, 'fixtures/not_autoloaded/old_school_autoload'
+
+end

data/spec/fixtures/not_autoloaded/nested.rb

@@ -0,0 +1 @@
+raise "The file #{__FILE__} should not have been loaded"

data/spec/fixtures/not_autoloaded/old_school_autoload.rb

@@ -0,0 +1,5 @@
+module NotAutoloaded
+
+  module OldSchoolAutoload; end
+
+end

data/spec/matchers.rb

@@ -0,0 +1,85 @@
+require 'support/util'
+require 'support/without_side_effects'
+
+RSpec::Matchers.define :define_constants do |*constant_names|
+  match do |source_file|
+    # Ensure the file exists.
+    File.open source_file, 'r' do
+    end
+
+    without_side_effects do
+      constant_names.each do |constant_name|
+        if Util.constantize(constant_name)
+          fail "constant #{constant_name} is already defined outside #{source_file}"
+        end
+      end
+
+      load source_file
+
+      constant_names.all? do |constant_name|
+        Util.namespace_and_unqualified_constant_name constant_name,
+                                                     raise_if_namespace_invalid: true
+        Util.constantize constant_name
+      end
+    end
+  end
+
+  description do
+    fragments = []
+    fragments << case constant_names.length
+                   when 0
+                     'no constants'
+                   when 1
+                     "constant #{constant_names.first}"
+                   else
+                     "constants #{constant_names.join ' and '}"
+                 end
+    "define #{fragments.join ' '}"
+  end
+end
+
+RSpec::Matchers.define :set_up_autoload_for_constant do |constant_name|
+  match do |source_file|
+    # Ensure the file exists.
+    File.open source_file, 'r' do
+    end
+
+    without_side_effects do
+      namespace, unqualified_constant_name = Util.namespace_and_unqualified_constant_name(constant_name)
+      if namespace && namespace.autoload?(unqualified_constant_name)
+        fail "#{namespace.name}::#{unqualified_constant_name} is already set up for autoload outside #{source_file}"
+      end
+
+      load source_file
+
+      namespace, unqualified_constant_name = Util.namespace_and_unqualified_constant_name(constant_name,
+                                                                                          raise_if_namespace_invalid: true)
+      if filename_or_filenames
+        Array(filename_or_filenames).sort == Array(namespace.autoload?(unqualified_constant_name)).sort
+      else
+        namespace.autoload? unqualified_constant_name
+      end
+    end
+  end
+
+  chain :from_file do |filename|
+    @filename_or_filenames = filename
+  end
+
+  chain :from_files do |*filenames|
+    @filename_or_filenames = filenames
+  end
+
+  description do
+    fragments = []
+    fragments << "constant #{constant_name}"
+    if filename_or_filenames
+      unless (filenames = Array(filename_or_filenames)).empty?
+        fragments << "from file#{(filenames.length == 1) ? nil : 's'} #{filenames.join ' and '}"
+      end
+    end
+    "set up #{Module.name}#autoload? for #{fragments.join ' '}"
+  end
+
+  attr_reader :filename_or_filenames
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+require 'codeclimate-test-reporter'
+
+CodeClimate::TestReporter.start
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  # config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 1
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end
+
+require 'autoloaded'