Ruby on Rails | Screencasts | Download | Documentation | Weblog | Community | Source

Ticket #6851: load_plugins_in_specified_order_with_better_error_handling_for_config_plugins_list.patch

File load_plugins_in_specified_order_with_better_error_handling_for_config_plugins_list.patch, 4.6 kB (added by lazyatom, 2 years ago)

The same patch as before, except with better error handling if config.plugins includes a plugin which doesn't exist

  • railties/test/plugin_test.rb

    old new  
    4343 
    4444  def test_load_plugin 
    4545    stubby = "#{File.dirname(__FILE__)}/fixtures/plugins/default/stubby" 
    46     expected = Set.new(['stubby']) 
     46    expected = ['stubby'] 
    4747 
    4848    assert @init.send(:load_plugin, stubby) 
    4949    assert_equal expected, @init.loaded_plugins 
    …… 
    6666  def test_load_plugins_from_two_sources 
    6767    assert_loaded_plugins %w(a stubby acts_as_chunky_bacon), ['default', 'alternate'] 
    6868  end 
     69  
     70  def test_load_all_plugins_when_config_plugins_is_nil 
     71    @init.configuration.plugins = nil 
     72    assert_loaded_plugins %w(a stubby acts_as_chunky_bacon), ['default', 'alternate'] 
     73  end 
    6974 
     75  def test_load_no_plugins_when_config_plugins_is_empty_array 
     76    @init.configuration.plugins = [] 
     77    assert_loaded_plugins [], ['default', 'alternate']    
     78  end 
     79  
     80  def test_load_only_selected_plugins 
     81    plugins = %w(stubby a) 
     82    @init.configuration.plugins = plugins 
     83    assert_loaded_plugins plugins, ['default', 'alternate'] 
     84  end 
     85  
     86  def test_load_plugins_in_order 
     87    plugins = %w(stubby acts_as_chunky_bacon a) 
     88    @init.configuration.plugins = plugins 
     89    assert_plugin_load_order plugins, ['default', 'alternate'] 
     90  end 
     91 
     92  def test_raise_error_when_plugin_not_found 
     93    @init.configuration.plugins = %w(this_plugin_does_not_exist) 
     94    assert_raise(LoadError) { load_plugins(['default', 'alternate']) } 
     95  end 
     96   
    7097  protected 
    71     def assert_loaded_plugins(plugins, path) 
    72       assert_equal Set.new(plugins), load_plugins(path) 
     98    def assert_loaded_plugins(plugins, paths) 
     99      assert_equal plugins.sort, load_plugins(paths).sort 
    73100    end 
     101     
     102    def assert_plugin_load_order(plugins, paths) 
     103      assert_equal plugins, load_plugins(paths) 
     104    end 
    74105 
    75106    def load_plugins(*paths) 
    76107      @init.configuration.plugin_paths = paths.flatten.map { |p| "#{File.dirname(__FILE__)}/fixtures/plugins/#{p}" } 

  • railties/lib/initializer.rb

    old new  
    4848    # instance. 
    4949    def initialize(configuration) 
    5050      @configuration = configuration 
    51       @loaded_plugins = Set.new 
     51      @loaded_plugins = [] 
    5252    end 
    5353 
    5454    # Sequentially step through all of the available initialization routines, 
    …… 
    176176    # * evaluate <tt>init.rb</tt> if present 
    177177    # 
    178178    # After all plugins are loaded, duplicates are removed from the load path. 
    179     # Plugins are loaded in alphabetical order. 
     179    # If an array of plugin names is specified in config.plugins, the plugins 
     180    # will be loaded in that order. Otherwise, plugins are loaded in alphabetical 
     181    # order. 
    180182    def load_plugins 
    181       find_plugins(configuration.plugin_paths).sort.each { |path| load_plugin path } 
     183      if configuration.plugins.nil? 
     184        # a nil value implies we don't care about plugins; load 'em all in a reliable order 
     185        find_plugins(configuration.plugin_paths).sort.each { |path| load_plugin path } 
     186      elsif !configuration.plugins.empty? 
     187        # we've specified a config.plugins array, so respect that order 
     188        plugin_paths = find_plugins(configuration.plugin_paths) 
     189        configuration.plugins.each do |name| 
     190          path = plugin_paths.find { |p| File.basename(p) == name } 
     191          raise(LoadError, "Cannot find the plugin '#{name}'!") if path.nil? 
     192          load_plugin path 
     193        end 
     194      end  
    182195      $LOAD_PATH.uniq! 
    183196    end 
    184197 
    …… 
    345358      end 
    346359 
    347360      def plugin_enabled?(path) 
    348         configuration.plugins.empty? || configuration.plugins.include?(File.basename(path)) 
     361        configuration.plugins.nil? || configuration.plugins.include?(File.basename(path)) 
    349362      end 
    350363 
    351364      # Load the plugin at <tt>path</tt> unless already loaded. 
    …… 
    470483    # any method of +nil+. Set to +false+ for the standard Ruby behavior. 
    471484    attr_accessor :whiny_nils 
    472485 
    473     # The list of plugins to load. If this is set to <tt>[]</tt>, all plugins will be loaded. 
     486    # The list of plugins to load. If this is set to <tt>nil</tt>, all plugins will 
     487    # be loaded. If this is set to <tt>[]</tt>, no plugins will be loaded. Otherwise, 
     488    # plugins will be loaded in the order specified. 
    474489    attr_accessor :plugins 
    475490 
    476491    # The path to the root of the plugins directory. By default, it is in 
    …… 
    642657      end 
    643658 
    644659      def default_plugins 
    645         [] 
     660        nil 
    646661      end 
    647662 
    648663      def default_plugin_paths