display_case 0.0.7 → 0.0.8

data/README.md

@@ -9,7 +9,7 @@ If the Model is concerned with storing and manipulating business data, and the V
 
 The Exhibit object is so named because it is like a museum display case for an artifact or a work of art. It does not obscure any of the features of the object being presented. Rather, it tries to showcase the object in the best light to a human audience, while also presenting meta-information about the object and cross-references to other objects in the museum's collection.
 
-Technically, exhibit objects are a type of Decorator specialized for presenting models to an end user. 
+Technically, exhibit objects are a type of Decorator specialized for presenting models to an end user.
 
 For the purposes of clarity, here's a rundown of the essential characteristics of an Exhibit object.
 
@@ -32,10 +32,10 @@ Your exhibits will look something like this:
 # app/exhibits/league_exhibit.rb
 
 class LeagueExhibit < DisplayCase::Exhibit
-  def self.applicable_to?(object, context) 
+  def self.applicable_to?(object, context)
     object.class.name == 'League'
   end
-  
+
   def render_icon(template)
     template.render(partial: 'leagues/icon', locals: {league: self})
   end
@@ -49,11 +49,11 @@ class LeaguesController < ApplicationController
   include DisplayCase::ExhibitsHelper
   # ...
   def index
-    # display_case automatically wraps the individual objects contained in 
+    # display_case automatically wraps the individual objects contained in
     # an Enumerable or ActiveRecord::Relation collections
-    @leagues = exhibit(League.all) 
+    @leagues = exhibit(League.all)
   end
-  
+
   def show
     # of course it will also wrap your individual objects
     @league = exhibit(League.find(params[:id]))
@@ -64,7 +64,7 @@ end
 Finally, in your view, you can use your Exhibit:
 ```
 <!-- app/views/leagues/index.html.erb -->
-<% @leagues.each do |league| %> 
+<% @leagues.each do |league| %>
   <%= league.render_icon(self) %> <!-- self is this "template", the parameter to the method we defined in LeagueExhibit -->
 <% end %>
 ```
@@ -77,6 +77,7 @@ Several configuration options can be set via an initializer:
 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).
+1. `logging_enabled` Setting this to `true` will provide debug information about exhibits to the Rails logger, but may adversely affect performance when many objects are being exhibited.
 
 An example `initializers/display_case.rb`
 ```
@@ -85,26 +86,27 @@ DisplayCase.configure do |config|
   config.explicit = true
   config.exhibits = [MyFirstExhibit,MySecondExhibit]
   config.cache_store = Rails.configuration.action_controller.perform_caching ? Rails.cache : nil
+  config.logging_enabled = false
 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 
+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: 
+Use the cache like you would in a Rails controller:
 
 ```ruby
 class LeagueExhibit < DisplayCase::Exhibit
-  def self.applicable_to?(object, context) 
+  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 
+    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
@@ -117,4 +119,4 @@ 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
+See this issue for the reason: https://github.com/objects-on-rails/display-case/issues/8

data/lib/display_case/configuration.rb

@@ -24,17 +24,25 @@ module DisplayCase
     # A cache store which responds to `fetch(key, options, &block)`
     attr_accessor :cache_store
 
+    # A boolean indicating whether or not to log to the Rails logger
+    attr_accessor :logging_enabled
+
     def initialize
       @definition_file_paths = %w(app/exhibits)
       @explicit = false
       @exhibits = []
       @cache_store = nil
+      @logging_enabled = false
     end
 
     def explicit?
       explicit
     end
 
+    def logging_enabled?
+      defined? ::Rails and logging_enabled
+    end
+
     def exhibits
       [DisplayCase::Exhibit::Exhibited,DisplayCase::BasicExhibit,DisplayCase::EnumerableExhibit] + @exhibits
     end

data/lib/display_case/exhibit.rb

@@ -23,20 +23,32 @@ module DisplayCase
 
     def self.exhibit(object, context=nil)
       return object if exhibited_object?(object)
-      if defined? ::Rails
+      if DisplayCase.configuration.logging_enabled?
         ::Rails.logger.debug "Registered exhibits: #{@@exhibits}"
         ::Rails.logger.debug "Exhibiting #{object.inspect}"
         ::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)
-      (unsimilar+similar).inject(object) do |object, exhibit_class|
-          exhibit_class.exhibit_if_applicable(object, context)
+      similar, unsimilar = partition_by_name(exhibits, context)
+
+      # done w/ unsimilar first since the last applied exhibit is the top-most one
+      (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
+        ::Rails.logger.debug "Exhibits applied: #{obj.inspect_exhibits}" if DisplayCase.configuration.logging_enabled?
+      end
+    end
+
+    def self.partition_by_name(exhibits, context=nil)
+      return [], exhibits if DisplayCase.configuration.explicit? || context.nil? || context.class.name.nil?
+
+      exhibits.partition do |exhibit_class|
+        exhibit_name = exhibit_class.name.to_s.downcase.gsub("exhibit", "")
+        exhibit_name.length > 0 && context.class.name.downcase.include?(exhibit_name)
       end
     end
+    private_class_method :partition_by_name
 
     def self.exhibit_if_applicable(object, context)
       if applicable_to?(object, context)

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 if Rails.env.development?
+      DisplayCase.find_definitions if Rails.env.development? || Rails.env.test?
     end
   end
 end

metadata

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