display_case 0.0.2 → 0.0.3

data/README.md

@@ -7,7 +7,7 @@ Description
 -----------
 If the Model is concerned with storing and manipulating business data, and the View is concerned with displaying it, you can think of the Exhibit as standing between them deciding which data to show, and in what order. It may also provide some extra presentation-specific information (such as the specific URLs for related resources) which the business model has no knowledge of by itself.
 
-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 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.
+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. 
 
@@ -71,4 +71,17 @@ Finally, in your view, you can use your Exhibit:
 
 Configuration
 -------------
-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 `DisplayCase.definition_file_paths = ['list/of/directories', 'to/find/exhibits']` in your config/environments/development.rb.
+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.
+
+An example `initializers/display_case.rb`
+```
+DisplayCase.configure do |config|
+  config.definition_file_paths = ['app/exhibits','some/other/path']
+  config.explicit = true
+  config.exhibits = [MyFirstExhibit,MySecondExhibit]
+end
+```

data/lib/display_case.rb

@@ -1,3 +1,4 @@
+require_relative 'display_case/configuration'
 require_relative 'display_case/exhibit'
 require_relative 'display_case/enumerable_exhibit'
 require_relative 'display_case/exhibits_helper'

data/lib/display_case/configuration.rb

@@ -0,0 +1,44 @@
+require_relative 'enumerable_exhibit'
+
+module DisplayCase
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    # A boolean indicating whether the Exhibits will be explicitly listed in order or
+    # dynamically collected with the inherited callback. By default, this is false
+    # and the list will be generated via the inherited callback.
+    attr_accessor :explicit
+    
+    # An Array of strings specifying locations that should be searched for
+    # exhibit classes and definitions. By default, "/app/exhibits" will be searched and
+    # existing file will be loaded.
+    attr_accessor :definition_file_paths
+
+    def initialize
+      @definition_file_paths = %w(app/exhibits)
+      @explicit = false
+      @exhibits = []
+    end
+
+    def explicit?
+      explicit
+    end
+
+    def exhibits
+      [DisplayCase::Exhibit::Exhibited,DisplayCase::EnumerableExhibit] + @exhibits
+    end
+
+    def exhibits=(val)
+      @exhibits = Array(val)
+    end
+  end
+
+  configure {}
+end

data/lib/display_case/exhibit.rb

@@ -1,13 +1,18 @@
 require 'delegate'
 require 'active_support/core_ext'
 require 'display_case/railtie' if defined?(Rails)
+require_relative 'configuration'
 
 module DisplayCase
   class Exhibit < SimpleDelegator
     @@exhibits = []
   
     def self.exhibits
-      @@exhibits
+      if DisplayCase.configuration.explicit?
+        DisplayCase.configuration.exhibits
+      else
+        @@exhibits
+      end
     end
   
     def self.inherited(child)

data/lib/display_case/find_definitions.rb

@@ -1,15 +1,7 @@
 module DisplayCase
-  class << self
-    # An Array of strings specifying locations that should be searched for
-    # exhibit classes and definitions. By default, "/app/exhibits" will be searched and
-    # existing file will be loaded.
-    attr_accessor :definition_file_paths
-  end
-
-  self.definition_file_paths = %w(app/exhibits)
 
   def self.find_definitions
-    absolute_definition_file_paths = definition_file_paths.map {|path| File.expand_path(path) }
+    absolute_definition_file_paths = configuration.definition_file_paths.map {|path| File.expand_path(path) }
 
     absolute_definition_file_paths.uniq.each do |path|
       load("#{path}.rb") if File.exists?("#{path}.rb")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: display_case
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-23 00:00:00.000000000 Z
+date: 2012-06-06 00:00:00.000000000Z
 dependencies: []
 description: An implementation of the Exhibit pattern, as described in Objects on
   Rails
@@ -19,6 +19,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/display_case/configuration.rb
 - lib/display_case/enumerable_exhibit.rb
 - lib/display_case/exhibit.rb
 - lib/display_case/exhibits_helper.rb
@@ -47,7 +48,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
 summary: An implementation of the Exhibit pattern, as described in Objects on Rails