require-magic 0.2.2 → 0.2.3

data/README.rdoc

@@ -7,15 +7,20 @@ Using this toolset should really simplify your require statements and make your
 == USAGE
 See unit tests for demonstrations of how to use it:
 
+Set basepath to use for require
+* required_files = Require.base_path = File.dirname(__FILE__)
+
 To require all files within the top level folder 'data' (non-recursively)
 * required_files = Require.folder('data')
 
+Override base_path
+* required_files = Require.folder('data', {:base_path => File.dirname(__FILE__) + '/../my/path})
+
 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')
 

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/lib/require-magic.rb

@@ -1,4 +1,12 @@
-module Require
+require 'singleton'
+class Require
+  include Singleton
+  
+  class << self
+    attr_accessor :base_path
+    attr_accessor :tracing
+    attr_accessor :verbose
+  end
   def self.rfolder(name, options = {})
     options[:recursive] = true
     folder(name, options)    
@@ -8,8 +16,14 @@ module Require
     recursive = options[:recursive]
     folder_list = options[:folders]
     file_pattern =  recursive ? "#{name}/**/*.rb" : "#{name}/*.rb" 
-    base_path = File.dirname(__FILE__)
-    path = File.join(base_path, file_pattern)
+    
+    base_dir = File.dirname(__FILE__)
+    
+    curr_base_path = options[:base_path] || base_path || base_dir
+    
+    # puts "base_path: #{curr_base_path}, base_dir:#{base_dir}, :base_path #{base_path}"
+
+    path = File.join(curr_base_path, file_pattern)
     required_files = []
 
     puts_trace "folder:: name: #{name}", options    
@@ -47,7 +61,7 @@ protected
   end
 
   def self.tracing?(options)
-    options[:tracing] == :on
+    tracing == :on || options[:tracing] == :on
   end
 
   def self.is_root?(path, options)
@@ -94,7 +108,15 @@ protected
 
   def self.do_require(name)
     require name 
-    name
+    list_name name
+  end
+
+  def self.list_name(name)    
+    if base_path && !(verbose == :on)
+      name.gsub(/#{Regexp.escape(base_path)}/, '')
+    else
+      name
+    end
   end
 
   def self.match(f, rexp)

data/require-magic.gemspec

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

data/test/test_require_folder.rb

@@ -0,0 +1,55 @@
+require 'require-magic'
+require "unit_test_require"
+ 
+class TestRequireFolder < UnitTestRequire
+    
+  def test_require_folder
+    required_files = Require.folder(@folder)
+        
+    found0 = match? required_files[0], 'data_a.rb'
+      
+    assert_equal 1, required_files.size, "Should require 1 file" 
+    assert found0, "Should require data_a.rb in /" 
+  
+  end
+  
+  def test_require_folder_recursive
+    required_files = Require.rfolder(@folder)
+    assert_equal 4, required_files.size, "Should require 4 files" 
+  end
+  
+  def test_require_folder_recursive_include
+    options = {:include => '_a'}
+    required_files = Require.folder(@folder, options)
+    assert_equal 1, required_files.size, "Should require 1 file" 
+  end
+
+  def test_require_folder_recursive_include_base_path
+    options = {:include => '_a'}
+    Require.base_path = File.dirname(__FILE__) + "/../lib"
+    required_files = Require.folder(@folder, options)
+    
+    assert_equal 1, required_files.size, "Should require 1 file" 
+    assert_equal "/data/data_a.rb", required_files[0], "Path of required files should be from base_path when verbose not :on"
+  end
+
+  
+  def test_require_folders_recursive_exclude_base_path
+    options = {:exclude => '_a'}
+    required_files = Require.folder(@folder, options)
+    assert_equal 0, required_files.size, "Should require 0 files" 
+  end  
+  
+  def test_require_folder_recursive_default_base_path_override
+    options = {:folders => ['blip'], :base_path => File.dirname(__FILE__) + "/../lib"}
+    required_files = Require.folder(@folder, options)
+    
+    assert_equal 3, required_files.size, "Should require 3 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.rb → test_require_folders.rb}

@@ -1,7 +1,7 @@
 require 'require-magic'
 require "unit_test_require"
  
-class TestFilter < UnitTestRequire
+class TestRequireFolders < UnitTestRequire
     
   def test_require_folders
     required_files = Require.folders(@folders)

data/test/{test_require_magic_adv.rb → test_require_folders_adv.rb}

@@ -1,7 +1,7 @@
 require 'require-magic'
 require "unit_test_require"
  
-class TestRequireAdv < UnitTestRequire
+class TestRequireFoldersAdv < UnitTestRequire
 
   def test_require_folders_recursive
     options = {:folders => ['blip'], :ignore_root_files => true}

data/test/unit_test_require.rb

@@ -4,6 +4,7 @@ class UnitTestRequire < Test::Unit::TestCase
 
   def setup
     @folders = ['data', 'data2']
+    @folder = 'data'
   end
 
   def match?(expr, rexp)    

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: require-magic
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -75,6 +75,7 @@ summary: utility to facilitate require of .rb files and folders
 test_files: 
 - spec/require-magic_spec.rb
 - spec/spec_helper.rb
-- test/test_require_magic.rb
-- test/test_require_magic_adv.rb
+- test/test_require_folder.rb
+- test/test_require_folders.rb
+- test/test_require_folders_adv.rb
 - test/unit_test_require.rb