sweetloader 0.1.1 → 0.1.2

data/Gemfile

@@ -7,7 +7,7 @@ gem "i18n"
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "rspec",    ">= 2.5.0"
-  gem "bundler",  "~> 1.0.10"
+  gem "bundler",  ">= 1.1.rc"
   gem "jeweler",  ">= 1.6.4"
   gem "rcov",     ">= 0"
 end

data/{README.textile → README.mdown}

@@ -1,32 +1,32 @@
-h1. sweetloader
+# 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.
+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... 
 
-h2. Install
+## Install
 
-In your Gemfile:
+Insert in your Gemfile:
 
-<pre>
-gem 'sweetload'
-</pre>
+```ruby
+gem 'sweetloader'
+```
 
 Run bundler to install
 
 $bundle$
 
-h2. Usage
+## Usage
 
 Simply use the autoload_modules macro in your Module and Class definitions.
 
-<pre>
+```ruby
 CanTango
   autoload_module :Configuration, :Factory, :Permit
 end
-</pre>
+```
 
 Each of these modules are then expected to be in @catango/configuration.rb@ and similar relative to a load path.
 
-h3. Configuration
+## Configuration
 
 The following global config vars are available in AutoLoader:
 * root
@@ -35,14 +35,46 @@ The following global config vars are available in AutoLoader:
 Set a specific root which the dir will be calculated relative to, using root.
 Override namespace to directory auto-mapping using the namespaces hash.
 
-<pre>
+```ruby
 AutoLoader.root = ''
 AutoLoader.namespaces= {:CanTango => 'cantango', :Permithelper => 'permit_helper'}
-</pre>
+```
 
 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'.
 
-h2. Contributing to sweetload
+You can also specify these 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'}
+```
+
+## Mutate path option
+
+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') }
+```
+
+## Scopes
+
+```ruby
+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
+      autoload_modules :Admin
+    end
+    
+    autoload_modules :Editor
+  end
+end
+```
+
+## 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
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -52,7 +84,7 @@ h2. Contributing to sweetload
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-h2. Copyright
+## Copyright
 
 Copyright (c) 2011 Kristian Mandrup. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/sweetloader.rb

@@ -1,6 +1,7 @@
 require 'active_support/core_ext/string/inflections'
 
-class Module
+
+module SweetLoader
   def include_and_extend(the_module, options={})
     options[:instance_methods] ||= :InstanceMethods
     options[:class_methods] ||= :ClassMethods
@@ -12,21 +13,54 @@ class Module
   end
 
   def autoload_modules *args
+    alm_options = args.extract_options!
+    alm_options.merge!(autoload_options) if respond_to? :autoload_options
 
-    options = args.extract_options!
-    root = options[:root] || AutoLoader.root || ''
+    root = alm_options[:root] || AutoLoader.root || ''
     path = root.strip.empty? ? self.name.to_s.underscore : [root, self.name.to_s.underscore].join('/')
-    from = options[:from] || path
-
+    from = alm_options[:from] || path
+    proc = alm_options[:mutate_path]
+    from = proc.call(from) if proc
+        
+    the_module = send(:the_module) if respond_to? :the_module
+    the_module ||= self
+    
     # 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
-
-      send :autoload, req_name, AutoLoader.translate("#{from}/#{ruby_file}")
+      require_file = AutoLoader.translate("#{from}/#{ruby_file}", alm_options)
+      the_module.send :autoload, req_name, require_file
     end
   end
+  alias_method :autoload_module, :autoload_modules
+  
+  def autoload_scope options = {}, &block
+    if block_given?
+      block.arity == 1 ? yield(self) : SweetLoader::Scope.new(self, options).instance_eval(&block)
+    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
@@ -49,11 +83,13 @@ module AutoLoader
     @@namespaces = namespaces
   end
 
-  def self.translate name
+  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
-      namespaces[clazz_name.to_sym] ? namespaces[clazz_name.to_sym] : name
+      folder = ns[clazz_name.to_sym] ? ns[clazz_name.to_sym] : name
+      folder.sub /\/$/, ''
     end.join('/')
   end
 end

data/spec/autoload_modules/configuration/editor.rb

@@ -0,0 +1,7 @@
+module AutoloadModules
+  module Configuration
+    module Editor
+    end
+  end
+end
+

data/spec/fixtures/autoload_modulez/abc.rb

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

data/spec/fixtures/autoload_modulez/first.rb

@@ -5,3 +5,12 @@ module AutoloadModulez
     end
   end
 end
+
+# for mutate_path test
+module AutoloadModules
+  module First
+    def self.test
+      puts "here is the test"
+    end
+  end
+end  

data/spec/fixtures/autoload_modulez/roles/config/admin.rb

@@ -0,0 +1,7 @@
+module AutoloadModules
+  module Configuration
+    module Admin
+    end
+  end
+end
+

data/spec/fixtures/autoload_modulez/xyz.rb

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

data/spec/fixtures/autoload_mutate_path.rb

@@ -0,0 +1,20 @@
+module AutoloadModules
+  autoload_modules :First, :mutate_path => Proc.new {|path| 'fixtures/autoload_modulez'}
+end
+
+module AutoloadModules
+  autoload_scope :mutate_path => Proc.new {|path| 'fixtures/autoload_modulez'} do
+    autoload_modules :Abc
+    autoload_modules :Xyz
+  end
+end
+
+module AutoloadModules
+  module Configuration
+    autoload_scope :ns => { :AutoloadModules => 'fixtures/autoload_modulez', :Configuration => 'roles/config/'} do
+      autoload_modules :Admin
+    end
+    
+    autoload_modules :Editor
+  end
+end

data/spec/fixtures/models.rb

@@ -0,0 +1,37 @@
+class Trial
+  include ClassExt
+end
+
+class Hello
+end
+
+module GoodBye
+  module Alpha
+    module Beta
+    end
+  end
+end
+
+module First 
+  module ClassMethods
+    def class_method
+    end
+  end
+
+  module InstanceMethods
+    def instance_method
+    end
+  end
+end
+
+module Second
+  include_and_extend First
+end
+
+class Third
+  include_and_extend Second
+end
+
+def trial
+  @trial ||= Trial.new
+end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'rspec'
 require 'sweetloader'
+require 'fixtures/models'
 
 RSpec.configure do |config|
 

data/spec/sweetloader/sweetloader_options_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'fixtures/autoload_mutate_path'
+
+describe 'Sweetloader options' do
+  describe "#autoload_modules" do    
+    
+    describe ':mutate_path argument' do
+      specify do
+        lambda { AutoloadModules::First.should respond_to(:test) }.should_not raise_error
+      end
+    end
+    
+    describe "#autoload_scope with :mutate_path options" do
+      specify do
+        lambda { AutoloadModules::Abc }.should_not raise_error
+      end
+    end
+
+    describe "#autoload_scope with :namespace option" do
+      specify do
+        lambda { AutoloadModules::Configuration::Admin }.should_not raise_error
+        lambda { AutoloadModules::Configuration::Editor }.should_not raise_error
+      end
+    end
+  end
+end

data/spec/sweetloader/sweetloader_spec.rb

@@ -1,43 +1,5 @@
 require 'spec_helper'
 
-class Trial
-  include ClassExt
-end
-
-class Hello
-end
-
-module GoodBye
-  module Alpha
-    module Beta
-    end
-  end
-end
-
-module First 
-  module ClassMethods
-    def class_method
-    end
-  end
-
-  module InstanceMethods
-    def instance_method
-    end
-  end
-end
-
-module Second
-  include_and_extend First
-end
-
-class Third
-  include_and_extend Second
-end
-
-def trial
-  @trial ||= Trial.new
-end
-
 describe Module do
 
   describe "#include_and_extend" do

data/sweetloader.gemspec

@@ -4,24 +4,24 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = "sweetloader"
-  s.version = "0.1.1"
+  s.name = %q{sweetloader}
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Kristian Mandrup"]
-  s.date = "2011-10-12"
-  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-28}
+  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.textile"
+    "README.mdown"
   ]
   s.files = [
     ".document",
     ".rspec",
     "Gemfile",
     "LICENSE.txt",
-    "README.textile",
+    "README.mdown",
     "Rakefile",
     "VERSION",
     "lib/sweetloader.rb",
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "spec/autoload_blank_root.rb",
     "spec/autoload_blank_root/hello.rb",
     "spec/autoload_blank_root/sailor.rb",
+    "spec/autoload_modules/configuration/editor.rb",
     "spec/class_ext_spec.rb",
     "spec/fixtures/autoload_modules.rb",
     "spec/fixtures/autoload_modules/subdir/first.rb",
@@ -39,18 +40,24 @@ Gem::Specification.new do |s|
     "spec/fixtures/autoload_modules_root/second.rb",
     "spec/fixtures/autoload_modules_root/third.rb",
     "spec/fixtures/autoload_modulez.rb",
+    "spec/fixtures/autoload_modulez/abc.rb",
     "spec/fixtures/autoload_modulez/first.rb",
+    "spec/fixtures/autoload_modulez/roles/config/admin.rb",
     "spec/fixtures/autoload_modulez/second.rb",
     "spec/fixtures/autoload_modulez/third_one_here.rb",
+    "spec/fixtures/autoload_modulez/xyz.rb",
+    "spec/fixtures/autoload_mutate_path.rb",
+    "spec/fixtures/models.rb",
     "spec/spec_helper.rb",
+    "spec/sweetloader/sweetloader_options_spec.rb",
     "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
@@ -59,14 +66,14 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<activesupport>, [">= 3.0.1"])
       s.add_runtime_dependency(%q<i18n>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 2.5.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.10"])
+      s.add_development_dependency(%q<bundler>, [">= 1.1.rc"])
       s.add_development_dependency(%q<jeweler>, [">= 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<activesupport>, [">= 3.0.1"])
       s.add_dependency(%q<i18n>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 2.5.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.10"])
+      s.add_dependency(%q<bundler>, [">= 1.1.rc"])
       s.add_dependency(%q<jeweler>, [">= 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
@@ -74,7 +81,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<activesupport>, [">= 3.0.1"])
     s.add_dependency(%q<i18n>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 2.5.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.10"])
+    s.add_dependency(%q<bundler>, [">= 1.1.rc"])
     s.add_dependency(%q<jeweler>, [">= 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sweetloader
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-12 00:00:00.000000000Z
+date: 2011-11-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2156227500 !ruby/object:Gem::Requirement
+  requirement: &70350317938260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2156227500
+  version_requirements: *70350317938260
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2156226920 !ruby/object:Gem::Requirement
+  requirement: &70350317937740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156226920
+  version_requirements: *70350317937740
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156226320 !ruby/object:Gem::Requirement
+  requirement: &70350317937200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,21 +43,21 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *2156226320
+  version_requirements: *70350317937200
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2156225840 !ruby/object:Gem::Requirement
+  requirement: &70350317936580 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.10
+        version: 1.1.rc
   type: :development
   prerelease: false
-  version_requirements: *2156225840
+  version_requirements: *70350317936580
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2156225240 !ruby/object:Gem::Requirement
+  requirement: &70350317933820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2156225240
+  version_requirements: *70350317933820
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2156224100 !ruby/object:Gem::Requirement
+  requirement: &70350317933120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156224100
+  version_requirements: *70350317933120
 description: sweet autoloading using file structure conventions while allowing configuration
   overrides for special cases
 email: kmandrup@gmail.com
@@ -84,13 +84,13 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.textile
+- README.mdown
 files:
 - .document
 - .rspec
 - Gemfile
 - LICENSE.txt
-- README.textile
+- README.mdown
 - Rakefile
 - VERSION
 - lib/sweetloader.rb
@@ -98,6 +98,7 @@ files:
 - spec/autoload_blank_root.rb
 - spec/autoload_blank_root/hello.rb
 - spec/autoload_blank_root/sailor.rb
+- spec/autoload_modules/configuration/editor.rb
 - spec/class_ext_spec.rb
 - spec/fixtures/autoload_modules.rb
 - spec/fixtures/autoload_modules/subdir/first.rb
@@ -108,10 +109,16 @@ files:
 - spec/fixtures/autoload_modules_root/second.rb
 - spec/fixtures/autoload_modules_root/third.rb
 - spec/fixtures/autoload_modulez.rb
+- spec/fixtures/autoload_modulez/abc.rb
 - spec/fixtures/autoload_modulez/first.rb
+- spec/fixtures/autoload_modulez/roles/config/admin.rb
 - spec/fixtures/autoload_modulez/second.rb
 - spec/fixtures/autoload_modulez/third_one_here.rb
+- spec/fixtures/autoload_modulez/xyz.rb
+- spec/fixtures/autoload_mutate_path.rb
+- spec/fixtures/models.rb
 - spec/spec_helper.rb
+- spec/sweetloader/sweetloader_options_spec.rb
 - spec/sweetloader/sweetloader_spec.rb
 - sweetloader.gemspec
 homepage: http://github.com/kristianmandrup/sweetloader
@@ -129,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 406729261451437961
+      hash: 648157612907280241
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -138,7 +145,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