code_metric_fu 4.14.0

data/lib/metric_fu.rb

@@ -0,0 +1,143 @@
+# coding: utf-8
+require "metric_fu/version"
+require "forwardable"
+require "pathname"
+require 'pry-byebug'
+module MetricFu
+  APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+  LIB_ROOT = File.join(APP_ROOT, "lib/metric_fu")
+
+  module_function
+
+  def root
+    @app_root ||= Pathname(APP_ROOT)
+  end
+
+  def metric_url
+    "https://github.com/metricfu/metric_fu"
+  end
+
+  def metric_name
+    "MetricFu"
+  end
+
+  def run_dir
+    @run_dir ||= Dir.pwd
+  end
+
+  def run_path
+    Pathname(run_dir)
+  end
+
+  def run_dir=(run_dir)
+    @run_dir = run_dir
+  end
+
+  def report_name
+    @report_name || self.report_name = run_path.basename.to_s
+  end
+
+  def report_name=(report_name)
+    @report_name = report_name
+  end
+
+  # The time at analyzed code state
+  def report_time
+    Time.now
+  end
+
+  def report_date_string
+    report_time.strftime("%Y%m%d")
+  end
+
+  # @return [String]
+  # @example '20140323'
+  # Used to uniquely identify reports
+  # as a sortable reference to when the report
+  # was generated
+  def report_id
+    report_date_string
+  end
+
+  # Non-date-specific; Used to uniquely identify a report run
+  def report_fingerprint
+    report_time.to_i.to_s
+  end
+
+  # The time the metrics are generated
+  def current_time
+    Time.now.localtime
+  end
+
+  def root_dir
+    APP_ROOT
+  end
+
+  def lib_dir
+    LIB_ROOT
+  end
+
+  require "metric_fu/loader"
+  LOADER = MetricFu::Loader.new(LIB_ROOT)
+  def loader
+    LOADER
+  end
+  extend SingleForwardable
+
+  def_delegators :loader, :lib_require, :load_tasks
+
+  def library_dirs
+    %w(metrics formatter reporting logging errors data_structures tasks)
+  end
+
+  loader.create_dirs(self) do
+    library_dirs
+  end
+
+  # @note artifact_dir is relative to where the task is being run,
+  #   not to the metric_fu library
+  require "metric_fu/io"
+  def artifact_dir
+    MetricFu::Io::FileSystem.artifact_dir
+  end
+
+  def artifact_subdirs
+    %w(scratch output _data)
+  end
+
+  loader.create_artifact_subdirs(self) do
+    artifact_subdirs
+  end
+
+  loader.setup
+
+  def reset
+    # TODO Don't like how this method needs to know
+    # all of these class variables that are defined
+    # in separate classes.
+    @configuration = nil
+    @graph = nil
+    @result = nil
+  end
+
+  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|
+      config.configure_metrics.each do |metric|
+        metric_name = metric.name.to_s
+        if metrics_to_run_names.include?(metric_name)
+          p "Enabling #{metric_name}"
+          metric.enabled = true
+        else
+          p "Disabling #{metric_name}"
+          metric.enabled = false
+        end
+      end
+    end
+    run(options)
+  end
+end

data/metric_fu.gemspec

@@ -0,0 +1,72 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "metric_fu/version"
+
+Gem::Specification.new do |s|
+  s.name        = "code_metric_fu"
+  s.homepage    = "https://github.com/rainchen/code_metric_fu"
+  s.summary     = "A fistful of code metrics, with awesome templates and graphs(forked metric_fu)"
+  s.description = "Code metrics from Flog, Flay, Saikuro, Churn, Reek, Roodi, Code Statistics, and Rails Best Practices. (and optionally RCov)"
+  s.email       = "github@benjaminfleischer.com"
+  author_file   = File.expand_path("AUTHORS", File.dirname(__FILE__))
+  s.authors     = File.readlines(author_file, encoding: Encoding::UTF_8).map(&:strip)
+
+  # used with gem i metric_fu -P HighSecurity
+  s.cert_chain  = ["certs/bf4.pem"]
+  # Sign gem when evaluating spec with `gem` command
+  #  unless ENV has set a SKIP_GEM_SIGNING
+  if ($0 =~ /gem\z/) and not ENV.include?("SKIP_GEM_SIGNING")
+    s.signing_key = File.join(Gem.user_home, ".ssh", "gem-private_key.pem")
+  end
+
+  s.rubyforge_project           = "metric_fu"
+  s.license                     = "MIT"
+  s.platform                    = Gem::Platform::RUBY
+  s.version                     = MetricFu::VERSION
+  s.required_ruby_version       = ">= 1.9.0"
+  s.required_rubygems_version   = ">= 1.3.6"
+
+  tracked_files = `git ls-files`.split($\)
+  excluded_dirs = %r{\Aetc}
+  files         = tracked_files.reject { |file| file[excluded_dirs] }
+  test_files    = files.grep(%r{^(test|spec|features)/})
+  executables   = files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  s.files                       = files
+  s.test_files                  = test_files
+  s.executables                 = executables
+  s.default_executable          = "metric_fu"
+  s.require_paths               = ["lib"]
+
+  s.has_rdoc                    = true
+  s.extra_rdoc_files            = ["HISTORY.md", "CONTRIBUTING.md", "TODO.md", "MIT-LICENSE"]
+  s.rdoc_options                = ["--main", "README.md"]
+
+  # metric dependencies
+  s.add_runtime_dependency "flay",                  [">= 2.0.1",  "~> 2.1"]
+  s.add_runtime_dependency "churn",                 ["~> 0.0.35"]
+  s.add_runtime_dependency "flog",                  [">= 4.1.1",  "~> 4.1"]
+  s.add_runtime_dependency "reek",                  [">= 1.3.4",  "< 5.0"]
+  s.add_runtime_dependency "cane",                  [">= 2.5.2",  "~> 2.5"]
+  s.add_runtime_dependency "rails_best_practices",  [">= 1.14.3", "~> 1.14"]
+  s.add_runtime_dependency "metric_fu-Saikuro",     [">= 1.1.3",  "~> 1.1"]
+  s.add_runtime_dependency "roodi",                 ["~> 5.0.0"]
+  s.add_runtime_dependency "code_metrics",          ["~> 0.1"]
+
+  # other dependencies
+  # ruby version identification
+  s.add_runtime_dependency "redcard"
+  # syntax highlighting
+  s.add_runtime_dependency "coderay"
+  # to_json support
+  s.add_runtime_dependency "multi_json"
+  # open browser support
+  s.add_runtime_dependency "launchy", "~> 2.0"
+
+  s.add_development_dependency "pry-byebug", '~> 3.4'
+  s.add_development_dependency "rspec", "~> 3.1"
+  # temporary filesystem to act on
+  s.add_development_dependency "test_construct"
+  # ensure we have a JSON parser
+  s.add_development_dependency "json"
+  s.add_development_dependency "simplecov", "~> 0.9"
+end

data/spec/capture_warnings.rb

@@ -0,0 +1,55 @@
+# https://raw.githubusercontent.com/metric_fu/metric_fu/master/spec/capture_warnings.rb
+require "rubygems" if RUBY_VERSION =~ /^1\.8/
+require "bundler/setup"
+require "rspec/core"
+require "rspec/expectations"
+require "tempfile"
+require "fileutils"
+
+stderr_file = Tempfile.new("app.stderr")
+app_root ||= Dir.pwd
+output_dir = File.join(app_root, "tmp")
+FileUtils.mkdir_p(output_dir)
+bundle_dir = File.join(app_root, "bundle")
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    $stderr.reopen(stderr_file.path)
+    $VERBOSE = true
+  end
+
+  config.after(:suite) do
+    stderr_file.rewind
+    lines = stderr_file.read.split("\n").uniq
+    stderr_file.close!
+
+    $stderr.reopen(STDERR)
+
+    app_warnings, other_warnings = lines.partition { |line|
+      line.include?(app_root) && !line.include?(bundle_dir)
+    }
+
+    if app_warnings.any?
+      puts <<-WARNINGS
+#{'-' * 30} app warnings: #{'-' * 30}
+
+#{app_warnings.join("\n")}
+
+#{'-' * 75}
+      WARNINGS
+    end
+
+    if other_warnings.any?
+      output_file = File.join(output_dir, "warnings.txt")
+      File.write(output_file, other_warnings.join("\n") << "\n")
+      puts
+      puts "Non-app warnings written to tmp/warnings.txt"
+      puts
+    end
+
+    # fail the build...
+    if app_warnings.any?
+      abort "Failing build due to app warnings: #{app_warnings.inspect}"
+    end
+  end
+end

data/spec/cli/helper_spec.rb

@@ -0,0 +1,165 @@
+require "spec_helper"
+require "metric_fu/cli/helper"
+MetricFu.configuration.configure_metric(:rcov) do |rcov|
+  rcov.enabled = true
+end
+MetricFu.configure
+
+describe MetricFu::Cli::Helper do
+  describe "defaults" do
+    let(:helper)  { MetricFu::Cli::Helper.new }
+    let(:defaults) { helper.process_options }
+
+    context "on every Ruby version" do
+      it "opens the report in a browser" do
+        expect(defaults[:open]).to be_truthy
+      end
+
+      it "enables Flay" do
+        expect(defaults[:flay]).to be_truthy
+      end
+
+      it "enables Reek" do
+        expect(defaults[:reek]).to be_truthy
+      end
+
+      it "enables Hotspots" do
+        expect(defaults[:hotspots]).to be_truthy
+      end
+
+      it "enables Churn" do
+        expect(defaults[:churn]).to be_truthy
+      end
+
+      it "enables Saikuro" do
+        expect(defaults[:saikuro]).to be_truthy
+      end
+
+      if MetricFu.configuration.mri?
+        it "enables Flog" do
+          !expect(defaults[:flog]).to be_truthy
+        end
+
+        it "enables Cane" do
+          expect(defaults[:cane]).to be_truthy
+        end
+      end
+
+      it "enables RCov" do
+        expect(defaults[:rcov]).to be_truthy
+      end
+
+      it "runs by default" do
+        expect(defaults[:run]).to be_truthy
+      end
+    end
+
+    if MetricFu.configuration.mri?
+
+      it "enables Rails Best Practices" do
+        expect(defaults[:rails_best_practices]).to be_truthy
+      end
+
+    end
+  end
+
+  describe ".parse" do
+    let(:helper)  { MetricFu::Cli::Helper.new }
+
+    it "turns open in browser off" do
+      expect(helper.process_options(["--no-open"])[:open]).to be_falsey
+    end
+
+    it "turns open in browser on" do
+      expect(helper.process_options(["--open"])[:open]).to be_truthy
+    end
+
+    it "turns saikuro off" do
+      expect(helper.process_options(["--no-saikuro"])[:saikuro]).to be_falsey
+    end
+
+    it "turns saikuro on" do
+      expect(helper.process_options(["--saikuro"])[:saikuro]).to be_truthy
+    end
+
+    it "turns churn off" do
+      expect(helper.process_options(["--no-churn"])[:churn]).to be_falsey
+    end
+
+    it "turns churn on" do
+      expect(helper.process_options(["--churn"])[:churn]).to be_truthy
+    end
+
+    it "turns flay off" do
+      expect(helper.process_options(["--no-flay"])[:flay]).to be_falsey
+    end
+
+    it "turns flay on" do
+      expect(helper.process_options(["--flay"])[:flay]).to be_truthy
+    end
+
+    if MetricFu.configuration.mri?
+
+      it "turns flog off" do
+        expect(helper.process_options(["--no-flog"])[:flog]).to be_falsey
+      end
+
+      it "turns flog on" do
+        expect(helper.process_options(["--flog"])[:flog]).to be_truthy
+      end
+
+      it "turns cane off" do
+        expect(helper.process_options(["--no-cane"])[:cane]).to be_falsey
+      end
+
+      it "turns cane on" do
+        expect(helper.process_options(["--cane"])[:cane]).to be_truthy
+      end
+
+    end
+
+    it "turns hotspots off" do
+      expect(helper.process_options(["--no-hotspots"])[:hotspots]).to be_falsey
+    end
+
+    it "turns hotspots on" do
+      expect(helper.process_options(["--hotspots"])[:hotspots]).to be_truthy
+    end
+
+    it "turns rcov off" do
+      expect(helper.process_options(["--no-rcov"])[:rcov]).to be_falsey
+    end
+
+    it "turns rcov on" do
+      expect(helper.process_options(["--rcov"])[:rcov]).to be_truthy
+    end
+
+    it "turns reek off" do
+      expect(helper.process_options(["--no-reek"])[:reek]).to be_falsey
+    end
+
+    it "turns reek on" do
+      expect(helper.process_options(["--reek"])[:reek]).to be_truthy
+    end
+
+    it "turns roodi off" do
+      expect(helper.process_options(["--no-roodi"])[:roodi]).to be_falsey
+    end
+
+    it "turns roodi on" do
+      expect(helper.process_options(["--roodi"])[:roodi]).to be_truthy
+    end
+
+    context "given a single format" do
+      it "sets the format" do
+        expect(helper.process_options(["--format", "json"])[:format]).to eq([["json"]])
+      end
+    end
+
+    context "given multiple formats" do
+      it "sets multiple formats" do
+        expect(helper.process_options(["--format", "json", "--format", "yaml"])[:format]).to eq([["json"], ["yaml"]])
+      end
+    end
+  end
+end

data/spec/dummy/.gitignore

@@ -0,0 +1 @@
+tmp

data/spec/dummy/.metrics

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+# For testing that this file gets loaded
+$metric_file_loaded = true

data/spec/dummy/lib/bad_encoding.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+class SomeClass
+  def initialize(_a, _b, _c)
+    "hey, invalid ASCII\xED"
+  end
+end