hexx-suit 0.0.1

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

@@ -0,0 +1,15 @@
+---
+folders: # The list of folders to be used by any metric.
+- lib
+- app
+metrics: # The list of allowed metrics. The other metrics are disabled.
+- cane
+- churn
+- flay
+- flog
+- reek
+- roodi
+- saikuro
+format: html
+output: tmp/metric_fu
+verbose: false

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

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

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

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

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

@@ -0,0 +1,24 @@
+---
+AssignmentInConditionalCheck:
+CaseMissingElseCheck:
+ClassLineCountCheck:
+  line_count: 300
+ClassNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ClassVariableCheck:
+CyclomaticComplexityBlockCheck:
+  complexity: 4
+CyclomaticComplexityMethodCheck:
+  complexity: 8
+EmptyRescueBodyCheck:
+ForLoopCheck:
+MethodLineCountCheck:
+  line_count: 20
+MethodNameCheck:
+  pattern: !ruby/regexp /^[\||\^|\&|\!]$|^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/
+ModuleLineCountCheck:
+  line_count: 300
+ModuleNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ParameterNumberCheck:
+  parameter_count: 5

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

@@ -0,0 +1,79 @@
+---
+# settings added by the 'hexx-suit' module
+# output: "tmp/rubocop"
+# format: "html"
+
+AllCops:
+  Exclude:
+    - '**/db/schema.rb'
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/RescueException:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/**/generator*'
+
+Style/AccessorMethodName:
+  Exclude:
+    - 'spec/**/*'
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Exclude:
+    - 'lib/**/version.rb'
+    - 'spec/**/*'
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/EmptyLineBetweenDefs:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SingleLineMethods:
+  Exclude:
+    - 'spec/**/*'
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'Gemfile'
+    - '*.gemspec'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Stype/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrivialAccessors:
+  Exclude:
+    - 'spec/**/*'

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

@@ -0,0 +1,3 @@
+---
+warn_cyclo:  4
+error_cyclo: 6

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

@@ -0,0 +1,8 @@
+---
+output: tmp/coverage
+filters: # The list of paths to be excluded from coverage checkup
+- "spec/"
+- "config/"
+groups: # The list of groups to be shown in the coverage report
+  Libraries: "lib/"
+  Application: "app/"

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

@@ -0,0 +1,37 @@
+---
+# Settings added by the 'hexx-suit' gem
+output: "tmp/yardstick/output.log"
+path: "lib/**/*.rb"
+rules:
+  ApiTag::Presence:
+    enabled: true
+    exclude: []
+  ApiTag::Inclusion:
+    enabled: true
+    exclude: []
+  ApiTag::ProtectedMethod:
+    enabled: true
+    exclude: []
+  ApiTag::PrivateMethod:
+    enabled: false
+    exclude: []
+  ExampleTag:
+    enabled: true
+    exclude: []
+  ReturnTag:
+    enabled: true
+    exclude: []
+  Summary::Presence:
+    enabled: true
+    exclude: []
+  Summary::Length:
+    enabled: true
+    exclude: []
+  Summary::Delimiter:
+    enabled: true
+    exclude: []
+  Summary::SingleLine:
+    enabled: true
+    exclude: []
+threshold: 100
+verbose: false

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

@@ -0,0 +1,96 @@
+require "yaml"
+
+module Hexx
+  module Suit
+
+    # Contains metric configurators
+    #
+    # Any configurator loads metric settings from a corresponding yaml,
+    # sets necessary environments via {.load} method,
+    # and then runs the metric via {.run} method.
+    #
+    # Configurators loads their own dependencies in a corresponding constructor.
+    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 (see #load)
+        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
+        #
+        # @abstract
+        #
+        # @return [Hexx::Suit::Metrics]
+        #   the configured metric object
+        #
+        # @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/metric_fu.rb

@@ -0,0 +1,165 @@
+# encoding: utf-8
+
+module Hexx
+  module Suit
+    module Metrics
+
+      # Configurator for the metric_fu and all its subpackages
+      class MetricFu < Base
+
+        # Loads the metric_fu gem dependency
+        #
+        # @return [Hexx::Suit::Metrics::MetricFu]
+        def self.new
+          require "metric_fu"
+          super
+        end
+
+        # Loads common settings and configures metrics
+        #
+        # @return [self]
+        def load
+          set_environment
+          configure_metric_fu
+          configure_packages
+
+          self
+        end
+
+        private
+
+        # metric_fu definitions
+
+        def packages
+          %w(
+            cane churn flay flog reek roodi saikuro
+            hotspots rails_best_practices rcov stats
+          )
+        end
+
+        def name
+          :metric_fu
+        end
+
+        def default_options
+          {
+            "folders" => %(lib app),
+            "format"  => "html",
+            "metrics" => %(cane churn flay flog reek roodi saikuro),
+            "output"  => "tmp/metric_fu",
+            "verbose" => false
+          }
+        end
+
+        def configuration
+          ::MetricFu::Configuration
+        end
+
+        # operations
+
+        def set_environment
+          ENV["METRIC_FU_OUTPUT"] = options["output"]
+        end
+
+        def configure_metric_fu
+          configuration.run do |config|
+            config.configure_formatter options["format"].to_sym
+            config.verbose = options["verbose"]
+          end
+        end
+
+        def configure_packages
+          packages.map { |item| "configure_#{ item }" }.each(&method(:send))
+        end
+
+        def configure_cane
+          configure(:cane) do |metric|
+            metric.dirs_to_cane = folders
+            Cane.load # loads settings from cane.yml
+          end
+        end
+
+        def configure_churn
+          configure(:churn) do |metric|
+            metric.configured_run_options[:dirs_to_churn] = folders
+            Churn.load # loads settings from churn.yml
+          end
+        end
+
+        def configure_flog
+          configure(:flog) do |metric|
+            metric.dirs_to_flog = folders
+            # no additional settings exist
+          end
+        end
+
+        def configure_flay
+          configure(:flay) do |metric|
+            metric.dirs_to_flay = folders
+            Flay.load # loads settings from flay.yml
+          end
+        end
+
+        def configure_hotspots
+          configure(:hotspots)
+        end
+
+        def configure_rails_best_practices
+          configure(:rails_best_practices)
+        end
+
+        def configure_rcov
+          configure(:reek) do |metric|
+            metric.configured_run_options[:dirs_to_rcov] = folders
+          end
+        end
+
+        def configure_reek
+          configure(:reek) do |metric|
+            metric.dirs_to_reek = folders
+            Reek.load # loads settings from reek.yml
+          end
+        end
+
+        def configure_roodi
+          configure(:roodi) do |metric|
+            metric.dirs_to_roodi = folders
+            Roodi.load # loads settings from roodi.yml
+          end
+        end
+
+        def configure_saikuro
+          configure(:saikuro) do |metric|
+            metric.input_directory = folders
+            Saikuro.load # loads settings from saikuro.yml
+          end
+        end
+
+        def configure_stats
+          configure(:stats)
+        end
+
+        # helpers
+
+        def configure(name)
+          configuration.configure_metric(name) do |metric|
+            metric.enabled = metrics.include? name.to_s
+            yield(metric) if block_given?
+          end
+        end
+
+        def options
+          @options ||= default_options.merge settings.to_h
+        end
+
+        def metrics
+          @metrics ||= options["metrics"]
+        end
+
+        def folders
+          @folders ||= options["folders"]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+module Hexx
+  module Suit
+    module Metrics
+      class MetricFu < Base
+
+        # Base class for metrics configured via metric_fu
+        class Base < Metrics::Base
+
+          # Constructs the object and loads 'metric_fu' dependency
+          #
+          # @return [Hexx::Suit::Metrics::MetricFu]
+          #
+          # @api private
+          def self.new
+            require "metric_fu"
+            super
+          end
+
+          # @!scope class
+          # Initializes and configures the metric from a corresponding yml
+          #
+          # @return [self]
+          def load
+            configure { |metric| options.each { |option| add(metric, option) } }
+
+            self
+          end
+
+          private
+
+          # current metric definitions
+
+          def name
+            :metric_fu
+          end
+
+          def options
+            %w()
+          end
+
+          # helpers
+
+          def add(metric, option)
+            value = settings[option]
+            metric.send option, value unless value.nil?
+          end
+
+          def configure
+            ::MetricFu::Configuration.configure_metric(name) do |metric|
+              yield(metric)
+            end
+          end
+        end
+      end
+    end
+  end
+end