showcase 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2dac659595ecfefe450c2e7b15134928cfb092f
-  data.tar.gz: 894b2b499088e50f4c1d6928ae318935678048b1
+  metadata.gz: 0c3e2b2cefd111fc7d1a066a4d9391e196292ecc
+  data.tar.gz: 6aeeda275c85e39770048b89ae9b17c747209bd7
 SHA512:
-  metadata.gz: ede80b6f7826d8899ae55dfc64ed0c651ec2f7f1fb8b694cf93520299b02992bc5e87f0761a3797feb066105a1ab754af8f1b9aa90af6b8ef352f5b9e59eb778
-  data.tar.gz: 6b2faaa1ad5d27333be12c34748da6263ff18ed61305ecc47d7289453a4d968f42910f70a3bd41f739aec30d1701dede0cec2bb3591a7d8ce27e99771832ad90
+  metadata.gz: 0551db2643cffe9fa475f4c3e8a31cc552788a8efd33ad3a2a809f1815dd79d2f31ce291a636dd6fb2b68330ce3c6916566966c1032e4b94d72bead873974a47
+  data.tar.gz: 9b94f78359199fd20804d1903420e314eed8ece8e8b2a8a18bd8d6158a440d6ed874aac09f38518a4b9c85ab5834994131d4d613f5803fd4e0990f87fda8c41c

data/README.md

@@ -1,6 +1,17 @@
-# Showcase [![Build Status](https://travis-ci.org/welaika/showcase.png?branch=master)](https://travis-ci.org/welaika/showcase)
+# Showcase [![Build Status](https://travis-ci.org/welaika/showcase.png?branch=master)](https://travis-ci.org/welaika/showcase) [![Coverage Status](https://coveralls.io/repos/welaika/showcase/badge.png?branch=master)](https://coveralls.io/r/welaika/showcase)
 
-A simple (< 100 lines of code) but powerful presenter implementation. Framework agnostic: works with Rails, Padrino or simply Sinatra.
+A simple (< 100 lines of code) but powerful exhibit/presenter implementation. It's framework agnostic: works with Rails, Padrino or simply Sinatra.
+
+## Properties of the Exhibit pattern
+
+Citing [Avdi's introductory post](http://devblog.avdi.org/2012/06/04/displaycase-gem-now-available/):
+
+* **It wraps a single model instance.** Not an assortment of objects.
+* **It is a true Decorator.** All unrecognized messages are passed through to the underlying object. This facilitates a gradual migration to the use of Exhibits to encapsulate presentation knowledge, since they can be layered onto models without any change to the existing views. It also enables multiple Exhibits to be layered onto an object, each handling different aspects of presentation.
+* **It brings together a model and a context.** Exhibits need a reference to a “context” object—either a controller or a view context—in order to be able to render templates as well as construct URLs for the object or related resources.
+* **It encapsulates decisions about how to render an object.** The tell-tale of an Exhibit is telling an object “render yourself”, rather than explicitly rendering a template and passing the object in as an argument.
+* **It may modify the behavior of an object.** For instance, an Exhibit might impose a scope on a `Blog#entries` association which only returns entries that are visible to the current user (as determined from the Exhibit’s controller context). Or it might reformat the return value of a `#social_security_number` method to include dashes and have all but the last four digits obscured: `***-**-5678`.
+* **There is a many-to-many relationship between model classes and exhibit classes.** One generic exhibit class may apply to several different types of model. Other exhibits may be specific, not just to a model, but to a model in a particular state, or within a particular viewing context.
 
 ## Installation
 
@@ -50,7 +61,7 @@ present(person, AdminPresenter) # => returns an AdminPresenter instance
 present(person, PersonPresenter, context)
 
 # maps each person in the collection with a presenter
-present_collection([ people ]) # => returns an array of PeoplePresenters
+present_collection([person]) # => returns an array of PersonPresenters
 ```
 
 Define your presenters i.e. in a `app/presenters` folder:
@@ -60,6 +71,9 @@ class ProjectPresenter < Showcase::Presenter
   # automatically wraps the attribute into a PersonPresenter
   presents :person
 
+  # automatically wraps the attribute into an AdminPresenter
+  presents :person, with: AdminPresenter
+
   # expects project.task to return an enumerable. automatically wraps each task in a TaskPresenter presenter
   presents_collection :tasks
 

data/lib/showcase/presenter.rb

@@ -1,5 +1,7 @@
 require 'delegate'
 require 'showcase/helpers'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/hash/keys'
 
 module Showcase
   class Presenter < SimpleDelegator
@@ -28,18 +30,26 @@ module Showcase
       object.instance_of?(klass)
     end
 
-    def self.presents(*attrs)
-      attrs.each do |attr|
+    def self.presents(*args)
+      options = args.extract_options!
+      options.assert_valid_keys(:with)
+      presenter_klass = options.fetch(:with, nil)
+
+      args.each do |attr|
         define_method attr do
-          present(object.send(attr), nil, view_context)
+          present(object.send(attr), presenter_klass, view_context)
         end
       end
     end
 
-    def self.presents_collection(*attrs)
-      attrs.each do |attr|
+    def self.presents_collection(*args)
+      options = args.extract_options!
+      options.assert_valid_keys(:with)
+      presenter_klass = options.fetch(:with, nil)
+
+      args.each do |attr|
         define_method attr do
-          present_collection(object.send(attr), nil, view_context)
+          present_collection(object.send(attr), presenter_klass, view_context)
         end
       end
     end

data/lib/showcase/version.rb

@@ -1,3 +1,4 @@
 module Showcase
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end
+

data/showcase.gemspec

@@ -4,20 +4,21 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'showcase/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "showcase"
+  gem.name          = 'showcase'
   gem.version       = Showcase::VERSION
-  gem.authors       = ["Stefano Verna"]
-  gem.email         = ["stefano.verna@welaika.com"]
+  gem.authors       = ['Stefano Verna']
+  gem.email         = ['stefano.verna@welaika.com']
   gem.description   = %q{A barebone and framework agnostic presenter implementation}
   gem.summary       = %q{A barebone and framework agnostic presenter implementation}
-  gem.homepage      = "https://github.com/welaika/showcase"
+  gem.homepage      = 'https://github.com/welaika/showcase'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
-  gem.add_dependency "activesupport"
-  gem.add_development_dependency "rspec"
+  gem.add_dependency 'activesupport'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'coveralls'
 end
 

data/spec/fixtures.rb

@@ -29,8 +29,14 @@ class PersonPresenter < Showcase::Presenter
   end
 end
 
+class AdminPresenter < PersonPresenter
+  def bold_name
+    h.bold("Admin #{object.name}")
+  end
+end
+
 class ProjectPresenter < Showcase::Presenter
-  presents :owner
+  presents :owner, with: AdminPresenter
   presents_collection :collaborators
 
   def name
@@ -53,3 +59,4 @@ class Context
     "**#{text}**"
   end
 end
+

data/spec/showcase_spec.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'showcase'
 require_relative './fixtures'
 
@@ -15,6 +18,14 @@ describe Showcase::Presenter do
     subject.class.should == Project
   end
 
+  it 'should be kind of original class' do
+    subject.should be_kind_of Project
+  end
+
+  it 'should be instance of original class' do
+    subject.should be_instance_of Project
+  end
+
   it 'delegates methods to object' do
     subject.dummy.should == 'foobar'
   end
@@ -38,7 +49,7 @@ describe Showcase::Presenter do
       subject.owner.sex.should == 'male'
     end
     it 'passes the context' do
-      subject.owner.bold_name.should == '**Stefano Verna**'
+      subject.owner.bold_name.should == '**Admin Stefano Verna**'
     end
   end
 
@@ -66,7 +77,7 @@ describe Showcase::Helpers do
       context.present(object, ProjectPresenter).should == 'Presenter'
     end
     it 'the context to use can be specified as third parameter' do
-      different_context = stub
+      different_context = double
       context.present(object, ProjectPresenter, different_context).view_context.should == different_context
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: showcase
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Stefano Verna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-19 00:00:00.000000000 Z
+date: 2013-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A barebone and framework agnostic presenter implementation
 email:
 - stefano.verna@welaika.com
@@ -87,3 +101,4 @@ summary: A barebone and framework agnostic presenter implementation
 test_files:
 - spec/fixtures.rb
 - spec/showcase_spec.rb
+has_rdoc: