catche 0.2.4 → 0.2.5

data/README.md

@@ -9,6 +9,10 @@ Add this to your Gemfile and run `bundle`.
 gem "catche"
 ```
 
+## Troubleshooting
+
+This gem is still in beta (v0.x), this means that certain structures, especially storing data, may change. If you're experiencing problems please try clearing the cache using `Rails.cache.clear`. If that doesn't work please open up a new issue.
+
 ## Controller caching
 
 Catche supports both action and page caching using the Rails methods `caches_action` and `caches_page`.
@@ -145,6 +149,30 @@ class Task < ActiveRecord::Base
 end
 ```
 
+## View caching
+
+Catche supports view caching using the Rails methods `cache`.
+
+### Resource caching
+
+```ruby
+<% catche @project do %>
+  <%= @project.title %>
+<% end %>
+```
+
+### Collection caching
+
+Because a collection may be an array, you will need to pass along the configured model you wish to use;
+
+```ruby
+<% catche @projects, :model => Project do %>
+  <% @projects.each do |project| %>
+    <%= project.title %>
+  <% end %>
+<% end %>
+```
+
 ## How does it work?
 
 Catche intercepts a cached value and tags this value using the unique identifier for the given/loaded resource or collection. Once a resource expires it will expire the tagged cached values, such as the resource itself and the collection it belongs to.
@@ -176,7 +204,7 @@ Want support for more? Just fork and open up a pull request.
 
 ## Roadmap
 
-* View cache
+No features planned for now. In need of a feature? Please open up an issue, or pull request.
 
 ## License
 

data/lib/catche.rb

@@ -5,17 +5,18 @@ require 'catche/model'
 require 'catche/tag'
 require 'catche/resource_loader'
 require 'catche/expire'
+require 'catche/view_helpers'
 
 module Catche
 
   extend self
 
-  def initialize_defaults
-    
-  end
+  class << self
+
+    def adapter
+      Catche::Adapter::Base
+    end
 
-  def adapter
-    Catche::Adapter::Base
   end
 
 end

data/lib/catche/controller.rb

@@ -54,5 +54,3 @@ module Catche
 
   end
 end
-
-ActionController::Base.send :include, Catche::Controller

data/lib/catche/model.rb

@@ -74,5 +74,3 @@ module Catche
 
   end
 end
-
-ActiveRecord::Base.send :include, Catche::Model

data/lib/catche/railtie.rb

@@ -1,7 +1,9 @@
 module Catche
   class Railtie < ::Rails::Railtie
     initializer "include.catche" do |app|
-      Catche.initialize_defaults
+      ActionController::Base.send :include, Catche::Controller
+      ActiveRecord::Base.send     :include, Catche::Model
+      ActionView::Base.send       :include, Catche::ViewHelpers
     end
   end
 end

data/lib/catche/version.rb

@@ -1,3 +1,3 @@
 module Catche
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/lib/catche/view_helpers.rb

@@ -0,0 +1,37 @@
+module Catche
+  module ViewHelpers
+
+    # Caches a fragment
+    # See ActionView `cache` for more information
+    #
+    #   <% catche @project do %>
+    #     <%= @project.title %>
+    #   <% end %>
+    #
+    #   <% catche @projects, :model => Project do %>
+    #     <% @projects.each do |project| %>
+    #       <%= project.title %>
+    #     <% end %>
+    #   <% end %>
+    def catche(model_or_resource, options={}, &block)
+      tags    = []
+      name    = Catche::Tag.join 'fragment', model_or_resource.hash
+      key     = ActiveSupport::Cache.expand_cache_key name, :views
+      object  = options[:model] || model_or_resource
+
+      if object.respond_to?(:catche_tag)
+        if object.respond_to?(:new)
+          tags = Catche::Tag::Collect.collection(controller, object)[:set]
+        else
+          tags = Catche::Tag::Collect.resource(object)[:set]
+        end
+      end
+
+      Catche::Tag.tag_view! key, *tags if tags.any?
+
+      cache name, options, &block
+    end
+    alias :catches_fragment :catche
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: catche
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-25 00:00:00.000000000Z
+date: 2012-07-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70111289680960 !ruby/object:Gem::Requirement
+  requirement: &70289602354040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70111289680960
+  version_requirements: *70289602354040
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70111289680540 !ruby/object:Gem::Requirement
+  requirement: &70289592727760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70111289680540
+  version_requirements: *70289592727760
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70111289680080 !ruby/object:Gem::Requirement
+  requirement: &70289592727300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70111289680080
+  version_requirements: *70289592727300
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70111289679660 !ruby/object:Gem::Requirement
+  requirement: &70289592726880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70111289679660
+  version_requirements: *70289592726880
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70111289679240 !ruby/object:Gem::Requirement
+  requirement: &70289592726460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70111289679240
+  version_requirements: *70289592726460
 - !ruby/object:Gem::Dependency
   name: guard-spork
-  requirement: &70111289678820 !ruby/object:Gem::Requirement
+  requirement: &70289592726040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70111289678820
+  version_requirements: *70289592726040
 description: ''
 email:
 - mail@arjen.me
@@ -98,6 +98,7 @@ files:
 - lib/catche/tag/collect.rb
 - lib/catche/tag.rb
 - lib/catche/version.rb
+- lib/catche/view_helpers.rb
 - lib/catche.rb
 - lib/tasks/catche_tasks.rake
 - MIT-LICENSE