Class: MetricFu::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/base/configuration.rb

Overview

Configuration

The Configuration class, as it sounds, provides methods for configuring the behaviour of MetricFu.

Customization for Rails

The Configuration class checks for the presence of a ‘config/environment.rb’ file. If the file is present, it assumes it is running in a Rails project. If it is, it will:

  • Add ‘app’ to the @code_dirs directory to include the code in the app directory in the processing

  • Add :stats to the list of metrics to run to get the Rails stats task

Customization for CruiseControl.rb

The Configuration class checks for the presence of a ‘CC_BUILD_ARTIFACTS’ environment variable. If it’s found it will change the default output directory from the default “tmp/metric_fu to the directory represented by ‘CC_BUILD_ARTIFACTS’

Deprications

The Configuration class checks for several deprecated constants that were previously used to configure MetricFu. These include CHURN_OPTIONS, DIRECTORIES_TO_FLOG, SAIKURO_OPTIONS, and MetricFu::SAIKURO_OPTIONS.

These have been replaced by config.churn, config.flog and config.saikuro respectively.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

:nodoc:#



69
70
71
72
73
 
# File 'lib/base/configuration.rb', line 69

def initialize #:nodoc:#
  reset
  add_attr_accessors_to_self
  add_class_methods_to_metric_fu
end

Class Method Details

.run {|MetricFu.configuration| ... } ⇒ Object

This allows us to have a nice syntax like:

MetricFu.run do |config|
  config.base_directory = 'tmp/metric_fu'
end

See the README for more information on configuration options.

Yields:



107
108
109
 
# File 'lib/base/configuration.rb', line 107

def self.run
  yield MetricFu.configuration
end

Instance Method Details

#add_attr_accessors_to_self ⇒ Object

Searches through the instance variables of the class and creates an attribute accessor on this instance of the Configuration class for each instance variable.



93
94
95
96
97
98
 
# File 'lib/base/configuration.rb', line 93

def add_attr_accessors_to_self
  instance_variables.each do |name|
    method_name = name[1..-1].to_sym
    MetricFu::Configuration.send(:attr_accessor, method_name)
  end
end

#add_class_methods_to_metric_fu ⇒ Object

Searches through the instance variables of the class and creates a class method on the MetricFu module to read the value of the instance variable from the Configuration class.



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/base/configuration.rb', line 78

def add_class_methods_to_metric_fu
  instance_variables.each do |name|
    method_name = name[1..-1].to_sym
    method = <<-EOF
              def self.#{method_name}
                configuration.send(:#{method_name})
              end
    EOF
    MetricFu.module_eval(method)
  end
end

#is_cruise_control_rb? ⇒ Boolean

Returns:

  • (Boolean) 


223
224
225
 
# File 'lib/base/configuration.rb', line 223

def is_cruise_control_rb?
  !!ENV['CC_BUILD_ARTIFACTS']
end

#platform ⇒ Object

:nodoc:



219
220
221
 
# File 'lib/base/configuration.rb', line 219

def platform #:nodoc:
  return RUBY_PLATFORM
end

#rails? ⇒ Boolean

TODO:

This should probably be made a bit more robust.

Perform a simple check to try and guess if we’re running against a rails app.

Returns:

  • (Boolean) 


183
184
185
 
# File 'lib/base/configuration.rb', line 183

def rails?
  @rails = File.exist?("config/environment.rb")
end

#reset ⇒ Object

This does the real work of the Configuration class, by setting up a bunch of instance variables to represent the configuration of the MetricFu app. TODO review if these code is functionally duplicated in the base generator initialize



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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/base/configuration.rb', line 116

def reset
  @base_directory    = (ENV['CC_BUILD_ARTIFACTS'] || 'tmp/metric_fu')
  @scratch_directory = File.join(@base_directory, 'scratch')
  @output_directory  = File.join(@base_directory, 'output')
  @data_directory    = File.join(@base_directory,'_data')
  # due to behavior differences between ruby 1.8.7 and 1.9.3
  # this is good enough for now
  [@base_directory, @scratch_directory, @output_directory].each do |dir|
    FileUtils.mkdir_p dir
  end
  @metric_fu_root_directory = File.join(File.dirname(__FILE__),
                                                    '..', '..')
  @template_directory =  File.join(@metric_fu_root_directory,
                                   'lib', 'templates')
  @template_class = AwesomeTemplate
  set_metrics
  set_graphs
  set_code_dirs
  @flay     = { :dirs_to_flay => @code_dirs,
                :minimum_score => 100,
                :filetypes => ['rb'] }
  @flog     = { :dirs_to_flog => @code_dirs  }
  @reek     = { :dirs_to_reek => @code_dirs,
                :config_file_pattern => nil}
  @roodi    = { :dirs_to_roodi => @code_dirs,
                :roodi_config => nil}
  @saikuro  = { :output_directory => "#{@scratch_directory}/saikuro",
                :input_directory => @code_dirs,
                :cyclo => "",
                :filter_cyclo => "0",
                :warn_cyclo => "5",
                :error_cyclo => "7",
                :formater => "text"}
  @churn    = {}
  @stats    = {}
  @rcov     = { :environment => 'test',
                :test_files => ['test/**/*_test.rb',
                                'spec/spec_helper.rb', # NOTE: ensure it is loaded before the specs
                                'spec/**/*_spec.rb'],
                :rcov_opts => ["--sort coverage",
                               "--no-html",
                               "--text-coverage",
                               "--no-color",
                               "--profile",
                               "--rails",
                               "--exclude /gems/,/Library/,/usr/,spec"],
                :external => nil
              }
  @rails_best_practices = {}
  @hotspots = {}
  @file_globs_to_ignore = []
  @link_prefix = nil


  @verbose = false

  @graph_engine = :bluff # can be :bluff or :gchart

  @darwin_txmt_protocol_no_thanks = true
  # uses the CodeRay gem (was syntax gem)
  @syntax_highlighting = true #Can be set to false to avoid UTF-8 issues with Ruby 1.9.2 and Syntax 1.0
end

#set_code_dirs ⇒ Object

Add the ‘app’ directory if we’re running within rails.



211
212
213
214
215
216
217
 
# File 'lib/base/configuration.rb', line 211

def set_code_dirs
  if rails?
    @code_dirs = ['app', 'lib']
  else
    @code_dirs = ['lib']
  end
end

#set_graphs ⇒ Object 



200
201
202
203
204
205
206
207
208
 
# File 'lib/base/configuration.rb', line 200

def set_graphs
  if rails?
    @graphs = MetricFu::AVAILABLE_GRAPHS + [
      :stats
    ]
  else
    @graphs = MetricFu::AVAILABLE_GRAPHS
  end
end

#set_metrics ⇒ Object

Add the :stats task to the AVAILABLE_METRICS constant if we’re running within rails.



189
190
191
192
193
194
195
196
197
198
 
# File 'lib/base/configuration.rb', line 189

def set_metrics
  if rails?
    @metrics = MetricFu::AVAILABLE_METRICS + [
      :stats,
      :rails_best_practices
    ]
  else
    @metrics = MetricFu::AVAILABLE_METRICS
  end
end