require_all 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e06fe7ba5ebad8808e535a57c68d3493d254b0a4
-  data.tar.gz: af66530c89f609f806f875dec3f630e8a40b4ca9
+  metadata.gz: 94b3a76320c4d23cda85ab8502101938a784e381
+  data.tar.gz: 8272f8a59cf18e4e5ea0de477136ac57fe5fea96
 SHA512:
-  metadata.gz: 8a8ed5bda5ed3f5db20d536925de3164c96205dff8734a117702abc6869a567d3fcc86886094953b6d838c9b73f60ce25426179d2b15ec934fa819775ab518da
-  data.tar.gz: d0edb85d06904dbcf63d91d12020c21d9439c70990ba53c327b44c9be5727eaedabb900a1aee16e5927404a5a66346cb960230f12c175a86007ea3d444296dfc
+  metadata.gz: 789a8ce1369441410a9f1b9e6ce7181eb47c41e91f17d281dbfdc13252199aac75dd981cdb44e5e3dbbbdde65491d38392735069e2ec26452cd7932f1dce3de6
+  data.tar.gz: a68153b0df9104a8226e85190515c793c15ce07562b1e0b849451d38a914e30e0babe0330073cbdc1cf7977c9bccf641d63fdfed320edb1f63b2e8d3a907d577

data/.travis.yml

@@ -0,0 +1,13 @@
+rvm:
+ - 1.9.3
+ - 2.0.0
+ - jruby-19mode
+ - rbx-19mode
+ - ruby-head
+notifications:
+  recipients:
+    - jarmo.p@gmail.com
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+

data/CHANGES

@@ -1,3 +1,7 @@
+1.3.1:
+
+* README improvements.
+
 1.3.0:
 
 * Make everything work with Ruby 1.9 and 2.0. Awesome! Thanks to Aaron Klaassen.

data/README.md

@@ -0,0 +1,127 @@
+# require_all
+[![Gem Version](https://badge.fury.io/rb/require_all.png)](http://badge.fury.io/rb/require_all)
+[![Build Status](https://secure.travis-ci.org/jarmo/require_all.png)](http://travis-ci.org/jarmo/require_all)
+
+A wonderfully simple way to load your code.
+
+Tired of futzing around with `require` statements everywhere, littering your code
+with `require File.dirname(__FILE__)` crap?  What if you could just 
+point something at a big directory full of code and have everything just 
+automagically load regardless of the dependency structure?  
+
+Wouldn't that be nice?  Well, now you can!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'require_all'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install require_all
+
+## Usage
+
+```ruby
+require 'require_all'
+
+# load all ruby files in the directory "lib" and its subdirectories
+require_all 'lib'
+
+# or load all files by using glob
+require_all 'lib/**/*.rb'
+
+# or load files in an Array
+require_all Dir.glob("blah/**/*.rb").reject { |f| stupid_file? f }
+
+# or load manually specified files
+require_all 'lib/a.rb', 'lib/b.rb', 'lib/c.rb', 'lib/d.rb'
+```
+
+You can also load files relative to the current file by using `require_rel`:
+
+```ruby
+# Instead of
+require File.dirname(__FILE__) + '/foobar'
+
+# you can do simply like this
+require_rel 'foobar'
+```
+
+You can give all the same argument types to the `require_rel` as for `require_all`.
+
+It is recommended to use `require_rel` instead of `require_all` since it will require files relatively
+to the current file (`__FILE__`) as opposed to loading files relative from the working directory.
+
+`load_all` and `load_rel` methods also exist to use `Kernel#load` instead of `Kernel#require`!
+
+The proper order to in which to load files is determined automatically for you.
+ 
+It's just that easy!  Code loading shouldn't be hard.
+
+## autoload_all
+
+This library also includes methods for performing `autoload` - what a bargain!
+
+Similar syntax is used as for `require_(all|rel)` and `load_(all|rel)` methods with some caveats:
+
+* Directory and file names have to reflect namespaces and/or constant names:
+
+```ruby
+# lib/dir1/dir2/my_file.rb
+module Dir1
+  module Dir2
+    class MyFile
+    end
+  end
+end
+
+# lib/loader.rb
+autoload_all File.dirname(__FILE__) + "/dir1"
+```
+
+* A `base_dir` option has to be specified if loading directories or files from some other location
+  than top-level directory:
+
+```ruby
+# lib/dir1/other_file.rb
+autoload_all File.dirname(__FILE__) + "/dir2/my_file.rb",
+             :base_dir => File.dirname(__FILE__) + "/../dir1"
+```
+  
+* All namespaces will be created dynamically by `autoload_all` - this means that `defined?(Dir1)` will
+  return `"constant"` even if `my_file.rb` is not yet loaded!
+
+Of course there's also an `autoload_rel` method:
+```ruby
+autoload_rel "dir2/my_file.rb", :base_dir => File.dirname(__FILE__) + "/../dir1"
+```
+
+If having some problems with `autoload_all` or `autoload_rel` then set `$DEBUG=true` to see how files
+are mapped to their respective modules and classes.
+
+## Methodology (except for autoload_{all|rel})
+
+* Enumerate the files to be loaded
+* Try to load all of the files.  If we encounter a `NameError` loading a 
+  particular file, store that file in a "try to load it later" list.
+* If all the files loaded, great, we're done! If not, go through the
+  "try to load it later" list again rescuing `NameError` the same way.
+* If we walk the whole "try to load it later" list and it doesn't shrink
+  at all, we've encountered an unresolvable dependency.  In this case,
+  `require_all` will rethrow the first `NameError` it encountered.
+
+## Questions? Comments? Concerns?
+
+You can reach the author on github or by email [jarmo.p@gmail.com](mailto:jarmo.p@gmail.com)
+
+## License
+
+Jarmo Pertman
+
+MIT (see the LICENSE file for details)

data/require_all.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "require_all"
-  s.version = "1.3.0"
+  s.version = "1.3.1"
   s.authors = ["Jarmo Pertman", "Tony Arcieri"]
   s.email = "jarmo.p@gmail.com"
   s.summary = "A wonderfully simple way to load your code"
@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/jarmo/require_all"
 
   s.has_rdoc = true
-  s.rdoc_options = %w(--title require_all --main README.textile --line-numbers)
-  s.extra_rdoc_files = ["LICENSE", "README.textile", "CHANGES"]
+  s.rdoc_options = %w(--title require_all --main README.md --line-numbers)
+  s.extra_rdoc_files = ["LICENSE", "README.md", "CHANGES"]
 
   s.add_development_dependency "rake",  "~>0.9"
   s.add_development_dependency "rspec", "~>2.14"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: require_all
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Jarmo Pertman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2013-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,14 +59,15 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.textile
+- README.md
 - CHANGES
 files:
 - .gitignore
+- .travis.yml
 - CHANGES
 - Gemfile
 - LICENSE
-- README.textile
+- README.md
 - Rakefile
 - lib/require_all.rb
 - require_all.gemspec
@@ -103,7 +104,7 @@ rdoc_options:
 - --title
 - require_all
 - --main
-- README.textile
+- README.md
 - --line-numbers
 require_paths:
 - lib

data/README.textile

@@ -1,140 +0,0 @@
-h1. require_all
-
-A wonderfully simple way to load your code.
-
-Tired of futzing around with require statements everywhere, littering your code
-with <code>require File.dirname(__FILE__)</code> crap?  What if you could just 
-point something at a big directory full of code and have everything just 
-automagically load regardless of the dependency structure?  
-
-Wouldn't that be nice?  Well, now you can!
-
- <code>require 'require_all'</code>
-
-You can use require_all in a multitude of different ways.
-
-The easiest way to use require_all is to just point it at a directory
-containing a bunch of .rb files:
-
- <code>require_all 'lib'</code>
-
-This will find all the .rb files under the lib directory (including all 
-subdirectories as well) and load them.
-
-The proper order to in which to load them is determined automatically.  If the 
-dependencies between the matched files are unresolvable, it will throw the 
-first unresolvable NameError.
-
-You can also give it a glob, which will enumerate all the matching files: 
-
- <code>require_all 'lib/**/*.rb'</code>
-
-It will also accept an array of files:
-
- <code>require_all Dir.glob("blah/**/*.rb").reject { |f| stupid_file? f }</code>
- 
-Or if you want, just list the files directly as arguments:
-
- <code>require_all 'lib/a.rb', 'lib/b.rb', 'lib/c.rb', 'lib/d.rb'</code>
-
-Still have the require <code>File.dirname(__FILE__)</code> blues?  The require_all gem also
-provides a require_rel statement which requires files to relative to the 
-current file.  So you can replace statements like:
-
- <code>require File.dirname(__FILE__) + '/foobar'</code>
-
-with just a simple require_rel:
-
- <code>require_rel 'foobar'</code>
- 
-Even better, require_rel still has the full power of require_all, so you can
-use require_rel to load entire directories of code too.  If "foobar" is a
-directory this will load all the .rb files found under that directory with
-automagic dependency handling.
-
-The difference between <code>require_all</code> and <code>require_rel</code> is that the former loads from the
-working directory and latter from the directory relative to the <code>__FILE__</code>.
-So, if your working directory is let's say /home, and there is /lib/a/b.rb and /lib/c.rb, then
-
-<code>require_all "lib/"</code> loads every ruby file from the lib directory in the working directory (pwd)
-
-and in /lib/c.rb <code>require_rel "a/"</code> loads every ruby file from the a/ directory not paying any attention
-to the working directory itself.
-
-It's recommended to use require_rel since it is not affected by the working directory.
-
-Also load_all and load_rel methods exist to use Kernel#load instead of Kernel#require!
- 
-It's just that easy!  Code loading shouldn't be hard.
-
-h2. autoload_all
-
-There's also a methods for performing autoloading - what a bargain!
-Similar syntax is used as for require and load methods although some things have to be
-kept in mind:
-
-* Directory and file names have to reflect namespaces and/or constant names - e.g.
-  a file called my_file.rb in directories dir1/dir2 has to be defined like this:
- <pre>
- <code>
-  module Dir1
-    module Dir2
-      class MyFile
-      end
-    end
-  end
- </code>
- </pre>
-
- in a loader.rb, which is in a parent directory for dir1:
-  <code>autoload_all File.dirname(__FILE__) + "/dir1"</code>
-
-* A :base_dir option has to be specified if loading directories or files from some other location
-  than top-level directory.
-
-  in dir1/other_file.rb:
- <pre>
- <code>
-  autoload_all File.dirname(__FILE__) + "/dir2/my_file.rb",
-               :base_dir => File.dirname(__FILE__) + "/../dir1" # top-level namespace starts from dir1
- </code>
- </pre>
-
-* All namespaces will be created dynamically by autoload_all - this means that defined?(Dir1) will
-  return "constant" even if my_file.rb is not loaded!
-
-Of course there's also an autoload_rel method:
- <code>autoload_rel "dir2/my_file.rb", :base_dir => File.dirname(__FILE__) + "/../dir1"</code>
-
-If having some problems with autoload_all or autoload_rel then set $DEBUG to true to see how files
-are mapped to their respective modules and classes.
-
-h2. Methodology (except for autoload_{all|rel})
-
-I didn't invent the approach this gem uses.  It was shamelessly stolen from
-Merb (which apparently stole it from elsewhere).  Here's how it works:  
-
-# Enumerate the files to be loaded
-# Try to load all of the files.  If we encounter a NameError loading a 
-  particular file, store that file in a "try to load it later" list.
-# If all the files loaded, great, we're done!  If not, go through the
-  "try to load it later" list again rescuing NameErrors the same way.
-# If we walk the whole "try to load it later" list and it doesn't shrink
-  at all, we've encountered an unresolvable dependency.  In this case,
-  require_all will rethrow the first NameError it encountered.
-
-h2. Questions? Comments? Concerns?
-
-You can reach the author on github or freenode: "jarm0"
-
-Or by email: "jarmo.p@gmail.com":mailto:jarmo.p@gmail.com
-
-Got issues with require_all to report? Post 'em here:
-
-"Github Tracker":http://github.com/jarmo/require_all/issues
-
-h2. License
-
-require_all was done originally by Tony Arcieri who asked me to maintain the gem.
-
-MIT (see the LICENSE file for details)