require_pattern 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5b24c83c3d4175da64ffc63b964fbbee9410c38
+  data.tar.gz: 386c726201430bf9c08d13dbf2e59d7f3283dbec
+SHA512:
+  metadata.gz: f7d74cab91a759eb53b0870a7f06b59564d09d9164747f86c8d1ba33dfd8a3f4e131fa2f5ce2882ffbb32cbcb33235921dfdc9932ad02b0a20248231c3ef06ae
+  data.tar.gz: c7b9a4283358588402e3a9c3f5d1a28475c61d6e61b3fa8486b9a49e77eb12187f2ac209f1b0723051d822688e5d7c014a3d125b567ece2803fa4c85c8641454

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2013 Tom Wardrop
+
+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.md

@@ -0,0 +1,25 @@
+Require Pattern
+===============
+This library provides a simple extension to the Kernel module that allows files to be conveniantly `require`'d based on a glob pattern.
+
+This library does NOT use load paths. Instead, it provides methods that load files either relative to the current working directory (`require_pattern`), or relative to the current file (`require_relative_pattern`).
+
+Why?
+----
+At this point you may be wondering why would I not just do this:
+
+```ruby
+Dir.glob('**/*.rb') { |f| require f }
+```
+
+In some instances you will get away with that, but what happens when file _x_ must be required before file _y_? This is what this library intends to resolve. It will load files in a loop, keeping track of what succeeds, and fails with an exception. This process continues until either all files have been required, or until a loop iteration fails to load any files at all.
+
+Usage
+-----
+Usage is relatively intuitive. Simply call either `require_pattern` or `require_relative_pattern` with one or more glob patterns, and all files matching those patterns will be required.
+
+```ruby
+require_pattern 'lib/**/*.rb', 'models/**/*.rb'
+```
+
+Any files that refuse to load will be reported to STDERR with backtrace information.

data/lib/require_pattern.rb

@@ -0,0 +1,37 @@
+require 'term-colorizer'
+
+module Kernel
+  
+  # Requires all files matching the glob patterns provided.
+  # If a file fails to load, it keeps retrying until all remaining files fail to load, in which case the exception is
+  # output to STDERR for each failed file.
+  def require_pattern(*patterns)
+    loaded = false # Indicates whether any files were loaded at all
+    require_map = patterns.map { |pattern| Dir.glob(pattern) }.flatten.reduce({}) { |m,v|  m[v] = nil; m }
+    loop do
+      remaining = require_map.reject! do |file,|
+        begin
+          loaded = true if require File.expand_path(file)
+          true
+        rescue => require_map[file]
+          false
+        end
+      end
+
+      if require_map.empty?
+        break loaded
+      elsif remaining.nil?
+        STDERR.puts "\nSome files failed:".red
+        require_map.each { |file, e| STDERR.puts "    #{file}: ".red + "#{e.backtrace[0]} #{e}".yellow}
+        STDERR.puts
+        raise LoadError, "One or more files failed to load. See STDERR output for details." 
+      end
+    end
+  end
+  
+  def require_relative_pattern(*patterns)
+    caller_path = caller_locations(1,1)[0].path
+    patterns.map! { |pattern| File.join(File.dirname(caller_path), pattern) }
+    require_pattern(*patterns)
+  end
+end

data/require_pattern.gemspec

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new 'require_pattern', '1.0' do |s|
+  s.summary           = 'Requires files based on a pattern in a robust and optimistic manner.'
+  s.authors           = ['Tom Wardrop']
+  s.email             = 'tom@tomwardrop.com'
+  s.homepage          = 'http://github.com/wardrop/RequirePattern'
+  s.license           = 'MIT'
+  s.files             = Dir.glob(`git ls-files`.split("\n") - %w[.gitignore])
+  s.test_files        = Dir.glob('spec/spec.rb')
+  s.rdoc_options      = %w[--line-numbers --inline-source --title Scorched --encoding=UTF-8]
+
+  s.required_ruby_version = '>= 1.9.3'
+  s.add_dependency 'term-colorizer'
+  s.add_development_dependency 'rspec'
+end

data/spec/dummy/bad.rb

@@ -0,0 +1,2 @@
+class Bad < EvenWorse
+end

data/spec/dummy/colors/green.rb

@@ -0,0 +1 @@
+$green = true

data/spec/dummy/colors/red.rb

@@ -0,0 +1 @@
+$red = true

data/spec/dummy/dependancies/car.rb

@@ -0,0 +1,2 @@
+class Car < Vehicle
+end

data/spec/dummy/dependancies/golf.rb

@@ -0,0 +1,2 @@
+class Golf < Volkswagen
+end

data/spec/dummy/dependancies/vehicle.rb

@@ -0,0 +1,2 @@
+class Vehicle
+end

data/spec/dummy/dependancies/volkswagen.rb

@@ -0,0 +1,2 @@
+class Volkswagen < Car
+end

data/spec/dummy/loaded.rb

@@ -0,0 +1 @@
+$loaded = true

data/spec/dummy/shapes/cirlcle.rb

@@ -0,0 +1 @@
+$circle = true

data/spec/dummy/shapes/square.rb

@@ -0,0 +1 @@
+$square = true

data/spec/dummy/sizes/short.rb

@@ -0,0 +1 @@
+$short = true

data/spec/dummy/sizes/tall.rb

@@ -0,0 +1 @@
+$tall = true

data/spec/spec.rb

@@ -0,0 +1,43 @@
+require_relative '../lib/require_pattern'
+Dir.chdir File.expand_path('../dummy', __FILE__)
+
+describe 'require_pattern' do
+  it "requires relative to the current working directory by default" do
+    require_pattern 'colors/*.rb'
+    $red.should be_true
+    $green.should be_true
+  end
+
+  it "can require relative to the current file" do
+    require_relative_pattern 'dummy/sizes/*.rb'
+    $tall.should be_true
+    $short.should be_true
+  end
+  
+  it "overcomes file ordering issues by intelligently retrying" do
+    require_relative_pattern 'dummy/dependancies/*.rb'
+    Golf
+  end
+  
+  it "reports true only if a file was loaded" do
+    require_pattern('loaded.rb').should be_true
+    require_pattern('loaded.rb').should be_false
+  end
+  
+  it "can take multiple patterns" do
+    require_pattern('colors/*.rb', 'shapes/*.rb').should be_true
+    $circle.should be_true
+    $square.should be_true
+  end
+  
+  it "outputs to STDERR on failure" do
+    STDERR.should_receive(:puts).at_least(2).times
+    expect {
+      require_pattern 'bad.*'
+    }.to raise_error(LoadError)
+  end
+  
+  it "doesn't care if it doesn't match any files" do
+    require_pattern('good luck matching this').should be_false
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: require_pattern
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Tom Wardrop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: term-colorizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: tom@tomwardrop.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/require_pattern.rb
+- require_pattern.gemspec
+- spec/dummy/bad.rb
+- spec/dummy/colors/green.rb
+- spec/dummy/colors/red.rb
+- spec/dummy/dependancies/car.rb
+- spec/dummy/dependancies/golf.rb
+- spec/dummy/dependancies/vehicle.rb
+- spec/dummy/dependancies/volkswagen.rb
+- spec/dummy/loaded.rb
+- spec/dummy/shapes/cirlcle.rb
+- spec/dummy/shapes/square.rb
+- spec/dummy/sizes/short.rb
+- spec/dummy/sizes/tall.rb
+- spec/spec.rb
+homepage: http://github.com/wardrop/RequirePattern
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Scorched
+- --encoding=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Requires files based on a pattern in a robust and optimistic manner.
+test_files:
+- spec/spec.rb