hexx-suit 0.0.1

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

@@ -0,0 +1,66 @@
+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
+          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/hexx/suit/version.rb

@@ -0,0 +1,7 @@
+module Hexx
+  module Suit
+    # The semantic version of the module.
+    # @see http://semver.org/ Semantic versioning 2.0
+    VERSION = "0.0.1".freeze
+  end # module Suit
+end # module Hexx

data/lib/tasks/check.rake

@@ -0,0 +1,32 @@
+namespace :check do
+
+  desc "Runs all tests and code metrics"
+  task run: %w(
+    pippi:run
+    coverage:run
+    rubocop:run
+    fu:run
+    yardstick:run
+  )
+
+  desc "Displays results of last run for any metric"
+  task display: %w(
+    pippi:display
+    coverage:display
+    rubocop:display
+    fu:display
+    inch
+    yardstick:display
+  )
+end
+
+desc "Runs all tests and code metrics and displays their results"
+task check: %w(
+  check:pippi:configure
+  check:coverage
+  check:rubocop
+  check:fu
+  check:pippi:display
+  check:inch
+  check:yardstick
+)

data/lib/tasks/check/coverage.rake

@@ -0,0 +1,27 @@
+namespace :check do
+  namespace :coverage do
+
+    metric = Hexx::Suit::Metrics::SimpleCov
+    caller = Hexx::Suit::Utils::System
+    output = -> { ENV.fetch("SIMPLECOV_OUTPUT") { "coveralls/index.html" } }
+
+    # Loads settings for simplecov from the '.hexx-suit.yml'
+    task :configure do
+      metric.load
+    end
+
+    desc "Runs tests under the coveralls"
+    task run: :configure do
+      caller.call "rake test"
+      puts "see results in #{ output.call }"
+    end
+
+    desc "Displays results of the coveralls last run"
+    task display: :configure do
+      caller.call "launchy #{ output.call }"
+    end
+  end
+
+  desc "Runs tests under the coveralls and displays the results"
+  task coverage: %w(coverage:run coverage:display)
+end

data/lib/tasks/check/fu.rake

@@ -0,0 +1,27 @@
+namespace :check do
+  namespace :fu do
+
+    metric = Hexx::Suit::Metrics::MetricFu
+    caller = Hexx::Suit::Utils::System
+    output = -> { ENV.fetch("METRIC_FU_OUTPUT") { "tmp/metric_fu/output" } }
+
+    # configures the metrics
+    task :configure do
+      metric.load
+    end
+
+    desc "Runs metric_fu"
+    task run: :configure do
+      caller.call "metric_fu --no-open --out #{ output.call }"
+      puts "see results in #{ output.call }"
+    end
+
+    desc "Displays results of metric_fu last run"
+    task display: :configure do
+      caller.call "metric_fu --open --out #{ output.call }"
+    end
+  end
+
+  desc "Runs metric_fu and displays the results"
+  task fu: %w(fu:display)
+end

data/lib/tasks/check/inch.rake

@@ -0,0 +1,11 @@
+namespace :check do
+
+  caller = Hexx::Suit::Utils::System
+
+  desc "Runs inch to check quality of API docs"
+  task :inch do
+    puts "******* STARTING METRIC inch"
+    caller.call "inch --pedantic"
+    puts "******* ENDING METRIC inch"
+  end
+end

data/lib/tasks/check/pippi.rake

@@ -0,0 +1,31 @@
+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

data/lib/tasks/check/rubocop.rake

@@ -0,0 +1,39 @@
+namespace :check do
+  namespace :rubocop do
+
+    metric  = Hexx::Suit::Metrics::Rubocop
+    caller  = Hexx::Suit::Utils::System
+    format  = -> { ENV.fetch("RUBOCOP_FORMAT") { "html" } }
+    output  = -> { ENV.fetch("RUBOCOP_OUTPUT") { "tmp/rubocop/index.html" } }
+    options = -> do
+      "-f #{ format.call } -o #{ output.call } -c config/metrics/rubocop.yml"
+    end
+
+    # Loads settings for rubocop metric from the '.hexx-suit.yml'
+    task :configure do
+      metric.load
+    end
+
+    desc "Runs rubocop metric"
+    task run: :configure do
+      puts "******* STARTING METRIC rubocop"
+      caller.call "rubocop #{ options.call }"
+      puts "see results in #{ output.call }"
+      puts "******* ENDING METRIC rubocop"
+    end
+
+    desc "Displays the results of rubocop last run"
+    task display: :configure do
+      if format.call == "html"
+        caller.call "launchy #{ output.call }"
+      else
+        puts "******* DISPLAYING METRIC rubocop"
+        caller.call "cat #{ output.call }"
+        puts "******* ENDING METRIC rubocop"
+      end
+    end
+  end
+
+  desc "Runs rubocop metric and displays the results"
+  task rubocop: %w(rubocop:run rubocop:display)
+end

data/lib/tasks/check/yardstick.rake

@@ -0,0 +1,27 @@
+namespace :check do
+  namespace :yardstick do
+
+    metric = Hexx::Suit::Metrics::Yardstick
+    caller = Hexx::Suit::Utils::System
+    output = ->{ ENV.fetch("YARDSTICK_OUTPUT") { "tmp/yardstick/results.log" } }
+
+    desc "Runs yardstick metric"
+    task :run do
+      puts "******* STARTING METRIC yardstick"
+      metric.run
+      puts "see results in #{ output.call }"
+      puts "******* ENDING METRIC yardstick"
+    end
+
+    desc "Displays the results of yardstick last run"
+    task :display do
+      puts "******* DISPLAYING METRIC yardstick"
+      metric.load
+      caller.call "cat #{ output.call }"
+      puts "******* ENDING METRIC yardstick"
+    end
+  end
+
+  desc "Runs yardstick metric and displays the results"
+  task yardstick: %w(yardstick:run yardstick:display)
+end

data/lib/tasks/debug.rake

@@ -0,0 +1,6 @@
+caller = Hexx::Suit::Utils::System
+
+desc "Runs a test suit in a bundle environment inside pry 'rescue' wrapper."
+task :debug do
+  caller.call "bundle exec rescue rspec spec"
+end

data/lib/tasks/test.rake

@@ -0,0 +1,6 @@
+caller = Hexx::Suit::Utils::System
+
+desc "Runs a test suit in a bundle environment, without monitoring coverage."
+task :test do
+  caller.call "bundle exec rspec spec"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# Loads the RSpec support files.
+require "rspec"
+Dir[File.expand_path "spec/support/config/*.rb"].each { |file| require file }
+
+# encoding: utf-8
+require "coveralls"
+Coveralls.wear!
+
+# Loads the code of the module with the RSpec test suit.
+require "hexx-suit"

data/spec/support/config/sandbox.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+RSpec.configure do |config|
+
+  # Prepares a sandbox before corresponding spec.
+  config.before :each, :sandbox do
+    require_relative "../sandbox/helpers"
+    require_relative "../sandbox/matchers"
+    prepare_sandbox
+  end
+
+  # Clears a sandbox after corresponding spec.
+  config.after :each, :sandbox do
+    clear_sandbox
+  end
+end

data/spec/support/config/tasks.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+RSpec.configure do |config|
+
+  # Array of commands that was sent to system
+  #
+  # @return [Array<String>]
+  def commands
+    @commands ||= []
+  end
+
+  # Checks whether a task with given name has been invoked
+  #
+  # @param [String] name
+  #
+  # @return [Boolean]
+  def task_invoked?(name)
+    Rake::Task[name].instance_eval { @already_invoked }
+  end
+
+  config.before :example, :tasks do
+
+    # Resets Rake application and reinstalls all tasks to be available
+    Rake.application = nil
+    Hexx::Suit.install_tasks
+
+    # Captures commands that System utility sends to system
+    # and stores them in {#commands} array.
+    allow_any_instance_of(Hexx::Suit::Utils::System)
+      .to receive(:system) { |command| commands << command }
+  end
+end

data/spec/support/sandbox/helpers.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+require "yaml"
+
+# Yields block and captures stdout stream.
+#
+# @example
+#   capture_stdout { do_something }
+#
+# @return [String] The captured stream.
+def capture_stdout
+  begin
+    $stdout = StringIO.new
+    yield
+    result = $stdout.string
+  ensure
+    $stdout = STDOUT
+  end
+  result.to_s
+end
+
+# Returns the path to the temporary `spec/sandbox`.
+# @return [String] The absolute path.
+def sandbox
+  @sandbox ||= File.expand_path "../../../sandbox", __FILE__
+end
+
+# Clears the temporary `spec/sandbox`.
+def clear_sandbox
+  FileUtils.rm_rf sandbox
+end
+
+# Re-creates the temporary `spec/sandbox`.
+def prepare_sandbox
+  clear_sandbox
+  FileUtils.mkdir_p sandbox
+end
+
+# Runs code from the temporary `spec/sandbox`.
+def try_in_sandbox
+  FileUtils.cd(sandbox) { capture_stdout { yield } }
+end
+
+# Reads file in sandbox and returns file content.
+# Returns a blank string when the file is absent.
+# @return [String] The content.
+def read_in_sandbox(filename)
+  file = Dir[File.join(sandbox, filename)].first
+  file ? File.read(file) : ""
+end
+
+# Creates settings file in a sandbox
+#
+# @param [Hash] settings ({})
+#   The list of settings to be stored in 'sandbox/.metrics.yml'
+#
+# @return [undefined]
+def prepare_settings(settings, file = ".metrics.yml")
+  try_in_sandbox do
+    ::FileUtils.mkdir_p ::File.dirname(file)
+    ::File.write file, settings.to_yaml
+  end
+end

data/spec/support/sandbox/matchers.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+# Checks if a file with given name is present in sandbox.
+#
+# @example
+#   expect("some_file.rb").to be_present_in_sandbox
+RSpec::Matchers.define :be_present_in_sandbox do
+  match do |filename|
+    files = Dir[File.join(sandbox, filename)]
+    expect(files).to be_any
+  end
+end
+
+# Checks if a file with given name is absent in sandbox.
+#
+# @example
+#   expect("some_file.rb").to be_absent_in_sandbox
+RSpec::Matchers.define_negated_matcher(
+  :be_absent_in_sandbox,
+  :be_present_in_sandbox
+)

data/spec/tests/bin/install_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+describe "hexx-suit install", :sandbox do
+
+  describe "install" do
+
+    before { try_in_sandbox { `hexx-suit install` } }
+
+    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
+      ).each { |file| expect(file).to be_present_in_sandbox }
+    end
+  end
+end