devtools 0.1.2 → 0.1.3

data/lib/devtools/spec_helper.rb

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

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

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

data/spec/unit/devtools/flay/file_list/call_spec.rb

@@ -0,0 +1,19 @@
+describe Devtools::Flay::FileList, '.call' do
+  subject(:output) { described_class.call([tmpdir.to_s], [exclude]) }
+
+  let(:tmpdir)     { Dir.mktmpdir                     }
+  let(:one)        { Pathname(tmpdir).join('1.rb')    }
+  let(:two)        { Pathname(tmpdir).join('2.erb')   }
+  let(:three)      { Pathname(tmpdir).join('3.rb')    }
+  let(:exclude)    { Pathname(tmpdir).join('3*').to_s }
+
+  around(:each) do |example|
+    [one, two, three].map(&FileUtils.method(:touch))
+
+    example.run
+
+    FileUtils.rm_rf(tmpdir)
+  end
+
+  it { should eql(Set.new([one, two])) }
+end

data/spec/unit/devtools/flay/scale/flay_report_spec.rb

@@ -0,0 +1,17 @@
+describe Devtools::Flay::Scale, '#flay_report' do
+  subject(:instance) { described_class.new(minimum_mass: 0, files: []) }
+
+  let(:flay) do
+    instance_double(::Flay, process: nil, analyze: nil, masses: {})
+  end
+
+  before do
+    allow(::Flay).to receive(:new).with(mass: 0).and_return(flay)
+  end
+
+  specify do
+    allow(flay).to receive(:report)
+    instance.flay_report
+    expect(flay).to have_received(:report)
+  end
+end

data/spec/unit/devtools/flay/scale/measure_spec.rb

@@ -0,0 +1,43 @@
+describe Devtools::Flay::Scale, '#measure' do
+  subject(:measure) { instance.measure }
+
+  let(:minimum_mass) { 0        }
+  let(:files)        { [instance_double(File)] }
+  let(:flay_masses) { { 0 => 5, 1 => 10 } }
+
+  let(:instance) do
+    described_class.new(minimum_mass: minimum_mass, files: files)
+  end
+
+  let(:flay_hashes) do
+    {
+      0 => instance_double(Array, size: 3),
+      1 => instance_double(Array, size: 11)
+    }
+  end
+
+  let(:flay) do
+    instance_double(
+      ::Flay,
+      analyze: nil,
+      masses:  flay_masses,
+      hashes:  flay_hashes
+    )
+  end
+
+  before do
+    allow(::Flay).to receive(:new).with(mass: minimum_mass).and_return(flay)
+    allow(flay).to receive(:process).with(*files)
+  end
+
+  it { should eql([Rational(5, 3), Rational(10, 11)]) }
+
+  context 'when minimum mass is not 0' do
+    let(:minimum_mass) { 1 }
+
+    specify do
+      measure
+      expect(::Flay).to have_received(:new).with(mass: 1)
+    end
+  end
+end

data/spec/unit/devtools/project/initializer/rake_spec.rb

@@ -0,0 +1,21 @@
+describe Devtools::Project::Initializer::Rake do
+  describe '.call' do
+    subject do
+      described_class.call
+    end
+
+    it 'performs expected rake initialization' do
+      path_a = instance_double(Pathname)
+      path_b = instance_double(Pathname)
+
+      expect(FileList).to receive(:glob)
+        .with(Devtools.root.join('tasks/**/*.rake').to_s)
+        .and_return([path_a, path_b])
+
+      expect(Rake.application).to receive(:add_import).with(path_a)
+      expect(Rake.application).to receive(:add_import).with(path_b)
+
+      expect(subject).to be(described_class)
+    end
+  end
+end