central-devtools 0.8.3

data/lib/central/devtools/config.rb

@@ -0,0 +1,199 @@
+# encoding: UTF-8
+
+module Central
+  module Devtools
+    # Abstract base class of tool configuration
+    class Config
+      include Adamantium::Flat, AbstractType, Concord.new(:config_dir)
+
+      # Represent no configuration
+      DEFAULT_CONFIG = {}.freeze
+
+      # Simple named type check representation
+      class TypeCheck
+        # Type check against expected class
+        include Concord.new(:name, :allowed_classes)
+
+        FORMAT_ERROR = '%<name>s: Got instance of %<got>s expected %<allowed>s'.freeze
+        CLASS_DELIM  = ','.freeze
+
+        # Check value for instance of expected class
+        #
+        # @param [Object] value
+        # @return [Object]
+        def call(value)
+          klass = value.class
+
+          unless allowed_classes.any?(&klass.method(:equal?))
+            fail TypeError, FORMAT_ERROR % {
+              name: name,
+              got: klass,
+              allowed: allowed_classes.join(CLASS_DELIM)
+            }
+          end
+
+          value
+        end
+      end
+
+      private_constant(*constants(false))
+
+      # Error raised on type errors
+      TypeError = Class.new(RuntimeError)
+
+      # Declare an attribute
+      #
+      # @param [Symbol] name
+      # @param [Array<Class>] classes
+      # @return [self]
+      # @api private
+      def self.attribute(name, classes, **options)
+        default = [options.fetch(:default)] if options.key?(:default)
+        type_check = TypeCheck.new(name, classes)
+        key = name.to_s
+
+        define_method(name) do
+          type_check.call(raw.fetch(key, *default))
+        end
+      end
+      private_class_method :attribute
+
+      # Return config path
+      #
+      # @return [String]
+      # @api private
+      def config_file
+        config_dir.join(self.class::FILE)
+      end
+      memoize :config_file
+
+      private
+
+      # Return raw data
+      #
+      # @return [Hash]
+      # @api private
+      def raw
+        yaml_config || DEFAULT_CONFIG
+      end
+      memoize :raw
+
+      # Return the raw config data from a yaml file
+      #
+      # @return [Hash]
+      #   returned if the yaml file is found
+      # @return [nil]
+      #   returned if the yaml file is not found
+      # @api private
+      def yaml_config
+        IceNine.deep_freeze(YAML.load_file(config_file)) if config_file.file?
+      end
+
+      # Rubocop configuration
+      class Rubocop < self
+        FILE = 'rubocop.yml'.freeze
+      end
+
+      # Reek configuration
+      class Reek < self
+        FILE = 'reek.yml'.freeze
+      end
+
+      # Flay configuration
+      class Flay < self
+        FILE = 'flay.yml'.freeze
+        DEFAULT_LIB_DIRS = %w(lib).freeze
+        DEFAULT_EXCLUDES = %w().freeze
+
+        attribute :total_score, Fixnum
+        attribute :threshold, Fixnum
+        attribute :lib_dirs, Array, default: DEFAULT_LIB_DIRS
+        attribute :excludes, Array, default: DEFAULT_EXCLUDES
+      end
+
+      # Yardstick configuration
+      class Yardstick < self
+        FILE = 'yardstick.yml'.freeze
+        OPTIONS = %w(
+          threshold
+          rules
+          verbose
+          path
+          require_exact_threshold
+        ).freeze
+
+        # Options hash that Yardstick understands
+        #
+        # @return [Hash]
+        # @api private
+        def options
+          OPTIONS.each_with_object({}) do |name, hash|
+            hash[name] = raw.fetch(name, nil)
+          end
+        end
+      end
+
+      # Flog configuration
+      class Flog < self
+        FILE = 'flog.yml'.freeze
+        DEFAULT_LIB_DIRS = %w(lib).freeze
+
+        attribute :total_score, Float
+        attribute :threshold, Float
+        attribute :lib_dirs, Array, default: DEFAULT_LIB_DIRS
+      end
+
+      # Mutant configuration
+      class Mutant < self
+        FILE = 'mutant.yml'.freeze
+        DEFAULT_NAME = ''.freeze
+        DEFAULT_STRATEGY = 'rspec'.freeze
+        DEFAULT_COVERAGE = '1/1'.freeze
+
+        attribute :name, String, default: DEFAULT_NAME
+        attribute :strategy, String, default: DEFAULT_STRATEGY
+        attribute :zombify, [TrueClass, FalseClass], default: false
+        attribute :since, [String, NilClass], default: nil
+        attribute :ignore_subjects, Array, default: []
+        attribute :expect_coverage, String, default: DEFAULT_COVERAGE
+        attribute :namespace, String
+      end
+
+      # Devtools configuration
+      class Devtools < self
+        FILE = 'devtools.yml'.freeze
+        DEFAULT_UNIT_TEST_TIMEOUT = 0.1
+
+        attribute :unit_test_timeout, Float, default: DEFAULT_UNIT_TEST_TIMEOUT
+      end
+
+      # Container configuration
+      class Container < self
+        FILE = 'container.yml'.freeze
+        OPTIONS = %w(
+          prefix
+          component
+          build_tag
+          from_image
+          from_version
+        ).freeze
+
+        # Options hash for the container
+        #
+        # @return [Hash]
+        # @api private
+        def options
+          OPTIONS.each_with_object({}) do |name, hash|
+            hash[name] = raw.fetch(name, nil)
+          end
+        end
+
+        attribute :prefix, String, default: nil
+        attribute :component, String, default: nil
+        attribute :build_tag, String, default: nil
+        attribute :from_image, String, default: nil
+        attribute :from_version, String, default: nil
+      end
+    end
+  end
+end

data/lib/central/devtools/flay.rb

@@ -0,0 +1,91 @@
+# encoding: UTF-8
+
+module Central
+  module Devtools
+    module Flay
+      # Measure flay mass relative to size of duplicated sexps
+      class Scale
+        include Adamantium
+        include Anima.new(:minimum_mass, :files)
+        include Procto.call(:measure)
+
+        # Measure duplication mass
+        #
+        # @return [Array<Rational>]
+        # @api private
+        def measure
+          flay.masses.map do |hash, mass|
+            Rational(mass, flay.hashes.fetch(hash).size)
+          end
+        end
+
+        # Report flay output
+        #
+        # @return [undefined]
+        # @api private
+        def flay_report
+          flay.report
+        end
+
+        private
+
+        # Memoized flay instance
+        #
+        # @return [Flay]
+        # @api private
+        def flay
+          ::Flay.new(mass: minimum_mass).tap do |flay|
+            flay.process(*files)
+            flay.analyze
+          end
+        end
+        memoize :flay, freezer: :noop
+      end
+
+      # Expand include and exclude file settings for flay
+      class FileList
+        include Procto.call, Concord.new(:includes, :excludes)
+
+        # Expand includes and filter by excludes
+        #
+        # @return [Set<Pathname>]
+        # @api private
+        def call
+          include_set - exclude_set
+        end
+
+        private
+
+        # Set of excluded files
+        #
+        # @return [Set<Pathname>]
+        # @api private
+        def exclude_set
+          excludes.flat_map(&Pathname.method(:glob))
+        end
+
+        # Set of included files
+        #
+        # Expanded using flay's file expander which takes into
+        # account flay's plugin support
+        #
+        # @return [Set<Pathname>]
+        # @api private
+        def include_set
+          Set.new(flay_includes.map(&method(:Pathname)))
+        end
+
+        # Expand includes using flay
+        #
+        # Expanded using flay's file expander which takes into
+        # account flay's plugin support
+        #
+        # @return [Array<String>]
+        # @api private
+        def flay_includes
+          ::Flay.expand_dirs_to_files(includes)
+        end
+      end
+    end
+  end
+end

data/lib/central/devtools/project/initializer/rake.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+module Central
+  module Devtools
+    class Project
+      class Initializer
+        # Imports all devtools rake tasks into a project
+        class Rake < self
+          include AbstractType
+
+          # Initialize rake tasks
+          #
+          # @return [undefined]
+          # @api rpivate
+          def self.call
+            FileList.glob(RAKE_FILES_GLOB).each(&::Rake.application.method(:add_import))
+            self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/central/devtools/project/initializer/rspec.rb

@@ -0,0 +1,70 @@
+# encoding: UTF-8
+
+module Central
+  module Devtools
+    class Project
+      class Initializer
+        # Requires all shared specs in a project's spec_helper
+        # Also installs a configurable unit test timeout
+        class Rspec < self
+          include Concord.new(:project)
+
+          # Call initializer for project
+          #
+          # @param [Project] project
+          # @return [self]
+          # @api private
+          def self.call(project)
+            new(project).__send__(:call)
+            self
+          end
+
+          private
+
+          # Setup RSpec for project
+          #
+          # @return [self]
+          # @api private
+          def call
+            require_shared_spec_files
+            enable_unit_test_timeout
+          end
+
+          # Timeout unit tests that take longer than configured amount of time
+          #
+          # @param [Numeric] timeout
+          # @return [undefined]
+          # @raise [Timeout::Error]
+          #   raised when the times are outside the timeout
+          # @api private
+          def enable_unit_test_timeout
+            timeout = project.devtools.unit_test_timeout
+            RSpec.configuration.around(file_path: UNIT_TEST_PATH_REGEXP) do |example|
+              Timeout.timeout(timeout, &example)
+            end
+          end
+
+          # Trigger the require of shared spec files
+          #
+          # @return [undefined]
+          # @api private
+          def require_shared_spec_files
+            require_files(SHARED_SPEC_PATH)
+            require_files(project.spec_root)
+          end
+
+          # Require files with pattern
+          #
+          # @param [Pathname] dir
+          #   the directory containing the files to require
+          #
+          # @return [self]
+          # @api private
+          def require_files(dir)
+            Dir.glob(dir.join(SHARED_SPEC_PATTERN)).each(&Kernel.method(:require))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/central/devtools/project/initializer.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+module Central
+  module Devtools
+    class Project
+      # Base class for project initializers
+      class Initializer
+        include AbstractType
+        abstract_singleton_method :call
+      end
+    end
+  end
+end

data/lib/central/devtools/project.rb

@@ -0,0 +1,80 @@
+# encoding: UTF-8
+
+module Central
+  module Devtools
+    class Project
+      include Concord.new(:root)
+
+      CONFIGS = {
+        container: Config::Container,
+        devtools: Config::Devtools,
+        flay: Config::Flay,
+        flog: Config::Flog,
+        reek: Config::Reek,
+        mutant: Config::Mutant,
+        rubocop: Config::Rubocop,
+        yardstick: Config::Yardstick
+      }.freeze
+
+      private_constant(*constants(false))
+
+      attr_reader(*CONFIGS.keys)
+
+      # The spec root
+      #
+      # @return [Pathname]
+      #
+      # @api private
+      attr_reader :spec_root
+
+      # Initialize object
+      #
+      # @param [Pathname] root
+      #
+      # @return [undefined]
+      #
+      # @api private
+      #
+      def initialize(root)
+        super(root)
+
+        initialize_environment
+        initialize_configs
+      end
+
+      # Init rspec
+      #
+      # @return [self]
+      #
+      # @api private
+      def init_rspec
+        Initializer::Rspec.call(self)
+        self
+      end
+
+      private
+
+      # Initialize environment
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def initialize_environment
+        @spec_root = root.join(SPEC_DIRECTORY_NAME)
+      end
+
+      # Initialize configs
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def initialize_configs
+        config_dir = root.join(DEFAULT_CONFIG_DIR_NAME)
+
+        CONFIGS.each do |name, klass|
+          instance_variable_set(:"@#{name}", klass.new(config_dir))
+        end
+      end
+    end
+  end
+end

data/lib/central/devtools/rake/flay.rb

@@ -0,0 +1,121 @@
+# encoding: UTF-8
+
+module Central
+  module Devtools
+    module Rake
+      # Flay metric runner
+      class Flay
+        include Anima.new(:threshold, :total_score, :lib_dirs, :excludes),
+                Procto.call(:verify),
+                Adamantium
+
+        BELOW_THRESHOLD = 'Adjust flay threshold down to %d'.freeze
+        TOTAL_MISMATCH  = 'Flay total is now %d, but expected %d'.freeze
+        ABOVE_THRESHOLD = '%d chunks have a duplicate mass > %d'.freeze
+
+        # Verify code specified by `files` does not violate flay expectations
+        #
+        # @raise [SystemExit] if a violation is found
+        # @return [undefined] otherwise
+        #
+        # rubocop:disable MethodLength
+        #
+        # @api private
+        def verify
+          # Run flay first to ensure the max mass matches the threshold
+          Central::Devtools.notify_metric_violation(
+            BELOW_THRESHOLD % largest_mass
+          ) if below_threshold?
+
+          Central::Devtools.notify_metric_violation(
+            TOTAL_MISMATCH % [total_mass, total_score]
+          ) if total_mismatch?
+
+          # Run flay a second time with the threshold set
+          return unless above_threshold?
+
+          restricted_flay_scale.flay_report
+          Central::Devtools.notify_metric_violation(
+            ABOVE_THRESHOLD % [restricted_mass_size, threshold]
+          )
+        end
+
+        private
+
+        # List of files flay will analyze
+        #
+        # @return [Set<Pathname>]
+        # @api private
+        def files
+          Central::Devtools::Flay::FileList.call(lib_dirs, excludes)
+        end
+
+        # Is there mass duplication which exceeds specified `threshold`
+        #
+        # @return [Boolean]
+        # @api private
+        def above_threshold?
+          restricted_mass_size.nonzero?
+        end
+
+        # Is the specified `threshold` greater than the largest flay mass
+        #
+        # @return [Boolean]
+        # @api private
+        def below_threshold?
+          threshold > largest_mass
+        end
+
+        # Is the expected mass total different from the actual mass total
+        #
+        # @return [Boolean]
+        # @api private
+        def total_mismatch?
+          !total_mass.equal?(total_score)
+        end
+
+        # Size of mass measured by `Flay::Scale` and filtered by `threshold`
+        #
+        # @return [Integer]
+        # @api private
+        def restricted_mass_size
+          restricted_flay_scale.measure.size
+        end
+
+        # Sum of all flay mass
+        #
+        # @return [Integer]
+        # @api private
+        def total_mass
+          flay_masses.reduce(:+).to_i
+        end
+
+        # Largest flay mass found
+        #
+        # @return [Integer]
+        # @api private
+        def largest_mass
+          flay_masses.max.to_i
+        end
+
+        # Flay scale which only measures mass above `threshold`
+        #
+        # @return [Flay::Scale]
+        # @api private
+        def restricted_flay_scale
+          Central::Devtools::Flay::Scale.new(minimum_mass: threshold.succ, files: files)
+        end
+        memoize :restricted_flay_scale
+
+        # All flay masses found in `files`
+        #
+        # @return [Array<Rational>]
+        # @api private
+        def flay_masses
+          Central::Devtools::Flay::Scale.call(minimum_mass: 0, files: files)
+        end
+        memoize :flay_masses
+      end
+    end
+  end
+end

data/lib/central/devtools/spec_helper.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+require 'central/devtools'
+
+Central::Devtools::PROJECT.init_rspec

data/lib/central/devtools/version.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+module Central
+  module Devtools
+    VERSION = '0.8.3'.freeze
+  end
+end

data/lib/central/devtools.rb

@@ -0,0 +1,90 @@
+# encoding: UTF-8
+
+# Stdlib infrastructure
+require 'pathname'
+require 'rake'
+require 'timeout'
+require 'yaml'
+require 'fileutils'
+
+# Non stdlib infrastructure
+require 'procto'
+require 'anima'
+require 'concord'
+require 'adamantium'
+
+# Wrapped tools
+require 'flay'
+require 'rspec'
+require 'rspec/its'
+require 'simplecov'
+
+module Central
+  # The devtools namespace
+  module Devtools
+    ROOT = Pathname.new(__FILE__).parent.parent.parent.freeze
+    PROJECT_ROOT = Pathname.pwd.freeze
+    SHARED_PATH = ROOT.join('shared').freeze
+    SHARED_SPEC_PATH = SHARED_PATH.join('spec').freeze
+    DEFAULT_CONFIG_PATH = ROOT.join('default/config').freeze
+    RAKE_FILES_GLOB = ROOT.join('shared/tasks/**/*.rake').to_s.freeze
+    LIB_DIRECTORY_NAME = 'lib'.freeze
+    SPEC_DIRECTORY_NAME = 'spec'.freeze
+    RAKE_FILE_NAME = 'Rakefile'.freeze
+    SHARED_SPEC_PATTERN = '{shared,support}/**/*.rb'.freeze
+    UNIT_TEST_PATH_REGEXP = %r{\bspec/unit/}
+    DEFAULT_CONFIG_DIR_NAME = 'config'.freeze
+
+    private_constant(*constants(false))
+
+    # Abort with message when a metric violation occurs.
+    #
+    # @param [String] message
+    # @return [undefined]
+    # @api private
+    def self.notify_metric_violation(message)
+      abort(message)
+    end
+
+    # Initialize project and load tasks. This should *only* be called from an
+    # $application_root/Rakefile.
+    #
+    # @return [self]
+    # @api public
+    def self.init
+      Project::Initializer::Rake.call
+      self
+    end
+
+    # Return devtools root path.
+    #
+    # @return [Pathname]
+    # @api private
+    def self.root
+      ROOT
+    end
+
+    # Return project.
+    #
+    # @return [Project]
+    # @api private
+    def self.project
+      PROJECT
+    end
+  end
+end
+
+require_relative 'devtools/config'
+require_relative 'devtools/project'
+require_relative 'devtools/project/initializer'
+require_relative 'devtools/project/initializer/rake'
+require_relative 'devtools/project/initializer/rspec'
+require_relative 'devtools/flay'
+require_relative 'devtools/rake/flay'
+
+module Central
+  # Self initialization
+  module Devtools
+    PROJECT = Project.new(PROJECT_ROOT)
+  end
+end