legit 0.0.5 → 0.0.6

data/README.md

@@ -1,5 +1,34 @@
 # Legit [![Dependency Status](https://gemnasium.com/dillonkearns/legit.png)](https://gemnasium.com/dillonkearns/legit) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/dillonkearns/dotfile-linker)
 
+## Installation
+```bash
+$ gem install legit
+```
+
+## Usage
+Run `legit` with no options to see a list of commands and options.
+
+### Setting Up a `catch-todos` `pre-commit` Hook
+![$ git up](http://i.imgur.com/rv0AfQi.png)
+
+1. Add the following to `.git/hooks/pre-commit` in the desired repository:
+```bash
+#! /bin/bash
+legit catch-todos TODO
+```
+
+2. Make the hook executable (git will silently ignore your hook otherwise):
+```bash
+chmod +x .git/hooks/pre-commit
+```
+
+Note: if you use a graphical git tool (such as [SourceTree](http://http://www.sourcetreeapp.com/) for OS X), you may need read the following:
+
+RVM and similar tools do store executables in custom locations instead of the standard locations for executables such as `/usr/bin`. Since your `.bash_profile` (or similar) might not be executed by your GUI tool, you may need to create a symlink to legit in a location that is in the tool's default path. `/usr/bin` is usually included, so this should do:
+```bash
+sudo ln -s $(which legit) /usr/bin/legit      # find where RVM is storing legit and add a symlink to it in /usr/bin
+```
+
 ## Contributing
 
 1. Fork it

data/legit.gemspec

@@ -18,5 +18,6 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rake", "~> 10.0.3"
   gem.add_runtime_dependency     "colorize", "~> 0.5.8"
-  gem.add_runtime_dependency     "thor", "~> 0.16.0"
+  gem.add_runtime_dependency     "thor", "~> 0.17.0"
+  gem.add_runtime_dependency     "rugged", "0.17.0.b7"
 end

data/lib/legit.rb

@@ -17,18 +17,19 @@ class Legit < Thor
 
   desc "catch-todos [TODO_FORMAT]", "Abort commit if any todos in TODO_FORMAT found"
   method_option :warn, :type => :boolean, :aliases => "-w", :desc => 'Warn and prompt the user to choose whether to abort the commit'
+  method_option :enable, :type => :boolean, :desc => 'Enable todo checking'
+  method_option :disable, :type => :boolean, :desc => 'Disable todo checking'
   def catch_todos(todo_format = "TODO")
-    system("git diff --staged | grep '^+' | grep #{todo_format}")
-
-    if $?.success?
-      if options[:warn]
-        exit 1 unless positive_response?("[pre-commit hook] Found staged `#{todo_format}`s. Do you still want to continue?", :warning)
+    if options[:enable]
+      repo.config.delete('hooks.ignore-todos')
+    elsif options[:disable]
+      repo.config['hooks.ignore-todos'] = true
+    else
+      if repo.config['hooks.ignore-todos'] == 'true'
+        show("[pre-commit hook] ignoring todos. Re-enable with `legit catch-todos --enable`", :low_warning)
       else
-        show("[pre-commit hook] Aborting commit... found staged `#{todo_format}`s.", :warning)
-        exit 1
+        run_catch_todos(todo_format)
       end
-    else
-      show("Success: No #{todo_format}s staged.", :success)
     end
   end
 
@@ -49,4 +50,23 @@ class Legit < Thor
     end
   end
 
+  private
+  def repo
+    @repo ||= Rugged::Repository.new('.')
+  end
+
+  def run_catch_todos(todo_format)
+    system("git diff --staged | grep '^+' | grep #{todo_format}")
+
+    if $?.success?
+      if options[:warn]
+        exit 1 unless positive_response?("[pre-commit hook] Found staged `#{todo_format}`s. Do you still want to continue?", :warning)
+      else
+        show("[pre-commit hook] Aborting commit... found staged `#{todo_format}`s.", :warning)
+        exit 1
+      end
+    else
+      show("Success: No #{todo_format}s staged.", :success)
+    end
+  end
 end

data/lib/legit/version.rb

@@ -1,3 +1,3 @@
 module Legit
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/legit_helper.rb

@@ -1,4 +1,5 @@
 require 'colorize'
+require 'rugged'
 
 def current_branch
   system "git rev-parse --abbrev-ref HEAD"
@@ -23,6 +24,8 @@ def show(message, type = :success)
         :green
       when :warning
         :red
+      when :low_warning
+        :yellow
       when :normal
         :white
       else

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: legit
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Dillon Kearns
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-12 00:00:00 -08:00
+date: 2013-02-04 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,16 +56,34 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 95
+        hash: 91
         segments: 
         - 0
-        - 16
+        - 17
         - 0
-        version: 0.16.0
+        version: 0.17.0
   requirement: *id003
   prerelease: false
   name: thor
   type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: -2833707614
+        segments: 
+        - 0
+        - 17
+        - 0
+        - b
+        - 7
+        version: 0.17.0.b7
+  requirement: *id004
+  prerelease: false
+  name: rugged
+  type: :runtime
 description: A collection of scripts for common git tasks to simplify and improve workflow.
 email: 
 - dillon@dillonkearns.com