Class: Autotest::MerbRspec

Inherits:
Autotest
  • Object
show all
Defined in:
lib/generators/templates/application/merb_stack/autotest/merb_rspec.rb,
lib/generators/templates/application/merb_core/autotest/merb_rspec.rb

Overview

This class maps your application’s structure so Autotest can understand what specs to run when files change.

Fixtures are not covered by this class. If you change a fixture file, you will have to run your spec suite manually, or, better yet, provide your own Autotest map explaining how your fixtures are set up.

Instance Method Summary collapse

Constructor Details

#initialize ⇒ MerbRspec

Returns a new instance of MerbRspec.



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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/generators/templates/application/merb_stack/autotest/merb_rspec.rb', line 13

def initialize
  super

  # Ignore any happenings in these directories
  add_exception %r%^\./(?:doc|log|public|tmp|\.git|\.hg|\.svn|framework|gems|schema|\.DS_Store|autotest|bin|.*\.sqlite3|.*\.thor)% 
  # Ignore SCM directories and custom Autotest mappings
  %w[.svn .hg .git .autotest].each { |exception| add_exception(exception) }

  # Ignore any mappings that Autotest may have already set up
  clear_mappings

  # Anything in /lib could have a spec anywhere, if at all. So, look for
  # files with roughly the same name as the file in /lib
  add_mapping %r%^lib\/(.*)\.rb% do |_, m|
    files_matching %r%^spec\/#{m[1]}%
  end

  add_mapping %r%^spec/(spec_helper|shared/.*)\.rb$% do
    all_specs
  end

  # Changing a spec will cause it to run itself
  add_mapping %r%^spec/.*\.rb$% do |filename, _|
    filename
  end

  # Any change to a model will cause it's corresponding test to be run
  add_mapping %r%^app/models/(.*)\.rb$% do |_, m|
    spec_for(m[1], 'model')
  end

  # Any change to global_helpers will result in all view and controller
  # tests being run
  add_mapping %r%^app/helpers/global_helpers\.rb% do
    files_matching %r%^spec/(views|controllers|helpers|requests)/.*_spec\.rb$%
  end

  # Any change to a helper will cause its spec to be run
  add_mapping %r%^app/helpers/((.*)_helper(s)?)\.rb% do |_, m|
    spec_for(m[1], 'helper')
  end

  # Changes to a view cause its spec to be run
  add_mapping %r%^app/views/(.*)/% do |_, m|
    spec_for(m[1], 'request')
  end

  # Changes to a controller result in its corresponding spec being run. If
  # the controller is the exception or application controller, all
  # controller specs are run.
  add_mapping %r%^app/controllers/(.*)\.rb$% do |_, m|
    if ["application", "exception"].include?(m[1])
      files_matching %r%^spec/requests/.*_spec\.rb$%
    else
      spec_for(m[1], 'request')
    end
  end

  # If a change is made to the router, run controller, view and helper specs
  add_mapping %r%^config/router.rb$% do
    files_matching %r%^spec/(views|controllers|helpers|requests)/.*_spec\.rb$%
  end

  # If any of the major files governing the environment are altered, run
  # everything
  add_mapping %r%^config/(init|rack|environments/test).*\.rb|database\.yml% do 
    all_specs
  end
end

Instance Method Details

#add_options_if_present ⇒ Object 



115
116
117
 
# File 'lib/generators/templates/application/merb_stack/autotest/merb_rspec.rb', line 115

def add_options_if_present
  File.exist?("spec/spec.opts") ? "-O spec/spec.opts " : ""
end

#consolidate_failures(failed) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
 
# File 'lib/generators/templates/application/merb_stack/autotest/merb_rspec.rb', line 94

def consolidate_failures(failed)
  filters = Hash.new { |h,k| h[k] = [] }
  failed.each do |spec, failed_trace|
    if f = test_files_for(failed).find { |f| f =~ /spec\// }
      filters[f] << spec
      break
    end
  end
  filters
end

#failed_results(results) ⇒ Object 



83
84
85
 
# File 'lib/generators/templates/application/merb_stack/autotest/merb_rspec.rb', line 83

def failed_results(results)
  results.scan(/^\d+\)\n(?:\e\[\d*m)?(?:.*?Error in )?'([^\n]*)'(?: FAILED)?(?:\e\[\d*m)?\n(.*?)\n\n/m)
end

#handle_results(results) ⇒ Object 



87
88
89
90
91
92
 
# File 'lib/generators/templates/application/merb_stack/autotest/merb_rspec.rb', line 87

def handle_results(results)
  @failures      = failed_results(results)
  @files_to_test = consolidate_failures(@failures)
  @files_to_test.empty? && !$TESTING ? hook(:green) : hook(:red)
  @tainted = !@files_to_test.empty?
end

#make_test_cmd(specs_to_runs) ⇒ Object 



105
106
107
108
109
110
111
112
113
 
# File 'lib/generators/templates/application/merb_stack/autotest/merb_rspec.rb', line 105

def make_test_cmd(specs_to_runs)
  [
    ruby,
    "-S",
    spec_command,
    add_options_if_present,
    files_to_test.keys.flatten.join(' ')
  ].join(' ')
end

#spec_command(separator = File::ALT_SEPARATOR) ⇒ Object

Finds the proper spec command to use. Precendence is set in the lazily-evaluated method spec_commands. Alias + Override that in ~/.autotest to provide a different spec command then the default paths provided.



123
124
125
126
127
128
129
130
131
132
 
# File 'lib/generators/templates/application/merb_stack/autotest/merb_rspec.rb', line 123

def spec_command(separator=File::ALT_SEPARATOR)
  unless defined?(@spec_command)
    @spec_command = spec_commands.find { |cmd| File.exists?(cmd) }

    raise RspecCommandError, "No spec command could be found" unless @spec_command

    @spec_command.gsub!(File::SEPARATOR, separator) if separator
  end
  @spec_command
end

#spec_commands ⇒ Object

Autotest will look for spec commands in the following locations, in this order:

* default spec bin/loader installed in Rubygems
* any spec command found in PATH



139
140
141
 
# File 'lib/generators/templates/application/merb_stack/autotest/merb_rspec.rb', line 139

def spec_commands
  [File.join(Config::CONFIG['bindir'], 'spec'), 'spec']
end