awesome_loader 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 362e0c1826dd0bcde66b8e466799b0b37743f2f2
-  data.tar.gz: 0d981dffe720657efa76c056b37b4d4f09ad8ae3
+  metadata.gz: 251b662a3b3fa4fbb57b49ba2221129c156f8844
+  data.tar.gz: bfa7481ad5aaddabb1f936f37a0cf7fede8fcf8c
 SHA512:
-  metadata.gz: e7d754fce596bd375ed6dec3f11341b10e76e8f7320b5ba6ae3aed577cff50f6ef4614b17358054cd784c48974623af38672c0c288b80c07970d2274b59fe6cb
-  data.tar.gz: 905b71a2043b2334334f1472eab79d2d4bf0709892c7d691568410e815318ac76f805bbce5ad566ae2198b2176a3624a6d6c0b7d846ea276a7dfac77b15b78f1
+  metadata.gz: f5a3019008b0bd2ca68d58a3625603606bdeeb3ed1c9f352dbd05c80c0bcd2b8f3b4aaf165af9e1b61028c79f3fcfa52013303dd2e5918f30e494c75e6d8c712
+  data.tar.gz: 2e198a51f1ebced488274f322971a21e64375086bfd53600714d26e95bfb33abe668063b56c917dec3a25a046480d9431e1cbee06cf16edb68f280268c0865c1

data/README.md

@@ -1,33 +1,30 @@
 # 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.)
+So you've created your bespoke Ruby application without Rails. Then you thought, "Bollocks, I have to manually require all my application files, and in a certain order! And I have to explicitly define all my submodules - they don't magically appear based on the directory structure like they did in Rails. There has to be a better way!" Well now there is.
 
 ## Install
 
-Just add to your Gemfile.
+Add to your Gemfile.
 
     gem 'awesome_loader'
 
 ## Basic Usage
 
-`awesome_loader` assumes that your directories and files are all in "snake case" (my_dir/my_file.rb), and that your Ruby Modules and Classes are all in "camel case" (MyDir::MyFile). Additionally, it assumes that your directory structure matches your Module structure. In fact it will traverse your directory tree and make sure all those Modules are created for you.
-
 Let's say you have a fairly simple layout, somewhat inspired by Rails.
 
-* `app/models/user.rb` contains `User`
-* `app/models/widget.rb` contains `Widget`
-* `app/models/billing/line_item.rb` contains `Billing::LineItem`
-* `app/helpers/app_helpers.rb` contains `AppHelpers`
+* `app/models/widget.rb` contains `class Widget`
+* `app/models/billing/line_item.rb` contains `class Billing::LineItem`
+* `app/helpers/app_helpers.rb` contains `module AppHelpers`
 
-Given those files and their contents, this is all you have to tell `awesome_loader`. Note the `root_depth: 2` argument. That's saying, "Only start creating modules for dirs after the first 2 levels." That means `app` and `app/*` won't get any modules, but deeper directories, like `app/models/billing`, will.
+Given those files and their contents, this is all you have to tell `awesome_loader`. Awesome, right?
 
-    AwesomeLoader.autoload root_depth: 2 do
+    AwesomeLoader.autoload do
       paths %w(app ** *.rb)
     end
 
 ## Advanced Usage
 
-Maybe your app structure is more complicated. That's fine too.
+Maybe your app structure is more complicated. That's fine too. Note the `root_depth: 2` argument. That's saying, "Only start creating modules for dirs after the first 2 levels." That means `app` and `app/*` won't get any modules, but deeper directories, like `app/models/billing`, will. `2` is the default, as you can see in the above example.
 
     AwesomeLoader.autoload root_depth: 2 do
       # These first few work just like above
@@ -39,11 +36,13 @@ Maybe your app structure is more complicated. That's fine too.
       paths %w(app entities ** *.rb), root_depth: 1
     end
 
+For more details and options, [check out the documentation](http://www.rubydoc.info/gems/awesome_loader).
+
 ## Eager Loading
 
 If you're running a threaded server like Puma or Thin, it's usually considered best practice to load everything up-front (at least in production), instead of lettings things load while other threads might be running. The `eager_load` option will ensure that all files are loaded before the block exits.
 
-    AwesomeLoader.autoload root_depth: 2, eager_load: true do
+    AwesomeLoader.autoload eager_load: is_prod? do
       paths %w(app ** *.rb)
     end
 

data/lib/awesome_loader/autoloader.rb

@@ -14,13 +14,13 @@ module AwesomeLoader
   #     paths %w(app routes ** *.rb), root_depth: 1
   #   end
   #
-  # @param root_depth [String] Tells AwesomeLoader to start creating Modules for dirs *after* this level
+  # @param root_depth [Integer] Tells AwesomeLoader to start creating Modules for dirs *after* this level (default 2)
   # @param root_path [String] Path to root of the application (default Dir.pwd)
   # @param root_module [Module] Module to load your modules into (default Object). You'll probably always want to keep the default.
   # @param eager_load [Boolean] Make sure all files get loaded by the time the block finishes (default false)
   # @return [AwesomeLoader::Autoloader]
   #
-  def self.autoload(root_depth:, root_path: Dir.pwd, root_module: Object, eager_load: false, &block)
+  def self.autoload(root_depth: Autoloader::DEFAULT_ROOT_DEPTH, root_path: Dir.pwd, root_module: Object, eager_load: false, &block)
     autoloader = Autoloader.new(root_depth: root_depth, root_path: root_path, root_module: root_module, eager_load: eager_load)
     if block
       autoloader.instance_eval(&block)
@@ -30,7 +30,7 @@ module AwesomeLoader
   end
 
   #
-  # The autoloader. Normally it's used indirectly through AwesomeLoader.autoload, but you can use it directly if you like:
+  # The autoloader. Normally it's used indirectly through `AwesomeLoader.autoload`, but you can use it directly if you like:
   #
   #   AwesomeLoader::Autoloader.new(root_depth: 2).
   #     paths(%w(app models ** *.rb)).
@@ -39,6 +39,8 @@ module AwesomeLoader
   #     finalize!
   #
   class Autoloader
+    # The default root_dept for new instances
+    DEFAULT_ROOT_DEPTH = 2
     RB_EXT = /\.rb$/
 
     # @return [Integer] root depth used for all paths unless otherwise specified
@@ -56,12 +58,12 @@ module AwesomeLoader
     #
     # Initialize a new AwesomeLoader::Autoloader.
     #
-    # @param root_depth [String] Tells AwesomeLoader to start creating Modules for dirs *after* this level
+    # @param root_depth [Integer] Tells AwesomeLoader to start creating Modules for dirs *after* this level (default 2)
     # @param root_path [String] Path to root of the application (default Dir.pwd)
     # @param root_module [Module] Module to load your modules into (default Object). You'll probably always want to keep the default.
     # @param eager_load [Boolean] Make sure all files get loaded by the time the block finishes (default false)
     #
-    def initialize(root_depth:, root_path: Dir.pwd, root_module: Object, eager_load: false)
+    def initialize(root_depth: DEFAULT_ROOT_DEPTH, root_path: Dir.pwd, root_module: Object, eager_load: false)
       @root_path, @root_module = Pathname.new(root_path.to_s), root_module
       @default_root_depth, @eager_load = root_depth, eager_load
       @all_files = Set.new

data/lib/awesome_loader/module_builder.rb

@@ -20,7 +20,7 @@ module AwesomeLoader
     end
 
     #
-    # Returns (building if necessary) the Module represented by the dir path. The path should be relative
+    # Returns (recursively creating if necessary) the Module represented by the dir path. The path should be relative
     # to your application root/working directory.
     #
     #   # Since root_depth is 2, the first 2 dirs in any path will be ignored
@@ -36,7 +36,7 @@ module AwesomeLoader
     #   => Billing::Foo
     #
     # @param rel_filepath [String] The path, relative to your application root, to the file you want the module for.
-    # @return [Module] The module that should contain the constant in the file.
+    # @return [Module] The module
     #
     def module(rel_path)
       module_names(rel_path).reduce(root_module) { |parent_mod, mod_name|
@@ -63,6 +63,9 @@ module AwesomeLoader
     #   builder.nested_dirs('src/features/billing/foo')
     #   => ['Billing', 'Foo']
     #
+    # @param rel_filepath [String] The path, relative to your application root, to the file you want the module for.
+    # @return [Array<String>] Array of nested Module names
+    #
     def module_names(rel_path)
       dir_names = Utils.clean_path(rel_path).split '/'
       return [] if rel_path == '.' or root_depth > dir_names.size

data/lib/awesome_loader/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awesome_loader
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-09 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies: []
 description: An awesome wrapper for Ruby's built-in autoload
 email: jordan.hollinger@gmail.com