erbeautifier 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 2007-09-02
+
+* 1 major enhancement:
+  * Initial release as a RubyGem

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Paul Battley/Revieworld Ltd.
+
+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/Manifest.txt

@@ -0,0 +1,24 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/htmlbeautifier
+config/hoe.rb
+config/requirements.rb
+lib/htmlbeautifier.rb
+lib/htmlbeautifier/beautifier.rb
+lib/htmlbeautifier/parser.rb
+lib/htmlbeautifier/version.rb
+log/debug.log
+script/destroy
+script/generate
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/html_beautifier_test_utilities.rb
+test/test_helper.rb
+test/test_html_beautifier_integration.rb
+test/test_html_beautifier_regression.rb
+test/test_parser.rb

data/README.txt

@@ -0,0 +1,16 @@
+= HTML Beautifier
+
+A normaliser/beautifier for HTML that also understands embedded Ruby. Ideal for tidying up Rails templates.
+
+== What it does
+
+* Normalises hard tabs to spaces
+* Removes trailing spaces
+* Indents after opening HTML elements
+* Outdents before closing elements
+* Collapses multiple whitespace
+* Indents after block-opening embedded Ruby (if, do etc.)
+* Outdents before closing Ruby blocks
+* Outdents elsif and then indents again
+* Indents the left-hand margin of JavaScript and CSS blocks to match the indentation level of the code
+

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "erbeautifier"
+    gemspec.summary = %q{Beautifies your HTML erb templates. Midwire's fork of Ho-Sheng Hsiao's code. Bug fixes, etc.}
+    gemspec.description = %q{A normaliser/beautifier for HTML that also understands embedded Ruby. Ideal for tidying up Rails templates.}
+    gemspec.email = %q{midwire@midwiretech.com}
+    gemspec.homepage = %q{http://github.com/midwire/htmlbeautifier}
+    gemspec.authors = ["Ho-Sheng Hsiao", "Midwire"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "erbeautifier #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/htmlbeautifier

@@ -0,0 +1,4 @@
+#! /usr/bin/ruby18
+require 'htmlbeautifier/beautifier'
+HtmlBeautifier::Beautifier.new($stdout).scan($stdin.read)
+$stdout << "\n"

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'htmlbeautifier/version'
+
+AUTHOR = 'Paul Battley'  # can also be an array of Authors
+EMAIL = "pbattley@gmail.com"
+DESCRIPTION = "A normaliser/beautifier for HTML that also understands embedded Ruby. Ideal for tidying up Rails templates."
+GEM_NAME = 'htmlbeautifier' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'htmlbeautifier' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}"
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = HtmlBeautifier::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'htmlbeautifier documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')

data/config/requirements.rb

@@ -0,0 +1,3 @@
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'htmlbeautifier'

data/erbeautifier.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{erbeautifier}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ho-Sheng Hsiao", "Midwire"]
+  s.date = %q{2010-02-05}
+  s.default_executable = %q{htmlbeautifier}
+  s.description = %q{A normaliser/beautifier for HTML that also understands embedded Ruby. Ideal for tidying up Rails templates.}
+  s.email = %q{midwire@midwiretech.com}
+  s.executables = ["htmlbeautifier"]
+  s.extra_rdoc_files = [
+    "README.txt"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "License.txt",
+     "Manifest.txt",
+     "README.txt",
+     "Rakefile",
+     "VERSION",
+     "bin/htmlbeautifier",
+     "config/hoe.rb",
+     "config/requirements.rb",
+     "erbeautifier.gemspec",
+     "lib/htmlbeautifier.rb",
+     "lib/htmlbeautifier/beautifier.rb",
+     "lib/htmlbeautifier/parser.rb",
+     "lib/htmlbeautifier/version.rb",
+     "script/destroy",
+     "script/generate",
+     "setup.rb",
+     "tasks/deployment.rake",
+     "tasks/environment.rake",
+     "tasks/website.rake",
+     "test/html_beautifier_test_utilities.rb",
+     "test/test_helper.rb",
+     "test/test_html_beautifier_integration.rb",
+     "test/test_html_beautifier_regression.rb",
+     "test/test_parser.rb"
+  ]
+  s.homepage = %q{http://github.com/midwire/htmlbeautifier}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Beautifies your HTML erb templates. Midwire's fork of Ho-Sheng Hsiao's code. Bug fixes, etc.}
+  s.test_files = [
+    "test/html_beautifier_test_utilities.rb",
+     "test/test_helper.rb",
+     "test/test_html_beautifier_integration.rb",
+     "test/test_html_beautifier_regression.rb",
+     "test/test_parser.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/htmlbeautifier.rb

@@ -0,0 +1,5 @@
+$:.unshift File.dirname(__FILE__)
+
+module HtmlBeautifier
+  
+end

data/lib/htmlbeautifier/beautifier.rb

@@ -0,0 +1,119 @@
+require 'htmlbeautifier/parser'
+
+module HtmlBeautifier
+  class Beautifier
+  
+    RUBY_INDENT  = 
+      %r{ ^ ( if | unless | while | begin | elsif )\b
+        | \b ( do | \{ ) ( \s* \| [^\|]+ \| )? $
+        }x
+    RUBY_OUTDENT = 
+      %r{ ^ ( end | elsif |\} ) \b 
+        }x
+    ELEMENT_CONTENT = %r{ (?:[^<>]|<%.*?%>)* }mx
+  
+    def initialize(output)
+      @level = 0
+      @new_line = true
+      self.tab_stops = 2
+      @output = output
+    end
+  
+    def tab_stops=(n)
+      @tab = ' ' * n
+    end
+  
+    def indent
+      @level += 1
+    end
+  
+    def outdent
+      @level -= 1
+      raise "Outdented too far" if @level < 0
+    end
+  
+    def emit(s)
+      if (@new_line)
+        @output << (@tab * @level)
+      end
+      @output << s
+      @new_line = false
+    end
+  
+    def whitespace(*x)
+      emit "\n"
+      @new_line = true
+    end
+  
+    def embed(opening, code, closing)
+      lines = code.split(/\n/).map{ |l| l.strip }
+      outdent if lines.first =~ RUBY_OUTDENT
+      emit opening + code + closing
+      indent if lines.last =~ RUBY_INDENT
+    end
+  
+    def foreign_block(opening, code, closing)
+      emit opening
+      begin
+        unless code.empty?
+          indent
+
+          lines = code.split(/\n/) 
+          lines.shift while lines.first.strip.empty?
+          lines.pop while lines.last.strip.empty?
+          indentation = lines.first[/^ +/]
+
+          whitespace
+          lines.each do |line|
+            emit line.rstrip.sub(/^#{indentation}/, '')
+            whitespace
+          end
+
+          outdent
+        end
+      rescue
+        # Ignore empty script blocks
+      end
+      emit closing
+    end
+  
+    def standalone_element(e)
+      emit e
+    end
+  
+    def close_element(e)
+      outdent
+      emit e
+    end
+  
+    def open_element(e)
+      emit e
+      indent
+    end
+  
+    def text(t)
+      emit(t.strip)
+      whitespace if t =~ /\s$/
+    end
+  
+    def scan(html)
+      html = html.strip.gsub(/\t/, @tab)
+      parser = Parser.new do
+        map %r{(<%=?)(.*?)(-?%>)}m,                             :embed
+        map %r{<!--\[.*?\]>}m,                                  :open_element
+        map %r{<!\[.*?\]-->}m,                                  :close_element
+        map %r{<!--.*?-->}m,                                    :standalone_element
+        map %r{<!.*?>}m,                                        :standalone_element
+        map %r{(<script#{ELEMENT_CONTENT}>)(.*?)(</script>)}m,  :foreign_block
+        map %r{(<style#{ELEMENT_CONTENT}>)(.*?)(</style>)}m,    :foreign_block
+        map %r{<#{ELEMENT_CONTENT}/>}m,                         :standalone_element
+        map %r{</#{ELEMENT_CONTENT}>}m,                         :close_element
+        map %r{<#{ELEMENT_CONTENT}>}m,                          :open_element
+        map %r{\s+},                                            :whitespace
+        map %r{[^<]+},                                          :text
+      end
+      parser.scan(html, self)
+    end
+    
+  end
+end

data/lib/htmlbeautifier/parser.rb

@@ -0,0 +1,53 @@
+require 'strscan'
+
+module HtmlBeautifier
+  class Parser
+  
+    def self.debug_block(&blk)
+      @debug_block = blk
+    end
+  
+    def self.debug(match, method)
+      if defined? @debug_block
+        @debug_block.call(match, method)
+      end
+    end
+  
+    def initialize(&blk)
+      @maps = []
+      if block_given?
+        self.instance_eval(&blk)
+      end
+    end
+  
+    def map(pattern, method)
+      @maps << [pattern, method]
+    end
+  
+    def scan(subject, receiver)
+      scanner = StringScanner.new(subject)
+      until scanner.eos?
+        dispatch(scanner, receiver)
+      end
+    end
+  
+    def dispatch(scanner, receiver)
+      @maps.each do |pattern, method|
+        if scanner.scan(pattern)
+          params = []
+          i = 1
+          while scanner[i]
+            params << scanner[i]
+            i += 1
+          end
+          params = [scanner[0]] if params.empty?
+          self.class.debug(scanner[0], method)
+          receiver.__send__(method, *params)
+          return
+        end
+      end
+      raise "Unmatched sequence #{match.inspect}"
+    end
+  
+  end
+end