devtools 0.1.2 → 0.1.3

data/lib/devtools/flay.rb

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

data/lib/devtools/project.rb

@@ -1,87 +1,22 @@
-# 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,
+      mutant:    Config::Mutant,
+      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 +25,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 +34,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 +59,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 +69,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

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/initializer/rake.rb

@@ -1,16 +1,18 @@
-# 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,33 @@ 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/rake/flay.rb

@@ -0,0 +1,126 @@
+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
+        Devtools.notify_metric_violation(
+          BELOW_THRESHOLD % largest_mass
+        ) if below_threshold?
+
+        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
+        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
+        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
+        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
+        Devtools::Flay::Scale.call(minimum_mass: 0, files: files)
+      end
+      memoize :flay_masses
+    end
+  end
+end