central-devtools 0.8.3

data/shared/spec/shared/abstract_type_behavior.rb

@@ -0,0 +1,16 @@
+shared_examples_for 'an abstract type' do
+  context 'called on a subclass' do
+    let(:object) { Class.new(described_class) }
+
+    it { should be_instance_of(object) }
+  end
+
+  context 'called on the class' do
+    let(:object) { described_class }
+
+    specify do
+      expect { subject }
+        .to raise_error(NotImplementedError, "#{object} is an abstract type")
+    end
+  end
+end

data/shared/spec/shared/command_method_behavior.rb

@@ -0,0 +1,5 @@
+shared_examples_for 'a command method' do
+  it 'returns self' do
+    should equal(object)
+  end
+end

data/shared/spec/shared/each_method_behaviour.rb

@@ -0,0 +1,13 @@
+shared_examples_for 'an #each method' do
+  it_should_behave_like 'a command method'
+
+  context 'with no block' do
+    subject { object.each }
+
+    it { should be_instance_of(to_enum.class) }
+
+    it 'yields the expected values' do
+      expect(subject.to_a).to eql(object.to_a)
+    end
+  end
+end

data/shared/spec/shared/hash_method_behavior.rb

@@ -0,0 +1,7 @@
+shared_examples_for 'a hash method' do
+  it_should_behave_like 'an idempotent method'
+
+  it 'is a Fixnum' do
+    should be_instance_of(Fixnum)
+  end
+end

data/shared/spec/shared/idempotent_method_behavior.rb

@@ -0,0 +1,10 @@
+shared_examples_for 'an idempotent method' do
+  it 'is idempotent' do
+    first = subject
+    fail 'RSpec not configured for threadsafety' unless RSpec.configuration.threadsafe?
+    mutex = __memoized.instance_variable_get(:@mutex)
+    memoized = __memoized.instance_variable_get(:@memoized)
+    mutex.synchronize { memoized.delete(:subject) }
+    should equal(first)
+  end
+end

data/shared/spec/support/ice_nine_config.rb

@@ -0,0 +1,9 @@
+if defined?(IceNine)
+  module IceNine
+    # Freezer namespace
+    class Freezer
+      # Rspec freezer
+      class RSpec < NoFreeze; end
+    end # Freezer
+  end # IceNine
+end

data/shared/tasks/docker.rake

@@ -0,0 +1,80 @@
+# encoding: UTF-8
+
+require 'colorize'
+require 'tty'
+
+options = Central::Devtools.project.container.options
+version = options['build_tag'].to_s
+versions = if version.nil? || version == 'latest'
+             ['latest']
+           else
+             ['latest', version.match(/(\d+\.\d+)/)[1]].freeze
+           end
+name = "#{options['prefix']}/#{options['component']}"
+from = "#{options['from_image']}:#{options['from_version']}"
+
+def msg(text)
+  ttable = TTY::Table.new
+  ttable << [text]
+  renderer = TTY::Table::Renderer::Unicode.new(ttable)
+  renderer.border.style = :red
+  puts renderer.render
+end
+
+def pull
+  " ↓ ".colorize(:red)
+end
+
+def push
+  " ↑ ".colorize(:light_red)
+end
+
+def tag
+  " ✓ ".colorize(:green)
+end
+
+def spin
+  " ↻ ".colorize(:cyan)
+end
+
+def sync
+  " ⎘ ".colorize(:light_green)
+end
+
+def build
+  " ◴ ".colorize(:light_magenta)
+end
+
+namespace :docker do
+  desc "Build #{name} container from #{from}"
+  task build: ['docker:build:task']
+
+  namespace :build do
+    task :task, :name, :version do |_t, _args|
+      msg "#{pull} docker pull #{from.colorize(:cyan)} "
+      sh "docker pull #{from}"
+      msg "#{build} docker build --no-cache --force-rm -t #{name.colorize(:cyan)}:#{version.colorize(:cyan)} "
+      sh "docker build --no-cache --force-rm -t #{name}:#{version} ."
+
+      versions.each do |v|
+        msg "#{tag} docker tag #{name.colorize(:yellow)}:#{version.colorize(:cyan)} #{name.colorize(:yellow)}:#{v.colorize(:cyan)} "
+        sh "docker tag #{name}:#{version} #{name}:#{v}"
+      end
+    end
+  end
+
+  desc "Push image #{name}"
+  task push: ['docker:push:task']
+
+  namespace :push do
+    task task: ['docker:build'] do
+      msg "#{push} docker push #{name.colorize(:cyan)}:#{version.colorize(:cyan)} "
+      sh "docker push #{name}:#{version}"
+
+      versions.each do |v|
+        msg "#{push} docker push #{name.colorize(:yellow)}:#{v.colorize(:cyan)} "
+        sh "docker push #{name}:#{v}"
+      end
+    end
+  end
+end

data/shared/tasks/metrics/ci.rake

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+desc 'Run all specs, metrics and mutant'
+task ci: %w(ci:metrics metrics:mutant)
+
+namespace :ci do
+  tasks = %w(
+    metrics:coverage
+    metrics:yardstick:verify
+    metrics:rubocop
+    metrics:flog
+    metrics:flay
+    metrics:reek
+    spec:integration
+  )
+
+  desc 'Run metrics (except mutant)'
+  task metrics: tasks
+end

data/shared/tasks/metrics/coverage.rake

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+
+namespace :metrics do
+  desc 'Measure code coverage'
+  task :coverage do
+    begin
+      original = ENV['COVERAGE']
+      ENV['COVERAGE'] = 'true'
+      Rake::Task['spec:unit'].execute
+    ensure
+      ENV['COVERAGE'] = original
+    end
+  end
+end

data/shared/tasks/metrics/flay.rake

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+namespace :metrics do
+  require 'flay'
+
+  project = Central::Devtools.project
+  config = project.flay
+
+  desc 'Measure code duplication'
+  task :flay do
+    threshold = config.threshold
+    total_score = config.total_score
+
+    Central::Devtools::Rake::Flay.call(
+      threshold: threshold,
+      total_score: total_score,
+      lib_dirs: config.lib_dirs,
+      excludes: config.excludes
+    )
+  end
+end

data/shared/tasks/metrics/flog.rake

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+
+namespace :metrics do
+  require 'flog'
+  require 'flog_cli'
+
+  project = Central::Devtools.project
+  config = project.flog
+
+  desc 'Measure code complexity'
+  task :flog do
+    threshold = config.threshold.to_f.round(1)
+    flog = Flog.new
+    flog.flog(*FlogCLI.expand_dirs_to_files(config.lib_dirs))
+
+    totals = flog.totals.select { |name, _score| name[-5, 5] != '#none' }
+                 .map { |name, score| [name, score.round(1)] }
+                 .sort_by { |_name, score| score }
+
+    if totals.any?
+      max = totals.last[1]
+      unless max >= threshold
+        Central::Devtools.notify_metric_violation "Adjust flog score down to #{max}"
+      end
+    end
+
+    bad_methods = totals.select { |_name, score| score > threshold }
+    if bad_methods.any?
+      bad_methods.reverse_each do |name, score|
+        printf "%8.1f: %s\n", score, name
+      end
+
+      Central::Devtools.notify_metric_violation(
+        "#{bad_methods.size} methods have a flog complexity > #{threshold}"
+      )
+    end
+  end
+end

data/shared/tasks/metrics/mutant.rake

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+
+namespace :metrics do
+  config = Central::Devtools.project.mutant
+
+  desc 'Measure mutation coverage'
+  task mutant: :coverage do
+    require 'mutant'
+
+    namespace =
+      if config.zombify
+        Mutant.zombify
+        Zombie::Mutant
+      else
+        Mutant
+      end
+
+    namespaces = Array(config.namespace).map { |n| "#{n}*" }
+
+    ignore_subjects = config.ignore_subjects.flat_map do |matcher|
+      %W(--ignore #{matcher})
+    end
+
+    jobs = ENV.key?('CIRCLECI') ? %w(--jobs 4) : []
+
+    since =
+      if config.since
+        %W(--since #{config.since})
+      else
+        []
+      end
+
+    arguments = %W(
+      --include lib
+      --require #{config.name}
+      --expect-coverage #{config.expect_coverage}
+      --use #{config.strategy}
+    ).concat(ignore_subjects).concat(namespaces).concat(since).concat(jobs)
+
+    unless namespace::CLI.run(arguments)
+      Central::Devtools.notify_metric_violation('Mutant task is not successful')
+    end
+  end
+end

data/shared/tasks/metrics/reek.rake

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+namespace :metrics do
+  require 'reek/rake/task'
+
+  Reek::Rake::Task.new do |reek|
+    reek.source_files = '{app,lib}/**/*.rb'
+    reek.config_file  = 'config/reek.yml'
+  end
+end

data/shared/tasks/metrics/rubocop.rake

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+
+namespace :metrics do
+  desc 'Check with code style guide'
+  task :rubocop do
+    require 'rubocop'
+    config = Central::Devtools.project.rubocop
+    begin
+      exit_status = RuboCop::CLI.new.run(%W(--config #{config.config_file}))
+      fail 'Rubocop not successful' unless exit_status.zero?
+    rescue Encoding::CompatibilityError => exception
+      Central::Devtools.notify_metric_violation exception.message
+    end
+  end
+end

data/shared/tasks/metrics/yardstick.rake

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+
+namespace :metrics do
+  namespace :yardstick do
+    require 'yardstick/rake/measurement'
+    require 'yardstick/rake/verify'
+
+    options = Central::Devtools.project.yardstick.options
+
+    if options['threshold']
+      Yardstick::Rake::Measurement.new(:measure, options)
+      Yardstick::Rake::Verify.new(:verify, options)
+    end
+  end
+end

data/shared/tasks/spec.rake

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+
+begin
+  require 'rspec/core/rake_task'
+
+  # Remove existing same-named tasks
+  %w(spec spec:unit spec:integration).each do |task|
+    klass = Rake::Task
+    klass[task].clear if klass.task_defined?(task)
+  end
+
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.pattern = 'spec/{unit,integration}/**/*_spec.rb'
+  end
+
+  namespace :spec do
+    desc 'Run unit specs'
+    RSpec::Core::RakeTask.new(:unit) do |task|
+      task.pattern = 'spec/unit/**/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    RSpec::Core::RakeTask.new(:integration) do |task|
+      task.pattern = 'spec/integration/**/*_spec.rb'
+    end
+  end
+rescue LoadError
+  %w(spec spec:unit spec:integration).each do |name|
+    task name do
+      $stderr.puts "In order to run #{name}, do: gem install rspec"
+    end
+  end
+end
+
+task test: :spec

data/shared/tasks/yard.rake

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+begin
+  require 'yard'
+
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    $stderr.puts 'In order to run yard, you must: gem install yard'
+  end
+end

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

@@ -0,0 +1,166 @@
+# encoding: UTF-8
+
+describe Central::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

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+require 'central/devtools/spec_helper'
+require 'tempfile'
+require 'tmpdir'
+
+if ENV['COVERAGE'] == 'true'
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec:unit'
+
+    add_filter 'config'
+    add_filter 'spec'
+    add_filter 'vendor'
+
+    minimum_coverage 100
+  end
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expect_with|
+    expect_with.syntax = :expect
+  end
+end

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

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+RSpec.describe Central::Devtools::Config::Yardstick do
+  let(:object) { described_class.new(Central::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/central/devtools/config_spec.rb

@@ -0,0 +1,75 @@
+# encoding: UTF-8
+
+RSpec.describe Central::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(
+          Central::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/central/devtools/flay/file_list/call_spec.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+describe Central::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