path: root/railties/test/initializer_test.rb

require 'abstract_unit'
require 'rails/initializer'
require 'rails/generators'

require 'action_view'
require 'action_mailer'
require 'active_record'

# Mocks out the configuration
module Rails
  def self.configuration
    Rails::Configuration.new
  end

  module Generators
    def self.clear_aliases!
      @aliases = nil
    end

    def self.clear_options!
      @@options = nil
    end
  end
end


class ConfigurationMock < Rails::Configuration
  attr_reader :environment_path

  def initialize(envpath)
    super()
    @environment_path = envpath
  end
end

class Initializer_after_initialize_with_blocks_environment_Test < Test::Unit::TestCase
  def setup
    config = ConfigurationMock.new("")
    config.after_initialize do
      $test_after_initialize_block1 = "success"
    end
    config.after_initialize do
      $test_after_initialize_block2 = "congratulations"
    end
    assert_nil $test_after_initialize_block1
    assert_nil $test_after_initialize_block2

    config.expects(:gems_dependencies_loaded).returns(true)
    Rails::Initializer.run(:after_initialize, config)
  end

  def teardown
    $test_after_initialize_block1 = nil
    $test_after_initialize_block2 = nil
  end

  def test_should_have_called_the_first_after_initialize_block
    assert_equal "success", $test_after_initialize_block1
  end

  def test_should_have_called_the_second_after_initialize_block
    assert_equal "congratulations", $test_after_initialize_block2
  end
end

class Initializer_after_initialize_with_no_block_environment_Test < Test::Unit::TestCase
  def setup
    config = ConfigurationMock.new("")
    config.after_initialize do
      $test_after_initialize_block1 = "success"
    end
    config.after_initialize # don't pass a block, this is what we're testing!
    config.after_initialize do
      $test_after_initialize_block2 = "congratulations"
    end
    assert_nil $test_after_initialize_block1

    config.expects(:gems_dependencies_loaded).returns(true)
    Rails::Initializer.run(:after_initialize, config)
  end

  def teardown
    $test_after_initialize_block1 = nil
    $test_after_initialize_block2 = nil
  end

  def test_should_have_called_the_first_after_initialize_block
    assert_equal "success", $test_after_initialize_block1, "should still get set"
  end

  def test_should_have_called_the_second_after_initialize_block
    assert_equal "congratulations", $test_after_initialize_block2
  end
end

class ConfigurationFrameworkPathsTests < Test::Unit::TestCase
  def setup
    @config = Rails::Configuration.new
    @config.frameworks.clear
    @initializer = Rails::Initializer.default
    @initializer.config = @config

    File.stubs(:directory?).returns(true)
    Rails::Initializer.run(:set_root_path, @config)
  end

  def test_minimal
    expected = %w(railties railties/lib activesupport/lib)
    assert_equal expected.map {|e| "#{@config.framework_root_path}/#{e}"}, @config.framework_paths
  end

  def test_actioncontroller_or_actionview_add_actionpack
    @config.frameworks << :action_controller
    assert_framework_path "actionpack/lib"

    @config.frameworks = [:action_view]
    assert_framework_path 'actionpack/lib'
  end

  def test_paths_for_ar_ares_and_mailer
    [:active_record, :action_mailer, :active_resource, :action_web_service].each do |framework|
      @config.frameworks = [framework]
      assert_framework_path "#{framework.to_s.gsub('_', '')}/lib"
    end
  end

  def test_action_mailer_load_paths_set_only_if_action_mailer_in_use
    @config.frameworks = [:action_controller]
    @initializer.config = @config
    @initializer.run :require_frameworks

    assert_nothing_raised NameError do
      @initializer.run :load_view_paths
    end
  end

  def test_action_controller_load_paths_set_only_if_action_controller_in_use
    @config.frameworks = []
    @initializer.run :require_frameworks

    assert_nothing_raised NameError do
      @initializer.run :load_view_paths
    end
  end

  protected
    def assert_framework_path(path)
      assert @config.framework_paths.include?("#{@config.framework_root_path}/#{path}"),
        "<#{path.inspect}> not found among <#{@config.framework_paths.inspect}>"
    end
end

require 'plugin_test_helper'

class InitializerPluginLoadingTests < Test::Unit::TestCase
  def setup
    @configuration     = Rails::Configuration.new
    @configuration.frameworks -= [:action_mailer]
    @configuration.plugin_paths << plugin_fixture_root_path
    @initializer       = Rails::Initializer.default
    @initializer.config = @configuration
    @valid_plugin_path = plugin_fixture_path('default/stubby')
    @empty_plugin_path = plugin_fixture_path('default/empty')
  end

  def test_no_plugins_are_loaded_if_the_configuration_has_an_empty_plugin_list
    only_load_the_following_plugins! []
    @initializer.run :load_plugins
    assert_equal [], @configuration.loaded_plugins
  end

  def test_only_the_specified_plugins_are_located_in_the_order_listed
    plugin_names = [:plugin_with_no_lib_dir, :acts_as_chunky_bacon]
    only_load_the_following_plugins! plugin_names
    load_plugins!
    assert_plugins plugin_names, @configuration.loaded_plugins
  end

  private

    def load_plugins!
      @initializer.run(:add_plugin_load_paths)
      @initializer.run(:load_plugins)
    end
end

class InitializerGeneratorsTests < Test::Unit::TestCase

  def setup
    @configuration = Rails::Configuration.new
    @initializer   = Rails::Initializer.default
    @initializer.config = @configuration
  end

  def test_generators_default_values
    assert_equal(true, @configuration.generators.colorize_logging)
    assert_equal({}, @configuration.generators.aliases)
    assert_equal({}, @configuration.generators.options)
  end

  def test_generators_set_rails_options
    @configuration.generators.orm = :datamapper
    @configuration.generators.test_framework = :rspec
    expected = { :rails => { :orm => :datamapper, :test_framework => :rspec } }
    assert_equal expected, @configuration.generators.options
  end

  def test_generators_set_rails_aliases
    @configuration.generators.aliases = { :rails => { :test_framework => "-w" } }
    expected = { :rails => { :test_framework => "-w" } }
    assert_equal expected, @configuration.generators.aliases
  end

  def test_generators_aliases_and_options_on_initialization
    @configuration.generators.rails :aliases => { :test_framework => "-w" }
    @configuration.generators.orm :datamapper
    @configuration.generators.test_framework :rspec

    @initializer.run(:initialize_generators)

    assert_equal :rspec, Rails::Generators.options[:rails][:test_framework]
    assert_equal "-w", Rails::Generators.aliases[:rails][:test_framework]
  end

  def test_generators_no_color_on_initialization
    @configuration.generators.colorize_logging = false
    @initializer.run(:initialize_generators)
    assert_equal Thor::Base.shell, Thor::Shell::Basic
  end

  def test_generators_with_hashes_for_options_and_aliases
    @configuration.generators do |g|
      g.orm    :datamapper, :migration => false
      g.plugin :aliases => { :generator => "-g" },
               :generator => true
    end

    expected = {
      :rails => { :orm => :datamapper },
      :plugin => { :generator => true },
      :datamapper => { :migration => false }
    }

    assert_equal expected, @configuration.generators.options
    assert_equal({ :plugin => { :generator => "-g" } }, @configuration.generators.aliases)
  end

  def test_generators_with_hashes_are_deep_merged
    @configuration.generators do |g|
      g.orm    :datamapper, :migration => false
      g.plugin :aliases => { :generator => "-g" },
               :generator => true
    end
    @initializer.run(:initialize_generators)

    assert Rails::Generators.aliases.size >= 1
    assert Rails::Generators.options.size >= 1
  end

  protected

    def teardown
      Rails::Generators.clear_aliases!
      Rails::Generators.clear_options!
    end
end

class InitializerSetupI18nTests < Test::Unit::TestCase
  def test_no_config_locales_dir_present_should_return_empty_load_path
    File.stubs(:exist?).returns(false)
    assert_equal [], Rails::Configuration.new.i18n.load_path
  end

  def test_config_locales_dir_present_should_be_added_to_load_path
    File.stubs(:exist?).returns(true)
    Dir.stubs(:[]).returns([ "my/test/locale.yml" ])
    assert_equal [ "my/test/locale.yml" ], Rails::Configuration.new.i18n.load_path
  end

  def test_config_defaults_should_be_added_with_config_settings
    File.stubs(:exist?).returns(true)
    Dir.stubs(:[]).returns([ "my/test/locale.yml" ])

    config = Rails::Configuration.new
    config.i18n.load_path << "my/other/locale.yml"

    assert_equal [ "my/test/locale.yml", "my/other/locale.yml" ], config.i18n.load_path
  end

  def test_setting_another_default_locale
    config = Rails::Configuration.new
    config.i18n.default_locale = :de
    Rails::Initializer.run(:initialize_i18n, config)
    assert_equal :de, I18n.default_locale
  end
end

class InitializerDatabaseMiddlewareTest < Test::Unit::TestCase
  def setup
    @config = Rails::Configuration.new
    @config.frameworks = [:active_record, :action_controller, :action_view]
  end

  def test_initialize_database_middleware_doesnt_perform_anything_when_active_record_not_in_frameworks
    @config.frameworks.clear
    @config.expects(:middleware).never
    Rails::Initializer.run(:initialize_database_middleware, @config)
  end

  def test_database_middleware_initializes_when_session_store_is_active_record
    store = ActionController::Base.session_store
    ActionController::Base.session_store = ActiveRecord::SessionStore

    @config.middleware.expects(:insert_before).with(:"ActiveRecord::SessionStore", ActiveRecord::ConnectionAdapters::ConnectionManagement)
    @config.middleware.expects(:insert_before).with(:"ActiveRecord::SessionStore", ActiveRecord::QueryCache)

    Rails::Initializer.run(:initialize_database_middleware, @config)
  ensure
    ActionController::Base.session_store = store
  end

  def test_database_middleware_doesnt_initialize_when_session_store_is_not_active_record
    store = ActionController::Base.session_store
    ActionController::Base.session_store = ActionDispatch::Session::CookieStore

    # Define the class, so we don't have to actually make it load
    eval("class ActiveRecord::ConnectionAdapters::ConnectionManagement; end")

    @config.middleware.expects(:use).with(ActiveRecord::ConnectionAdapters::ConnectionManagement)
    @config.middleware.expects(:use).with(ActiveRecord::QueryCache)

    Rails::Initializer.run(:initialize_database_middleware, @config)
  ensure
    ActionController::Base.session_store = store
  end

  def test_ensure_database_middleware_doesnt_use_action_controller_on_initializing
    @config.frameworks -= [:action_controller]
    store = ActionController::Base.session_store
    ActionController::Base.session_store = ActiveRecord::SessionStore

    @config.middleware.expects(:use).with(ActiveRecord::ConnectionAdapters::ConnectionManagement)
    @config.middleware.expects(:use).with(ActiveRecord::QueryCache)

    Rails::Initializer.run(:initialize_database_middleware, @config)
  ensure
    ActionController::Base.session_store = store
    @config.frameworks += [:action_controller]
  end
end

class InitializerViewPathsTest  < Test::Unit::TestCase
  def setup
    @config = Rails::Configuration.new
    @config.frameworks = [:action_view, :action_controller, :action_mailer]

    ActionController::Base.stubs(:view_paths).returns(stub)
    ActionMailer::Base.stubs(:view_paths).returns(stub)
  end

  def test_load_view_paths_doesnt_perform_anything_when_action_view_not_in_frameworks
    @config.frameworks -= [:action_view]
    ActionController::Base.view_paths.expects(:load!).never
    ActionMailer::Base.view_paths.expects(:load!).never
    Rails::Initializer.run(:load_view_paths, @config)
  end
end

class RailsRootTest < Test::Unit::TestCase
  def test_rails_dot_root_equals_rails_root
    assert_equal RAILS_ROOT, Rails.root.to_s
  end

  def test_rails_dot_root_should_be_a_pathname
    assert_equal File.join(RAILS_ROOT, 'app', 'controllers'), Rails.root.join('app', 'controllers').to_s
  end
end