= kode

* Based on: http://www.arachnoid.com/ruby/rubyBeautifier.html
* Gem's home: http://kode.rubyforge.org
* Git repo: http://gitorious.org/projects/kode

== DESCRIPTION:

This module is fork (and rework) of "Ruby Script Beautifier" by P. Lutus.

* Autoindenting of ruby code (Kode::Indenter)
* Check code for coding conventions (Kode::Styler)
* ... sometime erb/yaml formatter?

== FEATURES/PROBLEMS:

* Autoindenter works pretty well if you use ruby coding conventions
* Conventions checker coming soon :)
* erb/yaml indenter sometime...

== SYNOPSIS:

require 'kode'

# rewrites original and creates backup copy

Kode::Indenter.process :file => "/path/to/file.rb"

Kode::Indenter.process :file => "/path/to/file.rb", :backup => false

Kode::Indenter.process :text => "ruby\ncode\nhere"


== REQUIREMENTS:

* You need Ruby, dude :)

== INSTALL:

* sudo gem install kode

Vim addicts have to add this snippet to your ~/.vimrc

nmap <leader>rci :%!ruby-code-indenter<cr>

Gedit addicts have to add new external tool
Edit -> Preferences -> Plugins -> External Tools
Put ruby-code-indenter as command
Take current file as input
And replace current file by output

TextMate addicts may found this useful:
http://blog.neontology.com/posts/2006/05/10/beautiful-ruby-in-textmate

Emacs addicts please drop me some lisp snipet


== LICENSE:

Copyright (C) 2006, Paul Lutus

Copyright (C) 2008, Antono Vasiljev <[email protected]>

GPL 2+