Class: Nanoc::Extra::Checking::Runner Private
- Inherits:
-
Object
- Object
- Nanoc::Extra::Checking::Runner
- Defined in:
- lib/nanoc/extra/checking/runner.rb
Overview
This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.
Runner is reponsible for running issue checks.
Constant Summary
- CHECKS_FILENAMES =
This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.
['Checks', 'Checks.rb', 'checks', 'checks.rb']
Instance Method Summary (collapse)
-
- (String) checks_filename
private
The name of the Checks file.
-
- (Boolean) dsl_present?
(also: #has_dsl?)
private
True if a Checks file exists, false otherwise.
-
- (Runner) initialize(site)
constructor
private
A new instance of Runner.
-
- (void) list_checks
private
Lists all available checks on stdout.
-
- (Boolean) run_all
private
Runs all checks.
-
- (Boolean) run_for_deploy
private
Runs the checks marked for deployment.
-
- (Boolean) run_specific(check_class_names)
private
Runs the checks with the given names.
Constructor Details
- (Runner) initialize(site)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a new instance of Runner
11 12 13 |
# File 'lib/nanoc/extra/checking/runner.rb', line 11 def initialize(site) @site = site end |
Instance Method Details
- (String) checks_filename
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns The name of the Checks file
16 17 18 |
# File 'lib/nanoc/extra/checking/runner.rb', line 16 def checks_filename @_checks_filename ||= CHECKS_FILENAMES.find { |f| File.file?(f) } end |
- (Boolean) dsl_present? Also known as: has_dsl?
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns true if a Checks file exists, false otherwise
21 22 23 |
# File 'lib/nanoc/extra/checking/runner.rb', line 21 def dsl_present? checks_filename && File.file?(checks_filename) end |
- (void) list_checks
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
This method returns an undefined value.
Lists all available checks on stdout.
29 30 31 32 33 34 35 |
# File 'lib/nanoc/extra/checking/runner.rb', line 29 def list_checks load_dsl_if_available puts 'Available checks:' puts puts all_check_classes.map { |i| ' ' + i.identifier.to_s }.sort.join("\n") end |
- (Boolean) run_all
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Runs all checks.
40 41 42 43 44 |
# File 'lib/nanoc/extra/checking/runner.rb', line 40 def run_all load_dsl_if_available run_check_classes(all_check_classes) end |
- (Boolean) run_for_deploy
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Runs the checks marked for deployment.
49 50 51 52 53 54 |
# File 'lib/nanoc/extra/checking/runner.rb', line 49 def run_for_deploy require_dsl return true if dsl.nil? run_check_classes(check_classes_named(dsl.deploy_checks)) end |
- (Boolean) run_specific(check_class_names)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Runs the checks with the given names.
61 62 63 64 65 |
# File 'lib/nanoc/extra/checking/runner.rb', line 61 def run_specific(check_class_names) load_dsl_if_available run_check_classes(check_classes_named(check_class_names)) end |