Class: PluginTestEnvironment

Inherits:
Object
  • Object
show all
Defined in:
lib/plugin_test_environment.rb

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.plugin_path ⇒ Object

Returns the value of attribute plugin_path.



4
5
6
 
# File 'lib/plugin_test_environment.rb', line 4

def plugin_path
  @plugin_path
end

Class Method Details

.find_plugin_dir_by_caller ⇒ Object 



197
198
199
200
 
# File 'lib/plugin_test_environment.rb', line 197

def self.find_plugin_dir_by_caller
  # 1 = two levels up => Where the env is initialized
  File.dirname(caller[1].split(":").first)
end

.fixture_path ⇒ Object 



171
172
173
174
175
176
177
 
# File 'lib/plugin_test_environment.rb', line 171

def self.fixture_path
  if File.exists?(PluginTestEnvironment.plugin_path + '/test/fixtures')
    PluginTestEnvironment.plugin_path + '/test/fixtures'
  else
    File.dirname(__FILE__) + "/../fixtures/"
  end
end

.init_env(plugin_dir, use_standard_migration = true) ⇒ Object

initializes the test environment

deprecated - use PluginTestEnvironment#initialize_environment instead



166
167
168
169
 
# File 'lib/plugin_test_environment.rb', line 166

def self.init_env(plugin_dir, use_standard_migration = true)
  puts "This method is deprecated please use PluginTestEnvironment#initialize_environment instead"
  initialize_environment(plugin_dir, :use_standard_migration => use_standard_migration)
end

.init_environment(rails_version) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/plugin_test_environment.rb', line 68

def self.init_environment(rails_version)
  target_directory = rails_dir(rails_version)
  FileUtils.mkdir_p target_directory
  system("rails _#{rails_version}_ #{File.expand_path(target_directory)}")
  FileUtils.rm target_directory + '/app/helpers/application_helper.rb'
  FileUtils.cp_r File.dirname(__FILE__) + '/../rails_root_fixtures/app/models', target_directory + '/app'
  FileUtils.cp_r File.dirname(__FILE__) + '/../rails_root_fixtures/app/controllers', target_directory + '/app'
  FileUtils.cp_r File.dirname(__FILE__) + '/../rails_root_fixtures/db/migrate', target_directory + '/db'
  FileUtils.cp_r File.dirname(__FILE__) + '/../rails_root_fixtures/vendor/plugins/plugin_to_test', target_directory + '/vendor/plugins/'
  FileUtils.cp File.dirname(__FILE__) + '/../rails_root_fixtures/config/database.yml', target_directory + '/config/database.yml'
end

.initialize_engines ⇒ Object 



100
101
102
103
 
# File 'lib/plugin_test_environment.rb', line 100

def self.initialize_engines
  require "#{self.plugin_path}/vendor/plugins/engines/boot"
  Engines.use_plugin_asset_directory = false
end

.initialize_engines_environment(plugin_dir, options = {:use_standard_migration => true}) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/plugin_test_environment.rb', line 85

def self.initialize_engines_environment(plugin_dir, options = {:use_standard_migration => true})
  initialize_environment(plugin_dir, options.merge(:skip_fixtures => true)) do |config|
    initialize_engines
    set_app_load_paths(config)
    set_nested_plugin_load_paths(config)
    yield config if block_given?
  end

  set_app_view_path
  load_nested_plugins
  set_nested_plugin_view_paths

  initialize_fixtures unless options[:skip_fixtures]
end

.initialize_environment(plugin_dir, options = {}) ⇒ Object

initializes the test environment



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/plugin_test_environment.rb', line 10

def self.initialize_environment(plugin_dir, options = {})
  default_options = {
    :use_standard_migration => true
  }
  options = default_options.merge(options)
  
  if plugin_dir.nil?
    plugin_dir ||= find_plugin_dir_by_caller
  else
    if plugin_dir.is_a?(Hash)
      options = plugin_dir
      plugin_dir = find_plugin_dir_by_caller
    end
  end
  
  self.plugin_path = File.join(plugin_dir, '..')
  require rails_root_dir(options[:rails_version]) + '/config/boot.rb'
  require File.dirname(__FILE__) + '/silent_logger'
  
  Rails::Initializer.run do |config|
    config.logger = SilentLogger.new
    config.log_level = :debug

    config.cache_classes = false
    config.whiny_nils = true

    yield config if block_given?
  end
  
  Test::Unit::TestCase.class_eval do
    cattr_accessor :rails_root
    self.rails_root = PluginTestEnvironment.plugin_path
  end
  
  initialize_fixtures unless options[:skip_fixtures]
  
  ActiveRecord::Migrator.migrate("#{RAILS_ROOT}/db/migrate") if options[:use_standard_migration]
  plugin_migration
end

.initialize_fixtures ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/plugin_test_environment.rb', line 143

def self.initialize_fixtures
  require 'test_help'

  Test::Unit::TestCase.fixture_path = PluginTestEnvironment.fixture_path
  $LOAD_PATH.unshift(Test::Unit::TestCase.fixture_path)

  Test::Unit::TestCase.class_eval do
    def create_fixtures(*table_names)
      if block_given?
        Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names) { yield }
      else
        Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names)
      end
    end

    self.use_transactional_fixtures = false
    self.use_instantiated_fixtures  = false
  end
end

.latest_rails_version ⇒ Object 



64
65
66
 
# File 'lib/plugin_test_environment.rb', line 64

def self.latest_rails_version
  Gem.cache.find_name(/^rails$/).map { |g| g.version.version }.last
end

.load_nested_plugins ⇒ Object 



127
128
129
130
131
 
# File 'lib/plugin_test_environment.rb', line 127

def self.load_nested_plugins
  Dir.glob("#{self.plugin_path}/vendor/plugins/*/init.rb").each do |plugin|
    require plugin
  end
end

.log_path ⇒ Object 



179
180
181
 
# File 'lib/plugin_test_environment.rb', line 179

def self.log_path
  PluginTestEnvironment.plugin_path + '/test/log'
end

.plugin_migration ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/plugin_test_environment.rb', line 183

def self.plugin_migration
  custom_migration = "#{PluginTestEnvironment.plugin_path}/test/migration.rb"
  if File.exists?(custom_migration)
    self.const_set(:Migration, Class.new(ActiveRecord::Migration))
    Migration.class_eval do
      def self.setup(&block)
        self.class.send(:define_method, :up, &block)
      end
    end
    require custom_migration
    Migration.up
  end
end

.rails_dir(rails_version) ⇒ Object 



50
51
52
 
# File 'lib/plugin_test_environment.rb', line 50

def self.rails_dir(rails_version)
  File.join(test_helper_base_dir, "#{rails_version || latest_rails_version}/")
end

.rails_root_dir(rails_version) ⇒ Object 



54
55
56
57
58
 
# File 'lib/plugin_test_environment.rb', line 54

def self.rails_root_dir(rails_version)
  target_directory = rails_dir(rails_version)
  init_environment(rails_version || latest_rails_version) unless File.exists?(target_directory)
  target_directory
end

.remove_environment_for_rails_version(version) ⇒ Object 



80
81
82
83
 
# File 'lib/plugin_test_environment.rb', line 80

def self.remove_environment_for_rails_version(version)
  dir = File.join(test_helper_base_dir, version)
  FileUtils.rm_r(dir) if File.exists?(dir)
end

.set_app_load_paths(config) ⇒ Object 



105
106
107
108
109
 
# File 'lib/plugin_test_environment.rb', line 105

def self.set_app_load_paths(config)
  Dir["#{self.plugin_path}/app/**"].each do |path|
    config.load_paths << path
  end
end

.set_app_view_path ⇒ Object 



120
121
122
123
124
125
 
# File 'lib/plugin_test_environment.rb', line 120

def self.set_app_view_path
  view_path = File.join(self.plugin_path, 'app', 'views')
  if File.exist?(view_path)
    ActionController::Base.view_paths.insert(1, view_path)
  end
end

.set_nested_plugin_load_paths(config) ⇒ Object 



111
112
113
114
115
116
117
118
 
# File 'lib/plugin_test_environment.rb', line 111

def self.set_nested_plugin_load_paths(config)
  Dir["#{self.plugin_path}/vendor/plugins/*/init.rb"].each do |plugin|
    nested_plugin_dir = File.dirname(plugin)
    Dir["#{nested_plugin_dir}/lib", "#{nested_plugin_dir}/app/**"].each do |path|
      config.load_paths << path
    end
  end
end

.set_nested_plugin_view_paths ⇒ Object 



133
134
135
136
137
138
139
140
141
 
# File 'lib/plugin_test_environment.rb', line 133

def self.set_nested_plugin_view_paths
  Dir.glob("#{self.plugin_path}/vendor/plugins/*/init.rb").each do |plugin|
    nested_plugin_dir = File.dirname(plugin)
    view_path = File.join(nested_plugin_dir, 'app', 'views')
    if File.exist?(view_path)
      ActionController::Base.view_paths.insert(1, view_path)
    end
  end
end

.test_helper_base_dir ⇒ Object 



60
61
62
 
# File 'lib/plugin_test_environment.rb', line 60

def self.test_helper_base_dir
  File.join(ENV['HOME'], ".dry_plugin_test_helper")
end