require-magic 0.2.1 → 0.2.2

data/README.rdoc

@@ -4,6 +4,43 @@ Utility functions to facilitate importing (require) ruby files in complex Ruby p
 See unit tests in /test directory to see how to use the tools for the best effect.
 Using this toolset should really simplify your require statements and make your application more flexible to change.
 
+== USAGE
+See unit tests for demonstrations of how to use it:
+
+To require all files within the top level folder 'data' (non-recursively)
+* required_files = Require.folder('data')
+
+The required_files returned is a list of the paths of the files that were required 
+
+To require all files within the top level folder 'data' (non-recursively) and apply tracing to see output for the process of requiring the files
+* required_files = Require.folder('data')
+
+
+To require all files within the top level folder 'data' recursively 
+* required_files = Require.rfolder('data')
+
+To require all files within the top level folders 'data' and 'data2' (non-recursively) 
+* required_files = Require.rfolders(['data', 'data2'])
+
+To require all files within the top level folders 'data' and 'data2' recursively 
+* required_files = Require.rfolders(['data', 'data2'])
+
+To require files within the top level folders 'data' and 'data2' and also files within the subdirectory 'blip' if it exists 
+* required_files = Require.folders(['data', 'data2'], {:folders => ['blip]})
+
+To require files within 'data/blip' and 'data2/blip' only
+* required_files = Require.folders(['data', 'data2'], {:folders => ['blip], :ignore_root_files => true})
+
+To require files within 'data' and 'data2' first and then any files within the subdirectory 'blip' (default order)
+* required_files = Require.folders(['data', 'data2'], {:folders => ['blip], :root_files => :before})
+
+To require files within 'data/blip' and 'data2/blip' first and then any files within 'data' and 'data2' folders
+* required_files = Require.folders(['data', 'data2'], {:folders => ['blip], :root_files => :after})
+
+To require files within 'data' and 'data2' first and then any files within the subdirectory 'blip'
+* required_files = Require.folders(['data', 'data2'], {:folders => ['blip], :root_files => :before})
+
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/lib/require-magic.rb

@@ -14,7 +14,7 @@ module Require
 
     puts_trace "folder:: name: #{name}", options    
 
-    if options[:root_files] == :before
+    if !options[:root_files] || options[:root_files] == :before
       required_files << require_root_files(name, folder_list, path, options)
       # options[:root] = false
       required_files << require_folder_list(name, folder_list, options)    
@@ -64,7 +64,7 @@ protected
     else
       includes_rexp = options[:include]
       excludes_rexp = options[:exclude]      
-      
+            
       Dir.glob(path).each {|f| 
         next if excludes_rexp &&  match(f, excludes_rexp)
         if !includes_rexp || match(f, includes_rexp)

data/require-magic.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{require-magic}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
@@ -39,7 +39,8 @@ Gem::Specification.new do |s|
     "spec/require-magic_spec.rb",
      "spec/spec_helper.rb",
      "test/test_require_magic.rb",
-     "test/test_require_magic_adv.rb"
+     "test/test_require_magic_adv.rb",
+     "test/unit_test_require.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/test_require_magic.rb

@@ -1,50 +1,46 @@
 require 'require-magic'
-require "test/unit"
+require "unit_test_require"
  
-class TestFilter < Test::Unit::TestCase
-
-  def setup
-    @folders = ['data', 'data2']
-  end
-
-  def teardown
-    ## Nothing really
-  end
+class TestFilter < UnitTestRequire
     
   def test_require_folders
     required_files = Require.folders(@folders)
     
-    found0 = !(required_files[0] =~ /data_a.rb/).nil?
-    found1 = !(required_files[1] =~ /data2\/blap_a.rb/).nil?
-    
+    found0 = match? required_files[0], 'data_a.rb'
+    found1 = match? required_files[1], 'data2/blap_a.rb'
+      
     assert_equal 2, required_files.size, "Should require 2 files" 
-    assert_equal true, found0, "Should require data_a.rb in /" 
-    assert_equal true, found1, "Should require blap_a.rb in /data" 
+    assert found0, "Should require data_a.rb in /" 
+    assert found1, "Should require blap_a.rb in /data" 
   end
   
   def test_require_folders_recursive
     options = {:recursive => true}
     required_files = Require.folders(@folders, options)
-    assert_equal 3, required_files.size, "Should require 3 files" 
+    assert_equal 5, required_files.size, "Should require 5 files" 
   end
   
-  def test_require_folders_recursive
+  def test_require_folders_recursive_include
     options = {:recursive => true, :include => 'blip_'}
     required_files = Require.folders(@folders, options)
     assert_equal 2, required_files.size, "Should require 2 files" 
   end
   
-  def test_require_folders_recursive
+  def test_require_folders_recursive_exclude
     options = {:recursive => true, :exclude => 'blip_'}
     required_files = Require.folders(@folders, options)
-    assert_equal 2, required_files.size, "Should require 2 file" 
+    assert_equal 3, required_files.size, "Should require 3 file" 
   end  
   
-  def test_require_folders_recursive
+  def test_require_folders_recursive_default
     options = {:folders => ['blip']}
     required_files = Require.folders(@folders, options)
     assert_equal 4, required_files.size, "Should require 4 files" 
+    
+    found0 = match? required_files[0], 'data_a.rb'    
+    assert found0, "Should require root files such as 'data_a.rb' first"     
   end  
+
   
 end
 

data/test/test_require_magic_adv.rb

@@ -1,17 +1,7 @@
 require 'require-magic'
-require "test/unit"
+require "unit_test_require"
  
-class TestFilter < Test::Unit::TestCase
-
-  def setup
-    @folders = ['data', 'data2']
-  end
-
-  def teardown
-    ## Nothing really
-  end
-    
-
+class TestRequireAdv < UnitTestRequire
 
   def test_require_folders_recursive
     options = {:folders => ['blip'], :ignore_root_files => true}
@@ -23,17 +13,24 @@ class TestFilter < Test::Unit::TestCase
     options = {:folders => ['blip'], :root_files => :before}
     required_files = Require.folders(@folders, options)
     assert_equal 4, required_files.size, "Should require 4 files" 
+
+    root_first = match?(required_files[0], 'data_a.rb') 
+    assert root_first, "First required file should be root file 'data_a.rb'"                  
   end  
   
-  def test_require_folders_root_folders_before
+  def test_require_folders_root_folders_after
     options = {:folders => ['blip'], :root_files => :after}
     required_files = Require.folders(@folders, options)
     assert_equal 4, required_files.size, "Should require 4 files" 
+
+    root_last = match?(required_files[2], 'data_a.rb')        
+    assert root_last, "Last required file of 'data' should be root file 'data_a.rb'"
   end
 
   def test_require_folders_root_folders_before_but_ignore
-    options = {:folders => ['blip'], :root_files => :after, :ignore_root_files => true}
+    options = {:folders => ['blip'], :root_files => :before, :ignore_root_files => true}
     required_files = Require.folders(@folders, options)
+
     assert_equal 3, required_files.size, "Should require 3 files" 
   end
 
@@ -43,5 +40,15 @@ class TestFilter < Test::Unit::TestCase
     assert_equal 3, required_files.size, "Should require 3 files" 
   end
 
+  def test_require_folders_recursive_data_root_folders_after
+    options = {:folders => ['blip'], :root_files => :after}
+    required_files = Require.folders('data', options)
+    assert_equal 3, required_files.size, "Should require 3 files" 
+    
+    root_last = match?(required_files[2], 'data_a.rb')
+    
+    assert root_last, "Last required file should be root file 'data_a.rb'"     
+  end  
+
 
 end

data/test/unit_test_require.rb

@@ -0,0 +1,16 @@
+require "test/unit"
+
+class UnitTestRequire < Test::Unit::TestCase
+
+  def setup
+    @folders = ['data', 'data2']
+  end
+
+  def match?(expr, rexp)    
+    !(expr =~ /#{Regexp.escape(rexp)}/).nil?
+  end
+  
+  def test_me
+    assert true, "true"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: require-magic
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -77,3 +77,4 @@ test_files:
 - spec/spec_helper.rb
 - test/test_require_magic.rb
 - test/test_require_magic_adv.rb
+- test/unit_test_require.rb