display_case 0.0.6 → 0.0.7

data/README.md

@@ -32,8 +32,6 @@ Your exhibits will look something like this:
 # app/exhibits/league_exhibit.rb
 
 class LeagueExhibit < DisplayCase::Exhibit
-  # Note: the context parameter is new in the master branch, not yet released in the gem. 
-  # If you get an argument error, that's why
   def self.applicable_to?(object, context) 
     object.class.name == 'League'
   end
@@ -78,6 +76,7 @@ Several configuration options can be set via an initializer:
 1. `definition_file_paths` Because Rails lazily-loads files, in development mode DisplayCase will search /app/exhibits to load the Exhibits found there. If your Exhibits are elsewhere, you can set `config.definition_file_paths = ['list/of/directories', 'to/find/exhibits']` in your initializers/display_case.rb.
 1. `explicit` By default this option is false and Exhibits will be dynamically added via the inherited callback.
 1. `exhibits` If `explicit` is true you must explicitly set the Exhibits you wish to use in the order you want them evaluated. You can set `config.exhibits = [AnExhibit,AnotherExhibit]` in your initializers/display_case.rb.
+1. `cache_store` If you configure a cache store, you can use it by calling the `cache` method in your Exhibits (see below).
 
 An example `initializers/display_case.rb`
 ```
@@ -85,9 +84,37 @@ DisplayCase.configure do |config|
   config.definition_file_paths = ['app/exhibits','some/other/path']
   config.explicit = true
   config.exhibits = [MyFirstExhibit,MySecondExhibit]
+  config.cache_store = Rails.configuration.action_controller.perform_caching ? Rails.cache : nil
 end
 ```
 
+Caching
+-------
+You can cache the results of an operation in your exhibits by configuring DisplayCase to use a cache store, and then using the `cache` method.
+If you do this, you ought not use a real cache in development mode, since you'll likely want to see changes you're making to code, which of 
+course won't happen if you cache the results.
+
+Use the cache like you would in a Rails controller: 
+
+```ruby
+class LeagueExhibit < DisplayCase::Exhibit
+  def self.applicable_to?(object, context) 
+    object.class.name == 'League'
+  end
+  
+  def render(context)
+    cache key, options={} do 
+      # something that takes a long while, which might make you want 
+      # to cache this call to render
+      context.render(partial: 'leagues/icon', locals: {league: self})
+    end
+  end
+end
+```
+
+See [How key-based cache expiration works](http://37signals.com/svn/posts/3113-how-key-based-cache-expiration-works) for examples on
+how to choose good keys.
+
 Wrong url with extra parameters using an exhibited model?
 ------------------
 See this issue for the reason: https://github.com/objects-on-rails/display-case/issues/8

data/lib/display_case.rb

@@ -4,4 +4,3 @@ require_relative 'display_case/enumerable_exhibit'
 require_relative 'display_case/basic_exhibit'
 require_relative 'display_case/exhibits_helper'
 require_relative 'display_case/find_definitions'
-

data/lib/display_case/configuration.rb

@@ -21,10 +21,14 @@ module DisplayCase
     # existing file will be loaded.
     attr_accessor :definition_file_paths
 
+    # A cache store which responds to `fetch(key, options, &block)`
+    attr_accessor :cache_store
+
     def initialize
       @definition_file_paths = %w(app/exhibits)
       @explicit = false
       @exhibits = []
+      @cache_store = nil
     end
 
     def explicit?

data/lib/display_case/enumerable_exhibit.rb

@@ -45,6 +45,11 @@ module DisplayCase
     def to_ary
       self
     end
+    
+    # See https://github.com/objects-on-rails/display-case/issues/27
+    def to_json
+      as_json.to_json
+    end
 
     def render(template)
       inject(ActiveSupport::SafeBuffer.new) { |output,element|

data/lib/display_case/exhibit.rb

@@ -29,9 +29,10 @@ module DisplayCase
         ::Rails.logger.debug "Exhibit context: #{context}"
       end
 
+      similar, unsimilar = exhibits.partition { |exhibit_class| context and exhibit_class.name and context.class.name and context.class.name.downcase.include?(exhibit_class.name.to_s.downcase.gsub("exhibit", "")) }
       object = BasicExhibit.new(Exhibited.new(object, context), context)
-      exhibits.inject(object) do |object, exhibit_class|
-        exhibit_class.exhibit_if_applicable(object, context)
+      (unsimilar+similar).inject(object) do |object, exhibit_class|
+          exhibit_class.exhibit_if_applicable(object, context)
       end.tap do |obj|
         ::Rails.logger.debug "Exhibits applied: #{obj.inspect_exhibits}" if defined? ::Rails
       end
@@ -128,6 +129,14 @@ module DisplayCase
     def exhibited?
       true
     end
+    
+    def cache(key, options = {}, &block)
+      if DisplayCase.configuration.cache_store
+        DisplayCase.configuration.cache_store.fetch(key, options, &block)
+      else
+        yield
+      end
+    end
 
     private
 

data/lib/display_case/railtie.rb

@@ -3,7 +3,7 @@ module DisplayCase
     # http://guides.rubyonrails.org/configuring.html#initialization-events
     # "to_prepare will run upon every request in development, but only once (during boot-up) in production and test."
     config.to_prepare do
-      DisplayCase.find_definitions
-    end    
+      DisplayCase.find_definitions if Rails.env.development?
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: display_case
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-14 00:00:00.000000000Z
+date: 2013-05-29 00:00:00.000000000Z
 dependencies: []
 description: An implementation of the Exhibit pattern, as described in Objects on
   Rails