metric_fu 4.3.1 → 4.4.0

data/lib/metric_fu/environment.rb

@@ -0,0 +1,88 @@
+require 'redcard'
+MetricFu.logging_require { 'mf_debugger' }
+module MetricFu
+  module Environment
+
+    # TODO: Set log_level here, instead
+    def verbose
+      MfDebugger::Logger.debug_on
+    end
+
+    def verbose=(toggle)
+      MfDebugger::Logger.debug_on = toggle
+    end
+
+    # Perform a simple check to try and guess if we're running
+    # against a rails app.
+    #
+    # TODO This should probably be made a bit more robust.
+    def rails?
+      @rails ||= begin
+                   exists = File.exist?("config/environment.rb")
+                   def MetricFu.rails?
+                     exists
+                   end
+                   exists
+                 end
+    end
+
+    def is_cruise_control_rb?
+      !!ENV['CC_BUILD_ARTIFACTS']
+    end
+
+    def jruby?
+      @jruby ||= !!RedCard.check(:jruby)
+    end
+
+    def mri?
+      @mri ||= !!RedCard.check(:ruby)
+    end
+
+    def ruby_flavor
+      @ruby_flavor ||= RedCard.engine
+    end
+
+    def ruby_version
+      @ruby_version ||= RedCard.engine_version
+    end
+
+    def ruby18?
+      @ruby18 ||= mri? && !!RedCard.check('1.8'...'1.9')
+    end
+
+    def ruby192?
+      @ruby192 ||= mri? && ruby_version == '1.9.2'
+    end
+
+    def rubinius?
+      @rubinius ||= !!RedCard.check(:rubinius)
+    end
+
+    def supports_ripper?
+      @supports_ripper ||= begin
+                             require 'ripper'
+                             true
+                           rescue LoadError
+                             false
+                           end
+    end
+    def platform #:nodoc:
+      return RUBY_PLATFORM
+    end
+
+    def osx?
+      @osx ||= platform.include?('darwin')
+    end
+
+    def ruby_strangely_makes_accessors_private?
+       ruby192? || jruby?
+    end
+
+    # HACK: for using this module via inclusion in Configuration
+    def self.included(host_class)
+      def host_class.ruby_strangely_makes_accessors_private?
+        @private_accessors ||= allocate.ruby_strangely_makes_accessors_private?
+      end
+    end
+  end
+end

data/lib/metric_fu/formatter.rb

@@ -20,5 +20,28 @@ module MetricFu
 
     end
 
+    module Templates
+      MetricFu.reporting_require { 'templates/awesome/awesome_template' }
+
+      module_function
+
+      def options
+        @options ||= {}
+      end
+      def option(name)
+        options.fetch(name) { raise "No such template option: #{name}" }
+      end
+
+      # TODO: Remove config argument
+      def configure_template(config)
+        @options = {}
+        @options['template_class'] = AwesomeTemplate
+        @options['link_prefix'] = nil
+        @options['darwin_txmt_protocol_no_thanks'] = true
+        # # turning off syntax_highlighting may avoid some UTF-8 issues
+        @options['syntax_highlighting'] = true
+      end
+
+    end
   end
 end

data/lib/metric_fu/formatter/html.rb

@@ -9,12 +9,13 @@ module MetricFu
 
       def finish
         mf_log "** SAVING REPORTS"
-        mf_debug "** SAVING REPORT YAML OUTPUT TO #{MetricFu.base_directory}"
+        mf_debug "** SAVING REPORT YAML OUTPUT TO #{MetricFu::Io::FileSystem.directory('base_directory')}"
         MetricFu::Formatter::YAML.new.finish
 
-        mf_debug "** SAVING REPORT DATA OUTPUT TO #{MetricFu.data_directory}"
+        mf_debug "** SAVING REPORT DATA OUTPUT TO #{MetricFu::Io::FileSystem.directory('data_directory')}"
+        # TODO: Allow customizing output filenames
         MetricFu::Formatter::YAML.new(
-          output: Pathname.pwd.join("#{MetricFu.data_directory}/#{Time.now.strftime("%Y%m%d")}.yml")
+          output: Pathname.pwd.join("#{MetricFu::Io::FileSystem.directory('data_directory')}/#{Time.now.strftime("%Y%m%d")}.yml")
         ).finish
 
         mf_debug "** SAVING TEMPLATIZED REPORT"
@@ -36,7 +37,7 @@ module MetricFu
       protected
 
       def output_directory
-        @output ||= dir_for(@options[:output]) || Pathname.pwd.join(MetricFu.output_directory)
+        @output ||= dir_for(@options[:output]) || Pathname.pwd.join(MetricFu::Io::FileSystem.directory('output_directory'))
       end
 
       # Instantiates a new template class based on the configuration set
@@ -45,7 +46,7 @@ module MetricFu
       # assigns the result_hash to the result_hash in the template, and
       # tells the template to to write itself out.
       def save_templatized_result
-        @template = MetricFu.template_class.new
+        @template = MetricFu::Formatter::Templates.option('template_class').new
         @template.output_directory = self.output_directory
         @template.result = MetricFu.result.result_hash
         @template.per_file_data = MetricFu.result.per_file_data
@@ -56,9 +57,11 @@ module MetricFu
       def save_graphs
         mf_log "** GENERATING GRAPHS"
         mf_debug "** PREPARING TO GRAPH"
-        MetricFu.graphs.each {|graph|
-          mf_debug "** Graphing #{graph} with #{MetricFu.graph_engine}"
-          MetricFu.graph.add(graph, MetricFu.graph_engine, self.output_directory)
+        MetricFu.configuration.graphs.each {|graph|
+          mf_debug "** Graphing #{graph} with #{MetricFu.configuration.graph_engine}"
+          # TODO: This should probably be defined on configuration
+          #   rather than the module. See MetricFu::Graph
+          MetricFu.graph.add(graph, MetricFu.configuration.graph_engine, self.output_directory)
         }
         mf_debug "** GENERATING GRAPH"
         MetricFu.graph.generate
@@ -73,7 +76,7 @@ module MetricFu
       # @return Boolean
       #   Should we open in the browser or not?
       def open_in_browser?
-        MetricFu.configuration.platform.include?('darwin') &&
+        MetricFu.configuration.osx? &&
           ! MetricFu.configuration.is_cruise_control_rb?
       end
 

data/lib/metric_fu/initial_requires.rb

@@ -8,6 +8,7 @@ require 'redcard'
 require 'multi_json'
 
 MetricFu.configure
+MetricFu.lib_require { 'parser_ext' }
 MetricFu.logging_require { 'mf_debugger' }
 include MfDebugger
 MfDebugger::Logger.debug_on = !!(ENV['MF_DEBUG'] =~ /true/i)

data/lib/metric_fu/io.rb

@@ -1,5 +1,64 @@
+require 'fileutils'
 module MetricFu
   module Io
+    # TODO: Move this module / functionality elsewhere and make less verbose
+    module FileSystem
+
+      # TODO: Use a better environmental variable name for the output / artiface dir.  Set to a different default in tests.
+      def self.artifact_dir
+        (ENV['CC_BUILD_ARTIFACTS'] || 'tmp/metric_fu')
+      end
+
+      module_function
+
+      def directories
+        @directories ||= {}
+      end
+
+      def directory(name)
+        directories.fetch(name) { raise "No such directory configured: #{name}" }
+      end
+      def file_globs_to_ignore
+        @file_globs_to_ignore ||= []
+      end
+
+      # TODO: Remove call to config
+      def set_directories(config)
+        @directories = {}
+        @directories['base_directory']    = MetricFu.artifact_dir
+        @directories['scratch_directory'] = MetricFu.scratch_dir
+        @directories['output_directory']  = MetricFu.output_dir
+        @directories['data_directory']    = MetricFu.data_dir
+        create_directories @directories.values
+
+        @directories['root_directory']    = MetricFu.root_dir
+        # TODO Though this is true of the general AwesomeTemplate, it is not necessarily true of templates within each Metric.  Each metric should probably know how to use AwesomeTemplate (or whatever)
+        @directories['template_directory'] = File.join(@directories.fetch('root_directory'), 'lib', 'templates')
+        @file_globs_to_ignore = []
+        set_code_dirs(config)
+      end
+
+      def create_directories(*dirs)
+        # due to behavior differences between ruby 1.8.7 and 1.9.3
+        # this is good enough for now
+        Array(*dirs).each do |dir|
+          FileUtils.mkdir_p dir
+        end
+      end
+
+      # Add the 'app' directory if we're running within rails.
+      def set_code_dirs(config)
+        # TODO: Rather than check if we're running against a rails app,
+        #   shouldn't we just check if the directories exist?
+        if config.rails?
+          @directories['code_dirs'] = %w(app lib)
+        else
+          @directories['code_dirs'] = %w(lib)
+        end
+      end
+
+    end
+
     # Writes the output to a file or io stream.
     # @param output [String, #to_s] the content to write.
     # @param path_or_io [String, #to_s, IO, #write] a file path
@@ -62,7 +121,7 @@ module MetricFu
     end
 
     def path_relative_to_base(path)
-      pathname = Pathname.pwd.join(MetricFu.base_directory) # make full path relative to base directory
+      pathname = Pathname.pwd.join(MetricFu::Io::FileSystem.directory('base_directory')) # make full path relative to base directory
       pathname.join(path)
     end
   end

data/lib/metric_fu/load_files.rb

@@ -6,8 +6,10 @@ MetricFu.metrics_require   { 'graph' }
 MetricFu.reporting_require { 'graphs/grapher' }
 MetricFu.metrics_require   { 'hotspots/analysis/scoring_strategies' }
 
-Dir.glob(File.join(MetricFu.lib_dir, '*.rb')).reject{|file| file =~ /#{__FILE__}/}.each do |file|
-  require file
+Dir.glob(File.join(MetricFu.lib_dir, '*.rb')).
+  reject{|file| file =~ /#{__FILE__}|ext.rb/}.
+  each do |file|
+    require file
 end
 # prevent the task from being run multiple times.
 unless Rake::Task.task_defined? "metrics:all"

data/lib/metric_fu/loader.rb

@@ -0,0 +1,62 @@
+module MetricFu
+  class Loader
+    # TODO: This class mostly serves to clean up the base MetricFu module,
+    #   but needs further work
+
+    attr_reader :loaded_files
+    def initialize(lib_root)
+      @lib_root = lib_root
+      @loaded_files = []
+    end
+
+    def lib_require(base='',&block)
+      paths = []
+      base_path = File.join(@lib_root, base)
+      Array((yield paths, base_path)).each do |path|
+        file = File.join(base_path, *Array(path))
+        require file
+        if @loaded_files.include?(file)
+          puts "!!!\tAlready loaded #{file}" if !!(ENV['MF_DEBUG'] =~ /true/i)
+        else
+          @loaded_files << file
+        end
+      end
+    end
+
+    # TODO: Reduce duplication of directory logic
+    def create_dirs(klass)
+      class << klass
+        Array(yield).each do |dir|
+          define_method("#{dir}_dir") do
+            File.join(lib_dir,dir)
+          end
+          module_eval(%Q(def #{dir}_require(&block); lib_require('#{dir}', &block); end))
+        end
+      end
+    end
+
+    def create_artifact_subdirs(klass)
+      class << klass
+        Array(yield).each do |dir|
+          define_method("#{dir.gsub(/[^A-Za-z0-9]/,'')}_dir") do
+            File.join(artifact_dir,dir)
+          end
+        end
+      end
+    end
+
+    def load_tasks(tasks_relative_path)
+      load File.join(@lib_root, 'tasks', *Array(tasks_relative_path))
+    end
+
+    def setup
+      MetricFu.lib_require { 'configuration' }
+      MetricFu.lib_require { 'metric' }
+      # TODO: consolidate these setup files
+      MetricFu.lib_require { 'initial_requires' }
+      # Load a few things to make our lives easier elsewhere.
+      MetricFu.lib_require { 'load_files' }
+    end
+  end
+end
+

data/lib/metric_fu/metric.rb

@@ -0,0 +1,102 @@
+require 'set'
+# Encapsulates the configuration options for each metric
+module MetricFu
+  class Metric
+
+    attr_accessor :enabled, :activated
+
+    def initialize
+      self.enabled = false
+      @libraries = Set.new
+      @configured_run_options = {}
+    end
+
+    def enable
+      self.enabled = true
+    end
+
+    # TODO: Confirm this catches load errors from requires in subclasses, such as for flog
+    def activate
+      @libraries.each {|library| require(library) }
+      self.activated = true
+    rescue LoadError => e
+      MetricFu.configuration.mf_log("#{name} metric not activated, #{e.message}")
+    end
+
+    # @return metric name [Symbol]
+    def name
+      not_implemented
+    end
+
+    # @return metric run options [Hash]
+    def run_options
+      default_run_options.merge(configured_run_options)
+    end
+
+    def configured_run_options
+      @configured_run_options
+    end
+
+    # @return default metric run options [Hash]
+    def default_run_options
+      not_implemented
+    end
+
+    # @return metric_options [Hash]
+    def has_graph?
+      not_implemented
+    end
+
+    @metrics = []
+    # @return all subclassed metrics [Array<MetricFu::Metric>]
+    # ensure :hotspots runs last
+    def self.metrics
+      @metrics
+    end
+
+    def self.enabled_metrics
+      metrics.select{|metric| metric.enabled && metric.activated}.sort_by {|metric| metric.name  == :hotspots ? 1 : 0 }
+    end
+
+    def self.get_metric(name)
+      metrics.find{|metric|metric.name.to_s == name.to_s}
+    end
+
+    def self.inherited(subclass)
+      @metrics << subclass.new
+    end
+
+    protected
+
+    # Enable using a syntax such as metric.foo = 'foo'
+    #   by catching the missing method here,
+    #   checking if :foo is a key in the default_run_options, and
+    #   setting the key/value in the @configured_run_options hash
+    # TODO: See if we can do this without a method_missing
+    def method_missing(method, *args)
+      key = method_to_attr(method)
+      if default_run_options.has_key?(key)
+        configured_run_options[key] = args.first
+      else
+        raise "#{key} is not a valid configuration option"
+      end
+    end
+
+    # Used above to identify the stem of a setter method
+    def method_to_attr(method)
+      method.to_s.sub(/=$/, '').to_sym
+    end
+
+    private
+
+    def not_implemented
+      raise "Required method #{caller[0]} not implemented in #{__FILE__}"
+    end
+
+    def activate_library(file)
+      @libraries << file.strip
+    end
+
+
+  end
+end

data/lib/metric_fu/metrics/base_template.rb

@@ -14,7 +14,7 @@ module MetricFu
 
 
     def output_directory
-      @output_directory || MetricFu.output_directory
+      @output_directory || MetricFu::Io::FileSystem.directory('output_directory')
     end
 
 
@@ -56,7 +56,9 @@ module MetricFu
     # @return String
     #   A file path
     def template(section)
-      if MetricFu.metrics.include?(section) # expects a symbol
+      # TODO: each MetricFu::Metric should know about its templates
+      #  This class knows too much about the filesystem structure
+      if MetricFu::Metric.enabled_metrics.map(&:name).include?(section) # expects a symbol
         File.join(template_dir(section.to_s), "#{section}.html.erb")
       else
         File.join(template_directory,  section.to_s + ".html.erb")
@@ -156,7 +158,7 @@ module MetricFu
     def file_url(name, line) # :nodoc:
       return '' unless name
       filename = complete_file_path(name)
-      link_prefix = MetricFu.configuration.link_prefix
+      link_prefix = MetricFu::Formatter::Templates.option('link_prefix')
       if link_prefix
         "#{link_prefix}/#{name.gsub(/:.*$/, '')}"
       elsif render_as_txmt_protocol?
@@ -176,14 +178,18 @@ module MetricFu
       filename.gsub(/^\//, '')
     end
     def render_as_txmt_protocol? # :nodoc:
-      config = MetricFu.configuration
-      return false unless config.platform.include?('darwin')
-      return !config.darwin_txmt_protocol_no_thanks
+      if MetricFu.configuration.osx?
+        !MetricFu::Formatter::Templates.option('darwin_txmt_protocol_no_thanks')
+      else
+        false
+      end
     end
     def render_as_mvim_protocol? # :nodoc:
-      config = MetricFu.configuration
-      return false unless config.platform.include?('darwin')
-      return !config.darwin_mvim_protocol_no_thanks
+      if MetricFu.configuration.osx?
+        !MetricFu::Formatter::Templates.option('darwin_mvim_protocol_no_thanks')
+      else
+        false
+      end
     end
 
     # Provides a brain dead way to cycle between two values during