osm-rubocop 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bfe96d66708b6d85a47d781db1c5d08918e3a08
-  data.tar.gz: 15c09b2c1ee51c81b70b7a55d985fc859dad3b4b
+  metadata.gz: 6e42d709c96e2e27bceb516a8be42a2ec3924f7b
+  data.tar.gz: c070a92dc2457cd8563a6e874a798ff9b43b0250
 SHA512:
-  metadata.gz: b591962b8e5a02ba565f2c6a9b04a3afffa114e929fef420c671f813f1bfc993038b69a0f0b4f6c7d4175a84a8ab6663aa7ca226964608af2d053b826146bf7e
-  data.tar.gz: bc0257ff86116bd52e2c6c200ed876d1ef950d3a538b4da64310430877a35affa10e03e1c0d7079a59db4935c34ae07dea5ac623f469308bae8f2f583d28c931
+  metadata.gz: 050809daaf6d306943c8da25c62d7cda5dee9faf34a1c0c13edacdfe91b96a313753bd806274ad0c482a82ec5f905679dd662c6d161c3cd09a81313de7f4761d
+  data.tar.gz: 3d3af002fe4b3fc6f1a9377038cdde574bc59536007bd271d619e0e4f95422380ecb81481b16ce0a3a3aaf9d46bf3fbc876ab94de2eb72a84cd1db4563c017b6

data/README.md

@@ -20,12 +20,39 @@ Or install it yourself as:
 
 ## Usage
 
+#### Using osm-rubocop's rubocop configuration
+
 Add this line to the top of your project's .rubocop.yml:
 
 ```ruby
 require: osm-rubocop
 ```
 
+It will make osm-rubocop's configuration the default configuration for running rubocop.
+
+#### Adding a pre-commit hook
+
+If your project is a Rails application, add this to your Rakefile (above the call to `load_tasks`):
+
+```ruby
+require 'osm-rubocop'
+```
+
+If your project is not a Rails application, add this to your Rakefile:
+
+```ruby
+require 'osm-rubocop'
+load File.join Gem.loaded_specs['osm-rubocop'].full_gem_path, 'lib', 'tasks', 'osm_rubocop.rake'
+```
+
+Now you can create a pre-commit hook by running:
+
+```bash
+$ rake osm_rubocop:install_precommit_hook
+```
+
+This will install a pre-commit hook that will remind you to make sure there are no rubocop violations before each commit.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,2 +1,3 @@
 require 'bundler/gem_tasks'
+load 'tasks/osm_rubocop.rake'
 task default: :spec

data/lib/osm/rubocop/pre-commit.bash

@@ -0,0 +1,22 @@
+#!/bin/bash
+RED="\\e[31m"
+NO_COLOR="\\e[0m"
+# Pre commit messages don't take STDIN from the terminal by default.
+# (See http://stackoverflow.com/a/10015707/1633753)
+# The following line overrides that:
+exec < /dev/tty
+
+if !(bundle exec rubocop --parallel); then
+  echo -e "$RED"
+  echo -e "Rubocop offenses were found."
+  echo -ne "Do you want to commit anyway? [Y/n] "
+  echo -ne "$NO_COLOR"
+  read input
+  case $input in
+    [Yy] ) exit
+  esac
+  echo -ne "$RED"
+  echo -e "Commit was cancelled due to rubocop offenses."
+  echo -ne "$NO_COLOR"
+  exit 1
+fi

data/lib/osm/rubocop/railtie.rb

@@ -0,0 +1,7 @@
+module Osm
+  module Rubocop
+    class Railtie < Rails::Railtie
+      rake_tasks { load 'tasks/osm_rubocop.rake' }
+    end
+  end
+end

data/lib/osm/rubocop/version.rb

@@ -1,5 +1,5 @@
 module Osm
   module Rubocop
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.1.2'.freeze
   end
 end

data/lib/osm/rubocop.rb

@@ -1,4 +1,5 @@
 require 'osm/rubocop/version'
+require 'osm/rubocop/railtie' if defined?(::Rails::Railtie)
 require 'rubocop'
 
 module Osm

data/lib/tasks/osm_rubocop.rake

@@ -0,0 +1,30 @@
+namespace :osm_rubocop do
+  desc 'Install a pre-commit hook that ensures the code adheres to the OSM Rubocop configuration'
+  task :install_precommit_hook do
+    source = File.join(
+      Gem.loaded_specs['osm-rubocop'].full_gem_path,
+      'lib',
+      'osm',
+      'rubocop',
+      'pre-commit.bash'
+    )
+    root = defined?(::Rails.root) ? ::Rails.root : Dir.pwd
+    target = File.join(root, '.git', 'hooks', 'pre-commit')
+
+    # rubocop:disable Rails/SkipsModelValidations
+    # There's a false positive rubocop violation here.  See bug at:
+    # https://github.com/bbatsov/rubocop/issues/4260
+    FileUtils.touch target
+    # rubocop:enable Rails/SkipsModelValidations
+    FileUtils.chmod '+x', target
+
+    source_content = File.read source
+    target_content = File.read target
+
+    unless target_content.include? source_content
+      File.open(target, 'a') do |f|
+        f.puts source_content
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Isaac Betesh
@@ -84,7 +84,10 @@ files:
 - config/default.yml
 - lib/osm-rubocop.rb
 - lib/osm/rubocop.rb
+- lib/osm/rubocop/pre-commit.bash
+- lib/osm/rubocop/railtie.rb
 - lib/osm/rubocop/version.rb
+- lib/tasks/osm_rubocop.rake
 - osm-rubocop.gemspec
 homepage: https://github.com/on-site/osm-rubocop
 licenses: