display_case 0.0.8 → 0.0.9

data/README.md

@@ -78,6 +78,7 @@ Several configuration options can be set via an initializer:
 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.
+1. `smart_matching`  A boolean indicating whether Exhibits with names that are similar to context should be favored over other exhibits. By default, this is true.
 
 An example `initializers/display_case.rb`
 ```

data/lib/display_case/basic_exhibit.rb

@@ -9,10 +9,6 @@ module DisplayCase
         partialize_name(__getobj__.class.name)
       end
     end
-
-    def render(template)
-      template.render(:partial => to_partial_path, :object => self)
-    end
   end
 end
 

data/lib/display_case/configuration.rb

@@ -27,18 +27,27 @@ module DisplayCase
     # A boolean indicating whether or not to log to the Rails logger
     attr_accessor :logging_enabled
 
+    # A boolean indicating whether Exhibits with names that are similar to
+    # context should be favored over other exhibits. By default, this is true
+    attr_accessor :smart_matching
+
     def initialize
       @definition_file_paths = %w(app/exhibits)
       @explicit = false
       @exhibits = []
       @cache_store = nil
       @logging_enabled = false
+      @smart_matching = true
     end
 
     def explicit?
       explicit
     end
 
+    def smart_matching?
+      smart_matching
+    end
+
     def logging_enabled?
       defined? ::Rails and logging_enabled
     end

data/lib/display_case/enumerable_exhibit.rb

@@ -7,7 +7,7 @@ module DisplayCase
     def self.applicable_to?(object, context=nil)
       # ActiveRecord::Relation, surprisingly, is not Enumerable. But it
       # behaves sufficiently similarly for our purposes.
-      object_is_any_of?(object, 'Enumerable', 'ActiveRecord::Relation')
+      object.respond_to?(:each)
     end
 
     # Wrap an Enumerable method which returns another collection
@@ -45,7 +45,7 @@ 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

data/lib/display_case/exhibit.rb

@@ -30,10 +30,9 @@ module DisplayCase
       end
 
       object = BasicExhibit.new(Exhibited.new(object, context), 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|
+      sorted_exhibits(context).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 DisplayCase.configuration.logging_enabled?
@@ -41,8 +40,6 @@ module DisplayCase
     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)
@@ -50,6 +47,21 @@ module DisplayCase
     end
     private_class_method :partition_by_name
 
+    def self.sorted_exhibits(context)
+      if smart_matching?(context)
+        similar, unsimilar = partition_by_name(exhibits, context)
+        unsimilar + similar
+      else
+        exhibits
+      end
+    end
+    private_class_method :sorted_exhibits
+
+    def self.smart_matching?(context)
+      DisplayCase.configuration.smart_matching? && !(DisplayCase.configuration.explicit? || context.nil? || context.class.name.nil?)
+    end
+    private_class_method :smart_matching?
+
     def self.exhibit_if_applicable(object, context)
       if applicable_to?(object, context)
         new(object, context)
@@ -107,15 +119,15 @@ module DisplayCase
     def class
       __getobj__.class
     end
-    
+
     alias_method :__kind_of__?, :kind_of?
     def kind_of?(klass)
       __getobj__.kind_of?(klass)
     end
-    
+
     alias_method :__is_a__?, :is_a?
     alias_method :is_a?, :kind_of?
-    
+
     alias_method :__instance_of__?, :instance_of?
     def instance_of?(klass)
       __getobj__.instance_of?(klass)
@@ -138,10 +150,14 @@ module DisplayCase
       "#{inspect_exhibits}(#{__getobj__.inspect})"
     end
 
+    def render(template)
+      template.render(:partial => to_partial_path, :object => self)
+    end
+
     def exhibited?
       true
     end
-    
+
     def cache(key, options = {}, &block)
       if DisplayCase.configuration.cache_store
         DisplayCase.configuration.cache_store.fetch(key, options, &block)

data/lib/display_case/name_class_comparator.rb

@@ -7,7 +7,26 @@ module DisplayCase
   class NameClassComparator
     def call(object, *classes)
       # Note that '&' is the set intersection operator for Arrays.
-      (classes.map(&:to_s) & object.class.ancestors.map(&:name)).any?
+      (classes.map(&:to_s) & object.class.ancestors.map {|c| name_for(c)}).any?
+    end
+
+    private
+    class ClassNameTracker
+      def initialize
+        @data = Hash.new {|h, k| h[k] = k.name}
+      end
+
+      def name_for(kls)
+        @data[kls]
+      end
+    end
+
+    def class_name_tracker
+      @class_name_tracker ||= ClassNameTracker.new
+    end
+
+    def name_for(cls)
+      class_name_tracker.name_for(cls)
     end
   end
 end

metadata

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