hound-tools 0.0.4

data/lib/hound/tools/template.rb

@@ -0,0 +1,38 @@
+module Hound
+  module Tools
+    module Template
+      class InvalidTemplate < RuntimeError
+      end
+
+      attr_reader :filename
+
+      def initialize(filename)
+        @filename = filename
+      end
+
+      def generate
+        _validate(IO.read(@filename))
+        $stdout.puts "#{@filename} (seems ok - skipped)"
+        true
+      rescue Errno::ENOENT
+        Pathname.new(@filename).dirname.mkpath
+        IO.write(@filename, _template_for(@filename))
+        $stdout.puts "#{@filename} created"
+      rescue InvalidTemplate => e
+        $stderr.puts "Error: #{@filename} is invalid! (#{e.message})"
+      end
+
+      private
+
+      def _template_for(file)
+        template_dir = Pathname.new(__FILE__).expand_path.dirname + 'templates'
+        path = template_dir + file.sub(/^\./, '_.')
+        path.read
+      end
+
+      def _validate(_data)
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/hound/tools/templates/_.hound.yml

@@ -0,0 +1,6 @@
+ruby:
+  enabled: true
+  config_file: .rubocop_merged_for_hound.yml
+
+coffee_script:
+  enabled: true

data/lib/hound/tools/templates/_.hound/defaults.yml

@@ -0,0 +1,265 @@
+#
+# NOTE: * DO NOT EDIT THIS FILE! *
+#
+# This file should match the config/style_guides/ruby.yml from the
+# thoughtbot/hound project
+
+AllCops:
+  Exclude:
+    - db/schema.rb
+
+AccessorMethodName:
+  Enabled: false
+
+ActionFilter:
+  Enabled: false
+
+Alias:
+  Enabled: false
+
+ArrayJoin:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+AsciiIdentifiers:
+  Enabled: false
+
+Attr:
+  Enabled: false
+
+BlockNesting:
+  Enabled: false
+
+CaseEquality:
+  Enabled: false
+
+CharacterLiteral:
+  Enabled: false
+
+ClassAndModuleChildren:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+ClassVars:
+  Enabled: false
+
+CollectionMethods:
+  PreferredMethods:
+    find: detect
+    reduce: inject
+    collect: map
+    find_all: select
+
+ColonMethodCall:
+  Enabled: false
+
+CommentAnnotation:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+Delegate:
+  Enabled: false
+
+DeprecatedHashMethods:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+DotPosition:
+  EnforcedStyle: trailing
+
+DoubleNegation:
+  Enabled: false
+
+EachWithObject:
+  Enabled: false
+
+EmptyLiteral:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+EvenOdd:
+  Enabled: false
+
+FileName:
+  Enabled: false
+
+FlipFlop:
+  Enabled: false
+
+FormatString:
+  Enabled: false
+
+GlobalVars:
+  Enabled: false
+
+GuardClause:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+IfWithSemicolon:
+  Enabled: false
+
+InlineComment:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+LambdaCall:
+  Enabled: false
+
+LineEndConcatenation:
+  Enabled: false
+
+LineLength:
+  Max: 80
+
+MethodLength:
+  Enabled: false
+
+ModuleFunction:
+  Enabled: false
+
+NegatedIf:
+  Enabled: false
+
+NegatedWhile:
+  Enabled: false
+
+Next:
+  Enabled: false
+
+NilComparison:
+  Enabled: false
+
+Not:
+  Enabled: false
+
+NumericLiterals:
+  Enabled: false
+
+OneLineConditional:
+  Enabled: false
+
+OpMethod:
+  Enabled: false
+
+ParameterLists:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  Enabled: false
+
+PerlBackrefs:
+  Enabled: false
+
+PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
+Proc:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+SelfAssignment:
+  Enabled: false
+
+SingleLineBlockParams:
+  Enabled: false
+
+SingleLineMethods:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+SpecialGlobalVars:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+VariableInterpolation:
+  Enabled: false
+
+TrailingComma:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false
+
+VariableInterpolation:
+  Enabled: false
+
+WhenThen:
+  Enabled: false
+
+WhileUntilModifier:
+  Enabled: false
+
+WordArray:
+  Enabled: false
+
+# Lint
+
+AmbiguousOperator:
+  Enabled: false
+
+AmbiguousRegexpLiteral:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+ConditionPosition:
+  Enabled: false
+
+DeprecatedClassMethods:
+  Enabled: false
+
+ElseLayout:
+  Enabled: false
+
+HandleExceptions:
+  Enabled: false
+
+InvalidCharacterLiteral:
+  Enabled: false
+
+LiteralInCondition:
+  Enabled: false
+
+LiteralInInterpolation:
+  Enabled: false
+
+Loop:
+  Enabled: false
+
+ParenthesesAsGroupedExpression:
+  Enabled: false
+
+RequireParentheses:
+  Enabled: false
+
+UnderscorePrefixedVariableName:
+  Enabled: false
+
+Void:
+  Enabled: false

data/lib/hound/tools/templates/_.hound/overrides.yml

@@ -0,0 +1,19 @@
+# NOTE: DO NOT put a 'inheried_from' in this file, because Hound with silently
+# ignore it
+#
+# Files you want to exclude
+AllCops:
+  # Rails cops (so we don't need to run with -R option)
+  RunRailsCops: true
+  Exclude:
+    - db/schema.rb
+    - Gemfile
+    - Rakefile
+
+# TODO: put your overrides here:
+
+# StringLiterals:
+#  EnforcedStyle: single_quotes
+#
+# LineLength:
+#  Max: 200

data/lib/hound/tools/templates/_.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from:
+  - .hound/defaults.yml
+  - .hound/overrides.yml
+  - .rubocop_todo.yml
+
+# Rails cops (so we don't need to run with -R option)
+AllCops:
+  RunRailsCops: true

data/lib/hound/tools/version.rb

@@ -0,0 +1,5 @@
+module Hound
+  module Tools
+    VERSION = '0.0.4'
+  end
+end

data/spec/lib/hound/tools/cli_spec.rb

@@ -0,0 +1,90 @@
+require 'hound/tools/cli'
+
+module Hound
+  RSpec.describe Tools::Cli do
+    let(:hound_yml) { instance_double(Tools::HoundYml, generate: nil) }
+    let(:default_yml) { instance_double(Tools::HoundDefaults, generate: nil) }
+    let(:overrides_yml) { instance_double(Tools::HoundOverrides, generate: nil, filename: 'foo') }
+    let(:rubocop_yml) { instance_double(Tools::RubocopYml, generate: nil) }
+    let(:merged_yml) { instance_double(Tools::MergedYml, generate: nil) }
+
+    let(:bundler_result) { true }
+
+    before do
+      allow(Tools::HoundYml).to receive(:new).and_return(hound_yml)
+      allow(Tools::HoundDefaults).to receive(:new).and_return(default_yml)
+      allow(Tools::HoundOverrides).to receive(:new).and_return(overrides_yml)
+      allow(Tools::RubocopYml).to receive(:new).and_return(rubocop_yml)
+      allow(Tools::MergedYml).to receive(:new).and_return(merged_yml)
+
+      allow(Kernel).to receive(:system).
+        with("bundle show hound-tools > #{IO::NULL}").
+        and_return(bundler_result)
+
+      allow(Kernel).to receive(:system).with('bundle exec rubocop --auto-gen')
+
+      allow($stderr).to receive(:puts)
+      allow($stdout).to receive(:puts)
+    end
+
+    describe '#init' do
+      before { subject.init }
+
+      it 'generates a .hound.yml' do
+        expect(hound_yml).to have_received(:generate)
+      end
+
+      it 'generates a default Hound yml' do
+        expect(default_yml).to have_received(:generate)
+      end
+
+      it 'generates a default .rubocop.yml' do
+        expect(rubocop_yml).to have_received(:generate)
+      end
+
+      it 'generates an overrides yml' do
+        expect(overrides_yml).to have_received(:generate)
+      end
+
+      it 'merges the yml files for Hound' do
+        expect(merged_yml).to have_received(:generate)
+      end
+
+      context 'without hound-tools in the Gemfile' do
+        let(:bundler_result) { false }
+        it 'shows message about adding hound-tools to Gemfile' do
+          expect($stderr).to have_received(:puts).with(/Add hound-tools to your Gemfile/)
+        end
+      end
+
+      context 'with hound-tools in the Gemfile' do
+        it 'does not show message about adding hound-tools to Gemfile' do
+          expect($stderr).to_not have_received(:puts)
+        end
+      end
+
+      it 'runs rubocop --auto-gen' do
+        expect(Kernel).to have_received(:system).
+          with('bundle exec rubocop --auto-gen')
+      end
+    end
+
+    describe '#check' do
+      let(:runner) { instance_double(Hound::Tools::Runner) }
+
+      before do
+        allow(Hound::Tools::Runner).to receive(:new).and_return(runner)
+        allow(runner).to receive(:run)
+        subject.check
+      end
+
+      it 'merges the yml files for Hound' do
+        expect(merged_yml).to have_received(:generate)
+      end
+
+      it 'runs the check' do
+        expect(runner).to have_received(:run)
+      end
+    end
+  end
+end

data/spec/lib/hound/tools/hound_defaults_spec.rb

@@ -0,0 +1,52 @@
+require 'hound/tools/hound_defaults'
+
+require_relative 'template_spec'
+
+RSpec.describe Hound::Tools::HoundDefaults do
+  filename = '.hound/defaults.yml'
+
+  it_behaves_like 'a template', filename
+
+  describe '#generate' do
+    before do
+      allow(IO).to receive(:read).
+        with(/lib\/hound\/tools\/templates\/_#{filename}$/).and_call_original
+      allow($stderr).to receive(:puts)
+      allow($stdout).to receive(:puts)
+      allow(FileUtils).to receive(:mkpath).with('.hound')
+    end
+
+    context "with no #{filename}" do
+      before do
+        allow(IO).to receive(:read).with(filename).and_raise(Errno::ENOENT)
+        allow(IO).to receive(:write).with(filename, anything)
+      end
+
+      it "creates a valid #{filename} file" do
+        expect(IO).to receive(:write).with(filename, anything) do |_file, data|
+          expect(data).to be
+          config = YAML::load(data)
+          expect(config).to be
+          expect(config).to include('StringLiterals' => { 'EnforcedStyle' => 'double_quotes' })
+        end
+
+        subject.generate
+      end
+    end
+
+    context "with existing invalid #{filename}" do
+      let(:contents) { 'foo: :bar' }
+      before { allow(IO).to receive(:read).with(filename).and_return(contents) }
+
+      it 'returns false' do
+        expect(subject.generate).to be_falsey
+      end
+
+      it 'displays the file already exists' do
+        msg = "Error: #{filename} is invalid! (No StringLiterals section)"
+        expect($stderr).to receive(:puts).with(msg)
+        subject.generate
+      end
+    end
+  end
+end