detaso-oprah 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ee902d46e66b0a39b778241c9d18a8202dab24713ffaf4389b9ba3e43da831c
+  data.tar.gz: 8a611ae249feb8c39c849201cd463cd269b3f532de9f7fcdac8f5fe8fc296b07
+SHA512:
+  metadata.gz: d42a4b5ca87c66396eab35e4f6a53f75078a2e6fd1b4ac48ab91161d63ec727ea3395047ca6b348b9be1d2e6194a635690a92c1df1252284db277251b31b3069
+  data.tar.gz: bd2947f1f69df130f0c96101a08ff3ee4a982509ad7c6285f039961a7c1a6e0977ba791552d85ff51279b9b9ac12e873f3f635d78450b2a95dff5f783e0cd72b

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+test/dummy/log/

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+sudo: false
+cache: bundler
+script: bundle exec rake test
+rvm:
+  - 2.3.1
+matrix:
+  global:
+    - BUNDLE_JOBS=4
+before_install:
+  - bundle install --retry=3
+before_update:
+  - bundle update
+notifications:
+  email: false
+addons:
+  code_climate:
+    repo_token: 3d9c9c681c7be79695156ecbf9978ada542e60b726a7ba728866dee6f95f3ccd

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+0.3.0
+-----
+
+- Presenter now inherits from SimpleDelegator
+- Support for anonymous ancestors [#9]
+
+
+0.2.1
+-----
+
+- Support for ActionMailer
+
+0.2.0
+-----
+
+- Replace `Oprah::Cache` with `ActiveSupport::Cache::MemoryStore` [#3]
+
+0.1.3
+-----
+
+- Presenters can now be specified using the `only:` keyword argument, which
+  takes either a Class or an Array of classes
+- Replace repeated method default arguments with splats
+- Add assertions to TestHelper
+- Delegate to most recent view context in presenters created from within Rails
+  controllers [#1]
+- Add `#present` and `#present_many` methods to Presenter [#2]
+
+0.1.2
+-----
+
+- Explicitly rescue `NameError` in `Cache#presenter_classes_for`
+- Add `Oprah::TestHelpers`
+- Delegate `#to_s` and `#inspect` to the presented object
+
+0.1.1
+-----
+
+- Initial public release

data/CONTRIBUTING.md

@@ -0,0 +1,86 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish
+to make via issue, email, or any other method with the owners of this repository
+before making a change.
+
+Please note we have a code of conduct, please follow it in all your interactions
+with the project.
+
+## Pull Request Process
+
+If you'd like to contribute to Oprah, start by forking the repository on GitHub:
+
+http://github.com/endofunky/oprah
+
+To get all of the dependencies, install the gem first. The best way to get your
+changes merged back into core is as follows:
+
+- If you are about to add a larger feature, open an issue on the GitHub issue
+  tracker to discuss your ideas first. If whatever you're about to implement is
+  already in the issue tracker, please let us know that you picked it up.
+
+- Clone down your fork.
+
+- Create a thoughtfully named topic branch to contain your change.
+
+- Write some code.
+
+- Add tests and make sure everything still passes by running bundle exec rake.
+  This is mandatory for pull requests to be accepted.
+
+- If you are adding new functionality, document it!
+
+- Do not change the version number.
+
+- If necessary, rebase your commits into logical chunks, without errors.
+
+- Push the branch up to GitHub.
+
+- Send a pull request to the endofunky/oprah project.
+
+## Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery
+
+- Personal attacks
+
+- Trolling or insulting/derogatory comments
+
+- Public or private harassment
+
+- Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+
+- Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions that
+are not aligned to this Code of Conduct. By adopting this Code of Conduct,
+project maintainers commit themselves to fairly and consistently applying these
+principles to every aspect of managing this project. Project maintainers who do
+not follow or enforce the Code of Conduct may be permanently removed from the
+project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the
+[Contributor Covenant](http://contributor-covenant.org), version 1.2.0,
+available at http://contributor-covenant.org/version/1/2/0/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2016 Tobias Svensson <tob@tobiassvensson.co.uk>
+
+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,314 @@
+# Oprah
+
+[![Gem Version](https://badge.fury.io/rb/oprah.svg)](https://badge.fury.io/rb/oprah)
+[![Build Status](https://travis-ci.org/endofunky/oprah.svg)](https://travis-ci.org/endofunky/oprah)
+[![Code Climate](https://codeclimate.com/github/endofunky/oprah.svg)](https://codeclimate.com/github/endofunky/oprah)
+[![Dependency Status](https://gemnasium.com/badges/github.com/endofunky/oprah.svg)](https://gemnasium.com/github.com/endofunky/oprah)
+
+Opinionated presenters for Rails 5 - without the cruft.
+
+## Table of Contents
+
+* [Overview](#overview)
+* [Installation](#installation)
+* [Getting started](#getting-started)
+  + [ActionController integration](#actioncontroller-integration)
+  + [ActionMailer integration](#actionmailer-integration)
+* [Collections](#collections)
+* [Associations](#associations)
+* [Composition](#composition)
+  + [Performance](#performance)
+  + [Ordering](#ordering)
+  + [Choosing presenters](#choosing-presenters)
+* [Testing](#testing)
+* [API Documentation](#api-documentation)
+* [Contributing](#contributing)
+* [License](#license)
+* [Author](#author)
+
+## Overview
+
+If you've ever worked on a sufficiently large Rails application you've probably
+experienced the Rails helper mess first hand. Helper methods are annoying to
+locate, hard to test and not terribly expressive.
+
+So why another presenter/decorator library? Oprah was written with a few simple
+goals in mind only covered partially (or not at all) by other gems:
+
+- Thin, lightweight layer over Ruby's `SimpleDelegator`
+- Presenters should be easy to test
+- Avoid monkey patching, where possible :monkey::gun:
+- Embrace convention over configuration
+- First-class support for composition (modules and concerns)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'oprah'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Getting started
+
+Oprah expects a single presenter for each of your classes or modules. If your
+model is called `User` it will look for a class called `UserPresenter`:
+
+``` ruby
+class User
+  def first_name
+    "John"
+  end
+
+  def last_name
+    "Doe"
+  end
+end
+
+class UserPresenter < Oprah::Presenter
+  def name
+    "#{first_name} #{last_name}"
+  end
+end
+```
+
+Oprah will figure out the presenters by itself so you don't have to instantiate
+your presenter classes directly:
+
+``` ruby
+presenter = Oprah.present(User.new)
+
+presenter.name
+# => "John Doe"
+
+```
+
+Of course, all the regular methods on your model are still accessible:
+
+``` ruby
+presenter.first_name
+# => "John"
+```
+
+If you *DO* want to use a specific presenter, you can simply instantiate it
+yourself:
+
+``` ruby
+SomeOtherPresenter.new(User.new)
+```
+
+### ActionController integration
+
+Now, where do we put our presenters? Ideally, you'd want to expose them in your
+controller. Oprah avoids monkey patching and generally it's good to be aware of
+what's going on, even if that means to be (at least a little bit) explicit.
+
+Here's how you can use Oprah presenters from your controller:
+
+``` ruby
+class UsersController < ApplicationController
+  def show
+    @user = present User.find(params[:id])
+  end
+end
+```
+
+This will also take care of passing the correct view context to the presenter,
+which you can access with the `#view_context` (or shorter, `#h`) instance
+method.
+
+### ActionMailer integration
+
+Oprah will make the same helpers you have in ActionController available to
+ActionMailer:
+
+``` ruby
+class UserMailer < ApplicationMailer
+  default from: 'notifications@example.com'
+
+  def welcome_email(user)
+    @user = present user
+    mail(to: @user.email, subject: 'Welcome to My Awesome Site')
+  end
+end
+```
+
+## Collections
+
+Oprah has basic support for collections with `.present_many`. It will simply
+apply it's `.present` behavior to each object in the given collection:
+
+``` ruby
+users = [User.new, User.new]
+presenters = Oprah.present_many(users)
+
+presenters.first.kind_of?(UserPresenter)
+# => true
+
+presenters.last.kind_of?(UserPresenter)
+# => true
+```
+
+Of course, this works in controllers, too:
+
+``` ruby
+class UserController < ApplicationController
+  def index
+    @users = present_many User.all
+  end
+end
+```
+
+## Associations
+
+You can also automatically use presenters for your associations using the
+`#presents_one` and `#presents_many` macros. Let's say you have the following
+`Project` model:
+
+``` ruby
+class Project
+  has_many :users
+  has_one :owner, class_name: "User"
+end
+```
+
+Oprah lets you easily wrap the associated objects:
+
+``` ruby
+class ProjectPresenter < Oprah::Presenter
+  presents_many :users
+  presents_one :owner
+end
+```
+
+Note that you don't need to explicitly state the association class.
+
+## Composition
+
+Let's say you extraced some behaviour out of your model into a reusable module (or
+`ActiveSupport::Concern`). Oprah lets you write a single, separate presenter for
+this module and automatically chains it to your "main presenter" by walking up the
+ancestor chain of the given object.
+
+Let's say we want to mix a shared `Describable` module into our `User` class from
+above and render the description to HTML:
+
+
+``` ruby
+module Describable
+  def description
+    "*AWESOME*"
+  end
+end
+
+class User
+  include Describable
+end
+
+class DescribablePresenter < Oprah::Presenter
+  def description
+    Kramdown::Document.new(object.description).to_html
+  end
+end
+```
+
+You can now access the methods of both, `UserPresenter` *and*
+`DescribablePresenter`:
+
+``` ruby
+presenter = Oprah.present(User.new)
+
+presenter.description
+=> "<p><em>AWESOME</em></p>\n"
+
+presenter.name
+# => John Doe
+```
+
+### Performance
+
+Of course, looking up all the presenters would imply a performance issue. But
+don't worry, Oprah caches all matching presenters for a class (and busts it's
+cache on code reloads for a smooth development experience).
+
+### Ordering
+
+Oprah walks your object's ancestor chain in reverse. For example, you'd be
+able to access the methods exposed by the `DescribablePresenter` from your
+`UserPresenter`. You can even use `super`:
+
+``` ruby
+class DescribablePresenter < Oprah::Presenter
+  def baz
+    "foo"
+  end
+end
+
+class UserPresenter < Oprah::Presenter
+  def baz
+    super + "bar"
+  end
+end
+
+Oprah.present(User.new).baz
+# => "foobar"
+```
+
+### Choosing presenters
+
+When presenting an object you can optionally choose which presenter classes
+to use:
+
+``` ruby
+Oprah.present(User.new, only: DescribablePresenter)
+```
+
+This parameter takes either a single presenter or an `Array` of presenters.
+The presenter(s) given need to match the object's class or one of it's
+ancestors. Non-matching presenters given will be ignored.
+
+## Testing
+
+Testing presenters is as simple as testing a regular class. Oprah also
+provides couple of helpers to make it even easier:
+
+``` ruby
+class UserPresenterTest < Minitest::Test
+  include Oprah::TestHelpers
+
+  def setup
+    @presenter = present User.new
+  end
+
+  def test_presented
+    assert_presented @presenter
+  end
+
+  def test_name
+    assert_equal "John Doe", @presenter.name
+  end
+end
+```
+
+## API Documentation
+
+Comprehensive API Documentation is available at
+[rubydoc.info](http://www.rubydoc.info/gems/oprah).
+
+## Contributing
+
+Please check out our [contributing guidelines](CONTRIBUTING.md).
+
+## License
+
+Released under the MIT license. See the LICENSE file for details.
+
+## Author
+
+Tobias Svensson, [@endofunky](https://twitter.com/endofunky), [http://github.com/endofunky](http://github.com/endofunky)

data/Rakefile

@@ -0,0 +1,5 @@
+require File.join(Dir.pwd, 'lib', 'oprah', 'version')
+
+Dir["tasks/**/*.rb"].each { |task| load task }
+
+task default: :test

data/lib/oprah/controller_helpers.rb

@@ -0,0 +1,109 @@
+module Oprah
+  # Helpers that will be mixed into `ActionController::Base` and
+  # `ActionMailer::Base` by the {Oprah::Railtie}.
+  module ControllerHelpers
+    # A proxy class to delegate method calls to view contexts in presenters
+    # to the most recently created view context by
+    # {ControllerHelpers#view_context}.
+    #
+    # `ViewContextProxy` objects are automatically created in
+    # {ControllerHelpers#present} and {ControllerHelpers#present_many} and
+    # shouldn't have to be created manually.
+    #
+    # @since 0.1.3
+    class ViewContextProxy < ActiveSupport::ProxyObject
+      # @param [ActionController::Base] controller
+      #   The controller to delegate to.
+      def initialize(controller)
+        @controller = controller
+      end
+
+      # Delegates all method calls to the `ActionView::Base` returned from
+      # {ControllerHelpers#oprah_view_context}.
+      def method_missing(meth, *args, &block)
+        @controller.oprah_view_context.__send__(meth, *args, &block)
+      end
+    end
+
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :present
+      helper_method :present_many
+    end
+
+    # Presents a single object.
+    #
+    # Will pass the view context returned from {#oprah_view_context} to the
+    # presenter by default. This can be overridden.
+    #
+    # @see Presenter.present
+    def present(*args, **kwargs, &block)
+      kwargs = {
+        view_context: oprah_view_context_proxy
+      }.merge(kwargs)
+
+      Presenter.present(*args, **kwargs, &block)
+    end
+
+    # Presents a collection of objects.
+    #
+    # Will pass the view context returned from {#oprah_view_context} to the
+    # presenter by default. This can be overridden.
+    #
+    # @see Presenter.present_many
+    def present_many(*args, **kwargs, &block)
+      kwargs = {
+        view_context: oprah_view_context_proxy
+      }.merge(kwargs)
+
+      Presenter.present_many(*args, **kwargs, &block)
+    end
+
+    # The view context automatically passed to objects presented from this
+    # controller.
+    #
+    # You can override this method pass a custom view context to all
+    # presented objects from the controller scope.
+    #
+    # @see #oprah_view_context=
+    # @return [ActionView::Base]
+    def oprah_view_context
+      @oprah_view_context || view_context
+    end
+
+    # Assigns the view context returned from {#oprah_view_context}.
+    #
+    # You can override this method pass a custom view context to all
+    # presented objects from the controller scope.
+    #
+    # @since 0.1.3
+    # @see #oprah_view_context
+    # @param [ActionView::Base] view_context The view context to assign
+    # @return [ActionView::Base]
+    def oprah_view_context=(view_context)
+      @oprah_view_context = view_context
+    end
+
+    # Returns an instance of a view class and sets the current view context
+    # returned by {#oprah_view_context}.
+    #
+    # If you override this method in your controller ensure you keep Oprah's
+    # view context updated using {#oprah_view_context=}.
+    #
+    # @since 0.1.3
+    # @see http://api.rubyonrails.org/classes/ActionView/Rendering.html#method-i-view_context
+    #      Rails API Documentation
+    # @return [ActionView::Base]
+    def view_context
+      self.oprah_view_context = super
+    end
+
+    private
+
+    # @since 0.1.3
+    def oprah_view_context_proxy
+      @oprah_view_context_proxy ||= ViewContextProxy.new(self)
+    end
+  end
+end