require-magic 0.5.1 → 0.5.2

data/README.textile

@@ -0,0 +1,186 @@
+h1. Require-Me
+Includes a DSL for requiring files and folders and some also some static utility functions which can be used in combination. 
+These tools in combination facilitates managing requiring various subfolder structures. 
+
+h2. Require DSL  
+The following example code demonstrates how to use the Require DSL
+
+<pre>
+require 'require_me' # include both the static require helpers and the DSL require language
+require 'require_dsl'  # alternatively only include require_dsl (the DSL language)
+
+# enter subfolder 'mira'
+Folder.enter 'mira' do |folder|
+  # from new location, enter a subdir
+  folder.enter 'subdir' do |path|  # mira/subdir      
+    folder.all('**/*.rb').except(/sound\/*.rb/).require  
+  end
+
+  # from new location, enter a subdir
+  folder.enter 'another/subdir' do |path|           
+    # use file blobs here
+    folder.all('**/*.rb').require
+  end
+
+  # from new location, enter a subdir
+  folder.enter 'a_subdir' do |path|         
+    # matching and except are to be used as include and exclude filters
+    # they each take a list containing regular expressions and strings
+    # string arguments are postfixed with .rb internally if not present  
+    folder.all('blip/**/*.rb').matching(/_mixin.rb/, /.*\/power/).except(/sound/, /disco/).require
+
+    folder.enter 'sub_a' do |path|         
+      folder.enter 'sub_b' do |path| # a_subdir/sub_a/sub_b         
+        folder.all('grusch/**/*.rb').require
+      end
+
+    end
+    folder.all.require    
+  end
+end  
+</pre>
+
+If no argument, current path is used as initial folder 
+<pre>
+# use current path as folder
+Folder.enter do |folder| 
+  folder.all('**/*.rb').require
+  folder.enter 'game' do |path|
+
+    # use static require functions
+    Require.base_path path # set base path to use for Require
+
+    # include .rb files within data1, data2 but not within their subfolders (use recursive instead)
+    Require.folders('data1', 'data2') 
+     
+    list = path.all('**/*.rb')    
+    puts list.matching('sound', 'network').except(/sound/).show_require(:relative)
+    list.matching('sound', 'network').except(/sound/).require
+  end
+end
+</pre>
+
+h2. Static helpers
+Unit tests demonstrations how to use the static helpers (tests currently broken due to missing data files!):
+
+h3. Setting the base path
+
+Setting global base_path
+<pre>
+# Set basepath to use for require
+Require.base_path = File.dirname(__FILE__)  
+</pre>
+
+Set basepath to use within block
+<pre>
+# Set basepath to use within block
+Require.enter 'sound' do |path|
+  Require.folders 'data' # can be used for any number of folders   
+  Require.folder 'data2' # for one folder only
+end
+</pre>
+
+Override base_path
+<pre>
+# Override base_path
+Require.folders 'data', {:base_path => File.dirname(__FILE__) + '/../my/path}
+</pre>
+
+h3. Simple usage examples
+Require .rb files from a folder
+<pre>
+# To require .rb files in the folders 'data' and 'data2' (non-recursively)
+Require.folders 'data', 'data2' 
+
+# Same but recursively (recurse subtrees of folders)
+Require.recursive 'data', 'data2' 
+</pre>
+
+h3. Simple debugging
+Get list of required files
+<pre>
+# To require all files within the top level folder 'data' (non-recursively) 
+# The required_files returned is a list of the paths of the files that were required
+required_files = Require.folder 'data'
+puts required_files  
+</pre>
+
+h3. Tracing mode (for debugging)
+Apply tracing to see output for the process of requiring the files
+<pre>
+  # turn on tracing globally
+  Require.tracing = :on
+  Require.folder 'data'
+  # turn off tracing globally
+  Require.tracing = :off  
+</pre>
+
+Alternatively pass tracing as an option 
+<pre>
+Require.folder 'data', {:tracing => :on}  
+</pre>
+
+h3. Verbose mode (for detailed debugging)
+Set verbose mode on to see full path of each required file
+<pre>                    
+  # turn on tracing     
+  Require.tracing = :on    
+  # turn on verbose globally
+  Require.verbose = :on
+  Require.folder 'data'
+  # turn off verbose globally
+  Require.verbose = :off  
+</pre>
+
+h3. Require.recursive
+To require all files within the top level folder 'data' recursively 
+<pre>
+# To require all files within the top level folder 'data' recursively 
+required_files = Require.recursive 'data'  
+</pre>
+
+To require all files within the top level folders 'data' and 'data2' (non-recursively) 
+<pre>
+# To require all files within the top level folders 'data' and 'data2' (non-recursively) 
+required_files = Require.recursive 'data', 'data2'  
+</pre>
+
+To require all files within the top level folders 'data' and 'data2' recursively
+<pre> 
+# To require all files within the top level folders 'data' and 'data2' recursively
+required_files = Require.recursive 'data', 'data2'
+</pre>
+
+h3. Require.folders
+To require files within the top level folders 'data' and 'data2' and also files within the subdirectory 'blip' if it exists 
+<pre>
+# 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'}  
+</pre>
+
+To require files within 'data/blip' and 'data2/blip' only, NOT including the root files
+<pre>
+# To require files within 'data/blip' and 'data2/blip' only, NOT including the root files
+required_files = Require.folders 'data', 'data2', {:folders => 'blip', :ignore_root_files => true}  
+</pre>
+
+To require files within 'data' and 'data2' first and then AFTER any files within the subdirectory 'blip' (default order)
+<pre>
+# To require files within 'data' and 'data2' first and then AFTER any files within the subdirectory 'blip' (default order)
+required_files = Require.folders 'data', 'data2', {:folders => 'blip', :root_files => :before}  
+</pre>
+
+
+To require files within 'data/blip' and 'data2/blip' first and then AFTER any files within 'data' and 'data2' folders (the root files)
+<pre>
+required_files = Require.folders(['data', 'data2'], {:folders => 'blip', :root_files => :after})
+</pre>
+
+To require files within 'data' and 'data2' (the root files) first (BEFORE) and then any files within the subdirectories 'blip' and blap
+<pre>
+required_files = Require.folders(['data', 'data2'], {:folders => ['blip', 'blap'], :root_files => :before})  
+</pre>
+
+h2. Copyright
+
+Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/lib/require-magic.rb

@@ -26,8 +26,9 @@ module Require
 
   def self.enter(name, options = {}, &block)
     options[:recursive] = true
-    file  folder(name, options)
-    yield File.dirname(file)    
+    file = folder(name, options)
+    base_path = File.dirname(file)
+    yield base_path    
   end
 
 
@@ -123,18 +124,20 @@ protected
     end
   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)}
+  def self.match(f, *rexp)      
+      rexp.each{|e| return true if match_single(f, rexp)}
       false
-    elsif rexp.kind_of? Regexp  
-      match_res = (f =~ rexp)
-      !match_res.nil?
+  end
+  
+  def self.match_single(f, rexp)
+    if rexp.kind_of? String
+      str = Regexp.escape(str)
+      str.gsub! '\*', '[a-zA-Z0-9\s_-]*'
+      str.gsub! '/', '\/'      
     end
+    if rexp.kind_of? Regexp  
+      return f.match(re)
+    end    
+    false
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: require-magic
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -21,13 +21,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.textile
 files: 
 - lib/require-dsl.rb
 - lib/require-magic.rb
 - lib/util/util.rb
 - LICENSE
-- README.rdoc
+- README.textile
 has_rdoc: true
 homepage: http://github.com/kristianmandrup/require-magic
 licenses: []

data/README.rdoc

@@ -1,122 +0,0 @@
-= require-magic
-
-Utility functions to facilitate importing (require) ruby files in complex Ruby project, such as gem with complex folder hierarchies. 
-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  
-
-<code>
-require 'require_magic' # include both the old static require helpers and the DSL require language
-require 'require_dsl'  # alternatively only include require_dsl (the DSL language)
-
-Folder.enter [path relative to current file location] do |folder|
-  # from new location, enter a subdir
-  folder.enter [subdir] do |path|        
-    folder.all('**/*.rb').except(/sound\/*.rb/).require  
-  end
-
-  # from new location, enter a subdir
-  folder.enter [another subdir] do |path|           
-    # use file blobs here
-    folder.all('**/*.rb').require
-  end
-
-  # from new location, enter a subdir
-  folder.enter [yet another subdir] do |path|         
-    # matching and except are to be used as include and exclude filters
-    # they each take a list containing regular expressions and strings
-    # string arguments are postfixed with .rb internally if not present  
-    folder.all('blip/**/*.rb').matching(/_mixin.rb/, /.*\/power/).except(/sound/, /disco/).require
-    
-    folder.enter [subdir] do |path|         
-      folder.enter [subdir] do |path|         
-        folder.all('grusch/**/*.rb').require
-      end
-
-    end
-    folder.all.require    
-  end
-
-end
-
-# use current path as folder
-Folder.enter do |folder| 
-  folder.all('**/*.rb').require
-  folder.enter 'game' do |path|
-    list = folder.all('**/*.rb')    
-    # puts list.matching('sound', 'network').except(/sound/).show_require(:relative)
-    list.matching('sound', 'network').except(/sound/).require
-  end
-end
-</code>
-
-== Static helpers
-See unit tests for demonstrations of how to use it:
-
-# Set basepath to use for require
-<code>
-required_files = Require.base_path = File.dirname(__FILE__)
-</code>
-
-To require all files within the top level folder 'data' (non-recursively)
-<code>
-required_files = Require.folders('data')
-</code>
-
-Override base_path
-<code>
-required_files = Require.folders('data', {:base_path => File.dirname(__FILE__) + '/../my/path})
-</code>
-
-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
-<code>
-required_files = Require.folder 'data'
-required_files = Require.folders 'data'
-</code>
-
-To require all files within the top level folder 'data' recursively 
-<code>
-required_files = Require.recursive('data')
-</code>
-
-To require all files within the top level folders 'data' and 'data2' (non-recursively) 
-<code>
-required_files = Require.recursive(['data', 'data2'])
-</code>
-
-To require all files within the top level folders 'data' and 'data2' recursively 
-<code>
-required_files = Require.recursive(['data', 'data2'])
-</code>
-
-To require files within the top level folders 'data' and 'data2' and also files within the subdirectory 'blip' if it exists 
-<code>
-required_files = Require.folders(['data', 'data2'], {:folders => ['blip]})
-</code>
-
-To require files within 'data/blip' and 'data2/blip' only, NOT including the root files
-<code>
-required_files = Require.folders(['data', 'data2'], {:folders => ['blip], :ignore_root_files => true})
-</code>
-
-To require files within 'data' and 'data2' first and then AFTER any files within the subdirectory 'blip' (default order)
-<code>
-required_files = Require.folders(['data', 'data2'], {:folders => ['blip], :root_files => :before})
-</code>
-
-To require files within 'data/blip' and 'data2/blip' first and then AFTER any files within 'data' and 'data2' folders (the root files)
-<code>
-required_files = Require.folders(['data', 'data2'], {:folders => ['blip], :root_files => :after})
-</code>
-
-To require files within 'data' and 'data2' (the root files) first (BEFORE) and then any files within the subdirectory 'blip'
-<code>
-required_files = Require.folders(['data', 'data2'], {:folders => ['blip], :root_files => :before})
-</code>
-
-== Copyright
-
-Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.