require-magic 0.2.5 → 0.4.0

data/README.rdoc

@@ -5,44 +5,83 @@ See unit tests in /test directory to see how to use the tools for the best effec
 Using this toolset should really simplify your require statements and make your application more flexible to change.
 
 == USAGE
+
+require 'require_magic'
+
+# alternatively to only include require_dsl
+require 'require_dsl'
+
+Require.magic [path relative to current file location] do |magic|
+  # from new location, enter a subdir
+  magic.enter [subdir] do |path|        
+    magic.require_all('**/*.rb').except(/sound\/*.rb/).require  
+  end
+
+  # from new location, enter a subdir
+  magic.enter [another subdir] do |path|           
+    # use file blobs here
+    magic.require_all('**/*.rb').require
+  end
+
+  # from new location, enter a subdir
+  magic.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  
+    magic.require_all('blip/**/*.rb').matching(/_mixin.rb/, /.*\/power/).except(/sound/, /disco/).require
+  end
+
+end
+
+Require.magic '../spec/fixtures' do |magic|
+  magic.enter 'game' do |path|
+    list = magic.require_all('**/*.rb')    
+    # puts list.matching('sound', 'network').except(/sound/).show_require(:relative)
+    list.matching('sound', 'network').except(/sound/).require
+  end
+end
+
+
+== USAGE (Deprecated)
 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')
+* required_files = Require.folders('data')
 
 Override base_path
-* required_files = Require.folder('data', {:base_path => File.dirname(__FILE__) + '/../my/path})
+* required_files = Require.folders('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')
+* required_files = Require.folder 'data'
+* required_files = Require.folders 'data'
 
 To require all files within the top level folder 'data' recursively 
-* required_files = Require.rfolder('data')
+* required_files = Require.recursive('data')
 
 To require all files within the top level folders 'data' and 'data2' (non-recursively) 
-* required_files = Require.rfolders(['data', 'data2'])
+* required_files = Require.recursive(['data', 'data2'])
 
 To require all files within the top level folders 'data' and 'data2' recursively 
-* required_files = Require.rfolders(['data', 'data2'])
+* required_files = Require.recursive(['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
+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})
 
-To require files within 'data' and 'data2' first and then any files within the subdirectory 'blip' (default order)
+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})
 
-To require files within 'data/blip' and 'data2/blip' first and then any files within 'data' and 'data2' folders
+To require files within 'data/blip' and 'data2/blip' first and then AFTER any files within 'data' and 'data2' folders (the root files)
 * 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'
+To require files within 'data' and 'data2' (the root files) first (BEFORE) and then any files within the subdirectory 'blip'
 * required_files = Require.folders(['data', 'data2'], {:folders => ['blip], :root_files => :before})
 
 
@@ -59,4 +98,4 @@ To require files within 'data' and 'data2' first and then any files within the s
 
 == Copyright
 
-Copyright (c) 2009 Kristian Mandrup. See LICENSE for details.
+Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/lib/require-dsl.rb

@@ -0,0 +1,102 @@
+require 'rake'
+require 'fileutils'
+require 'util/util'
+
+module Require
+
+  def self.magic(path, &block) 
+    yield Magic.new path
+  end
+  
+  module MagicList 
+    attr_accessor :base_path
+    attr_accessor :rel_path
+        
+    def require(file)
+      require file
+    end
+
+    def show_require(*options)
+      each do |f|                                                      
+        if options.include? :relative                                 
+          file_path = File.join(rel_path, f)
+          path = Require::Dir.relative_path(base_path, file_path)
+        end
+        path = File.join(base_path, f) if !options.include? :relative
+        path
+      end  
+    end
+
+     
+    def delete_these(objs) 
+      reject! do |obj|  
+        a = false
+        objs.each do |del|         
+          a = true if obj.include? del
+        end
+        a
+      end
+    end
+    
+    def except(*reg_exps) 
+      self.each do |file|    
+        reg_exps.each {|re| self.delete(file) if file.match(re) }         
+      end
+      self
+    end        
+
+    def postfix_rb(str)
+      str << '.rb' if !str.include? '.rb'            
+    end            
+    
+    def matching(*reg_exps) 
+      keep_list = []
+      each do |file| 
+        reg_exps.each do |re|
+          postfix_rb(re) if re.kind_of? String
+          keep_list << file if file.match(re)
+        end
+      end                              
+      reject_list = (self - keep_list).flatten
+      delete_these(reject_list)
+      self
+    end    
+  end
+
+  class Magic
+    attr_accessor :current_path
+    attr_accessor :dir_stack
+    
+    def initialize(dir)      
+      @dir_stack = []
+      @current_path = FileUtils.pwd
+      @current_path = enter(dir)      
+    end
+    
+    def enter(dir)       
+      FileUtils.cd dir
+      dir_stack.push path = FileUtils.pwd 
+      @current_path = path
+      if block_given?
+        yield path
+         dir_stack.pop            
+         current_path = dir_stack.last
+      end      
+      path
+    end
+
+    def require_all(*globs)      
+      list = FileList.new(globs)
+      list.extend(MagicList)  
+      list.base_path = dir_stack.first 
+      list.rel_path = current_path    
+      list
+    end
+        
+  end
+end  
+              
+    
+    
+
+    

data/lib/require-magic.rb

@@ -1,27 +1,45 @@
-require 'rubygems'
-require 'singleton'
-class Require
-  include Singleton
+require 'require-dsl'
+
+module Require
   
   class << self
     attr_accessor :base_path
     attr_accessor :tracing
     attr_accessor :verbose
   end
-  def self.rfolder(name, options = {})
+
+  def self.recursive(*names, options, &block)
+    options = {} if !options     
     options[:recursive] = true
-    folder(name, options)    
+    names.each{|name| folder(name, options) }
   end
   
+  def self.folders(*names, options)
+    options = {} if !options 
+    required_files = []
+    names.each do |path| 
+      options[:root] = path if is_root?(path, options) 
+      required_files << folder(path, options)
+    end
+    required_files.flatten
+  end
+
+  def self.enter(name, options = {}, &block)
+    options[:recursive] = true
+    file  folder(name, options)
+    yield File.dirname(file)    
+  end
+
+
   def self.folder(name, options = {})
     recursive = options[:recursive]
     folder_list = options[:folders]
     file_pattern =  recursive ? "#{name}/**/*.rb" : "#{name}/*.rb" 
-    
+  
     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)
@@ -39,22 +57,7 @@ class Require
       # 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 = {})
-    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
+  end    
 
 protected
   def self.puts_trace(txt, options)

data/lib/util/util.rb

@@ -0,0 +1,13 @@
+require 'pathname'
+
+module Require
+  module Dir
+    def self.relative_path(base_path, path)
+      path.gsub! /#{Regexp.escape base_path}/ 
+      p1 = Pathname.new base_path
+      p2 = p1 + path
+      p4 = p2.relative_path_from(p1)  # Pathname:lib/ruby/1.8    
+    end
+  end
+end
+  

data/spec/fixtures/game/game.rb

@@ -0,0 +1 @@
+puts "Game was included"

data/spec/fixtures/game/graphics/graphics.rb

@@ -0,0 +1 @@
+puts "Graphics was included"

data/spec/fixtures/game/network/network.rb

@@ -0,0 +1 @@
+puts "Network was included"

data/spec/fixtures/game/sound/sound.rb

@@ -0,0 +1 @@
+puts "Sound was included"

data/spec/require-dsl_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "RequireMagic" do
+  it "works" do
+    Require.magic '../spec/fixtures' do |magic|
+      magic.enter 'game' do |path|
+        list = magic.require_all('**/*.rb')    
+        puts list.matching( 'sound', 'network').except(/sound/).show_require(:relative).inspect.should include("network/network.rb")
+      end
+    end    
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,6 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+# require 'require-dsl'
 require 'require-magic'
-require 'spec'
-require 'spec/autorun'
-
-Spec::Runner.configure do |config|
-  
-end
+require 'rspec'
+require 'rspec/autorun'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: require-magic
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
+  version: 0.4.0
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -11,18 +11,9 @@ cert_chain: []
 
 date: 2010-03-02 00:00:00 -04:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.9
-    version: 
-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
+dependencies: []
+
+description: Lets you easily define how to include hierarchies of ruby files, and also apply inclusion/exclusion filters for what to include
 email: kmandrup@gmail.com
 executables: []
 
@@ -32,7 +23,9 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
+- lib/require-dsl.rb
 - lib/require-magic.rb
+- lib/util/util.rb
 - LICENSE
 - README.rdoc
 has_rdoc: true
@@ -62,9 +55,13 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: utility to facilitate require of .rb files and folders
+summary: Facilitates requiring select ruby files in folders
 test_files: 
-- spec/require-magic_spec.rb
+- spec/fixtures/game/game.rb
+- spec/fixtures/game/graphics/graphics.rb
+- spec/fixtures/game/network/network.rb
+- spec/fixtures/game/sound/sound.rb
+- spec/require-dsl_spec.rb
 - spec/spec_helper.rb
 - test/test_require_folder.rb
 - test/test_require_folders.rb

data/spec/require-magic_spec.rb

@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "RequireMagic" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
-end