metric_fu 4.11.1 → 4.13.0

data/gem_tasks/build.rake

@@ -1,6 +1,7 @@
 # encoding: utf-8
 require 'rubygems'
 require 'digest/sha2'
+require 'rake/tasklib'
 # require 'bundler/gem_helper'
 # Bundler::GemHelper.install_tasks
 

data/gem_tasks/rubocop.rake

@@ -0,0 +1,10 @@
+if ENV["FULL_BUILD"] != "true" # skip on Travis
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.patterns = ["lib", "spec"]
+    task.formatters = ["progress"]
+    task.options = ["--display-cop-names"]
+    task.fail_on_error = false
+    task.verbose = false
+  end
+end

data/gem_tasks/yard.rake

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+begin
+  require "yard"
+rescue LoadError
+else
+namespace :yard do
+  YARD::Rake::YardocTask.new(:doc) do |t|
+    t.stats_options = ["--list-undoc"]
+  end
+
+  desc "start a gem server"
+  task :server do
+    sh "bundle exec yard server --gems"
+  end
+
+  desc "use Graphviz to generate dot graph"
+  task :graph do
+    output_file = "doc/erd.dot"
+    sh "bundle exec yard graph --protected --full --dependencies > #{output_file}"
+    puts "open doc/erd.dot if you have graphviz installed"
+  end
+end
+end

data/lib/metric_fu.rb

@@ -1,10 +1,10 @@
 # coding: utf-8
-require 'metric_fu/version'
-require 'forwardable'
-require 'pathname'
+require "metric_fu/version"
+require "forwardable"
+require "pathname"
 module MetricFu
-  APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__),'..'))
-  LIB_ROOT = File.join(APP_ROOT,'lib/metric_fu')
+  APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+  LIB_ROOT = File.join(APP_ROOT, "lib/metric_fu")
 
   module_function
 
@@ -13,11 +13,20 @@ module MetricFu
   end
 
   def metric_url
-    'https://github.com/metricfu/metric_fu'
+    "https://github.com/metricfu/metric_fu"
   end
 
   def metric_name
-    'MetricFu'
+    "MetricFu"
+  end
+
+  def with_run_dir(dir, &block)
+    old_dir = run_dir
+    self.run_dir = dir
+
+    block.call
+
+    self.run_dir = old_dir
   end
 
   def run_dir
@@ -71,11 +80,12 @@ module MetricFu
   def root_dir
     APP_ROOT
   end
+
   def lib_dir
     LIB_ROOT
   end
 
-  require 'metric_fu/loader'
+  require "metric_fu/loader"
   LOADER = MetricFu::Loader.new(LIB_ROOT)
   def loader
     LOADER
@@ -94,7 +104,7 @@ module MetricFu
 
   # @note artifact_dir is relative to where the task is being run,
   #   not to the metric_fu library
-  require 'metric_fu/io'
+  require "metric_fu/io"
   def artifact_dir
     MetricFu::Io::FileSystem.artifact_dir
   end
@@ -121,6 +131,7 @@ module MetricFu
   def run(options)
     MetricFu::Run.new.run(options)
   end
+
   def run_only(metrics_to_run_names, options)
     metrics_to_run_names = Array(metrics_to_run_names).map(&:to_s)
     MetricFu::Configuration.run do |config|

data/lib/metric_fu/calculate.rb

@@ -6,6 +6,5 @@ module MetricFu
       return 0 if total.zero?
       (Float(num) / Float(total) * 100).round
     end
-
   end
 end

data/lib/metric_fu/cli/client.rb

@@ -1,17 +1,18 @@
-require 'metric_fu'
-require 'metric_fu/cli/helper'
-require 'metric_fu/cli/parser'
+require "metric_fu"
+require "metric_fu/cli/helper"
+require "metric_fu/cli/parser"
 module MetricFu
   module Cli
     class Client
-
       def initialize
         @helper = MetricFu::Cli::Helper.new
       end
+
       def shutdown
         @helper.shutdown
       end
-      def run(argv=ARGV.dup)
+
+      def run(argv = ARGV.dup)
         options =  @helper.process_options(argv)
         mf_debug "Got options #{options.inspect}"
         if options[:run]
@@ -20,7 +21,6 @@ module MetricFu
           STDOUT.puts @helper.usage
         end
       end
-
     end
   end
 end

data/lib/metric_fu/cli/helper.rb

@@ -1,6 +1,6 @@
-require 'metric_fu'
-require 'metric_fu/cli/parser'
-MetricFu.lib_require { 'run' }
+require "metric_fu"
+require "metric_fu/cli/parser"
+MetricFu.lib_require { "run" }
 # see https://github.com/grosser/pru/blob/master/bin/pru
 module MetricFu
   module Cli
@@ -14,54 +14,63 @@ module MetricFu
       def initialize
         @metric_fu = MetricFu::Run.new
       end
-      def run(options={})
+
+      def run(options = {})
         @metric_fu.run(options)
         complete
       end
+
       def version
         MetricFu::VERSION
       end
+
       def shutdown
         out "\nShutting down. Bye"
         MetricFu::Cli.immediate_shutdown!
       end
+
       def banner
         "MetricFu: A Fistful of code metrics"
       end
+
       def usage
         <<-EOS
         #{banner}
         Use --help for help
         EOS
       end
+
       def executable_name
-        'metric_fu'
+        "metric_fu"
       end
 
       def metrics
         MetricFu::Metric.metrics.map(&:name).sort_by(&:to_s)
       end
 
-      def process_options(argv=[])
+      def process_options(argv = [])
         options = MetricFu::Cli::MicroOptParse::Parser.new do |p|
-            p.banner = self.banner
-            p.version = self.version
-            p.option :run, "Run all metrics with defaults", :default => true
-            metrics.each do |metric|
-              p.option metric.to_sym, "Enables or disables #{metric.to_s}", :default => true #, :value_in_set => [true, false]
-            end
-            p.option :open, "Open report in browser (if supported by formatter)", :default => true
+          p.banner = banner
+          p.version = version
+          p.option :run, "Run all metrics with defaults", default: true
+          metrics.each do |metric|
+            p.option metric.to_sym, "Enables or disables #{metric}", default: true # , :value_in_set => [true, false]
+          end
+          p.option :open, "Open report in browser (if supported by formatter)", default: true
         end.process!(argv)
         options
       end
 
       private
+
       def out(text)
         STDOUT.puts text
       end
+
       def error(text)
         STDERR.puts text
       end
+
       def complete
         out "all done"
         MetricFu::Cli.complete!

data/lib/metric_fu/cli/parser.rb

@@ -1,4 +1,4 @@
-require 'optparse'
+require "optparse"
 module MetricFu
   module Cli
     # see https://github.com/florianpilz/CLI-Option-Parser-Examples
@@ -22,7 +22,6 @@ module MetricFu
           @options << [name, desc, settings]
         end
 
-
         private
 
         def build_option_parser
@@ -51,9 +50,9 @@ module MetricFu
           add_output_option(p)
 
           p.banner = @banner unless @banner.nil?
-          p.on_tail("-h", "--help", "Show this message") {puts p ; success!}
+          p.on_tail("-h", "--help", "Show this message") { puts p; success! }
           short = @used_short.include?("v") ? "-V" : "-v"
-          p.on_tail(short, "--version", "Print version") {puts @version ; success!} unless @version.nil?
+          p.on_tail(short, "--version", "Print version") { puts @version; success! } unless @version.nil?
           p.on_tail("--debug-info", "Print debug info") { debug_info; success! }
           @default_values = @result.clone # save default values to reset @result in subsequent calls
         end
@@ -70,21 +69,21 @@ module MetricFu
           klass = o[2][:default].class == Fixnum ? Integer : o[2][:default].class
 
           if [TrueClass, FalseClass, NilClass].include?(klass) # boolean switch
-            p.on("-" << short, "--[no-]" << o[0].to_s.gsub("_", "-"), o[1]) {|x| @result[o[0]] = x}
+            p.on("-" << short, "--[no-]" << o[0].to_s.gsub("_", "-"), o[1]) { |x| @result[o[0]] = x }
           else # argument with parameter
-            p.on("-" << short, "--" << o[0].to_s.gsub("_", "-") << " " << o[2][:default].to_s, klass, o[1]) {|x| @result[o[0]] = x}
+            p.on("-" << short, "--" << o[0].to_s.gsub("_", "-") << " " << o[2][:default].to_s, klass, o[1]) { |x| @result[o[0]] = x }
           end
         end
 
         def add_output_option(p)
           p.on("--out FILE|DIR",
-              "Specify the file or directory to use for output",
-              "This option applies to the previously",
-              "specified --format, or the default format",
-              "if no format is specified. Paths are relative to",
-              "#{MetricFu.run_path.join(MetricFu::Io::FileSystem.directory('base_directory'))}",
-              "Check the specific formatter\'s docs to see",
-              "whether to pass a file or a dir.") do |o|
+               "Specify the file or directory to use for output",
+               "This option applies to the previously",
+               "specified --format, or the default format",
+               "if no format is specified. Paths are relative to",
+               "#{MetricFu.run_path.join(MetricFu::Io::FileSystem.directory('base_directory'))}",
+               "Check the specific formatter\'s docs to see",
+               "whether to pass a file or a dir.") do |o|
             @result[:format] ||= MetricFu::Formatter::DEFAULT
             @result[:format].last << o
           end
@@ -111,7 +110,7 @@ module MetricFu
 
         def debug_info
           extend(MetricFu::Environment)
-          require 'pp'
+          require "pp"
           pp debug_info
         end
 
@@ -124,7 +123,7 @@ module MetricFu
         #    "   <key>  : <description>."
         def format_descriptions
           formats = MetricFu::Formatter::BUILTIN_FORMATS
-          max = formats.keys.map{|s| s.length}.max
+          max = formats.keys.map(&:length).max
           formats.keys.sort.map do |key|
             "  #{key}#{' ' * (max - key.length)} : #{formats[key][1]}"
           end
@@ -133,10 +132,7 @@ module MetricFu
         def success!
           MetricFu::Cli.complete!
         end
-
-
       end
     end
-
   end
 end

data/lib/metric_fu/configuration.rb

@@ -1,6 +1,5 @@
-MetricFu.lib_require { 'logger' }
+MetricFu.lib_require { "logger" }
 module MetricFu
-
   # Even though the below class methods are defined on the MetricFu module
   # They are included here as they deal with configuration
 
@@ -12,9 +11,7 @@ module MetricFu
   end
 
   def self.configure
-    configuration.tap do |config|
-      config.configure_metrics
-    end
+    configuration.tap(&:configure_metrics)
   end
 
   # = Configuration
@@ -51,10 +48,10 @@ module MetricFu
   #   config.configure_formatter(MyCustomFormatter)
   #
   class Configuration
-    require_relative 'environment'
-    require_relative 'io'
-    require_relative 'formatter'
-    require_relative 'templates/configuration'
+    require_relative "environment"
+    require_relative "io"
+    require_relative "formatter"
+    require_relative "templates/configuration"
 
     # TODO: Remove need to include the module
     include MetricFu::Environment
@@ -122,7 +119,7 @@ module MetricFu
     # @return [Array<Symbol>] names of enabled metrics with graphs
     def graphed_metrics
       # TODO: This is a common enough need to be pushed into MetricFu::Metric as :enabled_metrics_with_graphs
-      MetricFu::Metric.enabled_metrics.select{|metric|metric.has_graph?}.map(&:name)
+      MetricFu::Metric.enabled_metrics.select(&:has_graph?).map(&:name)
     end
 
     def configure_graph_engine(graph_engine)
@@ -149,6 +146,5 @@ module MetricFu
     def templates_option(option)
       @templates_configuration.option(option)
     end
-
   end
 end

data/lib/metric_fu/constantize.rb

@@ -4,7 +4,7 @@ module MetricFu
     # https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflector/methods.rb#L220
     def constantize(camel_cased_word)
       tries ||= 2
-      names = camel_cased_word.split('::')
+      names = camel_cased_word.split("::")
       names.shift if names.empty? || names.first.empty?
 
       names.inject(Object) do |constant, name|
@@ -46,9 +46,9 @@ module MetricFu
     # https://github.com/rails/rails/blob/51cd6bb829c418c5fbf75de1dfbb177233b1b154/activesupport/lib/active_support/inflector/methods.rb#L88
     def underscore(camel_cased_word)
       word = camel_cased_word.to_s.dup
-      word.gsub!(/::/, '/')
-      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.gsub!(/::/, "/")
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
       word.tr!("-", "_")
       word.downcase!
       word

data/lib/metric_fu/data_structures/line_numbers.rb

@@ -1,4 +1,4 @@
-MetricFu.data_structures_require { 'sexp_node' }
+MetricFu.data_structures_require { "sexp_node" }
 module MetricFu
   class LineNumbers
     attr_reader :file_path
@@ -7,7 +7,7 @@ module MetricFu
     # Used by metrics that don't provide line numbers for class, module, or methods problems
     # @param contents [String] a string of ruby code
     # @param file_path [String] the file path for the contents, defaults to empty string
-    def initialize(contents,file_path='')
+    def initialize(contents, file_path = "")
       @file_path = file_path
       @locations = {}
       if contents.to_s.size.zero?
@@ -30,8 +30,8 @@ module MetricFu
     #   If a location is found, return the method name (first element)
     #   Else return :no_method_at_line
     def method_at_line(line_number)
-      default_proc = ->{ [:no_method_at_line] }
-      @locations.detect(default_proc) do |method_name, line_number_range|
+      default_proc = -> { [:no_method_at_line] }
+      @locations.detect(default_proc) do |_method_name, line_number_range|
         line_number_range.include?(line_number)
       end.first
     end
@@ -49,7 +49,7 @@ module MetricFu
       file_sexp = MetricFu::SexpNode.parse(contents)
       file_sexp && process_ast(file_sexp)
     rescue => e
-      #catch errors for files ruby_parser fails on
+      # catch errors for files ruby_parser fails on
       mf_log "RUBY PARSE FAILURE: #{e.class}\t#{e.message}\tFILE:#{file_path}\tSEXP:#{file_sexp.inspect}\n\tCONTENT:#{contents.inspect}\n\t#{e.backtrace}"
     end
 
@@ -65,8 +65,8 @@ module MetricFu
       else
         mf_debug "SEXP: Parsing line numbers for classes in sexp type #{node.node_type.inspect}"
         mf_debug "      in #{file_path}"
-        node.each_module {|child_node| process_class(child_node) }
-        node.each_class  {|child_node| process_class(child_node) }
+        node.each_module { |child_node| process_class(child_node) }
+        node.each_class  { |child_node| process_class(child_node) }
       end
     end
 
@@ -79,11 +79,11 @@ module MetricFu
       process_class(module_node)
     end
 
-    def process_class(class_node, module_name=nil)
+    def process_class(class_node, module_name = nil)
       class_name = class_node.name
       process_singleton_methods(class_node, class_name)
-      process_instance_methods( class_node, class_name, module_name)
-      process_class_methods(    class_node, class_name, module_name)
+      process_instance_methods(class_node, class_name, module_name)
+      process_class_methods(class_node, class_name, module_name)
     end
 
     def process_singleton_methods(class_node, class_name)
@@ -108,6 +108,5 @@ module MetricFu
         @locations[class_method_name] = class_method_node.line_range
       end
     end
-
   end
 end