hexx-suit 0.0.1

data/spec/tests/lib/install_spec.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+describe Hexx::Suit::Install, :sandbox do
+
+  describe ".start" do
+
+    before { try_in_sandbox { described_class.start } }
+
+    it "creates necessary files" do
+      %w(
+        .rspec
+        .yardopts
+        Guardfile
+        Rakefile
+        config/metrics/cane.yml
+        config/metrics/churn.yml
+        config/metrics/flay.yml
+        config/metrics/metric_fu.yml
+        config/metrics/pippi.yml
+        config/metrics/reek.yml
+        config/metrics/roodi.yml
+        config/metrics/rubocop.yml
+        config/metrics/saikuro.yml
+        config/metrics/simplecov.yml
+        config/metrics/yardstick.yml
+        config/metrics/STYLEGUIDE
+      ).each { |file| expect(file).to be_present_in_sandbox }
+    end
+
+    it "adds Hexx::Suit tasks loader to Rakefile" do
+      expect(read_in_sandbox "Rakefile").to include "Hexx::Suit.install_tasks"
+    end
+  end
+end

data/spec/tests/lib/metrics/metric_fu/cane_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require "spec_helper"
+require "metric_fu"
+
+describe Hexx::Suit::Metrics::MetricFu::Cane, :sandbox do
+
+  let(:config) do
+    ::MetricFu::Configuration.configure_metric(:cane) do |metric|
+      metric.instance_eval { @configured_run_options || {} }
+    end
+  end
+
+  let(:settings) do
+    {
+      "abc_max"      => "10",
+      "line_length"  => "80",
+      "no_doc"       => "y",
+      "no_readme"    => "y"
+    }
+  end
+
+  describe ".load" do
+
+    before  { prepare_settings settings, "config/metrics/cane.yml" }
+    subject { try_in_sandbox { described_class.load } }
+
+    it "configures the metric from cane.yml" do
+      subject
+      settings.each { |key, value| expect(config[key.to_sym]).to eq value }
+    end
+  end
+end

data/spec/tests/lib/metrics/metric_fu/churn_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require "spec_helper"
+require "metric_fu"
+
+describe Hexx::Suit::Metrics::MetricFu::Churn, :sandbox do
+
+  let(:config) do
+    ::MetricFu::Configuration.configure_metric(:churn) do |metric|
+      metric.instance_eval { @configured_run_options || {} }
+    end
+  end
+
+  let(:settings) do
+    {
+      "ignore_files"        => %w(spec),
+      "minimum_churn_count" => "1",
+      "start_date"          => "6 months ago"
+    }
+  end
+
+  describe ".load" do
+
+    before  { prepare_settings settings, "config/metrics/churn.yml" }
+    subject { try_in_sandbox { described_class.load } }
+
+    it "configures the metric from churn.yml" do
+      subject
+      settings.each { |key, value| expect(config[key.to_sym]).to eq value }
+    end
+  end
+end

data/spec/tests/lib/metrics/metric_fu/flay_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require "spec_helper"
+require "metric_fu"
+
+describe Hexx::Suit::Metrics::MetricFu::Flay, :sandbox do
+
+  let(:config) do
+    ::MetricFu::Configuration.configure_metric(:flay) do |metric|
+      metric.instance_eval { @configured_run_options || {} }
+    end
+  end
+
+  let(:settings) do
+    { "minimum_score" => "10" }
+  end
+
+  describe ".load" do
+
+    before  { prepare_settings settings, "config/metrics/flay.yml" }
+    subject { try_in_sandbox { described_class.load } }
+
+    it "configures the metric from flay.yml" do
+      subject
+      settings.each { |key, value| expect(config[key.to_sym]).to eq value }
+    end
+  end
+end

data/spec/tests/lib/metrics/metric_fu/reek_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require "spec_helper"
+require "metric_fu"
+
+describe Hexx::Suit::Metrics::MetricFu::Reek, :sandbox do
+
+  let(:config) do
+    ::MetricFu::Configuration.configure_metric(:reek) do |metric|
+      metric.instance_eval { @configured_run_options || {} }
+    end
+  end
+
+  describe ".load" do
+
+    subject { try_in_sandbox { described_class.load } }
+
+    it "configures the metric from reek.yml" do
+      subject
+      expect(config[:config_file_pattern]).to eq "config/metrics/reek.yml"
+    end
+  end
+end

data/spec/tests/lib/metrics/metric_fu/roodi_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require "spec_helper"
+require "metric_fu"
+
+describe Hexx::Suit::Metrics::MetricFu::Roodi, :sandbox do
+
+  let(:config) do
+    ::MetricFu::Configuration.configure_metric(:roodi) do |metric|
+      metric.instance_eval { @configured_run_options || {} }
+    end
+  end
+
+  describe ".load" do
+
+    subject { try_in_sandbox { described_class.load } }
+
+    it "configures the metric from roodi.yml" do
+      subject
+      expect(config[:roodi_config]).to eq "config/metrics/roodi.yml"
+    end
+  end
+end

data/spec/tests/lib/metrics/metric_fu/saikuro_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require "spec_helper"
+require "metric_fu"
+
+describe Hexx::Suit::Metrics::MetricFu::Saikuro, :sandbox do
+
+  let(:config) do
+    ::MetricFu::Configuration.configure_metric(:saikuro) do |metric|
+      metric.instance_eval { @configured_run_options || {} }
+    end
+  end
+
+  let(:settings) do
+    {
+      "warn_cyclo"  => "3",
+      "error_cyclo" => "5"
+    }
+  end
+
+  describe ".load" do
+
+    before  { prepare_settings settings, "config/metrics/saikuro.yml" }
+    subject { try_in_sandbox { described_class.load } }
+
+    it "configures the metric from saikuro.yml" do
+      subject
+      settings.each { |key, value| expect(config[key.to_sym]).to eq value }
+    end
+  end
+end

data/spec/tests/lib/metrics/metric_fu_spec.rb

@@ -0,0 +1,181 @@
+# encoding: utf-8
+require "spec_helper"
+require "metric_fu"
+
+describe Hexx::Suit::Metrics::MetricFu, :sandbox do
+
+  shared_context "without metric_fu.yml" do
+
+    let(:options) do
+      {
+        "folders" => %(lib app),
+        "format"  => "html",
+        "metrics" => %w(cane churn flay flog reek roodi saikuro),
+        "output"  => "tmp/metric_fu",
+        "verbose" => false
+      }
+    end
+  end
+
+  shared_context "with metric_fu.yml" do
+
+    let(:options) do
+      {
+        "folders" => %(custom),
+        "format"  => "yaml",
+        "metrics" => %w(hotspots stats),
+        "output"  => "custom",
+        "verbose" => true
+      }
+    end
+
+    before { prepare_settings options, "config/metrics/metric_fu.yml" }
+  end
+
+  shared_examples "environment setter" do
+
+    before { ENV["METRIC_FU_OUTPUT"] = nil }
+
+    it "[sets METRIC_FU_OUTPUT]" do
+      expect { subject }
+        .to change { ENV["METRIC_FU_OUTPUT"] }
+        .to options["output"]
+    end
+  end
+
+  shared_examples "verbose setter" do
+
+    before { subject }
+
+    it "[sets verbose from options]" do
+      ::MetricFu::Configuration.run do |config|
+        expect(config.verbose).to eq options["verbose"]
+      end
+    end
+  end
+
+  shared_examples "metrics selector" do
+
+    def enabled?(name)
+      ::MetricFu::Configuration.configure_metric(name.to_sym) do |metric|
+        metric.instance_eval { @enabled }
+      end
+    end
+
+    let(:metrics) do
+      %w(
+        cane churn flay flog hotspots rails_best_practices rcov reek roodi
+        saikuro stats
+      )
+    end
+    let(:allowed_metrics)  { options["metrics"]         }
+    let(:disabled_metrics) { metrics - allowed_metrics  }
+
+    before { subject }
+
+    it "[enables allowed metrics]" do
+      allowed_metrics.each { |name| expect(enabled? name).to be_truthy }
+    end
+
+    it "[disables other metrics]" do
+      disabled_metrics.each { |name| expect(enabled? name).to be_falsey }
+    end
+  end
+
+  shared_examples "folders setter" do
+
+    def run_options(name)
+      ::MetricFu::Configuration.configure_metric(name.to_sym) do |metric|
+        metric.instance_eval { @configured_run_options || {} }
+      end
+    end
+
+    let(:folders) { options["folders"] }
+
+    before { subject }
+
+    it "[sets cane folders]" do
+      expect(run_options(:cane)[:dirs_to_cane]).to eq folders
+    end
+
+    it "[sets churn folders]" do
+      expect(run_options(:churn)[:dirs_to_churn]).to eq folders
+    end
+
+    it "[sets flay folders]" do
+      expect(run_options(:flay)[:dirs_to_flay]).to eq folders
+    end
+
+    it "[sets flog folders]" do
+      expect(run_options(:flog)[:dirs_to_flog]).to eq folders
+    end
+
+    it "[sets reek folders]" do
+      expect(run_options(:reek)[:dirs_to_reek]).to eq folders
+    end
+
+    it "[sets roodi folders]" do
+      expect(run_options(:roodi)[:dirs_to_roodi]).to eq folders
+    end
+
+    it "[sets saikuro folders]" do
+      expect(run_options(:saikuro)[:input_directory]).to eq folders
+    end
+  end
+
+  shared_examples "metrics loader" do
+
+    after { subject }
+
+    it "[loads cane]" do
+      expect(described_class::Cane).to receive :load
+    end
+
+    it "[loads churn]" do
+      expect(described_class::Churn).to receive :load
+    end
+
+    it "[loads flay]" do
+      expect(described_class::Flay).to receive :load
+    end
+
+    it "[loads reek]" do
+      expect(described_class::Reek).to receive :load
+    end
+
+    it "[loads roodi]" do
+      expect(described_class::Roodi).to receive :load
+    end
+
+    it "[loads saikuro]" do
+      expect(described_class::Saikuro).to receive :load
+    end
+  end
+
+  describe ".load" do
+
+    subject { try_in_sandbox { described_class.load } }
+
+    context "when metric_fu.yml is absent" do
+
+      include_context "without metric_fu.yml"
+
+      it_behaves_like "environment setter"
+      it_behaves_like "verbose setter"
+      it_behaves_like "metrics selector"
+      it_behaves_like "folders setter"
+      it_behaves_like "metrics loader"
+    end
+
+    context "when metric_fu.yml is present" do
+
+      include_context "with metric_fu.yml"
+
+      it_behaves_like "environment setter"
+      it_behaves_like "verbose setter"
+      it_behaves_like "metrics selector"
+      it_behaves_like "folders setter"
+      it_behaves_like "metrics loader"
+    end
+  end
+end

data/spec/tests/lib/metrics/pippi_spec.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+require "spec_helper"
+require "pippi"
+
+describe Hexx::Suit::Metrics::Pippi, :sandbox do
+
+  shared_context "without pippi.yml" do
+   
+    let(:options) do
+      { "checkset" => "basic", "output" => "tmp/pippi/output.log" }
+    end 
+  end
+
+  shared_context "with pippi.yml" do
+
+    let(:options) do
+      { "checkset" => "training", "output" => "custom/pippi.log" }
+    end
+
+    before { prepare_settings options, "config/metrics/pippi.yml" }
+  end
+
+  shared_examples "environments loader" do
+
+    before { ENV["USE_PIPPI"]    = nil }
+    before { ENV["PIPPI_OUTPUT"] = nil }
+
+    it "[sets USE_PIPPI]" do
+      expect { subject }.to change { ENV["USE_PIPPI"] }.to "true"
+    end
+
+    it "[sets PIPPI_OUTPUT]" do
+      expect { subject }.to change { ENV["PIPPI_OUTPUT"] }.to options["output"]
+    end
+  end
+
+  shared_examples "file creator" do
+
+    before { subject }
+
+    it "[prepares the output file]" do
+      expect(options["output"]).to be_present_in_sandbox
+    end
+  end
+
+  shared_examples "metric runner" do
+
+    after { subject }
+
+    it "[runs the metric]" do
+      expect(::Pippi::AutoRunner).to receive(:new) do |settings|
+        expect(settings[:checkset]).to eq options["checkset"]
+        expect(settings[:io]).to be_kind_of ::File
+        expect(settings[:io].path).to eq options["output"]
+      end
+    end
+  end
+
+  describe ".load" do
+
+    subject { try_in_sandbox { described_class.load } }
+
+    context "when pippi.yml is absent" do
+
+      include_context "without pippi.yml"
+
+      it_behaves_like "environments loader"
+      it_behaves_like "file creator"
+    end
+
+    context "when pippi.yml is present" do
+
+      include_context "with pippi.yml"
+
+      it_behaves_like "environments loader"
+      it_behaves_like "file creator"
+    end
+  end
+
+  describe ".run" do
+
+    subject { try_in_sandbox { described_class.run } }
+
+    context "when pippi.yml is absent" do
+
+      include_context "with pippi.yml"
+
+      it_behaves_like "environments loader"
+      it_behaves_like "file creator"
+      it_behaves_like "metric runner"
+    end
+
+    context "when pippi.yml is present" do
+
+      include_context "without pippi.yml"
+
+      it_behaves_like "environments loader"
+      it_behaves_like "file creator"
+      it_behaves_like "metric runner"
+    end
+  end
+end