metric_fu 4.11.1 → 4.13.0

data/lib/metric_fu/formatter/yaml.rb

@@ -5,7 +5,7 @@ module MetricFu
 
       DEFAULT_PATH = "report.yml"
 
-      def initialize(opts={})
+      def initialize(opts = {})
         @options = opts
         @path_or_io = @options[:output] || DEFAULT_PATH
       end

data/lib/metric_fu/gem_run.rb

@@ -1,20 +1,19 @@
 # encoding: utf-8
-require 'open3'
-require 'shellwords'
-require 'metric_fu'
-MetricFu.lib_require { 'logger' }
-MetricFu.lib_require { 'gem_version' }
+require "open3"
+require "shellwords"
+require "metric_fu"
+MetricFu.lib_require { "logger" }
+MetricFu.lib_require { "gem_version" }
 module MetricFu
   class GemRun
-
     attr_reader :output, :gem_name, :library_name, :version, :arguments
-    def initialize(arguments={})
+    def initialize(arguments = {})
       @gem_name    = arguments.fetch(:gem_name)
       @library_name = arguments.fetch(:metric_name)
       @version = arguments.fetch(:version) { MetricFu::GemVersion.for(library_name) }
       args = arguments.fetch(:args)
       @arguments = args.respond_to?(:scan) ? Shellwords.shellwords(args) : args
-      @output = ''
+      @output = ""
       @errors = []
     end
 
@@ -28,10 +27,10 @@ module MetricFu
 
     def execute
       mf_debug "Running #{summary}"
-      captured_output = ''
-      captured_errors = ''
-      thread = ''
-      Open3.popen3("#{library_name}", *arguments) do |stdin, stdout, stderr, wait_thr|
+      captured_output = ""
+      captured_errors = ""
+      thread = ""
+      Open3.popen3("#{library_name}", *arguments) do |_stdin, stdout, stderr, wait_thr|
         captured_output << stdout.read.chomp
         captured_errors << stderr.read.chomp
         thread = wait_thr
@@ -52,8 +51,8 @@ module MetricFu
     def handle_system_exit(system_exit)
       status =  system_exit.success? ? "SUCCESS" : "FAILURE"
       message = "#{status} with code #{system_exit.status}: " <<
-        "#{system_exit.message}: #{system_exit.backtrace.inspect}"
-      if status == 'SUCCESS'
+                "#{system_exit.message}: #{system_exit.backtrace.inspect}"
+      if status == "SUCCESS"
         mf_debug message
       else
         @errors << message
@@ -67,6 +66,5 @@ module MetricFu
         STDERR.puts "\t" << error
       end
     end
-
   end
 end

data/lib/metric_fu/gem_version.rb

@@ -1,5 +1,5 @@
 # coding: utf-8
-require 'rubygems'
+require "rubygems"
 module MetricFu
   class GemVersion
     # regexp from https://github.com/gemnasium/gemnasium-parser/blob/807d7ccc/lib/gemnasium/parser/patterns.rb#L11
@@ -12,15 +12,14 @@ module MetricFu
     REQUIREMENT_LIST = /(?<qr1>["'])(?<req1>#{REQUIREMENT})\k<qr1>(?:[ \t]*,[ \t]*(?<qr2>["'])(?<req2>#{REQUIREMENT})\k<qr2>)?/
     REQUIREMENTS = /(?:#{REQUIREMENT_LIST}|\[[ \t]*#{REQUIREMENT_LIST}[ \t]*\])/
     COMMENT = /(#[^\n]*)?/
-    ADD_DEPENDENCY_CALL = /^[ \t]*\w+\.add(?<type>_runtime|_development)?_dependency\(?[ \t]*#{QUOTED_GEM_NAME}(?:[ \t]*,[ \t]*#{REQUIREMENTS})?[ \t]*\)?[ \t]*#{COMMENT}$/
-
+    ADD_DEPENDENCY_CALL = /^[ \t]*\w+\.add(?<type>_runtime|_development)?_dependency\(?[ \t]*#{QUOTED_GEM_NAME}(.freeze)?(?:[ \t]*,[ \t]*#{REQUIREMENTS})?[ \t]*\)?[ \t]*#{COMMENT}$/
 
     def initialize
-      @gem_spec = File.open(gemspec, 'rb') {|f| f.readlines }
+      @gem_spec = File.open(gemspec, "rb") { |f| f.readlines }
     end
 
     def gemspec
-      File.join(MetricFu.root_dir, 'metric_fu.gemspec')
+      File.join(MetricFu.root_dir, "metric_fu.gemspec")
     end
 
     def new_dependency(name, version)
@@ -32,10 +31,10 @@ module MetricFu
         begin
           @gem_spec.grep(/add_dependency|add_runtime/).map do |line|
             match = line.match(ADD_DEPENDENCY_CALL)
-            name = match['name'].downcase.sub('metric_fu-', '')
-            version = [match['req1'], match['req2']].compact
+            name = match["name"].downcase.sub("metric_fu-", "")
+            version = [match["req1"], match["req2"]].compact
             new_dependency(name, version)
-          end.compact << new_dependency('rcov', ['~> 0.8'])
+          end.compact << new_dependency("rcov", ["~> 0.8"])
         end
     end
 
@@ -49,7 +48,7 @@ module MetricFu
     end
 
     def unknown_dependency(name)
-      ->{ new_dependency(name, ['>= 0']) }
+      -> { new_dependency(name, [">= 0"]) }
     end
 
     RESOLVER = new
@@ -79,8 +78,8 @@ module MetricFu
       name = gem_dep.name
       version = activated_version(gem_dep.name) || gem_dep.requirements_list
       {
-        'name' => name,
-        'version' => version,
+        "name" => name,
+        "version" => version,
       }
     end
 
@@ -89,6 +88,5 @@ module MetricFu
         dependency_summary(gem_dep)
       end
     end
-
   end
 end

data/lib/metric_fu/generator.rb

@@ -1,6 +1,5 @@
-MetricFu.lib_require { 'utility' }
+MetricFu.lib_require { "utility" }
 module MetricFu
-
   # = Generator
   #
   # The Generator class is an abstract class that provides the
@@ -31,10 +30,9 @@ module MetricFu
   # in general setup the directory structure that the MetricFu system
   # expects.
   class Generator
-
     attr_reader :result, :template, :options
 
-    def initialize(options={})
+    def initialize(options = {})
       @options = options
     end
 
@@ -53,7 +51,7 @@ module MetricFu
     end
 
     def self.get_generator(metric)
-      generators.find{|generator|generator.metric.to_s == metric.to_s.downcase}
+      generators.find { |generator|generator.metric.to_s == metric.to_s.downcase }
     end
 
     def self.inherited(subclass)
@@ -66,7 +64,7 @@ module MetricFu
         MetricFu::Metric.get_metric(metric).run_options[:output_directory] ||
         begin
           metric_directory = MetricFu::Io::FileSystem.scratch_directory(metric)
-          MetricFu::Utility.mkdir_p(metric_directory, :verbose => false)
+          MetricFu::Utility.mkdir_p(metric_directory, verbose: false)
         end
     end
 
@@ -109,7 +107,7 @@ module MetricFu
     end
 
     def round_to_tenths(decimal)
-      decimal = 0.0 if decimal.to_s.eql?('NaN')
+      decimal = 0.0 if decimal.to_s.eql?("NaN")
       (decimal * 10).round / 10.0
     end
 
@@ -126,13 +124,12 @@ module MetricFu
     end
 
     def self.not_implemented
-      raise <<-EOF
+      raise NotImplementedError.new <<-EOF
         Required method #{caller[0]} not implemented in #{__FILE__}.
         This method must be implemented by a concrete class descending
         from Generator.  See generator class documentation for more
         information.
       EOF
     end
-
   end
 end

data/lib/metric_fu/io.rb

@@ -1,16 +1,15 @@
-MetricFu.lib_require { 'utility' }
+MetricFu.lib_require { "utility" }
 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.
-      @default_artifact_dir = 'tmp/metric_fu'
+      @default_artifact_dir = "tmp/metric_fu"
       def self.default_artifact_dir
         @default_artifact_dir
       end
       def self.artifact_dir
-        (ENV['CC_BUILD_ARTIFACTS'] || @artifact_dir)
+        (ENV["CC_BUILD_ARTIFACTS"] || @artifact_dir)
       end
       def self.artifact_dir=(artifact_dir)
         @artifact_dir = artifact_dir
@@ -28,7 +27,7 @@ module MetricFu
       end
 
       def scratch_directory(name)
-        File.join(directory('scratch_directory'), name.to_s)
+        File.join(directory("scratch_directory"), name.to_s)
       end
 
       def file_globs_to_ignore
@@ -37,15 +36,15 @@ module MetricFu
 
       def set_directories
         @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
+        @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
+        @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')
+        @directories["template_directory"] = File.join(@directories.fetch("root_directory"), "lib", "templates")
         @file_globs_to_ignore = []
         set_code_dirs
       end
@@ -60,9 +59,8 @@ module MetricFu
 
       # Add the 'app' directory if we're running within rails.
       def set_code_dirs
-        @directories['code_dirs'] = %w(app lib).select{|dir| Dir.exists?(dir) }
+        @directories["code_dirs"] = %w(app lib).select { |dir| Dir.exist?(dir) }
       end
-
     end
 
     # Writes the output to a file or io stream.
@@ -114,7 +112,7 @@ module MetricFu
     end
 
     def file_for(path, &block)
-      File.open(path_relative_to_base(path), 'w') do |file|
+      File.open(path_relative_to_base(path), "w") do |file|
         block.call(file)
       end
     end
@@ -127,7 +125,7 @@ module MetricFu
     end
 
     def path_relative_to_base(path)
-      pathname = MetricFu.run_path.join(MetricFu::Io::FileSystem.directory('base_directory')) # make full path relative to base directory
+      pathname = MetricFu.run_path.join(MetricFu::Io::FileSystem.directory("base_directory")) # make full path relative to base directory
       pathname.join(path)
     end
   end

data/lib/metric_fu/loader.rb

@@ -9,14 +9,14 @@ module MetricFu
       @loaded_files = []
     end
 
-    def lib_require(base='',&block)
+    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)
+          puts "!!!\tAlready loaded #{file}" if !!(ENV["MF_DEBUG"] =~ /true/i)
         else
           @loaded_files << file
         end
@@ -36,9 +36,9 @@ module MetricFu
       class << klass
         Array(yield).each do |dir|
           define_method("#{dir}_dir") do
-            File.join(lib_dir,dir)
+            File.join(lib_dir, dir)
           end
-          module_eval(%Q(def #{dir}_require(&block); lib_require('#{dir}', &block); end),  __FILE__, __LINE__)
+          module_eval(%(def #{dir}_require(&block); lib_require('#{dir}', &block); end),  __FILE__, __LINE__)
         end
       end
     end
@@ -52,41 +52,41 @@ module MetricFu
     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)
+          define_method("#{dir.gsub(/[^A-Za-z0-9]/, '')}_dir") do
+            File.join(artifact_dir, dir)
           end
         end
       end
     end
 
     def setup
-      MetricFu.lib_require { 'logger' }
-      MetricFu.logger.debug_on = !!(ENV['MF_DEBUG'] =~ /true/i)
+      MetricFu.lib_require { "logger" }
+      MetricFu.logger.debug_on = !!(ENV["MF_DEBUG"] =~ /true/i)
 
       load_metric_configuration
 
-      MetricFu.lib_require       { 'reporter' }
-      MetricFu.reporting_require { 'result' }
+      MetricFu.lib_require       { "reporter" }
+      MetricFu.reporting_require { "result" }
 
-      MetricFu.load_tasks('metric_fu.rake', task_name: 'metrics:all')
+      MetricFu.load_tasks("metric_fu.rake", task_name: "metrics:all")
     end
 
     def load_metric_configuration
-      MetricFu.lib_require { 'configuration' }
+      MetricFu.lib_require { "configuration" }
       load_installed_metrics
       MetricFu.configuration.configure_metrics
       load_user_configuration
     end
 
     def load_installed_metrics
-      MetricFu.lib_require { 'metric' }
-      Dir.glob(File.join(MetricFu.metrics_dir, '**/metric.rb')).each do |metric_config|
+      MetricFu.lib_require { "metric" }
+      Dir.glob(File.join(MetricFu.metrics_dir, "**/metric.rb")).each do |metric_config|
         require metric_config
       end
     end
 
     def load_user_configuration
-      file = File.join(MetricFu.run_dir, '.metrics')
+      file = File.join(MetricFu.run_dir, ".metrics")
       load file if File.exist?(file)
     end
 
@@ -96,11 +96,10 @@ module MetricFu
     # @param tasks_relative_path [String] 'metric_fu.rake' by default
     # @param options [Hash] optional task_name to check if loaded
     # @option options [String] :task_name The task_name to load, if not yet loaded
-    def load_tasks(tasks_relative_path, options={task_name: ''})
+    def load_tasks(tasks_relative_path, options = { task_name: "" })
       if defined?(Rake::Task) and not Rake::Task.task_defined?(options[:task_name])
-        load File.join(@lib_root, 'tasks', *Array(tasks_relative_path))
+        load File.join(@lib_root, "tasks", *Array(tasks_relative_path))
       end
     end
-
   end
 end

data/lib/metric_fu/logger.rb

@@ -1,7 +1,6 @@
-require 'logger'
-require 'forwardable'
+require "logger"
+require "forwardable"
 module MetricFu
-
   def self.logger
     @logger ||= ::MetricFu::Logger.new($stdout)
   end
@@ -13,12 +12,12 @@ module MetricFu
     def initialize(stdout)
       @logger = MfLogger.new(stdout)
       self.debug_on = false
-      self.formatter = ->(severity, time, progname, msg){ "#{msg}\n" }
-      self.level = 'info'
+      self.formatter = ->(_severity, _time, _progname, msg) { "#{msg}\n" }
+      self.level = "info"
     end
 
     def debug_on=(bool)
-      self.level = bool ? 'debug' : 'info'
+      self.level = bool ? "debug" : "info"
     end
 
     def debug_on
@@ -28,12 +27,12 @@ module MetricFu
     def_delegators :@logger, :info, :warn, :error, :fatal, :unknown
 
     LEVELS = {
-      'debug' => MfLogger::DEBUG,
-      'info'  => MfLogger::INFO,
-      'warn'  => MfLogger::WARN,
-      'error' => MfLogger::ERROR,
-      'fatal' => MfLogger::FATAL,
-      'unknown' => MfLogger::UNKNOWN,
+      "debug" => MfLogger::DEBUG,
+      "info"  => MfLogger::INFO,
+      "warn"  => MfLogger::WARN,
+      "error" => MfLogger::ERROR,
+      "fatal" => MfLogger::FATAL,
+      "unknown" => MfLogger::UNKNOWN,
     }
 
     def level=(level)
@@ -45,21 +44,19 @@ module MetricFu
     end
 
     def log(msg)
-      @logger.info '*'*5 + msg.to_s
+      @logger.info "*" * 5 + msg.to_s
     end
 
     def debug(msg)
-      @logger.debug '*'*5 + msg.to_s
+      @logger.debug "*" * 5 + msg.to_s
     end
-
   end
-
 end
 # For backward compatibility
-def mf_debug(msg,&block)
+def mf_debug(msg, &block)
   MetricFu.logger.debug(msg, &block)
 end
 
-def mf_log(msg,&block)
+def mf_log(msg, &block)
   MetricFu.logger.log(msg, &block)
 end

data/lib/metric_fu/logging/mf_debugger.rb

@@ -1,5 +1,5 @@
 warn "MfDebugger if deprecated.  Please use MetricFu.logger"
-MetricFu.lib_require { 'logger' }
+MetricFu.lib_require { "logger" }
 module MfDebugger
   extend self
   class Logger
@@ -9,13 +9,13 @@ module MfDebugger
     end
     def self.debug_on=(bool)
       warn "MfDebugger if deprecated.  Please use MetricFu.logger"
-      MetricFu.logger.level = bool ? 'debug' : 'info'
+      MetricFu.logger.level = bool ? "debug" : "info"
     end
-    def self.log(msg, &block)
+    def self.log(msg, &_block)
       warn "MfDebugger if deprecated.  Please use MetricFu.logger"
       MetricFu.logger.info msg
     end
-    def self.debug(msg, &block)
+    def self.debug(msg, &_block)
       warn "MfDebugger if deprecated.  Please use MetricFu.logger"
       MetricFu.logger.debug msg
     end