cache_trasher 0.0.1

data/lib/cache_trasher.rb

@@ -0,0 +1,58 @@
+# CacheTrasher
+module ActionController::Caching::Pages
+  module ClassMethods
+  
+    def trash_cache(path, options)
+      puts "[CacheTrasher] ActionController::Base.perform_caching is disabled, exiting." and return unless perform_caching
+
+      # check if the action or controller has been saved as a cached file
+      # as opposed to just a directory.
+      paths = [path.chomp('/')]
+      # if options includes format(s), then use those, otherwise use the standard page_cache_extension to pick stuff up
+      if options[:format]
+        options[:format].to_a.each do |format|
+          paths << "#{paths[0]}.#{format}" if File.exist?("#{page_cache_directory}/#{paths[0]}.#{format}")
+        end
+      else
+        paths << "#{paths[0]}#{page_cache_extension}" if File.exist?("#{page_cache_directory}/#{paths[0]}#{page_cache_extension}")
+      end
+      paths.each do |p|
+        p = File.join(page_cache_directory, p)
+        unless [p, p.chomp, p.chomp('/'), p.chomp('/*')].include? Rails.public_path 
+          puts "[CacheTrasher] Removing cache file or directory: #{p}"
+          begin
+            FileUtils.rm_r(p) 
+            puts "[CacheTrasher] Expired #{p}"
+          rescue Errno::ENOENT
+            puts "[CacheTrasher] Failed to expire #{p}"
+          end
+        else
+          # drop a long message into the log if they try to delete RAILS_ROOT/public
+          puts "[CacheTrasher] Something is misconfigured.  Check your environment log for more info."
+          File.open("#{RAILS_ROOT}/vendor/plugins/cache_trasher/warning.txt", 'r') { |f| logger.info f.read }
+        end
+      end
+    end
+    
+  end
+  
+  def trash_cache(supplied_path = "", options = {})
+    return unless perform_caching
+    
+    path = case supplied_path
+    when Hash
+      # Note this part of the url_for documentation:
+      # 
+      # If the controller name begins with a slash no defaults are used:
+      # url_for :controller => '/home'
+      # In particular, a leading slash ensures no namespace is assumed. Thus, while url_for :controller => 'users' 
+      # may resolve to Admin::UsersController if the current controller lives under that module, url_for :controller => '/users' 
+      # ensures you link to ::UsersController no matter what.
+      url_for(supplied_path.merge(:only_path => true, :skip_relative_url_root => true))
+    when String
+      supplied_path
+    end
+    
+    self.class.trash_cache(path, options)
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: cache_trasher
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sean Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-07 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Convenience methods for removing page cache files in Rails
+email: 
+- sean@factore.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/cache_trasher.rb
+has_rdoc: true
+homepage: http://github.com/factore/cache_trasher
+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: Convenience methods for removing page cache files in Rails
+test_files: []
+