devtools 0.1.0 → 0.1.26

data/lib/devtools/rake/flay.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+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 %<mass>d'
+      TOTAL_MISMATCH  = 'Flay total is now %<mass>d, but expected %<expected>d'
+      ABOVE_THRESHOLD = '%<mass>d chunks have a duplicate mass > %<threshold>d'
+
+      # Verify code specified by `files` does not violate flay expectations
+      #
+      # @raise [SystemExit] if a violation is found
+      # @return [undefined] otherwise
+      #
+      #
+      # @api private
+      def verify
+        # Run flay first to ensure the max mass matches the threshold
+        below_threshold_message if below_threshold?
+
+        total_mismatch_message if total_mismatch?
+
+        # Run flay a second time with the threshold set
+        return unless above_threshold?
+
+        restricted_flay_scale.flay_report
+        above_threshold_message
+      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
+
+      # Above threshold message
+      #
+      # @return [String]
+      #
+      # @api private
+      def above_threshold_message
+        format_values = { mass: restricted_mass_size, threshold: threshold }
+        Devtools.notify_metric_violation(
+          format(ABOVE_THRESHOLD, format_values)
+        )
+      end
+
+      # Below threshold message
+      #
+      # @return [String]
+      #
+      # @api private
+      def below_threshold_message
+        Devtools.notify_metric_violation(
+          format(BELOW_THRESHOLD, mass: largest_mass)
+        )
+      end
+
+      # Total mismatch message
+      #
+      # @return [String]
+      #
+      # @api private
+      def total_mismatch_message
+        Devtools.notify_metric_violation(
+          format(TOTAL_MISMATCH, mass: total_mass, expected: 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,44 +1,41 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
+# 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'
-
-# Provides access to metric tools
-module Devtools
+# Non stdlib infrastructure
+require 'abstract_type'
+require 'procto'
+require 'anima'
+require 'concord'
+require 'adamantium'
 
-  extend Platform
+# Wrapped tools
+require 'flay'
+require 'rspec'
+require 'rspec/its'
+require 'simplecov'
 
+# Main devtools namespace population
+module Devtools
   ROOT                    = Pathname.new(__FILE__).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('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
+  LIB_DIRECTORY_NAME      = 'lib'
+  SPEC_DIRECTORY_NAME     = 'spec'
+  RAKE_FILE_NAME          = 'Rakefile'
+  SHARED_SPEC_PATTERN     = '{shared,support}/**/*.rb'
+  UNIT_TEST_PATH_REGEXP   = %r{\bspec/unit/}
+  DEFAULT_CONFIG_DIR_NAME = 'config'
 
-  # Provides devtools for a project
-  SITE = Site.new(Project.new(PROJECT_ROOT))
+  private_constant(*constants(false))
 
   # React to metric violation
   #
@@ -63,26 +60,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 +75,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/idempotent_method_behavior.rb

@@ -1,9 +1,8 @@
-# encoding: utf-8
-
 shared_examples_for 'an idempotent method' do
   it 'is idempotent' do
     first = subject
-    fail 'RSpec not configured for threadsafety' unless RSpec.configuration.threadsafe?
+    error = 'RSpec not configured for threadsafety'
+    fail error unless RSpec.configuration.threadsafe?
     mutex = __memoized.instance_variable_get(:@mutex)
     memoized = __memoized.instance_variable_get(:@memoized)
     mutex.synchronize { memoized.delete(: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,196 @@
+# frozen_string_literal: true
+
+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: [] }
+    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
+
+        1) 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,15 +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
-  ]
+  formatter = [SimpleCov::Formatter::HTMLFormatter]
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(formatter)
 
   SimpleCov.start do
     command_name 'spec:unit'
@@ -22,8 +17,6 @@ if ENV['COVERAGE'] == 'true'
   end
 end
 
-require 'devtools'
-
 RSpec.configure do |config|
   config.expect_with :rspec do |expect_with|
     expect_with.syntax = :expect

data/spec/unit/devtools/config/yardstick_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe Devtools::Config::Yardstick do
+  let(:object) { described_class.new(Devtools.root.join('config')) }
+
+  describe '#options' do
+    subject { object.options }
+
+    specify do
+      should eql(
+        'threshold'               => 100,
+        'rules'                   => nil,
+        'verbose'                 => nil,
+        'path'                    => nil,
+        'require_exact_threshold' => nil
+      )
+    end
+  end
+end

data/spec/unit/devtools/config_spec.rb

@@ -0,0 +1,78 @@
+RSpec.describe Devtools::Config do
+
+  describe '.attribute' do
+    let(:raw) do
+      {
+        'a' => 'bar',
+        'c' => []
+      }
+
+    end
+
+    let(:config_path) { instance_double(Pathname) }
+
+    let(:class_under_test) do
+      expect(config_path).to receive(:file?)
+        .and_return(file?)
+      expect(config_path).to receive(:frozen?)
+        .and_return(true)
+      expect(config_path).to receive(:join)
+        .with('bar.yml')
+        .and_return(config_path)
+
+      Class.new(described_class) do
+        attribute :a, [String]
+        attribute :b, [Array], default: []
+        attribute :c, [TrueClass, FalseClass]
+
+        const_set(:FILE, 'bar.yml')
+      end
+    end
+
+    subject do
+      class_under_test.new(config_path)
+    end
+
+    context 'on present config' do
+      let(:class_under_test) do
+        # Setup message expectation in a lasy way, not in a before
+        # block to make sure the around hook setting timeouts from the
+        # code under test is not affected.
+        expect(YAML).to receive(:load_file)
+          .with(config_path)
+          .and_return(raw)
+
+        expect(IceNine).to receive(:deep_freeze)
+          .with(raw)
+          .and_return(raw)
+
+        super()
+      end
+
+      let(:file?) { true }
+
+      it 'allows to receive existing keys' do
+        expect(subject.a).to eql('bar')
+      end
+
+      it 'allows to receive absent keys with defaults' do
+        expect(subject.b).to eql([])
+      end
+
+      it 'executes checks when configured' do
+        expect { subject.c }.to raise_error(
+          Devtools::Config::TypeError,
+          'c: Got instance of Array expected TrueClass,FalseClass'
+        )
+      end
+    end
+
+    context 'on absent config' do
+      let(:file?) { false }
+
+      it 'defaults to absent keys' do
+        expect(subject.b).to eql([])
+      end
+    end
+  end
+end