Class: FlogCLI

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/flog_cli.rb

Overview

This is the CLI interface for Flog, responsible for processing options, finding files, loading plugins, and reporting results.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ FlogCLI

Creates a new Flog instance with options.



175
176
177
 
# File 'lib/flog_cli.rb', line 175

def initialize options = {}
  @flog = Flog.new options
end

Class Method Details

.load_plugins ⇒ Object

Loads all flog plugins. Files must be named “flog/*.rb”.



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
 
# File 'lib/flog_cli.rb', line 42

def self.load_plugins
  # TODO: I think I want to do this more like hoe's plugin system. Generalize?
  loaded, found = {}, {}

  Gem.find_files("flog/*.rb").reverse.each do |path|
    found[File.basename(path, ".rb").intern] = path
  end

  found.each do |name, plugin|
    next if loaded[name]
    begin
      warn "loading #{plugin}" # if $DEBUG
      loaded[name] = load plugin
    rescue LoadError => e
      warn "error loading #{plugin.inspect}: #{e.message}. skipping..."
    end
  end

  self.plugins.merge loaded

  names = Flog.constants.map {|s| s.to_s}.reject {|n| n =~ /^[A-Z_]+$/}

  names.each do |name|
    # next unless Hoe.plugins.include? name.downcase.intern
    mod = Flog.const_get(name)
    next if Class === mod
    warn "extend #{mod}" if $DEBUG
    # self.extend mod
  end
end

.parse_options(args = ARGV, extra_options = {}) ⇒ Object

Parse options in args (defaults to ARGV).



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/flog_cli.rb', line 76

def self.parse_options args = ARGV, extra_options = {}
  option = {
    :quiet    => false,
    :continue => false,
    :parser   => RubyParser,
  }.merge extra_options

  OptionParser.new do |opts|
    opts.separator "Standard options:"

    opts.on("-a", "--all", "Display all flog results, not top 60%.") do
      option[:all] = true
    end

    opts.on("-b", "--blame", "Include blame information for methods.") do
      option[:blame] = true
    end

    opts.on("-c", "--continue", "Continue despite syntax errors.") do
      option[:continue] = true
    end

    opts.on("-d", "--details", "Show method details.") do
      option[:details] = true
    end

    opts.on("-g", "--group", "Group and sort by class.") do
      option[:group] = true
    end

    opts.on("-h", "--help", "Show this message.") do
      puts opts
      exit
    end

    opts.on("-I dir1,dir2,dir3", Array, "Add to LOAD_PATH.") do |dirs|
      dirs.each do |dir|
        $: << dir
      end
    end

    opts.on("-m", "--methods-only", "Skip code outside of methods.") do
      option[:methods] = true
    end

    opts.on("-q", "--quiet", "Don't show parse errors.") do
      option[:quiet] = true
    end

    opts.on("-e", "--extended", "Put file:line on a separate line (for rubymine & friends).") do
      option[:extended] = true
    end

    opts.on("-s", "--score", "Display total score only.") do
      option[:score] = true
    end

    opts.on("-tN", "--threshold=N", Integer, "Set the report cutoff threshold (def: 60%).") do |n|
      option[:threshold] = n / 100.0
    end

    opts.on("-v", "--verbose", "Display progress during processing.") do
      option[:verbose] = true
    end

    next if self.plugins.empty?
    opts.separator "Plugin options:"

    extra = self.method_scores.grep(/parse_options/) - %w(parse_options)

    extra.sort.each do |msg|
      self.send msg, opts, option
    end

  end.parse! Array(args)

  option
end

.plugins ⇒ Object

The known plugins for Flog. See Flog.load_plugins.



158
159
160
 
# File 'lib/flog_cli.rb', line 158

def self.plugins
  @plugins ||= {}
end

.run(args = ARGV, extra = {}) ⇒ Object

This kicks off the whole thing.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/flog_cli.rb', line 23

def self.run args = ARGV, extra = {}
  load_plugins

  expander = PathExpander.new args, "**/*.{rb,rake}"
  files = expander.process

  options = parse_options args, extra

  abort "no files or stdin (-) to process, aborting." if
    files.empty? and args.empty?

  flogger = new options
  flogger.flog(*files)
  flogger.report
end

Instance Method Details

#flog(*files) ⇒ Object

Flog the given files. Deals with “-”, syntax errors, and traversing subdirectories intelligently. Use PathExpander to process dirs into files.



167
168
169
170
 
# File 'lib/flog_cli.rb', line 167

def flog(*files)
  files << "-" if files.empty?
  @flog.flog(*files)
end

#output_details(io, max = nil) ⇒ Object

Output the report up to a given max or report everything, if nil.



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

def output_details io, max = nil
  io.puts

  each_by_score max do |class_method, score, call_list|
    self.print_score io, class_method, score

    if option[:details] then
      call_list.sort_by { |k,v| -v }.each do |call, count|
        io.puts "  %6.1f:   %s" % [count, call]
      end
      io.puts
    end
  end
end

#output_details_grouped(io, threshold = nil) ⇒ Object

Output the report, grouped by class/module, up to a given max or report everything, if nil.



201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/flog_cli.rb', line 201

def output_details_grouped io, threshold = nil
  calculate

  scores.sort_by { |_, n| -n }.each do |klass, total|
    io.puts

    io.puts "%8.1f: %s" % [total, "#{klass} total"]

    method_scores[klass].each do |name, score|
      self.print_score io, name, score
    end
  end
end

#print_score(io, name, score) ⇒ Object

Print out one formatted score.



218
219
220
221
222
223
224
225
226
227
 
# File 'lib/flog_cli.rb', line 218

def print_score io, name, score
  location = method_locations[name]
  if location then
    sep = " "
    sep = "%-11s" % "\n" if option[:extended]
    io.puts "%8.1f: %-32s%s%s" % [score, name, sep, location]
  else
    io.puts "%8.1f: %s" % [score, name]
  end
end

#report(io = $stdout) ⇒ Object

Report results to #io, STDOUT by default.



232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/flog_cli.rb', line 232

def report(io = $stdout)
  io.puts "%8.1f: %s" % [total_score, "flog total"]
  io.puts "%8.1f: %s" % [average, "flog/method average"]

  return if option[:score]

  if option[:group] then
    output_details_grouped io, threshold
  else
    output_details io, threshold
  end
ensure
  self.reset
end