application_module 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in application_module.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Levente Bagi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# ApplicationModule
+
+This gem is meant to help with breaking down large Rails apps into modules.
+
+[![Build Status](https://travis-ci.org/bagilevi/application_module.png)](https://travis-ci.org/bagilevi/application_module) [![Code Climate](https://codeclimate.com/github/bagilevi/application_module.png)](https://codeclimate.com/github/bagilevi/application_module)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'application_module'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install application_module
+
+## Usage
+
+Create a directory for your modules. A `modules` directory in the app
+root works well for me.
+
+In `config/application.rb`:
+
+    config.autoload_paths += %W(#{config.root}/modules)
+
+For each module, create a subdirectory and a ruby file:
+
+    modules/animals.rb
+    modules/animals/
+
+`animals.rb`
+
+    module Animals
+      extend ApplicationModule
+    end
+
+Now you can create files like `modules/animals/tiger.rb` and
+`Animals::Tiger` will be autoloaded from here.
+
+You can create the usual `controllers/`, `models/`, `views/`
+directories under `modules/animals/`, the classes in these need to be
+namespaced under `Animals::`, but not
+`Animals::Controllers::`.
+
+By default if you want a subdirectory `services/`, then it will be
+assumed that classes under it will be namespaced as
+`Animals::Services::`. If you want it to behave like the
+`controllers/` and other directories, you can do this:
+
+    module Animals
+      extend ApplicationModule
+      autoload_without_namespacing 'services'
+    end
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.libs.push 'spec'
+end
+
+task :default => [:test]

data/application_module.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'application_module/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "application_module"
+  spec.version       = ApplicationModule::VERSION
+  spec.authors       = ["Levente Bagi"]
+  spec.email         = ["bagilevi@gmail.com"]
+  spec.description   = %q{Classes to help breaking down Rails app into modules}
+  spec.summary       = %q{Classes to help breaking down Rails app into modules}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", "~> 3.2.11"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/application_module/controller.rb

@@ -0,0 +1,28 @@
+module ApplicationModule
+  # You need to put this in controllers in your module:
+  #
+  #     extend ApplicationModule::Controller
+  #
+  # It makes Rails find the views inside your module directory.
+  module Controller
+    def self.extended(controller_class)
+      app_module_name = controller_class.name[%r{^[A-Za-z][A-Za-z0-9]*}]
+      app_module = const_get(app_module_name)
+      controller_class.instance_eval do
+        prepend_view_path app_module.view_path
+
+        protected
+
+        # Overriding AbstractController::ViewPaths#_prefixes
+        # to make it find the view 'login/new' instead 'module_name/login/new'
+        # Based on rails-3.2.11
+        define_method :_prefixes do
+          @_prefixes ||= begin
+            parent_prefixes = self.class.parent_prefixes
+            parent_prefixes.dup.unshift(controller_path.sub(%r{#{app_module_name.underscore}/}, ''))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/application_module/version.rb

@@ -0,0 +1,3 @@
+module ApplicationModule
+  VERSION = "0.0.1"
+end

data/lib/application_module.rb

@@ -0,0 +1,32 @@
+require "application_module/version"
+require 'autoloading'
+
+module ApplicationModule
+  autoload :Controller, 'application_module/controller'
+
+  def self.extended(app_module)
+    #puts "Loading application module: #{app_module}"
+    require 'pathname'
+    app_module.instance_variable_set(
+      :@path,
+      Pathname.new( caller.first[%r{^[^:]+}].sub(%r{\.rb$}, '') )
+    )
+    app_module.instance_eval do
+      extend Autoloading
+      autoload_without_namespacing %w(
+        models
+        views
+        controllers
+        helpers
+        concerns
+        mailers
+      )
+    end
+  end
+
+  attr_reader :path
+
+  def view_path
+    path.join 'views'
+  end
+end

data/lib/autoloading.rb

@@ -0,0 +1,35 @@
+require 'active_support/inflector'
+module Autoloading
+  def autoload_file(filepath)
+    klass_name = filepath[%r{([^/]+)\.rb$}, 1].camelize
+    autoload klass_name.to_sym, filepath
+  end
+
+  def autoload_without_namespacing dirnames
+    @autoload_without_namespacing_dirs ||= []
+    Array(dirnames).each do |dirname|
+      @autoload_without_namespacing_dirs << dirname
+      Dir[path.join(dirname, "*_#{ActiveSupport::Inflector.singularize(dirname)}.rb")].each do |p|
+        autoload_file(p)
+      end
+      Dir[path.join(dirname, "*.rb")].each do |p|
+        autoload_file(p)
+      end
+    end
+  end
+
+  # Overrides const_missing in ActiveSupport::Dependencies
+  def const_missing(const_name)
+    filename = const_name.to_s.underscore
+    dirs = [nil] + (@autoload_without_namespacing_dirs || [])
+    dirs.each do |dir|
+      filepath = path.join(*([dir, "#{filename}.rb"].compact))
+      if File.exists? filepath
+        load filepath.to_s
+        return const_get(const_name)
+      end
+    end
+    super
+  end
+end
+

data/spec/application_module/controller_spec.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class AnimalsTigersControllerTest < ActionController::TestCase
+  def setup
+    @controller = Animals::TigersController.new
+  end
+
+  test "makes Rails find the views inside the module directory" do
+    get :index
+    assert_includes response.body, "tigers#index"
+  end
+end
+

data/spec/application_module_spec.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+describe ApplicationModule do
+  it "autoloads submodules" do
+    Animals.send(:remove_const, :Tiger) if defined?(Animals::Tiger)
+    Animals::Tiger
+  end
+
+  it "autoloads submodules from models/views/controllers/etc subdirectories" do
+    Animals.send(:remove_const, :TigersController) if defined?(Animals::TigersController)
+    Animals::TigersController
+  end
+
+  it "can handle custom directories to autoload from" do
+    Animals.send(:remove_const, :TigerDecorator) if defined?(Animals::TigerDecorator)
+    Animals::TigerDecorator
+  end
+
+  it "knows the path of itself" do
+    Animals.path.to_s.must_equal(
+      "#{$dummy_path}/modules/animals"
+    )
+  end
+
+  it "has an overridable view_path" do
+    Animals.view_path.to_s.must_equal(
+      "#{$dummy_path}/modules/animals/views"
+    )
+  end
+end

data/spec/dummies/dummy-rails-3.2.11/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/dummies/dummy-rails-3.2.11/Gemfile

@@ -0,0 +1,26 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.11'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+
+
+
+
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'debugger'

data/spec/dummies/dummy-rails-3.2.11/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/dummies/dummy-rails-3.2.11/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+DummyRails3211::Application.load_tasks

data/spec/dummies/dummy-rails-3.2.11/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .

data/spec/dummies/dummy-rails-3.2.11/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummies/dummy-rails-3.2.11/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummies/dummy-rails-3.2.11/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end