rack-pagespeed 0.1.0

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

@@ -0,0 +1,16 @@
+class Rack::PageSpeed::Filters::InlineCSS < Rack::PageSpeed::Filters::Base
+  priority 10
+  
+  def execute! document
+    nodes = document.css('link[rel="stylesheet"][href$=".css"]:not([href^="http"])')
+    return false unless nodes.count > 0
+    nodes.each do |node|
+      file = file_for node
+      next if 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_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$=".js"]:not([src^="http"])')
+    return false unless nodes.count > 0
+    nodes.each do |node|
+      file = file_for node
+      next if 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  8
+      
+  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['src'] and !(node['src'] =~ /^http/ or !(node['src'] =~ /.js$/))
+  end
+end

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

@@ -0,0 +1,6 @@
+lib = File.join(File.dirname(__FILE__), '..')
+module Rack::PageSpeed::Store; end
+require "#{lib}/store/disk"
+require "#{lib}/store/memcached"
+
+  

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

@@ -0,0 +1,18 @@
+require 'tmpdir'
+
+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,17 @@
+require 'memcached' # wanted to use Dalli, but it just ain't working here right now
+
+class Rack::PageSpeed::Store::Memcached
+  def initialize address_port = nil
+    @client = Memcached.new address_port
+    @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/spec/config_spec.rb

@@ -0,0 +1,187 @@
+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
+    context 'options[:filters]' 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 logically" 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
+    end
+
+    it 'raises a NoSuchFilterError when a non-existing filter is passed to :filters' do
+      expect { Rack::PageSpeed.new page, :filters => [:whoops!] }.to raise_error
+    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 "won't add a filter if it's call returns false" do
+      class NeedsStore < Rack::PageSpeed::Filter
+        requires_store
+      end
+      config = Rack::PageSpeed::Config.new do needs_store end
+      config.filters.should be_empty
+    end
+  end
+
+  context 'setting a storage mechanism' do
+    before { File.stub(:directory?).and_return(true) }
+
+    context 'through the hash options' do
+      context ':disk => "directory path" sets to disk storage, with a specific path' do
+        before  { @config = Rack::PageSpeed::Config.new :store => { :disk => Fixtures.path } }
+        subject { @config.store }
+        specify { should be_a Rack::PageSpeed::Store::Disk }
+        specify { subject.instance_variable_get(:@path).should == Fixtures.path }
+      end
+      context ":disk sets to disk storage, in the system's temp dir" do
+        before  { @config = Rack::PageSpeed::Config.new :store => :disk }
+        subject { @config.store }
+        specify { should be_a Rack::PageSpeed::Store::Disk }
+        specify { subject.instance_variable_get(:@path).should == Dir.tmpdir }
+      end
+      context 'sets to memcache storage if :memcache => "server address/port"' do
+        before  { @config = Rack::PageSpeed::Config.new :store => { :memcached => 'localhost:11211' } }
+        subject { @config.store }
+        specify { should be_a Rack::PageSpeed::Store::Memcached }
+        specify { subject.instance_variable_get(:@client).servers.first.should =~ /localhost:11211/ }
+      end
+      context 'sets to memcache storage, 127.0.0.1:11211 if :memcache"' do
+        before  { @config = Rack::PageSpeed::Config.new :store => :memcached }
+        subject { @config.store }
+        specify { should be_a Rack::PageSpeed::Store::Memcached }
+        specify { subject.instance_variable_get(:@client).servers.first.should =~ /127.0.0.1:11211/ }
+      end
+      context "raises NoSuchStorageMechanism for weird stuff" do
+        specify { expect { Rack::PageSpeed::Config.new :store => :poo }.to raise_error(Rack::PageSpeed::Config::NoSuchStorageMechanism) }
+      end
+    end
+
+    context 'through a block passed to the initializer' do
+      context 'to a simple Hash, if {} gets passed' do
+        before do
+          @config = Rack::PageSpeed::Config.new do
+            store({})
+          end
+        end
+        subject { @config.store }
+        specify { should == {} }
+      end
+      context 'to disk storage, in a specific path if :disk => "some directory path"' do
+        before do
+          @config = Rack::PageSpeed::Config.new do
+            store :disk => Fixtures.path
+          end
+        end
+        subject { @config.store }
+        specify { should be_a Rack::PageSpeed::Store::Disk }
+        specify { subject.instance_variable_get(:@path).should == Fixtures.path }
+      end
+      context ":disk sets to disk storage, in the system's temp dir" do
+        before do
+          @config = Rack::PageSpeed::Config.new do
+            store :disk
+          end
+        end
+        subject { @config.store }
+        specify { should be_a Rack::PageSpeed::Store::Disk }
+        specify { subject.instance_variable_get(:@path).should == Dir.tmpdir }
+      end
+      context 'sets to memcache storage if :memcache => "server address/port"' do
+        before do
+          @config = Rack::PageSpeed::Config.new do
+            store :memcached => 'localhost:11211'
+          end
+        end
+        subject { @config.store }
+        specify { should be_a Rack::PageSpeed::Store::Memcached }
+        specify { subject.instance_variable_get(:@client).servers.first.should =~ /localhost:11211/ }
+      end
+      context 'sets to memcache storage, localhost:11211 if :memcache"' do
+        before do
+          @config = Rack::PageSpeed::Config.new do
+            store :memcached
+          end
+        end
+        subject { @config.store }
+        specify { should be_a Rack::PageSpeed::Store::Memcached }
+        specify { subject.instance_variable_get(:@client).servers.first.should =~ /127.0.0.1:11211/ }
+      end
+      context "raises NoSuchStorageMechanism for weird stuff" do
+        specify do
+          expect { Rack::PageSpeed::Config.new do store :poo end }.to raise_error(Rack::PageSpeed::Config::NoSuchStorageMechanism)
+        end
+      end
+    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
+    Rack::PageSpeed::Filters::CombineCSS.new.should be_false
+  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,48 @@
+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 { Rack::PageSpeed::Filters::CombineJavaScripts.new.should be_false }
+    specify { Rack::PageSpeed::Filters::CombineJavaScripts.new(:store => {}).should_not be_false }
+  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
+
+    it '#unique_id a key thats unique to the nodes combination of content + mtime' 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
+  end
+end

data/spec/filters/filter_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'the base filter class' do
+  before  { @base = Rack::PageSpeed::Filters::Base.new(:foo => 'bar') }
+  
+  it 'when instancing, it takes an options hash as argument' do
+    @base.options[:foo].should == 'bar'
+  end
+  
+  it 'when subclassing, it adds the new class to the #available_filters list' do
+    class Moo < Rack::PageSpeed::Filters::Base; end
+    Rack::PageSpeed::Filters::Base.available_filters.should include(Moo)
+  end
+
+  context 'the #name declaration, which can be used to declare a name which the filter can be called upon' do
+    it 'can be called from inside the class' do
+      class Boo < Rack::PageSpeed::Filters::Base
+        name 'mooers'
+      end
+      Boo.name.should == 'mooers'
+    end
+
+    it 'defaults to the class name if not called' do
+      class BananaSmoothie < Rack::PageSpeed::Filters::Base; end
+      BananaSmoothie.name.should == 'banana_smoothie'
+    end      
+  end
+  
+  context 'the #priority declaration, which defines the order that the filter will be executed' do
+    it 'takes a number' do
+      class NiceFilter < Rack::PageSpeed::Filter
+        priority 1
+      end
+      NiceFilter.priority.should == 1
+    end
+    it 'takes a string' do
+      class NiceFilter < Rack::PageSpeed::Filter
+        priority '1'
+      end
+      NiceFilter.priority.should == 1
+    end    
+  end
+
+  context '#file_for returns a File object' do
+    before { @base.options.stub(:[]).with(:public).and_return(Fixtures.path) }
+
+    it 'for a script' do
+      script = Fixtures.complex.at_css('#mylib')
+      @base.send(:file_for, script).stat.size.should == File.size(File.join(Fixtures.path, 'mylib.js'))
+    end
+
+    it "for a stylesheet" do
+      style = Fixtures.complex.at_css('link')
+      @base.send(:file_for, style).stat.size.should == File.size(File.join(Fixtures.path, 'reset.css'))
+    end
+  end
+end