wrapper 0.1.0.rc1

data/EXAMPLES

@@ -0,0 +1,41 @@
+## ./app/presenters/person_presenter.rb
+class PersonPresenter
+  include Wrapper
+
+  # Delegate to another presenter, will give you person.contact_email
+  delegate :email, to: :contact_presenter, prefix: :contact
+
+  def name
+    [first_name, last_name].join ' '
+  end
+
+  # Permanently override an method/attribute
+  def first_name
+    'Ingemar'
+  end
+
+  # Ideal pattern for JSON hashes
+  def as_json(*)
+    {
+      name: name,
+      age: age,
+      books: BooksPresenter.wrap books
+    }.as_json
+  end
+end
+
+## Wrapping resources for use in views
+class ArticlesController < ApplicationController
+  helper_method :articles, :article
+
+  ## whatever rocks your boat
+
+  protected
+  def articles
+    @articles ||= ArticlePresenter.wrap Article.published
+  end
+
+  def article
+    @article ||= ArticlePresenter.wrap Article.find(params[:id])
+  end
+end

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2012 Ingemar Edsborn
+
+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,30 @@
+## wrapper
+
+[![Build Status](https://secure.travis-ci.org/ingemar/wrapper.png)](http://travis-ci.org/ingemar/wrapper)
+
+this is a minimalistic implementation of a object wrapper intended to use for things like building a presenter layer in Rails.
+The goal with presenters is to separate view logic from the model and avoid using view helper modules.
+
+## Usage
+
+Normal procedure. Stick the gem in your `Gemfile` and `bundle`.
+
+```
+  gem 'wrapper'
+```
+
+Then just include `Wrapper` in your presenter class. To wrap your resources simply call `.wrap` with your presenter class. If you pass it a collection, you'll get a collection back with each resource neatly wrapped. If you pass it a single resource you'll get that back, neatly fixed ready for the grand stage.
+
+Add new methods or override existing ones for your view in your presenter class. All public instance methods defined in the original model are available for your presenter through `#method_missing` and `#respond_to?`.
+
+You can always get the original resource object through `#resource` and it's class constant with `#model`.
+
+It's considered good behaviour to place your presenters in `./app/presenters/`
+
+## Caveats
+
+If you need to compare a wrapped resource with itself, the wrapped resource has to be first in the statement (i.e. `user == current_user`).
+
+## Extended examples
+
+See `EXAMPLES`

data/lib/wrapper/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module Wrapper # :nodoc:
+  VERSION = '0.1.0.rc1'
+end

data/lib/wrapper.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+require 'active_support/concern'
+
+module Wrapper # :nodoc:
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    ##
+    #
+    # Wrap an object as an presenter instance. The wrapped object will be stored and
+    # available through +#resource+. If the given object responds to +#map+,
+    # each item will be wrapped individually.
+    #
+    # Returns an instance of your presenter class or a collection of instances.
+    #
+    def wrap(object)
+      if object.respond_to? :map
+        object.map { |resource| wrap_instance(resource) }
+      else
+        wrap_instance(object)
+      end
+    end
+
+    private
+    def wrap_instance(resource)
+      new(resource)
+    end
+  end
+
+  def initialize(resource)
+    @resource = resource
+  end
+
+  ##
+  # Returns the original, wrapped +#resource+.
+  #
+  def resource
+    @resource
+  end
+
+  ##
+  # Returns the wrapped +#resource+'s class.
+  #
+  def model
+    self.resource.class
+  end
+
+  ##
+  # Compare +#self+ or +#resource+ against the given +other+.
+  #
+  def ==(other)
+    super || resource == other
+  end
+
+  def as_json(*args)
+    resource.as_json(*args)
+  end
+
+  ##
+  # Check if an instance method is defined either in the presenter or for on
+  # the +#resource+.
+  #
+  def respond_to?(method)
+    super || resource.respond_to?(method)
+  end
+
+  private
+  def method_missing(method, *args, &block)
+    if resource.respond_to?(method)
+      resource.send(method, *args, &block)
+    else
+      super
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "rubygems"
+require "bundler/setup"
+require 'active_support/core_ext'
+
+require 'wrapper'
+
+Dir.glob("spec/{models,presenters}/*").each { |file| require File.expand_path file }
+
+RSpec.configure do |config|
+end

data/wrapper.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'wrapper/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'wrapper'
+  s.version     = Wrapper::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Ingemar Edsborn']
+  s.email       = ['ingemar@xox.se']
+
+  s.homepage    = 'http://github.com/ingemar/wrapper'
+  s.summary     = 'Wrapper is a presenter layer for Rails 3'
+  s.description = 'Wrapper is a minimalistic implementation of a presenter pattern for Rails.'
+
+  s.extra_rdoc_files = %w[README.md EXAMPLES]
+  s.rdoc_options = ["--main"]
+
+  s.files       = Dir.glob("lib/**/*") + %w[Gemfile wrapper.gemspec HISTORY README.md EXAMPLES LICENSE]
+  s.test_files  = Dir.glob('spec/*')
+
+  s.add_runtime_dependency "rails", '~> 3.0'
+  s.add_development_dependency 'rspec', '~> 2.0'
+end
+

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0.rc1
+  prerelease: 6
+platform: ruby
+authors:
+- Ingemar Edsborn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Wrapper is a minimalistic implementation of a presenter pattern for Rails.
+email:
+- ingemar@xox.se
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- EXAMPLES
+files:
+- lib/wrapper/version.rb
+- lib/wrapper.rb
+- Gemfile
+- wrapper.gemspec
+- HISTORY
+- README.md
+- EXAMPLES
+- LICENSE
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: http://github.com/ingemar/wrapper
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Wrapper is a presenter layer for Rails 3
+test_files:
+- spec/spec.opts
+- spec/spec_helper.rb