display_case 0.1.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8309a666cba84ff544fb5cf9d97914bc228b8780
-  data.tar.gz: 821fe5d1b63f8fef408206a0d9bfe31c46c89a33
+SHA256:
+  metadata.gz: 945dfe570fe0c95e52b65e0f673ebd6226e2c82eaef75d9233af833cf2565ef4
+  data.tar.gz: bf0a1fe16e46ba68aeb290352fe2cd75831d1e6ba517011bd61896d7b9ec7e18
 SHA512:
-  metadata.gz: 0615b6350ce33c59cd1c912769574502f06ed84d2957889a8c7c1682d0cc84a0bfffe6fbaa88fa849a2cee03784d872e58c71ae6b5f9c3fc7755b9141f520109
-  data.tar.gz: c8ea968c3df2d1fbef07c6e2f1b95b8af0fdaa1eb54252b3315f23c1295a74a238d8c9adf91edd275cdf78f667bf46115411422281b241110129324a2789241f
+  metadata.gz: 8d93788b405a1273e46e59d341ca74f7b8570b5861c65f59d42056de0bb3d5cce2ad1cdd62dc5ab4fdfefa77befb60a2b890b5ac453afd76111dae9d403f6919
+  data.tar.gz: d59cf587424e12bb5572f6662572dc7236f2f2cd3a559136c52cea842e62ebd3aa8cdaebc759bf9274a1f7af51602e9f50a6ce4cfd9f9d4bcce7fc1fc3b0d2d4

data/README.md

@@ -133,3 +133,25 @@ 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
+
+
+TypeError: superclass mismatch for class MyExhibit
+------------------
+This error is common in development mode in code bases which `ExhibitB` inherits from `ExhibitA`, which inherits from `DisplayCase::Exhibit`. 
+DisplayCase is doing a lot of messing around with your exhibits to make them respond appropriately as if they were the object you're exhibiting,
+and that is _normally_ the cause of this error if you're using inheritance among exhibits.
+
+However, since it's possible you could actually be inadvertently having a superclass mismatch, the recommended way around this error is to avoid 
+the situation.
+
+In case you're having this error, and you're confident that is _not_ happening, we do provide a configuration option to catch this 
+error and reload the class anyway. :warning: But be warned, if it is a legitimate superclass mismatch, you won't catch it with 
+this option turned on! :warning:
+
+To turn on this option, in your DisplayCase initializer:
+
+```ruby
+DisplayCase.configure do |config|
+  config.swallow_superclass_mismatch_for_exhibits = true
+end
+```

data/lib/display_case/configuration.rb

@@ -1,5 +1,3 @@
-require_relative 'enumerable_exhibit'
-
 module DisplayCase
   class << self
     attr_accessor :configuration
@@ -31,6 +29,10 @@ module DisplayCase
     # context should be favored over other exhibits. By default, this is true
     attr_accessor :smart_matching
 
+    # A boolean indicating whether DisplayCase will swallow superclass mismatch
+    # errors (see README for more info). By default, this is false.
+    attr_accessor :swallow_superclass_mismatch_for_exhibits
+
     def initialize
       @definition_file_paths = %w(app/exhibits)
       @explicit = false
@@ -38,6 +40,7 @@ module DisplayCase
       @cache_store = nil
       @logging_enabled = false
       @smart_matching = true
+      @swallow_superclass_mismatch_for_exhibits = false
     end
 
     def explicit?
@@ -48,6 +51,10 @@ module DisplayCase
       smart_matching
     end
 
+    def swallow_superclass_mismatch_for_exhibits?
+      swallow_superclass_mismatch_for_exhibits
+    end
+
     def logging_enabled?
       defined? ::Rails and logging_enabled
     end
@@ -58,6 +65,8 @@ module DisplayCase
 
     def exhibits=(val)
       @exhibits = Array(val)
+      DisplayCase::Exhibit.initialize_exhibits
+      @exhibits
     end
   end
 

data/lib/display_case/enumerable_exhibit.rb

@@ -47,8 +47,8 @@ module DisplayCase
     end
 
     # See https://github.com/objects-on-rails/display-case/issues/27
-    def to_json
-      as_json.to_json
+    def to_json(*args)
+      as_json(*args).to_json(*args)
     end
 
     def render(template, options = {})

data/lib/display_case/exhibit.rb

@@ -1,4 +1,5 @@
 require 'delegate'
+require 'active_support'
 require 'active_support/core_ext'
 require 'display_case/railtie' if defined?(::Rails)
 require_relative 'configuration'
@@ -7,18 +8,22 @@ require_relative 'name_class_comparator'
 
 module DisplayCase
   class Exhibit < SimpleDelegator
-    @@exhibits = []
+    def self.initialize_exhibits
+      @@exhibits = []
+      @@exhibits = DisplayCase.configuration.exhibits.dup if DisplayCase.configuration.explicit?
+    end
+    initialize_exhibits
 
     def self.exhibits
-      if DisplayCase.configuration.explicit?
-        DisplayCase.configuration.exhibits
-      else
-        @@exhibits
-      end
+      @@exhibits
     end
 
     def self.inherited(child)
-      @@exhibits << child
+      if idx = @@exhibits.map(&:name).index(child.name)
+        @@exhibits[idx] = child
+      elsif !DisplayCase.configuration.explicit?
+        @@exhibits << child
+      end
     end
 
     def self.exhibit(object, context=nil)

data/lib/display_case/find_definitions.rb

@@ -1,5 +1,4 @@
 module DisplayCase
-
   def self.find_definitions
     absolute_definition_file_paths = configuration.definition_file_paths.map {|path| File.expand_path(path) }
 
@@ -18,9 +17,36 @@ module DisplayCase
   private
   def self.display_case_load(file)
     @file_changes ||= {}
-    if File.exists?(file) && (@file_changes[file].to_i < (mtime = File.mtime(file).to_i))
-      load file
-      @file_changes[file] = mtime
+    if File.exist?(file) && (@file_changes[file].to_i < (mtime = File.mtime(file).to_i))
+      begin
+        load file
+        @file_changes[file] = mtime
+      rescue TypeError => error
+        klass = find_class_candidates(error.message).first # TODO: Is there a way to make this work correctly if there are multiple candidates?
+        if klass.ancestors.include?(DisplayCase::Exhibit) && configuration.swallow_superclass_mismatch_for_exhibits?
+          delimiter = '::'
+          namespace, klass_name =
+            if klass.name.index(delimiter)
+              klass_names = klass.name.split(delimiter)
+              namespace_name = klass_names[0..-2].join(delimiter).constantize
+              klass_name = klass_names.last
+              [namespace_name, klass_name]
+            else
+              [Object, klass.name]
+            end
+          namespace.send(:remove_const, klass_name.to_sym)
+          retry
+        else
+          raise error
+        end
+      end
     end
   end
+
+  def self.find_class_candidates(error_message)
+    klass_name = error_message.gsub("superclass mismatch for class ", "")
+    [klass_name.constantize]
+  rescue NameError
+    ObjectSpace.each_object(Class).select{|c| c.to_s.split('::').last == klass_name}
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: display_case
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Avdi Grimm
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-10-08 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies: []
 description: An implementation of the Exhibit pattern, as described in Objects on
   Rails
@@ -33,7 +33,7 @@ files:
 homepage: https://github.com/objects-on-rails/display-case
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -48,10 +48,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: An implementation of the Exhibit pattern, as described in Objects on Rails
 test_files: []
-has_rdoc: