metric_fu 4.11.3 → 4.11.4

data/lib/metric_fu/data_structures/sexp_node.rb

@@ -1,4 +1,4 @@
-require 'ruby_parser'
+require "ruby_parser"
 module MetricFu
   SexpNode = Struct.new(:sexp) do
     # @return file_sexp
@@ -9,66 +9,83 @@ module MetricFu
     def nil?
       sexp.nil?
     end
+
     def node_type
       sexp[0]
     end
+
     def name
       sexp[1]
     end
-    def each_of_type(type,node_class=SexpNode)
+
+    def each_of_type(type, node_class = SexpNode)
       sexp.each_of_type(type) do |child_sexp|
         yield node_class.new(child_sexp)
       end
     end
+
     def each_module(&block)
-      each_of_type(:module,&block)
+      each_of_type(:module, &block)
     end
+
     def each_class(&block)
-      each_of_type(:class,&block)
+      each_of_type(:class, &block)
     end
+
     def each_singleton_class(&block)
-      each_of_type(:sclass,SingletonMethodNode,&block)
+      each_of_type(:sclass, SingletonMethodNode, &block)
     end
+
     def each_instance_method(&block)
-      each_of_type(:defn,InstanceMethodNode,&block)
+      each_of_type(:defn, InstanceMethodNode, &block)
     end
+
     def each_class_method(&block)
-      each_of_type(:defs,ClassMethodNode,&block)
+      each_of_type(:defs, ClassMethodNode, &block)
     end
+
     def first_line
       sexp.line
     end
+
     def last_line
       sexp.last.line
     end
+
     def line_range
       (first_line..last_line)
     end
+
     def hide_methods_from_next_round
       sexp.find_and_replace_all(:defn, :ignore_me)
       sexp.find_and_replace_all(:defs, :ignore_me)
     end
-    def full_method_name(method_separator, class_name, module_name=nil)
+
+    def full_method_name(method_separator, class_name, module_name = nil)
       [module_namespace(module_name), class_name, method_separator, name].join
     end
-    def module_namespace(module_name=nil)
+
+    def module_namespace(module_name = nil)
       if module_name.nil?
         nil
       else
-        [module_name,class_method_separator].join
+        [module_name, class_method_separator].join
       end
     end
+
     def instance_method_separator
-      '#'
+      "#"
     end
+
     def class_method_separator
-      '::'
+      "::"
     end
   end
   class ClassMethodNode < SexpNode
     def name
       sexp[2]
     end
+
     def full_name(module_name, class_name)
       full_method_name(class_method_separator, class_name, module_name)
     end
@@ -82,8 +99,9 @@ module MetricFu
     def full_name(class_name)
       full_method_name(class_method_separator, class_name)
     end
+
     def each_singleton_method(&block)
-      each_of_type(:defn,SingletonMethodNode,&block)
+      each_of_type(:defn, SingletonMethodNode, &block)
     end
   end
 end

data/lib/metric_fu/environment.rb

@@ -1,9 +1,8 @@
-require 'redcard'
-require 'rbconfig'
-MetricFu.lib_require { 'logger' }
+require "redcard"
+require "rbconfig"
+MetricFu.lib_require { "logger" }
 module MetricFu
   module Environment
-
     # TODO: Set log_level here, instead
     def verbose
       MetricFu.logger.debug_on
@@ -28,7 +27,7 @@ module MetricFu
     end
 
     def is_cruise_control_rb?
-      !!ENV['CC_BUILD_ARTIFACTS']
+      !!ENV["CC_BUILD_ARTIFACTS"]
     end
 
     def jruby?
@@ -48,11 +47,11 @@ module MetricFu
     end
 
     def ruby18?
-      @ruby18 ||= mri? && !!RedCard.check('1.8'...'1.9')
+      @ruby18 ||= mri? && !!RedCard.check("1.8"..."1.9")
     end
 
     def ruby192?
-      @ruby192 ||= mri? && ruby_version == '1.9.2'
+      @ruby192 ||= mri? && ruby_version == "1.9.2"
     end
 
     def rubinius?
@@ -61,7 +60,7 @@ module MetricFu
 
     def supports_ripper?
       @supports_ripper ||= begin
-                             require 'ripper'
+                             require "ripper"
                              true
                            rescue LoadError
                              false
@@ -69,7 +68,7 @@ module MetricFu
     end
 
     def platform #:nodoc:
-      return RUBY_PLATFORM
+      RUBY_PLATFORM
     end
 
     def version
@@ -78,12 +77,12 @@ module MetricFu
 
     def environment_details
       @environment_details ||= {
-        'VERBOSE' => $VERBOSE.inspect,
-        'External Encoding' => Encoding.default_external.to_s,
-        'Internal Encoding' => Encoding.default_internal.to_s,
-        'Host Architecture' => RbConfig::CONFIG['build'],
-        'Ruby Prefix'       => RbConfig::CONFIG['prefix'],
-        'Ruby Options'      => ENV.keys.grep(/RUBYOPT/).map{|key| "#{key}=#{ENV[key]}" }.join(', '),
+        "VERBOSE" => $VERBOSE.inspect,
+        "External Encoding" => Encoding.default_external.to_s,
+        "Internal Encoding" => Encoding.default_internal.to_s,
+        "Host Architecture" => RbConfig::CONFIG["build"],
+        "Ruby Prefix"       => RbConfig::CONFIG["prefix"],
+        "Ruby Options"      => ENV.keys.grep(/RUBYOPT/).map { |key| "#{key}=#{ENV[key]}" }.join(", "),
       }
     end
 
@@ -92,40 +91,39 @@ module MetricFu
     # $LOAD_PATH
     def ruby_details
       @ruby_details ||= {
-        'Engine' => ruby_flavor,
-        'Version' => ruby_version,
-        'Patchlevel' => (defined?(RUBY_PATCHLEVEL) && RUBY_PATCHLEVEL),
-        'Ripper Support' => supports_ripper?,
-        'Rubygems Version' => Gem::VERSION,
-        'Long Description' => (defined?(RUBY_DESCRIPTION) ? RUBY_DESCRIPTION : platform),
+        "Engine" => ruby_flavor,
+        "Version" => ruby_version,
+        "Patchlevel" => (defined?(RUBY_PATCHLEVEL) && RUBY_PATCHLEVEL),
+        "Ripper Support" => supports_ripper?,
+        "Rubygems Version" => Gem::VERSION,
+        "Long Description" => (defined?(RUBY_DESCRIPTION) ? RUBY_DESCRIPTION : platform),
       }
     end
 
     def library_details
       @library_details ||= {
-        'Version' =>  version,
-        'Verbose Mode' => verbose,
-        'Enabled Metrics' => MetricFu::Metric.enabled_metrics.map(&:name),
-        'Dependencies' => MetricFu::GemVersion.dependencies_summary,
+        "Version" =>  version,
+        "Verbose Mode" => verbose,
+        "Enabled Metrics" => MetricFu::Metric.enabled_metrics.map(&:name),
+        "Dependencies" => MetricFu::GemVersion.dependencies_summary,
       }
     end
 
     def debug_info
       @debug_info ||= {
-        'Ruby' => ruby_details,
-        'Environment' => environment_details,
-        'MetricFu' => library_details,
+        "Ruby" => ruby_details,
+        "Environment" => environment_details,
+        "MetricFu" => library_details,
       }
     end
 
     def osx?
-      @osx ||= platform.include?('darwin')
+      @osx ||= platform.include?("darwin")
     end
 
     def ruby_strangely_makes_accessors_private?
-       @private_accessors ||= ruby192? || jruby?
+      @private_accessors ||= ruby192? || jruby?
     end
     module_function :ruby_strangely_makes_accessors_private?
-
   end
 end

data/lib/metric_fu/formatter.rb

@@ -1,9 +1,9 @@
-require 'metric_fu/constantize'
+require "metric_fu/constantize"
 module MetricFu
   module Formatter
     BUILTIN_FORMATS = {
-      'html' => ['MetricFu::Formatter::HTML', 'Generates a templated HTML report using the configured template class and graph engine.'],
-      'yaml' => ['MetricFu::Formatter::YAML', 'Generates the raw output as yaml']
+      "html" => ["MetricFu::Formatter::HTML", "Generates a templated HTML report using the configured template class and graph engine."],
+      "yaml" => ["MetricFu::Formatter::YAML", "Generates the raw output as yaml"]
     }
     DEFAULT = [[:html]]
 
@@ -17,11 +17,10 @@ module MetricFu
           constantize(format.to_s)
         end
       end
-
     end
 
     module Templates
-      MetricFu.lib_require { 'templates/metrics_template' }
+      MetricFu.lib_require { "templates/metrics_template" }
 
       module_function
 
@@ -36,7 +35,6 @@ module MetricFu
       def templates_configuration
         @templates_configuration ||= MetricFu::Templates::Configuration.new
       end
-
     end
   end
 end

data/lib/metric_fu/formatter/html.rb

@@ -1,12 +1,12 @@
-require 'launchy'
-MetricFu.formatter_require { 'yaml' }
-MetricFu.reporting_require { 'graphs/graph' }
+require "launchy"
+MetricFu.formatter_require { "yaml" }
+MetricFu.reporting_require { "graphs/graph" }
 module MetricFu
   module Formatter
     class HTML
       include MetricFu::Io
 
-      def initialize(opts={})
+      def initialize(opts = {})
         @options = opts
       end
 
@@ -27,20 +27,20 @@ module MetricFu
       end
 
       def write_template(output, file)
-        write_output(output, "#{self.output_directory}/#{file}")
+        write_output(output, "#{output_directory}/#{file}")
       end
 
       def display_results
         if self.open_in_browser?
-          mf_debug "** OPENING IN BROWSER FROM #{self.output_directory}"
-          self.show_in_browser(self.output_directory)
+          mf_debug "** OPENING IN BROWSER FROM #{output_directory}"
+          show_in_browser(output_directory)
         end
       end
 
       protected
 
       def output_directory
-        @output ||= dir_for(@options[:output]) || MetricFu.run_path.join(MetricFu::Io::FileSystem.directory('output_directory'))
+        @output ||= dir_for(@options[:output]) || MetricFu.run_path.join(MetricFu::Io::FileSystem.directory("output_directory"))
       end
 
       # Instantiates a new template class based on the configuration set
@@ -49,8 +49,8 @@ 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::Formatter::Templates.option('template_class').new
-        @template.output_directory = self.output_directory
+        @template = MetricFu::Formatter::Templates.option("template_class").new
+        @template.output_directory = output_directory
         @template.result = MetricFu.result.result_hash
         @template.per_file_data = MetricFu.result.per_file_data
         @template.formatter = self
@@ -64,7 +64,7 @@ module MetricFu
           mf_debug "** Graphing #{graphed_metric} with #{MetricFu.configuration.graph_engine}"
           # TODO: This should probably be defined on configuration
           #   rather than the module. See MetricFu::Graph
-          MetricFu.graph.add(graphed_metric, MetricFu.configuration.graph_engine, self.output_directory)
+          MetricFu.graph.add(graphed_metric, MetricFu.configuration.graph_engine, output_directory)
         }
         mf_debug "** GENERATING GRAPH"
         MetricFu.graph.generate
@@ -78,7 +78,7 @@ module MetricFu
       # @return Boolean
       #   Should we open in the browser or not?
       def open_in_browser?
-        ! MetricFu.configuration.is_cruise_control_rb?
+        !MetricFu.configuration.is_cruise_control_rb?
       end
 
       # Shows 'index.html' from the passed directory in the browser
@@ -88,7 +88,7 @@ module MetricFu
       #   The directory path where the 'index.html' we want to open is
       #   stored
       def show_in_browser(dir)
-        uri = URI.join(URI.escape("file://#{dir}/"), 'index.html')
+        uri = URI.join(URI.escape("file://#{dir}/"), "index.html")
         Launchy.open(uri) if open_in_browser?
       end
     end

data/lib/metric_fu/formatter/syntax.rb

@@ -1,5 +1,5 @@
-require 'coderay'
-MetricFu.lib_require { 'utility' }
+require "coderay"
+MetricFu.lib_require { "utility" }
 # CodeRay options
 # used to analyze source code, because object Tokens is a list of tokens with specified types.
 # :tab_width – tabulation width in spaces. Default: 8
@@ -15,10 +15,9 @@ MetricFu.lib_require { 'utility' }
 module MetricFu
   module Formatter
     class Syntax
-
       def initialize
-        @options = { :css => :class, :style => :alpha }
-        @line_number_options = {:line_numbers => :inline, :line_number_start => 0 }
+        @options = { css: :class, style: :alpha }
+        @line_number_options = { line_numbers: :inline, line_number_start: 0 }
       end
 
       def highlight(ruby_text, line_number)
@@ -29,7 +28,7 @@ module MetricFu
       def highlight_options(line_number)
         line_number = line_number.to_i
         if line_number > 0
-          @options.merge(@line_number_options.merge(:line_number_start => line_number))
+          @options.merge(@line_number_options.merge(line_number_start: line_number))
         else
           @options
         end
@@ -41,7 +40,6 @@ module MetricFu
         ascii_text = MetricFu::Utility.clean_ascii_text(ruby_text)
         tokens = CodeRay.scan(ascii_text, :ruby)
       end
-
     end
   end
 end

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