initial commit

Author: e2

.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rspec', '~> 3.1'
+  gem 'guard-rspec'
+end

Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %(app lib config test spec feature)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "ostruct"
+
+  # Generic Ruby apps
+  rspec = OpenStruct.new
+  rspec.spec = ->(m) { "spec/#{m}_spec.rb" }
+  rspec.spec_dir = "spec"
+  rspec.spec_helper = "spec/spec_helper.rb"
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| rspec.spec.("lib/#{m[1]}") }
+  watch(rspec.spec_helper)      { rspec.spec_dir }
+
+  hound = OpenStruct.new
+  hound.libspec = ->(m) { "spec/lib/hound/tools/#{m}_spec.rb" }
+  hound.libspecs = ->(m) { m.map {|name| hound.libspec.(name) } }
+  hound.template_r = ->(m) { /^#{Regexp.quote("lib/hound/tools/templates/_#{m}")}$/ }
+
+  watch('lib/hound/tools/template.rb') { hound.libspecs.(%w(cli hound_yml hound_defaults)) }
+  watch(hound.template_r.('.hound.yml')) { hound.libspecs.(%w(cli hound_yml)) }
+  watch(hound.template_r.('.rubocop.hound_defaults.yml')) { hound.libspecs.(%w(cli hound_defaults)) }
+end

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.

README.md

@@ -0,0 +1,38 @@
+# Hound::Tools
+
+Tools and configuration to locally simulate HoundCi checks
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'hound-tools', require: false
+end
+```
+
+Run this to setup your config files so that Hound will produce the same results
+as running Rubocop locally:
+
+```bash
+$ hound-tools init
+```
+
+
+## Usage
+
+You can locally simulate a HoundCi check using:
+
+```bash
+$ hound-tools
+```
+
+
+## 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

Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

bin/hound-tools

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

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         = ["[email protected]"]
+  spec.summary       = %q{Tools for configuring and using HoundCI}
+  spec.description   = %q{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

lib/hound/tools.rb

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

lib/hound/tools/cli.rb

@@ -0,0 +1,86 @@
+require 'thor'
+require 'yaml'
+
+require 'hound/tools/hound_yml'
+require 'hound/tools/hound_defaults'
+require 'hound/tools/rubocop_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
+        to uncomment them)
+
+        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
+
+        Instructions:
+        =============
+
+        1. edit .rubocop_todo.yml to uncomment offenses you want to fix now
+
+        2. edit .rubocop.yml to exclude project specific files (e.g. Rakefile,
+        etc.) and add overrides (meaning - rules/cops you want different from
+        Hound's defaults)
+
+        3. Run `bundle exec hound-tool` to see what HoundCi would report on
+        your files (which almost give you the same results as running `bundle
+        exec rubocop` now - if not, file an issue).
+
+        HINT: for quickly fixing most offenses, you can uncomment those in
+        `.rubocop_todo.yml` which include 'auto-correct' and simply run `bundle exec rubocop -a`
+
+        HINT: check the rubocop README for tips on setting up rubocop with
+        Rake, Guard and other tools
+
+        Contributing
+        ============
+
+        Feel free to file issues at: https://github.com/e2/hound-tools
+
+      EOS
+
+      desc :init, "Initializes a project to match default HoundCi config"
+      def init
+        HoundYml.new.generate
+        HoundDefaults.new.generate
+        RubocopYml.new.generate
+
+        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
+
+        # TODO: help setup Rakefile?
+
+        Kernel.system('bundle exec rubocop --auto-gen')
+        $stdout.puts INSTRUCTIONS
+      end
+
+      default_task :check
+      desc :check, "Simulates a HoundCi check locally"
+      def check
+        options = {
+          hound_yml_file: ".hound.yml",
+          hound_ci_style_file: ".rubocop.hound_defaults.yml",
+          debug: false,
+          glob_pattern: "**/*.rb"
+        }
+
+        Runner.new(options).run
+      end
+    end
+  end
+end

lib/hound/tools/hound_defaults.rb

@@ -0,0 +1,27 @@
+require 'yaml'
+
+require "hound/tools/template"
+
+module Hound
+  module Tools
+    class HoundDefaults
+      include Template
+
+      def initialize
+        super('.rubocop.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'
+      end
+    end
+  end
+end

lib/hound/tools/hound_yml.rb

@@ -0,0 +1,25 @@
+require 'yaml'
+
+require "hound/tools/template"
+
+module Hound
+  module Tools
+    class HoundYml
+      include Template
+
+      def initialize
+        super('.hound.yml')
+      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

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 = '.rubocop.hound_defaults.yml'
+        fail InvalidTemplate, "'#{file}' not inherited" unless inherited.include?(file)
+      end
+    end
+  end
+end