active_reload 0.1.0 → 0.2.0

data/.gitignore

@@ -3,3 +3,13 @@
 Gemfile.lock
 pkg/*
 nbproject
+
+
+test/dummy*/.bundle
+test/dummy*/db/*.sqlite3
+test/dummy*/log/*.log
+test/dummy*/tmp/
+test/dummy*/vendor/bundle/
+
+test/dummy310rc4/app/controllers/root_controller.rb
+test/dummy309/app/controllers/root_controller.rb

data/README.md

@@ -0,0 +1,157 @@
+# Active Reload
+## The only Rails boost tool that doesn't try to be too smart.
+
+<a href='http://www.pledgie.com/campaigns/15547'><img alt='Donate Active Reload at www.pledgie.com' src='http://pledgie.com/campaigns/15547.png?skin_name=chrome' border='0' /></a>
+
+Active Reload is a gem that changes a little when Rails code reloading is executed.
+Normally Rails "forgets" your code after every request in development mode and loads again necessary
+files during the request. If your application is big this can take lot of time especially on "dashboard" page
+that uses lot of different classes.
+
+However this constant reloading is not always necessary. This gem changes it so it occurs
+before request and only when file was changed or added. It won't make reloading your app
+faster but it will skip reloading when nothing changed and that saved second can really sum
+up to a big value. It means that after change first request in development mode will reload the code
+and take as much time as it takes without this gem but subsequent request will be faster until next
+changes due to lack of code reloading.
+
+## Y U NO BELIEVE ?
+
+Watch these videos for comparison:
+
+### 2 simultaneous movies:
+
+http://youtubedoubler.com/1fts
+
+### Spree in development mode without Active Reload
+<a href='http://www.youtube.com/watch?v=KIOV5Me-83M'><img alt='Spree in development mode' src='http://img.youtube.com/vi/KIOV5Me-83M/0.jpg' border='0' /></a>
+
+### Spree in development and Active Reload enabled
+
+<a href='http://www.youtube.com/watch?v=HelS-mVnfI4'><img alt='Spree in development mode with enabled Active Reload' src='http://img.youtube.com/vi/HelS-mVnfI4/0.jpg' border='0' /></a>
+
+## Installation
+
+Simply add Active Reload to your Gemfile and bundle it up:
+
+```ruby
+  gem 'active_reload'
+```
+
+## Compatibility
+
+It was hand tested only with Rails 3.0.9 but should work without any problem on any `3.0.*` and `3.1.*` Rails version. I'm in the middle of writing automatic tests for it.
+
+It should work with any ruby compatible with `1.9.2` (ex. JRuby). Expect `1.8.7` support soon.
+
+## Notifications
+
+You can subscribe to two notifications provided by this gem.
+
+`active_reload.set_clear_dependencies_hook_replaced` event is triggered when the gem changes original rails hook for code reloading.
+
+```ruby
+ActiveSupport::Notifications.subscribe("active_reload.set_clear_dependencies_hook_replaced") do |*args|
+  event = ActiveSupport::Notifications::Event.new(*args)
+  msg = event.name
+  # Ubuntu: https://github.com/splattael/libnotify, Example: Libnotify.show(:body => msg, :summary => Rails.application.class.name, :timeout => 2.5, :append => true)
+  # Macos: http://segment7.net/projects/ruby/growl/
+  puts Rails.logger.warn(" --- #{msg} --- ")
+end
+```
+
+`active_support.dependencies.clear` event is triggered when code reloading is triggered by this gem.
+
+```ruby
+ActiveSupport::Notifications.subscribe("active_support.dependencies.clear") do |*args|
+  msg = "Code reloaded!"
+  # Ubuntu: https://github.com/splattael/libnotify, Example: Libnotify.show(:body => msg, :summary => Rails.application.class.name, :timeout => 2.5, :append => true)
+  # Macos: http://segment7.net/projects/ruby/growl/
+  puts Rails.logger.info(" --- #{msg} --- ")
+end
+```
+
+## Links
+
+ * http://blog.robert.pankowecki.pl/2011/06/faster-rails-development-part-2.html
+ * http://blog.robert.pankowecki.pl/2011/05/get-faster-rails-development.html
+
+## Do you want to reproduce the video experiment ? 
+
+The tested spree version was: https://github.com/spree/spree/tree/42795d91d3680394ef70126e6660cac3da81e8a9
+
+It was installed in sandbox mode:
+
+```bash
+  git clone git://github.com/spree/spree.git spree
+  cd spree
+  git checkout 42795d91d3680394ef70126e6660cac3da81e8a9
+  bundle install
+  rake sandbox
+  cd sandbox
+  # Edit Gemfile to add or remove active_reload support
+  rails server
+```
+
+Here is the ruby script that walks through the site using capybara:
+
+```ruby
+require 'bbq/test' # https://github.com/drugpl/bbq
+require 'benchmark'
+
+shop = ["Ruby on Rails", "Apache", "Clothing", "Bags", "Mugs"]
+admin = [
+"Overview", 
+"Orders", 
+"Next", 
+"Products", 
+"Option Types", 
+"Properties", 
+"Prototypes", 
+"Product Groups", 
+"Reports", 
+"Sales Total", 
+"Configuration", 
+"General Settings",
+"Mail Methods",
+"Tax Categories",
+"Zones",
+"States",
+"Payment Methods",
+"Taxonomies",
+"Shipping Methods",
+"Inventory Settings",
+"Analytics Trackers",
+"Complete List",
+"Users",
+"Promotions"
+]
+
+user = Bbq::TestUser.new(:driver => :selenium, :session => :default)
+user.visit("/")
+
+Benchmark.measure do
+
+  shop.each do |link|
+    user.click_on(link)
+  end
+
+  user.visit("/admin")
+  user.fill_in("Email", :with => "spree@example.com")
+  user.fill_in("Password", :with => "spree@example.com")
+  user.click_button("Log In")
+
+  admin.each do |link|
+    user.click_on(link)
+  end
+
+  FileUtils.touch( Rails.root.join("app/controllers/application_controller.rb") )
+
+  admin.first(5).each do |link|
+    user.click_on(link)
+  end
+
+  user.click_on "Logout"
+
+end
+```

data/Rakefile

@@ -1 +1,28 @@
-require 'bundler/gem_tasks'
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+require 'rdoc/task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Bbq'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/unit/*_test.rb' # Don't load test/dummy/test
+  t.verbose = false
+end
+
+task :default => :test

data/active_reload.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rake"
+  s.add_development_dependency "bbq"
 end

data/lib/active_reload.rb

@@ -9,7 +9,23 @@ module ActiveReload
   end # Railtie
 
   def self.replace?
-    !Rails.application.config.cache_classes && replace_proc?(ActionDispatch::Callbacks.instance_variable_get(:@_call_callbacks).last)
+    !Rails.application.config.cache_classes && replace_proc?(proc_collection.last)
+  end
+
+  def self.proc_collection
+    if rails31?
+      proc_source._cleanup_callbacks
+    else
+      proc_source._call_callbacks
+    end
+  end
+
+  def self.proc_source
+    if rails31?
+      ActionDispatch::Reloader
+    else
+      ActionDispatch::Callbacks
+    end
   end
   
   def self.replace_proc?(last)
@@ -45,8 +61,20 @@ module ActiveReload
   end
 
   def self.replace_proc(&new)
-    replaced = ActionDispatch::Callbacks.instance_variable_get(:@_call_callbacks).pop
-    ActionDispatch::Callbacks.before(&new)
+    @replaced = proc_collection.pop
+    if rails31?
+      proc_source.to_prepare(&new)
+    else
+      proc_source.before(&new)
+    end
+  end
+
+  def self.rails3?
+    Rails::VERSION::MAJOR == 3
+  end
+
+  def self.rails31?
+    rails3? && Rails::VERSION::MINOR == 1
   end
 
   

data/lib/active_reload/version.rb

@@ -1,3 +1,3 @@
 module ActiveReload
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/dummy309/Gemfile

@@ -0,0 +1,32 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.9'
+gem 'active_reload', :path => '../../../active_reload'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+# group :development, :test do
+#   gem 'webrat'
+# end

data/test/dummy309/README

@@ -0,0 +1,256 @@
+== 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.find(: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.com/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
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |   |-- images
+  |   |-- javascripts
+  |   `-- stylesheets
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+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. Contains subdirectories for
+  images, stylesheets, and javascripts. 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.