autoload_for 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in autoload_for.gemspec
+gemspec

data/README.md

@@ -0,0 +1,34 @@
+autoload_for
+====
+
+Autoload_for is a small gem that allows for autoloading of all ruby files underneath
+a directory, assuming a class namespacing scheme consistent with the directory
+structure.
+
+## Why?
+
+Rails spoiled us.  If we have the following paths to files in our Rails app with contents as below:
+
+    PATH TO FILE                                     CONTENTS OF FILE
+    ------------------------------------------------ ----------------------------------------------------------------------------------------------
+    app/controllers/users_controller.rb              class UserController < ActionController::Base; def index; @users = User.all; end; end
+    app/controllers/users/roles_controller.rb        class Users::RolesController < ActionController::Base; end
+    app/models/user.rb                               class User < ActiveRecord::Base; @role = Role.new;  end
+    app/models/user/role.rb                          class User::Role; @user = User.new; end
+
+then Rails automatically loads the classes in.  As long as the class name corresponds to the directory and file name it resides in, we're good to go.
+
+But when we step outside of our cushy Rails world and we want to write a Ruby gem, or a Sinatra app, or something else, then we have to manually require these files, and in the right order.  If the above files were not in a non-Rails application, we would have to require user.rb before users_controller.rb, since UserController depends on User.  What's worse, there is a circular dependency between user.rb and role.rb.  The only way to make it work is to use the autoload kernel method.  **autoload_for** fixes all that.
+
+## How to use it
+
+    gem install autoload_for
+
+And in your code (say you want to autoload the files listed in the above example):
+
+    require 'autoload_for'
+    include AutoloadFor
+    autoload_for('app/controllers'))
+    autoload_for('app/models')
+
+That's all there is to it.  Happy autoloading!

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/autoload_for.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "autoload_for"
+
+Gem::Specification.new do |s|
+  s.name        = "autoload_for"
+  s.version     = AutoloadFor::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Charles Finkel"]
+  s.email       = ["charles.finkel@gmail.com"]
+  s.homepage    = "https://github.com/charleseff/autoload_for"
+  s.summary     = %q{Have your classes in a directory autoloaded, just like Rails does with app/models, app/controllers, etc.}
+  s.description = %q{Have your classes in a directory autoloaded, just like Rails does with app/models, app/controllers, etc.}
+
+  s.rubyforge_project = "autoload_for"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'activesupport'
+  s.add_development_dependency 'rspec', '>= 2.6.0'
+
+end

data/lib/autoload_for.rb

@@ -0,0 +1,23 @@
+require 'active_support/core_ext'
+
+module AutoloadFor
+  VERSION = '0.0.2'
+
+  def autoload_for(dir)
+    Dir.glob(File.join(dir, "**/")).each do |inner_dir|
+      dir_to_modulize = inner_dir.split("#{dir}/")[1]
+      eval "module ::#{dir_to_modulize.chop.camelize}; end" if dir_to_modulize
+    end
+
+    Dir.glob(File.join(dir, '**', '*.rb')).each do |file|
+      split = file.split("#{dir}/")[1].split('/')
+      class_symbol = "#{split.last.chomp('.rb').camelize}".to_sym
+      if (split.size > 1)
+        the_module = eval(split[0, split.size-1].join('/').camelize)
+        the_module.autoload class_symbol, file
+      else
+        ::Object.autoload class_symbol, file
+      end
+    end
+  end
+end

data/spec/fixtures/animal/fish.rb

@@ -0,0 +1 @@
+class Animal::Fish; end

data/spec/fixtures/animal/mammal/cat.rb

@@ -0,0 +1 @@
+class Animal::Mammal::Cat; end

data/spec/fixtures/animal/mammal/dog.rb

@@ -0,0 +1 @@
+class Animal::Mammal::Dog; end

data/spec/fixtures/zoo.rb

@@ -0,0 +1 @@
+class Zoo; end

data/spec/lib/autoload_for_spec.rb

@@ -0,0 +1,33 @@
+require File.join(File.expand_path('../../..', __FILE__), 'lib', 'autoload_for')
+include AutoloadFor
+
+require 'active_support/inflector'
+
+describe AutoloadFor do
+
+  describe '.autoload_for' do
+
+    let(:fixtures_dir) { (File.join(File.expand_path('../..', __FILE__), 'fixtures')) }
+
+    it "should not have classes or modules to be loaded if not called" do
+      expect { Animal }.to raise_error
+      expect { Animal::Mammal }.to raise_error
+      expect { Animal::Mammal::Cat }.to raise_error
+      expect { Animal::Mammal::Dog }.to raise_error
+      expect { Animal::Fish }.to raise_error
+      expect { Zoo }.to raise_error
+
+      autoload_for fixtures_dir
+
+      expect { Animal }.to_not raise_error
+      expect { Animal::Mammal }.to_not raise_error
+      expect { Animal::Mammal::Cat }.to_not raise_error
+      expect { Animal::Mammal::Dog }.to_not raise_error
+      expect { Animal::Fish }.to_not raise_error
+      expect { Zoo }.to_not raise_error
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: autoload_for
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Charles Finkel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id002
+description: Have your classes in a directory autoloaded, just like Rails does with app/models, app/controllers, etc.
+email: 
+- charles.finkel@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- autoload_for.gemspec
+- lib/autoload_for.rb
+- spec/fixtures/animal/fish.rb
+- spec/fixtures/animal/mammal/cat.rb
+- spec/fixtures/animal/mammal/dog.rb
+- spec/fixtures/zoo.rb
+- spec/lib/autoload_for_spec.rb
+homepage: https://github.com/charleseff/autoload_for
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: autoload_for
+rubygems_version: 1.8.2
+signing_key: 
+specification_version: 3
+summary: Have your classes in a directory autoloaded, just like Rails does with app/models, app/controllers, etc.
+test_files: []
+