Module: MetricFu

Defined in:
lib/metric_fu.rb,
lib/base/graph.rb,
lib/base/report.rb,
lib/base/generator.rb,
lib/graphs/grapher.rb,
lib/generators/flay.rb,
lib/generators/flog.rb,
lib/generators/rcov.rb,
lib/generators/reek.rb,
lib/base/md5_tracker.rb,
lib/generators/churn.rb,
lib/generators/roodi.rb,
lib/generators/stats.rb,
lib/metric_fu/railtie.rb,
lib/base/base_template.rb,
lib/base/configuration.rb,
lib/generators/saikuro.rb,
lib/graphs/flay_grapher.rb,
lib/graphs/flog_grapher.rb,
lib/graphs/rcov_grapher.rb,
lib/graphs/reek_grapher.rb,
lib/graphs/engines/bluff.rb,
lib/graphs/roodi_grapher.rb,
lib/graphs/stats_grapher.rb,
lib/graphs/engines/gchart.rb,
lib/graphs/rails_best_practices_grapher.rb

Overview

Load a few things to make our lives easier elsewhere.

Defined Under Namespace

Modules: GchartGrapher Classes: Churn, Configuration, Flay, FlayBluffGrapher, FlayGchartGrapher, FlayGrapher, Flog, FlogBluffGrapher, FlogGchartGrapher, FlogGrapher, Generator, Graph, Grapher, MD5Tracker, RailsBestPracticesGrapher, Railtie, Rcov, RcovBluffGrapher, RcovGchartGrapher, RcovGrapher, Reek, ReekBluffGrapher, ReekGchartGrapher, ReekGrapher, Report, Roodi, RoodiBluffGrapher, RoodiGchartGrapher, RoodiGrapher, Saikuro, Stats, StatsBluffGrapher, StatsGrapher, Template

Constant Summary collapse

LIB_ROOT =
File.dirname(__FILE__)
AVAILABLE_METRICS =

A list of metrics which are available in the MetricFu system.

These are metrics which have been developed for the system. Of course, in order to use these metrics, their respective gems must be installed on the system.

[:churn, :flog, :flay, :reek, 
:roodi, :saikuro, :rcov]
AVAILABLE_GRAPHS =
[:flog, :flay, :reek, :roodi, :rcov]
AVAILABLE_GRAPH_ENGINES =
[:gchart, :bluff]
GRAPH_PERIOD =

Only graph 30 days worth of data by default

30

Class Method Summary collapse

Class Method Details

.configurationObject

The @@configuration class variable holds a global type configuration object for any parts of the system to use.


18
19
20
# File 'lib/base/configuration.rb', line 18

def self.configuration
  @@configuration ||= Configuration.new
end

.graphObject


3
4
5
# File 'lib/base/graph.rb', line 3

def self.graph
  @graph ||= Graph.new
end

.reportObject

MetricFu.report memoizes access to a Report object, that will be used throughout the lifecycle of the MetricFu app.


5
6
7
# File 'lib/base/report.rb', line 5

def self.report
  @report ||= Report.new
end