require-dsl 0.2.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kristian Mandrup
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,168 @@
+# Required
+
+Handle load and require ruby files using a nice DSL.
+
+## Install
+
+<code>gem install require-dsl</code>
+
+## Usage
+
+<code>require 'require-dsl'</code>
+
+## Using the DSL
+
+Imagine we are using the DSL inside a file basic.rb in <code>lib/project/report</code>
+
+Passing 'spec' and the current file, lets Required determine that it should create require statements relative to 'spec' as the root folder.
+The method 'ruby_files' is evaluated in the context of the file it is used in, i.e File.dirname(__FILE___) which could alternatively be passed as the second argument.
+
+### Recursive option
+
+By default the files are evaluated non-recursively, that is within the current folder and not any subfolders. You can explicitly set it with the <code>:recursive => :none</code> option
+
+<pre>
+# lib/project/report/basic.rb
+
+ruby_files('spec', __FILE__) # OR ruby_files('spec', __FILE__, :recursive => :none)
+==> ['lib/project/report/basic.rb']
+</pre>
+
+To evaluate all files within the current folder and recursively one level below, use the <code>:recursive => :single</code> option. 
+
+<pre>
+# lib/project/report/basic.rb
+
+ruby_files('spec', __FILE__, :recursive => :single)
+==> ['lib/project/report/basic.rb', 'lib/project/report/subfolder/in_the_sub.rb']
+</pre>
+
+To evaluate all files within the current folder and recursively traversing the complete hierarchy of subfolders, use the <code>:recursive => :full</code> option. 
+
+<pre>
+# lib/project/report/basic.rb
+
+ruby_files('spec', __FILE__, :recursive => :full)
+==> ['lib/project/report/basic.rb', 'lib/project/report/subfolder/in_the_sub.rb', 
+'lib/project/report/subfolder/sub_sub/in_the_sub_of_the_sub.rb']
+</pre>
+
+### Except conditions
+
+You can chain except_file(s) and except_folder(s) conditions on the filelist returned by ruby_files to filter out specific files and folders.
+
+#### Condition: except_file(s)
+
+<pre>
+# Context: An extra file 'except_me.rb' has been added to the project/report folder:
+
+ruby_files('lib', __FILE__).except_file('except_me')
+==> 'project/report/basic.rb'
+
+# Context: An extra file 'except_also_me.rb' has been added to the folder:
+
+ruby_files('lib', __FILE__).except_files('except_me', 'except_also_me')
+==> 'project/report/basic.rb'
+
+ruby_files('lib', __FILE__).except_file('except_me').except_files('except_also_me')
+==> 'project/report/basic.rb'
+</pre>
+
+#### Condition: except_folder(s)
+
+<pre>
+# Context: Extra folders 'not_me_folder' and 'me_folder' has been added to the project/report folder:
+
+ruby_files('lib', __FILE__).except_folder('not_me_folder')
+==> 'project/report/basic.rb', 'project/report/me_folder/yes_me.rb'
+
+ruby_files('lib', __FILE__).except_folders('not_me_folder', 'me_folder')
+==> 'project/report/basic.rb'
+
+ruby_files('lib', __FILE__).except_folder('not_me_folder').except_folders('me_folder')
+==> 'project/report/basic.rb'
+</pre>
+
+### Only conditions
+
+You can chain only_file(s) and only_folder(s) conditions on the filelist returned by ruby_files to filter out specific files and folders.
+
+Note: It rarely makes sense to chain multiple only conditions.
+
+#### Condition: only_file(s)
+
+<pre>
+# Context: An extra file 'only_me.rb' has been added to the project/report folder:
+
+ruby_files('lib', __FILE__).only_file('only_me')
+==> 'project/report/only_me.rb'
+
+# Context: An extra file 'also_only_me.rb' has been added to the folder:
+
+ruby_files('lib', __FILE__).only_files('only_me', 'also_only_me')
+==> 'project/report/only_me.rb', 'project/report/also_only_me.rb'
+</pre>
+
+#### Condition: only_folder(s)
+
+<pre>
+# Context: Extra folders 'only_me_folder' and 'me_folder' has been added to the project/report folder:
+
+ruby_files('lib', __FILE__).only_folder('only_me_folder')
+==> 'project/report/basic.rb', 'project/report/only_me_folder/yes_me.rb'
+
+ruby_files('lib', __FILE__).only_folders('only_me_folder', 'me_folder')
+==> 'project/report/basic.rb', 'project/report/only_me_folder/yes_me.rb', 'project/report/me_folder/me.rb'
+</pre>
+
+
+## strip_file_ext
+
+Chaining a call to strip_file_ext, ensures that the file list is stripped of the .rb ending and thus usable for fx require statements. 
+
+<pre>
+# lib/project/report/basic.rb
+
+ruby_files('lib', __FILE__).strip_file_ext
+==> 'project/report/basic'
+</pre>
+
+The method *strip_file_ext* can take an argument to indicate a built-in action to perform on this file liust, fx load the files into ruby kernel (:load or :require), display them for debugging (:display)
+
+<pre>
+# lib/project/report/basic.rb
+
+ruby_files('lib', __FILE__).except('except_me', 'except_also_me').strip_file_ext :display => 'require'
+==> PRINTS "require 'project/report/basic'\n" to STDOUT
+
+ruby_files('lib', __FILE__).except('except_me', 'except_also_me').strip_file_ext :require
+==> 'project/report/basic' loaded into Ruby and executed if not previously loaded (using Ruby Kernel 'require' statement)
+
+ruby_files('lib', __FILE__).except('except_me', 'except_also_me').strip_file_ext :load
+==> 'project/report/basic' loaded into Ruby and executed (using Ruby Kernel 'load' statement)
+</pre>
+
+## output to StringIO
+
+<pre>
+out = StringIO.new  
+ruby_files('lib', __FILE__, :stdout => out).strip_file_ext :display => :load
+out.rewind
+puts out.read
+==> PRINTS "load 'project/report/basic'\n" to STDOUT
+
+</pre>
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "require-dsl"
+    gem.summary = %Q{DSL to facilitate require/load of ruby files and folders}
+    gem.description = %Q{DSL to facilitate require/load of ruby files and folders}
+    gem.email = "kmandrup@gmail.com"
+    gem.homepage = "http://github.com/kristianmandrup/required"
+    gem.authors = ["Kristian Mandrup"]
+    gem.add_development_dependency "rspec", ">= 2.0.0.beta.14"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+# require 'spec/rake/spectask'
+# Spec::Rake::SpecTask.new(:spec) do |spec|
+#   spec.libs << 'lib' << 'spec'
+#   spec.spec_files = FileList['spec/**/*_spec.rb']
+# end
+# 
+# Spec::Rake::SpecTask.new(:rcov) do |spec|
+#   spec.libs << 'lib' << 'spec'
+#   spec.pattern = 'spec/**/*_spec.rb'
+#   spec.rcov = true
+# end
+# 
+# task :spec => :check_dependencies
+# 
+# task :default => :spec
+# 
+# require 'rake/rdoctask'
+# Rake::RDocTask.new do |rdoc|
+#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
+# 
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "required #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/lib/require-dsl.rb

@@ -0,0 +1,198 @@
+require 'stringio'
+
+def ruby_files base_path, path, options = {}, &block
+  required = Required.new(base_path, path)
+  stdout = options[:stdout] if options[:stdout]
+  required.stdout = stdout
+  files = []       
+  dir = File.dirname path
+  FileUtils.cd dir do |dir|            
+    glob = Required.glob(options)
+    files = FileList.new(glob) 
+    Required.extend_files(files, required)
+    files.select_ruby_files!
+    files.prefix_with_path! required.location
+  end
+  if block
+    block.arity < 1 ? files.instance_eval(&block) : block.call(files)
+  else
+    files
+  end  
+end
+
+class Required
+  attr_accessor :location, :stdout
+  
+  def initialize base_path, path
+    rel_path = relative_path(base_path, path)
+    @location = File.dirname(rel_path) 
+  end
+
+  def self.glob options
+    case options[:recursive]
+    when :full
+      '**/*.rb'    
+    when :single
+      ['*/*.rb', '*.rb']
+    else
+      '*.rb'
+    end
+  end
+  
+  def self.extend_files files, required
+    files.extend(FileListExtension).required = required 
+    files.map! do |f| 
+      f.extend(FileString)
+      f.required = required
+      f
+    end 
+    files
+  end    
+  
+  protected
+
+  def relative_path base_path, path 
+    last_part_path = path.gsub /(\S*?)#{Regexp.escape(base_path)}\/(.*?)/, '\2'
+    File.join(base_path, last_part_path)
+  end
+  
+end  
+
+module FileListExtension
+
+  attr_accessor :required
+
+  def prefix_with_path! location    
+    self.map! do |f| 
+      f = File.join(location, f).extend(FileString)
+      f.required = required       
+      f
+    end
+    self          
+  end
+
+  def strip_file_ext mode = nil
+    self.map!{|f| f.remove_rb }
+    if mode
+      self.action mode
+    else
+      self
+    end
+  end
+
+  def select_ruby_files!
+    self.select! {|f| (f =~ /[^\.]*.rb$/) == 0 }
+    self
+  end
+
+  def except_folders *reject_folders    
+    self.reject! do |file| 
+      file.matches_any_folder reject_folders
+    end
+    self
+  end
+
+  
+  def except_files *reject_files
+    self.reject! do |file| 
+      file.matches_any reject_files
+    end
+    self
+  end
+
+  def only_folders *only_folders
+    self.select! do |file| 
+      !file.inside_a_folder? || file.matches_any_folder(only_folders)
+    end
+    self
+  end
+
+  def only_files *only_files
+    self.select! do |file| 
+      file.matches_any only_files
+    end
+    self
+  end
+
+  protected
+  
+  def action mode = :require
+    self.each{|f| f.handle_file mode}      
+  end
+  
+      
+end
+
+module FileString  
+
+  attr_accessor :required
+
+  def handle_file mode = nil
+    stdout = required.stdout    
+    case mode
+    when Hash      
+      case stdout
+      when StringIO
+        stdout.write display_text(mode)
+      else
+        puts "#{mode[:display]} '#{self}'" if mode[:display]
+        puts self if !mode[:display]  
+      end
+        
+    when :display    
+      stdout.puts self
+    when :require
+      require self
+    when :require
+      load self
+    else
+      self
+    end
+  end
+
+  def display_text mode
+    mode[:display] ? "#{mode[:display]} '#{self}'\n" : "#{self}\n"    
+  end
+
+  def remove_rb
+    self.sub!('.rb', '')
+  end  
+  
+  def matches_any match_files
+    match_files.any? {|match_file| match? match_file }    
+  end
+
+  def matches_any_folder match_folders  
+    match_folders.any? {|match_folder| match_folder? match_folder }
+  end
+
+  def inside_a_folder?
+    return true if (self =~ /#{Regexp.escape(required.location)}\/(.*?)\//) != nil      
+  end
+
+  protected
+
+  def match? match_file
+    case match_file
+    when String
+      (self =~ /#{Regexp.escape(match_file)}.rb$/) != nil
+    when Regexp
+      (self =~ /#{match_file.source}.rb$/) != nil
+    else
+      raise ArgumentError, "File matcher must be either a String or RegExp"
+    end
+  end
+
+  def match_folder? match_folder                
+    case match_folder
+    when String
+      (self =~ /#{Regexp.escape(required.location)}\/#{Regexp.escape(match_folder)}\//) != nil
+    when Regexp
+      (self =~ /#{Regexp.escape(required.location)}\/#{match_folder.source}\//) != nil
+    else
+      raise ArgumentError, "File matcher must be either a String or RegExp"
+    end
+  end
+
+
+end  

data/spec/.rspec

@@ -0,0 +1 @@
+--color

data/spec/required/required_spec.rb

@@ -0,0 +1,113 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class String
+  def remove_rb
+    self.sub!('.rb', '')
+  end  
+end
+
+def path *args
+  File.join args
+end
+
+def current_folder
+  File.dirname(__FILE__)  
+end
+
+describe "Required" do
+  let (:folder) { current_folder }
+  let (:dir)    { 'spec/required' }
+  
+  context "current folder: #{current_folder}"  do
+    describe '#' do
+      it "should list all 'pure' ruby files, , none recursive" do
+        res = ruby_files('spec', __FILE__)
+        res2 = ruby_files('spec', __FILE__, :recursive => :none) 
+        res.should == res2
+        res.should include(path dir, File.basename(__FILE__) )
+        res.should_not include(path dir, 'not_me.erb.rb' )
+        res.should_not include(path dir, 'not_this_folder', 'sub_not_me.rb' )
+        res.should_not include(path dir, 'this_folder', 'yes_me.rb' )
+        res.should_not include(path dir, 'this_folder', 'subsub', 'a_sub_sub_file.rb' )
+      end
+
+      it "should list all 'pure' ruby files, full recursive" do
+        res = ruby_files('spec', __FILE__, :recursive => :full)
+        res.should include(path dir, 'this_folder', 'subsub', 'a_sub_sub_file.rb' )
+      end
+
+      it "should list all 'pure' ruby files, single recursive" do
+        res = ruby_files('spec', __FILE__, :recursive => :single)
+        res.should include(path dir, File.basename(__FILE__) )
+        res.should_not include(path dir, 'this_folder', 'subsub', 'a_sub_sub_file.rb' )
+      end
+
+      it "should list all 'pure' ruby files except one file" do
+        res = ruby_files('spec', __FILE__).except_files('except_me')
+        res.should include(path dir, File.basename(__FILE__))
+        res.should_not include(path dir, 'not_me.erb.rb')
+        res.should_not include(path dir, 'except_me.rb')
+        res.should include(path dir, 'except_also_me.rb') # not in except list
+      end
+
+      it "should list all 'pure' ruby files except one file using block DSL" do
+        res = ruby_files('spec', __FILE__) do
+          except_files('except_me')
+        end
+        res.should include(path dir, File.basename(__FILE__))
+        res.should_not include(path dir, 'not_me.erb.rb')
+        res.should_not include(path dir, 'except_me.rb')
+        res.should include(path dir, 'except_also_me.rb') # not in except list
+      end
+
+      
+      it "should list all 'pure' ruby files except two file" do
+        res = ruby_files('spec', __FILE__).except_files('except_me', 'except_also_me')
+        res2 = ruby_files('spec', __FILE__).except_files('except_me').except_files('except_also_me')        
+        res2.should == res
+        res.should include(path dir, File.basename(__FILE__))
+        res.should_not include(path dir, 'not_me.erb.rb')
+        res.should_not include(path dir, 'except_me.rb')
+        res.should_not include(path dir, 'except_also_me.rb')
+      end
+            
+      it "should list required files" do
+        res = ruby_files('spec', __FILE__).except_files('except_me').strip_file_ext
+        res.should include(path dir, File.basename(__FILE__).remove_rb)
+        res.should_not include(path dir, 'not_me.erb')
+        res.should_not include(path dir, 'except_me')
+        res.should include(path dir, 'except_also_me')
+      end
+
+      it "should list only required files" do          
+        out = StringIO.new
+        res = ruby_files('spec', __FILE__, :stdout => out).only_files(/.*only.*/).strip_file_ext :display => :require
+        out.rewind
+        out.read.should match /require '(.*?)'/
+        res.should_not include(path dir, File.basename(__FILE__).remove_rb)
+        res.should include(path dir, 'only_me')
+        res.should_not include(path dir, 'except_me')
+        res.should_not include(path dir, 'except_also_me')
+      end
+
+      it "should list all 'pure' ruby files except one subfolder using block DSL" do
+        res = ruby_files('spec', __FILE__, :recursive => :full) do
+          except_folders('not_this_folder')
+        end.strip_file_ext
+        res.should include(path dir, File.basename(__FILE__).remove_rb)
+        res.should include(path dir, 'this_folder', 'yes_me')
+      end
+
+      it "should list all 'pure' ruby files except one subfolder using block DSL" do
+        res = ruby_files('spec', __FILE__, :recursive => :full) do
+          only_folders('this_folder')
+        end.strip_file_ext
+        res.should include(path dir, File.basename(__FILE__).remove_rb)
+        res.should include(path dir, 'this_folder', 'yes_me')
+        res.should_not include(path dir, 'not_this_folder', 'sub_not_me')
+      end
+
+
+    end    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'rspec/autorun'
+
+require 'rake'
+require 'fileutils'
+
+require 'require-dsl'
+
+RSpec.configure do |config|
+#  config.include(Matchers)  
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: require-dsl
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-29 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 14
+        version: 2.0.0.beta.14
+  type: :development
+  version_requirements: *id001
+description: DSL to facilitate require/load of ruby files and folders
+email: kmandrup@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/require-dsl.rb
+- spec/.rspec
+- spec/required/except_also_me.rb
+- spec/required/except_me.rb
+- spec/required/not_me.erb.rb
+- spec/required/not_this_folder/sub_not_me.rb
+- spec/required/only_me.rb
+- spec/required/required_spec.rb
+- spec/required/this_folder/subsub/a_sub_sub_file.rb
+- spec/required/this_folder/yes_me.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kristianmandrup/required
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: DSL to facilitate require/load of ruby files and folders
+test_files: 
+- spec/required/except_also_me.rb
+- spec/required/except_me.rb
+- spec/required/not_me.erb.rb
+- spec/required/not_this_folder/sub_not_me.rb
+- spec/required/only_me.rb
+- spec/required/required_spec.rb
+- spec/required/this_folder/subsub/a_sub_sub_file.rb
+- spec/required/this_folder/yes_me.rb
+- spec/spec_helper.rb