awesome_loader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5dc03dba0d176271e0c6c434bebb77c37839d6b
+  data.tar.gz: 7a0d3cffefadf3428d07a00284de1ec1cc85939d
+SHA512:
+  metadata.gz: 2467eb61030682522223291cb5b6f1f43cbb446600a7831852375ed7cc0108798f99ca5cb1b46f442930d05d644c4f7cb72f30835fde00e541ea27bf7521a20c
+  data.tar.gz: 2dbeec359709d42235a86935ebb74982c95b7a602e37fb329934e837803bcb8ff52449e3eba1594b089d52052f2c25206d8cc4afcea2536de26d8bf952f72d2e

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Jordan Hollinger
+
+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,49 @@
+# awesome_loader
+
+An awesome way to load your (non-Rails) Ruby application! Tired of tons of manual requires? Me too! So I made this little gem to augment Ruby's built-in `autoload` functionality. Works pretty much the same as in Rails. (NOTE Don't confuse this with auto-**re**loading.)
+
+## Install
+
+Just add to your Gemfile.
+
+    gem 'awesome_loader'
+
+## Basic Usage
+
+Let's say your (non-Rails) app has a very Rails-like layout. `app/models`, `app/helpers`, etc. And those might have some subdirectories that correspond to module names. This is all you have to do:
+
+    # The root_depth argument is saying "Start creating modules for dirs after the first 2 levels"
+    AwesomeLoader.autoload root_depth: 2 do
+      paths %w(app ** *.rb)
+    end
+
+## Advanced Usage
+
+Maybe your app structure is more complicated. That's fine too.
+
+    AwesomeLoader.autoload root_depth: 2 do
+      # These first few work just like above
+      paths %w(app models ** *.rb)
+      paths %w(app helpers ** *.rb)
+
+      # But the files in these dirs have top-level Routes and Entities modules
+      paths %w(app routes ** *.rb), root_depth: 1
+      paths %w(app entities ** *.rb), root_depth: 1
+    end
+
+## Eager Loading
+
+If you're running a threaded server like Puma or Thin, it's often considered best practice to load everything
+up-front, instead of possibly loading something during a request Thread. At least in production.
+
+    AwesomeLoader.autoload root_depth: 2, eager_load: true do
+      ...
+    end
+
+## License
+
+MIT License. See LICENSE for details.
+
+## Copyright
+
+Copyright (c) 2017 Jordan Hollinger

data/lib/awesome_loader/autoloader.rb

@@ -0,0 +1,67 @@
+require 'set'
+
+module AwesomeLoader
+  def self.autoload(root_depth:, root: Dir.cwd, eager_load: false, &block)
+    autoloader = Autoloader.new(root: root, root_depth: root_depth, eager_load: eager_load)
+    if block
+      autoloader.instance_eval(&block)
+      autoloader.finialize
+    end
+    autoloader
+  end
+
+  class Autoloader
+    RB_EXT = /\.rb$/
+
+    attr_reader :root
+    attr_reader :default_root_depth
+    attr_reader :eager_load
+    attr_reader :all_files
+
+    def initialize(root_depth:, root: Dir.cwd, eager_load: false)
+      @root = Pathname.new(root.to_s)
+      @default_root_depth, @eager_load = root_depth, eager_load
+      @all_files = []
+    end
+
+    def paths(array, root_depth: default_root_depth)
+      files = Dir.glob File.join *array
+      root_regex = Regexp.new "^#{File.join *array[0, root_depth]}/?"
+
+      # Get an array of nested dirs (parent dir always comes before child dir)
+      nested_dirs = files.
+        map { |path| File.dirname(path).sub(root_regex, '') }.uniq.
+        reduce(Set.new) { |dirs, leaf_dir|
+          dirs + leaf_dir.split('/').reduce([]) { |a, dir|
+            a << File.join(*a, dir)
+          }
+        }
+
+      # Create modules for each dir. Set a Hash of dir path => Module.
+      modules = nested_dirs.reduce({'.' => Object}) { |a, dir|
+        parent_module = a.fetch File.dirname dir
+        new_module = parent_module.const_set Utils.camelize(File.basename dir), Module.new
+        a[dir] = new_module
+        a
+      }
+
+      # For each file, look up it's dir module and set autoload on the class/module in the file.
+      files.each do |full_path|
+        rel_dir = File.dirname full_path.sub(root_regex, '')
+        abs_path = self.root.join(full_path)
+        file_const_name = Utils.camelize File.basename(full_path).sub(RB_EXT, '')
+        mod = modules.fetch rel_dir
+        mod.autoload file_const_name, abs_path
+        self.all_files << abs_path if eager_load
+      end
+
+      self
+    end
+
+    def finialize
+      all_files.each { |f| require f } if eager_load
+      all_files.clear
+      self
+    end
+  end
+end

data/lib/awesome_loader/utils.rb

@@ -0,0 +1,9 @@
+module AwesomeLoader
+  module Utils
+    SNAKE = /_([a-z])/
+
+    def self.camelize(name)
+      name.capitalize.gsub(SNAKE) { |match| match[1].capitalize }
+    end
+  end
+end

data/lib/awesome_loader/version.rb

@@ -0,0 +1,4 @@
+module AwesomeLoader
+  # Library version
+  VERSION = '0.0.1'.freeze
+end

data/lib/awesome_loader.rb

@@ -0,0 +1,3 @@
+require 'awesome_loader/version'
+require 'awesome_loader/autoloader'
+require 'awesome_loader/utils'

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: awesome_loader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jordan Hollinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-07 00:00:00.000000000 Z
+dependencies: []
+description: An awesome wrapper for Ruby's built-in autoload
+email: jordan.hollinger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/awesome_loader.rb
+- lib/awesome_loader/autoloader.rb
+- lib/awesome_loader/utils.rb
+- lib/awesome_loader/version.rb
+homepage: https://github.com/jhollinger/awesome_loader
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: An awesome way to autoload your Ruby application
+test_files: []