autoloaded 1.2.0 → 1.3.0

data/spec/autoloaded/version_spec.rb

@@ -1,5 +1,3 @@
-require 'autoloaded/version'
-
 RSpec.describe "#{Autoloaded.name}::VERSION" do
   specify { expect(Autoloaded::VERSION).to match( /^\d+\.\d+\.\d+/ ) }
 end

data/spec/autoloaded/warning_spec.rb

@@ -0,0 +1,115 @@
+require 'stringio'
+
+RSpec.describe Autoloaded::Warning do
+  before :each do
+    warning_module.io = io
+  end
+
+  let(:warning_module) { described_class }
+
+  let(:io) { StringIO.new }
+
+  describe '.enable' do
+    describe 'simple form' do
+      describe 'with nil argument' do
+        specify('sets .enabled? as expected') {
+          warning_module.enable nil
+          expect(warning_module.enabled?).to eq(false)
+        }
+      end
+
+      describe 'with false argument' do
+        specify('sets .enabled? as expected') {
+          warning_module.enable false
+          expect(warning_module.enabled?).to eq(false)
+        }
+      end
+
+      describe 'with string argument' do
+        specify('sets .enabled? as expected') {
+          warning_module.enable 'foo'
+          expect(warning_module.enabled?).to eq(true)
+        }
+      end
+
+      describe 'with true argument' do
+        specify('sets .enabled? as expected') {
+          warning_module.enable true
+          expect(warning_module.enabled?).to eq(true)
+        }
+      end
+
+      specify("returns #{Autoloaded::Warning.name}") {
+        expect(warning_module.enable('foo')).to eq(warning_module)
+      }
+    end
+
+    describe 'block form' do
+      specify('returns the result of the block') {
+        result = warning_module.enable('foo') do
+          :block_result
+        end
+        expect(result).to eq(:block_result)
+      }
+
+      describe 'if the block returns' do
+        specify('resets .enabled?') {
+          expect {
+            warning_module.enable(false) { }
+          }.not_to change { warning_module.enabled? }
+          expect {
+            warning_module.enable(true) { }
+          }.not_to change { warning_module.enabled? }
+        }
+      end
+
+      describe 'if the block raises an error' do
+        specify('resets .enabled?') {
+          expect {
+            begin
+              warning_module.enable(false) do
+                1 / 0
+              end
+            rescue ZeroDivisionError
+            end
+          }.not_to change { warning_module.enabled? }
+          expect {
+            begin
+              warning_module.enable(true) do
+                1 / 0
+              end
+            rescue ZeroDivisionError
+            end
+          }.not_to change { warning_module.enabled? }
+        }
+      end
+    end
+  end
+
+  describe '.changing_autoload' do
+    before :each do
+      warning_module.enable true
+      warning_module.changing_autoload constant_name:        :Foo,
+                                       old_source_filename:  'bar',
+                                       new_source_filename:  'baz',
+                                       host_source_location: 'qux.rb:123'
+    end
+
+    specify('writes the expected message to .io') {
+      expect(io.string).to eq(%Q(\e[33m*** \e[7m WARNING \e[0m Existing autoload of \e[4mFoo\e[0m from "bar" is being overridden to autoload from "baz" -- avoid this warning by using an \e[4monly\e[0m or an \e[4mexcept\e[0m specification in the block at qux.rb:123\n))
+    }
+  end
+
+  describe '.existing_constant' do
+    before :each do
+      warning_module.enable true
+      warning_module.existing_constant constant_name:        :Foo,
+                                       source_filename:      'bar',
+                                       host_source_location: 'baz.rb:123'
+    end
+
+    specify('writes the expected message to .io') {
+      expect(io.string).to eq(%Q(\e[33m*** \e[7m WARNING \e[0m Existing definition of \e[4mFoo\e[0m obviates autoloading from "bar" -- avoid this warning by using an \e[4monly\e[0m or an \e[4mexcept\e[0m specification in the block at baz.rb:123\n))
+    }
+  end
+end

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

@@ -1,138 +1,320 @@
-require 'autoloaded'
+require 'autoloaded_macro_sharedspec'
 require 'matchers'
+require 'stringio'
 
 RSpec.describe Autoloaded do
-  before :each do
-    class << self
-      alias_method :define_constant, :define_constants
-    end
-  end
+  let(:autoloaded_module) { described_class }
 
-  begin
-    fork
-  rescue NotImplementedError => e
-    pending "[pending because #{e.message}]"
-  else
-    describe 'not extending a namespace' do
-      subject(:source_file) { 'spec/fixtures/not_autoloaded.rb' }
+  let(:warning_module) { autoloaded_module::Warning }
 
-      it { is_expected.to define_constant(:NotAutoloaded) }
+  describe '.class' do
+    it_behaves_like "an #{Autoloaded.name} macro", :class
+  end
 
-      it { is_expected.to define_constant('NotAutoloaded::OldSchoolAutoload') }
+  describe '.module' do
+    it_behaves_like "an #{Autoloaded.name} macro", :module
+  end
 
-      it { is_expected.not_to define_constant('NotAutoloaded::Nested') }
+  describe '.warn' do
+    describe 'simple form' do
+      before :each do
+        allow(warning_module).to receive(:enable).
+                                 and_return(:warning_enable_result)
+      end
 
-      it {
-        is_expected.to set_up_autoload_for_constant('NotAutoloaded::OldSchoolAutoload').
-                       from_file('fixtures/not_autoloaded/old_school_autoload')
+      specify("delegates to #{Autoloaded::Warning.name}.enable") {
+        expect(warning_module).to receive(:enable).
+                                  with('foo').
+                                  and_return(:warning_enable_result)
+        autoloaded_module.warn 'foo'
       }
 
-      it {
-        is_expected.not_to set_up_autoload_for_constant('NotAutoloaded::Nested')
+      specify("returns #{Autoloaded.name}") {
+        expect(autoloaded_module.warn('foo')).to eq(autoloaded_module)
       }
     end
 
-    describe 'extending a namespace whose constituent source files have' do
-      describe 'conventional names used for autoloading' do
-        subject(:source_file) {
-          'spec/fixtures/autoloaded_with_conventional_filename.rb'
-        }
+    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
 
-        it { is_expected.to define_constant(:AutoloadedWithConventionalFilename) }
+  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
 
-        it {
-          is_expected.to define_constant('AutoloadedWithConventionalFilename::OldSchoolAutoload')
-        }
+  describe 'integration' do
+    before :each do
+      class << self
+        alias_method :define_constant, :define_constants
+      end
+    end
 
-        it {
-          is_expected.to define_constant('AutoloadedWithConventionalFilename::Nested').
-                         dynamically
-        }
+    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.not_to define_constant('AutoloadedWithConventionalFilename::NONEXISTENT')
-        }
+        it { is_expected.to define_constant(:NotAutoloaded) }
 
-        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 define_constant('NotAutoloaded::OldSchoolAutoload') }
+
+        it { is_expected.not_to define_constant('NotAutoloaded::Nested') }
 
         it {
-          is_expected.to set_up_autoload_for_constant('AutoloadedWithConventionalFilename::Nested').
-                         from_files('fixtures/autoloaded_with_conventional_filename/nested',
-                                    'fixtures/autoloaded_with_conventional_filename/N-est-ed',
-                                    'fixtures/autoloaded_with_conventional_filename/nest_ed')
+          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('AutoloadedWithConventionalFilename::NONEXISTENT')
+          is_expected.not_to set_up_autoload_for_constant('NotAutoloaded::Nested')
         }
       end
 
-      describe 'conventional names' do
-        subject(:source_file) {
-          'spec/fixtures/autoloaded_with_conventional_filename_only.rb'
-        }
+      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(:AutoloadedWithConventionalFilenameOnly) }
+          it {
+            is_expected.to define_constant(:AutoloadedWithConventionalFilename)
+          }
 
-        it {
-          is_expected.to define_constant('AutoloadedWithConventionalFilenameOnly::OldSchoolAutoload')
-        }
+          it {
+            is_expected.to define_constant('AutoloadedWithConventionalFilename::OldSchoolAutoload')
+          }
 
-        it {
-          is_expected.to define_constant('AutoloadedWithConventionalFilenameOnly::Nested').
-                         dynamically
-        }
+          it {
+            is_expected.to define_constant('AutoloadedWithConventionalFilename::Nested')
+          }
 
-        it {
-          is_expected.to set_up_autoload_for_constant('AutoloadedWithConventionalFilenameOnly::OldSchoolAutoload').
-                         from_file('fixtures/autoloaded_with_conventional_filename_only/old_school_autoload')
-        }
+          it {
+            is_expected.not_to define_constant('AutoloadedWithConventionalFilename::NONEXISTENT')
+          }
 
-        it {
-          is_expected.to set_up_autoload_for_constant('AutoloadedWithConventionalFilenameOnly::Nested').
-                         from_file('fixtures/autoloaded_with_conventional_filename_only/nested')
-        }
+          it {
+            is_expected.to set_up_autoload_for_constant('AutoloadedWithConventionalFilename::OldSchoolAutoload').
+                           from_file('fixtures/autoloaded_with_conventional_filename/old_school_autoload')
+          }
 
-        it {
-          is_expected.not_to set_up_autoload_for_constant('AutoloadedWithConventionalFilenameOnly::NONEXISTENT')
-        }
+          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
 
-      describe 'unconventional names' do
-        subject(:source_file) {
-          'spec/fixtures/autoloaded_with_unconventional_filenames.rb'
-        }
+    describe 'old API' do
+      before :each do
+        autoloaded_module::Deprecation.io = StringIO.new
+      end
 
-        it {
-          is_expected.to define_constant(:AutoloadedWithUnconventionalFilenames)
-        }
+      after :each do
+        autoloaded_module::Deprecation.io = nil
+      end
 
-        it {
-          is_expected.to define_constant('AutoloadedWithUnconventionalFilenames::OldSchoolAutoload')
-        }
+      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/old_api/not_autoloaded.rb' }
 
-        it {
-          is_expected.to define_constants('AutoloadedWithUnconventionalFilenames::Nested').
-                         dynamically
-        }
+          it { is_expected.to define_constant(:NotAutoloaded) }
 
-        it {
-          is_expected.to set_up_autoload_for_constant('AutoloadedWithUnconventionalFilenames::OldSchoolAutoload').
-                         from_file('fixtures/autoloaded_with_unconventional_filenames/old_school_autoload')
-        }
+          it {
+            is_expected.to define_constant('NotAutoloaded::OldSchoolAutoload')
+          }
 
-        it {
-          is_expected.to set_up_autoload_for_constant('AutoloadedWithUnconventionalFilenames::Nested').
-                         from_files('fixtures/autoloaded_with_unconventional_filenames/N-est-ed',
-                                    'fixtures/autoloaded_with_unconventional_filenames/nest_ed')
-        }
+          it { is_expected.not_to define_constant('NotAutoloaded::Nested') }
 
-        it {
-          is_expected.not_to set_up_autoload_for_constant('AutoloadedWithUnconventionalFilenames::NONEXISTENT')
-        }
+          it {
+            is_expected.to set_up_autoload_for_constant('NotAutoloaded::OldSchoolAutoload').
+                           from_file('fixtures/old_api/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/old_api/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/old_api/autoloaded_with_conventional_filename/old_school_autoload')
+            }
+
+            it {
+              is_expected.to set_up_autoload_for_constant('AutoloadedWithConventionalFilename::Nested').
+                             from_files('fixtures/old_api/autoloaded_with_conventional_filename/nested',
+                                        'fixtures/old_api/autoloaded_with_conventional_filename/N-est-ed',
+                                        'fixtures/old_api/autoloaded_with_conventional_filename/nest_ed')
+            }
+
+            it {
+              is_expected.not_to set_up_autoload_for_constant('AutoloadedWithConventionalFilename::NONEXISTENT')
+            }
+          end
+
+          describe 'a conventional source filename only' do
+            subject(:source_file) {
+              'spec/fixtures/old_api/autoloaded_with_conventional_filename_only.rb'
+            }
+
+            it {
+              is_expected.to define_constant(:AutoloadedWithConventionalFilenameOnly)
+            }
+
+            it {
+              is_expected.to define_constant('AutoloadedWithConventionalFilenameOnly::OldSchoolAutoload')
+            }
+
+            it {
+              is_expected.to define_constant('AutoloadedWithConventionalFilenameOnly::Nested')
+            }
+
+            it {
+              is_expected.to set_up_autoload_for_constant('AutoloadedWithConventionalFilenameOnly::OldSchoolAutoload').
+                             from_file('fixtures/old_api/autoloaded_with_conventional_filename_only/old_school_autoload')
+            }
+
+            it {
+              is_expected.to set_up_autoload_for_constant('AutoloadedWithConventionalFilenameOnly::Nested').
+                             from_file('fixtures/old_api/autoloaded_with_conventional_filename_only/nested')
+            }
+
+            it {
+              is_expected.not_to set_up_autoload_for_constant('AutoloadedWithConventionalFilenameOnly::NONEXISTENT')
+            }
+          end
+
+          describe 'unconventional source filenames' do
+            subject(:source_file) {
+              'spec/fixtures/old_api/autoloaded_with_unconventional_filenames.rb'
+            }
+
+            it {
+              is_expected.to define_constant(:AutoloadedWithUnconventionalFilenames)
+            }
+
+            it {
+              is_expected.to define_constant('AutoloadedWithUnconventionalFilenames::OldSchoolAutoload')
+            }
+
+            it {
+              is_expected.to define_constants('AutoloadedWithUnconventionalFilenames::Nested')
+            }
+
+            it {
+              is_expected.to set_up_autoload_for_constant('AutoloadedWithUnconventionalFilenames::OldSchoolAutoload').
+                             from_file('fixtures/old_api/autoloaded_with_unconventional_filenames/old_school_autoload')
+            }
+
+            it {
+              is_expected.to set_up_autoload_for_constant('AutoloadedWithUnconventionalFilenames::Nested').
+                             from_files('fixtures/old_api/autoloaded_with_unconventional_filenames/N-est-ed',
+                                        'fixtures/old_api/autoloaded_with_unconventional_filenames/nest_ed')
+            }
+
+            it {
+              is_expected.not_to set_up_autoload_for_constant('AutoloadedWithUnconventionalFilenames::NONEXISTENT')
+            }
+          end
+        end
       end
     end
   end