hexx-suit 0.2.2 → 1.0.0

data/config/initializers/garbage_collection.rb

@@ -1,11 +0,0 @@
-# Delays garbage collection until the end of testing.
-RSpec.configure do |config|
-
-  config.before(:each) do
-    GC.disable
-  end
-
-  config.after(:each) do
-    GC.enable
-  end
-end

data/config/initializers/i18n.rb

@@ -1,3 +0,0 @@
-require "i18n"
-
-I18n.enforce_available_locales = false

data/config/initializers/random_order.rb

@@ -1,4 +0,0 @@
-# Runs tests in a random order
-RSpec.configure do |config|
-  config.order = "random"
-end

data/config/initializers/rspec.rb

@@ -1,11 +0,0 @@
-# Configures RSpec default settings
-RSpec.configure do |config|
-
-  config.mock_with :rspec do |mocks|
-    mocks.yield_receiver_to_any_instance_implementation_blocks = false
-  end
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-end

data/lib/hexx/suit/install/Rakefile

@@ -1,17 +0,0 @@
-# encoding: utf-8
-begin
-  require "bundler/setup"
-rescue LoadError
-  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
-  exit
-end
-
-# Loads bundler tasks
-Bundler::GemHelper.install_tasks
-
-# Loads the Hexx::Suit and its tasks
-require "hexx-suit"
-Hexx::Suit.install_tasks
-
-# Sets the Hexx::Suit :test task to default
-task default: :test

data/lib/hexx/suit/install/_rspec

@@ -1,2 +0,0 @@
---require spec_helper
---color

data/lib/hexx/suit/install/metrics/pippi.yml

@@ -1,3 +0,0 @@
----
-checkset: basic
-output: "tmp/pippi/output.log"

data/lib/hexx/suit/metrics/base.rb

@@ -1,88 +0,0 @@
-require "yaml"
-
-module Hexx
-
-  module Suit
-
-    module Metrics
-
-      # Base class for metrics configurators
-      #
-      # @api private
-      class Base
-
-        # The utility class for sending commands to the system
-        SYSTEM = Utils::System
-
-        # Loads metric settings and configures the current metric
-        #
-        # @return [Hexx::Suit::Metrics]
-        #   the configured metric object
-        def self.load
-          send(:new).load
-        end
-
-        # Configures and runs the current metric
-        #
-        # @return (see #run)
-        def self.run
-          load.run
-        end
-
-        # Loads the configuration file and configures the metric
-        #
-        # @return [self]
-        #
-        # @api private
-        def load
-          self
-        end
-
-        # Runs the metric
-        #
-        # @abstract
-        #
-        # @return [undefined]
-        #
-        # @api private
-        def run
-        end
-
-        # @note
-        #   The class has a private constructor.
-        #   Use methods {.load} or {.run}.
-        private_class_method :new
-
-        private
-
-        # Extracts a hash of settings from the current file
-        #
-        # @return [Hash]
-        #
-        # @api private
-        def settings
-          @settings ||= file ? ::YAML.load_file(file) : {}
-        end
-
-        # Returns the name of the settings file
-        #
-        # @return [String]
-        #   when the file is present in the config/metrics folder
-        # @return [nil]
-        #   when the file is absent in the config/metrics folder
-        #
-        # @api private
-        def file
-          @file ||= Dir["config/metrics/#{ name }.yml"].first
-        end
-
-        # The name of the current metric
-        #
-        # @abstract
-        #
-        # @return [Symbol]
-        attr_reader :name
-      end
-    end
-  end
-end

data/lib/hexx/suit/metrics/pippi.rb

@@ -1,89 +0,0 @@
-module Hexx
-  module Suit
-    module Metrics
-
-      # Prepares and runs pippi environment
-      class Pippi < Base
-
-        # Constructs the object and loads 'pippi' gem dependency
-        #
-        # Loads pippi settings, prepares the log file,
-        # and sets ENV variables for the pippi rake tasks.
-        #
-        # @return [Hexx::Suit::Metrics::MetricFu]
-        #
-        # @api private
-        def self.new
-          require "pippi"
-          super
-        end
-
-        # @!scope class
-        # Prepares log file and sets ENV variables for pippi rake tasks
-        #
-        # @return [undefined]
-        def load
-          prepare_output
-          set_environment
-
-          super
-        end
-
-        # @!scope class
-        # Starts pippi AutoRunner
-        #
-        # @return [undefined]
-        def run
-          ::Pippi::AutoRunner.new checkset: checkset, io: io
-        end
-
-        private
-
-        # pippi metric definitions
-
-        def name
-          :pippi
-        end
-
-        def default_options
-          {
-            "checkset" => "basic",
-            "output"   => "tmp/pippi/output.log"
-          }
-        end
-
-        # operations
-
-        def prepare_output
-          SYSTEM.call %(
-            mkdir #{ File.dirname(output) } -p
-            touch #{ output }
-          )
-        end
-
-        def set_environment
-          ENV["USE_PIPPI"]    = "true"
-          ENV["PIPPI_OUTPUT"] = output
-        end
-
-        # helpers
-
-        def options
-          @options ||= default_options.merge settings.to_hash
-        end
-
-        def output
-          @output ||= options["output"]
-        end
-
-        def io
-          ::File.open(output, "w")
-        end
-
-        def checkset
-          options["checkset"]
-        end
-      end
-    end
-  end
-end

data/lib/hexx/suit/metrics/simplecov.rb

@@ -1,119 +0,0 @@
-module Hexx
-  module Suit
-    module Metrics
-
-      # Prepares and runs pippi environment
-      #
-      # @api private
-      class SimpleCov < Base
-
-        # Loads the simplecov and coveralls gem
-        #
-        # @return [Hexx::Suit::Metrics::SimpleCov]
-        #
-        # @api private
-        def self.new
-          %w(simplecov coveralls).each { |gem| require gem }
-          super
-        end
-
-        # @!scope class
-        # Configures the SimpleCov metric
-        #
-        # @return [self]
-        def load
-          set_environment
-          configure_metric
-
-          super
-        end
-
-        # @!scope class
-        # Configures simplecov from the simplecov.yml file and starts
-        # the metric
-        #
-        # @return [undefined]
-        def run
-          metric.start
-        end
-
-        private
-
-        # simplecov metric definitions
-
-        def name
-          "simplecov"
-        end
-
-        def metric
-          ::SimpleCov
-        end
-
-        def default_options
-          {
-            "output"  => "tmp/coverage",
-            "filters" => ["spec/", "config/"],
-            "groups"  => {
-              "Libraries" => "lib/",
-              "Application" => "app/"
-            }
-          }
-        end
-
-        # operations
-
-        def set_environment
-          ENV["USE_SIMPLECOV"]    = "true"
-          ENV["SIMPLECOV_OUTPUT"] = "#{ output }/index.html"
-        end
-
-        def configure_metric
-          add_filters
-          add_groups
-          set_formatters
-          set_output
-        end
-
-        def add_filters
-          filters.each(&metric.method(:add_filter))
-        end
-
-        def add_groups
-          groups.each { |key, value| metric.add_group(key, value) }
-        end
-
-        def set_formatters
-          metric.formatter = metric::Formatter::MultiFormatter[
-            metric::Formatter::HTMLFormatter,
-            ::Coveralls::SimpleCov::Formatter
-          ]
-        end
-
-        def set_output
-          metric.coverage_dir output
-        end
-
-        # helpers
-
-        def options
-          @options ||= default_options.merge settings.to_hash
-        end
-
-        def output
-          @output = options["output"]
-        end
-
-        def filters
-          @filters ||= Array(options["filters"]).flatten.map(&:to_s)
-        end
-
-        def groups
-          @groups ||= begin
-            list = options["groups"]
-            list.is_a?(Hash) ? list : {}
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hexx/suit/utils/system.rb

@@ -1,66 +0,0 @@
-module Hexx
-  module Suit
-
-    # Contains utilitity classes
-    module Utils
-
-      # The utility sends multiline string to system
-      #
-      # Allows stubbing system calls in specifications.
-      #
-      # @example
-      #   System.call %(
-      #     inch --pedantic
-      #     rubocop
-      #   )
-      #
-      # @api private
-      class System < String
-
-        # Initializes multiline text to be sent to system
-        #
-        # Removes repetitive spaces from itself
-        #
-        # @param [#to_s] text
-        #   Multiline text to be sent to system
-        #
-        # @return [undefined]
-        def initialize(text)
-          super
-          strip!
-          gsub!(/ {2,}/, " ")
-        end
-
-        # Returns non-empty lines without trailing spaces
-        #
-        # @return [Array<String>]
-        def lines
-          Array(super).map(&:strip).reject(&:empty?)
-        end
-
-        # Sends itself to system line by line
-        #
-        # @return [self]
-        def call
-          lines.each(&method(:system))
-
-          self
-        end
-
-        # Sends multiline string to system
-        #
-        # @example (see Hexx::Suit::Utils::System)
-        #
-        # @param  (see #initialize)
-        #
-        # @return [Hexx::Suit::Utils::System]
-        #   utility object (allows chaining)
-        def self.call(text)
-          new(text).call
-
-          self
-        end
-      end # class System
-    end # module Utils
-  end # module Suit
-end # module Hexx

data/lib/tasks/check/pippi.rake

@@ -1,33 +0,0 @@
-namespace :check do
-
-  namespace :pippi do
-
-    metric = Hexx::Suit::Metrics::Pippi
-    caller = Hexx::Suit::Utils::System
-    output = -> { ENV.fetch("PIPPI_OUTPUT") { "log/pippi.log" } }
-
-    # Loads settings for pippi runtime metric from the '.hexx-suit.yml'
-    task :configure do
-      metric.load
-    end
-
-    desc "Runs tests with pippi runtime metric"
-    task run: :configure do
-      puts "******* STARTING METRIC pippi"
-      caller.call "rake test"
-      puts "see pippi results in #{ output.call }"
-      puts "******* ENDING METRIC pippi"
-    end
-
-    desc "Displays results of pippi last run"
-    task display: :configure do
-      puts "******* DISPLAYING METRIC pippi"
-      caller.call "cat #{ output.call }"
-      puts "******* ENDING METRIC pippi"
-    end
-  end
-
-  desc "Runs tests with pippi runtime metric and displays the results"
-  task pippi: %w(pippi:run pippi:display)
-
-end if USE_PIPPI_METRIC

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

@@ -1,104 +0,0 @@
-# encoding: utf-8
-require "spec_helper"
-
-describe Hexx::Suit::Metrics::Pippi, :sandbox do
-
-  require "pippi"
-
-  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 if USE_PIPPI_METRIC

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

@@ -1,102 +0,0 @@
-# encoding: utf-8
-require "spec_helper"
-require "simplecov"
-
-describe Hexx::Suit::Metrics::SimpleCov, :sandbox do
-
-  shared_context "without simplecov.yml" do
-
-    let(:options) do
-      {
-        "output"  => "tmp/coverage",
-        "filters" => ["spec/", "config/"],
-        "groups"  => {
-          "Libraries" => "lib/",
-          "Application" => "app/"
-        }
-      }
-    end
-  end
-
-  shared_context "with simplecov.yml" do
-
-    let(:options) do
-      {
-        "output"  => "custom",
-        "filters" => ["custom/"],
-        "groups"  => { "Custom" => "custom/" }
-      }
-    end
-
-    before { prepare_settings options, "config/metrics/simplecov.yml" }
-  end
-
-  shared_examples "environmets setter" do
-
-    before do
-      ENV["USE_SIMPLECOV"]    = nil
-      ENV["SIMPLECOV_OUTPUT"] = nil
-    end
-
-    it "[sets USE_SIMPLECOV]" do
-      expect { subject }
-        .to change { ENV["USE_SIMPLECOV"] }
-        .to "true"
-    end
-
-    it "[sets SIMPLECOV_OUTPUT]" do
-      expect { subject }
-        .to change { ENV["SIMPLECOV_OUTPUT"] }
-        .to "#{ options['output'] }/index.html"
-    end
-  end
-
-  shared_examples "metric loader" do
-
-    after { subject }
-
-    it "starts the metric" do
-      expect(::SimpleCov).to receive(:start)
-    end
-  end
-
-  describe ".load" do
-
-    subject { try_in_sandbox { described_class.load } }
-
-    context "without simplecov.yml" do
-
-      include_context "without simplecov.yml"
-
-      it_behaves_like "environmets setter"
-    end
-
-    context "with simplecov.yml" do
-
-      include_context "with simplecov.yml"
-
-      it_behaves_like "environmets setter"
-    end
-  end
-
-  describe ".run" do
-
-    subject { try_in_sandbox { described_class.run } }
-
-    context "without simplecov.yml" do
-
-      include_context "without simplecov.yml"
-
-      it_behaves_like "environmets setter"
-      it_behaves_like "metric loader"
-    end
-
-    context "with simplecov.yml" do
-
-      include_context "without simplecov.yml"
-
-      it_behaves_like "environmets setter"
-      it_behaves_like "metric loader"
-    end
-  end
-end