radiant-cache_buster-extension 0.0.1

data/README.md

@@ -0,0 +1,17 @@
+# Cache Buster 
+
+Simply adds a tag which applies to a cache buster to any asset.
+
+## Usage
+
+        <h1> Homepage </h1>
+        <img src="http://example.com/some/external/image.jpg<r:cache_buster/>">
+
+## Configuration
+
+        # file: :radiant_root/config/initializers/radiant_config.rb
+        Radiant.config do |config|
+                config['cache_buster.timeout'] = 1.day
+        end
+
+

data/Rakefile

@@ -0,0 +1,134 @@
+# 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
+
+unless defined? RAILS_ROOT
+  case
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    RAILS_ROOT = "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}"
+  else
+    RAILS_ROOT = "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}"
+  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 'cucumber'
+require 'cucumber/rake/task'
+
+# 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, :cucumber]
+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
+  
+  desc "Run the Cucumber features"
+  task :integration => 'cucumber:ok'
+  
+  # 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
+
+namespace :cucumber do
+  Cucumber::Rake::Task.new(:ok, 'Run features that should pass') do |t|
+    t.fork = true # You may get faster startup if you set this to false
+    t.profile = 'default'
+  end
+
+  Cucumber::Rake::Task.new(:wip, 'Run features that are being worked on') do |t|
+    t.fork = true # You may get faster startup if you set this to false
+    t.profile = 'wip'
+  end
+
+  desc 'Run all features'
+  task :all => [:ok, :wip]
+end
+
+desc 'Alias for cucumber:ok'
+task :cucumber => 'cucumber:ok'
+
+task :features => :cucumber do
+  STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+end
+
+desc 'Generate documentation for the sheets extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SheetsExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/app/controllers/admin/buster_controller.rb

@@ -0,0 +1,14 @@
+class Admin::BusterController < Admin::ResourceController
+  model_class CacheBuster
+
+  def index
+    if request.post?
+      if CacheBuster.bust_buster
+        flash[:notice] = "Cache Buster Reset - Succeeded!"
+      else
+        flash[:notice] = "Cache Buster Reset - FAILED!"
+      end
+    end
+  end
+end
+

data/app/models/cache_buster.rb

@@ -0,0 +1,47 @@
+class CacheBuster < ActiveRecord::Base
+
+  DEFAULT_TIMEOUT = 1.day
+
+  before_save :ensure_updated_at
+
+  def self.buster
+    self.there_can_be_only_one
+
+    if self.first.updated_at.to_i < Time.now.to_i-self.timeout
+      buster = self.bust_buster
+    else
+      buster = self.last
+    end
+
+    "?#{buster.updated_at.to_i}"
+  end
+
+  def self.bust_buster
+    if self.first.nil?
+       self.new.save
+    else
+      self.first.save
+    end
+    self.first
+  end
+
+  def self.timeout
+    (Radiant::Config['cache_buster.timeout'] ? Radiant::Config['cache_buster.timeout'].to_i : DEFAULT_TIMEOUT).to_i
+  end
+
+  private
+  def self.there_can_be_only_one
+    return self.new(:updated_at => Time.now).save if self.first.nil?
+
+    unless self.first == self.last
+      the_one = self.last
+      self.destroy_all
+      self.new(:updated_at => the_one.updated_at).save
+    end
+  end
+
+  def ensure_updated_at
+    self.updated_at = Time.now
+  end
+
+end

data/app/views/admin/buster/index.html.haml

@@ -0,0 +1,5 @@
+%h3="Current Cache Buster: <tt>'#{CacheBuster.buster}'</tt>"
+- form_for :buster, :url => "/admin/buster", :method => :post do |f|
+  = f.submit('Reset Cache Buster')
+
+

data/cache_buster_extension.rb

@@ -0,0 +1,21 @@
+# Uncomment this if you reference any of your controllers in activate
+require_dependency 'application_controller'
+require 'compass'
+require 'radiant-cache_buster-extension'
+
+class CacheBusterExtension < Radiant::Extension
+  version     RadiantCacheBusterExtension::VERSION
+  description RadiantCacheBusterExtension::DESCRIPTION
+  url         RadiantCacheBusterExtension::URL
+  
+  def activate
+    tab 'Settings' do
+      add_item "Cache Buster", "/admin/buster"
+    end
+
+    Page.class_eval do      
+     include CacheBusterTags
+    end
+  end
+end
+

data/config/routes.rb

@@ -0,0 +1,10 @@
+ActionController::Routing::Routes.draw do |map|
+  map.namespace :admin do |admin|
+    admin.resources :buster
+  end
+end
+#ActionController::Routing::Routes.draw do |map|
+  #map.connect '/admin/buster', :controller => :buster, :action => :index, :conditions => { :method => [ :get, :post ] }
+#end
+
+

data/db/migrate/001_create_cache_buster.rb

@@ -0,0 +1,12 @@
+class CreateCacheBuster < ActiveRecord::Migration
+  def self.up
+    create_table :cache_busters, :force => false do |t|
+      t.datetime :updated_at, :null => false
+    end
+    
+  end
+  
+  def self.down
+    drop_table :cache_busters
+  end
+end

data/db/migrate/002_create_inital_cache_buster.rb

@@ -0,0 +1,10 @@
+class CreateInitalCacheBuster < ActiveRecord::Migration
+  def self.up
+    CacheBuster.new.save!
+  end
+  
+  def self.down
+    CacheBuster.destroy_all
+  end
+end
+

data/lib/cache_buster_tags.rb

@@ -0,0 +1,18 @@
+module CacheBusterTags 
+  include Radiant::Taggable
+  class TagError < StandardError; end
+  desc %{
+Renders a cache buster.
+
+*Usage:*
+
+<pre><code><img src="http://example.com/some/external/image.png<r:cache_buster /></code>"></pre>
+
+The above example will produce the following:
+
+<pre><code><img src="http://example.com/some/external/image.png?123456789</code>"></pre>
+  }
+  tag 'cache_buster' do |tag|
+    CacheBuster.buster
+  end
+end

data/lib/radiant-cache_buster-extension.rb

@@ -0,0 +1,8 @@
+module RadiantCacheBusterExtension
+  VERSION     = '0.0.1'
+  SUMMARY     = %q{Cache Buster tag for Radiant CMS}
+  DESCRIPTION = SUMMARY
+  URL         = "http://github.com/jmervine/radiant-cache_buster-extension"
+  AUTHORS     = ["Josh Mervine"]
+  EMAIL       = ["joshua@mervine.net"]
+end

data/lib/tasks/cache_buster_extension_tasks.rake

@@ -0,0 +1,17 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :cache_buster do
+      desc "Runs the migration of the CacheBuster extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          CacheBusterExtension.migrator.migrate(ENV["VERSION"].to_i)
+          Rake::Task['db:schema:dump'].invoke
+        else
+          CacheBusterExtension.migrator.migrate
+          Rake::Task['db:schema:dump'].invoke
+        end
+      end
+    end
+  end
+end

data/radiant-cache_buster-extension.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-cache_buster-extension"
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-cache_buster-extension"
+  s.platform    = Gem::Platform::RUBY
+
+  s.version     = RadiantCacheBusterExtension::VERSION
+  s.authors     = RadiantCacheBusterExtension::AUTHORS
+  s.email       = RadiantCacheBusterExtension::EMAIL
+  s.homepage    = RadiantCacheBusterExtension::URL
+  s.summary     = RadiantCacheBusterExtension::SUMMARY
+  s.description = RadiantCacheBusterExtension::DESCRIPTION
+
+  ignores = if File.exist?('.gitignore')
+    File.read('.gitignore').split("\n").inject([]) {|a,p| a + Dir[p] }
+  else
+    []
+  end
+  s.files         = Dir['**/*'] - ignores
+  s.test_files    = Dir['spec/**/*'] - ignores
+  s.require_paths = ["lib"]
+end
+

data/spec/ci/before_script

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+
+# all 'test's before 'ue' or will exit when test fails
+
+test "$WITH_RVM" || WITH_RVM="true"
+test "$RADIANT_VERSION" || RADIANT_VERSION="1.1.0"
+test "$DB" || DB="sqlite"
+test -e ~/radiant && rm -rf ~/radiant
+
+
+set -xue
+
+start_path="$( pwd )"
+
+cd ~
+git clone git://github.com/radiant/radiant.git
+cd ~/radiant
+
+if [[ $RADIANT_VERSION != "master" ]]
+then
+  git checkout -b $RADIANT_VERSION $RADIANT_VERSION
+fi
+
+cp -r $start_path vendor/extensions/cache_buster
+gem install bundler --no-ri --no-rdoc
+
+echo 'gem "radiant-cache_buster-extension", :path => "vendor/extensions/cache_buster"' >> Gemfile
+echo 'gemspec' >> Gemfile
+
+# I really dislike using rvm gemset, but while testing this 
+# script I got sick having to install the same gems over and
+# over again.
+if [[ $WITH_RVM == "true" ]]; then
+        rvm gemset create radiant_development
+        rvm gemset use radiant_development
+        bundle install
+else
+        bundle install --path ./vendor/bundle
+fi
+
+case $DB in
+  "mysql" )
+    mysql -e 'create database radiant_test;'
+    cp spec/ci/database.mysql.yml config/database.yml;;
+  "postgres" )
+    psql -c 'create database radiant_test;' -U postgres
+    cp spec/ci/database.postgresql.yml config/database.yml;;
+  "sqlite" )
+    cp spec/ci/database.sqlite.yml config/database.yml;;
+esac
+
+RAILS_ENV=test bundle exec rake db:migrate --trace 
+RAILS_ENV=test bundle exec rake db:migrate:extensions --trace

data/spec/ci/script

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+# all 'test's before 'ue' or will exit when test fails
+test "$WITH_RVM" || WITH_RVM="true"
+
+set -xue
+
+start_path="$( pwd )"
+
+# I really dislike using rvm gemset, but while testing this 
+# script I got sick having to install the same gems over and
+# over again.
+if [[ $WITH_RVM == "true" ]]; then
+        rvm gemset create radiant_development
+        rvm gemset use radiant_development
+fi
+
+cd ~/radiant
+
+# ensure fresh cache_buster code
+rm -rf vendor/extensions/cache_buster
+cp -r $start_path vendor/extensions/cache_buster
+bundle update radiant-cache_buster-extension
+
+RAILS_ENV=test bundle exec rake spec:extensions EXT=cache_buster --trace

data/spec/controllers/admin/buster_controller_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe Admin::BusterController do
+  dataset :users
+
+  before :each do
+    ActionController::Routing::Routes.reload
+    login_as :designer
+  end
+  
+  it "should be a ResourceController" do
+    controller.should be_kind_of(Admin::ResourceController)
+  end
+
+  it "should handle CacheBuster" do
+    controller.class.model_class.should == CacheBuster
+  end
+
+  describe "index" do
+    describe "display Buster" do
+      before do
+        get :index
+      end
+
+      it "should render the index view" do
+        response.should be_success
+        response.should render_template('index')
+      end
+    end
+
+    describe "update Buster" do
+      before do
+        post :index
+      end
+
+      it "should render the index view" do
+        response.should be_success
+        response.should render_template('index')
+      end
+    end
+  end
+end

data/spec/lib/cache_buster_tags_spec.rb

@@ -0,0 +1,20 @@
+# require 'spec_helper'
+require File.expand_path("../../spec_helper", __FILE__)
+
+#class Time
+  #def self.now
+    #Time.at 1212483780 # July 3 2008 9:03AM PST
+  #end
+#end
+
+describe "Cache Buster Tags" do
+  dataset :pages, :users
+
+  let(:page){ pages(:home) }
+
+  describe "<r:cache_buster />" do
+    subject { page }
+    it      { should render(%{<r:cache_buster />}).as(/\?[0-9]+$/) }
+  end
+
+end

data/spec/models/cache_buster_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe CacheBuster do
+
+  before(:all) do
+    # ensure default after previous tests
+    Radiant::Config['cache_buster.timeout'] = CacheBuster::DEFAULT_TIMEOUT
+  end
+
+  describe '.buster' do
+    it 'should return cache buster' do
+      CacheBuster.buster.should be
+    end
+    it 'should be a string' do
+      CacheBuster.buster.should be_a_kind_of String
+      CacheBuster.buster.should match /^\?[0-9]+$/
+    end
+  end
+
+  describe '.timeout' do
+    describe 'without timeout config' do
+      it 'should be an int' do
+        CacheBuster.timeout.should be_a_kind_of Fixnum
+      end
+    end
+    describe 'with timeout config' do
+      before do
+        Radiant::Config['cache_buster.timeout'] = 1
+      end
+      it 'should be an int' do
+        CacheBuster.timeout.should be_a_kind_of Fixnum
+        CacheBuster.timeout.should == 1
+      end
+
+      it 'should update after timeout passes' do
+
+        buster1 = CacheBuster.buster
+        sleep 2
+        buster2 = CacheBuster.buster
+
+        buster1.should_not == buster2
+        #buster1.gsub("?", "").to_i.should be_less_then buster2.gsub("?", "").to_i
+      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,36 @@
+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"
+
+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,72 @@
+--- !ruby/object:Gem::Specification
+name: radiant-cache_buster-extension
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Josh Mervine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-12 00:00:00.000000000 Z
+dependencies: []
+description: Cache Buster tag for Radiant CMS
+email:
+- joshua@mervine.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/routes.rb
+- app/models/cache_buster.rb
+- app/controllers/admin/buster_controller.rb
+- app/views/admin/buster/index.html.haml
+- README.md
+- db/migrate/002_create_inital_cache_buster.rb
+- db/migrate/001_create_cache_buster.rb
+- radiant-cache_buster-extension.gemspec
+- spec/models/cache_buster_spec.rb
+- spec/controllers/admin/buster_controller_spec.rb
+- spec/ci/script
+- spec/ci/before_script
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/lib/cache_buster_tags_spec.rb
+- lib/radiant-cache_buster-extension.rb
+- lib/tasks/cache_buster_extension_tasks.rake
+- lib/cache_buster_tags.rb
+- cache_buster_extension.rb
+- Rakefile
+homepage: http://github.com/jmervine/radiant-cache_buster-extension
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Cache Buster tag for Radiant CMS
+test_files:
+- spec/models/cache_buster_spec.rb
+- spec/controllers/admin/buster_controller_spec.rb
+- spec/ci/script
+- spec/ci/before_script
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/lib/cache_buster_tags_spec.rb