Module: Rails::CssUnused

Defined in:
lib/rails/css_unused.rb,
lib/rails/css_unused/report.rb,
lib/rails/css_unused/railtie.rb,
lib/rails/css_unused/spinner.rb,
lib/rails/css_unused/version.rb,
lib/rails/css_unused/view_scanner.rb,
lib/rails/css_unused/configuration.rb,
lib/rails/css_unused/stylesheet_scanner.rb

Defined Under Namespace

Classes: Configuration, Error, Railtie, Report, Spinner, StylesheetScanner, ViewScanner

Constant Summary collapse

VERSION = 
"0.2.0"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



84
85
86
 
# File 'lib/rails/css_unused/configuration.rb', line 84

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



88
89
90
 
# File 'lib/rails/css_unused/configuration.rb', line 88

def configure
  yield(configuration)
end

.default_root ⇒ Object

Returns the project root: Rails.root if inside Rails, else cwd.



29
30
31
32
33
34
35
 
# File 'lib/rails/css_unused.rb', line 29

def default_root
  if defined?(::Rails) && ::Rails.respond_to?(:root) && ::Rails.root
    ::Rails.root
  else
    Pathname.new(Dir.pwd)
  end
end

.ghost_classes(root: default_root) ⇒ Object

Returns an array of unused class name strings.



24
25
26
 
# File 'lib/rails/css_unused.rb', line 24

def ghost_classes(root: default_root)
  Report.new(root: root).ghost_classes.map(&:class_name)
end

.report(root: default_root, output: $stdout) ⇒ Object

Prints a full report to output (default: $stdout). Returns the exit code (0 = clean, 1 = ghosts found + fail_on_unused).



19
20
21
 
# File 'lib/rails/css_unused.rb', line 19

def report(root: default_root, output: $stdout)
  Report.new(root: root, output: output).print_summary
end

.reset_configuration! ⇒ Object 



92
93
94
 
# File 'lib/rails/css_unused/configuration.rb', line 92

def reset_configuration!
  @configuration = nil
end