devtools 0.1.0 → 0.1.26

data/lib/devtools/config.rb

@@ -1,48 +1,67 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 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)
+
+      ERROR_FORMAT = '%<name>s: Got instance of %<got>s expected %<allowed>s'
+      CLASS_DELIM  = ','
+
+      # Check value for instance of expected class
+      #
+      # @param [Object] value
+      #
+      # @return [Object]
+      def call(value)
+        klass = value.class
+        format_values = {
+          name: name,
+          got: klass,
+          allowed: allowed_classes.join(CLASS_DELIM)
+        }
+
+        unless allowed_classes.any?(&klass.method(:equal?))
+          fail TypeError, format(ERROR_FORMAT, format_values)
+        end
+
+        value
+      end
+    end # TypeCheck
+
+    private_constant(*constants(false))
+
+    # Error raised on type errors
+    TypeError = Class.new(RuntimeError)
+
     # Declare an attribute
     #
     # @param [Symbol] name
-    #
-    # @yieldreturn [Object]
-    #   the default value to use
+    # @param [Array<Class>] classes
     #
     # @api private
     #
     # @return [self]
     #
-    def self.attribute(name, *default)
+    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
-        raw.fetch(name.to_s, *default)
+        type_check.call(raw.fetch(key, *default))
       end
     end
     private_class_method :attribute
 
-    # Return project
-    #
-    # @return [Project]
-    #
-    # @api private
-    #
-    attr_reader :project
-
-    # Initialize object
-    #
-    # @return [Project]
-    #
-    # @api private
-    #
-    def initialize(project)
-      @project = project
-    end
-
     # Return config path
     #
     # @return [String]
@@ -50,8 +69,9 @@ module Devtools
     # @api private
     #
     def config_file
-      @config_file ||= project.config_dir.join(self.class::FILE).freeze
+      config_dir.join(self.class::FILE)
     end
+    memoize :config_file
 
   private
 
@@ -62,8 +82,9 @@ module Devtools
     # @api private
     #
     def raw
-      @raw ||= yaml_config || DEFAULT_CONFIG
+      yaml_config || DEFAULT_CONFIG
     end
+    memoize :raw
 
     # Return the raw config data from a yaml file
     #
@@ -75,33 +96,35 @@ module Devtools
     # @api private
     #
     def yaml_config
-      config_file = self.config_file
-      YAML.load_file(config_file).freeze if config_file.file?
+      IceNine.deep_freeze(YAML.load_file(config_file)) if config_file.file?
     end
 
     # Rubocop configuration
     class Rubocop < self
-      FILE = 'rubocop.yml'.freeze
-    end
+      FILE = 'rubocop.yml'
+    end # Rubocop
 
     # Reek configuration
     class Reek < self
-      FILE = 'reek.yml'.freeze
-    end
+      FILE = 'reek.yml'
+    end # Reek
 
     # Flay configuration
+    #
     class Flay < self
-      FILE             = 'flay.yml'.freeze
+      FILE             = 'flay.yml'
       DEFAULT_LIB_DIRS = %w[lib].freeze
+      DEFAULT_EXCLUDES = %w[].freeze
 
-      attribute :total_score
-      attribute :threshold
-      attribute :lib_dirs, DEFAULT_LIB_DIRS
-    end
+      attribute :total_score, [0.class]
+      attribute :threshold,   [0.class]
+      attribute :lib_dirs,    [Array], default: DEFAULT_LIB_DIRS
+      attribute :excludes,    [Array], default: DEFAULT_EXCLUDES
+    end # Flay
 
     # Yardstick configuration
     class Yardstick < self
-      FILE    = 'yardstick.yml'.freeze
+      FILE    = 'yardstick.yml'
       OPTIONS = %w[
         threshold
         rules
@@ -120,39 +143,24 @@ module Devtools
           hash[name] = raw.fetch(name, nil)
         end
       end
-    end
+    end # Yardstick
 
     # Flog configuration
     class Flog < self
-      FILE                      = 'flog.yml'.freeze
-      DEFAULT_LIB_DIRS          = %w[lib].freeze
-
-      attribute :total_score
-      attribute :threshold
-      attribute :lib_dirs,          DEFAULT_LIB_DIRS
-    end
+      FILE             = 'flog.yml'
+      DEFAULT_LIB_DIRS = %w[lib].freeze
 
-    # Mutant configuration
-    class Mutant < self
-      FILE             = 'mutant.yml'.freeze
-      DEFAULT_NAME     = ''.freeze
-      DEFAULT_STRATEGY = 'rspec'.freeze
-
-      attribute :name,            DEFAULT_NAME
-      attribute :strategy,        DEFAULT_STRATEGY
-      attribute :zombify,         false
-      attribute :since,           nil
-      attribute :ignore_subjects, []
-      attribute :expect_coverage, 1
-      attribute :namespace
-    end
+      attribute :total_score, [Float]
+      attribute :threshold,   [Float]
+      attribute :lib_dirs,    [Array], default: DEFAULT_LIB_DIRS
+    end # Flog
 
     # Devtools configuration
     class Devtools < self
-      FILE = 'devtools.yml'.freeze
+      FILE                      = 'devtools.yml'
       DEFAULT_UNIT_TEST_TIMEOUT = 0.1  # 100ms
 
-      attribute :unit_test_timeout, DEFAULT_UNIT_TEST_TIMEOUT
-    end
-  end
-end
+      attribute :unit_test_timeout, [Float], default: DEFAULT_UNIT_TEST_TIMEOUT
+    end # Devtools
+  end # Config
+end # Devtools

data/lib/devtools/flay.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+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)
+
+      GLOB = '**/*.{rb,erb}'
+
+      # 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
+        PathExpander.new(includes.dup, GLOB).process
+      end
+    end
+  end
+end

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

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

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Devtools
   class Project
     class Initializer
@@ -7,72 +5,33 @@ module Devtools
       # Requires all shared specs in a project's spec_helper
       # Also installs a configurable unit test timeout
       class Rspec < self
+        include Concord.new(:project)
 
-        def self.require_files(directory)
-          Devtools.require_files(directory, SHARED_SPEC_PATTERN)
-        end
-
-        # Initialize RSpec for +project+
+        # Call initializer for project
         #
         # @param [Project] project
-        #   the project to initialize
         #
-        # @return [Rspec]
+        # @return [self]
         #
         # @api private
         def self.call(project)
-          new(project).call
+          new(project).__send__(:call)
+          self
         end
 
-        # The spec root
-        #
-        # @return [Pathname]
-        #
-        # @api private
-        attr_reader :spec_root
-        private :spec_root
+      private
 
-        # The unit test timeout
-        #
-        # @return [Numeric]
-        #
-        # @api private
-        attr_reader :unit_test_timeout
-        private :unit_test_timeout
-
-        # Initialize a new instance
-        #
-        # @param [Project] project
-        #   the project to initialize
-        #
-        # @param [Numeric] unit_test_timeout
-        #   the maximum time a single unit test can take
-        #
-        # @return [undefined]
-        #
-        # @api private
-        def initialize(project)
-          super
-          @spec_root         = project.spec_root
-          @unit_test_timeout = project.unit_test_timeout
-        end
-
-        # Setup RSpec for {#project}
+        # Setup RSpec for project
         #
         # @return [self]
         #
         # @api private
         def call
-          require 'rspec'
-          require 'rspec/its'
           require_shared_spec_files
-          enable_unit_test_timeout unless Devtools.jit?
-          self
+          enable_unit_test_timeout
         end
 
-        private
-
-        # Timeout unit tests that take longer than 1/10th of a second
+        # Timeout unit tests that take longer than configured amount of time
         #
         # @param [Numeric] timeout
         #
@@ -84,19 +43,35 @@ module Devtools
         # @api private
         #
         def enable_unit_test_timeout
-          timeout = unit_test_timeout # support the closure
-          RSpec.configuration.around file_path: UNIT_TEST_PATH_REGEXP do |example|
+          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(spec_root)
+          require_files(project.spec_root)
         end
 
-        def require_files(directory)
-          self.class.require_files(directory)
+        # 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 # class Rspec

data/lib/devtools/project/initializer.rb

@@ -1,21 +1,11 @@
-# encoding: utf-8
-
 module Devtools
   class Project
 
     # Base class for project initializers
     class Initializer
+      include AbstractType
 
-      attr_reader :project
-      protected :project
-
-      def initialize(project)
-        @project = project
-      end
-
-      def call
-        fail NotImplementedError, "#{self.class}##{__method__} must be implemented"
-      end
+      abstract_singleton_method :call
     end # class Initializer
   end # class Project
 end # module Devtools

data/lib/devtools/project.rb

@@ -1,87 +1,21 @@
-# encoding: utf-8
-
 module Devtools
 
   # The project devtools supports
   class Project
+    include Concord.new(:root)
 
-    # The reek configuration
-    #
-    # @return [Config::Reek]
-    #
-    # @api private
-    attr_reader :reek
-
-    # The rubocop configuration
-    #
-    # @return [Config::Rubocop]
-    #
-    # @api private
-    attr_reader :rubocop
+    CONFIGS = {
+      devtools:  Config::Devtools,
+      flay:      Config::Flay,
+      flog:      Config::Flog,
+      reek:      Config::Reek,
+      rubocop:   Config::Rubocop,
+      yardstick: Config::Yardstick
+    }.freeze
 
-    # The flog configuration
-    #
-    # @return [Config::Flog]
-    #
-    # @api private
-    attr_reader :flog
+    private_constant(*constants(false))
 
-    # The yardstick configuration
-    #
-    # @return [Config::Yardstick]
-    #
-    # @api private
-    attr_reader :yardstick
-
-    # The flay configuration
-    #
-    # @return [Config::Flay]
-    #
-    # @api private
-    attr_reader :flay
-
-    # The mutant configuration
-    #
-    # @return [Config::Mutant]
-    #
-    # @api private
-    attr_reader :mutant
-
-    # The devtools configuration
-    #
-    # @return [Config::Devtools]
-    #
-    # @api private
-    attr_reader :devtools
-
-    # Return project root
-    #
-    # @return [Pathname]
-    #
-    # @api private
-    #
-    attr_reader :root
-
-    # The default config path
-    #
-    # @return [Pathname]
-    #
-    # @api private
-    attr_reader :default_config_path
-
-    # The lib directory
-    #
-    # @return [Pathname]
-    #
-    # @api private
-    attr_reader :lib_dir
-
-    # The Ruby file pattern
-    #
-    # @return [Pathname]
-    #
-    # @api private
-    attr_reader :file_pattern
+    attr_reader(*CONFIGS.keys)
 
     # The spec root
     #
@@ -90,20 +24,6 @@ module Devtools
     # @api private
     attr_reader :spec_root
 
-    # Return config directory
-    #
-    # @return [Pathname]
-    #
-    # @api private
-    attr_reader :config_dir
-
-    # The unit test timeout
-    #
-    # @return [Numeric]
-    #
-    # @api private
-    attr_reader :unit_test_timeout
-
     # Initialize object
     #
     # @param [Pathname] root
@@ -113,12 +33,20 @@ module Devtools
     # @api private
     #
     def initialize(root)
-      @root = root
+      super(root)
 
       initialize_environment
       initialize_configs
+    end
 
-      @unit_test_timeout = @devtools.unit_test_timeout
+    # Init rspec
+    #
+    # @return [self]
+    #
+    # @api private
+    def init_rspec
+      Initializer::Rspec.call(self)
+      self
     end
 
   private
@@ -130,11 +58,7 @@ module Devtools
     # @api private
     #
     def initialize_environment
-      @default_config_path = @root.join(DEFAULT_CONFIG_DIR_NAME).freeze
-      @lib_dir             = @root.join(LIB_DIRECTORY_NAME).freeze
-      @spec_root           = @root.join(SPEC_DIRECTORY_NAME).freeze
-      @file_pattern        = @lib_dir.join(RB_FILE_PATTERN).freeze
-      @config_dir          = @default_config_path
+      @spec_root = root.join(SPEC_DIRECTORY_NAME)
     end
 
     # Initialize configs
@@ -144,13 +68,11 @@ module Devtools
     # @api private
     #
     def initialize_configs
-      @reek      = Config::Reek.new(self)
-      @rubocop   = Config::Rubocop.new(self)
-      @flog      = Config::Flog.new(self)
-      @yardstick = Config::Yardstick.new(self)
-      @flay      = Config::Flay.new(self)
-      @mutant    = Config::Mutant.new(self)
-      @devtools  = Config::Devtools.new(self)
+      config_dir = root.join(DEFAULT_CONFIG_DIR_NAME)
+
+      CONFIGS.each do |name, klass|
+        instance_variable_set(:"@#{name}", klass.new(config_dir))
+      end
     end
 
   end # class Project