htmlmin 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in htmlmin.gemspec
+gemspec

data/README.md

@@ -0,0 +1,64 @@
+# Introduction
+
+HTMLMIN (HTML minimizer) is a HTML minimizer written in Ruby wich acts like a slot machine.
+
+This document describes installation, usage, available minifications and development roadmap of HTMLMIN.
+
+Please report issues on [Github] (https://github.com/aishek/htmlmin/issues).
+
+For feedback, suggestions, etc. write to <aishek@gmail.com>.
+
+**Important**: this project is in beta and may contain bugs. Current version: 0.0.1
+
+# Installation
+
+To install:
+
+* run `gem install htmlmin`
+
+# Usage
+
+Usage:
+
+    require 'htmlmin'
+    options = {
+      :remove_comments => true,
+      :minify_whitespaces => true
+    }
+    minified_html = HTMLMin.minify(html, options)
+
+# Minification
+
+* Insert newline after DOCTYPE declaration
+* Removal of whitespace
+* Removal of comments
+
+# Development roadmap
+
+* ~~Minify whitespaces between tags~~
+* ~~Insert newline after DOCTYPE declaration~~
+* ~~Minify whitespaces after tag start and tag stop~~
+* ~~Minify whitespaces in text~~
+* ~~Remove comments~~
+* Do not remove conditional comments
+* Keep lines not longer that 30k (config option)
+* Do not perform minify in script and style tag's content
+* Do not perform minify in code, samp, pre tags's content
+* Replace entities with numeric entities for shorter strings
+* Replace entities with characters for shorter strings
+* Minify shorttag close symbol
+* Minify shorttag close whitespace
+* Replace http:// with // in href and src attributes
+* Minify whitespaces between tag attributes
+* Minify quotes in one-word attributes
+* Remove empty attributes
+* Minify whitespaces in class attribute's content
+* Replace css-classes in class attribute's content
+
+# Author
+
+Idea & implementation&nbsp;— Alexandr Borisov (<aishek@gmail.com>)
+
+# Licence
+
+HTMLMIN is licensed under [MIT](https://github.com/afelix/csso/blob/master/MIT-LICENSE.txt)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/htmlmin.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "htmlmin/version"
+
+Gem::Specification.new do |s|
+  s.name        = "htmlmin"
+  s.version     = Htmlmin::VERSION
+  s.authors     = ["Alexandr Borisov"]
+  s.email       = ["aishek@gmail.com"]
+  s.platform    = Gem::Platform::RUBY
+  s.homepage    = "http://github.com/aishek/htmlmin"
+  s.summary     = %q{HTMLMin is a HTML-code minification tool}
+  s.description = %q{HTMLMin is a HTML-code minification tool implemented in Ruby. It works like a slot machine.}
+  s.license = 'MIT'
+
+  s.rubyforge_project = "htmlmin"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/htmlmin/buffer.rb

@@ -0,0 +1,30 @@
+module HTMLMin
+  
+  module Buffer
+    
+    private 
+
+    def add_to_buffer(char)
+      @result_buffer.push(char)
+    end
+    
+    def space_in_buffer?
+      @result_buffer.length > 0 && @result_buffer[@result_buffer.length - 1] == ' '
+    end
+    
+    def flush_buffer
+      @result += @result_buffer.join('')
+      clear_buffer
+    end
+    
+    def unshift_spaces_from_buffer
+      @result_buffer = @result_buffer.drop_while {|char| char == ' '} if @settings[:minify_whitespaces]
+    end
+    
+    def clear_buffer
+      @result_buffer = []
+    end
+    
+  end
+  
+end

data/lib/htmlmin/slot_machines/comment.rb

@@ -0,0 +1,53 @@
+module HTMLMin
+  
+  module SlotMachines
+    
+    module Comment
+
+      private
+
+      def comment_begin_1(char)
+        case char
+          when "\s", "\n", "\r", "\t", " "
+            flush_buffer
+            change_state_to_text_prespaced char
+          when '-'
+            add_to_buffer char
+            change_state_to :comment_start_end
+          else
+            flush_buffer
+            add_to_result char
+            change_state_to :start
+        end
+      end
+
+      def comment_start_end(char)
+        add_to_buffer char
+        change_state_to :comment
+      end
+
+      def comment(char)
+        add_to_buffer char
+        change_state_to :comment_end_1 if char == '-'
+      end
+
+      def comment_end_1(char)
+        add_to_buffer char
+        change_state_to (char == '-' ? :comment_end_2 : :comment)
+      end
+
+      def comment_end_2(char)
+        if char == '>'
+          clear_buffer
+          change_state_to :start unless restore_state
+        else
+          add_to_buffer char
+          change_state_to :comment
+        end
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/htmlmin/slot_machines/common.rb

@@ -0,0 +1,102 @@
+module HTMLMin
+
+  module SlotMachines
+    
+    module Common
+
+      private
+        
+      def add_to_result(char)
+        @result += char
+      end
+  
+      def change_state_to(new_state)
+        @state = new_state
+      end
+        
+      def tag_or_tagend_or_comment_or_doctype_begin(char)
+        case char
+          when "\s", "\n", "\r", "\t", " "
+            flush_buffer
+            change_state_to_text_prespaced char
+          when "/"
+            add_to_buffer char
+            change_state_to :tag_end
+          when "!"
+            add_to_buffer char
+            change_state_to :comment_or_doctype_begin
+          when "a".."z", "A".."Z"
+            add_to_buffer char
+            change_state_to :tag_begin
+          else
+            flush_buffer
+            add_to_result char
+            change_state_to :start
+        end
+      end
+
+      def comment_or_doctype_begin(char)
+        case char
+          when "\s", "\n", "\r", "\t", " "
+            flush_buffer
+            change_state_to_text_prespaced char
+          when "-"
+            if @settings[:remove_comments]
+              add_to_buffer char
+              change_state_to :comment_begin_1
+            else
+              flush_buffer
+              add_to_result char
+              change_state_to :start
+            end
+          when 'D'
+            add_to_buffer char
+            change_state_to :doctype_begin_1
+          else
+            flush_buffer
+            add_to_result char
+            change_state_to :start
+        end
+      end
+
+      def text_prespaced(char)              
+        case char
+          when "\s", "\n", "\r", "\t", " "
+            if @settings[:minify_whitespaces]
+              add_to_buffer " " unless space_in_buffer?
+            else
+              add_to_buffer char
+            end
+          when "<"
+            add_to_buffer char
+            change_state_to :tag_or_tagend_or_comment_or_doctype_begin
+          else
+            flush_buffer
+            add_to_result char
+            change_state_to :start
+        end
+      end
+  
+      def start(char)
+        case char
+          when "\s", "\n", "\r", "\t"
+            change_state_to_text_prespaced char
+          when "<"
+            add_to_buffer char
+            change_state_to :tag_or_tagend_or_comment_or_doctype_begin            
+          else
+            add_to_result char
+            change_state_to :start
+        end
+      end
+    
+      def change_state_to_text_prespaced(char)
+        add_to_buffer (@settings[:minify_whitespaces] ? ' ' : char)
+        change_state_to :text_prespaced
+      end
+    
+    end
+    
+  end
+
+end

data/lib/htmlmin/slot_machines/doctype.rb

@@ -0,0 +1,135 @@
+module HTMLMin
+  
+  module SlotMachines
+    
+    module Doctype
+
+      private
+
+      def doctype_begin_1(char)
+        case char
+          when "O"
+            add_to_buffer char
+            change_state_to :doctype_begin_2
+          when "\s", "\n", "\r", "\t", " "
+            change_state_to_text_prespaced char
+          else
+            flush_buffer
+
+            add_to_result char
+            change_state_to :start
+        end
+      end
+      
+      def doctype_begin_2(char)
+        case char
+          when "C"
+            add_to_buffer char
+            change_state_to :doctype_begin_3
+          when "\s", "\n", "\r", "\t", " "
+            flush_buffer
+            change_state_to_text_prespaced char
+          else
+            flush_buffer
+
+            add_to_result char
+            change_state_to :start
+        end
+      end
+      
+      def doctype_begin_3(char)
+        case char
+          when "T"
+            add_to_buffer char
+            change_state_to :doctype_begin_4
+          when "\s", "\n", "\r", "\t", " "
+            flush_buffer
+            change_state_to_text_prespaced char
+          else
+            flush_buffer
+
+            add_to_result char
+            change_state_to :start
+        end
+      end
+      
+      def doctype_begin_4(char)
+        case char
+          when "Y"
+            add_to_buffer char
+            change_state_to :doctype_begin_5
+          when "\s", "\n", "\r", "\t", " "
+            flush_buffer
+            change_state_to_text_prespaced char
+          else
+            flush_buffer
+
+            add_to_result char
+            change_state_to :start
+        end
+      end
+      
+      def doctype_begin_5(char)
+        case char
+          when "P"
+            add_to_buffer char
+            change_state_to :doctype_begin_6
+          when "\s", "\n", "\r", "\t", " "
+            flush_buffer
+            change_state_to_text_prespaced char
+          else
+            flush_buffer
+
+            add_to_result char
+            change_state_to :start
+        end
+      end
+      
+      def doctype_begin_6(char)
+        case char
+          when "E"
+            add_to_buffer char
+            change_state_to :doctype_begin_7
+          when "\s", "\n", "\r", "\t", " "
+            flush_buffer
+            change_state_to_text_prespaced char
+          else
+            flush_buffer
+
+            add_to_result char
+            change_state_to :start
+        end
+      end
+
+      def doctype_begin_7(char)
+        case char
+          when " "
+            add_to_buffer char
+            change_state_to :doctype
+          when "\s", "\n", "\r", "\t"
+            flush_buffer
+            change_state_to_text_prespaced char
+          else
+            flush_buffer
+
+            add_to_result char
+            change_state_to :start
+        end
+      end
+      
+      def doctype(char)
+        add_to_buffer char
+        if char == '>'          
+          unshift_spaces_from_buffer
+          flush_buffer
+          
+          add_to_result "\n" 
+          change_state_to :start
+        end
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/htmlmin/slot_machines/tag.rb

@@ -0,0 +1,83 @@
+module HTMLMin
+  
+  module SlotMachines
+    
+    module Tag
+
+      private
+
+      def tag_end(char)
+        case char
+          when "a".."z", "A".."Z"
+            add_to_buffer char
+            change_state_to :tag_end_body
+          else
+            flush_buffer
+            change_state_to :start
+        end
+      end
+
+      def tag_end_body(char)
+        case char
+          when "a".."z", "A".."Z"
+            add_to_buffer char
+          when '>'
+            add_to_buffer char
+
+            unshift_spaces_from_buffer
+            flush_buffer
+
+            change_state_to :tag_ended
+          else
+            flush_buffer
+            change_state_to :start
+        end
+      end
+
+      def tag_begin(char)
+        add_to_buffer char
+        case char
+          when "/"
+            change_state_to :tag_end_expected
+          when ">"
+            change_state_to :tag_ended
+        end
+      end
+      
+      def tag_end_expected(char)
+        case char
+          when '>'
+            add_to_buffer char
+            change_state_to :tag_ended
+          else
+            flush_buffer
+            change_state_to :start
+        end
+      end
+      
+      def tag_ended(char)
+        case char
+          when "\s", "\n", "\r", "\t", " "
+            add_to_result char unless @settings[:minify_whitespaces]
+          when '<'
+            save_state
+            
+            unshift_spaces_from_buffer
+            flush_buffer
+            
+            add_to_buffer char
+            change_state_to :tag_or_tagend_or_comment_or_doctype_begin
+          else
+            unshift_spaces_from_buffer
+            flush_buffer            
+            
+            add_to_result char
+            change_state_to :start
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/htmlmin/slot_machines.rb

@@ -0,0 +1,4 @@
+require 'htmlmin/slot_machines/common'
+require 'htmlmin/slot_machines/comment'
+require 'htmlmin/slot_machines/doctype'
+require 'htmlmin/slot_machines/tag'

data/lib/htmlmin/version.rb

@@ -0,0 +1,3 @@
+module Htmlmin
+  VERSION = "0.0.1"
+end

data/lib/htmlmin.rb

@@ -0,0 +1,85 @@
+require "htmlmin/version"
+require "htmlmin/buffer"
+require "htmlmin/slot_machines"
+
+module HTMLMin
+  
+  def self.minify(html, options = {})
+    HTMLMin::Minifier.minify(html, options)
+  end
+  
+  class Minifier
+    extend HTMLMin::Buffer
+    extend HTMLMin::SlotMachines::Common
+    extend HTMLMin::SlotMachines::Comment
+    extend HTMLMin::SlotMachines::Doctype
+    extend HTMLMin::SlotMachines::Tag
+    
+    class << self
+      
+      DEFAULT_OPTIONS = {
+        :remove_comments => true,
+        
+        :minify_whitespaces => true,
+
+        :debug => false
+      }
+      
+      def minify(html, options = {})
+        init_settings options
+        
+        @result = ''
+        init_slot_machine
+        run_slot_machine html
+                
+        @result        
+      end
+      
+      
+      private
+      
+      def init_settings(options)
+        @settings = DEFAULT_OPTIONS.merge options
+      end
+      
+      def init_slot_machine
+        clear_buffer
+        @state = :text_prespaced
+        @prev_state = nil
+      end
+      
+      def run_slot_machine(html)
+        pos = 0
+        input = html.strip
+        while (pos < input.length) do
+          char = input[pos]
+          
+          self.send @state, char
+          debug_log if @settings[:debug]
+        
+          pos += 1
+        end
+        self.send @state, ''
+      end
+      
+      def debug_log
+        p "char: #{char}, state: #{@state.to_s}, buffer: #{@result_buffer.join('')}"
+      end
+      
+      def save_state
+        @prev_state = @state
+      end
+      
+      def restore_state
+        return false if @prev_state.nil?
+
+        @state = @prev_state
+        return true
+      end
+      
+    end
+    
+    
+  end
+  
+end

data/test/input/cc_1.txt

@@ -0,0 +1,8 @@
+<html>
+<!--[if lte IE 7]>
+<p>Internet Explorer 7 or older</p>
+<![endif]-->
+<!--[if gte IE 8]>
+<p>Internet Explorer 8 or later</p>
+<![endif]-->
+</html>

data/test/input/comment_1.txt

@@ -0,0 +1 @@
+<!---->

data/test/input/comment_2.txt

@@ -0,0 +1 @@
+<!--<!--<!---->

data/test/input/comment_3.txt

@@ -0,0 +1 @@
+<!--<!---->-->

data/test/input/comment_4.txt

@@ -0,0 +1 @@
+<!-- just a comment -->

data/test/input/comment_5.txt

@@ -0,0 +1,11 @@
+    
+    
+    
+      
+      
+        <!--asda
+        
+        asd
+        a
+        sdas-- > >-- > --!
+        <p>test</p>

data/test/input/comment_6.txt

@@ -0,0 +1,7 @@
+<!-- tag start -->
+<p>
+<!-- text begin -->
+Fix me
+<!-- <p>Fix me</p> - it's a paragraph -->
+</p>
+<!-- tag end -->

data/test/input/doctype_1.txt

@@ -0,0 +1 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

data/test/input/doctype_2.txt

@@ -0,0 +1,6 @@
+
+ <!-- hello before doctype -->
+
+       <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+       
+       <html>

data/test/input/tag_1.txt

@@ -0,0 +1,7 @@
+
+    <p>
+<em>
+
+      nothing at all</em>
+
+          </p>

data/test/input/tag_2.txt

@@ -0,0 +1,6 @@
+<div>
+  <span>
+    <i>
+    </i>
+  </span>
+</div>

data/test/input/text_1.txt

@@ -0,0 +1,5 @@
+  
+  
+      text      
+      
+      

data/test/input/text_2.txt

@@ -0,0 +1 @@
+hello there. how are you?

data/test/input/text_3.txt

@@ -0,0 +1,4 @@
+<p> please,   stay
+ with   me
+ 
+  </p>

data/test/output/cc_1.txt

@@ -0,0 +1 @@
+<html></html>

data/test/output/comment_6.txt

@@ -0,0 +1 @@
+<p>Fix me</p>

data/test/output/doctype_1.txt

@@ -0,0 +1 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

data/test/output/doctype_2.txt

@@ -0,0 +1,2 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>

data/test/output/tag_1.txt

@@ -0,0 +1 @@
+<p><em>nothing at all</em></p>

data/test/output/tag_2.txt

@@ -0,0 +1 @@
+<div><span><i></i></span></div>

data/test/output/text_1.txt

@@ -0,0 +1 @@
+text

data/test/output/text_2.txt

@@ -0,0 +1 @@
+hello there. how are you?

data/test/output/text_3.txt

@@ -0,0 +1 @@
+<p>please, stay with me</p>

data/test/test_htmlmin.rb

@@ -0,0 +1,51 @@
+require 'test/unit'
+require 'htmlmin'
+
+class HTMLMinTest < Test::Unit::TestCase
+
+  class << self
+
+    INPUT_DIR = "test/input"
+    OUTPUT_DIR = "test/output"
+    EXTENSION = "txt"
+    
+    def create_test_methods_from_data
+      files = input_files
+      files.each do |filename|      
+        basename = File.basename(filename, File.extname(filename))
+        unless output_exists?(basename)
+          p "Output for '#{basename}' test not exists. Please, create '#{OUTPUT_DIR}/#{basename}.#{EXTENSION}' file!"
+          next
+        end
+      
+        method_name = create_method_name basename
+        self.send :define_method, method_name do
+          input = File.read "#{INPUT_DIR}/#{basename}.#{EXTENSION}"
+          output = File.read "#{OUTPUT_DIR}/#{basename}.#{EXTENSION}"
+          minified = HTMLMin.minify(input)
+
+          assert_equal output, minified, "Minified '#{basename}' not equals to output!"
+        end
+      end
+    end
+    
+    
+    private
+    
+    def output_exists?(basename)
+      File.exists? "#{OUTPUT_DIR}/#{basename}.txt"
+    end
+    
+    def input_files
+      Dir.glob("#{INPUT_DIR}/#{ENV['input'] || '*'}.#{EXTENSION}")
+    end
+    
+    def create_method_name(basename)
+      "test_#{basename}"
+    end
+        
+  end
+  
+  create_test_methods_from_data
+
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: htmlmin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexandr Borisov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-21 00:00:00.000000000Z
+dependencies: []
+description: HTMLMin is a HTML-code minification tool implemented in Ruby. It works
+  like a slot machine.
+email:
+- aishek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- htmlmin.gemspec
+- lib/htmlmin.rb
+- lib/htmlmin/buffer.rb
+- lib/htmlmin/slot_machines.rb
+- lib/htmlmin/slot_machines/comment.rb
+- lib/htmlmin/slot_machines/common.rb
+- lib/htmlmin/slot_machines/doctype.rb
+- lib/htmlmin/slot_machines/tag.rb
+- lib/htmlmin/version.rb
+- test/input/cc_1.txt
+- test/input/comment_1.txt
+- test/input/comment_2.txt
+- test/input/comment_3.txt
+- test/input/comment_4.txt
+- test/input/comment_5.txt
+- test/input/comment_6.txt
+- test/input/doctype_1.txt
+- test/input/doctype_2.txt
+- test/input/tag_1.txt
+- test/input/tag_2.txt
+- test/input/text_1.txt
+- test/input/text_2.txt
+- test/input/text_3.txt
+- test/output/cc_1.txt
+- test/output/comment_1.txt
+- test/output/comment_2.txt
+- test/output/comment_3.txt
+- test/output/comment_4.txt
+- test/output/comment_5.txt
+- test/output/comment_6.txt
+- test/output/doctype_1.txt
+- test/output/doctype_2.txt
+- test/output/tag_1.txt
+- test/output/tag_2.txt
+- test/output/text_1.txt
+- test/output/text_2.txt
+- test/output/text_3.txt
+- test/test_htmlmin.rb
+homepage: http://github.com/aishek/htmlmin
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: htmlmin
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: HTMLMin is a HTML-code minification tool
+test_files:
+- test/input/cc_1.txt
+- test/input/comment_1.txt
+- test/input/comment_2.txt
+- test/input/comment_3.txt
+- test/input/comment_4.txt
+- test/input/comment_5.txt
+- test/input/comment_6.txt
+- test/input/doctype_1.txt
+- test/input/doctype_2.txt
+- test/input/tag_1.txt
+- test/input/tag_2.txt
+- test/input/text_1.txt
+- test/input/text_2.txt
+- test/input/text_3.txt
+- test/output/cc_1.txt
+- test/output/comment_1.txt
+- test/output/comment_2.txt
+- test/output/comment_3.txt
+- test/output/comment_4.txt
+- test/output/comment_5.txt
+- test/output/comment_6.txt
+- test/output/doctype_1.txt
+- test/output/doctype_2.txt
+- test/output/tag_1.txt
+- test/output/tag_2.txt
+- test/output/text_1.txt
+- test/output/text_2.txt
+- test/output/text_3.txt
+- test/test_htmlmin.rb