require-me 0.6.5 → 0.7.3

data/README.markdown

@@ -3,6 +3,11 @@
 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.
 
+## Important ##
+            
+The tool has gone through some more testing and some bugs have been found and fixed so it should now be more stable. 
+The rspec tests in spec/dsl directory demonstrate most of these new features.
+
 ## Installation ##
 This gem is also available for installation on gemcutter.
 
@@ -74,7 +79,28 @@ Folder.enter do |folder| # use current path as folder
 end  
 </pre>
 
-Using 'require_me' method #
+Using 'require_rel' method. This is nice when fx requiring helper files used in test suite files
+
+<pre>
+require File.expand_path(File.dirname(__FILE__) + "../../../spec_helper")
+</pre>
+                                                                        
+Can be replaced with the following in all .rb files under /spec
+
+<pre>
+Folder.require_rel 'spec/spec_helper', __FILE__
+</pre>
+
+Or ... using special convenience wrappers
+
+
+<pre>
+Folder.require_spec 'spec_helper', __FILE__  # relative to /spec folder 
+
+Folder.require_test 'spec_helper', __FILE__ # relative to /test folder
+</pre>
+
+Using 'require_me' method
 
 <pre>
 
@@ -160,6 +186,7 @@ Set verbose mode on to see full path of each required file
   Require.verbose = :off  # turn off verbose globally
 </pre>
 
+
 ### Require.recursive ##
 
 Require all files within the top level folder 'data' recursively 

data/lib/folder/folder.rb

@@ -0,0 +1,94 @@
+require 'folder/magic'
+require 'folder/magic_list'
+
+module Folder
+  def self.enter(path = '.', &block) 
+    m = Magic.new      
+    m.enter path    
+    m.relative_to_me    
+    if block_given? 
+      yield m
+    end
+    m.exit
+  end 
+
+  def self.enter_here(file, &block) 
+    m = Magic.new      
+    path = File.dirname(file)
+    m.enter path   
+    m.relative_to_me     
+    if block_given?
+      yield m
+    end
+    m.exit
+  end 
+
+  def self.rel_base(dir, source, &block)  
+    enter(relative_path dir, source, &block) 
+  end
+
+  # Folder.require_rel 'spec/spec_helper', __FILE__
+  # require /spec/spec_helper.rb relative to current file location
+  def self.relative_path(req_file, source, base_dir = nil)
+    req_file = File.join(base_dir, req_file) if base_dir
+    source_dir = File.dirname(source)
+    req_dir = req_file.split('/')[0] || req_file 
+    # puts "req_dir: #{req_dir}"
+    
+    req_file = req_file.split('/')[1]  
+    folders = source_dir.split req_dir 
+         
+    folderlist = folders[1] ? folders[1].split('/') : folders[1]
+    if folderlist    
+      path_nav = folderlist.inject([]){|res, f| res << '..' }.join('/')     
+    else
+      path_nav = ''
+    end
+    File.expand_path(source_dir + "#{path_nav}/#{req_file}")  
+  end
+
+  # Folder.require_rel 'spec/spec_helper', __FILE__
+  # require /spec/spec_helper.rb relative to current file location
+  def self.require_rel(req_file, source, base_dir = nil)
+    require relative_path(req_file, source, base_dir)
+  end
+
+  def self.require_spec(req_file, source)
+    require relative_path(req_file, source, 'spec')
+  end
+
+  def self.require_test(req_file, source)
+    require relative_path(req_file, source, 'test')
+  end
+
+
+  def self.require_all(*folders)
+    return Magic.new.all.dup.extend(MagicList).do_require if folders.empty?
+    folders.each do |folder|
+      enter folder do |f| 
+        f.all.dup.extend(MagicList).do_require
+      end
+    end
+  end
+
+  def self.show_require_all(*folders)
+    return Magic.new.all.dup.extend(MagicList).show_require if folders.empty?
+    folders.each do |folder|
+      enter folder do |f|  
+        f.all.dup.extend(MagicList).show_require
+      end
+    end
+  end
+
+
+  def self.here(file)
+    FileUtils.cd File.dirname(file)
+    self
+  end    
+
+  def self.require_me(*files)
+    return Magic.new.all(files).dup.extend(MagicList).do_require     
+  end      
+  
+
+end

data/lib/folder/magic.rb

@@ -0,0 +1,97 @@
+require 'pathname'
+
+module Folder
+  class Magic
+    attr_accessor :current_path
+    attr_accessor :dir_stack
+    attr_accessor :relative_path
+    
+    def initialize      
+      @dir_stack = []
+      @current_path = FileUtils.pwd
+      
+    end
+
+    def relative_to_me
+      @relative_path = me
+    end
+
+    def to_s
+      "path: #{current_path}, directory stack: #{dir_stack.inspect}"
+    end
+
+    def me       
+      Pathname.new(current_path).basename.to_s
+    end    
+    
+    def enter(dir)   
+      path = FileUtils.pwd
+      dir_stack.push path    
+      FileUtils.cd dir if !dir.empty?
+      @current_path = FileUtils.pwd
+      self.relative_to_me
+      if block_given?
+        yield self                    
+        exit              
+      end      
+      self
+    end
+
+    def exit
+      current_path = dir_stack.last
+      old_dir = dir_stack.last 
+      dir_stack.pop 
+      FileUtils.cd old_dir if old_dir               
+    end
+
+
+    def all(*globs)
+      globs = '**/*.rb' if globs.empty?      
+      list = FileList.new(globs) 
+      magic_list(list) 
+    end
+
+    def require_all(*folders)
+      relative = {:relative_to => relative_path || ''}
+      relative = folders.pop if folders && !folders.empty? && folders.last.kind_of?(Hash)      
+
+      # puts "relative_to: #{relative[:relative_to]}"
+
+      if folders.empty?
+        files = all.dup.extend(MagicList)
+        files.rel_path = relative[:relative_to]
+        return files.do_require        
+      end
+
+      # puts "iterate"
+      folders.each do |folder|   
+        enter folder do |f|   
+          file = f.all.dup.extend(MagicList)
+          require_relative_to = relative ? relative_to(folder, relative) : folder                     
+          file.do_require(require_relative_to)
+        end
+      end
+    end
+
+    def require_me(*files)
+      file = all(files).dup.extend(MagicList)
+      file.do_require(relative_path)     
+    end      
+
+    protected            
+
+    def relative_to(folder, relative)
+      # puts "relative_to: #{relative.inspect}"      
+      # puts "relative_to: #{relative[:relative_to]}"      
+      relative[:relative_to] ? File.join(relative[:relative_to], folder) : folder
+    end
+    
+    def magic_list(list) 
+      list.extend(MagicList)  
+      list.base_path = dir_stack.first 
+      list.rel_path = current_path    
+      list.freeze
+    end
+            
+  end
+end

data/lib/folder/magic_list.rb

@@ -0,0 +1,72 @@
+module Folder
+  module MagicList 
+    attr_accessor :base_path
+    attr_accessor :rel_path
+      
+    def do_require(*options)     
+      rel_path = options.shift if options && !options.empty?
+      each do |file|                     
+        req_file = self.rel_path ? File.join(self.rel_path, file) : file                
+        require req_file
+      end 
+      self
+    end
+
+    def show_require(*options)
+      each do |f|                                                      
+        if options.include? :relative                                 
+          file_path = File.join(rel_path, f)
+          path = Require::Directory.relative_path(base_path, file_path)
+        end
+        path = File.join(base_path, f) if !options.include? :relative
+        path
+      end  
+    end
+    
+    def except(*reg_exps) 
+      duplicate = self.dup.extend(MagicList)  
+      duplicate.each do |file|    
+        reg_exps.each {|re| duplicate.delete(file) if file.match(re) }         
+      end
+      duplicate
+    end        
+  
+    def matching(*reg_exps) 
+      duplicate = self.dup.extend(MagicList)  
+      keep_list = []
+      duplicate.each do |file| 
+        reg_exps.each do |re|
+          re = fix(re) if re.kind_of? String
+          keep_list << file if file.match(re)
+        end
+      end                              
+      reject_list = (duplicate - keep_list).flatten
+      duplicate.delete_these(reject_list)
+    end   
+   
+   protected
+     def delete_these(objs) 
+       reject! do |obj|  
+         a = false
+         objs.each do |del|         
+           a = true if obj.include? del
+         end
+         a
+       end
+     end
+   
+   
+     def postfix_rb(str)
+       str << '.rb' if !str.include? '.rb'            
+     end            
+
+     def fix(str)   
+       postfix_rb(str) 
+       str = Regexp.escape(str)
+       str.gsub! '\*', '[a-zA-Z0-9\s_-]*'
+       str.gsub! '/', '\/'
+       str
+     end
+           
+  end
+end

data/lib/require-dsl.rb

@@ -1,182 +1,10 @@
 require 'rake'
 require 'fileutils'
 require 'util/util'
+                   
+require 'folder/folder'
 
-module Folder
 
-  def self.enter(path = '.', &block) 
-    m = Magic.new      
-    m.enter path    
-    if block_given?
-      yield m
-    end
-    m.exit
-  end 
-
-  def self.enter_here(file, &block) 
-    m = Magic.new      
-    path = File.dirname(file)
-    m.enter path    
-    if block_given?
-      yield m
-    end
-    m.exit
-  end 
-
-
-  def self.require_all(*folders)
-    return Magic.new.all.dup.extend(MagicList).do_require if folders.empty?
-    folders.each do |folder|
-      enter folder do |f| 
-        f.all.dup.extend(MagicList).do_require
-      end
-    end
-  end
-
-  def self.show_require_all(*folders)
-    return Magic.new.all.dup.extend(MagicList).show_require if folders.empty?
-    folders.each do |folder|
-      enter folder do |f|  
-        f.all.dup.extend(MagicList).show_require
-      end
-    end
-  end
-
-
-  def self.here(file)
-    FileUtils.cd File.dirname(file)
-    self
-  end    
-
-  def self.require_me(*files)
-    return Magic.new.all(files).dup.extend(MagicList).do_require     
-  end      
-  
-  module MagicList 
-    attr_accessor :base_path
-    attr_accessor :rel_path
-        
-    def do_require
-      each do |file|
-        require file
-      end 
-      self
-    end
-
-    def show_require(*options)
-      each do |f|                                                      
-        if options.include? :relative                                 
-          file_path = File.join(rel_path, f)
-          path = Require::Directory.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) 
-      duplicate = self.dup.extend(MagicList)  
-      duplicate.each do |file|    
-        reg_exps.each {|re| duplicate.delete(file) if file.match(re) }         
-      end
-      duplicate
-    end        
-
-    def postfix_rb(str)
-      str << '.rb' if !str.include? '.rb'            
-    end            
-
-    def fix(str)   
-      postfix_rb(str) 
-      str = Regexp.escape(str)
-      str.gsub! '\*', '[a-zA-Z0-9\s_-]*'
-      str.gsub! '/', '\/'
-      str
-    end
-    
-    def matching(*reg_exps) 
-      duplicate = self.dup.extend(MagicList)  
-      keep_list = []
-      duplicate.each do |file| 
-        reg_exps.each do |re|
-          re = fix(re) if re.kind_of? String
-          keep_list << file if file.match(re)
-        end
-      end                              
-      reject_list = (duplicate - keep_list).flatten
-      duplicate.delete_these(reject_list)
-      duplicate
-    end    
-  end
-
-  class Magic
-    attr_accessor :current_path
-    attr_accessor :dir_stack
-    
-    def initialize      
-      @dir_stack = []
-      @current_path = FileUtils.pwd
-    end
-
-    def to_s
-      "path: #{current_path}, directory stack: #{dir_stack.inspect}"
-    end
-    
-    def enter(dir)   
-      path = FileUtils.pwd
-      dir_stack.push path    
-      FileUtils.cd dir if !dir.empty?
-      @current_path = FileUtils.pwd
-      if block_given?
-        yield self                    
-        exit              
-      end      
-      self
-    end
-
-    def exit
-      current_path = dir_stack.last
-      old_dir = dir_stack.last 
-      dir_stack.pop 
-      FileUtils.cd old_dir if old_dir               
-    end
-
-
-    def all(*globs)
-      globs = '**/*.rb' if globs.empty?      
-      list = FileList.new(globs)
-      list.extend(MagicList)  
-      list.base_path = dir_stack.first 
-      list.rel_path = current_path    
-      list.freeze
-    end
-
-    def require_all(*folders)
-      return all.dup.extend(MagicList).do_require if folders.empty?
-      folders.each do |folder|
-        enter folder do |f|
-          f.all.dup.extend(MagicList).do_require
-        end
-      end
-    end
-
-    def require_me(*files)
-      return all(files).dup.extend(MagicList).do_require     
-    end      
-        
-  end
-end  
               
     
     

data/spec/blip.rb

@@ -0,0 +1 @@
+puts "Blip included"

data/spec/dsl/blap.rb

@@ -0,0 +1 @@
+puts "Blap included"

data/spec/dsl/require-dsl_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "RequireMagic" do
+  it "Folder.enter works " do          
+    Folder.enter '..' do   
+      Folder.enter '../fixtures/game' do |folder|            
+        # puts "Current 1:" + folder.current_path          
+      end
+      Folder.enter('../fixtures/game') do |folder|            
+        # puts "Current 2:" + folder.current_path          
+      end
+    end
+  end
+  
+  it "just works " do          
+    Folder.enter '../../fixtures' do |folder| # oops!
+      folder.enter 'game' do |f|
+        list = f.all('**/*.rb')                                                    
+        l1 = list.matching( 'sound', 'network').except(/sound/)
+  
+        # require fx 'game/network/network.rb'
+        l1.do_require(f.me)
+                
+        l1_res = l1.show_require(:relative).inspect
+        l1_res.should include("network/network.rb")
+  
+        l2 = list.matching( '*/sound', 'network').show_require(:relative).inspect        
+        l2.should include("network/network.rb")
+      end
+    end    
+  end
+  
+  it "works with require_all " do          
+    Folder.enter('../../fixtures/game') do |folder|            
+      folder.require_all 'graphics', 'network', 'sound'
+    end
+  end
+  
+  it "works with require_all and explicit :relative_to" do          
+    Folder.enter('../../fixtures/game') do |folder|            
+      folder.require_all 'graphics', 'network', 'sound', :relative_to => folder.me
+    end
+  end
+    
+  
+  it "works with require_all and require me" do          
+    Folder.enter '..' do    
+      Folder.enter '../fixtures/game' do |f|
+        f.require_all
+        f.require_me 'game.rb'
+      end            
+    end
+  end  
+  
+  it "works with require_all " do          
+    Folder.require_all '../../fixtures' 
+  end
+  
+  it "works with require_rel " do          
+    Folder.require_spec 'blip', __FILE__     
+
+    Folder.require_rel 'blap', __FILE__ , 'dsl' 
+    
+    Folder.require_rel 'spec/blip', __FILE__ 
+    Folder.require_rel 'blip', __FILE__ , 'spec' 
+
+    # puts Folder.relative_path 'blip', __FILE__ , 'spec' 
+  
+    Folder.rel_base 'spec', __FILE__ do |f|
+      f.require_me 'blip'      
+    end    
+  end 
+  
+    
+  it "works with base folder " do  
+    Folder.enter '..' do       
+      Folder.enter '../fixtures' do |folder|
+        # puts "Current 2:" + folder.current_path
+        folder.enter 'game' do |f|
+          f.relative_to_me # set implicit by default          
+          
+          f.require_all        
+          list = f.all # ('**/*.rb')                                                    
+          l1 = list.matching( 'sound', 'network').except(/sound/).show_require(:relative).inspect        
+          l1.should include("network/network.rb")
+  
+          l2 = list.matching( '*/sound', 'network').show_require(:relative).inspect        
+          l2.should include("network/network.rb")                      
+        end
+      end    
+    end
+  end    
+  
+end

data/spec/spec_helper.rb

@@ -1,7 +1,11 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'spec'))
-# require 'require-dsl'
-require 'require-me'
+require 'load-me'
 require 'rspec'
 require 'rspec/autorun'
+require 'require-me'
+
+# add fixtures to load path!
+LoadPath.relative_to(__FILE__, '../')
+LoadPath.add('fixtures')             
+
+
+

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 5
-  version: 0.6.5
+  - 7
+  - 3
+  version: 0.7.3
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,10 +14,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-18 00:00:00 -04:00
+date: 2010-05-29 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: load-me
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id002
 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: []
@@ -28,12 +57,24 @@ extra_rdoc_files:
 - LICENSE
 - README.markdown
 files: 
+- lib/folder/folder.rb
+- lib/folder/magic.rb
+- lib/folder/magic_list.rb
 - lib/playground.rb
 - lib/require-dsl.rb
 - lib/require-me.rb
 - lib/util/util.rb
 - LICENSE
 - README.markdown
+- spec/blip.rb
+- spec/dsl/blap.rb
+- spec/dsl/require-dsl_spec.rb
+- spec/require_more_spec.rb
+- spec/spec_helper.rb
+- test/test_require_folder.rb
+- test/test_require_folders.rb
+- test/test_require_folders_adv.rb
+- test/unit_test_require.rb
 has_rdoc: true
 homepage: http://github.com/kristianmandrup/require-magic
 licenses: []
@@ -44,6 +85,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -51,6 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -60,12 +103,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Facilitates requiring select ruby files in folders
 test_files: 
-- spec/require-dsl_spec.rb
+- spec/blip.rb
+- spec/dsl/blap.rb
+- spec/dsl/require-dsl_spec.rb
 - spec/require_more_spec.rb
 - spec/spec_helper.rb
 - test/test_require_folder.rb

data/spec/require-dsl_spec.rb

@@ -1,65 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "RequireMagic" do
-  it "Folder.enter works " do          
-    puts FileUtils.pwd
-    Folder.enter '../fixtures/game' do |folder|            
-      # puts "Current 1:" + folder.current_path          
-    end
-    Folder.enter('../fixtures/game') do |folder|            
-      # puts "Current 2:" + folder.current_path          
-    end
-  end
-
-  it "just works " do          
-    Folder.enter '../fixtures' do |folder| # oops!
-      folder.enter 'game' do |f|
-        list = folder.all('**/*.rb')                                                    
-        l1 = list.matching( 'sound', 'network').except(/sound/).do_require        
-        l1_res = l1.show_require(:relative).inspect
-        l1_res.should include("network/network.rb")
-  
-        l2 = list.matching( '*/sound', 'network').show_require(:relative).inspect        
-        l2.should include("network/network.rb")
-      end
-    end    
-  end
-  
-  it "works with require_all " do          
-    Folder.enter('../fixtures/game') do |folder|            
-      # puts "Current 1:" + folder.current_path    
-      folder.require_all 'graphics', 'network', 'sound'
-    end
-  end
-
-  it "works with require_all " do          
-    Folder.require_me '../fixtures/game/game.rb'
-    
-    Folder.enter '../fixtures/game' do |f|
-      f.require_all
-      f.require_me 'game.rb'
-    end            
-  end
-
-  it "works with require_all " do          
-    Folder.require_all '../fixtures' 
-  end
-
-  
-  it "works with base folder " do  
-    Folder.enter '../fixtures' do |folder|
-      # puts "Current 2:" + folder.current_path
-      folder.enter 'game' do |f|
-        # puts f
-        f.require_all        
-        list = f.all # ('**/*.rb')                                                    
-        l1 = list.matching( 'sound', 'network').except(/sound/).show_require(:relative).inspect        
-        l1.should include("network/network.rb")
-  
-        l2 = list.matching( '*/sound', 'network').show_require(:relative).inspect        
-        l2.should include("network/network.rb")                      
-      end
-    end    
-  end    
-  
-end