hexx-suit 0.0.1

data/lib/hexx/suit/metrics/metric_fu/cane.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module Hexx
+  module Suit
+    module Metrics
+      class MetricFu < Base
+
+        # The configurer for the Cane metric
+        class Cane < Base
+
+          private
+
+          def name
+            :cane
+          end
+
+          def options
+            %w(abc_max line_length no_doc no_readme)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hexx/suit/metrics/metric_fu/churn.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module Hexx
+  module Suit
+    module Metrics
+      class MetricFu < Base
+
+        # The configurer for the Churn metric
+        class Churn < Base
+
+          private
+
+          def name
+            :churn
+          end
+
+          def options
+            %w(ignore_files start_date minimum_churn_count)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hexx/suit/metrics/metric_fu/flay.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module Hexx
+  module Suit
+    module Metrics
+      class MetricFu < Base
+
+        # The configurer for the Flay metric
+        class Flay < Base
+
+          private
+
+          def name
+            :flay
+          end
+
+          def options
+            %w(minimum_score)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hexx/suit/metrics/metric_fu/reek.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+module Hexx
+  module Suit
+    module Metrics
+      class MetricFu < Base
+
+        # The configurer for the Reek metric
+        class Reek < Base
+
+          # @!scope class
+          # Changes settings source to config/metrics/reek.yml
+          #
+          # @return [self]
+          def load
+            configure do |metric|
+              metric.config_file_pattern = "config/metrics/reek.yml"
+            end
+
+            self
+          end
+
+          private
+
+          def name
+            :reek
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hexx/suit/metrics/metric_fu/roodi.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+module Hexx
+  module Suit
+    module Metrics
+      class MetricFu < Base
+
+        # The configurer for the Roodi metric
+        class Roodi < Base
+
+          # @!scope class
+          # Changes settings source to config/metrics/roodi.yml
+          #
+          # @return [self]
+          def load
+            configure do |metric|
+              metric.roodi_config = "config/metrics/roodi.yml"
+            end
+
+            self
+          end
+
+          private
+
+          def name
+            :roodi
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hexx/suit/metrics/metric_fu/saikuro.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module Hexx
+  module Suit
+    module Metrics
+      class MetricFu < Base
+
+        # The configurer for the Saikuro metric
+        class Saikuro < Base
+
+          private
+
+          def name
+            :saikuro
+          end
+
+          def options
+            %w(warn_cyclo error_cyclo)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+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
+
+          self
+        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_h
+        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/rubocop.rb

@@ -0,0 +1,39 @@
+module Hexx
+  module Suit
+    module Metrics
+
+      # Prepares and runs rubocop environment from '.hexx-suit.yml'
+      class Rubocop < Base
+
+        # @!scope class
+        # Sets ENV variables for rubocop rake tasks
+        #
+        # @return [self]
+        def load
+          ENV["RUBOCOP_FORMAT"] = options["format"]
+          ENV["RUBOCOP_OUTPUT"] = options["output"]
+
+          self
+        end
+
+        private
+
+        # rubocop metric definitions
+
+        def name
+          :rubocop
+        end
+
+        def default_options
+          { "format" => "html", "output" => "tmp/rubocop/index.html" }
+        end
+
+        # helpers
+
+        def options
+          @options ||= default_options.merge settings.to_h
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+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
+
+          self
+        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_h
+        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/metrics/yardstick.rb

@@ -0,0 +1,91 @@
+module Hexx
+  module Suit
+    module Metrics
+
+      # Prepares and runs yardstick environment from '.hexx-suit.yml'
+      class Yardstick < Base
+
+        # Loads yardstick verifier
+        #
+        # @return [Hexx::Suit::Metrics::Yardstick]
+        #
+        # @api private
+        def self.new
+          require "yardstick/rake/measurement"
+          super
+        end
+
+        # @!scope class
+        # Prepares output for the yardstick and sets the YARDSTICK_OUTPUT env
+        #
+        # @return [self]
+        def load
+          prepare_output
+          set_environment
+
+          self
+        end
+
+        # @!scope class
+        # Runs yardstick with options from '.hexx-suit.yml'
+        #
+        # @return [undefined]
+        def run
+          measurement.yardstick_measure
+        end
+
+        private
+
+        # yardstic metric definitions
+
+        def name
+          "yardstick"
+        end
+
+        def default_options
+          {
+            "output" => "tmp/yardstick/output.log",
+            "path"   => "lib/**/*.rb"
+          }
+        end
+
+        def metric
+          ::Yardstick::Rake::Measurement
+        end
+
+        # operations
+
+        def prepare_output
+          SYSTEM.call %(
+            mkdir #{ ::File.dirname(output) } -p
+            touch #{ output }
+          )
+        end
+
+        def set_environment
+          ENV["YARDSTICK_OUTPUT"] = output
+        end
+
+        # helpers
+
+        def measurement
+          metric.new(:yardstick_measure, options) do |config|
+            config.output = output
+          end
+        end
+
+        def options
+          @options ||= begin
+            list = default_options.merge settings.to_h
+            list["path"] = Array(list["path"]).join(" ")
+            list
+          end
+        end
+
+        def output
+          @output ||= options["output"]
+        end
+      end
+    end
+  end
+end