Class: Compass::Commands::ProjectStats

Inherits:
UpdateProject show all
Defined in:
lib/compass/commands/project_stats.rb

Instance Attribute Summary

Attributes inherited from ProjectBase

#options, #project_name

Attributes inherited from Base

#options, #working_path

Attributes included from Actions

#logger

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateProject

#dry_run?, #new_compiler_instance

Methods inherited from ProjectBase

#execute

Methods inherited from Base

#execute, register

Methods included from Actions

#basename, #compile, #copy, #directory, #process_erb, #relativize, #remove, #separate, #strip_trailing_separator, #write_file

Constructor Details

#initialize(working_path, options) ⇒ ProjectStats 



26
27
28
29
 
# File 'lib/compass/commands/project_stats.rb', line 26

def initialize(working_path, options)
  super
  assert_project_directory_exists!
end

Class Method Details

.description(command) ⇒ Object 



135
136
137
 
# File 'lib/compass/commands/project_stats.rb', line 135

def description(command)
  "Report statistics about your stylesheets"
end

.option_parser(arguments) ⇒ Object 



124
125
126
127
128
129
 
# File 'lib/compass/commands/project_stats.rb', line 124

def option_parser(arguments)
  parser = Compass::Exec::CommandOptionParser.new(arguments)
  parser.extend(Compass::Exec::GlobalOptionsParser)
  parser.extend(Compass::Exec::ProjectOptionsParser)
  parser.extend(StatsOptionsParser)
end

.parse!(arguments) ⇒ Object 



141
142
143
144
145
146
 
# File 'lib/compass/commands/project_stats.rb', line 141

def parse!(arguments)
  parser = option_parser(arguments)
  parser.parse!
  parse_arguments!(parser, arguments)
  parser.options
end

.parse_arguments!(parser, arguments) ⇒ Object 



148
149
150
151
152
153
154
155
156
 
# File 'lib/compass/commands/project_stats.rb', line 148

def parse_arguments!(parser, arguments)
  if arguments.size == 1
    parser.options[:project_name] = arguments.shift
  elsif arguments.size == 0
    # default to the current directory.
  else
    raise Compass::Error, "Too many arguments were specified."
  end
end

.primary ⇒ Object 



139
 
# File 'lib/compass/commands/project_stats.rb', line 139

def primary; false; end

.usage ⇒ Object 



131
132
133
 
# File 'lib/compass/commands/project_stats.rb', line 131

def usage
  option_parser([]).to_s
end

Instance Method Details

#css_columns(css_file) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/compass/commands/project_stats.rb', line 107

def css_columns(css_file)
  if File.exists?(css_file)
    cf = Compass::Stats::CssFile.new(css_file)
    cf.analyze!
    %w(selector_count prop_count).map do |t|
      cf.send(t).to_s
    end
  else
    return [ '--', '--' ]
  end
rescue LoadError
  @missing_css_parser = true
  return [ 'DISABLED', 'DISABLED' ]
end

#filename_columns(sass_file) ⇒ Object 



94
95
96
97
 
# File 'lib/compass/commands/project_stats.rb', line 94

def filename_columns(sass_file)
  filename = Compass.deprojectize(sass_file, working_path)
  [filename]
end

#pad(c, max, options = {}) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/compass/commands/project_stats.rb', line 69

def pad(c, max, options = {})
  options[:align] ||= :left
  if c == :-
    filler = '-'
    c = ''
  else
    filler = ' '
  end
  spaces = max - c.size
  filled = filler * [spaces,0].max
  "#{options[:left]}#{filled if options[:align] == :right}#{c}#{filled if options[:align] == :left}#{options[:right]}"
end

#perform ⇒ Object 



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
 
# File 'lib/compass/commands/project_stats.rb', line 31

def perform
  super
  require 'compass/stats'
  compiler = new_compiler_instance
  sass_files = sorted_sass_files(compiler)
  rows       = [[           :-,           :-,           :-,            :-,            :-,            :-,               :- ],
                [   'Filename',      'Rules', 'Properties', 'Mixins Defs', 'Mixins Used',   'CSS Rules', 'CSS Properties' ],
                [           :-,           :-,           :-,            :-,            :-,            :-,               :- ]]
  maximums   =  [            8,            5,           10,            14,            11,             9,               14 ]
  alignments =  [        :left,       :right,       :right,        :right,        :right,        :right,           :right ]
  delimiters =  [ ['| ', ' |'],  [' ', ' |'],  [' ', ' |'],   [' ', ' |'],   [' ', ' |'],   [' ', ' |'],      [' ', ' |'] ]
  totals     =  [ "Total (#{sass_files.size} files):", 0, 0,            0,             0,             0,                0 ]

  sass_files.each do |sass_file|
    css_file = compiler.corresponding_css_file(sass_file) unless sass_file[0..0] == '_'
    row = filename_columns(sass_file)
    row += sass_columns(sass_file)
    row += css_columns(css_file)
    row.each_with_index do |c, i|
      maximums[i] = [maximums[i].to_i, c.size].max
      totals[i] = totals[i] + c.to_i if i > 0
    end
    rows << row
  end
  rows << [:-] * 7
  rows << totals.map{|t| t.to_s}
  rows << [:-] * 7
  rows.each do |row|
    row.each_with_index do |col, i|
      print pad(col, maximums[i], :align => alignments[i], :left => delimiters[i].first, :right => delimiters[i].last)
    end
    print "\n"
  end
  if @missing_css_parser
    puts "\nInstall css_parser to enable stats on your css files:\n\n\tgem install css_parser"
  end
end

#sass_columns(sass_file) ⇒ Object 



99
100
101
102
103
104
105
 
# File 'lib/compass/commands/project_stats.rb', line 99

def sass_columns(sass_file)
  sf = Compass::Stats::SassFile.new(sass_file)
  sf.analyze!
  %w(rule_count prop_count mixin_def_count mixin_count).map do |t|
    sf.send(t).to_s
  end
end

#sorted_sass_files(compiler) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/compass/commands/project_stats.rb', line 82

def sorted_sass_files(compiler)
  sass_files = compiler.sass_files(:exclude_partials => false)
  sass_files.map! do |s| 
    filename = Compass.deprojectize(s, File.join(Compass.configuration.project_path, Compass.configuration.sass_dir))
    [s, File.dirname(filename), File.basename(filename)]
  end
  sass_files = sass_files.sort_by do |s,d,f|
    File.join(d, f[0] == ?_ ? f[1..-1] : f)
  end
  sass_files.map!{|s,d,f| s}
end