lazy_require 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cf0fbe761105702360d3854efe5d6dcecf56b34
-  data.tar.gz: 36750dfd97102eeaa954e0fc4f722624db7f7470
+  metadata.gz: 126e4dbfcad94a1ce5e9b68b9da5fc3572214a25
+  data.tar.gz: 1b3ef93c27246fbf5d726a29b37f6c6ebd673c55
 SHA512:
-  metadata.gz: 2bb28136852cd2e42b7aec30d2dc29741cb2ddfe38500b747414ff360b4f762fdbadbdda1d3dfa2eb46dac8f7d001875793a871230f6ad18e40df1886c8310f9
-  data.tar.gz: bb1d276a83d739e5df4ed612938fa196f36adadeee50984a8776765d1f4d48ad4a1336efe0806460f64482a3f006e0ed8f5da588792d3446aeec8d566665a876
+  metadata.gz: b00987706a8588ed20b44128189a92cbddc1a67f130941d7820d1709258eb54f5096f60fd5fe31fc8e6798419aecab750a16db46cde9c1cfc333395d940f5bd8
+  data.tar.gz: 10c9c68c904f010eb2e7ef987e5248a694d4dfcd90d5599d99626a726ac053152e94c9b91ffd21b810e3cb6a5d645ebbfb6c17e020c4742cd03a7fd128ad4a67

data/README.md

@@ -1,8 +1,10 @@
 # LazyRequire
+[![Code Climate](https://codeclimate.com/github/thomas07vt/lazy_require/badges/gpa.svg)](https://codeclimate.com/github/thomas07vt/lazy_require)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lazy_require`. To experiment with that code, run `bin/console` for an interactive prompt.
+Isn't it annoying when you try to load one file that is dependent on another file that hasn't been loaded yet?
+**LazyRequire** lets you require all your project files without worrying about the load order.
 
-TODO: Delete this and the text above, and describe your gem
+It has a similar function to the Rails autoloader, but is much simpler.
 
 ## Installation
 
@@ -20,9 +22,104 @@ Or install it yourself as:
 
     $ gem install lazy_require
 
+
+
 ## Usage
+Given this folder structure:
+
+```terminal
+app_root
+  |- lib/
+    |- first.rb
+    |- second.rb
+  |- app.rb
+```
+
+If you have files like these inside lib:
+```ruby
+# first.rb
+# The First class depends on the Second class
+class First < Second
+end
+```
+
+```ruby
+# second.rb
+class Second
+  # Does something special
+end
+```
+
+You might want to load all files inside your lib directory from the app.rb root file.
+Doing something like this could easily fail if load order matters:
+```ruby
+# App.rb
+
+# This might cause issues
+Dir['./lib/**/*.rb'].each { |file| require file }
+
+class App
+  # Some stuff here
+end
+```
+
+In the above files, its required to load the "second.rb" file prior to the "first.rb" file.
+You could add a line like this, explicitly adding the require line:
+
+```ruby
+# first.rb
+
+require_relative './second.rb'
+# The First class depends on the Second class
+class First < Second
+end
+```
 
-TODO: Write usage instructions here
+But that can get cumbersome, especially when you start moving or renaming files in your project.
+
+With **LazyRequire**, you can ask it to load all the files in your project/folder, without having to think about the load order. If **LazyRequire** tries to load a file, which has an unloaded dependency, it will simply skip that file and try again later. So your app.rb file can look something like this:
+
+```ruby
+# App.rb
+
+LazyRequire.load_all('./lib/**/*.rb')
+
+class App
+  # Some stuff here
+end
+```
+
+**LazyRequire.load_all()** accepts any glob pattern and will try to require all files that it finds with that glob pattern. If it it successfully loads all files it will return true:
+
+```ruby
+2.3.0 :010 >   LazyRequire.load_all('./spec/support/load_all/**/*.rb')
+#=> true 
+```
+
+If it cannot load any of the files, it will raise an exception:
+
+```ruby
+2.3.0 :006 > LazyRequire.load_all('./spec/support/errors/**/*.rb')
+RuntimeError: Could not load files: 
+./spec/support/errors/top_two.rb
+./spec/support/errors/top.rb
+
+	from ../code/lazy_require/lib/lazy_require.rb:12:in `load'
+	from ../code/lazy_require/lib/lazy_require.rb:22:in `load_all'
+	from (irb):6
+```
+
+If you want to load a specific collection of files and avoid using the glob pattern, you can do that to using the #load() method.
+
+```ruby
+files = [
+  './spec/support/errors/top_two.rb',
+  './spec/support/errors/top.rb',
+]
+
+LazyRequire.load(files)
+#=> true
+```
 
 ## Development
 
@@ -32,7 +129,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lazy_require.
+Bug reports and pull requests are welcome on GitHub at https://github.com/thomas07vt/lazy_require.
 
 
 ## License

data/lib/lazy_require.rb

@@ -2,44 +2,49 @@ require "lazy_require/version"
 
 module LazyRequire
 
-  def self.load(files)
-    files = toArray(files)
-    failed_files = try_to_require(files)
-
-    if failed_files.length == files.length
-      raise "Could not load files: \n#{failed_files.join("\n")}\n"
-    elsif failed_files.length != 0
-      self.load(failed_files)
-    end
+  class << self
+    alias_method :kernal_require, :require
 
-    true
-  end
+    def require(files)
+      files = toArray(files)
+      failed_files = try_to_require(files)
 
-  def self.load_all(glob)
-    files = Dir[glob]
-    self.load(files)
-  end
+      if failed_files.length == files.length
+        kernal_require "#{files.first}"
+      elsif failed_files.length != 0
+        self.require(failed_files)
+      end
 
-  private
+      true
+    end
 
-  def self.toArray(files)
-    if files.is_a?(Array)
-      files
-    else
-      [files]
+    def require_all(glob)
+      files = Dir[glob]
+      self.require(files)
     end
-  end
 
-  def self.try_to_require(files)
-    failed = []
-    files.each do |file|
-      begin
-        require "#{file}"
-      rescue NameError => e
-        failed << file
+    private
+
+    def toArray(files)
+      if files.is_a?(Array)
+        files
+      else
+        [files]
       end
     end
-    failed
+
+    def try_to_require(files)
+      failed = []
+      files.each do |file|
+        begin
+          kernal_require "#{file}"
+        rescue NameError
+          failed << file
+        end
+      end
+      failed
+    end
+
   end
 
 

data/lib/lazy_require/version.rb

@@ -1,3 +1,5 @@
+
 module LazyRequire
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazy_require
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - John Thomas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-25 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler