sweetloader 0.1.4 → 0.1.5

data/README.mdown

@@ -26,19 +26,21 @@ end
 
 Each of these modules are then expected to be in @catango/configuration.rb@ and similar relative to a load path.
 
-## AutoLoader Configuration
+## SweetLoader Configuration
 
-The following global config vars are available in AutoLoader:
+The following global config vars are available in SweetLoader:
 * root
 * namespaces
 * mode
 
+Note: AutoLoader is available as a deprecated alias for SweetLoader (versions < 1.5)
+
 ### Root
 
 Set a specific root which the dir will be calculated relative to, using root.
 
 ```ruby
-AutoLoader.root = 'fixtures'
+SweetLoader.root = 'fixtures'
 ```
 
 Now the constant `::CanTango` will be resolved as `'fixtures/can_tango'`
@@ -48,20 +50,18 @@ Now the constant `::CanTango` will be resolved as `'fixtures/can_tango'`
 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'}
+SweetLoader.namespaces= {:CanTango => 'cantango', :Permithelper => 'permit_helper'}
 ```
 
 ### Modes
 
-AutoLoader supports the following modes: `:autoload, :require`
+SweetLoader 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.
+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.
 
 ## autoload_modules Configuration
 
-You can also specify the AutoLoader options directly as an option hash on the `#autoload_modules` call:
+You can also specify the SweetLoader options directly as an option hash on the `#autoload_modules` call:
 
 ```ruby
   autoload_modules :Configuration, :mode => :require
@@ -86,8 +86,8 @@ module AutoloadModules
   module Configuration
 	# the scope options only have effect for autoload_modules statements within it!
     autoload_scope 
-        :ns => { :AutoloadModules => 'fixtures/autoload_modulez'},
-		:mutate_path => Proc.new {|path| path.sub(/(ies)/, 'y') } do
+				:ns => { :AutoloadModules => 'fixtures/autoload_modulez'},
+				:mutate_path => Proc.new {|path| path.sub(/(ies)/, 'y') } do
       autoload_modules :Admin
     end
     
@@ -96,6 +96,31 @@ module AutoloadModules
 end
 ```
 
+## ClassExt
+
+Sweetloader also encludes a convenient extension called `ClassExt`, which can be used to find a Module or Class based on a name.
+
+```ruby
+module First
+	module Blip
+		def self.blip
+		end
+	end
+end
+
+module Second
+	include_and_extend ClassExt
+  include_and_extend First
+end
+
+Second.new.try_module('Blip').blip
+Second.try_module('Blip').blip
+Second.try_class('Blip') == nil # => ClassNotFoundError
+
+Second.find_first_class(:Blop, :blip_blop, 'Blip') # => ClassNotFoundError
+Second.find_first_module('Blop', :blip) # => Blip:Class
+```
+
 ## Contributing to sweetloader
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/lib/sweetloader.rb

@@ -1,8 +1,11 @@
 require 'active_support/core_ext/string/inflections'
 
+require 'sweetloader/class_methods'
 
 module SweetLoader
   class InvalidAutoloadMode < StandardError; end
+
+  extend ClassMethods
   
   def include_and_extend(the_module, options={})
     options[:instance_methods] ||= :InstanceMethods
@@ -38,7 +41,7 @@ module SweetLoader
     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)
+      require_file = SweetLoader.translate("#{from}/#{ruby_file}", alm_options)
       logic.call(the_module, module_name, require_file)
     end
   end
@@ -66,7 +69,8 @@ class Module
   include SweetLoader
 end
 
+# backwards (deprecated) alias
+AutoLoader = SweetLoader
+
 require 'sweetloader/scope'
-require 'sweetloader/auto_loader'
 require 'sweetloader/class_ext'
-

data/lib/sweetloader/{auto_loader.rb → class_methods.rb}

@@ -1,7 +1,17 @@
-module AutoLoader
+module SweetLoader
   module ClassMethods
     attr_writer :default_mode
 
+    def 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
+
     def root
       @root ||= ''
     end
@@ -35,20 +45,10 @@ module AutoLoader
     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/spec/sweetloader/sweetloader_spec.rb

@@ -30,13 +30,13 @@ describe Module do
 
     context 'using AutoLoader.root' do
       it 'empty root' do
-        AutoLoader.root = ''
+        SweetLoader.root = ''
         require 'autoload_blank_root'
         AutoloadBlankRoot::Hello.should respond_to(:test)
       end
 
       it 'should autoload modules using ClassExt#autoload_root' do
-        AutoLoader.root = 'fixtures'
+        SweetLoader.root = 'fixtures'
         require 'fixtures/autoload_modules_root'
         AutoloadModulesRoot::Third.should respond_to(:test)
       end
@@ -44,8 +44,8 @@ describe Module do
 
     context 'using AutoLoader.namespaces' do
       it 'empty root' do
-        AutoLoader.root = ''
-        AutoLoader.namespaces= {:AutoLoadBlankRoot => 'autoload_blank_root', :HelloSailor => 'sailor'}
+        SweetLoader.root = ''
+        SweetLoader.namespaces= {:AutoLoadBlankRoot => 'autoload_blank_root', :HelloSailor => 'sailor'}
         require 'auto_load_blank_root'
         AutoLoadBlankRoot::HelloSailor.should respond_to(:test)
       end

data/sweetloader.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = "sweetloader"
-  s.version = "0.1.4"
+  s.name = %q{sweetloader}
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  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.authors = [%q{Kristian Mandrup}]
+  s.date = %q{2011-11-29}
+  s.description = %q{sweet autoloading using file structure conventions while allowing configuration overrides for special cases}
+  s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.mdown"
@@ -25,8 +25,8 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/sweetloader.rb",
-    "lib/sweetloader/auto_loader.rb",
     "lib/sweetloader/class_ext.rb",
+    "lib/sweetloader/class_methods.rb",
     "lib/sweetloader/scope.rb",
     "spec/auto_load_blank_root.rb",
     "spec/autoload_blank_root.rb",
@@ -57,11 +57,11 @@ Gem::Specification.new do |s|
     "spec/sweetloader/sweetloader_spec.rb",
     "sweetloader.gemspec"
   ]
-  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"
+  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}
 
   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.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &899195900 !ruby/object:Gem::Requirement
+  requirement: &70281404735240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *899195900
+  version_requirements: *70281404735240
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &899195210 !ruby/object:Gem::Requirement
+  requirement: &70281404734700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *899195210
+  version_requirements: *70281404734700
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &899194770 !ruby/object:Gem::Requirement
+  requirement: &70281404733980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *899194770
+  version_requirements: *70281404733980
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &899194410 !ruby/object:Gem::Requirement
+  requirement: &70281404733120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.1.rc
   type: :development
   prerelease: false
-  version_requirements: *899194410
+  version_requirements: *70281404733120
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &899194080 !ruby/object:Gem::Requirement
+  requirement: &70281404732360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *899194080
+  version_requirements: *70281404732360
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &899193050 !ruby/object:Gem::Requirement
+  requirement: &70281404731500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *899193050
+  version_requirements: *70281404731500
 description: sweet autoloading using file structure conventions while allowing configuration
   overrides for special cases
 email: kmandrup@gmail.com
@@ -94,8 +94,8 @@ files:
 - Rakefile
 - VERSION
 - lib/sweetloader.rb
-- lib/sweetloader/auto_loader.rb
 - lib/sweetloader/class_ext.rb
+- lib/sweetloader/class_methods.rb
 - lib/sweetloader/scope.rb
 - spec/auto_load_blank_root.rb
 - spec/autoload_blank_root.rb
@@ -140,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -951501357
+      hash: 1025158195221417970
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: sweetens up autoloading using file structure conventions