radiant-cache_by_page-extension 1.0.0

data/HELP_admin.textile

@@ -0,0 +1,17 @@
+h2. Usage
+
+This is available to admin users only.
+In Page Edit pane, open the drawer to set caching options specific to that page.
+Instructions there should be sufficient:
+* '0' for default caching
+* '-1' for no caching
+* 'n' for _n_ minutes caching
+* or, on the right, set a 24 hr HH:MM time for the cache to expire for this page daily
+
+h3. Notes
+
+* The cache_expire_time is being set with a text field with no validation for a few reasons:
+** The time_select in rails has issues when the :include_blank => true option is set, viz. it consistently throws multi-parameter assignment errors.
+** At validation time the text entered has already been parsed into a Time object, therefore attempting validates_format_of with a regex for hh:mm is pointless.
+** Consequently, if you enter "www" it will parse the input into Time 00:00 (midnight).  To avoid possible confusion, I have added Current Setting in the meta partial.
+* Expire time displays as hh:mm, due to fact that it is a Time object being handled by ActiveRecord, it is entered as hh:mm, with seconds defaulting to 00.

data/README.textile

@@ -0,0 +1,60 @@
+h2. _Cache by Page_
+
+Extension for Radiant CMS which enables per page admin option of setting caching to a non-default value, or turning it off altogether
+
+* Created by:  Andrew vonderLuft
+* Contact: avonderluft [at] avlux [dot] net
+
+h3. Revision History
+
+* 1.0 - 4/2009 - Radiant 0.7 compatible, per page caching options
+
+h3. Requirements
+
+* Radiant 0.7 or greater
+* no other known dependencies
+
+h3. Installation
+
+From your RADIANT_ROOT:
+
+* <pre>$ script/extension install cache_by_page</pre>
+* Restart your radiant app, and you should be good to go.
+
+h2. Installation
+
+h3. From the Radiant Extension Registry
+
+# From your RAILS_ROOT run:
+<pre>script/extension install cache_by_page</pre>
+# Restart your app
+NOTE: In some earlier versions of Radiant, the migrations may not run, and the assets may not be copied and you may therefore need to run:
+<pre>rake radiant:extensions:cache_by_page:migrate</pre>
+
+h3. From Github
+
+# From your RAILS_ROOT run:
+<pre>cd vendor/extensions
+git clone git://github.com/avonderluft/radiant-cache_by_page-extension.git ./cache_by_page
+cd ../../
+rake radiant:extensions:cache_by_page:migrate
+</pre>
+# Restart your app
+
+h3. Using the gem
+
+# Install the gem
+<pre>gem install radiant-cache_by_page-extension</pre>
+# Update your Radiant config:  add to environment.rb with other gem.configs
+<pre>config.gem 'radiant-cache_by_page-extension', :lib => false</pre>
+# Run database migrations
+<pre>rake db:migrate:extensions</pre>
+# Restart your app
+
+h3. Usage
+
+See Admin help doc
+
+h3. Acknowledgments
+
+As always, Sean Cribbs lent assistance with the finer points of Ruby, Rails and Radiant.  The _Jupiter_ of Holst is still exquisite, even if it is a little bit of overkill for a podcast.

data/Rakefile

@@ -0,0 +1,136 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-cache_by_page-extension"
+    gem.summary = %Q{Cache By Page Extension for Radiant CMS}
+    gem.description = %Q{Enables per page admin option of setting caching to a non-default value, or turning it off altogether.}
+    gem.email = "avonderluft@avlux.net"
+    gem.homepage = "https://github.com/avonderluft/radiant-cache_by_page-extension"
+    gem.authors = ['Andrew vonderLuft']
+    gem.add_dependency 'radiant', ">=0.9.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package banner_rotator as a gem."
+end
+
+# I think this is the one that should be moved to the extension Rakefile template
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+# require 'spec/translator'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  # Hopefully no one has written their extensions in pre-0.9 style
+  # desc "Translate specs from pre-0.9 to 0.9 style"
+  # task :translate do
+  #   translator = ::Spec::Translator.new
+  #   dir = RAILS_ROOT + '/spec'
+  #   translator.translate(dir, dir)
+  # end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the page_options extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PageOptionsExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the page_options extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/app/views/admin/pages/_caching_meta.html.haml

@@ -0,0 +1,29 @@
+- if current_user.admin?
+  %tr
+    %th.label{:style => "vertical-align:middle"} Page Caching
+    %td.field{:style => "text-align: left"}
+      %table{:style => "vertical-align:top;"}
+        %row
+          %td{:style => "text-align: left"}
+            %label Current Setting:
+            %br
+            = @page.cache_setting if Page.exists? @page
+          %td{:style => "padding-left:40px"}
+            %label Override:
+          %td{:style => "padding-left:10px"}
+            %label Cache this page for
+            = text_field :page, :cache_expire_minutes, {:maxlength => 4}
+            = "minutes"
+            %br
+            %span.desc= "( '0' = Default of #{Page.default_caching},  '-1' = No Caching )"
+          %td — or —
+          %td
+            %label Expire cache each day at
+            = text_field_tag 'page[cache_expire_time]', @page.cache_expire_time ? @page.cache_expire_time.in_time_zone.strftime("%H:%M") : "", {:size => 5, :maxlength => 5}
+            = "(HH:MM)"
+            %br
+            %span.desc= "(Clear expire time to reset default of #{Page.default_caching})"
+  - content_for :page_css do
+    :sass
+      .desc
+        font-size: 80%

data/app/views/admin/pages/_caching_td.html.haml

@@ -0,0 +1,4 @@
+- if page.cache_setting == "Default"
+  %td.status{:title=>Page.default_caching}= page.cache_setting
+- else
+  %td.status= page.cache_setting

data/app/views/admin/pages/_caching_th.html.haml

@@ -0,0 +1 @@
+%th.caching Caching

data/cache_by_page_extension.rb

@@ -0,0 +1,17 @@
+# Uncomment this if you reference any of your controllers in activate
+# require_dependency 'application_controller'
+
+class CacheByPageExtension < Radiant::Extension
+  version "#{File.read(File.expand_path(File.dirname(__FILE__)) + '/VERSION')}"
+  description "Enables per page admin option of setting caching to a non-default value, or turning it off altogether"
+  url "https://github.com/avonderluft/radiant-cache_by_page-extension"
+
+  def activate
+    SiteController.send :include, CacheByPage::SiteControllerExtensions
+    Page.send :include, CacheByPage::PageExtensions
+    admin.page.index.add :sitemap_head, 'caching_th', :before => 'status_column_header'
+    admin.page.index.add :node, 'caching_td', :before => 'status_column'
+    admin.page.edit.add :extended_metadata, 'caching_meta'
+  end
+
+end

data/db/migrate/001_add_page_options.rb

@@ -0,0 +1,11 @@
+class AddPageOptions < ActiveRecord::Migration
+  def self.up   
+    add_column :pages, :cache_expire_minutes, :integer, :allow_nil => false, :default => 0
+    add_column :pages, :cache_expire_time, :time, :default => nil  
+  end
+
+  def self.down
+    remove_column :pages, :cache_expire_minutes
+    remove_column :pages, :cache_expire_time
+  end
+end

data/lib/cache_by_page/page_extensions.rb

@@ -0,0 +1,87 @@
+module CacheByPage::PageExtensions
+  def self.included(base)
+    base.class_eval do
+      extend ClassMethods
+      validates_numericality_of :cache_expire_minutes, :allow_nil => false, :only_integer => true,
+                                :message => 'must be a whole number'
+      def validate
+        self.cache_expire_minutes = -1 if self.cache_expire_minutes.to_i < -1
+        if self.cache_expire_minutes.to_i != 0 && self.changes.include?("cache_expire_minutes")
+          self.cache_expire_time = nil
+        end
+        if self.cache_expire_time != nil && self.changes.include?("cache_expire_time")
+          self.cache_expire_minutes = 0
+        end
+        super
+      end
+
+      def cache?
+        self.cache_expire_minutes.to_i >= 0
+      end
+      def cache_override?
+        self.cache_expire_minutes.to_i > 0 || self.cache_expire_time != nil
+      end
+      def cache_duration
+        @page = Page.find(self.id)
+        case true
+        when @page.cache_expire_minutes == 0 && @page.cache_expire_time == nil
+          if SiteController.respond_to?('cache_timeout')
+            SiteController.cache_timeout
+          else
+            ResponseCache.defaults[:expire_time]
+          end
+        when @page.cache_expire_minutes == -1: nil
+        when @page.cache_expire_minutes >= 1: @page.cache_expire_minutes.minutes
+        when @page.cache_expire_time != nil && @page.cache_expire_time.is_a?(Time)
+          next_expire_time = @page.cache_expire_time < Time.now ? @page.cache_expire_time.tomorrow : @page.cache_expire_time
+          (next_expire_time - Time.now).round
+        else nil
+        end
+      end
+      def cache_setting
+        @page = Page.find(self.id)
+        case true
+        when @page.cache_expire_minutes == 0 && @page.cache_expire_time == nil: Page.default_caching
+        when @page.cache_expire_minutes == -1: "No Caching"
+        when @page.cache_expire_minutes == 1: "1 minute"
+        when @page.cache_expire_minutes > 1: "#{@page.cache_expire_minutes} minutes"
+        when @page.cache_expire_time != nil && @page.cache_expire_time.is_a?(Time)
+          "Daily at #{@page.cache_expire_time.strftime("%H")}:#{@page.cache_expire_time.strftime("%M")}"
+        else "Not set"
+        end
+      end
+      alias_method_chain :process, :expire_time
+    end
+  end
+
+  def process_with_expire_time(request, response)
+    if cache?
+      if cache_expire_minutes.to_i > 0
+        response.cache_timeout = cache_expire_minutes.minutes.from_now
+      elsif ! cache_expire_time.nil?
+        expire_time = Time.parse("#{cache_expire_time.hour}:#{cache_expire_time.min}")
+        response.cache_timeout = expire_time < Time.now ? expire_time.tomorrow : expire_time
+      end
+    end
+    process_without_expire_time(request, response)
+  end
+
+  module ClassMethods
+    def default_caching
+      seconds = SiteController.respond_to?('cache_timeout') ? SiteController.cache_timeout : ResponseCache.defaults[:expire_time] 
+      cache_expire_time = case true
+        when seconds >= 86400
+          "#{seconds/86400} days"
+        when seconds >= 3600
+          "#{seconds/3600} hours"
+        when seconds >= 120
+          "#{seconds/60} minutes"
+        else
+          "#{seconds} seconds"
+      end
+      cache_expire_time = cache_expire_time.chop if cache_expire_time[0,1] == "1"
+      cache_expire_time
+    end
+  end
+
+end

data/lib/cache_by_page/site_controller_extensions.rb

@@ -0,0 +1,18 @@
+module CacheByPage::SiteControllerExtensions
+  def self.included(base)
+    base.class_eval do
+      alias_method_chain :set_cache_control, :cache_by_page
+    end
+  end
+  
+  private
+  
+  def set_cache_control_with_cache_by_page
+    if (request.head? || request.get?) && @page.cache? && @page.cache_duration && live?
+      expires_in @page.cache_duration, :public => true, :private => false
+    else
+      set_cache_control_without_cache_by_page
+    end
+  end
+
+end

data/lib/tasks/cache_by_page_extension_tasks.rake

@@ -0,0 +1,28 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :cache_by_page do
+      
+      desc "Runs the migration of the Cache By Page extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          CacheByPageExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          CacheByPageExtension.migrator.migrate
+        end
+      end
+      
+      desc "Copies public assets of the Page Options to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        Dir[CacheByPageExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(CacheByPageExtension.root, '')
+          directory = File.dirname(path)
+          puts "Copying #{path}..."
+          mkdir_p RAILS_ROOT + directory
+          cp file, RAILS_ROOT + path
+        end
+      end  
+    end
+  end
+end

data/radiant-cache_by_page-extension.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{radiant-cache_by_page-extension}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew vonderLuft"]
+  s.date = %q{2011-05-09}
+  s.description = %q{Enables per page admin option of setting caching to a non-default value, or turning it off altogether.}
+  s.email = %q{avonderluft@avlux.net}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    "HELP_admin.textile",
+    "README.textile",
+    "Rakefile",
+    "VERSION",
+    "app/views/admin/pages/_caching_meta.html.haml",
+    "app/views/admin/pages/_caching_td.html.haml",
+    "app/views/admin/pages/_caching_th.html.haml",
+    "cache_by_page_extension.rb",
+    "db/migrate/001_add_page_options.rb",
+    "lib/cache_by_page/page_extensions.rb",
+    "lib/cache_by_page/site_controller_extensions.rb",
+    "lib/tasks/cache_by_page_extension_tasks.rake",
+    "radiant-cache_by_page-extension.gemspec",
+    "spec/controllers/admin_pages_controller_spec.rb",
+    "spec/controllers/site_controller_extensions_spec.rb",
+    "spec/integration/page_caching_spec.rb",
+    "spec/models/page_extensions_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{https://github.com/avonderluft/radiant-cache_by_page-extension}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Cache By Page Extension for Radiant CMS}
+  s.test_files = [
+    "spec/controllers/admin_pages_controller_spec.rb",
+    "spec/controllers/site_controller_extensions_spec.rb",
+    "spec/integration/page_caching_spec.rb",
+    "spec/models/page_extensions_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<radiant>, [">= 0.9.1"])
+    else
+      s.add_dependency(%q<radiant>, [">= 0.9.1"])
+    end
+  else
+    s.add_dependency(%q<radiant>, [">= 0.9.1"])
+  end
+end
+

data/spec/controllers/admin_pages_controller_spec.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+Admin::PagesController.module_eval { def rescue_action(e); raise e; end }
+
+describe Admin::PagesController, 'with cache_by_page' do
+  dataset :users_and_pages
+  integrate_views
+
+  before :each do
+    @page = pages(:home)
+  end
+
+  [:admin, :non_admin, :designer].each do |user|
+    describe "privileges for user '#{user}'" do
+      before(:each) do
+        login_as user
+      end
+      it "should display admin edit page on a new page" do
+        get :new
+        response.should render_template('new')
+      end
+      if user == :admin
+        it "should display page caching options on the admin edit page for an existing page" do
+          get :edit, :id => @page
+          response.should include_text("Cache this page for")
+        end
+      else
+        it "should not display page caching options on the admin edit page for an existing page" do
+          get :edit, :id => @page
+          response.should_not include_text("Cache this page for")
+        end
+      end
+    end
+  end
+
+  after :each do
+    response.should be_success
+    logout
+  end
+
+end

data/spec/controllers/site_controller_extensions_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'site_controller'
+SiteController.module_eval { def rescue_action(e); raise e; end }
+
+describe SiteController, "(Extended) - cache by page changes" do
+  dataset :users_and_pages
+  
+  before :each do
+    @page = pages(:home)
+  end
+
+  it "should include the extension module" do
+    SiteController.included_modules.should include(CacheByPage::SiteControllerExtensions)
+  end
+  
+  describe "alias method chain" do
+    it "should be set up" do
+      controller.private_methods.should include('set_cache_control_with_cache_by_page')
+      controller.private_methods.should include('set_cache_control_without_cache_by_page')
+      controller.private_methods.should include('set_cache_control')
+    end
+  end
+
+end

data/spec/integration/page_caching_spec.rb

@@ -0,0 +1,112 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Page, "with page-specific caching", :type => :integration do
+  dataset :pages
+  USING_RACK_CACHE = SiteController.respond_to?('cache_timeout')
+
+  before :all do
+    @cache_dir = "#{RAILS_ROOT}/tmp/cache"
+    @cache_file = USING_RACK_CACHE ? "#{@cache_dir}/meta/*/*" : "#{@cache_dir}/_site-root.yml"
+  end
+
+  before :each do
+    @page = pages(:home)
+    @default = 1.day
+    if USING_RACK_CACHE
+      SiteController.page_cache_directory = @cache_dir
+      SiteController.perform_caching = true
+      SiteController.cache_timeout = @default
+    else
+      ResponseCache.defaults[:directory] = @cache_dir
+      ResponseCache.defaults[:perform_caching] = true
+      ResponseCache.defaults[:expire_time] = @default
+    end
+    @expire_mins = @default.to_i/60
+    @cache = USING_RACK_CACHE ? Radiant::Cache : ResponseCache.instance
+    @cache.clear
+  end
+
+  def page_is_cached(page)
+    if response.nil?
+      @cache.clear
+      false
+    elsif USING_RACK_CACHE
+      ! response.headers['Cache-Control'].include?('no-cache')
+    else
+      @cache.response_cached?(page.url)
+    end
+  end
+
+  def cache_expires
+    if USING_RACK_CACHE
+      Time.now + `cat #{@cache_file}`.split('max-age=')[1].split(',')[0].to_i rescue nil
+    else
+      YAML.load_file(@cache_file)['expires'] rescue nil
+    end
+  end
+
+  describe "- intial fetch of page before updates" do
+    it "should render a page with default caching" do
+      get "#{@page.slug}"
+      response.should be_success
+      response.cache_timeout.should be_nil
+      page_is_cached(@page).should be_true
+      if USING_RACK_CACHE
+        response.headers['Cache-Control'].should == "max-age=#{@default}, public"
+      else
+        @cache.expire_time.should == @default
+        @cache.response_cached?(@page.url).should be_true
+      end
+    end
+  end
+
+  %w(minutes time).each do |att|
+    describe "- page with specific caching option by #{att}" do
+    
+      before(:each) do
+        page_is_cached(@page).should be_false
+        @expire_mins = 180
+        @expire_time = @expire_mins.minutes.from_now
+        if att == "minutes"
+          @page.cache_expire_minutes = @expire_mins
+        elsif att == "time"
+          @page.cache_expire_time = @expire_time
+        end
+        @page.save!
+        get "#{@page.slug}"
+        page_is_cached(@page).should be_true
+      end
+
+      it "should cache page for the specified #{att}" do
+        cache_expires.should be_close(@expire_mins.minutes.from_now, 30)
+      end
+      it "should re-cache the page if the expire_time is past" do
+        if USING_RACK_CACHE
+          unless `ls #{@cache_dir}/meta`.blank?
+            file_name = `ls -1 #{@cache_dir}/meta/*/*`.strip
+            file_contents = `cat #{file_name}`
+            year = Time.now.strftime('%Y')
+            file_contents = file_contents.sub(" #{year} ", " #{(year.to_i-1).to_s} ")
+            FileUtils.rm(file_name)
+            File.open(file_name, 'w') { |f| f.write(file_contents) }
+          end
+        else
+          file_contents = YAML.load_file(@cache_file)
+          file_contents['expires'] = 1.year.ago
+          FileUtils.rm(@cache_file)
+          File.open(@cache_file, 'w') { |f| f.write(file_contents.to_yaml) }
+        end
+        `sleep 1`
+        2.times { get "#{@page.slug}" }
+        page_is_cached(@page).should be_true
+        response.headers['Age'].should == "0" if USING_RACK_CACHE
+        cache_expires.should be_close(@expire_mins.minutes.from_now, 30)
+      end
+    end
+  end
+
+  after(:each) do
+    @cache.clear
+  end
+
+end

data/spec/models/page_extensions_spec.rb

@@ -0,0 +1,92 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "CacheByPage::PageExtensions" do
+  dataset :pages
+  
+  describe "page with Cache By Page extension" do
+    
+    before(:each) do
+      @page = pages(:home)
+    end
+    
+    it "should have alias method chain set up" do
+      @page.should respond_to(:process_without_expire_time)
+      @page.should respond_to(:process_with_expire_time)
+      @page.should respond_to(:process)
+    end
+    it "should have class method for default_caching" do
+      Page.should respond_to(:default_caching)
+    end
+    %w{cache_override? cache_duration cache_setting process_with_expire_time}.each do |method|
+      it "should have #{method} method" do
+        @page.should respond_to(method)
+      end
+    end
+    it "should be valid" do
+      @page.should be_valid
+    end
+    it 'should cache by by default' do
+      @page.cache?.should == true
+      @page.cache_duration.should == 86400
+      @page.cache_setting.should == "1 day"
+    end
+
+    describe "- after updates and validation with save" do
+      it "should return error if non-numeric is entered for cache_expire_minutes" do
+        @page.cache_expire_minutes = "five"
+        @page.save.should raise_error
+      end
+      it "should return error if non-integer is entered for cache_expire_minutes" do
+        @page.cache_expire_minutes = "3.3"
+        @page.save.should raise_error
+      end
+      it "should set cache_expire_minutes to 0 when cache_expire_time is updated" do
+        @page.update_attribute(:cache_expire_minutes, 30)
+        @page.cache_expire_time = 2.days.from_now
+        @page.save
+        @page.cache_expire_minutes.should == 0
+        @page.cache_duration.should be_close(2.days.to_i,2)
+        @page.cache_setting.should == "Daily at #{Time.now.strftime('%H:%M')}"
+      end
+      it "should set cache_expire_time to nil when cache_expire_minutes is updated" do
+        @page.update_attribute(:cache_expire_time, 1.day.from_now)
+        @page.cache_expire_minutes = 30
+        @page.save
+        @page.cache_expire_time.should be_nil
+        @page.cache_duration.should be_close(30.minutes.to_i,2)
+        @page.cache_setting.should == "30 minutes"
+      end
+      it "should not cache after setting cache_expire_minutes to -1" do
+        @page.update_attribute(:cache_expire_minutes, -1)
+        @page.cache?.should == false
+        @page.cache_duration.should be_nil
+        @page.cache_setting.should == "No Caching"
+      end
+
+      describe "- updating a page which has caching turned off" do
+        before :each do
+          @page.update_attribute(:cache_expire_minutes, -1)
+          @page.cache?.should == false
+          @page.cache_duration.should be_nil
+          @page.cache_setting.should == "No Caching"
+        end
+        it "should cache after updating cache_expire_minutes" do
+          @page.cache_expire_minutes = 30
+          @page.save
+          @page.cache?.should == true
+          @page.cache_duration.should be_close(30.minutes.to_i,2)
+          @page.cache_setting.should == "30 minutes"
+        end
+        it "should cache after updating cache_expire_time" do
+          @page.cache_expire_time = 2.days.from_now
+          @page.save
+          @page.cache?.should == true
+          @page.cache_duration.should be_close(2.days.to_i,2)
+          @page.cache_setting.should == "Daily at #{Time.now.strftime('%H:%M')}"
+        end
+      end
+    end
+
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+# if File.directory?(File.dirname(__FILE__) + "/scenarios")
+#   Scenario.load_paths.unshift File.dirname(__FILE__) + "/scenarios"
+# end
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-cache_by_page-extension
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andrew vonderLuft
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-09 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: radiant
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :runtime
+  version_requirements: *id001
+description: Enables per page admin option of setting caching to a non-default value, or turning it off altogether.
+email: avonderluft@avlux.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- HELP_admin.textile
+- README.textile
+- Rakefile
+- VERSION
+- app/views/admin/pages/_caching_meta.html.haml
+- app/views/admin/pages/_caching_td.html.haml
+- app/views/admin/pages/_caching_th.html.haml
+- cache_by_page_extension.rb
+- db/migrate/001_add_page_options.rb
+- lib/cache_by_page/page_extensions.rb
+- lib/cache_by_page/site_controller_extensions.rb
+- lib/tasks/cache_by_page_extension_tasks.rake
+- radiant-cache_by_page-extension.gemspec
+- spec/controllers/admin_pages_controller_spec.rb
+- spec/controllers/site_controller_extensions_spec.rb
+- spec/integration/page_caching_spec.rb
+- spec/models/page_extensions_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/avonderluft/radiant-cache_by_page-extension
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Cache By Page Extension for Radiant CMS
+test_files: 
+- spec/controllers/admin_pages_controller_spec.rb
+- spec/controllers/site_controller_extensions_spec.rb
+- spec/integration/page_caching_spec.rb
+- spec/models/page_extensions_spec.rb
+- spec/spec_helper.rb