require_all 1.1.0 → 1.2.0

data/require_all.gemspec

@@ -1,26 +1,22 @@
-require 'rubygems'
-
-GEMSPEC = Gem::Specification.new do |s|
-  s.name = "require_all"
-  s.version = "1.1.0"
-  s.authors = "Tony Arcieri"
-  s.email = "tony@medioh.com"
-  s.date = "2009-07-18"
-  s.summary = "A wonderfully simple way to load your code"
-  s.platform = Gem::Platform::RUBY
-
-  # Gem contents
-  s.files = Dir.glob("{lib,spec}/**/*") + ['Rakefile', 'require_all.gemspec']
-
-  # RubyForge info
-  s.homepage = "http://github.com/tarcieri/require_all"
-  s.rubyforge_project = "codeforpeople"
-
-  # RDoc settings
-  s.has_rdoc = true
-  s.rdoc_options = %w(--title require_all --main README.textile --line-numbers)
-  s.extra_rdoc_files = ["LICENSE", "README.textile", "CHANGES"]
-
-  # Extensions
-  s.extensions = FileList["ext/**/extconf.rb"].to_a
-end
+require 'rubygems'
+
+GEMSPEC = Gem::Specification.new do |s|
+  s.name = "require_all"
+  s.version = "1.2.0"
+  s.authors = ["Jarmo Pertman", "Tony Arcieri"]
+  s.email = "jarmo.p@gmail.com"
+  s.date = "2010-09-14"
+  s.summary = "A wonderfully simple way to load your code"
+  s.platform = Gem::Platform::RUBY
+
+  # Gem contents
+  s.files = Dir.glob("{lib,spec}/**/*") + ['Rakefile', 'require_all.gemspec']
+
+  # RubyForge info
+  s.homepage = "http://github.com/jarmo/require_all"
+
+  # RDoc settings
+  s.has_rdoc = true
+  s.rdoc_options = %w(--title require_all --main README.textile --line-numbers)
+  s.extra_rdoc_files = ["LICENSE", "README.textile", "CHANGES"]
+end

data/spec/autoload_shared.rb

@@ -0,0 +1,78 @@
+# difference between "#require_all syntactic sugar" is the
+# need to specify :base_dir if performing autoloading below the top-level
+# module directory
+
+shared_examples_for "#autoload_all syntactic sugar" do
+  before :each do
+    @file_list = [
+            "#{@base_dir}/module1/a.rb",
+            "#{@base_dir}/module2/longer_name.rb",
+            "#{@base_dir}/module2/module3/b.rb"
+    ]
+  end
+
+  it "accepts files with and without extensions" do
+    should_not be_loaded("Autoloaded::Module2::LongerName")
+    send(@method, @base_dir + '/module2/longer_name', :base_dir => @autoload_base_dir).should be_true
+    should be_loaded("Autoloaded::Module2::LongerName")
+
+    should_not be_loaded("Autoloaded::Module1::A")
+    send(@method, @base_dir + '/module1/a.rb', :base_dir => @autoload_base_dir).should be_true
+    should be_loaded("Autoloaded::Module1::A")
+  end
+
+  it "accepts lists of files" do
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                         "Autoloaded::Module2::Module3::B")
+    send(@method, @file_list, :base_dir => @autoload_base_dir).should be_true
+    should be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                     "Autoloaded::Module2::Module3::B")
+  end
+
+  it "is totally cool with a splatted list of arguments" do
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                         "Autoloaded::Module2::Module3::B")
+    send(@method, *(@file_list << {:base_dir => @autoload_base_dir})).should be_true
+    should be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                     "Autoloaded::Module2::Module3::B")
+  end
+
+  it "will load all .rb files under a directory without a trailing slash" do
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                         "Autoloaded::Module2::Module3::B")
+    send(@method, @base_dir, :base_dir => @autoload_base_dir).should be_true
+    should be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                     "Autoloaded::Module2::Module3::B")
+  end
+
+  it "will load all .rb files under a directory with a trailing slash" do
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                         "Autoloaded::Module2::Module3::B")
+    send(@method, "#{@base_dir}/", :base_dir => @autoload_base_dir).should be_true
+    should be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                     "Autoloaded::Module2::Module3::B")
+  end
+
+  it "will load all files specified by a glob" do
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                         "Autoloaded::Module2::Module3::B")
+    send(@method, "#{@base_dir}/**/*.rb", :base_dir => @autoload_base_dir).should be_true
+    should be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                     "Autoloaded::Module2::Module3::B")
+  end
+
+  it "returns false if an empty input was given" do
+    send(@method, [])
+    send(@method, []).should be_false
+    send(@method).should be_false
+  end
+
+  it "raises LoadError if no file or directory found" do
+    lambda {send(@method, "not_found")}.should raise_error(LoadError)
+  end
+
+  it "raises LoadError if :base_dir doesn't exist" do
+    lambda {send(@method, @base_dir, :base_dir => @base_dir + "/non_existing_dir")}.
+            should raise_exception(LoadError)
+  end
+end

data/spec/autoload_spec.rb

@@ -0,0 +1,59 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.dirname(__FILE__) + '/autoload_shared.rb'
+
+describe "autoload_all" do
+  it "provides require_all functionality by using 'autoload' instead of 'require'" do
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName", "Autoloaded::Module2::Module3::B")
+    autoload_all File.dirname(__FILE__) + "/fixtures/autoloaded"
+    should be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName", "Autoloaded::Module2::Module3::B")
+  end
+
+  it "doesn't autoload files with wrong module names" do
+    autoload_all File.dirname(__FILE__) + "/fixtures/autoloaded"
+    should_not be_loaded("Autoloaded::WrongModule::WithWrongModule", "WrongModule::WithWrongModule")
+  end
+
+  it "needs to specify base_dir for autoloading if loading something from under top-level module directory" do
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName", "Autoloaded::Module2::Module3::B")
+    autoload_all File.dirname(__FILE__) + "/fixtures/autoloaded/module1"
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName", "Autoloaded::Module2::Module3::B")
+
+    autoload_all File.dirname(__FILE__) + "/fixtures/autoloaded/module1",
+                 :base_dir => File.dirname(__FILE__) + "/fixtures/autoloaded"
+    should be_loaded("Autoloaded::Module1::A")
+    should_not be_loaded("Autoloaded::Module2::LongerName", "Autoloaded::Module2::Module3::B")
+  end
+
+  before(:all) do
+    @base_dir = File.dirname(__FILE__) + '/fixtures/autoloaded'
+    @method = :autoload_all
+    @autoload_base_dir = @base_dir
+  end
+  it_should_behave_like "#autoload_all syntactic sugar"
+end
+
+describe "autoload_rel" do
+  it "provides autoload_all functionality relative to the current file" do
+    should_not be_loaded("Modules::Module1::First", "Modules::Module2::Second", "Modules::Zero")
+    require File.dirname(__FILE__) + '/fixtures/autoloaded_rel/modules/zero'
+    should be_loaded("Modules::Module1::First", "Modules::Module2::Second", "Modules::Zero")
+  end
+
+  it "needs to specify base_dir for autoloading if loading something from under top-level module directory" do
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName", "Autoloaded::Module2::Module3::B")
+    autoload_rel "./fixtures/autoloaded/module1"
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName", "Autoloaded::Module2::Module3::B")
+
+    autoload_rel "./fixtures/autoloaded/module1",
+                 :base_dir => File.dirname(__FILE__) + "/fixtures/autoloaded"
+    should be_loaded("Autoloaded::Module1::A")
+    should_not be_loaded("Autoloaded::Module2::LongerName", "Autoloaded::Module2::Module3::B")
+  end
+
+  before(:all) do
+    @base_dir = './fixtures/autoloaded'
+    @method = :autoload_rel
+    @autoload_base_dir = File.dirname(__FILE__) + "/fixtures/autoloaded"
+  end
+  it_should_behave_like "#autoload_all syntactic sugar"
+end

data/spec/fixtures/autoloaded/module1/a.rb

@@ -0,0 +1,6 @@
+module Autoloaded
+  module Module1
+    class A
+    end
+  end
+end

data/spec/fixtures/autoloaded/module2/longer_name.rb

@@ -0,0 +1,6 @@
+module Autoloaded
+  module Module2
+    class LongerName
+    end
+  end
+end

data/spec/fixtures/autoloaded/module2/module3/b.rb

@@ -0,0 +1,8 @@
+module Autoloaded
+  module Module2
+    module Module3
+      class B
+      end
+    end
+  end
+end

data/spec/fixtures/autoloaded/with_wrong_module.rb

@@ -0,0 +1,4 @@
+module WrongModule
+  class WithWrongModule
+  end
+end

data/spec/fixtures/autoloaded_rel/modules/module1/first.rb

@@ -0,0 +1,6 @@
+module Modules
+  module Module1
+    class First
+    end
+  end
+end

data/spec/fixtures/autoloaded_rel/modules/module2/second.rb

@@ -0,0 +1,6 @@
+module Modules
+  module Module2
+    class Second
+    end
+  end
+end

data/spec/fixtures/autoloaded_rel/modules/zero.rb

@@ -0,0 +1,6 @@
+autoload_rel "../modules"
+
+module Modules
+  class Zero
+  end
+end

data/spec/fixtures/relative/a.rb

@@ -1,2 +1,2 @@
-class RelativeA
+class RelativeA
 end

data/spec/fixtures/relative/b/b.rb

@@ -1,5 +1,5 @@
-require_rel '../a'
-require_rel '../c'
-
-class RelativeB
+require_rel '../a'
+require_rel '../c'
+
+class RelativeB
 end

data/spec/fixtures/relative/c/c.rb

@@ -1,2 +1,2 @@
-class RelativeC
+class RelativeC
 end

data/spec/fixtures/relative/d/d.rb

@@ -0,0 +1,8 @@
+load_rel '../a'
+load_rel '../c'
+
+class RelativeD
+  def ok?
+    true
+  end
+end

data/spec/fixtures/resolvable/c.rb

@@ -1 +1,5 @@
-class C; end
+class C
+  def cool?
+    true
+  end
+end

data/spec/load_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.dirname(__FILE__) + '/require_shared.rb'
+
+describe "load_all" do
+  it "provides require_all functionality but using 'load' instead of 'require'" do
+    require_all File.dirname(__FILE__) + '/fixtures/resolvable'
+    C.new.should be_cool
+
+    class C
+      def cool?
+        false
+      end
+    end
+    C.new.should_not be_cool
+
+    load_all File.dirname(__FILE__) + '/fixtures/resolvable'
+    C.new.should be_cool
+  end
+
+  before(:all) do
+    @base_dir = File.dirname(__FILE__) + '/fixtures/autoloaded'
+    @method = :load_all
+  end
+  it_should_behave_like "#require_all syntactic sugar"
+end
+
+describe "load_rel" do
+  it "provides load_all functionality relative to the current file" do
+    require File.dirname(__FILE__) + '/fixtures/relative/d/d'
+
+    should be_loaded("RelativeA", "RelativeC", "RelativeD")
+    RelativeD.new.should be_ok
+
+    class RelativeD
+      def ok?
+        false
+      end
+    end
+    RelativeD.new.should_not be_ok
+
+    load File.dirname(__FILE__) + '/fixtures/relative/d/d.rb'
+    RelativeD.new.should be_ok
+  end
+
+  before(:all) do
+    @base_dir = './fixtures/autoloaded'
+    @method = :load_rel
+  end
+  it_should_behave_like "#require_all syntactic sugar"
+end

data/spec/require_shared.rb

@@ -0,0 +1,68 @@
+shared_examples_for "#require_all syntactic sugar" do
+  before :each do
+    @file_list = [
+            "#{@base_dir}/module1/a.rb",
+            "#{@base_dir}/module2/longer_name.rb",
+            "#{@base_dir}/module2/module3/b.rb"
+    ]
+  end
+
+  it "accepts files with and without extensions" do
+    should_not be_loaded("Autoloaded::Module2::LongerName")
+    send(@method, @base_dir + '/module2/longer_name').should be_true
+    should be_loaded("Autoloaded::Module2::LongerName")
+
+    should_not be_loaded("Autoloaded::Module1::A")
+    send(@method, @base_dir + '/module1/a.rb').should be_true
+    should be_loaded("Autoloaded::Module1::A")
+  end
+
+  it "accepts lists of files" do
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                         "Autoloaded::Module2::Module3::B")
+    send(@method, @file_list).should be_true
+    should be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                     "Autoloaded::Module2::Module3::B")
+  end
+
+  it "is totally cool with a splatted list of arguments" do
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                         "Autoloaded::Module2::Module3::B")
+    send(@method, *@file_list).should be_true
+    should be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                     "Autoloaded::Module2::Module3::B")
+  end
+
+  it "will load all .rb files under a directory without a trailing slash" do
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                         "Autoloaded::Module2::Module3::B", "WrongModule::WithWrongModule")
+    send(@method, @base_dir).should be_true
+    should be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                     "Autoloaded::Module2::Module3::B", "WrongModule::WithWrongModule")
+  end
+
+  it "will load all .rb files under a directory with a trailing slash" do
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                         "Autoloaded::Module2::Module3::B", "WrongModule::WithWrongModule")
+    send(@method, "#{@base_dir}/").should be_true
+    should be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                     "Autoloaded::Module2::Module3::B", "WrongModule::WithWrongModule")
+  end
+
+  it "will load all files specified by a glob" do
+    should_not be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                         "Autoloaded::Module2::Module3::B", "WrongModule::WithWrongModule")
+    send(@method, "#{@base_dir}/**/*.rb").should be_true
+    should be_loaded("Autoloaded::Module1::A", "Autoloaded::Module2::LongerName",
+                     "Autoloaded::Module2::Module3::B", "WrongModule::WithWrongModule")
+  end
+
+  it "returns false if an empty input was given" do
+    send(@method, []).should be_false
+    send(@method).should be_false
+  end
+
+  it "throws LoadError if no file or directory found" do
+    lambda {send(@method, "not_found")}.should raise_error(LoadError)
+  end
+end

data/spec/require_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.dirname(__FILE__) + '/require_shared.rb'
+
+describe "require_all" do
+  describe "dependency resolution" do
+    it "handles load ordering when dependencies are resolvable" do
+      require_all File.dirname(__FILE__) + '/fixtures/resolvable/*.rb'
+
+      should be_loaded("A", "B", "C", "D")
+    end
+
+    it "raises NameError if dependencies can't be resolved" do
+      proc do
+        require_all File.dirname(__FILE__) + '/fixtures/unresolvable/*.rb'
+      end.should raise_error(NameError)
+    end
+  end
+
+  before(:all) do
+    @base_dir = File.dirname(__FILE__) + '/fixtures/autoloaded'
+    @method = :require_all
+  end
+  it_should_behave_like "#require_all syntactic sugar"
+end
+
+describe "require_rel" do
+  it "provides require_all functionality relative to the current file" do
+    require File.dirname(__FILE__) + '/fixtures/relative/b/b'
+
+    should be_loaded("RelativeA", "RelativeB", "RelativeC")
+    should_not be_loaded("RelativeD")
+  end
+
+  before(:all) do
+    @base_dir = './fixtures/autoloaded'
+    @method = :require_rel
+  end
+  it_should_behave_like "#require_all syntactic sugar"
+end