code-cleaner 0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 – 2010 Jakub Šťastný aka Botanicus
+
+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.

data/README.textile

@@ -0,0 +1,64 @@
+h1. About
+
+Remove trailing whitespace, append missing \n and replace tabs by two spaces.
+
+h1. Usage
+
+<pre>
+# edit script.rb and all Ruby scripts in lib directory
+code-cleaner script.rb lib
+
+# normalize standard input and print output to standard output
+cat script.rb | code-cleaner
+
+# add encoding declaration if missing
+code-cleaner --encoding=utf-8
+</pre>
+
+h2. Blacklisting & Whitelisting
+
+Of course you don't want to remove spaces from other files like PDF documents, images etc. You don't even want to remove spaces from all Ruby scripts, you probably want to ignore vendored files and locally installed gems. And this is where blacklisting and whitelisting comes handy.
+
+Default behaviour is to ignore everything from vendor and gems directories and from other directories just files ending with .rb, .rake, .task and .thor are normalized.
+
+You can change this behaviour by setting environment variables @BLACKLIST@ and @WHITELIST@. What you pass to these variables will be treated as a regular expression. The default behaviour respond to @BLACKLIST='/(vendor|gems)/'@ and @WHITELIST='\.(rb|rake|task|thor)$'@. Here's an example how you can use it:
+
+<pre>
+WHITELIST=''\.(rb|rake|nake|thor|task)$'' BLACKLIST='/(vendor|gems)/' code-cleaner .
+</pre>
+
+Note that these rules aren't applied for explicit arguments, so if you run @code-cleaner README.textile@, your readme actually will be normalized. It's because blacklisting and whitelisting rules are applied just on directories, so if you run @code-cleaner .@, your readme will stay untouched. Because of this reason @code-cleaner .@ and @code-cleaner *@ will be different.
+
+If you want to force blacklisting resp. whitelisting even for explicitly specified files, use @--apply-rules@ switch. If you want just try it, use @--try-apply-rules@ which will tell you which files will be skipped and exit without any editing. If some files left in ARGV, the exit status will be 0, otherwise it will be 1.
+
+In your Ruby projects, you might add all files in your @bin@ and @script@ directories into whitelist: @WHITELIST='(bin/[^/]+|.+\.(rb|rake|nake|thor|task))$'@
+
+h2. Exit statuses
+
+If code-cleaner does any changes, the exit status will be 0, otherwise it will be 10. It means you can use it in commands like:
+
+<pre>
+if code-cleaner "$file" --apply-rules; then # code-cleaner exits with 0 if some changes were made
+  git add "$file" # so the changes will be committed immediately
+fi
+</pre>
+
+Or, better and more safe way is to directly check exit status of last command via @$?@ as is used in the default @pre-commit@ hook:
+
+<pre>
+code-cleaner .
+
+if [ $? -eq 10 ]; then
+  echo Any modifications were made
+else
+  echo File was changed
+fi
+</pre>
+
+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.
+
+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@.

data/bin/code-cleaner

@@ -0,0 +1,141 @@
+#!/usr/bin/env ruby -i
+# encoding: utf-8
+
+# This is black magic!
+# If you like Perl, you will probably enjoy it
+# However it's easy to write and it works, so why not.
+
+# Also be warned this script is evil – it might eat your
+# cat or burn you house and I'm not responsible for it.
+
+# == Normalize your source code == #
+# 1) replace tabs by two space
+# 2) remove trailing whitespace
+# 3) add \n at the end of file unless it's already there
+
+# == Usage == #
+# code-cleaner app/controller/application_controller.rb
+# cat app/controller/application_controller.rb | code-cleaner
+#
+# == Implementation == #
+# The point is that ruby with -i will edit files
+
+require "find"
+
+$-i = "" # Windows compatibility
+
+WHITELIST = Regexp.new(ENV["WHITELIST"] || '\.(rb|rake|nake|thor|task)$')
+BLACKLIST = Regexp.new(ENV["BLACKLIST"] || '/(vendor|gems)/')
+
+def permitted?(file)
+  WHITELIST.match(file) && ! BLACKLIST.match(file)
+end
+
+if ARGF.nil?
+  abort "Hey mate, what about some arguments or piped data? How the fuck you think I work?!"
+end
+
+# help
+if ARGV.include?("-h") or ARGV.include?("--help")
+  abort "[\e[32mUsage\e[0m]\n"\
+        "code-cleaner script.rb       # normalize script.rb\n"\
+        "cat script.rb | code-cleaner # normalize standard input and print output to standard output\n"\
+        "\n"\
+        "[\e[32mOptions\e[0m]\n"\
+        "--encoding=utf-8             # add encoding declaration if missing\n"\
+        "--apply-rules                # apply blacklisting and whitelisting even on explicitly specified files\n"\
+        "--try-apply-rules            # apply rules and exit successfuly if some files left in ARGV, fail otherwise\n"\
+        "\n"\
+        "[\e[32mEnvironment Variables\e[0m]\n"\
+        "BLACKLIST                    # patterns which will be ignored, defaults to /(vendor|gems)/\n"\
+        "WHITELIST                    # patterns which won't be ignored, defaults to \.(rb|rake|nake|thor|task)$\n"\
+        "\n"\
+        "[\e[32mTricks\e[0m]\n"\
+        "If you want to add files from your bin or script directory into \n"\
+        "whitelist, use WHITELIST='(bin/[^/]+|.+\.(rb|rake|nake|thor|task))$'"
+        "\n"\
+        "[\e[32mExamples\e[0m]\n"\
+        "WHITELIST='(bin/[^/]+|.+\.(rb|rake|nake|thor|task))$'"
+end
+
+def apply_rules
+  original = ARGV.dup
+  ARGV.delete_if { |file| File.file?(file) && ! permitted?(file) }
+  puts "~ Skipping #{original - ARGV}" unless ARGV == original
+end
+
+if ARGV.delete("--try-apply-rules")
+  apply_rules
+  ARGV.empty? ? exit(1) : exit
+end
+
+if ARGV.delete("--apply-rules")
+  apply_rules
+end
+
+unless ARGV.grep(/^--encoding=(.+)$/).empty?
+  argument = ARGV.grep(/^--encoding=(.+)$/).first
+  ARGV.delete(argument)
+  argument.match(/^--encoding=(.+)$/)
+  encoding = $1.dup
+else
+  encoding = nil
+end
+
+# expand all directories to list of files
+if ARGV.any? { |file| File.directory?(file) }
+  args = Array.new
+  ARGV.each do |item|
+    if File.directory?(item)
+      Find.find(item) do |file|
+        if File.file?(file) && permitted?(file)
+          args.push(file)
+        end
+      end
+    else
+      args.push(item)
+    end
+  end
+  ARGV.clear.push(*args)
+  puts "~ Expanding args into #{ARGV.inspect}"
+end
+
+# Ruby 1.9 will warn that you can't do in place edit for stdio,
+# so we will disable in place mode. Yes, in Ruby 1.9 you can finally
+# turn in place mode on or off from API in better way than just $-i = false.
+if ARGF.respond_to?(:inplace_mode) && ARGV.empty?
+  ARGF.inplace_mode = false
+end
+
+# default exit status is 10 which signalize that we actually haven't changed anything
+status = 10
+
+# This is the only way how I was able to inspect if STDIN is empty. Magic, right?
+# NOTE: if this shows as a bad idea, another way might be to put "/dev/null" resp. "NUL" on Windows to the ARGV
+begin
+  STDIN.read_nonblock(1)
+rescue Errno::EAGAIN
+  # The point of inspecting if STDIN and ARGV are empty is that we might
+  # have an empty ARGF if anything passed and if so, it will wait for an interactive input which we don't want
+  unless ARGV.empty?
+    while line = ARGF.gets
+      # I was trying to use ARGF.lineno.eql?(1), but it doesn't work. First problem
+      # was it didn't work with ARGF#each_line because IO#lineno count how many times
+      # IO#gets was called rather than how many \n the stream have. It isn't any
+      # serious problem, however when we have multiple files in ARGV, then the
+      # lineno isn't cleaned after the file in ARGF is switched.
+      # The trick with line.length == ARGF.pos is simple, IO#pos returns position
+      # of last character which was readed by gets or similar method, so if
+      # the position is same as is the line, then it has to be the first line.
+      if line.length == ARGF.pos && encoding && ! line.match(/^#.*coding/)
+        puts "# encoding: #{encoding}"
+      end
+      # You might be wondering WTF is going on, I'm editing files, so I have to use File.open, do the modification on the original content and then save it. The point is we used -i switch which is good for in place editing
+       # flag that we actually changed the file
+      status = 0 if line.match(/^\s*\t\s*/) || ! line.match(/\n/)
+      puts line.gsub(/\t/, "  ").rstrip
+    end
+  end
+end
+
+exit status

data/code-cleaner.gemspec

@@ -0,0 +1,25 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name = "code-cleaner"
+  s.version = "0.1"
+  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"
+  s.description = "" # TODO: long description
+  s.cert_chain = nil
+  s.email = ["knava.bestvinensis", "gmail.com"].join("@")
+  s.has_rdoc = false
+
+  # so you can use load "code-cleaner.rake" in you Rakefile
+  s.require_paths = ["tasks"]
+
+  # files
+  s.files = Dir["**/*"]
+  s.executables = ["code-cleaner"]
+  s.default_executable = "code-cleaner"
+
+  # RubyForge
+  s.rubyforge_project = "code-cleaner"
+end

data/support/pre-commit

@@ -0,0 +1,37 @@
+#!/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 ".")
+
+# 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"
+      else
+        printf "[\e[33mDONE\e[0m]\n"
+        git add "$file" # so the changes will be committed immediately
+      fi
+    else
+      printf "Skipping \"\e[36m$file\e[0m\"\n"
+    fi
+  done
+else
+  printf "[\e[31mERROR\e[0m] You have to install code-cleaner first!\n"
+  exit 1
+fi

data/tasks/code-cleaner.nake

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require "fileutils"
+require "nake/task"
+
+Nake::Task.new("hooks:whitespace:install") do |task|
+  task.description = "Install hook for automatically removing trailing whitespace"
+  task.define do
+    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
+      rescue Errno::ENOENT
+        abort "You have to run git init first!"
+      end
+    end
+  end
+end

data/tasks/code-cleaner.rake

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+desc "Install hook for automatically removing trailing whitespace"
+task "hooks:whitespace:install" do
+  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")
+      install source, ".git/hooks/pre-commit", :mode => 0755
+    rescue Errno::ENOENT
+      abort "You have to run git init first!"
+    end
+  end
+end

data/tasks/code-cleaner.thor

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require "fileutils"
+
+module Hooks
+  class Whitespace < Thor
+    desc "install", "Install hook for automatically removing trailing whitespace"
+    def install
+      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
+      end
+    rescue Errno::ENOENT
+      abort "You have to run git init first!"
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: code-cleaner
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- "Jakub \xC5\xA0\xC5\xA5astn\xC3\xBD aka Botanicus"
+autorequire: 
+bindir: bin
+cert_chain: 
+date: 2009-12-28 00:00:00 +01:00
+default_executable: code-cleaner
+dependencies: []
+
+description: ""
+email: knava.bestvinensis@gmail.com
+executables: 
+- code-cleaner
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/code-cleaner
+- code-cleaner-0.1.gem
+- code-cleaner.gemspec
+- LICENSE
+- README.textile
+- support/pre-commit
+- tasks/code-cleaner.nake
+- tasks/code-cleaner.rake
+- tasks/code-cleaner.thor
+has_rdoc: true
+homepage: http://github.com/botanicus/code-cleaner
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- tasks
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: code-cleaner
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Remove trailing whitespace, append missing \n and replace tabs by two spaces
+test_files: []
+