hound-tools 0.0.4

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cezary Baginski
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+[![Gem Version](https://badge.fury.io/rb/hound-tools.svg)](http://badge.fury.io/rb/hound-tools)
+[![Build Status](https://travis-ci.org/e2/hound-tools.png?branch=master)](https://travis-ci.org/e2/hound-tools)
+
+
+# Hound::Tools
+
+Tools and configuration to locally simulate HoundCi checks
+
+## Initial Setup
+
+In your Gemfile:
+
+```ruby
+group :development do
+  gem 'hound-tools', '~> 0.0.3', require: false
+end
+```
+
+Create customizable RuboCop + Hound setup:
+
+```bash
+$ bundle exec hound-tools init
+```
+
+(NOTE: this runs `rubocop --auto-gen`, so it will disable all the offenses.)
+
+## Add new files to repository
+
+Add the files to the repository:
+
+```bash
+git add .hound       # default Hound style guide and your overrides
+git add .rubocop.yml # Rubocop-only config
+git add .hound.yml   # Hound general style-checking config
+git add .rubocop_merged_for_hound.yml # auto-generated Hound-only config (without Hound defaults)
+```
+
+
+## Customizing your Rubocop/Hound setup
+
+You should only be interested in these files:
+- `.rubocop_todo.yml`, which can be updated with `bundle exec rubocop --auto-gen` and then edited
+- `.hound/overrides.yml`, where you can override Hound's default rules or excludes
+- `.rubocop_merged_for_hound.yml` - you want to regenerate this and commit
+
+## Usage
+
+Every time you modify `.rubocop_todo.yml` or `.hound/overrides.yml`, you'll
+want to regenerate `.rubocop_merged_for_hound.yml` with:
+
+```bash
+$ bundle exec hound-tools
+```
+
+(And then you'll want to add all 3 to the repository before doing anything else).
+
+Once you have your style working, you can simulate Hound with almost 100% accuracy with:
+
+```bash
+bundle exec rubocop
+```
+
+(If this shows no offenses, check the .rubocop_todo.yml file for disabled rules.)
+
+## Tips
+
+1) For quickly fixing most offenses, uncomment the 'auto-correct' ones in
+`.rubocop_todo.yml` simply run `bundle exec rubocop -a`
+
+2) The RuboCop README has tips on setting up Rake, Guard, etc.
+
+## Why is this so complex?
+
+Well, simply because Hound doesn't support the RuboCop `inherited_from` keys.
+And that's because Hound is avoiding touching the filesystem - which makes
+sense since it downloads files to memory from GitHub.
+
+Also, since Hound internally loads it's defaults and does a "mini-merge" of the
+configurations, it needs a different setup than Rubocop.
+
+I won't mention the clever hacks in Hound to side-step directory traversing and
+other messy issues (e.g. handling excludes).
+
+
+## Alternatives
+
+1) Using only the default Hound settings (without being able to Hound-check them locally)
+
+2) Copying the default Hound settings (`.hound/defaults.yml`) to `.rubocop.yml` and tweak them (but you loose the flexibility and control of using multiple files and the coolness of .rubocop_todo.yml with 'inherited_from')
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/hound-tools/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+
+default_tasks = []
+
+def ci?
+  ENV["CI"] == "true"
+end
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = ci?
+end
+
+default_tasks << :spec
+
+unless ci?
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new(:rubocop)
+  default_tasks << :rubocop
+end
+
+task default: default_tasks

data/bin/hound-tools

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'hound/tools/cli'
+
+Hound::Tools::Cli.start

data/hound-tools.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hound/tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hound-tools'
+  spec.version       = Hound::Tools::VERSION
+  spec.authors       = ['Cezary Baginski']
+  spec.email         = ['cezary@chronomantic.net']
+  spec.summary       = 'Tools for configuring and using HoundCI'
+  spec.description   = 'Matches your project config to give the same errors as HoundCi'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rubocop', '0.25.0'
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/hound/tools.rb

@@ -0,0 +1,7 @@
+require 'hound/tools/version'
+
+module Hound
+  module Tools
+    # Your code goes here...
+  end
+end

data/lib/hound/tools/cli.rb

@@ -0,0 +1,74 @@
+require 'thor'
+require 'yaml'
+
+require 'hound/tools/hound_yml'
+require 'hound/tools/hound_defaults'
+require 'hound/tools/hound_overrides'
+require 'hound/tools/rubocop_yml'
+require 'hound/tools/merged_yml'
+
+require 'hound/tools/runner'
+
+module Hound
+  module Tools
+    class Cli < Thor
+      INSTRUCTIONS = <<-EOS
+
+         **** WARNING!!! ****
+
+        1. All Rubocop offenses are initially ignored! (see .rubocop_todo.yml and/or README)
+          - tweak .rubocop_todo.yml and regenerate with `bundle exec hound-tools`
+
+        2. Fixing all offenses at once is discouraged unless:
+          - you are the only person actively working on the project (or starting out)
+          - you have accepted ALL the pull requests FIRST
+          - you have merged ALL the local and remote branches and you are NOT
+          currently maintaining multiple branches
+
+        Issues? Go here: https://github.com/e2/hound-tools/issues
+      EOS
+
+      desc :init, 'Initializes a project to match default HoundCi config'
+      def init
+        HoundYml.new.generate
+        HoundDefaults.new.generate
+        HoundOverrides.new.generate
+        RubocopYml.new.generate
+
+        # TODO: help setup Rakefile?
+
+        Kernel.system('bundle exec rubocop --auto-gen')
+
+        MergedYml.new.generate
+
+        $stdout.puts INSTRUCTIONS
+
+        unless Kernel.system("bundle show hound-tools > #{IO::NULL}")
+          $stderr.puts <<-EOS
+          Add hound-tools to your Gemfile like so:
+
+              gem 'hound-tools', require: false
+
+          EOS
+        end
+      end
+
+      default_task :check
+      desc :check, 'Simulates a HoundCi check locally'
+      def check
+        # TODO: add an "update" action?
+        # TODO: only merge if necessary (files outdated)
+        MergedYml.new.generate
+
+        options = {
+          hound_yml_file: '.hound.yml',
+          hound_ci_style_file: '.hound/defaults.yml',
+          debug: false,
+          glob_pattern: '**/*.rb'
+        }
+
+        Runner.new(options).run
+      end
+    end
+  end
+end

data/lib/hound/tools/hound_defaults.rb

@@ -0,0 +1,30 @@
+require 'yaml'
+
+require 'hound/tools/template'
+
+module Hound
+  module Tools
+    class HoundDefaults
+      include Template
+
+      def initialize
+        super('.hound/defaults.yml')
+      end
+
+      private
+
+      def _validate(content)
+        config = YAML.load(content)
+        literals = config['StringLiterals']
+        fail InvalidTemplate, 'No StringLiterals section' unless literals
+
+        quote_style = literals['EnforcedStyle']
+        fail InvalidTemplate, 'No EnforcedStyle section' unless quote_style
+        fail InvalidTemplate, 'No double_quotes value'  unless quote_style == 'double_quotes'
+
+        # TODO: not tested
+        fail InvalidTemplate, "Detected 'inherited_from' section" if config.key?('inherited_from')
+      end
+    end
+  end
+end

data/lib/hound/tools/hound_overrides.rb

@@ -0,0 +1,26 @@
+require 'yaml'
+
+require 'hound/tools/template'
+
+module Hound
+  module Tools
+    class HoundOverrides
+      include Template
+
+      def initialize
+        super('.hound/overrides.yml')
+      end
+
+      private
+
+      def _validate(content)
+        config = YAML.load(content)
+        cops = config['AllCops']
+        fail InvalidTemplate, 'No AllCops section' unless cops
+
+        # TODO: not tested
+        fail InvalidTemplate, "Detected 'inherited_from' section" if config.key?('inherited_from')
+      end
+    end
+  end
+end

data/lib/hound/tools/hound_yml.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+
+require 'hound/tools/template'
+
+module Hound
+  module Tools
+    class HoundYml
+      include Template
+
+      def initialize
+        super('.hound.yml')
+      end
+
+      def rubocop_filename
+        data = IO.read(filename)
+        _validate(data)
+        YAML.load(data)['ruby']['config_file']
+      end
+
+      private
+
+      def _validate(data)
+        config = YAML.load(data)
+        ruby = config['ruby']
+        fail InvalidTemplate, "No 'ruby' section" unless ruby
+        fail InvalidTemplate, "Expected 'ruby' section to be a hash, got #{ruby.inspect}" unless ruby.is_a?(Hash)
+        fail InvalidTemplate, "No 'config_file' section" unless ruby.key?('config_file')
+      end
+    end
+  end
+end

data/lib/hound/tools/merged_yml.rb

@@ -0,0 +1,40 @@
+require 'hound/tools/template'
+require 'hound/tools/hound_yml'
+require 'hound/tools/hound_overrides'
+
+module Hound
+  module Tools
+    class MergedYml
+      include Template
+
+      def initialize
+        @todo_file = '.rubocop_todo.yml'
+
+        # NOTE: should be named. .rubocop.yml to prevent RuboCop from traversing
+        super('.rubocop_merged_for_hound.yml')
+      end
+
+      def generate
+        s = StringIO.new
+        s.write(<<EOS)
+# This is a file generated by `hound-tools`
+#
+# We don't include .hound/defaults.yml, because Hound has internally
+# loaded them at this point
+#
+EOS
+        [HoundOverrides.new.filename, @todo_file].each do |filename|
+          s.puts '# ---------------------------------'
+          s.puts "# #{filename}"
+          s.puts '# ---------------------------------'
+          s.puts IO.read(filename)
+        end
+        Pathname.new(filename).dirname.mkpath
+        output_file = HoundYml.new.rubocop_filename
+        IO.write(output_file, s.string)
+
+        $stdout.puts "#{output_file} (regenerated)"
+      end
+    end
+  end
+end

data/lib/hound/tools/rubocop_yml.rb

@@ -0,0 +1,24 @@
+require 'yaml'
+require 'hound/tools/template'
+
+module Hound
+  module Tools
+    class RubocopYml
+      include Template
+
+      def initialize
+        super '.rubocop.yml'
+      end
+
+      private
+
+      def _validate(data)
+        config = YAML.load(data)
+        inherited = config['inherit_from']
+        fail InvalidTemplate, "No 'inherit_from' section" unless inherited
+        file = '.hound/defaults.yml'
+        fail InvalidTemplate, "'#{file}' not inherited" unless inherited.include?(file)
+      end
+    end
+  end
+end

data/lib/hound/tools/runner.rb

@@ -0,0 +1,71 @@
+module Hound
+  module Tools
+    class HoundConfig
+      attr_reader :yaml
+      attr_reader :rubocop_file
+      attr_reader :rubocop_data
+
+      def enabled?
+        @enabled
+      end
+
+      def initialize(filename)
+        @yaml = YAML.load(IO.read(filename))
+        @enabled = @yaml['ruby'].fetch('enabled', true)
+        @rubocop_file = @yaml['ruby'].fetch('config_file', nil)
+        @rubocop_data = @rubocop_file && YAML.load(IO.read(@rubocop_file))
+      end
+    end
+
+    class Runner
+      DEFAULTS = {
+        hound_yml_file: '.hound.yml',
+        hound_ci_style_file: '.hound/defaults.yml',
+        debug: false,
+        glob_pattern: '**/*.rb' # TODO: should be all files?
+      }
+
+      def initialize(options)
+        @options = DEFAULTS.merge(options)
+      end
+
+      def run
+        # TODO: clean this up
+        # TODO: not covered by specs
+
+        hound_yml_file = @options[:hound_yml_file]
+        hound_ci_style = @options[:hound_ci_style_file]
+        debug = @options[:debug]
+        glob_pattern = @options[:glob_pattern]
+
+        # NOTE: the code below should be written to EXACTLY do what Hound does
+
+        require 'rubocop'
+
+        RuboCop::ConfigLoader.debug = debug
+        hound = HoundConfig.new(hound_yml_file)
+
+        return "RuboCop disabled in #{hound_yml_file}" unless hound.enabled?
+
+        # NOTE: treating hound.yml as a rubocop.yml file is deprecated
+        custom = RuboCop::Config.new(hound.rubocop_data || hound.yml, '')
+        custom.add_missing_namespaces
+        custom.make_excludes_absolute
+
+        default = RuboCop::ConfigLoader.configuration_from_file(hound_ci_style)
+        config = RuboCop::ConfigLoader.merge(default, custom)
+
+        cfg = RuboCop::Config.new(config, '')
+        team = RuboCop::Cop::Team.new(RuboCop::Cop::Cop.all, cfg, debug: debug)
+
+        Dir[glob_pattern].each do |path|
+          next if File.directory?(path)
+          file = RuboCop::ProcessedSource.new(IO.read(path))
+          team.inspect_file(file).each do |violation|
+            $stderr.puts "#{path}:#{violation.line}:#{violation.message}"
+          end
+        end
+      end
+    end
+  end
+end