devtools 0.1.0

data/lib/devtools/site/initializer.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+module Devtools
+  class Site
+
+    # Supports initializing new projects with a Rakefile
+    class Initializer
+
+      def self.call(root)
+        new(root).call
+      end
+
+      attr_reader :site
+
+      attr_reader :root
+
+      attr_reader :config_dir
+
+      def initialize(site)
+        @site       = site
+        @root       = site.root
+        config_dir  = @root.join(DEFAULT_CONFIG_DIR_NAME).tap(&:mkpath)
+        @config_dir = config_dir.parent
+      end
+
+      # Init devtools using default config
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def call
+        FileUtils.cp_r(DEFAULT_CONFIG_PATH, config_dir)
+
+        site.sync
+        init_rakefile
+
+        self
+      end
+
+      private
+
+      # Initialize the Rakefile
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def init_rakefile
+        rakefile = root.join(RAKE_FILE_NAME)
+        return if rakefile.file? && rakefile.read.include?(INIT_RAKE_TASKS)
+        rakefile.open('a') do |file|
+          file << ANNOTATION_WRAPPER % [REQUIRE, INIT_RAKE_TASKS].join("\n")
+        end
+      end
+
+    end # class Initializer
+  end # class Site
+end # module Devtools

data/lib/devtools/spec_helper.rb

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

data/shared/spec/shared/abstract_type_behavior.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+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,7 @@
+# encoding: utf-8
+
+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,15 @@
+# encoding: utf-8
+
+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,9 @@
+# encoding: utf-8
+
+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,12 @@
+# 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?
+    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,14 @@
+# encoding: utf-8
+
+if defined?(IceNine)
+  module IceNine
+
+    # Freezer namespace
+    class Freezer
+
+      # Rspec freezer
+      class RSpec < NoFreeze; end
+
+    end # Freezer
+  end # IceNine
+end

data/spec/spec_helper.rb

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

data/tasks/metrics/ci.rake

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

data/tasks/metrics/coverage.rake

@@ -0,0 +1,13 @@
+# 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/tasks/metrics/flay.rake

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+namespace :metrics do
+  require 'flay'
+
+  project = Devtools.project
+  config  = project.flay
+
+  # Original code by Marty Andrews:
+  # http://blog.martyandrews.net/2009/05/enforcing-ruby-code-quality.html
+  desc 'Measure code duplication'
+  task :flay do
+    threshold   = config.threshold
+    total_score = config.total_score
+    files       = Flay.expand_dirs_to_files(config.lib_dirs).sort
+
+    # Run flay first to ensure the max mass matches the threshold
+    flay = Flay.new(fuzzy: false, verbose: false, mass: 0)
+    flay.process(*files)
+    flay.analyze
+
+    masses = flay.masses.map do |hash, mass|
+      Rational(mass, flay.hashes[hash].size)
+    end
+
+    max = (masses.max || 0).to_i
+    unless max >= threshold
+      Devtools.notify_metric_violation "Adjust flay threshold down to #{max}"
+    end
+
+    total = masses.inject(:+).to_i
+    unless total == total_score
+      Devtools.notify_metric_violation "Flay total is now #{total}, but expected #{total_score}"
+    end
+
+    # Run flay a second time with the threshold set
+    flay = Flay.new(fuzzy: false, verbose: false, mass: threshold.succ)
+    flay.process(*files)
+    flay.analyze
+
+    mass_size = flay.masses.size
+
+    if mass_size.nonzero?
+      flay.report
+      Devtools.notify_metric_violation "#{mass_size} chunks have a duplicate mass > #{threshold}"
+    end
+  end
+end

data/tasks/metrics/flog.rake

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+namespace :metrics do
+  require 'flog'
+  require 'flog_cli'
+
+  project = Devtools.project
+  config  = project.flog
+
+  # Original code by Marty Andrews:
+  # http://blog.martyandrews.net/2009/05/enforcing-ruby-code-quality.html
+  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
+        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
+
+      Devtools.notify_metric_violation(
+        "#{bad_methods.size} methods have a flog complexity > #{threshold}"
+      )
+    end
+  end
+end

data/tasks/metrics/mutant.rake

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+namespace :metrics do
+  config  = Devtools.project.mutant
+
+  if !ENV['DEVTOOLS_SELF']
+    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
+
+      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)
+
+      status = namespace::CLI.run(arguments)
+      if status.nonzero?
+        Devtools.notify_metric_violation 'Mutant task is not successful'
+      end
+    end
+  else
+    desc 'Measure mutation coverage'
+    task mutant: :coverage do
+      $stderr.puts 'Mutant is disabled'
+    end
+  end
+end

data/tasks/metrics/reek.rake

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+namespace :metrics do
+  task :reek do
+    $stderr.puts 'Reek is disabled due defunct AST processing'
+  end
+end

data/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 = Devtools.project.rubocop
+    begin
+      exit_status = RuboCop::CLI.new.run(%W[--config #{config.config_file.to_s}])
+      fail 'Rubocop not successful' unless exit_status.zero?
+    rescue Encoding::CompatibilityError => exception
+      Devtools.notify_metric_violation exception.message
+    end
+  end
+end

data/tasks/metrics/yardstick.rake

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+namespace :metrics do
+  namespace :yardstick do
+    require 'yardstick/rake/measurement'
+    require 'yardstick/rake/verify'
+
+    # Enable the legacy parser for JRuby until ripper is fully supported
+    if Devtools.jruby?
+      # Remove when https://github.com/lsegal/yard/issues/681 is resolved
+      # This code first requires ripper, then removes the constant so
+      # that it does not trigger a bug in YARD where if it checks if Ripper
+      # is available and assumes other constants are defined, when JRuby's
+      # implementation does not yet.
+      require 'ripper'
+      Object.send(:remove_const, :Ripper)
+      YARD::Parser::SourceParser.parser_type = :ruby18
+    end
+
+    options = Devtools.project.yardstick.options
+
+    Yardstick::Rake::Measurement.new(:measure, options)
+
+    Yardstick::Rake::Verify.new(:verify, options)
+  end
+end

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