rack-cache 0.2.0

data/test/core_test.rb

@@ -0,0 +1,84 @@
+require "#{File.dirname(__FILE__)}/spec_setup"
+require 'rack/cache/core'
+
+class MockCore
+  include Rack::Cache::Core
+  alias_method :initialize, :initialize_core
+  public :transition, :trigger, :events
+end
+
+describe 'Rack::Cache::Core' do
+  before :each do
+    @core = MockCore.new
+  end
+
+  it 'has events after instantiation' do
+    @core.events.should.respond_to :[]
+  end
+  it 'defines and triggers event handlers' do
+    executed = false
+    @core.on(:foo) { executed = true }
+    @core.trigger :foo
+    executed.should.be true
+  end
+  it 'executes multiple handlers in LIFO order' do
+    x = 'nothing executed'
+    @core.on :foo do
+      x.should.be == 'bottom executed'
+      x = 'top executed'
+    end
+    @core.on :foo do
+      x.should.be == 'nothing executed'
+      x = 'bottom executed'
+    end
+    @core.trigger :foo
+    x.should.be == 'top executed'
+  end
+  it 'records event execution history' do
+    @core.on(:foo) {}
+    @core.trigger :foo
+    @core.should.a.performed :foo
+  end
+  it 'raises an exception when asked to perform an unknown event' do
+    assert_raises NameError do
+      @core.trigger :foo
+    end
+  end
+  it 'raises an exception when asked to transition to an unknown event' do
+    @core.on(:bling) {}
+    @core.on(:foo) { throw(:transition, [:bling]) }
+    lambda { @core.transition(from=:foo, to=[:bar, :baz]) }.
+      should.raise Rack::Cache::IllegalTransition
+  end
+  it 'passes transition arguments to handlers' do
+    passed = nil
+    @core.meta_def(:perform_bar) do |*args|
+      passed = args
+      'hi'
+    end
+    @core.on(:bar) {}
+    @core.on(:foo) { throw(:transition, [:bar, 1, 2, 3]) }
+    result = @core.transition(from=:foo, to=[:bar])
+    passed.should.be == [1,2,3]
+    result.should.be == 'hi'
+  end
+  it 'fully transitions out of handlers when the next event is invoked' do
+    x = []
+    @core.on(:foo) {
+      x << 'in foo, before transitioning to bar'
+      throw(:transition, [:bar])
+      x << 'in foo, after transitioning to bar'
+    }
+    @core.on(:bar) { x << 'in bar' }
+    @core.trigger(:foo).should.be == [:bar]
+    @core.trigger(:bar).should.be.nil
+    x.should.be == [
+      'in foo, before transitioning to bar',
+      'in bar'
+    ]
+  end
+  it 'returns the transition event name' do
+    @core.on(:foo) { throw(:transition, [:bar]) }
+    @core.trigger(:foo).should.be == [:bar]
+  end
+end

data/test/entitystore_test.rb

@@ -0,0 +1,176 @@
+require "#{File.dirname(__FILE__)}/spec_setup"
+require 'rack/cache/entitystore'
+
+class Object
+  def sha_like?
+    length == 40 && self =~ /^[0-9a-z]+$/
+  end
+end
+
+describe_shared 'A Rack::Cache::EntityStore Implementation' do
+
+  it 'responds to all required messages' do
+    %w[read open write exist?].each do |message|
+      @store.should.respond_to message
+    end
+  end
+
+  it 'stores bodies with #write' do
+    key, size = @store.write('My wild love went riding,')
+    key.should.not.be.nil
+    key.should.be.sha_like
+
+    data = @store.read(key)
+    data.should.be == 'My wild love went riding,'
+  end
+
+  it 'correctly determines whether cached body exists for key with #exist?' do
+    key, size = @store.write('She rode to the devil,')
+    @store.should.exist key
+    @store.should.not.exist '938jasddj83jasdh4438021ksdfjsdfjsdsf'
+  end
+
+  it 'can read data written with #write' do
+    key, size = @store.write('And asked him to pay.')
+    data = @store.read(key)
+    data.should.be == 'And asked him to pay.'
+  end
+
+  it 'gives a 40 character SHA1 hex digest from #write' do
+    key, size = @store.write('she rode to the sea;')
+    key.should.not.be.nil
+    key.length.should.be == 40
+    key.should.be =~ /^[0-9a-z]+$/
+    key.should.be == '90a4c84d51a277f3dafc34693ca264531b9f51b6'
+  end
+
+  it 'returns the entire body as a String from #read' do
+    key, size = @store.write('She gathered together')
+    @store.read(key).should.be == 'She gathered together'
+  end
+
+  it 'returns nil from #read when key does not exist' do
+    @store.read('87fe0a1ae82a518592f6b12b0183e950b4541c62').should.be.nil
+  end
+
+  it 'returns a Rack compatible body from #open' do
+    key, size = @store.write('Some shells for her hair.')
+    body = @store.open(key)
+    body.should.respond_to :each
+    buf = ''
+    body.each { |part| buf << part }
+    buf.should.be == 'Some shells for her hair.'
+  end
+
+  it 'returns nil from #open when key does not exist' do
+    @store.open('87fe0a1ae82a518592f6b12b0183e950b4541c62').should.be.nil
+  end
+
+  it 'can store largish bodies with binary data' do
+    pony = File.read(File.dirname(__FILE__) + '/pony.jpg')
+    key, size = @store.write(pony)
+    key.should.be == 'd0f30d8659b4d268c5c64385d9790024c2d78deb'
+    data = @store.read(key)
+    data.length.should.be == pony.length
+    data.hash.should.be == pony.hash
+  end
+
+end
+
+describe 'Rack::Cache::EntityStore' do
+
+  describe 'Heap' do
+    it_should_behave_like 'A Rack::Cache::EntityStore Implementation'
+    before { @store = Rack::Cache::EntityStore::Heap.new }
+    it 'takes a Hash to ::new' do
+      @store = Rack::Cache::EntityStore::Heap.new('foo' => ['bar'])
+      @store.read('foo').should.be == 'bar'
+    end
+    it 'uses its own Hash with no args to ::new' do
+      @store.read('foo').should.be.nil
+    end
+  end
+
+  describe 'Disk' do
+    it_should_behave_like 'A Rack::Cache::EntityStore Implementation'
+    before do
+      @temp_dir = create_temp_directory
+      @store = Rack::Cache::EntityStore::Disk.new(@temp_dir)
+    end
+    after do
+      @store = nil
+      remove_entry_secure @temp_dir
+    end
+    it 'takes a path to ::new and creates the directory' do
+      path = @temp_dir + '/foo'
+      @store = Rack::Cache::EntityStore::Disk.new(path)
+      File.should.be.a.directory path
+    end
+    it 'spreads data over a 36² hash radius' do
+      (<<-PROSE).each { |line| @store.write(line).first.should.be.sha_like }
+        My wild love went riding,
+        She rode all the day;
+        She rode to the devil,
+        And asked him to pay.
+
+        The devil was wiser
+        It's time to repent;
+        He asked her to give back
+        The money she spent
+
+        My wild love went riding,
+        She rode to sea;
+        She gathered together
+        Some shells for her hair
+
+        She rode on to Christmas,
+        She rode to the farm;
+        She rode to Japan
+        And re-entered a town
+
+        My wild love is crazy
+        She screams like a bird;
+        She moans like a cat
+        When she wants to be heard
+
+        She rode and she rode on
+        She rode for a while,
+        Then stopped for an evening
+        And laid her head down
+
+        By this time the weather
+        Had changed one degree,
+        She asked for the people
+        To let her go free
+
+        My wild love went riding,
+        She rode for an hour;
+        She rode and she rested,
+        And then she rode on
+        My wild love went riding,
+      PROSE
+      subdirs = Dir["#{@temp_dir}/*"]
+      subdirs.each do |subdir|
+        File.basename(subdir).should.be =~ /^[0-9a-z]{2}$/
+        files = Dir["#{subdir}/*"]
+        files.each do |filename|
+          File.basename(filename).should.be =~ /^[0-9a-z]{38}$/
+        end
+        files.length.should.be > 0
+      end
+      subdirs.length.should.be == 28
+    end
+  end
+
+  need_memcached 'entity store tests' do
+    describe 'MemCache' do
+      it_should_behave_like 'A Rack::Cache::EntityStore Implementation'
+      before do
+        @store = Rack::Cache::EntityStore::MemCache.new($memcached)
+      end
+      after do
+        @store = nil
+      end
+    end
+  end
+end

data/test/environment_headers_test.rb

@@ -0,0 +1,71 @@
+require "#{File.dirname(__FILE__)}/spec_setup"
+require 'rack/utils/environment_headers'
+
+describe 'Rack::Utils::EnvironmentHeaders' do
+
+  before :each do
+    @now = Time.now.httpdate
+    @env = {
+      'CONTENT_TYPE'           => 'text/plain',
+      'CONTENT_LENGTH'         => '0x1A4',
+      'HTTP_X_FOO'             => 'BAR',
+      'HTTP_IF_MODIFIED_SINCE' => @now,
+      'rack.run_once'          => true
+    }
+    @h = Rack::Utils::EnvironmentHeaders.new(@env)
+  end
+
+  after(:each) {
+    @env, @h = nil, nil
+  }
+
+  it 'retrieves headers with #[]' do
+    @h.should.respond_to :[]
+    @h['X-Foo'].should.be == 'BAR'
+    @h['If-Modified-Since'].should.be == @now
+  end
+
+  it 'sets headers with #[]=' do
+    @h.should.respond_to :[]=
+    @h['X-Foo'] = 'BAZZLE'
+    @h['X-Foo'].should.be == 'BAZZLE'
+  end
+
+  it 'sets values on the underlying environment hash' do
+    @h['X-Something-Else'] = 'FOO'
+    @env['HTTP_X_SOMETHING_ELSE'].should.be == 'FOO'
+  end
+
+  it 'handles Content-Type special case' do
+    @h['Content-Type'].should.be == 'text/plain'
+  end
+
+  it 'handles Content-Length special case' do
+    @h['Content-Length'].should.be == '0x1A4'
+  end
+
+  it 'implements #include? with RFC 2616 header name' do
+    @h.should.include 'If-Modified-Since'
+  end
+
+  it 'deletes underlying env entries' do
+    @h.delete('X-Foo')
+    @env.should.not.include? 'HTTP_X_FOO'
+  end
+
+  it 'returns the underlying environment hash with #to_env' do
+    @h.to_env.should.be @env
+  end
+
+  it 'iterates over all headers with #each' do
+    hash = {}
+    @h.each { |name,value| hash[name] = value }
+    hash.should.be == {
+      'Content-Type'           => 'text/plain',
+      'Content-Length'         => '0x1A4',
+      'X-Foo'                  => 'BAR',
+      'If-Modified-Since'      => @now
+    }
+  end
+
+end

data/test/headers_test.rb

@@ -0,0 +1,215 @@
+require "#{File.dirname(__FILE__)}/spec_setup"
+
+class MockResponse < Rack::MockResponse
+  include Rack::Cache::Headers
+  include Rack::Cache::ResponseHeaders
+  public :now
+end
+
+describe 'Rack::Cache::Headers' do
+  before :each do
+    @now = Time.now
+    @res = MockResponse.new(200, {'Date' => @now.httpdate}, '')
+    @one_hour_ago = Time.httpdate((Time.now - (60**2)).httpdate)
+  end
+  after :each do
+    @now, @res, @one_hour_ago = nil
+  end
+
+  describe '#cache_control' do
+    it 'handles single name=value pair' do
+      @res.headers['Cache-Control'] = 'max-age=600'
+      @res.cache_control['max-age'].should.be == '600'
+    end
+    it 'handles multiple name=value pairs' do
+      @res.headers['Cache-Control'] = 'max-age=600, max-stale=300, min-fresh=570'
+      @res.cache_control['max-age'].should.be == '600'
+      @res.cache_control['max-stale'].should.be == '300'
+      @res.cache_control['min-fresh'].should.be == '570'
+    end
+    it 'handles a single flag value' do
+      @res.headers['Cache-Control'] = 'no-cache'
+      @res.cache_control.should.include 'no-cache'
+      @res.cache_control['no-cache'].should.be true
+    end
+    it 'handles a bunch of all kinds of stuff' do
+      @res.headers['Cache-Control'] = 'max-age=600,must-revalidate,min-fresh=3000,foo=bar,baz'
+      @res.cache_control['max-age'].should.be == '600'
+      @res.cache_control['must-revalidate'].should.be true
+      @res.cache_control['min-fresh'].should.be == '3000'
+      @res.cache_control['foo'].should.be == 'bar'
+      @res.cache_control['baz'].should.be true
+    end
+    it 'removes the header when given an empty hash' do
+      @res.headers['Cache-Control'] = 'max-age=600, must-revalidate'
+      @res.cache_control['max-age'].should.be == '600'
+      @res.cache_control = {}
+      @res.headers.should.not.include 'Cache-Control'
+    end
+  end
+end
+
+describe 'Rack::Cache::ResponseHeaders' do
+  before :each do
+    @now = Time.now
+    @one_hour_ago = Time.httpdate((Time.now - (60**2)).httpdate)
+    @one_hour_later = Time.httpdate((Time.now + (60**2)).httpdate)
+    @res = MockResponse.new(200, {'Date' => @now.httpdate}, '')
+  end
+  after :each do
+    @now, @res, @one_hour_ago = nil
+  end
+
+  describe '#validateable?' do
+    it 'is true when Last-Modified header present' do
+      @res = MockResponse.new(200, { 'Last-Modified' => @one_hour_ago.httpdate }, '')
+      @res.extend Rack::Cache::ResponseHeaders
+      @res.should.be.validateable
+    end
+    it 'is true when Etag header present' do
+      @res = MockResponse.new(200, { 'Etag' => '"12345"' }, '')
+      @res.extend Rack::Cache::ResponseHeaders
+      @res.should.be.validateable
+    end
+    it 'is false when no validator is present' do
+      @res = MockResponse.new(200, {}, '')
+      @res.extend Rack::Cache::ResponseHeaders
+      @res.should.not.be.validateable
+    end
+  end
+
+  describe '#date' do
+    it 'uses the Date header if present' do
+      @res = MockResponse.new(200, { 'Date' => @one_hour_ago.httpdate }, '')
+      @res.extend Rack::Cache::ResponseHeaders
+      @res.date.should.be == @one_hour_ago
+    end
+    it 'uses the current time when no Date header present' do
+      @res = MockResponse.new(200, {}, '')
+      @res.extend Rack::Cache::ResponseHeaders
+      @res.date.should.be.close Time.now, 1
+    end
+  end
+
+  describe '#expires_at' do
+    it 'returns #date + #max_age when Cache-Control/max-age is present' do
+      @res.headers['Cache-Control'] = 'max-age=500'
+      @res.expires_at.should.be == @res.date + 500
+    end
+    it 'uses the Expires header when present and no Cache-Control/max-age' do
+      @res.headers['Expires'] = @one_hour_ago.httpdate
+      @res.expires_at.should.be == @one_hour_ago
+    end
+    it 'returns nil when no Expires or Cache-Control provided' do
+      @res.expires_at.should.be nil
+    end
+  end
+
+  describe '#max_age' do
+    it 'uses Cache-Control to calculate #max_age when present' do
+      @res.headers['Cache-Control'] = 'max-age=600'
+      @res.max_age.should.be == 600
+    end
+    it 'uses Expires for #max_age if no Cache-Control max-age present' do
+      @res.headers['Cache-Control'] = 'must-revalidate'
+      @res.headers['Expires'] = @one_hour_later.httpdate
+      @res.max_age.should.be == 60 ** 2
+    end
+    it 'gives a #max_age of nil when no freshness information available' do
+      @res.max_age.should.be.nil
+    end
+  end
+
+  describe '#freshness_information?' do
+    it 'is true when Expires header is present' do
+      @res.headers['Expires'] = Time.now.httpdate
+      @res.freshness_information?.should.be true
+    end
+    it 'is true when a Cache-Control max-age directive is present' do
+      @res.headers['Cache-Control'] = 'max-age=500'
+      @res.freshness_information?.should.be true
+    end
+    it 'is not true otherwise' do
+      @res.freshness_information?.should.be false
+    end
+  end
+
+  describe '#no_cache?' do
+    it 'is true when a Cache-Control no-cache directive is present' do
+      @res.headers['Cache-Control'] = 'no-cache'
+      @res.no_cache?.should.be true
+    end
+    it 'is false otherwise' do
+      @res.no_cache?.should.be false
+    end
+  end
+
+  describe '#stale?' do
+    it 'is true when TTL cannot be established' do
+      @res.should.be.stale
+    end
+    it 'is false when the TTL is <= 0' do
+      @res.headers['Expires'] = (@res.now + 10).httpdate
+      @res.should.not.be.stale
+    end
+    it 'is true when the TTL is >= 0' do
+      @res.headers['Expires'] = (@res.now - 10).httpdate
+      @res.should.be.stale
+    end
+  end
+
+  describe '#ttl' do
+    it 'is nil when no Expires or Cache-Control headers present' do
+      @res.ttl.should.be.nil
+    end
+    it 'uses the Expires header when no max-age is present' do
+      @res.headers['Expires'] = (@res.now + (60**2)).httpdate
+      @res.ttl.should.be.close(60**2, 1)
+    end
+    it 'returns negative values when Expires is in part' do
+      @res.ttl.should.be.nil
+      @res.headers['Expires'] = @one_hour_ago.httpdate
+      @res.ttl.should.be < 0
+    end
+    it 'uses the Cache-Control max-age value when present' do
+      @res.headers['Cache-Control'] = 'max-age=60'
+      @res.ttl.should.be.close(60, 1)
+    end
+  end
+
+  describe '#vary' do
+    it 'is nil when no Vary header is present' do
+      @res.vary.should.be.nil
+    end
+    it 'returns the literal value of the Vary header' do
+      @res.headers['Vary'] = 'Foo Bar Baz'
+      @res.vary.should.be == 'Foo Bar Baz'
+    end
+    it 'can be checked for existence using the #vary? method' do
+      @res.should.respond_to :vary?
+      @res.should.not.vary
+      @res.headers['Vary'] = '*'
+      @res.should.vary
+    end
+  end
+
+  describe '#vary_header_names' do
+    it 'returns an empty Array when no Vary header is present' do
+      @res.vary_header_names.should.be.empty
+    end
+    it 'parses a single header name value' do
+      @res.headers['Vary'] = 'Accept-Language'
+      @res.vary_header_names.should.be == ['Accept-Language']
+    end
+    it 'parses multiple header name values separated by spaces' do
+      @res.headers['Vary'] = 'Accept-Language User-Agent    X-Foo'
+      @res.vary_header_names.should.be ==
+        ['Accept-Language', 'User-Agent', 'X-Foo']
+    end
+    it 'parses multiple header name values separated by commas' do
+      @res.headers['Vary'] = 'Accept-Language,User-Agent,    X-Foo'
+      @res.vary_header_names.should.be ==
+        ['Accept-Language', 'User-Agent', 'X-Foo']
+    end
+  end
+end