rubocopter 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15bb789590e6e7ba4b61bea04057362859c4fcfd
-  data.tar.gz: e7ef6833104019d9bfa712f3d811127d97ea7db5
+  metadata.gz: 5244a6527323ba5bb4b6560925216c8a22200762
+  data.tar.gz: 3c904d1302984791c15420303d62216e9116dc99
 SHA512:
-  metadata.gz: f82afae1304b8671c27d3691d0e5347eddddaf3206980d32c1800bb182e18e0b0da7587ad1ecf3e5461114cc0f63154446fb56a02f2d8399c336fdcc9386d9f7
-  data.tar.gz: d63562899508e6f7b5f6c8b4c2031030a31fe8fc503d05816e391949302a60cecabd28c307ee965b36e883215a4b320ab81598f0ac394b21ca4d0c5f4c8b2323
+  metadata.gz: b4ebc8a3683d5d821293db9730b9c07baed73bd704d0135cab513c8068c8042b94285a8c6bbb2cf23ac4a54f2045696ae5e3780d1052c053b295a46eb190b72f
+  data.tar.gz: 02b50c2d3f4a3b90338609aa0fc8612395a604c554cb849b27f35b26daca47e875cdff34dd7039fb04fcbd6a107159d307c687b96d514a6b752e11475f917f41

data/README.md

@@ -0,0 +1,17 @@
+# Rubocopter
+
+A simple wrapper gem around [RuboCop](https://github.com/bbatsov/rubocop). Rubocopter aids you in development by providing a convenient way to find ruby style and logic issues in your large .git projects by comparing only the changes from a given commit.
+
+## Installation
+
+`gem install rubocopter`
+
+## Usage
+
+`rubocopter`
+
+Use the `-h` or `--help` flag to see options.
+
+## License
+
+This project rocks and uses MIT-LICENSE.

data/git_hooks/pre-commit

@@ -0,0 +1,9 @@
+#!/bin/sh
+#
+# Ensure your code is valid before commiting
+rubocopter
+
+if [ $? -ne 0 ]; then
+  echo 'Rubocop validation failed. Aborting commit.'
+  exit 1
+fi

data/git_hooks/pre-push

@@ -0,0 +1,9 @@
+#!/bin/sh
+#
+# Ensure your code is valid before pushing
+rubocopter
+
+if [ $? -ne 0 ]; then
+  echo 'Rubocop validation failed. Aborting push.'
+  exit 1
+fi

data/lib/rubocopter/cli.rb

@@ -1,6 +1,7 @@
 require 'optparse'
 require 'shellwords'
 require 'rubocop'
+require 'pathname'
 
 RuboCopter::Options = Struct.new(:hash, :debug)
 
@@ -11,6 +12,7 @@ class RuboCopter::CLI
   def run(args = ARGV)
     parse_options(args)
     check_for_offences
+    show_results
 
     return $?.exitstatus
   end
@@ -38,25 +40,32 @@ class RuboCopter::CLI
   end
 
   def check_for_offences
+    # Check for git.
     if `which git` == ''
       puts 'git not detected. Running normal rubocop.'
       system(Shellwords.join(['rubocop', '-R'] + '--out rubocop_result.txt'.split))
-    else
-      `git rev-parse`
-      if $?.exitstatus == 0
-        files = changed_ruby_file_names
-        if files.length == 0
-          puts 'No changes detected, no reason to run rubocop'
-          exit(0)
-        else
-          system(Shellwords.join(['rubocop', '-R'] + files + '--out rubocop_result.txt'.split))
-        end
+      return
+    end
+
+    # Check for changes
+    `git rev-parse`
+    if $?.exitstatus == 0
+      files = changed_ruby_file_names
+      if files.length == 0
+        puts 'No changes detected, no reason to run rubocop'
+        exit(0)
       else
-        puts 'git directory not detected. Running normal rubocop.'
-        system(Shellwords.join(['rubocop', '-R'] + '--out rubocop_result.txt'.split))
+        system(Shellwords.join(['rubocop', '-R'] + files + '--out rubocop_result.txt'.split))
       end
+      return
     end
 
+    # No git directory
+    puts 'git directory not detected. Running normal rubocop.'
+    system(Shellwords.join(['rubocop', '-R'] + '--out rubocop_result.txt'.split))
+  end
+
+  def show_results
     if File.exists?('rubocop_result.txt')
       text = File.open('rubocop_result.txt').read
       puts text
@@ -81,6 +90,14 @@ class RuboCopter::CLI
         @options.hash = hash
       end
 
+      opts.on('--install-git-hooks HOOK', 'write git hooks to rubocopter. options : all, commit, push') do |hook|
+        install_git_hooks(hook)
+      end
+
+      opts.on('--remove-git-hooks HOOK', 'remove git hooks. options : all, commit, push') do |hook|
+        remove_git_hooks(hook)
+      end
+
       opts.on("--debug", "Prints runtime") do
         @options.debug = true
       end
@@ -94,4 +111,31 @@ class RuboCopter::CLI
     opt_parser.parse!(args)
   end
 
+  def install_git_hooks(hook)
+    working_dir_git_hooks = Pathname.new(Dir.pwd).join('.git', 'hooks')
+    current_path = Pathname.new(File.dirname(__FILE__))
+    if hook == 'commit'
+      system(Shellwords.join(['cp', current_path.join('../../git_hooks', 'pre-commit'), working_dir_git_hooks]))
+    elsif hook == 'push'
+      system(Shellwords.join(['cp', current_path.join('../../git_hooks', 'pre-push'), working_dir_git_hooks]))
+    elsif hook == 'all'
+      system(Shellwords.join(['cp', current_path.join('../../git_hooks', 'pre-commit'), working_dir_git_hooks]))
+      system(Shellwords.join(['cp', current_path.join('../../git_hooks', 'pre-push'), working_dir_git_hooks]))
+    end
+    exit(0)
+  end
+
+  def remove_git_hooks(hook)
+    working_dir_git_hooks = Pathname.new(Dir.pwd).join('.git', 'hooks')
+    if hook == 'commit'
+      system(Shellwords.join(['rm', working_dir_git_hooks.join('pre-commit')]))
+    elsif hook == 'push'
+      system(Shellwords.join(['rm', working_dir_git_hooks.join('pre-push')]))
+    elsif hook == 'all'
+      system(Shellwords.join(['rm', working_dir_git_hooks.join('pre-commit')]))
+      system(Shellwords.join(['rm', working_dir_git_hooks.join('pre-push')]))
+    end
+    exit(0)
+  end
+
 end

data/lib/rubocopter/version.rb

@@ -1,3 +1,3 @@
 module RuboCopter
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocopter
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Matthew Basset
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.29.1
-description: Helps with speeding up rubocop checks in large git projects.
+description: Helps with speeding up RuboCop checks in large git projects.
 email:
 - matthew@quandl.com
 executables:
@@ -33,8 +33,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - bin/rubocopter
+- git_hooks/pre-commit
+- git_hooks/pre-push
 - lib/rubocopter.rb
 - lib/rubocopter/cli.rb
 - lib/rubocopter/version.rb

data/README.rdoc

@@ -1,7 +0,0 @@
-= Rubocopter
-
-A simple gem that you can run in your projects to aid in running RuboCop against only the changes in your .git projects.
-
-== License
-
-This project rocks and uses MIT-LICENSE.