sweetloader 0.1.2 → 0.1.4

data/README.mdown

@@ -1,6 +1,6 @@
 # Sweetloader
 
-A 'sweet' autoloader that can autoload your modules and classes more easily, by taking advantage of a standard directory structure approach for the placement of your classes and modules. You can also configure Sweetloader to override the defaults in various ways... 
+A 'sweet' autoloader designed to autoload your modules and classes more easily, by taking advantage of a standard directory structure approach for the placement of your classes and modules. You can also configure Sweetloader to override the defaults in various ways... and even have it use `require` instead of `autoload` :)
 
 ## Install
 
@@ -26,32 +26,52 @@ end
 
 Each of these modules are then expected to be in @catango/configuration.rb@ and similar relative to a load path.
 
-## Configuration
+## AutoLoader Configuration
 
 The following global config vars are available in AutoLoader:
 * root
 * namespaces
+* mode
+
+### Root
 
 Set a specific root which the dir will be calculated relative to, using root.
-Override namespace to directory auto-mapping using the namespaces hash.
 
 ```ruby
-AutoLoader.root = ''
+AutoLoader.root = 'fixtures'
+```
+
+Now the constant `::CanTango` will be resolved as `'fixtures/can_tango'`
+
+### Namespaces
+
+Normally the constant CanTango will be translated to the dir `'can_tango'`, here we override this so it will instead be translated to `'cantango'`.
+
+```ruby
 AutoLoader.namespaces= {:CanTango => 'cantango', :Permithelper => 'permit_helper'}
 ```
 
-Normally the namespace/constant CanTango will be translated to the dir 'can_tango', here we override this so it will instead be translated to 'cantango'.
+### Modes
+
+AutoLoader supports the following modes: `:autoload, :require`
+
+The mode `:require` is used to execute require statements directly. The `:autoload` mode is used to do autoloading.
+Note that autoloading is not stable in multi-threaded environments and will likely be deprecated in later version of Ruby.
+However autoloading does perform lazy loading and can be advantageous when you want to speed up initial load time and don't run in a multi-threaded environment.
 
-You can also specify these options directly as an option hash on the `#autoload_modules` call 
+## autoload_modules Configuration
+
+You can also specify the AutoLoader options directly as an option hash on the `#autoload_modules` call:
 
 ```ruby
-  autoload_modules :Configuration, :Factory, :Permit, :root => 'helpers'
-  autoload_modules :Configuration, :Factory, :Permit, :ns => {:CanTango => 'cantango'}
+  autoload_modules :Configuration, :mode => :require
+  autoload_modules :Configuration, :Factory, :root => 'helpers'
+  autoload_modules :Configuration, :Factory, :Permit, :ns => {:CanTango => 'cantango'} # or use :namespaces
 ```
 
 ## Mutate path option
 
-Can be used to execute more general substitution logic on the generated file path
+This option is only available for `autoload_modules`.  It can be used to execute more general substitution logic on the generated file path:
 
 ```ruby
   autoload_modules :Configuration, :Factory, :Permit, :mutate_path => Proc.new {|path| path.sub(/(ies)/, 'y') }
@@ -59,6 +79,8 @@ Can be used to execute more general substitution logic on the generated file pat
 
 ## Scopes
 
+A Scope allows options to be specified that are effective on all `autoload_modules` statements within the scope.
+
 ```ruby
 module AutoloadModules
   module Configuration

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.4

data/lib/sweetloader.rb

@@ -2,6 +2,8 @@ require 'active_support/core_ext/string/inflections'
 
 
 module SweetLoader
+  class InvalidAutoloadMode < StandardError; end
+  
   def include_and_extend(the_module, options={})
     options[:instance_methods] ||= :InstanceMethods
     options[:class_methods] ||= :ClassMethods
@@ -25,15 +27,33 @@ module SweetLoader
     the_module = send(:the_module) if respond_to? :the_module
     the_module ||= self
     
+    mode = alm_options[:mode] if AutoLoader.valid_mode? alm_options[:mode]
+    mode ||= AutoLoader.mode
+    
+    logic = alm_options[:proc] if alm_options[:proc].respond_to? :call
+    logic ||= mode_logic mode
+    
     # Here also could be adding of the file in top of load_paths like: $:.unshift File.dirname(__FILE__)
     # It is very useful for situations of having not load_paths built Rails or Gems way.
-    args.each do |req_name|
-      ruby_file = req_name.to_s.underscore
+    args.each do |module_name|
+      ruby_file = module_name.to_s.underscore
+      module_name = module_name.to_s.camelize.to_sym
       require_file = AutoLoader.translate("#{from}/#{ruby_file}", alm_options)
-      the_module.send :autoload, req_name, require_file
+      logic.call(the_module, module_name, require_file)
     end
   end
   alias_method :autoload_module, :autoload_modules
+
+  def mode_logic mode
+    case mode
+    when :autoload
+      Proc.new { |the_module, module_name, require_file| the_module.send :autoload, module_name, require_file }
+    when :require
+      Proc.new {|the_module, module_name, require_file| require require_file }
+    else
+      raise InvalidAutoloadMode, "Not a valid Autloader mode: #{AutoLoader.mode}, must be one of: #{AutoLoader.valid_mode}"
+    end
+  end
   
   def autoload_scope options = {}, &block
     if block_given?
@@ -41,132 +61,12 @@ module SweetLoader
     end    
   end  
 end  
-  
-module SweetLoader
-  class Scope
-    include SweetLoader
-
-    attr_reader :autoload_options, :the_module
-  
-    def initialize the_module, options = {}
-      @the_module = the_module
-      @autoload_options = options
-    end
-    
-    def name
-      the_module.name
-    end
-  end
-end
 
 class Module
   include SweetLoader
 end
 
-module AutoLoader
-  @@root = ''
-  @@namespaces = {}
-
-  def self.root
-    @@root
-  end
-
-  def self.namespaces
-    @@namespaces
-  end
-
-  def self.root= root
-    @@root = root
-  end
-
-  def self.namespaces= namespaces
-    @@namespaces = namespaces
-  end
-
-  def self.translate name, options = {}    
-    names = name.split('/')
-    ns = namespaces.merge(options[:namespaces] || options[:ns] || {})
-    names.map do |name|
-      clazz_name = name.to_s.camelize
-      folder = ns[clazz_name.to_sym] ? ns[clazz_name.to_sym] : name
-      folder.sub /\/$/, ''
-    end.join('/')
-  end
-end
-
-module ClassExt
-  class ModuleNotFoundError < StandardError; end
-  class ClassNotFoundError < StandardError; end
-
-  def get_module name
-    # Module.const_get(name)
-    name.to_s.camelize.constantize
-  rescue
-    nil
-  end
+require 'sweetloader/scope'
+require 'sweetloader/auto_loader'
+require 'sweetloader/class_ext'
 
-  def is_class?(clazz)
-    clazz.is_a?(Class) && (clazz.respond_to? :new)
-  end
-
-  def is_module?(clazz)
-    clazz.is_a?(Module) && !(clazz.respond_to? :new)
-  end
-
-  def class_exists?(name)
-    is_class? get_module(name)
-  rescue
-    return false
-  end
-
-  def module_exists?(name)
-    is_module? get_module(name)
-  rescue NameError
-    return false
-  end
-
-  def try_class name
-    return name if name.kind_of?(Class)
-    found = get_module(name) if name.is_a?(String) || name.is_a?(Symbol)
-    return found if found.is_a?(Class)
-  rescue
-    false
-  end
-
-  def try_module name
-    return name if name.kind_of?(Module)
-    found = get_module(name.to_s) if name.is_a?(String) || name.is_a?(Symbol)
-    return found if found.is_a?(Module)
-  rescue
-    false
-  end
-
-  def try_module_only name
-    return name if is_module?(name)
-    found = get_module(name) if name.is_a?(String) || name.is_a?(Symbol)
-    return found if is_module?(found)
-  rescue
-    false
-  end
-
-
-  def find_first_class *names
-    classes = names.flatten.compact.uniq.inject([]) do |res, class_name|
-      found_class = try_class(class_name.to_s.camelize)
-      res << found_class if found_class
-      res
-    end
-    raise ClassNotFoundError, "Not one Class for any of: #{names} is currently loaded" if classes.empty?
-    classes.first
-  end
-
-  def find_first_module *names
-    modules = names.flatten.compact.uniq.inject([]) do |res, class_name|
-      found_class = try_module(class_name.to_s.camelize)
-      res << found_class if found_class
-      res
-    end
-    raise ModuleNotFoundError, "Not one Module for any of: #{names} is currently loaded" if modules.empty?
-    modules.first
-  end
-end

data/lib/sweetloader/auto_loader.rb

@@ -0,0 +1,54 @@
+module AutoLoader
+  module ClassMethods
+    attr_writer :default_mode
+
+    def root
+      @root ||= ''
+    end
+
+    def root= root
+      raise ArgumentError, "Must be a String, was: #{root}" if !root.kind_of?(String)
+      @root = root
+    end
+
+    def namespaces
+      @namespaces ||= {}
+    end
+
+    def namespaces= namespaces
+      raise ArgumentError, "Must be a Hash, was: #{namespaces}" if !namespaces.kind_of?(Hash)
+      @namespaces = namespaces
+    end
+
+    def mode
+      @mode || default_mode
+    end
+
+    def mode= mode 
+      @mode = mode if valid_mode? mode
+    end
+
+    def valid_mode? mode
+      valid_modes.include? mode
+    end
+
+    def valid_modes
+      [:autoload, :require]
+    end
+    
+    def default_mode
+      valid_modes.first
+    end
+  end
+  extend ClassMethods
+  
+  def self.translate name, options = {}    
+    names = name.split('/')
+    ns = namespaces.merge(options[:namespaces] || options[:ns] || {})
+    names.map do |name|
+      clazz_name = name.to_s.camelize
+      folder = ns[clazz_name.to_sym] ? ns[clazz_name.to_sym] : name
+      folder.sub /\/$/, ''
+    end.join('/')
+  end
+end

data/lib/sweetloader/class_ext.rb

@@ -0,0 +1,76 @@
+module ClassExt
+  class ModuleNotFoundError < StandardError; end
+  class ClassNotFoundError < StandardError; end
+
+  def get_module name
+    # Module.const_get(name)
+    name.to_s.camelize.constantize
+  rescue
+    nil
+  end
+
+  def is_class?(clazz)
+    clazz.is_a?(Class) && (clazz.respond_to? :new)
+  end
+
+  def is_module?(clazz)
+    clazz.is_a?(Module) && !(clazz.respond_to? :new)
+  end
+
+  def class_exists?(name)
+    is_class? get_module(name)
+  rescue
+    return false
+  end
+
+  def module_exists?(name)
+    is_module? get_module(name)
+  rescue NameError
+    return false
+  end
+
+  def try_class name
+    return name if name.kind_of?(Class)
+    found = get_module(name) if name.is_a?(String) || name.is_a?(Symbol)
+    return found if found.is_a?(Class)
+  rescue
+    false
+  end
+
+  def try_module name
+    return name if name.kind_of?(Module)
+    found = get_module(name.to_s) if name.is_a?(String) || name.is_a?(Symbol)
+    return found if found.is_a?(Module)
+  rescue
+    false
+  end
+
+  def try_module_only name
+    return name if is_module?(name)
+    found = get_module(name) if name.is_a?(String) || name.is_a?(Symbol)
+    return found if is_module?(found)
+  rescue
+    false
+  end
+
+
+  def find_first_class *names
+    classes = names.flatten.compact.uniq.inject([]) do |res, class_name|
+      found_class = try_class(class_name.to_s.camelize)
+      res << found_class if found_class
+      res
+    end
+    raise ClassNotFoundError, "Not one Class for any of: #{names} is currently loaded" if classes.empty?
+    classes.first
+  end
+
+  def find_first_module *names
+    modules = names.flatten.compact.uniq.inject([]) do |res, class_name|
+      found_class = try_module(class_name.to_s.camelize)
+      res << found_class if found_class
+      res
+    end
+    raise ModuleNotFoundError, "Not one Module for any of: #{names} is currently loaded" if modules.empty?
+    modules.first
+  end
+end

data/lib/sweetloader/scope.rb

@@ -0,0 +1,16 @@
+module SweetLoader
+  class Scope
+    include SweetLoader
+
+    attr_reader :autoload_options, :the_module
+  
+    def initialize the_module, options = {}
+      @the_module = the_module
+      @autoload_options = options
+    end
+    
+    def name
+      the_module.name
+    end
+  end
+end

data/spec/autoload_modules/procedure.rb

@@ -0,0 +1,4 @@
+module AutoloadModules
+  module Procedure
+  end
+end

data/spec/fixtures/autoload_mutate_path.rb

@@ -7,6 +7,10 @@ module AutoloadModules
     autoload_modules :Abc
     autoload_modules :Xyz
   end
+  
+  autoload_scope :proc => Proc.new {|the_module, module_name, require_file| require require_file } do 
+    autoload_modules :Procedure
+  end
 end
 
 module AutoloadModules

data/spec/sweetloader/sweetloader_options_spec.rb

@@ -22,5 +22,11 @@ describe 'Sweetloader options' do
         lambda { AutoloadModules::Configuration::Editor }.should_not raise_error
       end
     end
+
+    describe "#autoload_scope with :proc option" do
+      specify do
+        lambda { AutoloadModules::Procedure }.should_not raise_error
+      end
+    end
   end
 end

data/sweetloader.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{sweetloader}
-  s.version = "0.1.2"
+  s.name = "sweetloader"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Kristian Mandrup}]
-  s.date = %q{2011-11-28}
-  s.description = %q{sweet autoloading using file structure conventions while allowing configuration overrides for special cases}
-  s.email = %q{kmandrup@gmail.com}
+  s.authors = ["Kristian Mandrup"]
+  s.date = "2011-11-29"
+  s.description = "sweet autoloading using file structure conventions while allowing configuration overrides for special cases"
+  s.email = "kmandrup@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.mdown"
@@ -25,11 +25,15 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/sweetloader.rb",
+    "lib/sweetloader/auto_loader.rb",
+    "lib/sweetloader/class_ext.rb",
+    "lib/sweetloader/scope.rb",
     "spec/auto_load_blank_root.rb",
     "spec/autoload_blank_root.rb",
     "spec/autoload_blank_root/hello.rb",
     "spec/autoload_blank_root/sailor.rb",
     "spec/autoload_modules/configuration/editor.rb",
+    "spec/autoload_modules/procedure.rb",
     "spec/class_ext_spec.rb",
     "spec/fixtures/autoload_modules.rb",
     "spec/fixtures/autoload_modules/subdir/first.rb",
@@ -53,11 +57,11 @@ Gem::Specification.new do |s|
     "spec/sweetloader/sweetloader_spec.rb",
     "sweetloader.gemspec"
   ]
-  s.homepage = %q{http://github.com/kristianmandrup/sweetloader}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.6}
-  s.summary = %q{sweetens up autoloading using file structure conventions}
+  s.homepage = "http://github.com/kristianmandrup/sweetloader"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "sweetens up autoloading using file structure conventions"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sweetloader
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-28 00:00:00.000000000Z
+date: 2011-11-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70350317938260 !ruby/object:Gem::Requirement
+  requirement: &899195900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *70350317938260
+  version_requirements: *899195900
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70350317937740 !ruby/object:Gem::Requirement
+  requirement: &899195210 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70350317937740
+  version_requirements: *899195210
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70350317937200 !ruby/object:Gem::Requirement
+  requirement: &899194770 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *70350317937200
+  version_requirements: *899194770
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70350317936580 !ruby/object:Gem::Requirement
+  requirement: &899194410 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.1.rc
   type: :development
   prerelease: false
-  version_requirements: *70350317936580
+  version_requirements: *899194410
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70350317933820 !ruby/object:Gem::Requirement
+  requirement: &899194080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70350317933820
+  version_requirements: *899194080
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70350317933120 !ruby/object:Gem::Requirement
+  requirement: &899193050 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70350317933120
+  version_requirements: *899193050
 description: sweet autoloading using file structure conventions while allowing configuration
   overrides for special cases
 email: kmandrup@gmail.com
@@ -94,11 +94,15 @@ files:
 - Rakefile
 - VERSION
 - lib/sweetloader.rb
+- lib/sweetloader/auto_loader.rb
+- lib/sweetloader/class_ext.rb
+- lib/sweetloader/scope.rb
 - spec/auto_load_blank_root.rb
 - spec/autoload_blank_root.rb
 - spec/autoload_blank_root/hello.rb
 - spec/autoload_blank_root/sailor.rb
 - spec/autoload_modules/configuration/editor.rb
+- spec/autoload_modules/procedure.rb
 - spec/class_ext_spec.rb
 - spec/fixtures/autoload_modules.rb
 - spec/fixtures/autoload_modules/subdir/first.rb
@@ -136,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 648157612907280241
+      hash: -951501357
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -145,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: sweetens up autoloading using file structure conventions