rails-dev-boost 0.1.1

data/lib/rails_development_boost/descendants_tracker_patch.rb

@@ -0,0 +1,18 @@
+module RailsDevelopmentBoost
+  module DescendantsTrackerPatch
+    def self.apply!
+      ActiveSupport::DescendantsTracker.extend self
+      ActiveSupport::DescendantsTracker.singleton_class.remove_possible_method :clear
+    end
+    
+    def delete(klass)
+      class_variable_get(:@@direct_descendants).tap do |direct_descendants|
+        direct_descendants.delete(klass)
+        direct_descendants.each_value {|descendants| descendants.delete(klass)}
+      end
+    end
+    
+    def clear
+    end
+  end
+end

data/lib/rails_development_boost/loaded_file.rb

@@ -0,0 +1,76 @@
+module RailsDevelopmentBoost
+  class LoadedFile
+    @constants_to_files = {}
+    
+    class << self
+      attr_reader :constants_to_files
+    end
+    
+    attr_accessor :path, :constants
+    delegate :constants_to_files, :to => 'self.class'
+  
+    def initialize(path, constants=[])
+      @path       = path
+      @constants  = constants
+      @mtime      = current_mtime
+    end
+  
+    def changed?
+      previous_mtime, @mtime = @mtime, current_mtime
+      previous_mtime != @mtime
+    end
+    
+    def add_constants(new_constants)
+      new_constants.each do |new_constant|
+        (constants_to_files[new_constant] ||= []) << self
+      end
+      @constants |= new_constants
+      retrieve_associated_files.each {|file| file.add_constants(@constants)} if @associated_files
+    end
+    
+    def delete_constant(const_name)
+      delete_from_constants_to_files(const_name)
+      @constants.delete(const_name)
+    end
+    
+    def associate_with(other_loaded_file)
+      (@associated_files ||= []) << other_loaded_file
+    end
+    
+    def retrieve_associated_files
+      associated_files, @associated_files = @associated_files, nil
+      associated_files
+    end
+    
+    def require_path
+      @path.sub(/\.rb\Z/, '')
+    end
+    
+    def self.each_file_with_const(const_name, &block)
+      if files = constants_to_files[const_name]
+        files.dup.each(&block)
+      end
+    end
+    
+    def stale!
+      @mtime = 0
+      if associated_files = retrieve_associated_files
+        associated_files.each(&:stale!)
+      end
+    end
+    
+  private
+    
+    def delete_from_constants_to_files(const_name)
+      if files = constants_to_files[const_name]
+        files.delete(self)
+        constants_to_files.delete(const_name) if files.empty?
+      end
+    end
+    
+    def current_mtime
+      # trying to be more efficient: there is no need for a full-fledged Time instance, just grab the timestamp
+      File.mtime(@path).to_i rescue nil
+    end
+  end
+end

data/lib/rails_development_boost/reference_patch.rb

@@ -0,0 +1,24 @@
+module RailsDevelopmentBoost
+  module ReferencePatch
+    if defined?(ActiveSupport::Dependencies::ClassCache) # post Rails' f345e2380cac2560f3bb
+      def self.apply!
+        ActiveSupport::Dependencies::ClassCache.send :include, self
+      end
+      
+      def loose!(const_name)
+        @store.delete(const_name)
+      end
+    else
+      def self.apply!
+        ActiveSupport::Dependencies::Reference.cattr_reader :constants
+        ActiveSupport::Dependencies::Reference.extend ClassMethods
+      end
+
+      module ClassMethods
+        def loose!(const_name)
+          constants.delete(const_name)
+        end
+      end
+    end
+  end
+end

data/lib/rails_development_boost/view_helpers_patch.rb

@@ -0,0 +1,17 @@
+module RailsDevelopmentBoost
+  module ViewHelpersPatch
+    def self.apply!
+      AbstractController::Helpers::ClassMethods.send :include, self
+    end
+    
+    # we need to explicitly associate helpers to their including controllers/mailers
+    def add_template_helper_with_const_association_tracking(helper_module)
+      ActiveSupport::Dependencies.add_explicit_dependency(helper_module, self)
+      add_template_helper_without_const_association_tracking(helper_module)
+    end
+
+    def self.included(base)
+      base.alias_method_chain :add_template_helper, :const_association_tracking
+    end
+  end
+end

data/rails-dev-boost.gemspec

@@ -0,0 +1,116 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rails-dev-boost}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Roman Le N\303\251grate", "thedarkone"]
+  s.date = %q{2010-11-11}
+  s.description = %q{Make your Rails app 10 times faster in development mode}
+  s.email = %q{roman.lenegrate@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "TODO.txt",
+     "VERSION",
+     "init.rb",
+     "lib/rails_development_boost.rb",
+     "lib/rails_development_boost/dependencies_patch.rb",
+     "lib/rails_development_boost/descendants_tracker_patch.rb",
+     "lib/rails_development_boost/loaded_file.rb",
+     "lib/rails_development_boost/reference_patch.rb",
+     "lib/rails_development_boost/view_helpers_patch.rb",
+     "rails-dev-boost.gemspec",
+     "test/constants/.DS_Store",
+     "test/constants/active_record/comment.rb",
+     "test/constants/active_record/message.rb",
+     "test/constants/active_record/other.rb",
+     "test/constants/active_record/post.rb",
+     "test/constants/deep_nesting/a.rb",
+     "test/constants/deep_nesting/a/b.rb",
+     "test/constants/deep_nesting/a/b/c.rb",
+     "test/constants/deep_nesting/a/b/c/d.rb",
+     "test/constants/double_removal/ns.rb",
+     "test/constants/double_removal/ns/c.rb",
+     "test/constants/double_removal/ns/m.rb",
+     "test/constants/mixins/client.rb",
+     "test/constants/mixins/mixin.rb",
+     "test/constants/mixins/update/mixin.rb",
+     "test/constants/nested_mixins/b.rb",
+     "test/constants/nested_mixins/b/c.rb",
+     "test/constants/nested_mixins/ma.rb",
+     "test/constants/nested_mixins/ma/mb.rb",
+     "test/constants/nested_mixins/ma/mb/mc.rb",
+     "test/constants/nested_mixins/oa.rb",
+     "test/constants/nested_mixins/oa/ob.rb",
+     "test/constants/nested_mixins/oa/ob/oc.rb",
+     "test/constants/single_removal/a.rb",
+     "test/constants/single_removal/b.rb",
+     "test/constants/singleton_mixins/a.rb",
+     "test/constants/singleton_mixins/b.rb",
+     "test/constants/subclass/a.rb",
+     "test/constants/subclass/b.rb",
+     "test/constants/subclass/c.rb",
+     "test/rails_development_boost_test.rb",
+     "test/stub_environment.rb"
+  ]
+  s.homepage = %q{http://github.com/thedarkone/rails-dev-boost}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Speeds up Rails development mode}
+  s.test_files = [
+    "test/constants/active_record/comment.rb",
+     "test/constants/active_record/message.rb",
+     "test/constants/active_record/other.rb",
+     "test/constants/active_record/post.rb",
+     "test/constants/deep_nesting/a/b/c/d.rb",
+     "test/constants/deep_nesting/a/b/c.rb",
+     "test/constants/deep_nesting/a/b.rb",
+     "test/constants/deep_nesting/a.rb",
+     "test/constants/double_removal/ns/c.rb",
+     "test/constants/double_removal/ns/m.rb",
+     "test/constants/double_removal/ns.rb",
+     "test/constants/mixins/client.rb",
+     "test/constants/mixins/mixin.rb",
+     "test/constants/mixins/update/mixin.rb",
+     "test/constants/nested_mixins/b/c.rb",
+     "test/constants/nested_mixins/b.rb",
+     "test/constants/nested_mixins/ma/mb/mc.rb",
+     "test/constants/nested_mixins/ma/mb.rb",
+     "test/constants/nested_mixins/ma.rb",
+     "test/constants/nested_mixins/oa/ob/oc.rb",
+     "test/constants/nested_mixins/oa/ob.rb",
+     "test/constants/nested_mixins/oa.rb",
+     "test/constants/single_removal/a.rb",
+     "test/constants/single_removal/b.rb",
+     "test/constants/singleton_mixins/a.rb",
+     "test/constants/singleton_mixins/b.rb",
+     "test/constants/subclass/a.rb",
+     "test/constants/subclass/b.rb",
+     "test/constants/subclass/c.rb",
+     "test/rails_development_boost_test.rb",
+     "test/stub_environment.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/constants/active_record/comment.rb

@@ -0,0 +1,2 @@
+class Comment < Message
+end

data/test/constants/active_record/message.rb

@@ -0,0 +1,2 @@
+class Message < ActiveRecord::Base
+end

data/test/constants/active_record/other.rb

@@ -0,0 +1,2 @@
+class Other < ActiveRecord::Base
+end

data/test/constants/active_record/post.rb

@@ -0,0 +1,3 @@
+class Post < Message
+  has_many :comments
+end

data/test/constants/deep_nesting/a.rb

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

data/test/constants/deep_nesting/a/b.rb

@@ -0,0 +1,2 @@
+module A::B
+end

data/test/constants/deep_nesting/a/b/c.rb

@@ -0,0 +1,2 @@
+module A::B::C
+end

data/test/constants/deep_nesting/a/b/c/d.rb

@@ -0,0 +1,2 @@
+module A::B::C::D
+end

data/test/constants/double_removal/ns.rb

@@ -0,0 +1,3 @@
+class Ns
+  include M
+end

data/test/constants/double_removal/ns/c.rb

@@ -0,0 +1,3 @@
+class Ns::C
+  include Ns::M
+end

data/test/constants/double_removal/ns/m.rb

@@ -0,0 +1,2 @@
+module Ns::M
+end

data/test/constants/mixins/client.rb

@@ -0,0 +1,3 @@
+class Client
+  include Mixin
+end

data/test/constants/mixins/mixin.rb

@@ -0,0 +1,4 @@
+module Mixin
+  def from_mixin
+  end
+end

data/test/constants/mixins/update/mixin.rb

@@ -0,0 +1,4 @@
+module Mixin
+  def from_mixin_update
+  end
+end

data/test/constants/nested_mixins/b.rb

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

data/test/constants/nested_mixins/b/c.rb

@@ -0,0 +1,2 @@
+class B::C
+end

data/test/constants/nested_mixins/ma.rb

@@ -0,0 +1,3 @@
+module Ma
+  include Mb
+end

data/test/constants/nested_mixins/ma/mb.rb

@@ -0,0 +1,3 @@
+module Ma::Mb
+  include Mc
+end

data/test/constants/nested_mixins/ma/mb/mc.rb

@@ -0,0 +1,2 @@
+module Ma::Mb::Mc
+end

data/test/constants/nested_mixins/oa.rb

@@ -0,0 +1,4 @@
+module Oa
+  include Ma::Mb
+  Ob
+end

data/test/constants/nested_mixins/oa/ob.rb

@@ -0,0 +1,3 @@
+module Oa::Ob
+  Oc
+end

data/test/constants/nested_mixins/oa/ob/oc.rb

@@ -0,0 +1,2 @@
+class Oa::Ob::Oc < B::C
+end

data/test/constants/single_removal/a.rb

@@ -0,0 +1,2 @@
+class A
+end

data/test/constants/single_removal/b.rb

@@ -0,0 +1,2 @@
+class B
+end

data/test/constants/singleton_mixins/a.rb

@@ -0,0 +1,3 @@
+module A
+  extend B
+end

data/test/constants/singleton_mixins/b.rb

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

data/test/constants/subclass/a.rb

@@ -0,0 +1,2 @@
+class A
+end

data/test/constants/subclass/b.rb

@@ -0,0 +1,2 @@
+class B < A
+end

data/test/constants/subclass/c.rb

@@ -0,0 +1,2 @@
+class C
+end

data/test/rails_development_boost_test.rb

@@ -0,0 +1,222 @@
+require 'test/unit'
+require 'mocha'
+
+require 'stub_environment'
+require 'rails_development_boost'
+RailsDevelopmentBoost.apply!
+
+class RailsDevelopmentBoostTest < Test::Unit::TestCase
+  def test_single_removal
+    load_from "single_removal"
+    
+    assert_same_object_id('A') { reload! }
+    assert_different_object_id('A') { reload! { update("a.rb") } }
+    assert_different_object_id('A') { reload! { update("a.rb") } }
+    assert_same_object_id('A') { reload! }
+    
+    assert_same_object_id('B') do
+      assert_different_object_id('A') do
+        reload! do
+          update("a.rb")
+        end
+      end
+    end
+  end
+  
+  def test_subclass_update_cascade
+    load_from "subclass"
+    
+    assert_different_object_id 'A', 'B' do
+      assert_same_object_id 'C' do
+        reload! do
+          update("a.rb")
+        end
+      end
+    end
+  end
+  
+  def test_nested_constant_update_cascade
+    load_from "deep_nesting"
+    
+    assert_different_object_id 'A::B::C::D', 'A::B::C', 'A::B', 'A' do
+      reload! do
+        update("a.rb")
+      end
+    end
+  end
+  
+  def test_mixin_update_cascade
+    load_from "mixins"
+    
+    assert_different_object_id 'Mixin', 'Client' do
+      reload! do
+        update("mixin.rb")
+      end
+    end
+    
+    assert Client.public_method_defined?('from_mixin') # sanity check
+    
+    # Simulate a change in the mixin file
+    reload! do
+      update("mixin.rb")
+    end
+    Deps.load_paths.unshift("#{@constant_dir}/update")
+    
+    assert !Client.public_method_defined?('from_mixin')
+    assert Client.public_method_defined?('from_mixin_update')
+  end
+  
+  def test_prevention_of_removal_cycle
+    load_from "double_removal"
+    
+    # Failure of this test = SystemStackError: stack level too deep
+    assert_different_object_id 'Ns::M', 'Ns::C', 'Ns' do
+      reload! do
+        update("ns/m.rb")
+      end
+    end
+  end
+  
+  def test_nested_mixins
+    load_from "nested_mixins"
+    
+    assert_different_object_id 'Ma::Mb::Mc', 'Ma::Mb', 'Ma' do
+      assert_different_object_id 'Oa::Ob::Oc', 'Oa::Ob', 'Oa' do
+        assert_same_object_id 'B::C' do
+          reload! do
+            update("ma/mb/mc.rb")
+          end
+        end
+      end
+    end
+  end
+  
+  def test_singleton_mixins
+    load_from "singleton_mixins"
+    
+    assert_different_object_id 'A' do
+      reload! do
+        update("b.rb")
+      end
+    end
+    assert_same_object_id 'B' do
+      reload! do
+        update("a.rb")
+      end
+    end
+  end
+  
+  def test_consistency_of_activerecord_registry
+    load_from "active_record"
+    
+    fetch_registered_ar_subclasses = lambda do
+      ActiveRecord::Base.instance_eval { subclasses }.sort_by(&:name)
+    end
+    
+    # Load initial version of the models
+    assert_equal [Comment, Message, Other, Post], fetch_registered_ar_subclasses[]
+    
+    # AR::Base subclass tree is updated
+    assert_different_object_id 'Message', 'Post', 'Comment' do
+      assert_same_object_id 'Other' do
+        reload! do
+          update("message.rb")
+        end
+      end
+    end
+    assert_equal [Comment, Message, Other, Post], fetch_registered_ar_subclasses[]
+    
+    # Create initial references to reflection classes
+    assert_equal Comment, Post.new.comments.new.class
+    
+    # Reflections are updated
+    assert_same_object_id 'Post' do
+      assert_different_object_id 'Comment' do
+        reload! do
+          update("comment.rb")
+        end
+      end
+    end
+    assert_equal Comment, Post.new.comments.new.class
+  end
+  
+protected
+
+  CONSTANT_DIR    = "#{File.dirname(__FILE__)}/constants".freeze
+  CONSTANT_FILES  = Dir.chdir(CONSTANT_DIR) { Dir.glob("**/*.rb") }.freeze
+  
+  Deps = ActiveSupport::Dependencies
+  
+  def setup
+    # Cleanup
+    clean_up! "setup"
+    @constant_dir = CONSTANT_DIR
+    
+    # Configuration
+    Deps.load_paths = [CONSTANT_DIR]
+    Deps.logger = Logger.new(STDERR)
+    Deps.log_activity = false
+    
+    # Stub mtimes
+    CONSTANT_FILES.each { |file| stub_mtime(file) }
+  end
+  
+  def teardown
+    clean_up! "teardown"
+  end
+  
+private
+
+  def load_from(root)
+    @constant_dir = "#{CONSTANT_DIR}/#{root}"
+    Deps.load_paths = [@constant_dir]
+  end
+
+  def update(path)
+    stub_mtime(path, File.mtime("#{@constant_dir}/#{path}") + 1)
+  end
+  
+  def stub_mtime(path, time=1)
+    File.stubs(:mtime).with("#{@constant_dir}/#{path}").returns time
+  end
+  
+  def reload!
+    ActionController::Dispatcher.new.cleanup_application
+    yield if block_given?
+    ActionController::Dispatcher.new.reload_application
+  end
+  
+  def clean_up!(stage)
+    message = "#{stage} dependency cleanup of <#{@method_name}> failed"
+    
+    Deps.clear
+    Deps.history.clear
+    
+    assert_equal([], Deps.constants_being_removed, message)
+    assert_equal([], Deps.module_cache, message)
+    assert_equal(Set.new, Deps.loaded, message)
+    assert_equal({}, Deps.file_map, message)
+    assert_equal([], Deps.autoloaded_constants, message)
+  end
+  
+  def assert_same_object_id(*expressions, &block)
+    each_object_id_diff(block, expressions) do |expr, before, after|
+      assert_equal(before, after, "<#{expr}.object_id> has changed")
+    end
+  end
+  
+  def assert_different_object_id(*expressions, &block)
+    each_object_id_diff(block, expressions) do |expr, before, after|
+      assert_not_equal(before, after, "<#{expr}.object_id> has remained the same")
+    end
+  end
+  
+  def each_object_id_diff(alter, expressions)
+    ids_before = expressions.map { |expr| [expr, eval("#{expr}.object_id")] }
+    alter.call
+    ids_before.each do |expr, before|
+      after = eval("#{expr}.object_id")
+      yield expr, before, after
+    end
+  end
+end