awesome_loader 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3342aa4f09d39ec0e5c7c784e89efa7c13fcd648
-  data.tar.gz: 1f5407ab67608b7c30a9b95c83a76af3538d06bc
+  metadata.gz: ff578e319ae7955c039a49a12e1a7dd41f4af2db
+  data.tar.gz: 1044693107960f3dbfd2b1f78f3247316ae01502
 SHA512:
-  metadata.gz: c9e56691706e874b1f1485dfb5fec6d0f16b2019bee005db971c05f21fc7da7657ff574d758207a1d3b2280330aeef10af26d95512ad4832e98aa1ebcfe157cc
-  data.tar.gz: 7f8aa1136e030f5915cb43541b59a320fbba36b784e099b901eabe80cbe97a394442c0950323fcbb0c99d90cc0b1de1d92567c67ef223eab8691010dc9135ab9
+  metadata.gz: 116775922f484ed6eca46c5d5655f72bae1c5234e6b039c1e4f69734c195f0faffa1ccd4759538dc9c3a476fb41a4d607c8862dc0874c8cd529c255b7670b425
+  data.tar.gz: 71ed372da0aaeba0719423c971d9399027adf980ffb5472dc63611c8cf16797fb05e1af2557601e04b1e1398b0caff2a1262a2963dcca4f8d955f43118c88771

data/lib/awesome_loader/autoloader.rb

@@ -1,29 +1,77 @@
 require 'set'
+require 'pathname'
 
+#
+# A module that holds all the awesomeness.
+#
 module AwesomeLoader
+  #
+  # Set up an AwesomeLoader::Autoloader instance.
+  #
+  #   AwesomeLoader.autoload root_depth: 2 do
+  #     paths %w(app models ** *.rb)
+  #     paths %w(app helpers ** *.rb)
+  #     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 [String] Path to root of the application (default Dir.cwd)
+  # @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: 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
+      autoloader.finialize!
     end
     autoloader
   end
 
+  #
+  # 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)).
+  #     paths(%w(app helpers *.rb)).
+  #     paths(%w(app routes ** *.rb), root_depth: 1).
+  #     finialize!
+  #
   class Autoloader
     RB_EXT = /\.rb$/
 
+    # @return [Pathname] the application root
     attr_reader :root
+    # @return [Integer] root depth used for all paths unless otherwise specified
     attr_reader :default_root_depth
+    # @return [Boolean] whether or not to automatically load all files once they're defined
     attr_reader :eager_load
+    # @return [Array<String>] all defined files, ready to be eager_loaded
     attr_reader :all_files
+    private :all_files
 
+    #
+    # Initialize a new AwesomeLoader::Autoloader.
+    #
+    # @param root_depth [String] Tells AwesomeLoader to start creating Modules for dirs *after* this level
+    # @param root [String] Path to root of the application (default Dir.cwd)
+    # @param eager_load [Boolean] Make sure all files get loaded by the time the block finishes (default false)
+    #
     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
 
+    #
+    # Set a glob pattern of files to be autoloaded.
+    #
+    #   autoloader.paths %w(app models ** *.rb)
+    #
+    # @param array [Array<String>] A glob pattern as an array.
+    # @paths root_depth [Integer] Depth at which to start creating modules for dirs. Defaults to whatever the AwesomeLoader::Autoloader instance was initialized with.
+    # @return [AwesomeLoader::Autoloader] returns self, so you can chain calls
+    #
     def paths(array, root_depth: default_root_depth)
       files = Dir.glob File.join *array
       root_regex = Regexp.new "^([^/]+/){%d}" % root_depth
@@ -51,13 +99,16 @@ module AwesomeLoader
         const_name = Utils.camelize File.basename(path).sub(RB_EXT, '')
         mod = modules.fetch File.dirname path.sub(root_regex, '')
         mod.autoload const_name, full_path
-        self.all_files << full_path if eager_load
+        all_files << full_path if eager_load
       end
 
       self
     end
 
-    def finialize
+    #
+    # Perform any final operations or cleanup. If eager_load is true, this is where they're loaded.
+    #
+    def finialize!
       all_files.each { |f| require f } if eager_load
       all_files.clear
       self

data/lib/awesome_loader/utils.rb

@@ -1,7 +1,17 @@
 module AwesomeLoader
+  #
+  # Misc utilities.
+  #
   module Utils
+    # Regex to match "snake name" paths
     SNAKE = /_([a-z])/
 
+    #
+    # Converts a snake_case_name to a CamelCaseName.
+    #
+    # @param name [String] the snake_case version
+    # @return [String] the CamelCase version
+    #
     def self.camelize(name)
       name.capitalize.gsub(SNAKE) { |match| match[1].capitalize }
     end

data/lib/awesome_loader/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: awesome_loader
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Jordan Hollinger