expiry_control 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Urban Hafner
+
+ Permission is hereby granted, free of charge, to any person
+ obtaining a copy of this software and associated documentation
+ files (the "Software"), to deal in the Software without
+ restriction, including without limitation the rights to use,
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the
+ Software is furnished to do so, subject to the following
+ conditions:
+
+ The above copyright notice and this permission notice shall be
+ included in all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+Rails 2.3 allows you to set the Expires header using the expires_in
+method. However this couples your caching strategy with your controller
+code. And it spreads out the caching configuration all over the place.
+This plugin allows you to keep your caching configuration in one place
+out of the controllers.
+
+Install
+=======
+
+Install as a gem (`gem install expiry_control`) and add it in your
+`environmen.rb` file.
+
+Usage
+=====
+
+Create a file somewhere, maybe in `config/initializers` that will contain
+your configuration. The name doesn't matter. Your configuration will go
+into the following block of code:
+
+    ExpiryControl.configure do |config|
+      # configuration goes here
+    end
+
+Just like when you configure your routes you call methods on the object
+passed into the block:
+
+    # Set Expires header to 1 hour for the whole blog controller
+    config.cache "blog", :for => 1.hour
+    
+    # Set Expires header to 5 minutes for a special action, this overrides
+    # the controller wide setting
+    config.cache "blog#special", :for => 5.minutes
+    
+    # Set a default caching time
+    config.default 1.minute
+
+This is all there is to it for the basic usage. Note that more specialized
+rules take precedence. Specifically, the code first looks for a rule at
+the action level (or rather action in a specific controller), then at the
+controller level and the it uses the default rule (if it exists).
+
+Sometimes however this is not enough and you need to make the caching
+optional. For these cases you can use `:if` and `:unless` like you would
+use in validations. Note, that you have to use a `Proc` symbols or strings
+are not supported. This `Proc` gets passed the controller object for
+maximum flexibility.
+
+    # Only cache if 'cache' param is set
+    config.cache "blog", :for => 1.hour, :if => Proc.new {|controller| controller.params["cache"]}

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rake/gempackagetask'
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'generators/**/*',
+  'lib/**/*',
+  'rails/**/*',
+  'tasks/**/*',
+  'test/**/*'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = "expiry_control"
+  s.version = "0.0.1"
+  s.author = "Urban Hafner"
+  s.email = "urban@bettong.net"
+  s.homepage = "http://github.com/msales/expiry_control"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "DSL to set expires headers for Rails apps"
+  s.files = PKG_FILES.to_a
+  s.require_path = "lib"
+
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README.md"]
+end
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/lib/expiry_control.rb

@@ -0,0 +1,61 @@
+class ActionController::Base
+  
+  after_filter :_set_expires_header
+  
+  private
+  
+  def _set_expires_header
+    et = ExpiryControl.expiration_time(self)
+    expires_in et, :public => true if et
+  end
+  
+end
+
+module ExpiryControl
+  
+  def self.configure
+    @@config ||= Config.new
+    yield @@config
+  end
+  
+  def self.expiration_time(controller)
+    @@config.expiration_time(controller) if @@config
+  end
+  
+  class Config
+
+    def initialize
+      @config = {}
+    end
+
+    def cache(path, options)
+      raise "Missing expiration time!" unless options[:for]
+      raise "You cannot use :if and :unless at the same time!" if [:if, :unless].all? {|o| options[o]}
+      @config[path] = options
+    end
+
+    def default(time)
+      @config[:default] = time
+    end
+    
+    def expiration_time(controller)
+      ca_string = "#{controller.controller_name}##{controller.action_name}"
+      request_config = @config[ca_string]
+      request_config ||= @config[controller.controller_name]
+      request_config ||= @config[:default]
+      request_config ||= {}
+      if [:if, :unless].any? {|o| request_config[o]}
+        r = request_config[:if].call(controller) if request_config[:if]
+        r = !request_config[:unless].call(controller) if request_config[:unless]
+        if r
+          request_config[:for]
+        else
+          nil
+        end
+      else
+        request_config[:for]
+      end
+    end
+  end
+  
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'expiry_control'

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: expiry_control
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Urban Hafner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-28 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: urban@bettong.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- LICENSE
+- Rakefile
+- README.md
+- lib/expiry_control.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/msales/expiry_control
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: DSL to set expires headers for Rails apps
+test_files: []
+