devtools 0.1.0 → 0.1.5

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/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

data/lib/devtools/spec_helper.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'devtools'
 
-Devtools.init_spec_helper
+Devtools::PROJECT.init_rspec

data/lib/devtools.rb

@@ -1,24 +1,24 @@
-# encoding: utf-8
-
+# Stdlib infrastructure
 require 'pathname'
 require 'rake'
 require 'timeout'
 require 'yaml'
 require 'fileutils'
 
-require 'devtools/platform'
-require 'devtools/site'
-require 'devtools/site/initializer'
-require 'devtools/project'
-require 'devtools/config'
-require 'devtools/project/initializer'
-require 'devtools/project/initializer/rake'
-require 'devtools/project/initializer/rspec'
+# Non stdlib infrastructure
+require 'procto'
+require 'anima'
+require 'concord'
+require 'adamantium'
 
-# Provides access to metric tools
-module Devtools
+# Wrapped tools
+require 'flay'
+require 'rspec'
+require 'rspec/its'
+require 'simplecov'
 
-  extend Platform
+# Main devtools namespace population
+module Devtools
 
   ROOT                    = Pathname.new(__FILE__).parent.parent.freeze
   PROJECT_ROOT            = Pathname.pwd.freeze
@@ -28,17 +28,12 @@ module Devtools
   RAKE_FILES_GLOB         = ROOT.join('tasks/**/*.rake').to_s.freeze
   LIB_DIRECTORY_NAME      = 'lib'.freeze
   SPEC_DIRECTORY_NAME     = 'spec'.freeze
-  RB_FILE_PATTERN         = '**/*.rb'.freeze
   RAKE_FILE_NAME          = 'Rakefile'.freeze
-  REQUIRE                 = "require 'devtools'".freeze
-  INIT_RAKE_TASKS         = 'Devtools.init_rake_tasks'.freeze
   SHARED_SPEC_PATTERN     = '{shared,support}/**/*.rb'.freeze
   UNIT_TEST_PATH_REGEXP   = %r{\bspec/unit/}.freeze
   DEFAULT_CONFIG_DIR_NAME = 'config'.freeze
-  ANNOTATION_WRAPPER      = "\n# Added by devtools\n%s\n".freeze
 
-  # Provides devtools for a project
-  SITE = Site.new(Project.new(PROJECT_ROOT))
+  private_constant(*constants(false))
 
   # React to metric violation
   #
@@ -63,26 +58,13 @@ module Devtools
     self
   end
 
-  # Initialize project and load shared specs
-  #
-  # Expects to be called from $application_root/spec/spec_helper.rb
+  # Return devtools root path
   #
-  # @return [self]
+  # @return [Pathname]
   #
-  # @api public
-  def self.init_spec_helper
-    SITE.init_spec_helper
-    self
-  end
-
-  # Initialize devtools using default config
-  #
-  # @return [undefined]
-  #
-  # @api public
-  def self.init
-    SITE.init
-    self
+  # @api private
+  def self.root
+    ROOT
   end
 
   # Return project
@@ -91,53 +73,22 @@ module Devtools
   #
   # @api private
   def self.project
-    SITE.project
+    PROJECT
   end
 
-  # Require shared examples
-  #
-  # @param [Pathname] dir
-  #   the directory containing the files to require
-  #
-  # @param [String] pattern
-  #   the file pattern to match inside directory
-  #
-  # @return [self]
-  #
-  # @api private
-  def self.require_files(dir, pattern)
-    Dir[dir.join(pattern)].each { |file| require file }
-    self
-  end
-
-  # Detect ci
-  #
-  # @return [Boolean]
-  #
-  # @api private
-  #
-  def self.ci?
-    ENV.key?('CI')
-  end
-
-  # Detect circle ci
-  #
-  # @return [Boolean]
-  #
-  # @api private
-  #
-  def self.circle_ci?
-    ENV.key?('CIRCLECI')
-  end
+end # module Devtools
 
-  # Detect travis ci
-  #
-  # @return [Boolean]
-  #
-  # @api private
-  #
-  def self.travis?
-    ENV.key?('TRAVIS')
-  end
+# Devtools implementation
+require 'devtools/config'
+require 'devtools/project'
+require 'devtools/project/initializer'
+require 'devtools/project/initializer/rake'
+require 'devtools/project/initializer/rspec'
+require 'devtools/flay'
+require 'devtools/rake/flay'
 
-end # module Devtools
+# Devtools self initialization
+module Devtools
+  # The project devtools is active for
+  PROJECT = Project.new(PROJECT_ROOT)
+end

data/shared/spec/shared/abstract_type_behavior.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 shared_examples_for 'an abstract type' do
   context 'called on a subclass' do
     let(:object) { Class.new(described_class) }

data/shared/spec/shared/command_method_behavior.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 shared_examples_for 'a command method' do
   it 'returns self' do
     should equal(object)

data/shared/spec/shared/each_method_behaviour.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 shared_examples_for 'an #each method' do
   it_should_behave_like 'a command method'
 

data/shared/spec/shared/hash_method_behavior.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 shared_examples_for 'a hash method' do
   it_should_behave_like 'an idempotent method'
 

data/shared/spec/shared/idempotent_method_behavior.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 shared_examples_for 'an idempotent method' do
   it 'is idempotent' do
     first = subject

data/shared/spec/support/ice_nine_config.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 if defined?(IceNine)
   module IceNine
 

data/spec/integration/devtools/rake/flay/verify_spec.rb

@@ -0,0 +1,164 @@
+describe Devtools::Rake::Flay, '#verify' do
+  let(:tempfile)    { Tempfile.new(%w[file .rb], Dir.mktmpdir) }
+  let(:file)        { Pathname(tempfile.path)                  }
+  let(:directories) { [file.dirname.to_s]                      }
+
+  let(:ruby) do
+    <<-ERUBY
+    def foo; end
+    def bar; end
+    ERUBY
+  end
+
+  around(:each) do |example|
+    begin
+      # silence other flay output
+      $stdout = $stderr = StringIO.new
+
+      tempfile.write(ruby)
+      tempfile.close
+
+      example.run
+    ensure
+      $stdout = STDOUT
+      $stderr = STDERR
+
+      file.unlink
+    end
+  end
+
+  context 'reporting' do
+    let(:options) do
+      { threshold: 3, total_score: 3, lib_dirs: directories, excludes: [] }.freeze
+    end
+
+    let(:instance) { described_class.new(options) }
+
+    it 'measures total mass' do
+      allow(::Flay).to receive(:new).and_call_original
+
+      instance.verify
+
+      expect(::Flay).to have_received(:new).with(hash_including(mass: 0))
+    end
+
+    it 'does not report the files it is processing' do
+      expect { instance.verify }.to_not output(/Processing #{file}/).to_stderr
+    end
+  end
+
+  context 'when theshold is too low' do
+    let(:instance) do
+      described_class.new(threshold: 0, total_score: 0, lib_dirs: directories, excludes: [])
+    end
+
+    specify do
+      expect { instance.verify }
+        .to raise_error(SystemExit)
+        .with_message('Flay total is now 3, but expected 0')
+    end
+  end
+
+  context 'when threshold is too high' do
+    let(:instance) do
+      described_class.new(threshold: 1000, total_score: 0, lib_dirs: directories, excludes: [])
+    end
+
+    specify do
+      expect { instance.verify }
+        .to raise_error(SystemExit)
+        .with_message('Adjust flay threshold down to 3')
+    end
+  end
+
+  context 'when total is too high' do
+    let(:instance) do
+      described_class.new(threshold: 3, total_score: 50, lib_dirs: directories, excludes: [])
+    end
+
+    specify do
+      expect { instance.verify }
+        .to raise_error(SystemExit)
+        .with_message('Flay total is now 3, but expected 50')
+    end
+  end
+
+  context 'when duplicate mass is greater than 0' do
+    let(:ruby) do
+      <<-ERUBY
+      def foo
+        :hi if baz?
+      end
+
+      def bar
+        :hi if baz?
+      end
+      ERUBY
+    end
+
+    let(:report) do
+      <<-REPORT
+Total score (lower is better) = 10
+
+Similar code found in :defn (mass = 10)
+  #{file}:1
+  #{file}:5
+REPORT
+    end
+
+    let(:instance) do
+      described_class.new(threshold: 3, total_score: 5, lib_dirs: directories, excludes: [])
+    end
+
+    specify do
+      expect { instance.verify }
+        .to raise_error(SystemExit)
+        .with_message('1 chunks have a duplicate mass > 3')
+    end
+
+    specify do
+      expect { instance.verify }
+        .to raise_error(SystemExit)
+        .and output(report).to_stdout
+    end
+  end
+
+  context 'when multiple duplicate masses' do
+    let(:ruby) do
+      <<-ERUBY
+      def foo; end
+      def bar; end
+
+      class Foo
+        def initialize
+          @a = 1
+        end
+      end
+      class Bar
+        def initialize
+          @a = 1
+        end
+      end
+      ERUBY
+    end
+
+    let(:instance) do
+      described_class.new(threshold: 5, total_score: 8, lib_dirs: directories, excludes: [])
+    end
+
+    it 'sums masses for total' do
+      expect { instance.verify }.to_not raise_error
+    end
+  end
+
+  context 'when no duplication masses' do
+    let(:ruby) { '' }
+    let(:instance) do
+      described_class.new(threshold: 0, total_score: 0, lib_dirs: directories, excludes: [])
+    end
+
+    specify do
+      expect { instance.verify }.to_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,14 +1,10 @@
-# encoding: utf-8
-
 require 'devtools/spec_helper'
+require 'tempfile'
+require 'tmpdir'
 
 if ENV['COVERAGE'] == 'true'
-  require 'simplecov'
-  require 'coveralls'
-
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
     SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
   ]
 
   SimpleCov.start do
@@ -22,8 +18,6 @@ if ENV['COVERAGE'] == 'true'
   end
 end
 
-require 'devtools'
-
 RSpec.configure do |config|
   config.expect_with :rspec do |expect_with|
     expect_with.syntax = :expect