require-magic 0.1.0 → 0.2.1

data/CHANGELOG

@@ -0,0 +1,19 @@
+17-11-2009
+----------
+Created unit tests to ensure all util functions work as expected. Fixed a number of bugs.
+
+14-11-2009
+----------
+* Initial release with two helper functions:
+
+- Require.folder(name, options)
+
+name    : the name (or path) of a top-level folder. 
+options : a hash containing specific options for applying the require (all optional)
+          :include      - regular expression to match on .rb filenames to require 
+          :exclude      - regular expression to match on .rb filenames to NOT require
+          :recursive    - whether to do a recursive traversal of directories
+          :folder_list  - list of folders under main folder (name argument) to process (in list order)
+             
+
+

data/README.rdoc

@@ -1,8 +1,8 @@
 = require-magic
 
 Utility functions to facilitate importing (require) ruby files in complex Ruby project, such as gem with complex folder hierarchies. 
-
-NOTE: Needs testing
+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.
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -6,7 +6,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "require-magic"
     gem.summary = %Q{utility to facilitate require of .rb files and folders}
-    gem.description = %Q{utility to facilitate require of .rb files and folders}
+    gem.description = %Q{enhance your ruby app with require magic to more easily define how to include hierarchies of ruby files, and also apply inclusion/exclusion filters for what to include}
     gem.email = "kmandrup@gmail.com"
     gem.homepage = "http://github.com/kristianmandrup/require-magic"
     gem.authors = ["Kristian Mandrup"]

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.1

data/lib/require-magic.rb

@@ -1,29 +1,113 @@
 module Require
-  def self.folder(name, options)
-    includes_rexp = options[:include]
-    excludes_rexp = options[:exclude]
+  def self.rfolder(name, options = {})
+    options[:recursive] = true
+    folder(name, options)    
+  end
+  
+  def self.folder(name, options = {})
     recursive = options[:recursive]
     folder_list = options[:folders]
-    
-    file_pattern =  recursive ? "#{name}/**/*.rb" : "#{name}/*.rb"    
-    Dir.glob(File.join(File.dirname(__FILE__), file_pattern)).each {|f| 
-      next if excludes &&  match(f, excludes_rexp)
-      require f if !match || match(f, includes_rexp)
-    }
-    folders(folder_list, options) if folder_list
+    file_pattern =  recursive ? "#{name}/**/*.rb" : "#{name}/*.rb" 
+    base_path = File.dirname(__FILE__)
+    path = File.join(base_path, file_pattern)
+    required_files = []
+
+    puts_trace "folder:: name: #{name}", options    
+
+    if 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)    
+    else
+      required_files << require_folder_list(name, folder_list, options)          
+      required_files << require_root_files(name, folder_list, path, options)
+      # options[:root] = false      
+    end
+    required_files.flatten
+  end
+
+  def self.rfolders(folder_list, options = {}) 
+    options[:recursive] = true
+    folders(folder_list, options)    
   end
+    
 
-  def self.folders(folder_list, options)
-    folder_list.each(|f| folder(f, options))
+  def self.folders(folder_list, options = {})
+    required_files = []
+    folder_list.each do |path| 
+      options[:root] = path if is_root?(path, options) 
+      required_files << folder(path, options)
+    end
+    required_files.flatten
   end
 
 protected
-  def match(f, rexp)
+  def self.puts_trace(txt, options)
+    puts txt if tracing?(options)    
+  end
+
+  def self.tracing?(options)
+    options[:tracing] == :on
+  end
+
+  def self.is_root?(path, options)
+    root = options[:root]
+    root == nil || (root && path.size < root.size)
+  end
+
+  def self.require_root_files(name, folder_list, path, options)
+    puts_trace "require_root_files:: name: #{name}, folders: #{folder_list.inspect}, path: #{path}", options    
+    required_files = []
+    i_am_root = options[:root] == name
+    if options[:ignore_root_files] && i_am_root
+      options.delete :ignore_root_files                        
+    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)
+          puts_trace "require: #{f}", options
+          required_files << do_require(f) 
+        end
+      }
+    end    
+    
+    required_files.flatten
+  end
+
+  def self.require_folder_list(name, folder_list, options)
+    puts_trace "require_folder_list:: name: #{name}, folders: #{folder_list.inspect}", options    
+    required_files = []
+    if folder_list
+      # options.delete :ignore_root_files            
+      options.delete :folders
+      
+      folder_list.each do |folder|
+        sub_folder = File.join(name, folder)
+        required_files << folders(sub_folder, options) 
+      end
+    end
+    required_files.flatten
+  end
+
+  def self.do_require(name)
+    require name 
+    name
+  end
+
+  def self.match(f, rexp)
+    if rexp.kind_of? String
+      rexp = /#{Regexp.escape(rexp)}/
+    end
+      
     if rexp.kind_of? Array
       rexp.each{|e| return true if match(f, rexp)}
       false
-    elsif rexp.kind_of? RegExp  
-      f =~ rexp
+    elsif rexp.kind_of? Regexp  
+      match_res = (f =~ rexp)
+      !match_res.nil?
     end
   end
 

data/require-magic.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{require-magic}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2009-11-19}
+  s.description = %q{enhance your ruby app with require magic to more easily define how to include hierarchies of ruby files, and also apply inclusion/exclusion filters for what to include}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/require-magic.rb",
+     "require-magic.gemspec",
+     "spec/require-magic_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/require-magic}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{utility to facilitate require of .rb files and folders}
+  s.test_files = [
+    "spec/require-magic_spec.rb",
+     "spec/spec_helper.rb",
+     "test/test_require_magic.rb",
+     "test/test_require_magic_adv.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/test/test_require_magic.rb

@@ -1 +1,50 @@
-# TODO
+require 'require-magic'
+require "test/unit"
+ 
+class TestFilter < Test::Unit::TestCase
+
+  def setup
+    @folders = ['data', 'data2']
+  end
+
+  def teardown
+    ## Nothing really
+  end
+    
+  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?
+    
+    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" 
+  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" 
+  end
+  
+  def test_require_folders_recursive
+    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
+    options = {:recursive => true, :exclude => 'blip_'}
+    required_files = Require.folders(@folders, options)
+    assert_equal 2, required_files.size, "Should require 2 file" 
+  end  
+  
+  def test_require_folders_recursive
+    options = {:folders => ['blip']}
+    required_files = Require.folders(@folders, options)
+    assert_equal 4, required_files.size, "Should require 4 files" 
+  end  
+  
+end
+

data/test/test_require_magic_adv.rb

@@ -0,0 +1,47 @@
+require 'require-magic'
+require "test/unit"
+ 
+class TestFilter < Test::Unit::TestCase
+
+  def setup
+    @folders = ['data', 'data2']
+  end
+
+  def teardown
+    ## Nothing really
+  end
+    
+
+
+  def test_require_folders_recursive
+    options = {:folders => ['blip'], :ignore_root_files => true}
+    required_files = Require.folders(@folders, options)
+    assert_equal 3, required_files.size, "Should require 3 files" 
+  end  
+
+  def test_require_folders_root_folders_before
+    options = {:folders => ['blip'], :root_files => :before}
+    required_files = Require.folders(@folders, options)
+    assert_equal 4, required_files.size, "Should require 4 files" 
+  end  
+  
+  def test_require_folders_root_folders_before
+    options = {:folders => ['blip'], :root_files => :after}
+    required_files = Require.folders(@folders, options)
+    assert_equal 4, required_files.size, "Should require 4 files" 
+  end
+
+  def test_require_folders_root_folders_before_but_ignore
+    options = {:folders => ['blip'], :root_files => :after, :ignore_root_files => true}
+    required_files = Require.folders(@folders, options)
+    assert_equal 3, required_files.size, "Should require 3 files" 
+  end
+
+  def test_require_folders_root_folders_after_but_ignore
+    options = {:folders => ['blip'], :root_files => :after, :ignore_root_files => true}
+    required_files = Require.folders(@folders, options)
+    assert_equal 3, required_files.size, "Should require 3 files" 
+  end
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: require-magic
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-15 00:00:00 +01:00
+date: 2009-11-19 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.9
     version: 
-description: utility to facilitate require of .rb files and folders
+description: enhance your ruby app with require magic to more easily define how to include hierarchies of ruby files, and also apply inclusion/exclusion filters for what to include
 email: kmandrup@gmail.com
 executables: []
 
@@ -34,11 +34,13 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGELOG
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - lib/require-magic.rb
+- require-magic.gemspec
 - spec/require-magic_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -74,3 +76,4 @@ test_files:
 - spec/require-magic_spec.rb
 - spec/spec_helper.rb
 - test/test_require_magic.rb
+- test/test_require_magic_adv.rb