code-cleaner 0.2 → 0.3

data/README.textile

@@ -59,6 +59,16 @@ h2. Pre-commit hook
 
 The best way how you can ensure your sources are clean is to use pre-commit hook, if your SCM provides this function. Plus, if you are using git, just use @load "code-cleaner.rake"@ in your Rakefile and then run @rake hooks:whitespace:install@. There are also alternatives for "Nake":http://github.com/botanicus/nake (@code-cleaner.nake@) and "Thor":http://github.com/wycats/thor (@code-cleaner.thor@). Second way is to use @rake --rakefile /path/to/code-cleaner/tasks/code-cleaner.rake hooks:whitespace:install@ resp. @nake /path/to/code-cleaner/tasks/code-cleaner.nake hooks:whitespace:install@ directly.
 
-It might force you to remove your @.git/hooks/pre-commit@ if this file exist. If you haven't done any editation in this file, it's safe to do so and if you done some, then you will need to merge your changes manually.
+It might force you to remove your @.git/hooks/pre-commit@ if this file exist. If you haven't done any editation in this file, it's safe to do so and if you done some, then you will need to merge your changes manually. You can do it manually, or, if you are using Nake or Thor, just use @--force@ option.
 
-If you project run in bundled environment, make sure you have your @bin@ or @script@ directory in your @$PATH@ or change the pre-commit hook to point to the right path to the @code-cleaner@.
+Here's an example how you can integrate code-cleaner to your tasks:
+
+<pre>
+begin
+  load "code-cleaner.nake"
+rescue LoadError
+  warn "If you want to contribute to nake, you have to install code-cleaner gem and then run ./tasks.rb hooks:
+end
+</pre>
+
+Also, if you project run in bundled environment, make sure you have your @bin@ or @script@ directory in your @$PATH@ or change the pre-commit hook to point to the right path to the @code-cleaner@. If you are using Nake or Thor, just specify @--path=bin@ resp. @--path=script@ as an option for the @hooks:whitespace:install@ If you are using Rake, you will have to do it manually.

data/code-cleaner.gemspec

@@ -3,7 +3,7 @@
 
 Gem::Specification.new do |s|
   s.name = "code-cleaner"
-  s.version = "0.2"
+  s.version = "0.3"
   s.authors = ["Jakub Šťastný aka Botanicus"]
   s.homepage = "http://github.com/botanicus/code-cleaner"
   s.summary = "Remove trailing whitespace, append missing \\n and replace tabs by two spaces"

data/support/pre-commit.erb

@@ -0,0 +1,52 @@
+#!/bin/sh
+
+echo "Entering pre-commit hook ..."
+
+# The code-cleaner script has to be in your $PATH. Uncomment
+# the following line if you have code-cleaner installed locally
+<% if options[:path].nil? %>#<% end %>export PATH="<%= options[:path] || "script" %>:$PATH"
+
+# If you haven't done any commit yet,
+# git diff will fail with following message:
+# fatal: No HEAD commit to compare with (yet)
+
+# TODO: how to get list of files which will be
+# committed if there isn't any commit in the index yet?
+# For now we just use normalize everything in current
+# directory, but it isn't very good solution.
+files=$(git diff --staged --name-only 2> /dev/null || echo ".")
+
+function abort() {
+  printf "[\e[31mERROR\e[0m] $*\n"
+  exit 1
+}
+
+# NOTE: we are using printf rather than echo because printf should be
+# more portable, each echo implementation has quite different behaviour
+if which code-cleaner &> /dev/null; then
+  for file in $files; do
+    if test -f "$file" ; then # ignore files which was removed by git rm
+      if code-cleaner "$file" --try-apply-rules &> /dev/null ; then
+        printf "Normalizing \"\e[36m$file\e[0m\" "
+        code-cleaner "$file" --apply-rules &> /dev/null
+        # NOTE: we have to check the exit status directly,
+        # so we can be sure that the command just wasn't found
+        if [ $? -eq 10 ]; then # code-cleaner exits with 0 if some changes were made
+          printf "[\e[32mCLEAN\e[0m]\n"
+        elif [ $? -eq 1 ]; then # something goes wrong
+          printf "[\e[31mERROR\e[0m]\n"
+          code-cleaner "$file" --apply-rules
+        elif [ $? -eq 0 ] ; then
+          printf "[\e[33mDONE\e[0m]\n"
+          git add "$file" # so the changes will be committed immediately
+        else
+          abort "Unexpected exit status $?"
+        fi
+      else
+        printf "Skipping \"\e[36m$file\e[0m\"\n"
+      fi
+    fi
+  done
+else
+  abort "You have to have code-cleaner installed and the code-cleaner script has to be in your \$PATH ($PATH)"
+fi

data/tasks/code-cleaner.nake

@@ -1,18 +1,26 @@
 # encoding: utf-8
 
+require "erb"
 require "fileutils"
 require "nake/task"
 
+# nake hooks:whitespace:install
+# nake hooks:whitespace:install --force
+# nake hooks:whitespace:install --path=script
 Nake::Task.new("hooks:whitespace:install") do |task|
   task.description = "Install hook for automatically removing trailing whitespace"
-  task.define do
+  task.define do |options = Hash.new|
+    FileUtils.rm ".git/hooks/pre-commit" if options[:force]
     if File.exist?(".git/hooks/pre-commit")
       abort "You must remove .git/hooks/pre-commit first!"
     else
       begin
         puts "Installing .git/hooks/pre-commit ..."
-        source = File.join(File.dirname(__FILE__), "..", "support", "pre-commit")
-        FileUtils.install source, ".git/hooks/pre-commit", :mode => 0755
+        source = File.join(File.dirname(__FILE__), "..", "support", "pre-commit.erb")
+        File.open(".git/hooks/pre-commit", "w") do |file|
+          file.puts(ERB.new(File.read(source)).result(binding))
+        end
+        File.chmod(0755, ".git/hooks/pre-commit")
       rescue Errno::ENOENT
         abort "You have to run git init first!"
       end

data/tasks/code-cleaner.rake

@@ -1,5 +1,8 @@
 # encoding: utf-8
 
+# The task for Rake doesn't support any options. Sorry, your task utility sucks, get something better.
+# The reason why I can't add --path option is that Rake has very nasty bug http://gist.github.com/263325
+# Yeah, I know I can use environment varibles, but why I should bother when you can just install nake which is so much better!
 desc "Install hook for automatically removing trailing whitespace"
 task "hooks:whitespace:install" do
   if File.exist?(".git/hooks/pre-commit")
@@ -7,8 +10,11 @@ task "hooks:whitespace:install" do
   else
     begin
       puts "Installing .git/hooks/pre-commit ..."
-      source = File.join(File.dirname(__FILE__), "..", "support", "pre-commit")
-      install source, ".git/hooks/pre-commit", :mode => 0755
+      source = File.join(File.dirname(__FILE__), "..", "support", "pre-commit.erb")
+      File.open(".git/hooks/pre-commit", "w") do |file|
+        file.puts(ERB.new(File.read(source)).result)
+      end
+      File.chmod(0755, ".git/hooks/pre-commit")
     rescue Errno::ENOENT
       abort "You have to run git init first!"
     end

data/tasks/code-cleaner.thor

@@ -2,16 +2,24 @@
 
 require "fileutils"
 
+# thor hooks:whitespace:install
+# thor hooks:whitespace:install --force
+# thor hooks:whitespace:install --path=script
 module Hooks
   class Whitespace < Thor
+    method_options :force => :boolean, :path => :string
     desc "install", "Install hook for automatically removing trailing whitespace"
     def install
+      FileUtils.rm ".git/hooks/pre-commit" if options[:force]
       if File.exist?(".git/hooks/pre-commit")
         abort "You must remove .git/hooks/pre-commit first!"
       else
         puts "Installing .git/hooks/pre-commit ..."
-        source = File.join(File.dirname(__FILE__), "..", "support", "pre-commit")
-        FileUtils.install source, ".git/hooks/pre-commit", :mode => 0755
+        source = File.join(File.dirname(__FILE__), "..", "support", "pre-commit.erb")
+        File.open(".git/hooks/pre-commit", "w") do |file|
+          file.puts(ERB.new(File.read(source)).result(binding))
+        end
+        File.chmod(0755, ".git/hooks/pre-commit")
       end
     rescue Errno::ENOENT
       abort "You have to run git init first!"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: code-cleaner
 version: !ruby/object:Gem::Version 
-  version: "0.2"
+  version: "0.3"
 platform: ruby
 authors: 
 - "Jakub \xC5\xA0\xC5\xA5astn\xC3\xBD aka Botanicus"
@@ -22,11 +22,10 @@ extra_rdoc_files: []
 
 files: 
 - bin/code-cleaner
-- code-cleaner-0.1.gem
 - code-cleaner.gemspec
 - LICENSE
 - README.textile
-- support/pre-commit
+- support/pre-commit.erb
 - tasks/code-cleaner.nake
 - tasks/code-cleaner.rake
 - tasks/code-cleaner.thor

data/support/pre-commit

@@ -1,46 +0,0 @@
-#!/bin/sh
-
-echo "Entering pre-commit hook ..."
-
-# If you haven't done any commit yet,
-# git diff will fail with following message:
-# fatal: No HEAD commit to compare with (yet)
-
-# TODO: how to get list of files which will be
-# committed if there isn't any commit in the index yet?
-# For now we just use normalize everything in current
-# directory, but it isn't very good solution.
-files=$(git diff --staged --name-only 2> /dev/null || echo ".")
-
-function abort() {
-  printf "[\e[31mERROR\e[0m] $*\n"
-  exit 1
-}
-
-# NOTE: we are using printf rather than echo because printf should be
-# more portable, each echo implementation has quite different behaviour
-if which code-cleaner &> /dev/null; then
-  for file in $files; do
-    if code-cleaner "$file" --try-apply-rules &> /dev/null ; then
-      printf "Normalizing \"\e[36m$file\e[0m\" "
-      code-cleaner "$file" --apply-rules &> /dev/null
-      # NOTE: we have to check the exit status directly,
-      # so we can be sure that the command just wasn't found
-      if [ $? -eq 10 ]; then # code-cleaner exits with 0 if some changes were made
-        printf "[\e[32mCLEAN\e[0m]\n"
-      elif [ $? -eq 1 ]; then # something goes wrong
-        printf "[\e[31mERROR\e[0m]\n"
-        code-cleaner "$file" --apply-rules
-      elif [ $? -eq 0 ] ; then
-        printf "[\e[33mDONE\e[0m]\n"
-        git add "$file" # so the changes will be committed immediately
-      else
-        abort "Unexpected exit status $?"
-      fi
-    else
-      printf "Skipping \"\e[36m$file\e[0m\"\n"
-    fi
-  done
-else
-  abort "You have to install code-cleaner first!"
-fi