kode 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.1.0 / 2008-02-25
+
+* first release as 'kode'
+

data/Manifest.txt

@@ -0,0 +1,9 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/ruby-code-indenter
+bin/ruby-code-styler
+lib/kode.rb
+test/test_kode.rb
+test/dirty.rb

data/README.txt

@@ -0,0 +1,65 @@
+= 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 <antono.vasiljev@gmail.com>
+
+GPL 2+
+

data/Rakefile

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/kode.rb'
+
+Hoe.new('kode', Kode::VERSION) do |p|
+  p.rubyforge_name = 'kode'
+  p.author = 'Antono Vasiljev'
+  p.email = 'antono.vasiljev@gmail.com'
+  p.summary = 'Code indenter and coding convention checker for Ruby'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = "http://gitorious.org/projects/kode"
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/bin/ruby-code-indenter

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../lib/kode'
+
+if ARGV.any?
+  ARGV.each do |path|
+    Kode::Indenter.process :file => path, :backup => true
+  end
+elsif !(code = STDIN.read).empty?
+  puts Kode::Indenter.process(:text => code)
+else
+  STDERR.puts "usage: ruby-code-indenter file.rb"
+  STDERR.puts "usage: cat file.rb | ruby-code-indenter"
+  exit 0
+end
+
+# vim: syntax=Ruby

data/bin/ruby-code-styler

@@ -0,0 +1 @@
+#!/usr/bin/env ruby

data/lib/kode.rb

@@ -0,0 +1,248 @@
+=begin
+/***************************************************************************
+ *   Copyright (C) 2006, Paul Lutus                                        *
+ *   Copyright (C) 2008, Antono Vasiljev                                   *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+module Kode
+
+  VERSION = '0.1.0'
+
+  class Indenter
+
+    # indent regexp
+    INDENT_EXP = [
+      /^def\b/,
+      /^if\b/,
+      /^else\b/,
+      /^elsif\b/,
+      /\bdo\b/,
+      /^class\b/,
+      /^module\b/,
+      /(=\s*|^)until\b/,
+      /(=\s*|^)for\b/,
+      /^unless\b/,
+      /(=\s*|^)while\b/,
+      /(=\s*|^)begin\b/,
+      /(^| )case\b/,
+      /\bthen\b/,
+      /^rescue\b/,
+      /^ensure\b/,
+      /\bwhen\b/,
+      /\{[^\}]*$/,
+      /\[[^\]]*$/
+    ]
+
+    # outdent regexp
+    OUTDENT_EXP = [
+      /^end\b/,
+      /^else\b/,
+      /^elsif\b/,
+      /^rescue\b/,
+      /^ensure\b/,
+      /\bwhen\b/,
+      /^[^\{]*\}/,
+      /^[^\[]*\]/
+    ]
+
+    # Creates cleaner. Takes hash of parametrs:
+    #
+    # :indent_char - indent symbol (default: space)
+    #
+    # :indent_size - quantity of indent symbols for single step (default: 2)
+    #
+    def initialize(params = {})
+      @indent_char = params[:indent_char] || " "
+      @indent_size = params[:indent_size] || 2
+    end
+
+    # Cleaning source. Takes hash of parametrs:
+    #
+    # :file   - Source code as path to file
+    #
+    # :text   - Source code as ruby string
+    #
+    # :backup - makes backup copy if true
+    #
+    # :indent_char - indent symbol (default: " ")
+    #
+    # :indent_size - quantity of indent symbols for single step
+    #
+    #
+    def self.process(params = {})
+      unless params[:file].nil?
+        params[:text] = File.read(params[:file])
+        @path = params[:file]
+      end
+
+      output = self.new(params).process(params[:text])
+
+      if params[:backup] && (source != dest) && params[:file]
+        File.open(params[:file] + ".ugly~","w") { |f| f.write(params[:text]) }
+        File.open(params[:file],"w") { |f| f.write(output) }
+      else
+        return output
+      end
+
+    end
+
+
+    # Cleaning source. Takes source code as ruby string.
+    #
+    def process(source)
+
+      cursor_inside_comment_block = false
+      cursor_at_program_end       = false
+
+      multiline_array  = []
+      multiline_string = ""
+
+      indent_level  = 0
+      dest          = ""
+
+      source.each_line do |line|
+
+        unless cursor_at_program_end
+
+          # detect program end mark
+          if line =~ /^__END__$/
+            cursor_at_program_end = true
+          else
+
+            # combine continuing lines
+            if(!(line =~ /^\s*#/) && line =~ /[^\\]\\\s*$/)
+              multiline_array.push line
+              multiline_string += line.sub(/^(.*)\\\s*$/,"\\1")
+              next
+            end
+
+            # add final line
+            if (multiline_string.length > 0)
+              multiline_array.push line
+              multiline_string += line.sub(/^(.*)\\\s*$/,"\\1")
+            end
+
+            tline = ((multiline_string.length > 0) ? multiline_string : line).strip
+
+            cursor_inside_comment_block = true if tline.match(/^=begin/)
+          end
+        end
+
+        if (cursor_inside_comment_block or cursor_at_program_end)
+          dest += line # add the line unchanged
+        else
+
+          cursor_at_comment_line = (tline =~ /^#/)
+
+          unless cursor_at_comment_line
+            # throw out sequences that will
+            # only sow confusion
+            # XXX WTF?
+            while tline.gsub!(/\{[^\{]*?\}/,"")
+            end
+            while tline.gsub!(/\[[^\[]*?\]/,"")
+            end
+            while tline.gsub!(/'.*?'/,"")
+            end
+            while tline.gsub!(/".*?"/,"")
+            end
+            while tline.gsub!(/\`.*?\`/,"")
+            end
+            while tline.gsub!(/\([^\(]*?\)/,"")
+            end
+            while tline.gsub!(/\/.*?\//,"")
+            end
+            while tline.gsub!(/%r(.).*?\1/,"")
+            end
+
+            # delete end-of-line comments
+            tline.sub!(/#[^\"]+$/,"")
+            # convert quotes
+            # WTF?
+            tline.gsub!(/\\\"/,"'")
+            OUTDENT_EXP.each do |re|
+              if (tline =~ re)
+                indent_level -= 1
+                break
+              end
+            end
+          end
+
+          unless multiline_array.empty?
+            multiline_array.each do |ml|
+              dest += add_line(ml,indent_level)
+            end
+            multiline_array.clear
+            multiline_string = ""
+          else
+            dest += add_line(line,indent_level)
+          end
+
+          unless cursor_at_comment_line
+            INDENT_EXP.each do |re|
+              if(tline =~ re && !(tline =~ /\s+end\s*$/))
+                indent_level += 1
+                break
+              end
+            end
+          end
+
+        end
+
+        cursor_inside_comment_block = false if tline =~ /^=end/
+      end
+
+
+      if (indent_level != 0)
+        STDERR.puts "#{@path}: Indentation error: #{indent_level}" if @path
+      end
+
+      return dest
+    end
+
+    private
+
+    def make_indent(indent_level)
+      return (indent_level < 0) ? "" : @indent_char * @indent_size * indent_level
+    end
+
+    def add_line(line,indent_level)
+      line.strip!
+      line = make_indent(indent_level)+line if line.length > 0
+      return line + "\n"
+    end
+
+  end
+
+
+  # Check code for Ruby coding conventions...
+  #
+  class Styler
+
+    METHOD = {
+      :match => /def\s+([\.\w]+)/,
+      :false => /[A-Z]+/,
+      :true  => /[a-z_]+/
+    }
+
+    def self.process
+
+    end
+  end
+
+end

data/test/dirty.rb

@@ -0,0 +1,231 @@
+=begin
+/***************************************************************************
+*   Copyright (C) 2006, Paul Lutus                                        *
+*                                                                         *
+*   This program is free software; you can redistribute it and/or modify  *
+*   it under the terms of the GNU General Public License as published by  *
+*   the Free Software Foundation; either version 2 of the License, or     *
+*   (at your option) any later version.                                   *
+*                                                                         *
+*   This program is distributed in the hope that it will be useful,       *
+*   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+*   GNU General Public License for more details.                          *
+*                                                                         *
+*   You should have received a copy of the GNU General Public License     *
+*   along with this program; if not, write to the                         *
+*   Free Software Foundation, Inc.,                                       *
+*   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+***************************************************************************/
+=end
+
+module Code
+
+  class Indenter
+
+    # indent regexp
+    INDENT_EXP = [
+      /^def\b/,
+      /^if\b/,
+      /^else\b/,
+      /^elsif\b/,
+      /\bdo\b/,
+      /^class\b/,
+      /^module\b/,
+      /(=\s*|^)until\b/,
+      /(=\s*|^)for\b/,
+      /^unless\b/,
+      /(=\s*|^)while\b/,
+      /(=\s*|^)begin\b/,
+      /(^| )case\b/,
+      /\bthen\b/,
+      /^rescue\b/,
+      /^ensure\b/,
+      /\bwhen\b/,
+      /\{[^\}]*$/,
+      /\[[^\]]*$/
+    ]
+
+    # outdent regexp
+    OUTDENT_EXP = [
+      /^end\b/,
+      /^else\b/,
+      /^elsif\b/,
+      /^rescue\b/,
+      /^ensure\b/,
+      /\bwhen\b/,
+      /^[^\{]*\}/,
+      /^[^\[]*\]/
+    ]
+
+    # Creates cleaner. Takes hash of parametrs:
+    #
+    # :indent_char - indent symbol (default: " ")
+    # :indent_size - quantity of indent symbols for single step
+    #
+    def initialize(params = {})
+      @indent_char = params[:indent_char] || " "
+      @indent_size = params[:indent_size] || 2
+    end
+
+    # Cleaning file by given path. Takes full path to ruby source file and a hash of parameters:
+    #
+    # :backup - makes backup copy if true
+    #
+    # For more look at +CleanR.new+ documentation
+    #
+    def self.process_file(path, params = { :backup => true } )
+
+      source = File.read(path)
+      dest   = self.clean(params.merge(:text => source))
+
+      if params[:backup] && (source != dest)
+        # make a backup copy
+        File.open(path + ".ugly~","w") { |f| f.write(source) }
+        # overwrite the original
+        File.open(path,"w") { |f| f.write(dest) }
+      end
+    end
+
+    # Cleaning source. Takes hash of parametrs:
+    #
+    # :text - Source code as ruby string
+    #
+    # For more keys look at +CleanR.new+ documentation
+    #
+    def self.clean(params = {})
+      self.new(params).clean(params[:text])
+    end
+
+    def clean(source)
+
+      cursor_inside_comment_block = false
+      cursor_at_program_end       = false
+
+      multiline_array  = []
+      multiline_string = ""
+
+      indent_level  = 0
+      dest          = ""
+
+      source.each_line do |line|
+
+        unless cursor_at_program_end
+
+          # detect program end mark
+          if line =~ /^__END__$/
+            cursor_at_program_end = true
+          else
+
+            # combine continuing lines
+            if(!(line =~ /^\s*#/) && line =~ /[^\\]\\\s*$/)
+              multiline_array.push line
+              multiline_string += line.sub(/^(.*)\\\s*$/,"\\1")
+              next
+            end
+
+            # add final line
+            if (multiline_string.length > 0)
+              multiline_array.push line
+              multiline_string += line.sub(/^(.*)\\\s*$/,"\\1")
+            end
+
+            tline = ((multiline_string.length > 0) ? multiline_string : line).strip
+
+            cursor_inside_comment_block = true if tline.match(/^=begin/)
+          end
+        end
+
+        if (cursor_inside_comment_block or cursor_at_program_end)
+          dest += line # add the line unchanged
+        else
+
+          cursor_at_comment_line = (tline =~ /^#/)
+
+          unless cursor_at_comment_line
+            # throw out sequences that will
+            # only sow confusion
+            # XXX WTF?
+            while tline.gsub!(/\{[^\{]*?\}/,"")
+            end
+            while tline.gsub!(/\[[^\[]*?\]/,"")
+            end
+            while tline.gsub!(/'.*?'/,"")
+            end
+            while tline.gsub!(/".*?"/,"")
+            end
+            while tline.gsub!(/\`.*?\`/,"")
+            end
+            while tline.gsub!(/\([^\(]*?\)/,"")
+            end
+            while tline.gsub!(/\/.*?\//,"")
+            end
+            while tline.gsub!(/%r(.).*?\1/,"")
+            end
+
+            # delete end-of-line comments
+            tline.sub!(/#[^\"]+$/,"")
+            # convert quotes
+            # WTF?
+            tline.gsub!(/\\\"/,"'")
+            OUTDENT_EXP.each do |re|
+              if (tline =~ re)
+                indent_level -= 1
+                break
+              end
+            end
+          end
+
+          unless multiline_array.empty?
+            multiline_array.each do |ml|
+              dest += add_line(ml,indent_level)
+            end
+            multiline_array.clear
+            multiline_string = ""
+          else
+            dest += add_line(line,indent_level)
+          end
+
+          unless cursor_at_comment_line
+            INDENT_EXP.each do |re|
+              if(tline =~ re && !(tline =~ /\s+end\s*$/))
+                indent_level += 1
+                break
+              end
+            end
+          end
+
+        end
+
+        cursor_inside_comment_block = false if tline =~ /^=end/
+      end
+
+
+      if (indent_level != 0)
+        STDERR.puts "#{path}: Indentation error: #{indent_level}"
+      end
+
+      return dest
+    end
+
+    private
+
+    def make_indent(indent_level)
+      return (indent_level < 0) ? "" : @indent_char * @indent_size * indent_level
+    end
+
+    def add_line(line,indent_level)
+      line.strip!
+      line = make_indent(indent_level)+line if line.length > 0
+      return line + "\n"
+    end
+
+  end
+
+
+
+  class Styler
+  end
+
+end
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: kode
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Antono Vasiljev
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDQDCCAiigAwIBAgIBADANBgkqhkiG9w0BAQUFADBGMRgwFgYDVQQDDA9hbnRv
+  bm8udmFzaWxqZXYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixk
+  ARkWA2NvbTAeFw0wODAyMjQxNzQyMzNaFw0wOTAyMjMxNzQyMzNaMEYxGDAWBgNV
+  BAMMD2FudG9uby52YXNpbGpldjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYK
+  CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
+  tnBsZV7rCGSGhRfCfiTJ4Hu7vrAty73aF7nDJnXiBEn5nLDb2r4XAnz/WFjNCJty
+  f+9NuRLocUtx53mmC4GbOth1IROlYxTCcoSnaWYUK6k9X2/uQuZmGaTWm+l9cVfB
+  toNB2+NmxS5m3shtlu4eDD23OPXAN7whUSqM6atszzKcfAjcSX580b+6wtDy8vGa
+  9GxWYojzhbOLiKekkP6/XX0tattBfziLgWRNFgf0spwr0RbTpCo9x+mmo3YjmCXx
+  FCMstCdYmrMw21pAu2oJjnoqZ+XmMMefZ4xy5+A5+by+6MuiSHzzQASy5E56bFeL
+  uTqLtDDNOS6h/D3p0DvbrwIDAQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIE
+  sDAdBgNVHQ4EFgQUpDAbiShgNHzfObH6wSF5vbw47WUwDQYJKoZIhvcNAQEFBQAD
+  ggEBAC86UZzjH6Tiua20Tv6zgiS45YjW/MYKztfXL3OyifrlT0dTLoSJ7edt+kBW
+  CMh1ykErLh0e+w2hGbs7igZI25dRbcI5UnfnTEqb67Ghm+gHqdMXeQYFWhXU2D4C
+  UDwmpMJU93SPb7dit2s44UaMT9dplQANwLNQFEECr70WJ5VG3avo4x10oxeRHlDa
+  jTpXj3vTnG3ZDpWPDhmoX+2WeJfuPwAznuL2Z1HBMk8iDlJ1GM+FGUbVfMofD4Ex
+  P5/ty+94oWvf4D4SOAXWib/x0LVZJIWIMaoFEjH/tvmxtMJaJXvL+oixnc9xE1U4
+  jPtJtRL1RfX37yQGoofqWl37iHY=
+  -----END CERTIFICATE-----
+
+date: 2008-02-25 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+description: "== 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:"
+email: antono.vasiljev@gmail.com
+executables: 
+- ruby-code-indenter
+- ruby-code-styler
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/ruby-code-indenter
+- bin/ruby-code-styler
+- lib/kode.rb
+- test/test_kode.rb
+- test/dirty.rb
+has_rdoc: true
+homepage: http://gitorious.org/projects/kode
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+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: kode
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Code indenter and coding convention checker for Ruby
+test_files: 
+- test/test_kode.rb