required 0.1.1 → 0.1.2

data/README

@@ -89,9 +89,5 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 == Links
 
-Required:: <http://blog.codesherpas.com/>
-Required's Rubyforge project:: <http://rubyforge.org/projects/required>
+Required's RubyGems.org project:: <http://rubygems.org/gems/required>
 Official Required repository:: <http://github.com/required>
-
-Arild Shirazi:: <http://setup-a-personal-site-quick.com/>
-

data/lib/required.rb

@@ -4,11 +4,11 @@ module Kernel
   # `require` all ruby files found.  Returns an array of files that were
   # actually loaded in the order which they were loaded.
   # Available options:
-  #   :recurse => [true|false]         # Descend into subdirectories or not
-  #   :include => /filename_pattern/   # Only require files matching this regex
-  #   :exclude => /filename_pattern/   # Don't require files matching this regex
+  #   :recurse => true       # Descend into subdirectories (default is false)
+  #   :include => /pattern/  # Only require files with names matching this regex
+  #   :exclude => /pattern/  # Don't require files matching this regex
   #   :sort => lambda { |x, y| y <=> x }
-  #                # Specify a custom sort order for files within each directory
+  #                # Specify a custom file sort order within each directory
   #
   # Note: required files are loaded only once.
   def required(directories, options={})

data/tests/required_test.rb

@@ -0,0 +1,182 @@
+Dir.chdir File.expand_path(File.dirname(__FILE__) + "/..")
+require 'rubygems'
+require 'shoulda'
+require 'lib/required'
+
+class RequiredTest < Test::Unit::TestCase
+  
+  @@req_dir = "tests/required_test"
+
+  def reset_required_test_files
+    my_test_files = $".select { |r| r =~ /required_test/ }
+    my_test_files.each { |r| $".delete r }
+    $REQUIRED = []
+    # $REQUIRED global will be populated with name of each test file required
+  end
+
+  context "Non-recursive required" do
+    setup do
+      reset_required_test_files
+      @required = required @@req_dir
+    end
+
+    should "accurately report all files that have been required" do
+      assert_equal(
+          %W(#{@@req_dir}/required-1.rb
+             #{@@req_dir}/required-2.rb
+             #{@@req_dir}/required\ space\ 3.rb
+             ).sort, @required.sort)
+    end
+
+    should "require all ruby files (those having a .rb extension)" do
+      %W(#{@@req_dir}/required-1.rb
+         #{@@req_dir}/required-2.rb
+         #{@@req_dir}/required\ space\ 3.rb
+         ).each {|f| assert $REQUIRED.include?(f),
+                 "#{f} not found in #{$REQUIRED.inspect}"}
+    end
+
+    should "ignore non-ruby files" do
+      %W(#{@@req_dir}/junk space 4.rake
+         #{@@req_dir}/junk-2
+         #{@@req_dir}/junk-1.rbt
+         #{@@req_dir}/junk-3rb
+         ).each {|f| assert ! $REQUIRED.include?(f),
+                 "#{f} found in #{$REQUIRED.inspect}"}
+    end
+
+    should "ignore hidden files (files with a . prefix)" do
+      %W(#{@@req_dir}/.required-4.rb
+         ).each {|f| assert ! $REQUIRED.include?(f),
+                 "#{f} found in #{$REQUIRED.inspect}"}
+    end
+
+    should "ignore ruby files in subdirectories" do
+      %W(#{@@req_dir}/sub1
+         #{@@req_dir}/sub1/required-1.rb
+         #{@@req_dir}/sub1/required-2.rb
+         #{@@req_dir}/sub1/required\ space\ 3.rb
+         #{@@req_dir}/sub1/junk space 4.rake
+         #{@@req_dir}/sub1/junk-2
+         #{@@req_dir}/sub1/junk-1.rbt
+         #{@@req_dir}/sub1/junk-3rb
+         ).each {|f| assert ! $REQUIRED.include?(f),
+                 "#{f} found in #{$REQUIRED.inspect}"}
+    end
+  end
+
+  context "Non-recursive, exclude pattern required" do
+    setup do
+      reset_required_test_files
+      @required = required(@@req_dir, :exclude => /-2/)
+    end
+
+    should "require only ruby files matching an include pattern" do
+      %W(#{@@req_dir}/required-2.rb
+         ).each {|f| assert ! $REQUIRED.include?(f),
+                 "#{f} unexpectedly found in #{$REQUIRED.inspect}"}
+    end
+
+    should "not require ruby files that do not match the include pattern" do
+      %W(#{@@req_dir}/required-1.rb
+         #{@@req_dir}/required\ space\ 3.rb
+         ).each {|f| assert $REQUIRED.include?(f),
+                 "#{f} not found in #{$REQUIRED.inspect}"}
+    end
+  end
+
+  context "Non-recursive, include pattern required" do
+    setup do
+      reset_required_test_files
+      @required = required(@@req_dir, :include => /-2/)
+    end
+
+    should "require only ruby files matching an include pattern" do
+      %W(#{@@req_dir}/required-2.rb
+         ).each {|f| assert $REQUIRED.include?(f),
+                 "#{f} not found in #{$REQUIRED.inspect}"}
+    end
+
+    should "not require ruby files that do not match the include pattern" do
+      %W(#{@@req_dir}/required-1.rb
+         #{@@req_dir}/required\ space\ 3.rb
+         ).each {|f| assert ! $REQUIRED.include?(f),
+                 "#{f} unexcpectedly found in #{$REQUIRED.inspect}"}
+    end
+  end
+
+  context "Non-recursive, exclude and include pattern required" do
+    setup do
+      reset_required_test_files
+      @required = required(@@req_dir,
+          {:include => /required-/, :exclude => /2/})
+    end
+
+    should "require only ruby files matching an include pattern" do
+      %W(#{@@req_dir}/required-1.rb
+         ).each {|f| assert $REQUIRED.include?(f),
+                 "#{f} not found in #{$REQUIRED.inspect}"}
+    end
+
+    should "not require ruby files that do not match the include pattern" do
+      %W(#{@@req_dir}/required-2.rb
+         #{@@req_dir}/required\ space\ 3.rb
+         ).each {|f| assert ! $REQUIRED.include?(f),
+                 "#{f} unexcpectedly found in #{$REQUIRED.inspect}"}
+    end
+  end
+
+  context "Recursive required" do
+    setup do
+      reset_required_test_files
+      @required =  required(@@req_dir, :recurse => true)
+    end
+
+    should "accurately report all files that have been required" do
+      assert_equal(
+          %W(#{@@req_dir}/required\ space\ 3.rb
+             #{@@req_dir}/required-1.rb
+             #{@@req_dir}/required-2.rb
+             #{@@req_dir}/sub1/required-1.rb
+             #{@@req_dir}/sub1/required-2.rb
+             #{@@req_dir}/sub1/required\ space\ 3.rb
+             #{@@req_dir}/sub1/sub2/required-1.rb
+             #{@@req_dir}/sub1/sub2/required-2.rb
+             #{@@req_dir}/sub1/sub2/required\ space\ 3.rb
+             ).sort, @required.sort)
+    end
+
+    should "require all ruby files in subdirectories" do
+      %W(#{@@req_dir}/sub1/required-1.rb
+         #{@@req_dir}/sub1/required-2.rb
+         #{@@req_dir}/sub1/required\ space\ 3.rb
+         #{@@req_dir}/sub1/sub2/required-1.rb
+         #{@@req_dir}/sub1/sub2/required-2.rb
+         #{@@req_dir}/sub1/sub2/required\ space\ 3.rb
+         ).each {|f| assert $REQUIRED.include?(f),
+                 "#{f} not found in #{$REQUIRED.inspect}"}
+    end
+
+    should "ignore non-ruby files in subdirectories" do
+      %W(#{@@req_dir}/sub1/junk space 4.rake
+         #{@@req_dir}/sub1/junk-2
+         #{@@req_dir}/sub1/junk-1.rbt
+         #{@@req_dir}/sub1/junk-3rb
+         #{@@req_dir}/sub1/sub2/junk space 4.rake
+         #{@@req_dir}/sub1/sub2/junk-2
+         #{@@req_dir}/sub1/sub2/junk-1.rbt
+         #{@@req_dir}/sub1/sub2/junk-3rb
+         ).each {|f| assert ! $REQUIRED.include?(f),
+                 "#{f} found in #{$REQUIRED.inspect}"}
+    end
+
+    should "ignore hidden files (files with a . prefix) in subdirectories" do
+      %W(#{@@req_dir}/.required-4.rb
+         #{@@req_dir}/sub1/.required-4.rb
+         #{@@req_dir}/sub1/sub2/.required-4.rb
+         #{@@req_dir}/sub1/.sub3/required-1.rb
+         ).each {|f| assert ! $REQUIRED.include?(f),
+                 "#{f} found in #{$REQUIRED.inspect}"}
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Arild Shirazi
@@ -14,20 +14,34 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-31 00:00:00 -05:00
+date: 2010-04-01 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: "Required, a utility to require all files in a directory\n\
-  Required provides the ability to require all files within a directory, with options for file inclusion/exclusion based on pattern matching, as well as recursive descent. An array of all the files that were loaded (\xE2\x80\x98require\xE2\x80\x99 only loads a file the first time) are returned.\n\n\
-  Quick start\n\
-  First pull in the \xE2\x80\x98required\xE2\x80\x99 module:\n\n    require 'required'\n\
-  To pull in all ruby files in a directory (this excludes subdirectories):\n\n    required \"some/path/to/dir\"\n\
-  Same as before, but require the files in reverse alphanumeric order:\n\n    required \"some/path/to/dir\", :sort => lambda { |x, y| y <=> x}\n\
-  To pull in files from multiple directories:\n\n    required [\"some/path/to/dir\", \"another/path/another/dir\"]\n\
-  Or to recurse through subdirectories, requiring all files along the way:\n\n    required \"lib\", {:recurse => true}\n\
-  Same as before, but exclude ruby files tagged as \"_old\":\n\n    required \"lib\", {:recurse => true, :exclude => /_old/}\n    # Will not require \"lib/extensions/string_old.rb\"\n\
-  Same as before, but only require ruby files tagged with \"_new\":\n\n    required \"lib\", {:recurse => true, :include => /_new/}\n"
+description: |
+  <p>Required is a utility to require all files in a directory.</p>
+  <p>
+    Why would one want to require a whole bunch of files at once? I have used this
+    gem on 2 projects to:
+  </p>
+  <ul>
+    <li>require dozens of jar files when working on a JRuby project</li>
+    <li>pull in all files before running code coverage (rcov), to find code that
+        is otherwise dead/untouched</li>
+  </ul>
+  
+  <p>
+    Options for <strong>required</strong> include the ability to recursively
+    descend through subdirectories, include/exclude files based on pattern
+    matching, and to specify the order of requires based on filename.  An array of
+    all the files that were loaded is returned.
+  </p>
+  
+  <code>require 'required'
+  required "some/path/to/dir"</code>
+  
+  <p>See the README for quick usage instructions</p>
+
 email: ashirazi@codesherpas.com
 executables: []
 
@@ -67,6 +81,6 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Provides the ability to 'require' many or all files within directories, using a simple statement.
-test_files: []
-
+summary: Required is a utility to require all files in a directory.
+test_files: 
+- tests/required_test.rb