airgun 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjllNGU0ODM3YjNhMDUyNmU0YmMzNGM0NzFiY2UzMDNkZDA5MWM3NA==
+  data.tar.gz: !binary |-
+    ZWQwYzBmYzNlZTNlNzY5NTIzYjA1YTk0NjMwMmU4NzY1YmNhMjAwMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTEzYWIxYjBmYTBiZWExYjA2ZWI3ZjViYTY3NTlkMzliYzg4ZjdhZDczMGNk
+    NDJlNGIxOTU5YzY4OTAxNjY0YTFlZjEzOTcwMzNhMjc1ZDE1MGE1ZjkxODNk
+    ZmMwNzQ5ZGI2N2NmZmYyOGMyMzliNDdjNjc5YTRlNThmZDRkYWE=
+  data.tar.gz: !binary |-
+    MDUyYjVmYTcxZGQ1ZDU1NmJiYmRlNjM4OGZkYzhiYzA5YTA5NTc0ZGI4N2Fj
+    OTkyODRiOTk3OGYyM2QyNWY3YmVmYWIxZDZhZDAxYTI3NjlhY2QxMmI5ZmQ5
+    YzI0YzIxYTAwMmIxNGMzYjFhMTVmNzkyNTc3NTNkOTlmZTljYTc=

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-18mode
+  - jruby-19mode
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+gemspec
+

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (C) 2013 Peter Bakkum
+
+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.md

@@ -0,0 +1,58 @@
+# Airgun [![Build Status](https://secure.travis-ci.org/bakks/airgun.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/bakks/airgun.png?travis)][gemnasium]
+
+[travis]: http://travis-ci.org/bakks/airgun
+[gemnasium]: https://gemnasium.com/bakks/airgun
+
+This gem provides a simple Ruby interface to compress HTML, JS, and CSS, including embedded JS and CSS. This is useful for compressing static web content for size and obfuscation.
+
+```ruby
+require 'airgun'
+puts Airgun::html 'file.htm'
+
+args = {
+  :outfile => 'compressed.htm',
+  :jscompressor => :closure,
+  :erb => true,
+  :compressjs => true,
+  :compresscss => false
+}
+Airgun::html 'file.htm', args
+```
+
+HTML compresson is provided by the [html_compressor](https://github.com/completelynovel/html_compressor) gem after parsing with [Nokogiri](). CSS compression is provided by the [YUI Compressor](http://developer.yahoo.com/yui/compressor/). JS compression is provided by Google's [Closure Compiler](https://developers.google.com/closure/compiler/).
+
+## Documentation
+
+__Airgun::html__ file, args
+
+By default this method returns the compressed HTML as a string.
+
+Possible arguments:
+
+* :outfile - Write the compressor's output to this file.
+* :exclude - Exclude the CSS and JS linked in the HTML page that match one of the filenames in this list.
+* :jscompressor - Either :closure or :yui, defaults to :closure.
+* :fragment - Either true or false. Don't parse with Nokogiri prior to compression, this disables JS and CSS compression.
+* :erb - Either true or false. Run the files through ERB before compression.
+* :compressjs - Either true or false, defaults to true.
+* :compresscss - Either true or false, defaults to true.
+
+__Airgun::js__ file, args
+
+By default this method returns the compressed JS as a string.
+
+Possible arguments:
+
+* :compressor - Either :closure or :yui, defaults to :closure.
+* :outfile - Write the compressor's output to this file.
+* :erb - Run the file through ERB prior to compression
+
+__Airgun::css__ file, args
+
+By default this method returns the compressed CSS as a string.
+
+Possible arguments:
+
+* :outfile - Write the compressor's output to this file.
+* :erb - Run the file through ERB prior to compression
+

data/airgun.gemspec

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require File.expand_path("../lib/airgun", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_runtime_dependency 'nokogiri'
+  gem.add_runtime_dependency 'yui-compressor'
+  gem.add_runtime_dependency 'closure-compiler'
+  gem.add_runtime_dependency 'html_compressor'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'autotest-standalone'
+
+  gem.authors = ["Peter Bakkum"]
+  gem.bindir = 'bin'
+  gem.description = %q{A simple interface to compress HTML, JS, and CSS, includig embedded JS and CSS, using several technologies, including the YUI Compressor and the Google Closure Compiler.}
+  gem.email = ['pbb7c@virginia.edu']
+  gem.executables = ['airgun']
+  gem.extra_rdoc_files = ['LICENSE.md', 'README.md']
+  gem.files = Dir['LICENSE.md', 'README.md', 'airgun.gemspec', 'Gemfile', '.rspec', '.travis.yml', 'spec/**/*', 'lib/**/*', 'bin/*']
+  gem.homepage = 'http://github.com/bakks/airgun'
+  gem.name = 'airgun'
+  gem.rdoc_options = ["--charset=UTF-8"]
+  gem.require_paths = ['lib']
+  gem.required_rubygems_version = Gem::Requirement.new(">= 1.3.6")
+  gem.summary = %q{An interface to compress HTML and embedded JS and CSS}
+  gem.test_files = Dir['spec/**/*']
+  gem.version = Airgun::VERSION
+  gem.license = 'MIT'
+end
+

data/bin/airgun

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'trollop'
+require 'airgun'
+require 'pp'
+
+p = Trollop::Parser.new do
+  version "airgun #{Airgun::VERSION}"
+  banner <<-EOS
+Airgun is a compressor for HTML and embedded/linked CSS and Javascript
+
+Usage:
+       airgun [options] <filename>...
+
+Example:
+       airgun -o compressed.htm file.htm
+ 
+EOS
+
+  opt :outfile, "Write the compressor's output to this file", :default => 'airgun.out', :short => 'o'
+  opt :path, 'Path for dependencies', :type => String, :short => 'p'
+  opt :jscompressor, "Either closure or yui", :default => 'closure'
+  opt :fragment, "Don't parse with Nokogiri prior to compression, this disables JS and CSS compression", :default => false
+  opt :erb, "Run the files through ERB before compression", :default => false
+  opt :compressjs, "Run JS compression", :default => true
+  opt :compresscss, "Run CSS compression", :default => true
+end
+
+opts = Trollop::with_standard_exception_handling p do
+  raise Trollop::HelpNeeded if ARGV.empty?
+  p.parse ARGV
+end
+
+file = ARGV[0]
+opts[:jscompressor] = opts[:jscompressor].to_sym
+
+Airgun::html file, opts
+

data/lib/airgun.rb

@@ -0,0 +1,189 @@
+require 'nokogiri'
+require 'yui/compressor'
+require 'closure-compiler'
+require 'html_compressor'
+require 'erb'
+
+module Airgun
+  VERSION = "0.1.0"
+
+  def self.load file
+    File.open(file, 'r') { |f| f.read }
+  end
+
+  def self.path source, target, arg = {}
+    unless arg[:target]
+      arg[:target] = target[0] == '/' ? target : File.join(Dir.pwd, target)
+    end
+    unless arg[:htmlmatcher]
+      arg[:htmlmatcher] = /.*\.(htm|html)/
+    end
+    arg[:path] = Dir.pwd unless arg[:path]
+    arg[:exclude] = [] unless arg[:exclude]
+
+    Dir[File.join(source, '*')].each do |f|
+      if f =~ arg[:htmlmatcher]
+        arg = {
+          :exclude => arg[:exclude],
+          :path => arg[:path],
+          :outfile => File.join(arg[:target], f)
+        }
+
+        Airgun::html f, arg
+      end
+    end
+    
+  end
+
+  def self.html htmlfile, arg = {}
+    arg[:outfile] = nil unless arg[:outfile]
+    arg[:exclude] = [] unless arg[:exclude]
+    arg[:jscompressor] = :closure unless arg[:jscompressor]
+    arg[:fragment] = false unless arg[:fragment]
+    arg[:erb] = false unless arg[:erb]
+    arg[:compressjs] = true unless arg[:compressjs]
+    arg[:compresscss] = true unless arg[:compresscss]
+    arg[:path] = File.join(Dir.pwd, File.dirname(htmlfile)) unless arg[:path]
+
+    html = File.open(htmlfile, 'r') { |f| f.read }
+
+    html = ERB.new(html).result(binding) if arg[:erb]
+
+    doc = html
+
+    unless arg[:fragment]
+      doc = Nokogiri::HTML(html)
+      a = {
+        :exclude => arg[:exclude],
+        :path => arg[:path]
+      }
+
+      Airgun::css doc, a if arg[:compresscss]
+
+      a[:compressor] = arg[:jscompressor]
+      Airgun::js doc, a if arg[:compresscss]
+    end
+
+    s = doc.to_s
+    s = HtmlCompressor::HtmlCompressor.new.compress(s)
+
+    if arg[:outfile]
+      File.open(arg[:outfile], 'w') { |f| f.write(s) }
+    end
+
+    s
+  end
+
+  def self.include? arr, str
+    arr.any? do |x|
+      if x.is_a? String
+        r = (str == x)
+      elsif x.is_a? Regexp
+        r = (str =~ x)
+      else raise "cant check #{x}"
+      end
+      r
+    end
+  end
+
+  def self.css doc, arg = {}
+    arg[:exclude] = [] unless arg[:exclude]
+    arg[:path] = '' unless arg[:path]
+    arg[:erb] = false unless arg[:erb]
+
+    if doc.kind_of? Nokogiri::XML::Node
+      c = YUI::CssCompressor.new
+      files = []
+
+      doc.xpath("//link[@rel='stylesheet']").each do |node|
+        next unless node['href']
+        if include? arg[:exclude], node['href']
+          puts "excluding #{node['href']}"
+          node.remove
+          next
+        end
+        files << node['href']
+
+        puts "expanding #{node['href']}"
+        css = c.compress(File.open(File.join(arg[:path], node['href'])))
+        n = Nokogiri::XML::Node.new('style', doc)
+        n.content = css
+        node.add_next_sibling n
+        node.remove
+      end
+
+      doc.xpath("//style").each do |node|
+        node.content = c.compress(node.content)
+      end
+    else
+      c = YUI::CssCompressor.new
+      s = File.open(doc, 'r') { |f| f.read }
+      s = ERB.new(s).result(binding) if arg[:erb]
+      s = c.compress(s)
+
+      if arg[:outfile]
+        File.open(arg[:outfile], 'w') { |f| f.write(s) }
+      end
+
+      return s
+    end
+  end
+
+  def self.js doc, arg = {}
+    arg[:compressor] = :closure unless arg[:compressor]
+    arg[:exclude] = [] unless arg[:exclude]
+    arg[:path] = '' unless arg[:path]
+    arg[:erb] = false unless arg[:erb]
+
+    if doc.kind_of? Nokogiri::XML::Node
+      c = nil
+
+      if arg[:compressor] == :closure
+        c = Closure::Compiler.new :language_in => 'ECMASCRIPT5'
+      elsif arg[:compressor] == :yui
+        c = YUI::JavaScriptCompressor.new
+      else
+        raise ':compressor should be set to either :closure (default) or :yui'
+      end
+
+      doc.xpath('//script').each do |node|
+        if include? arg[:exclude], node['src']
+          puts "excluding #{node['src']}"
+          node.remove
+          next
+        end
+
+        if node['src']
+          puts "expanding #{node['src']}"
+          js = c.compress(File.open(File.join(arg[:path], node['src'])))
+          node.remove_attribute 'src'
+          node.content = js
+        else
+          node.content = c.compress(node.text)
+        end
+      end
+    else
+      c = nil
+
+      if arg[:compressor] == :closure
+        c = Closure::Compiler.new :language_in => 'ECMASCRIPT5'
+      elsif arg[:compressor] == :yui
+        c = YUI::JavaScriptCompressor.new
+      else
+        raise 'compressor setting is bad'
+      end
+
+      s = File.open(doc, 'r') { |f| f.read }
+      s = ERB.new(s).result(binding) if arg[:erb]
+      s = c.compress(s)
+
+      if arg[:outfile]
+        File.open(arg[:outfile], 'w') { |f| f.write(s) }
+      end
+
+      return s
+    end
+  end
+
+end
+

data/spec/helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rubygems'
+require 'rspec'
+require 'mocha'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.fail_fast = true
+end
+
+

data/spec/lib/airgun_spec.rb

@@ -0,0 +1,81 @@
+require 'helper'
+require 'airgun'
+
+describe Airgun do
+
+  it 'should handle basic html compression' do
+    r = Airgun::html 'spec/resources/test1.htm'
+    r.should_not == nil
+    r.include?('16').should == false
+  end
+
+  it 'should run erb' do
+    a = {
+      :erb => true
+    }
+    r = Airgun::html 'spec/resources/test1.htm', a
+    r.include?('64').should == true
+  end
+
+  it 'should handle embedded and linked css compression' do
+    a = {
+      :erb => true
+    }
+    r = Airgun::html 'spec/resources/test2.htm', a
+    r.include?('64').should == true
+    r.include?('#one').should == true
+    r.include?('#four').should == true
+  end
+
+  it 'should handle embedded js and linked js with Closure' do
+    a = {
+      :erb => true,
+      :compressor => :closure
+    }
+    r = Airgun::html 'spec/resources/test3.htm', a
+    r.include?('64').should == true
+    r.include?('alert("one")').should == true
+    r.include?('alert("two")').should == true
+  end
+
+  it 'should handle embedded and linked js with YUI' do
+    a = {
+      :erb => false,
+      :compressor => :yui
+    }
+    r = Airgun::html 'spec/resources/test3.htm', a
+    r.include?('64').should == false
+    r.include?('alert("one")').should == true
+    r.include?('alert("two")').should == true
+  end
+
+  it 'should handle direct css with file write' do
+    fname = '/tmp/compressed.css'
+    File.delete fname if File.exist? fname
+
+    a = {
+      :outfile => fname
+    }
+
+    Airgun::css 'spec/resources/css/test2.css', a
+
+    content = File.open(fname) { |f| f.read }
+    content.include?('#four').should == true
+  end
+
+  it 'should handle direct js with file write' do
+    fname = '/tmp/compressed.js'
+    File.delete fname if File.exist? fname
+
+    a = {
+      :outfile => fname
+    }
+
+    Airgun::js 'spec/resources/js/test3.js', a
+
+    content = File.open(fname) { |f| f.read }
+    content.include?('alert("two")').should == true
+  end
+
+end
+

data/spec/resources/css/test2.css

@@ -0,0 +1,9 @@
+#four {
+  color: #000;
+}
+.five {
+  background-color: #ccc;
+}
+a .six {
+  font-family: 'Arial', sans-serif;
+}

data/spec/resources/js/test3.js

@@ -0,0 +1,2 @@
+if(10 * 10 == 100)
+  alert('two')

data/spec/resources/test1.htm

@@ -0,0 +1,13 @@
+<!doctype HTML>
+<html>
+<head>
+  <title>Test Page</title>
+</head>
+<body>
+  hello world
+  <br/>
+  this is a test for a very simple html page with no js or css
+  <br/>
+  <%= (8 * 8).to_s %>
+</body>
+</html>

data/spec/resources/test2.htm

@@ -0,0 +1,25 @@
+<!doctype HTML>
+<html>
+<head>
+  <title>Test Page</title>
+  <style>
+    #one {
+      color: #000;
+    }
+    .two {
+      background-color: #ccc;
+    }
+    a .three {
+      font-family: 'Arial', sans-serif;
+    }
+  </style>
+  <link rel="stylesheet" href="/css/test2.css"/>
+</head>
+<body>
+  hello world
+  <br/>
+  this is a test for a very simple html page with css
+  <br/>
+  <%= (8 * 8).to_s %>
+</body>
+</html>

data/spec/resources/test3.htm

@@ -0,0 +1,18 @@
+<!doctype HTML>
+<html>
+<head>
+  <title>Test Page</title>
+  <script type="text/javascript">
+    if(true)
+      alert('one');
+  </script>
+  <script type="text/javascript" src="js/test3.js"></script>
+</head>
+<body>
+  hello world
+  <br/>
+  this is a test for a very simple html page with js
+  <br/>
+  <%= (8 * 8).to_s %>
+</body>
+</html>

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: airgun
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Bakkum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yui-compressor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: closure-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: html_compressor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: autotest-standalone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple interface to compress HTML, JS, and CSS, includig embedded JS
+  and CSS, using several technologies, including the YUI Compressor and the Google
+  Closure Compiler.
+email:
+- pbb7c@virginia.edu
+executables:
+- airgun
+extensions: []
+extra_rdoc_files:
+- LICENSE.md
+- README.md
+files:
+- LICENSE.md
+- README.md
+- airgun.gemspec
+- Gemfile
+- .rspec
+- .travis.yml
+- spec/helper.rb
+- spec/lib/airgun_spec.rb
+- spec/resources/css/test2.css
+- spec/resources/js/test3.js
+- spec/resources/test1.htm
+- spec/resources/test2.htm
+- spec/resources/test3.htm
+- lib/airgun.rb
+- bin/airgun
+homepage: http://github.com/bakks/airgun
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: An interface to compress HTML and embedded JS and CSS
+test_files:
+- spec/helper.rb
+- spec/lib/airgun_spec.rb
+- spec/resources/css/test2.css
+- spec/resources/js/test3.js
+- spec/resources/test1.htm
+- spec/resources/test2.htm
+- spec/resources/test3.htm
+has_rdoc: