loader 2.2.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fb6d587cdce79bd118d9613737d6748df3bfcc4
-  data.tar.gz: 5e53ed93aab29a1e2eaf8ddebad0f4fd1fd88037
+  metadata.gz: 13b2d8b0d11367696e839694ae8efa0deae9d94c
+  data.tar.gz: 1e2918297cb642e5539e5a1fd94fe5b36012d2fc
 SHA512:
-  metadata.gz: 8d43285977aba52256e2e448d56e014b7649d4c8bf624cd54d4826971836d3f385ab876cb342b6300bd58ff8a692dcab31ba6205a78323c2e88fffa1e425fcdd
-  data.tar.gz: e7b0ca491da195e2733971f86111c453c0831135d16a5ac2108cd82f5350099d570d9171547ff6d2117f1df67c287c23206f25b7bfcb9118119baf9a70e14383
+  metadata.gz: 7bb3719bcb4642aa5f95a820a31b8deadd50eb729f02c4d91a43465b7b835367084a53e58c7eae0b151bce7a3c35194bf2532268361404092c20b14810ef11f7
+  data.tar.gz: 127a0d8f5a68212b46410d0661d05349ba807f20499c90344aa09ef779fc689f7e3f0f19505b35bfb6119c62080cbb8bf7e65338d8e7224996bbfcc69982a6fa

data/README.md

@@ -1,7 +1,7 @@
 loader
 ======
 
-Ruby module for Easy File lifting :)
+Ruby module for automatic file require based on convention :)
 
 ### Introduction
 

data/VERSION

@@ -1 +1 @@
-2.2.3
+3.0.0

data/lib/loader/autoload.rb

@@ -1,7 +1,2 @@
 require 'loader'
-module Loader::AutoLoad
-  require 'loader/autoload/module_patch'
-  require 'loader/autoload/loader_patch'
-  require 'loader/autoload/fetcher'
-  Loader.__send__(:extend,Loader::AutoLoad::LoaderPatch)
-end
+Loader.autoload!

data/lib/loader/core_ext/module.rb

@@ -0,0 +1,10 @@
+Module.class_eval do
+
+  alias const_missing_original const_missing
+
+  def const_missing(name)
+    constant = Loader::Fetcher.load(self, name)
+    constant || const_missing_original(name)
+  end
+
+end

data/lib/loader/core_ext/object.rb

@@ -0,0 +1,10 @@
+Object.class_eval do
+
+  def require_relative_directory(relative_directory_path)
+    Dir.glob(File.join(File.dirname(caller[0]), relative_directory_path, '*.{ru,rb}'))
+        .sort_by { |file_path| file_path.length }
+        .each { |file_path| Loader::Utils.require(file_path) }
+
+  end
+
+end

data/lib/loader/core_ext.rb

@@ -0,0 +1,4 @@
+module Loader::CoreExt
+  require 'loader/core_ext/object'
+  require 'loader/core_ext/module'
+end

data/lib/loader/fetcher.rb

@@ -0,0 +1,57 @@
+module Loader::Fetcher
+
+  extend self
+  extend ::Loader::Utils
+
+  def load_gem(caller_class, constant_name)
+    underscore_name = Loader::Utils.underscore(constant_name)
+    gem_symbolic_name = underscore_name.sub(File::Separator, '-')
+
+    begin
+      require(underscore_name)
+    rescue LoadError
+      require(gem_symbolic_name)
+    end
+
+    return fetch_constant(caller_class, constant_name)
+  rescue LoadError
+    nil
+  end
+
+  def load(caller_class, name)
+    folder_path = get_folder_path(caller_class)
+    file_name = Loader::Utils.underscore(name)
+
+    Loader.project_root_folders.each do |project_root|
+      Dir.glob(File.join(project_root, '**', [folder_path, "#{file_name}.{rb,ru}"].compact)).each do |ruby_file_path|
+        if Loader::Utils.require(ruby_file_path)
+          c = fetch_constant(caller_class, name)
+
+          return c unless c.nil?
+        end
+      end
+    end
+
+    return load_gem(caller_class, name)
+  end
+
+
+  protected
+
+  def get_folder_path(caller_class)
+    return if caller_class == ::Object
+    caller_class.to_s.split('::').map { |camel_case| Loader::Utils.underscore(camel_case) }.join(File::Separator)
+  end
+
+  def fetch_constant(caller_class, name)
+    class_name = ([caller_class, name] - [Object]).join('::')
+    rgx = /^#{Regexp.escape(class_name)}$/
+
+    ObjectSpace.each_object(Module) do |obj|
+      return obj if !!(obj.to_s =~ rgx)
+    end
+
+    return nil
+  end
+
+end

data/lib/loader/{helpers.rb → utils.rb}

@@ -1,8 +1,14 @@
 require 'loader'
-module Loader::Helpers
+module Loader::Utils
 
   extend self
 
+  def require(file_path)
+    Kernel.require(file_path)
+  rescue LoadError
+    Kernel.load(file_path)
+  end
+
   def pwd
     if !!ENV['BUNDLE_GEMFILE']
       ENV['BUNDLE_GEMFILE'].split(File::Separator)[0..-2].join(File::Separator)

data/lib/loader.rb

@@ -1,7 +1,20 @@
 #encoding: UTF-8
 module Loader
-  require 'loader/meta'
-  require 'loader/helpers'
-  require 'loader/require'
-  require 'loader/autoload'
+
+  require 'loader/utils'
+  require 'loader/fetcher'
+  require 'loader/core_ext'
+
+  extend self
+
+  def project_root_folders
+    @project_root_folders ||= []
+  end
+
+  def autoload!(project_root_folder=Loader::Utils.pwd)
+    project_root_folders.push(File.expand_path(project_root_folder))
+  end
+
+  alias autoload autoload!
+
 end

data/loader.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   spec.add_development_dependency('rspec')
   spec.add_development_dependency('rake')
 

data/spec/fixtures/autoload/lib/sample/cat/paw.rb

@@ -0,0 +1,2 @@
+module Sample::Cat::Paw
+end

data/spec/fixtures/autoload/lib/sample/cat.rb

@@ -0,0 +1,3 @@
+module Sample::Cat
+
+end

data/spec/fixtures/autoload/lib/sample/dog/tail.rb

@@ -0,0 +1,3 @@
+class Sample::Dog::Tail
+
+end

data/spec/fixtures/autoload/lib/sample/dog.rb

@@ -0,0 +1,3 @@
+class Sample::Dog
+
+end

data/spec/fixtures/autoload/sample.rb

@@ -0,0 +1,3 @@
+module Sample
+
+end

data/spec/fixtures/require_relative_directory/relative_folder/test_constant/stuff.ru

@@ -0,0 +1,2 @@
+module TestConstant::Stuff
+end

data/spec/fixtures/require_relative_directory/relative_folder/test_constant.rb

@@ -0,0 +1,2 @@
+module TestConstant
+end

data/spec/fixtures/require_relative_directory/relative_folder_recursive/test_constant2/stuff2.ru

@@ -0,0 +1,2 @@
+module TestConstant2::Stuff2
+end

data/spec/fixtures/require_relative_directory/relative_folder_recursive/test_constant2.rb

@@ -0,0 +1,2 @@
+module TestConstant2
+end

data/spec/loader/helpers_spec.rb

@@ -1,8 +1,8 @@
 require_relative '../spec_helper'
-describe Loader::Helpers do
+describe Loader::Utils do
 
   let(:project_folder) { 'Path/To/Project/Folder' }
-  subject { Loader::Helpers }
+  subject { Loader::Utils }
 
   describe '#pwd' do
 
@@ -46,6 +46,4 @@ describe Loader::Helpers do
 
   end
 
-
-
 end

data/spec/loader_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+describe Loader do
+
+  describe '.autoload!' do
+    let(:root_folder) { File.absolute_path(File.join(File.dirname(__FILE__), 'fixtures', 'autoload')) }
+    before { Loader.autoload!(root_folder) }
+
+    it 'should lazy load all the constants upon being used' do
+      expect { Sample }.to_not raise_error
+      expect { Sample::Dog }.to_not raise_error
+      expect { Sample::Dog::Tail }.to_not raise_error
+      expect { Sample::Cat::Paw }.to_not raise_error
+    end
+
+    it 'should require unrequired gems' do
+      expect { JSON }.to_not raise_error
+    end
+
+  end
+
+  describe '.require_relative_directory' do
+
+    it 'should require the given relative folder content' do
+      require_relative_directory 'fixtures/require_relative_directory/relative_folder'
+
+      expect { TestConstant::Stuff }.to raise_error(NameError, 'uninitialized constant TestConstant::Stuff')
+
+      expect { TestConstant }.to_not raise_error
+    end
+
+    it 'should require the given relative folder content recursively like this' do
+      require_relative_directory 'fixtures/require_relative_directory/relative_folder_recursive/**'
+
+      expect{ TestConstant2::Stuff2 }.to_not raise_error
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loader
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Adam Luzsi
@@ -65,25 +65,24 @@ files:
 - files.rb
 - lib/loader.rb
 - lib/loader/autoload.rb
-- lib/loader/autoload/fetcher.rb
-- lib/loader/autoload/loader_patch.rb
-- lib/loader/autoload/module_patch.rb
-- lib/loader/helpers.rb
-- lib/loader/meta.rb
-- lib/loader/require.rb
+- lib/loader/core_ext.rb
+- lib/loader/core_ext/module.rb
+- lib/loader/core_ext/object.rb
+- lib/loader/fetcher.rb
+- lib/loader/utils.rb
 - loader.gemspec
+- spec/fixtures/autoload/lib/sample/cat.rb
+- spec/fixtures/autoload/lib/sample/cat/paw.rb
+- spec/fixtures/autoload/lib/sample/dog.rb
+- spec/fixtures/autoload/lib/sample/dog/tail.rb
+- spec/fixtures/autoload/sample.rb
+- spec/fixtures/require_relative_directory/relative_folder/test_constant.rb
+- spec/fixtures/require_relative_directory/relative_folder/test_constant/stuff.ru
+- spec/fixtures/require_relative_directory/relative_folder_recursive/test_constant2.rb
+- spec/fixtures/require_relative_directory/relative_folder_recursive/test_constant2/stuff2.ru
 - spec/loader/helpers_spec.rb
+- spec/loader_spec.rb
 - spec/spec_helper.rb
-- test/app/controllers/samples_controller.rb
-- test/helper.rb
-- test/lib/cat.rb
-- test/lib/cat/sup.rb
-- test/lib/cat/tail.rb
-- test/lib/dog.rb
-- test/manual_test.rb
-- test/sub/test2.rb
-- test/test.rb
-- test/test_autoload.rb
 homepage: https://github.com/adamluzsi/loader.rb
 licenses: []
 metadata: {}
@@ -95,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -110,15 +109,15 @@ summary: easy to use File loader that allow directories/project both Lazy Load a
   Eager load for files and constants. The Eager load for relative directory made for
   gems by default
 test_files:
+- spec/fixtures/autoload/lib/sample/cat.rb
+- spec/fixtures/autoload/lib/sample/cat/paw.rb
+- spec/fixtures/autoload/lib/sample/dog.rb
+- spec/fixtures/autoload/lib/sample/dog/tail.rb
+- spec/fixtures/autoload/sample.rb
+- spec/fixtures/require_relative_directory/relative_folder/test_constant.rb
+- spec/fixtures/require_relative_directory/relative_folder/test_constant/stuff.ru
+- spec/fixtures/require_relative_directory/relative_folder_recursive/test_constant2.rb
+- spec/fixtures/require_relative_directory/relative_folder_recursive/test_constant2/stuff2.ru
 - spec/loader/helpers_spec.rb
+- spec/loader_spec.rb
 - spec/spec_helper.rb
-- test/app/controllers/samples_controller.rb
-- test/helper.rb
-- test/lib/cat.rb
-- test/lib/cat/sup.rb
-- test/lib/cat/tail.rb
-- test/lib/dog.rb
-- test/manual_test.rb
-- test/sub/test2.rb
-- test/test.rb
-- test/test_autoload.rb

data/lib/loader/autoload/fetcher.rb

@@ -1,55 +0,0 @@
-module Loader::AutoLoad::Fetcher
-
-  extend self
-  extend ::Loader::Helpers
-
-  def try_load_by(caller_class, name)
-    levels = generate_levels(caller_class, name)
-    [
-        nil,
-        'lib',
-        File.join('{application,app,api}', '*'),
-        File.join('**', '*')
-    ].each do |folder|
-      return if load_by_folder(levels, folder)
-    end
-  end
-
-  def load_by_folder(levels, folder=nil)
-
-    Loader.project_folders.each do |project_folder|
-
-      desc_ary(levels.map { |str| File.join(*[project_folder, folder, "#{underscore(str)}.rb"].compact) }).each do |path_constructor|
-        desc_ary(Dir.glob(path_constructor)).each do |path|
-          return true if File.exist?(path) && require(path)
-        end
-      end
-
-    end
-
-    return false
-
-  end
-
-  def desc_ary(array)
-    array.sort { |a, b| b.length <=> a.length }
-  end
-
-  def generate_levels(klass, name)
-    levels = klass.to_s.split('::').reduce([]) { |m, c|
-      m << [(last_obj = m.last), c].compact.join('::'); m
-    }.map { |str| [str, name].join('::') }
-    levels.unshift(name.to_s)
-    return levels
-  end
-
-  def try_fetch_constant(caller_class, name)
-    levels = generate_levels(caller_class, name).map { |str| Regexp.escape(str) }
-    ObjectSpace.each_object(Module) { |obj|
-      if !!(obj.to_s =~ /^(#{levels.join('|')})$/)
-        return obj
-      end
-    }; nil
-  end
-  
-end

data/lib/loader/autoload/loader_patch.rb

@@ -1,14 +0,0 @@
-module Loader::AutoLoad::LoaderPatch
-
-  def project_folders
-    @project_folders ||= []
-  end
-
-  def autoload!(project_folder=Loader::Helpers.pwd)
-    project_folders.push(project_folder)
-    ::Module.__send__(:prepend, Loader::AutoLoad::ModulePatch)
-  end
-
-  alias autoload autoload!
-
-end

data/lib/loader/autoload/module_patch.rb

@@ -1,10 +0,0 @@
-module Loader::AutoLoad::ModulePatch
-
-  def const_missing(name)
-    c = Loader::AutoLoad::Fetcher
-    c.try_load_by(self,name)
-    constant = c.try_fetch_constant(self, name)
-    constant ? constant : super
-  end
-
-end

data/lib/loader/meta.rb

@@ -1,79 +0,0 @@
-module Loader
-
-  class << self
-
-    def caller_file(skip=0)
-
-      raise unless skip.class <= Integer
-      skip += 1
-
-      return nil if caller[skip].nil?
-      caller_file = caller[skip].scan(/^(.*)(:\d+:\w+)/)[0][0]
-
-      if caller_file[0] != File::Separator
-        caller_file= File.expand_path caller_file
-      end
-
-      return caller_file
-
-    end
-
-    def caller_folder skip= 0
-
-      raise unless skip.class <= Integer
-      caller_file_path= caller_file(skip+1)
-      return nil if caller_file_path.nil?
-
-      if !File.directory?(caller_file_path)
-        caller_file_path= caller_file_path.split(File::Separator)
-        caller_file_path.pop
-        caller_file_path= caller_file_path.join(File::Separator)
-      end
-
-      return caller_file_path
-
-    end
-
-
-
-    # you can give optional file names that will be searched for
-    def caller_root(*args)
-
-      what_can_be_in_the_root= %w[
-              gemfile Gemfile GemFile
-              rakefile Rakefile RakeFile
-              config.ru README.md LICENSE LICENSE.txt .gitignore ] + args.map{|e|e.to_s}
-
-      folder_path= caller_folder(1).split(File::Separator)
-
-      loop do
-
-        Dir.glob(File.join(folder_path.join(File::Separator),"*")).map do |element|
-          if !File.directory?(element)
-            if what_can_be_in_the_root.include? element.split(File::Separator).last
-              return folder_path.join(File::Separator)
-            end
-          else
-            if %W[ .git .bundler ].include? element.split(File::Separator).last
-              return folder_path.join(File::Separator)
-            end
-          end
-        end
-
-        if folder_path.count == 0
-          return nil
-        else
-          folder_path.pop
-        end
-
-      end
-
-    end
-
-    alias :caller_root_folder :caller_root
-
-  end
-
-end
-
-# Object.__send__ :include, Loader::ObjectCallerEXT

data/lib/loader/require.rb

@@ -1,74 +0,0 @@
-require 'loader'
-module Loader::ObjectExtension
-
-  # require sender relative directory's files
-  # return the directory and the sub directories file names (rb/ru)
-  def require_relative_directory(*args)
-
-    folder= args.select { |e| (e.class <= ::String) }.join(File::Separator)
-    opts= {}
-    args.select { |e| (e.class <= ::Hash) }.each { |hash| hash.each { |sk, sv| opts[sk]=sv } }
-    args.select! { |e| (e.class <= ::Symbol) }
-
-    opts[:recursive] ||= opts.delete(:r) || opts.delete(:R) || !([:recursive, :r, :R,].select { |e| args.include?(e) }.empty?)
-    opts[:recursive] = !!opts[:recursive]
-
-    # inclusion and exclusion
-    [[:exclude, [:ex, :e, :EX, :E]], [:include, [:in, :i, :IN, :I]]].each do |name, aliases|
-
-      aliases.each do |one_alias|
-        opts[name] ||= opts.delete(one_alias)
-      end
-
-      opts[name] ||= []
-
-      # should be REGEXP collection
-      opts[name] = [*opts[name]].map { |e| !(e.class <= ::Regexp) ? Regexp.new(e.to_s) : e }
-
-    end
-
-
-    opts[:caller_folder] ||= opts.delete(:f) || opts.delete(:folder) || ::Loader.caller_folder
-
-    unless folder.to_s[0] == File::Separator
-      folder= [opts[:caller_folder], folder]
-    end
-
-    #> recursive option
-    begin
-      path_parts= [*folder]
-      if opts[:recursive]
-        path_parts.push("**")
-      end
-      path_parts.push("*.{rb,ru}")
-    end
-
-    return Dir.glob(File.join(*path_parts)).sort_by { |e| e.split(File::Separator).size }.map { |one_path|
-
-      next unless opts[:exclude].select { |regex| one_path =~ regex ? true : false }.empty?
-
-      if opts[:include].empty?
-        require(one_path); one_path
-      else
-        opts[:include].each do |regex|
-          if one_path =~ regex
-            require(one_path); one_path
-          end
-        end
-      end
-
-    }.compact
-
-  end
-
-  alias :require_directory :require_relative_directory
-
-  def require_relative_directory_r(*args)
-    require_relative_directory *args, r: true, f: Loader.caller_folder
-  end
-
-  alias :require_directory_r :require_relative_directory_r
-
-end
-
-Object.__send__ :include, Loader::ObjectExtension

data/test/app/controllers/samples_controller.rb

@@ -1,3 +0,0 @@
-class SamplesController
-
-end

data/test/helper.rb

@@ -1,3 +0,0 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'..','lib'))
-require 'minitest/autorun'
-require 'loader'

data/test/lib/cat/sup.rb

@@ -1 +0,0 @@
-puts 'hello world!'

data/test/lib/cat/tail.rb

@@ -1,5 +0,0 @@
-class Cat
-  class Tail
-
-  end
-end

data/test/lib/cat.rb

@@ -1,3 +0,0 @@
-class Cat
-
-end

data/test/lib/dog.rb

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

data/test/manual_test.rb

@@ -1,7 +0,0 @@
-$LOAD_PATH.unshift(File.join(__dir__,'..','lib'))
-require 'loader'
-
-Loader.autoload __dir__
-
-p Cat
-

data/test/sub/test2.rb

@@ -1,4 +0,0 @@
-
-
-puts test
-# test

data/test/test.rb

@@ -1,3 +0,0 @@
-class TEST
-
-end

data/test/test_autoload.rb

@@ -1,70 +0,0 @@
-require_relative 'helper'
-describe Loader::AutoLoad do
-
-  before do
-    Loader::Helpers.__send__(:define_singleton_method,:pwd){ __dir__ }
-  end
-
-  it 'should raise an constant missing error than' do
-
-    -> {
-      begin
-        TEST
-      rescue Exception => e
-        e
-      end
-    }.call.is_a?(Exception).must_be :==, true
-
-    Loader.autoload!
-
-    -> {
-      begin
-        TEST
-      rescue Exception => e
-        e
-      end
-    }.call.is_a?(Exception).must_be :==, false
-
-    -> {
-      begin
-        Cat::Tail
-      rescue Exception => e
-        e
-      end
-    }.call.is_a?(Exception).must_be :==, false
-
-    -> {
-      begin
-
-        class Cat
-          Dog
-        end
-
-      rescue Exception => e
-        e
-      end
-    }.call.is_a?(Exception).must_be :==, false
-
-    -> {
-      begin
-
-        SamplesController
-
-      rescue Exception => e
-        e
-      end
-    }.call.is_a?(Exception).must_be :==, false
-
-    -> {
-      begin
-        BOOOM
-      rescue Exception => e
-        e
-      end
-    }.call.is_a?(Exception).must_be :==, true
-
-  end
-
-  # require_relative_directory_r 'lib'
-
-end