showcase 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 693362b089b6c475cdc2604804aa9f4b48d216ff
+  data.tar.gz: dcf7d634807feca412dfe996c1876f27dcf9476a
+SHA512:
+  metadata.gz: 893a1c780c5ade2491d71ee16f2a36726ef9d956188d0183fc7272d645ee805c5bc553a04f80cfb65aeec0b4e9220e6115583473295e9a85938e094b829eee47
+  data.tar.gz: 9793dce8c7bfafd7a05e1df6c8249ffb4a9cbb538f82e8a38ef972ef3bf3178712da947e0e5268b150f1c20180f5656950c39807a45c989f639166ee5ff70acd

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+script: "bundle exec rspec spec"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in basic_presenter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stefano Verna
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# Showcase [![Build Status](https://travis-ci.org/welaika/showcase.png?branch=master)](https://travis-ci.org/welaika/showcase)
+
+The most basic presenter implementation in town (< 100 lines of code). Framework agnostic, works with Rails, Padrino or simply Sinatra.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'showcase'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install showcase
+
+## Usage
+
+Include Showcase::Helpers as additional helper module.
+
+```ruby
+class ApplicationController < ActionController::Base
+  helper Showcase::Helpers
+end
+```
+
+You can now instantiate new presenters in your controller/views using the included helpers:
+
+```ruby
+# this is the object that needs to be presented
+person = Person.new
+
+# automatically infers presenter class to use based on person's class name
+present(person) # => returns a PersonPresenter instance
+
+# you can also explicitly tell what presenter to use
+present(person, AdminPresenter) # => returns an AdminPresenter instance
+
+# explicit presenter and context
+present(person, PersonPresenter, context)
+
+# maps each person in the collection with a presenter
+present_collection([ people ]) # => returns an array of PeoplePresenters
+```
+
+Define your presenters i.e. in a `app/presenters` folder:
+
+```ruby
+class ProjectPresenter < Showcase::Presenter
+  # automatically wraps the attribute into a PersonPresenter
+  presents :person
+
+  # expects project.task to return an enumerable. automatically wraps each task in a TaskPresenter presenter
+  presents_collection :tasks
+
+  # you can use `context`, or the shortcut `h`, to access the view context.
+  # `object` refers to the object being presented
+  def title
+    h.link_to object.title, object
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/showcase/presenter/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a presenter for a model with the given name.
+
+Example:
+    rails generate shocase:presenter user
+
+    This will create:
+        app/presenters/user_presenter.rb

data/lib/generators/showcase/presenter/presenter_generator.rb

@@ -0,0 +1,11 @@
+module Showcase
+  module Generators
+    class PresenterGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def create_presenter
+        template 'presenter.rb', File.join('app/presenters', class_path, "#{file_name}_presenter.rb")
+      end
+    end
+  end
+end

data/lib/generators/showcase/presenter/templates/presenter.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class <%= class_name %>Presenter < Showcase::Presenter
+end
+<% end -%>

data/lib/showcase/helpers.rb

@@ -0,0 +1,18 @@
+module Showcase
+  module Helpers
+    def present(obj, klass = nil, context = self)
+      if obj.is_a? ::Showcase::Presenter
+        obj
+      else
+        klass ||= "#{obj.class.name}Presenter".constantize
+        klass.new(obj, context)
+      end
+    end
+
+    def present_collection(obj, klass = nil, context = self)
+      obj.map { |o| present(o, klass, context) }
+    end
+  end
+end
+
+

data/lib/showcase/presenter.rb

@@ -0,0 +1,39 @@
+require 'delegate'
+require 'active_support/inflector'
+require 'showcase/helpers'
+
+module Showcase
+  class Presenter < SimpleDelegator
+    include Helpers
+
+    attr_reader :context
+
+    alias :object :__getobj__
+    alias :h :context
+
+    def class
+      object.class
+    end
+
+    def initialize(obj, context)
+      super(obj)
+      @context = context
+    end
+
+    def self.presents(*attrs)
+      attrs.each do |attr|
+        define_method attr do
+          present(object.send(attr), nil, context)
+        end
+      end
+    end
+
+    def self.presents_collection(*attrs)
+      attrs.each do |attr|
+        define_method attr do
+          present_collection(object.send(attr), nil, context)
+        end
+      end
+    end
+  end
+end

data/lib/showcase/version.rb

@@ -0,0 +1,3 @@
+module Showcase
+  VERSION = "0.0.1"
+end

data/lib/showcase.rb

@@ -0,0 +1,5 @@
+require 'showcase/version'
+require 'showcase/presenter'
+
+module Showcase
+end

data/showcase.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'showcase/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "showcase"
+  gem.version       = Showcase::VERSION
+  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.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.add_dependency "activesupport"
+  gem.add_development_dependency "rspec"
+end

data/spec/fixtures.rb

@@ -0,0 +1,39 @@
+class Person < Struct.new(:name)
+end
+
+class Project < Struct.new(:name)
+  def owner
+    Person.new("Stefano Verna")
+  end
+
+  def collaborators
+    [ Person.new("Ju Liu") ]
+  end
+
+  def dummy
+    "foobar"
+  end
+end
+
+class PersonPresenter < Showcase::Presenter
+  def sex
+    'male'
+  end
+end
+
+class ProjectPresenter < Showcase::Presenter
+  presents :owner
+  presents_collection :collaborators
+
+  def name
+    "Presented #{object.name}"
+  end
+
+  def context_foo
+    h.foo
+  end
+end
+
+class Context
+  include Showcase::Helpers
+end

data/spec/showcase_spec.rb

@@ -0,0 +1,83 @@
+require 'showcase'
+require_relative './fixtures'
+
+describe Showcase::Presenter do
+
+  let(:context) { stub(:context, foo: 'bar') }
+  let(:object) { Project.new('Showcase') }
+  let(:subject) { ProjectPresenter.new(object, context) }
+
+  it 'takes the object and a context as parameters' do
+    subject.object.should == object
+    subject.context.should == context
+  end
+
+  it 'preserves original .class' do
+    subject.class.should == Project
+  end
+
+  it 'delegates methods to object' do
+    subject.dummy.should == 'foobar'
+  end
+
+  it 'allows overriding of methods' do
+    subject.name.should == 'Presented Showcase'
+  end
+
+  it 'allows .h as shortcut to access the context' do
+    subject.context_foo.should == 'bar'
+  end
+
+  describe '#presents' do
+    it 'wraps the specified attributes inside a presenter' do
+      subject.owner.sex.should == 'male'
+    end
+  end
+
+  describe '#presents_collection' do
+    it 'wraps the specifieed collection attributes inside a presenter' do
+      subject.collaborators.first.sex.should == 'male'
+    end
+  end
+end
+
+describe Showcase::Helpers do
+  let(:object) { Person.new('Steve Ballmer') }
+  let(:context) { Context.new }
+
+  describe '.present' do
+    context 'when the passed object is already a Showcase::Base' do
+      it 'returns the object itself' do
+        presenter = PersonPresenter.new(object, stub)
+        context.present(presenter).should == presenter
+      end
+    end
+    context 'when the object still needs to be presented' do
+      it 'instanciate a new presenter, inferring the class' do
+        PersonPresenter.stub(:new).with(object, context).and_return 'Presenter'
+        context.present(object, PersonPresenter).should == 'Presenter'
+      end
+      it 'the presenter class to use can be specified as the second parameter' do
+        ProjectPresenter.stub(:new).with(object, context).and_return 'Presenter'
+        context.present(object, ProjectPresenter).should == 'Presenter'
+      end
+      it 'the context to use can be specified as third parameter' do
+        different_context = stub
+        context.present(object, ProjectPresenter, different_context).context.should == different_context
+      end
+    end
+  end
+
+  describe '.present_collection' do
+    it 'returns a presenter for each object in the collection' do
+      collection = [ Person.new('Mark'), Person.new('Luke') ]
+
+      PersonPresenter.stub(:new).with(collection[0], context).and_return 'foo'
+      PersonPresenter.stub(:new).with(collection[1], context).and_return 'bar'
+
+      presented_collection = context.present_collection(collection)
+      presented_collection.should == [ 'foo', 'bar' ]
+    end
+  end
+
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: showcase
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stefano Verna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/showcase/presenter/USAGE
+- lib/generators/showcase/presenter/presenter_generator.rb
+- lib/generators/showcase/presenter/templates/presenter.rb
+- lib/showcase.rb
+- lib/showcase/helpers.rb
+- lib/showcase/presenter.rb
+- lib/showcase/version.rb
+- showcase.gemspec
+- spec/fixtures.rb
+- spec/showcase_spec.rb
+homepage: https://github.com/welaika/showcase
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: A barebone and framework agnostic presenter implementation
+test_files:
+- spec/fixtures.rb
+- spec/showcase_spec.rb