require_pattern_xt 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +14 -0
- data/.travis.yml +10 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +58 -0
- data/Rakefile +2 -0
- data/lib/require_pattern_xt/coloring.rb +11 -0
- data/lib/require_pattern_xt/core.rb +39 -0
- data/lib/require_pattern_xt/version.rb +3 -0
- data/lib/require_pattern_xt.rb +16 -0
- data/require_pattern_xt.gemspec +26 -0
- data/sh/test +1 -0
- data/test/dummy/bad.rb +2 -0
- data/test/dummy/colors/green.rb +1 -0
- data/test/dummy/colors/red.rb +1 -0
- data/test/dummy/dependancies/car.rb +2 -0
- data/test/dummy/dependancies/golf.rb +2 -0
- data/test/dummy/dependancies/vehicle.rb +2 -0
- data/test/dummy/dependancies/volkswagen.rb +2 -0
- data/test/dummy/loaded.rb +1 -0
- data/test/dummy/shapes/cirlcle.rb +1 -0
- data/test/dummy/shapes/square.rb +1 -0
- data/test/dummy/sizes/short.rb +1 -0
- data/test/dummy/sizes/tall.rb +1 -0
- data/test/require_pattern_xt_test.rb +42 -0
- data/test/test_helper.rb +7 -0
- metadata +141 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: fa3bef27d6565ba20067a0fb4a5830a109578a48
|
4
|
+
data.tar.gz: 40db6e20582302fe52992e59dee534dd1706b394
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 705210a46ff04a510f2ecf30c84c40be54cd857322f1e2f670ddcf3d393d857d058381b543d853f1ab9dd355bc77775f4519e02d01cf3d2db78e63f66b8e5079
|
7
|
+
data.tar.gz: 835dd073c69b74a2fc3857a41f4a3e5e7f5be85343b5009327d3bd191afd787a3f86a16ae7121300dacf660a045be4536948cabe1280e01173794576943297ff
|
data/.gitignore
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2015 Roman Heinrich
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,58 @@
|
|
1
|
+
# RequirePatternXt
|
2
|
+
[](http://travis-ci.org/mindreframer/require_pattern_xt)
|
3
|
+
|
4
|
+
__ a fork from https://github.com/Wardrop/RequirePattern with some impovements __
|
5
|
+
|
6
|
+
This library provides a simple extension to the Kernel module that allows files to be conveniantly `require`'d based on a glob pattern.
|
7
|
+
|
8
|
+
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`).
|
9
|
+
|
10
|
+
|
11
|
+
# Why?
|
12
|
+
|
13
|
+
At this point you may be wondering why would I not just do this:
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
Dir.glob('**/*.rb') { |f| require f }
|
17
|
+
```
|
18
|
+
|
19
|
+
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.
|
20
|
+
|
21
|
+
## Installation
|
22
|
+
|
23
|
+
Add this line to your application's Gemfile:
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
gem 'require_pattern_xt'
|
27
|
+
```
|
28
|
+
|
29
|
+
And then execute:
|
30
|
+
|
31
|
+
$ bundle
|
32
|
+
|
33
|
+
Or install it yourself as:
|
34
|
+
|
35
|
+
$ gem install require_pattern_xt
|
36
|
+
|
37
|
+
## Usage
|
38
|
+
|
39
|
+
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.
|
40
|
+
|
41
|
+
```ruby
|
42
|
+
require_pattern 'lib/**/*.rb', 'models/**/*.rb'
|
43
|
+
```
|
44
|
+
|
45
|
+
Any files that refuse to load will be reported to STDERR with backtrace information.
|
46
|
+
|
47
|
+
# Tests
|
48
|
+
|
49
|
+
$ sh/test
|
50
|
+
|
51
|
+
## Contributing
|
52
|
+
|
53
|
+
1. Fork it ( https://github.com/[my-github-username]/require_pattern_xt/fork )
|
54
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
55
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
56
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
57
|
+
5. Create a new Pull Request
|
58
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
module RequirePatternXt
|
2
|
+
module Core
|
3
|
+
# Requires all files matching the glob patterns provided.
|
4
|
+
# If a file fails to load, it keeps retrying until all remaining files fail to load, in which case the exception is
|
5
|
+
# output to STDERR for each failed file.
|
6
|
+
def self.require_pattern(*patterns)
|
7
|
+
loaded = false # Indicates whether any files were loaded at all
|
8
|
+
require_map = patterns.
|
9
|
+
map { |pattern| Dir.glob(pattern) }.
|
10
|
+
flatten.
|
11
|
+
reduce({}) { |m,v| m[v] = nil; m }
|
12
|
+
loop do
|
13
|
+
remaining = require_map.reject! do |file,_|
|
14
|
+
begin
|
15
|
+
loaded = true if require File.expand_path(file)
|
16
|
+
true
|
17
|
+
rescue => require_map[file]
|
18
|
+
false
|
19
|
+
end
|
20
|
+
end
|
21
|
+
|
22
|
+
if require_map.empty?
|
23
|
+
break loaded
|
24
|
+
elsif remaining.nil?
|
25
|
+
log_error(require_map)
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
def self.log_error(require_map)
|
30
|
+
STDERR.puts Coloring.red("\nSome files failed:")
|
31
|
+
require_map.each { |file, e| STDERR.puts
|
32
|
+
Coloring.red(" #{file}: ") +
|
33
|
+
Coloring.yellow("#{e.backtrace[0]} #{e}")
|
34
|
+
}
|
35
|
+
STDERR.puts
|
36
|
+
raise LoadError, "One or more files failed to load. See STDERR output for details."
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
require "require_pattern_xt/version"
|
2
|
+
require 'require_pattern_xt/coloring'
|
3
|
+
require 'require_pattern_xt/core'
|
4
|
+
|
5
|
+
module Kernel
|
6
|
+
def require_pattern(*patterns)
|
7
|
+
RequirePatternXt::Core.require_pattern(patterns)
|
8
|
+
end
|
9
|
+
|
10
|
+
# this has to be in kernel module, so we keep the caller_locations intact
|
11
|
+
def require_relative_pattern(*patterns)
|
12
|
+
caller_path = caller_locations(1,1)[0].path
|
13
|
+
patterns.map! { |pattern| File.join(File.dirname(caller_path), pattern) }
|
14
|
+
require_pattern(*patterns)
|
15
|
+
end
|
16
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'require_pattern_xt/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "require_pattern_xt"
|
8
|
+
spec.version = RequirePatternXt::VERSION
|
9
|
+
spec.authors = ["Roman Heinrich", "Tom Wardrop"]
|
10
|
+
spec.email = ["roman.heinrich@gmail.com"]
|
11
|
+
spec.summary = %q{Requires files based on a pattern in a robust and optimistic manner.}
|
12
|
+
spec.description = %q{Write a longer description. Optional.}
|
13
|
+
spec.homepage = "https://github.com/mindreframer/require_pattern_xt"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.required_ruby_version = '>= 1.9.3'
|
22
|
+
spec.add_development_dependency "bundler", "~> 1.7"
|
23
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
24
|
+
spec.add_development_dependency 'maxitest'
|
25
|
+
spec.add_development_dependency 'mocha'
|
26
|
+
end
|
data/sh/test
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
mtest test
|
data/test/dummy/bad.rb
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
$green = true
|
@@ -0,0 +1 @@
|
|
1
|
+
$red = true
|
@@ -0,0 +1 @@
|
|
1
|
+
$loaded = true
|
@@ -0,0 +1 @@
|
|
1
|
+
$circle = true
|
@@ -0,0 +1 @@
|
|
1
|
+
$square = true
|
@@ -0,0 +1 @@
|
|
1
|
+
$short = true
|
@@ -0,0 +1 @@
|
|
1
|
+
$tall = true
|
@@ -0,0 +1,42 @@
|
|
1
|
+
require './test/test_helper'
|
2
|
+
|
3
|
+
describe 'require_pattern' do
|
4
|
+
it "requires relative to the current working directory by default" do
|
5
|
+
require_pattern 'colors/*.rb'
|
6
|
+
$red.must_equal true
|
7
|
+
$green.must_equal true
|
8
|
+
end
|
9
|
+
|
10
|
+
it "can require relative to the current file" do
|
11
|
+
require_relative_pattern 'dummy/sizes/*.rb'
|
12
|
+
$tall.must_equal true
|
13
|
+
$short.must_equal true
|
14
|
+
end
|
15
|
+
|
16
|
+
it "overcomes file ordering issues by intelligently retrying" do
|
17
|
+
require_relative_pattern 'dummy/dependancies/*.rb'
|
18
|
+
Golf
|
19
|
+
end
|
20
|
+
|
21
|
+
it "reports true only if a file was loaded" do
|
22
|
+
require_pattern('loaded.rb').must_equal true
|
23
|
+
require_pattern('loaded.rb').wont_equal true
|
24
|
+
end
|
25
|
+
|
26
|
+
it "can take multiple patterns" do
|
27
|
+
require_pattern('colors/*.rb', 'shapes/*.rb').must_equal true
|
28
|
+
assert $circle
|
29
|
+
assert $square
|
30
|
+
end
|
31
|
+
|
32
|
+
it "outputs to STDERR on failure" do
|
33
|
+
STDERR.expects(:puts).at_least(2)
|
34
|
+
lambda {
|
35
|
+
require_pattern 'bad.*'
|
36
|
+
}.must_raise LoadError
|
37
|
+
end
|
38
|
+
|
39
|
+
it "doesn't care if it doesn't match any files" do
|
40
|
+
require_pattern('good luck matching this').must_equal false
|
41
|
+
end
|
42
|
+
end
|
data/test/test_helper.rb
ADDED
metadata
ADDED
@@ -0,0 +1,141 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: require_pattern_xt
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Roman Heinrich
|
8
|
+
- Tom Wardrop
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2015-01-08 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: bundler
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
requirements:
|
18
|
+
- - "~>"
|
19
|
+
- !ruby/object:Gem::Version
|
20
|
+
version: '1.7'
|
21
|
+
type: :development
|
22
|
+
prerelease: false
|
23
|
+
version_requirements: !ruby/object:Gem::Requirement
|
24
|
+
requirements:
|
25
|
+
- - "~>"
|
26
|
+
- !ruby/object:Gem::Version
|
27
|
+
version: '1.7'
|
28
|
+
- !ruby/object:Gem::Dependency
|
29
|
+
name: rake
|
30
|
+
requirement: !ruby/object:Gem::Requirement
|
31
|
+
requirements:
|
32
|
+
- - "~>"
|
33
|
+
- !ruby/object:Gem::Version
|
34
|
+
version: '10.0'
|
35
|
+
type: :development
|
36
|
+
prerelease: false
|
37
|
+
version_requirements: !ruby/object:Gem::Requirement
|
38
|
+
requirements:
|
39
|
+
- - "~>"
|
40
|
+
- !ruby/object:Gem::Version
|
41
|
+
version: '10.0'
|
42
|
+
- !ruby/object:Gem::Dependency
|
43
|
+
name: maxitest
|
44
|
+
requirement: !ruby/object:Gem::Requirement
|
45
|
+
requirements:
|
46
|
+
- - ">="
|
47
|
+
- !ruby/object:Gem::Version
|
48
|
+
version: '0'
|
49
|
+
type: :development
|
50
|
+
prerelease: false
|
51
|
+
version_requirements: !ruby/object:Gem::Requirement
|
52
|
+
requirements:
|
53
|
+
- - ">="
|
54
|
+
- !ruby/object:Gem::Version
|
55
|
+
version: '0'
|
56
|
+
- !ruby/object:Gem::Dependency
|
57
|
+
name: mocha
|
58
|
+
requirement: !ruby/object:Gem::Requirement
|
59
|
+
requirements:
|
60
|
+
- - ">="
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: '0'
|
63
|
+
type: :development
|
64
|
+
prerelease: false
|
65
|
+
version_requirements: !ruby/object:Gem::Requirement
|
66
|
+
requirements:
|
67
|
+
- - ">="
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '0'
|
70
|
+
description: Write a longer description. Optional.
|
71
|
+
email:
|
72
|
+
- roman.heinrich@gmail.com
|
73
|
+
executables: []
|
74
|
+
extensions: []
|
75
|
+
extra_rdoc_files: []
|
76
|
+
files:
|
77
|
+
- ".gitignore"
|
78
|
+
- ".travis.yml"
|
79
|
+
- Gemfile
|
80
|
+
- LICENSE.txt
|
81
|
+
- README.md
|
82
|
+
- Rakefile
|
83
|
+
- lib/require_pattern_xt.rb
|
84
|
+
- lib/require_pattern_xt/coloring.rb
|
85
|
+
- lib/require_pattern_xt/core.rb
|
86
|
+
- lib/require_pattern_xt/version.rb
|
87
|
+
- require_pattern_xt.gemspec
|
88
|
+
- sh/test
|
89
|
+
- test/dummy/bad.rb
|
90
|
+
- test/dummy/colors/green.rb
|
91
|
+
- test/dummy/colors/red.rb
|
92
|
+
- test/dummy/dependancies/car.rb
|
93
|
+
- test/dummy/dependancies/golf.rb
|
94
|
+
- test/dummy/dependancies/vehicle.rb
|
95
|
+
- test/dummy/dependancies/volkswagen.rb
|
96
|
+
- test/dummy/loaded.rb
|
97
|
+
- test/dummy/shapes/cirlcle.rb
|
98
|
+
- test/dummy/shapes/square.rb
|
99
|
+
- test/dummy/sizes/short.rb
|
100
|
+
- test/dummy/sizes/tall.rb
|
101
|
+
- test/require_pattern_xt_test.rb
|
102
|
+
- test/test_helper.rb
|
103
|
+
homepage: https://github.com/mindreframer/require_pattern_xt
|
104
|
+
licenses:
|
105
|
+
- MIT
|
106
|
+
metadata: {}
|
107
|
+
post_install_message:
|
108
|
+
rdoc_options: []
|
109
|
+
require_paths:
|
110
|
+
- lib
|
111
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
112
|
+
requirements:
|
113
|
+
- - ">="
|
114
|
+
- !ruby/object:Gem::Version
|
115
|
+
version: 1.9.3
|
116
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
117
|
+
requirements:
|
118
|
+
- - ">="
|
119
|
+
- !ruby/object:Gem::Version
|
120
|
+
version: '0'
|
121
|
+
requirements: []
|
122
|
+
rubyforge_project:
|
123
|
+
rubygems_version: 2.4.4
|
124
|
+
signing_key:
|
125
|
+
specification_version: 4
|
126
|
+
summary: Requires files based on a pattern in a robust and optimistic manner.
|
127
|
+
test_files:
|
128
|
+
- test/dummy/bad.rb
|
129
|
+
- test/dummy/colors/green.rb
|
130
|
+
- test/dummy/colors/red.rb
|
131
|
+
- test/dummy/dependancies/car.rb
|
132
|
+
- test/dummy/dependancies/golf.rb
|
133
|
+
- test/dummy/dependancies/vehicle.rb
|
134
|
+
- test/dummy/dependancies/volkswagen.rb
|
135
|
+
- test/dummy/loaded.rb
|
136
|
+
- test/dummy/shapes/cirlcle.rb
|
137
|
+
- test/dummy/shapes/square.rb
|
138
|
+
- test/dummy/sizes/short.rb
|
139
|
+
- test/dummy/sizes/tall.rb
|
140
|
+
- test/require_pattern_xt_test.rb
|
141
|
+
- test/test_helper.rb
|