rack-pagespeed-fork 0.1.0

data/lib/rack/pagespeed/filters/inline_css.rb

@@ -0,0 +1,16 @@
+class Rack::PageSpeed::Filters::InlineCSS < Rack::PageSpeed::Filter
+  priority 10
+  
+  def execute! document
+    nodes = document.css('link[rel="stylesheet"][href]')
+    return false unless nodes.count > 0
+    nodes.each do |node|
+      file = file_for node
+      next if !file or file.stat.size > (@options[:max_size] or 2048)
+      inline = Nokogiri::XML::Node.new 'style', document
+      inline.content = file.read
+      node.before inline
+      node.remove
+    end
+  end
+end

data/lib/rack/pagespeed/filters/inline_images.rb

@@ -0,0 +1,17 @@
+class Rack::PageSpeed::Filters::InlineImages < Rack::PageSpeed::Filter
+  priority 8
+  
+  def execute! document
+    nodes = document.css('img')
+    return false unless nodes.count > 0
+    nodes.each do |node|
+      file = file_for node
+      next if !file or file.stat.size > (@options[:max_size] or 1024)
+      img = node.clone
+      img['src'] = "data:#{Rack::Mime.mime_type(File.extname(file.path))};base64,#{[file.read].pack('m')}"
+      img['alt'] = node['alt'] if node['alt']
+      node.before img
+      node.remove
+    end
+  end
+end

data/lib/rack/pagespeed/filters/inline_javascripts.rb

@@ -0,0 +1,17 @@
+class Rack::PageSpeed::Filters::InlineJavaScripts < Rack::PageSpeed::Filter
+  name      'inline_javascripts'
+  priority  10
+      
+  def execute! document
+    nodes = document.css('script[src]')
+    return false unless nodes.count > 0
+    nodes.each do |node|
+      file = file_for node
+      next if !file or file.stat.size > (@options[:max_size] or 2048)
+      inline = Nokogiri::XML::Node.new 'script', document
+      inline.content = file.read
+      node.before inline
+      node.remove
+    end
+  end
+end

data/lib/rack/pagespeed/filters/minify_javascripts.rb

@@ -0,0 +1,41 @@
+require 'jsmin'
+begin
+  require 'md5'
+rescue LoadError
+  require 'digest/md5'
+end
+
+class Rack::PageSpeed::Filters::MinifyJavaScripts < Rack::PageSpeed::Filters::Base
+  requires_store
+  name      'minify_javascripts'
+  priority  2
+      
+  def execute! document
+    nodes = document.css('script')
+    return false unless nodes.count > 0
+    nodes.each do |node|
+      if !node['src']
+        node.content = JSMin.minify node.content
+      else
+        if match = %r(^/rack-pagespeed-(.*)).match(node['src'])
+          store = @options[:store]
+          store[match[1]] = JSMin.minify store[match[1]]
+        else
+          next unless local_script? node
+          file = file_for node
+          javascript = file.read
+          hash = Digest::MD5.hexdigest file.mtime.to_i.to_s + javascript
+          compressed = Nokogiri::XML::Node.new 'script', document
+          compressed['src'] = "/rack-pagespeed-#{hash}.js"
+          @options[:store]["#{hash}.js"] = JSMin.minify javascript
+          node.before compressed
+          node.remove
+        end        
+      end
+    end
+  end
+  
+  def local_script? node
+    node.name == 'script' and file_for(node)
+  end
+end

data/lib/rack/pagespeed/store/disk.rb

@@ -0,0 +1,20 @@
+require 'tmpdir'
+
+module Rack::PageSpeed::Store; end
+
+class Rack::PageSpeed::Store::Disk
+  def initialize path = Dir.tmpdir
+    raise ArgumentError, "#{path} is not a directory" unless File.directory? path
+    @path = path
+  end
+
+  def [] key
+    path = "#{@path}/rack-pagespeed-#{key}"
+    File.read path if File.exists? path
+  end
+
+  def []= key, value
+    File.open("#{@path}/rack-pagespeed-#{key}", 'w') { |file| file << value }
+    true
+  end
+end

data/lib/rack/pagespeed/store/memcached.rb

@@ -0,0 +1,21 @@
+begin
+  require 'dalli'
+rescue LoadError
+  raise LoadError, ":memcached store requires the dalli gem to be installed."
+end
+
+class Rack::PageSpeed::Store::Memcached
+  def initialize *args
+    @client = Dalli::Client.new *args
+    # @client.stats # let it raise errors if it can't connect
+  end
+  
+  def [] key
+    @client.get key
+  end
+  
+  def []= key, value
+    @client.set key, value
+    true
+  end
+end

data/lib/rack/pagespeed/store/redis.rb

@@ -0,0 +1,19 @@
+begin
+  require 'redis'
+rescue LoadError
+  raise LoadError, ":redis store requires the redis gem to be installed."
+end
+
+class Rack::PageSpeed::Store::Redis
+  def initialize *args
+    @client = Redis.new *args
+  end
+  
+  def [] key
+    @client.get key
+  end
+  
+  def []= key, value
+    @client.set key, value
+  end
+end

data/rack-pagespeed-fork.gemspec

@@ -0,0 +1,103 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: rack-pagespeed-fork 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "rack-pagespeed-fork"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Will Jordan", "Julio Cesar Ody"]
+  s.date = "2014-10-08"
+  s.description = "Web page speed optimizations at the Rack level - fork"
+  s.email = "will@code.org"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/rack-pagespeed.rb",
+    "lib/rack/pagespeed.rb",
+    "lib/rack/pagespeed/config.rb",
+    "lib/rack/pagespeed/filters/all.rb",
+    "lib/rack/pagespeed/filters/base.rb",
+    "lib/rack/pagespeed/filters/combine_css.rb",
+    "lib/rack/pagespeed/filters/combine_javascripts.rb",
+    "lib/rack/pagespeed/filters/inline_css.rb",
+    "lib/rack/pagespeed/filters/inline_images.rb",
+    "lib/rack/pagespeed/filters/inline_javascripts.rb",
+    "lib/rack/pagespeed/filters/minify_javascripts.rb",
+    "lib/rack/pagespeed/store/disk.rb",
+    "lib/rack/pagespeed/store/memcached.rb",
+    "lib/rack/pagespeed/store/redis.rb",
+    "rack-pagespeed-fork.gemspec",
+    "spec/config_spec.rb",
+    "spec/filters/combine_css_spec.rb",
+    "spec/filters/combine_javascripts_spec.rb",
+    "spec/filters/filter_spec.rb",
+    "spec/filters/inline_css_spec.rb",
+    "spec/filters/inline_images_spec.rb",
+    "spec/filters/inline_javascript_spec.rb",
+    "spec/filters/minify_javascript_spec.rb",
+    "spec/fixtures/all-small-dog-breeds.jpg",
+    "spec/fixtures/complex.html",
+    "spec/fixtures/foo.js",
+    "spec/fixtures/hh-reset.css",
+    "spec/fixtures/huge.css",
+    "spec/fixtures/iphone.css",
+    "spec/fixtures/jquery-1.4.1.min.js",
+    "spec/fixtures/medialess1.css",
+    "spec/fixtures/medialess2.css",
+    "spec/fixtures/mock_store.rb",
+    "spec/fixtures/mylib.js",
+    "spec/fixtures/noexternalcss.html",
+    "spec/fixtures/noscripts.html",
+    "spec/fixtures/ohno.js",
+    "spec/fixtures/reset.css",
+    "spec/fixtures/screen.css",
+    "spec/fixtures/styles.html",
+    "spec/pagespeed_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/store/disk_spec.rb",
+    "spec/store/memcached_spec.rb",
+    "spec/store/redis_spec.rb"
+  ]
+  s.homepage = "http://github.com/wjordan/rack-pagespeed"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.2"
+  s.summary = "Web page speed optimizations at the Rack level - fork"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<jsmin>, [">= 0"])
+      s.add_runtime_dependency(%q<mime-types>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<rspec>, ["= 2.6.0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<jsmin>, [">= 0"])
+      s.add_dependency(%q<mime-types>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<rspec>, ["= 2.6.0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<jsmin>, [">= 0"])
+    s.add_dependency(%q<mime-types>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<rspec>, ["= 2.6.0"])
+  end
+end
+

data/spec/config_spec.rb

@@ -0,0 +1,110 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'rack-pagespeed configuration' do
+  before do
+    class StripsNaked < Rack::PageSpeed::Filter; end
+    class MakesItLookGood < Rack::PageSpeed::Filter; end
+  end
+
+  context 'when instancing a new object' do
+    it 'creates methods for each filter class found in Rack::PageSpeed::Filters::Base.available_filters' do
+      Rack::PageSpeed::Config.new(:public => Dir.tmpdir).should respond_to :strips_naked
+    end
+
+    it "requires a :public parameter pointing to the app's public directory" do
+      expect { Rack::PageSpeed::Config.new("foo" => "bar") }.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'sorts filter execution based on their specified order' do
+    before do
+      class Larry < Rack::PageSpeed::Filter; priority 3; end
+      class Moe < Rack::PageSpeed::Filter; priority 2; end
+      class Curly < Rack::PageSpeed::Filter; priority 1; end
+      @config = Rack::PageSpeed::Config.new :public => Fixtures.path do
+        curly
+        larry
+        moe
+      end
+    end
+    
+    it "Larry is first" do
+      @config.filters.first.should be_a Larry
+    end
+        
+    it "Moe is second" do
+      @config.filters[1].should be_a Moe
+    end
+    
+    it "Curly is last" do
+      @config.filters.last.should be_a Curly
+    end
+  end
+
+  context 'enabling filters, options hash based' do
+    before { File.stub(:directory?).and_return(true) }
+
+    it "if it's an array, it enables filters listed in it with their default options" do
+      config = Rack::PageSpeed::Config.new :filters => [:makes_it_look_good]
+      config.filters.first.should be_a MakesItLookGood
+    end
+
+    it "if it's a hash, it let's you pass options to the filters" do
+      config = Rack::PageSpeed::Config.new :filters => {:makes_it_look_good => {:test => 6000}}
+      filter = config.filters.first
+      filter.should be_a MakesItLookGood
+      filter.options[:test].should == 6000 # yeah, 2 assertions, bad, bad
+    end
+
+    it 'raises a NoSuchFilter error when a non-existing filter is passed to :filters' do
+      expect { Rack::PageSpeed::Config.new :filters => [:whoops!] }.to raise_error(Rack::PageSpeed::Config::NoSuchFilter)
+    end
+  end
+
+  context 'enabling filters, block/DSL based' do
+    before { File.stub(:directory?).and_return(true) }
+
+    it "let's you invoke filter names in a DSL-like fashion through a block" do
+      config = Rack::PageSpeed::Config.new do
+        makes_it_look_good
+        strips_naked
+      end
+      config.filters.should include_an_instance_of MakesItLookGood
+      config.filters.should include_an_instance_of StripsNaked
+    end
+
+    # two specs below actually work with the optiosn hash based context too
+    it "won't add the same filter twice" do
+      config = Rack::PageSpeed::Config.new do
+        makes_it_look_good
+        makes_it_look_good
+        strips_naked
+      end
+      config.filters.count.should == 2
+    end
+
+    it "calling a filter that requires storage without specifying one raises an error" do
+      class NeedsStore < Rack::PageSpeed::Filter
+        requires_store
+      end
+      expect { Rack::PageSpeed::Config.new do needs_store end }.to raise_error
+    end
+    
+    it 'raises a NoSuchFilter error when a non-existing filter is called ' do
+      expect { Rack::PageSpeed::Config.new do whateva :foo => 'bar' end }.to raise_error(Rack::PageSpeed::Config::NoSuchFilter)
+    end
+  end
+
+  context 'setting a storage mechanism' do
+    before { File.stub(:directory?).and_return(true) }
+    
+    it 'loads the appropriate class on request' do
+      ::File.stub(:join).and_return(File.dirname(__FILE__) + '/fixtures/mock_store.rb')
+      expect {
+        Rack::PageSpeed::Config.new do
+          store :mock
+        end
+      }.to change { Rack::PageSpeed::Store.const_defined?('Mock') }.from(false).to(true)
+    end
+  end
+end

data/spec/filters/combine_css_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'the combine_css filter' do
+  it "is called \"combine_css\" as far as Config is concerned" do
+    Rack::PageSpeed::Filters::CombineCSS.name.should == 'combine_css'
+  end
+
+  it "requires a store mechanism to be passed via :store when initializing" do
+    expect { Rack::PageSpeed::Filters::CombineCSS.new }.to raise_error
+  end
+  
+  it "is a priority 9 filter" do
+    Rack::PageSpeed::Filters::CombineCSS.priority.should == 9
+  end
+
+  context 'execute!' do
+    before :each do
+      @filter = Rack::PageSpeed::Filters::CombineCSS.new :public => Fixtures.path, :store => {}
+    end
+
+    it 'cuts down the number of scripts in the fixtures from 5 to 1' do
+      expect { @filter.execute! Fixtures.complex }.to change { Fixtures.complex.css('link[rel="stylesheet"][href$=".css"]:not([href^="http"])').count }.from(5).to(1)
+    end
+    
+    it "stores the nodes' contents in the store passed through the initializer" do
+      @filter.instance_variable_get(:@options)[:store].should_receive(:[]=)
+      @filter.execute! Fixtures.complex
+    end
+  end
+end

data/spec/filters/combine_javascripts_spec.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'the combine_javascripts filter' do
+  it "is called \"combine_javascripts\" as far as Config is concerned" do
+    Rack::PageSpeed::Filters::CombineJavaScripts.name.should == 'combine_javascripts'
+  end
+
+  it "is a priority 9 filter" do
+    Rack::PageSpeed::Filters::CombineJavaScripts.priority 9
+  end
+
+  context "requires a store mechanism to be passed via :store when initializing" do
+    specify { expect { Rack::PageSpeed::Filters::CombineJavaScripts.new }.to raise_error }
+    specify { expect { Rack::PageSpeed::Filters::CombineJavaScripts.new(:store => {}) }.to_not raise_error }
+  end
+
+  context 'execute!' do
+    before :each do
+      @filter = Rack::PageSpeed::Filters::CombineJavaScripts.new :public => Fixtures.path, :store => {}
+    end
+
+    it 'cuts down the number of scripts in the fixtures from 4 to 2' do
+      expect { @filter.execute! Fixtures.complex }.to change { Fixtures.complex.css('script[src$=".js"]:not([src^="http"])').count }.from(4).to(2)
+    end
+
+    it "stores the nodes' contents in the store passed through the initializer" do
+      @filter.instance_variable_get(:@options)[:store].should_receive(:[]=).twice
+      @filter.execute! Fixtures.complex
+    end
+  end
+
+  context 'yes, I test private methods, so what?' do
+    before do
+      @filter = Rack::PageSpeed::Filters::CombineJavaScripts.new :public => Fixtures.path, :store => {}
+    end
+
+    it 'returns an array of arrays containing JS nodes that are next to each other in #group_siblings' do
+      nodes = Fixtures.complex.css('script[src$=".js"]:not([src^="http"]) + script[src$=".js"]:not([src^="http"])')
+      result = @filter.send :group_siblings, nodes
+      result.should == [[nodes[0].previous_element, nodes[0]], [nodes[1].previous_element, nodes[1]]]
+    end
+    
+    context 'the #unique_id method' do
+      it "generates a hash thats unique to the nodes' combination of content + mtime in the absence of @options[:hash]" do
+        nodes = Fixtures.complex.css('script[src$=".js"]:not([src^="http"]) + script[src$=".js"]:not([src^="http"])')
+        @filter.send(:unique_id, nodes).should == Digest::MD5.hexdigest(nodes.map { |node| file = @filter.send(:file_for, node); file.mtime.to_i.to_s + file.read }.join)
+      end
+      
+      it "uses values for hashes estipulated in @options[:hash] if any" do
+        nodes = []
+        nodes << Fixtures.complex.at_css('script[src="ohno.js"]')
+        nodes << Fixtures.complex.at_css('script[src="foo.js"]')
+        filter = Rack::PageSpeed::Filters::CombineJavaScripts.new :store => {}, :hash => { %W(ohno.js foo.js) => "romanking" }
+        filter.send(:unique_id, nodes).should == "romanking"
+      end
+    end
+  end
+end