pres 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 679fb7c90be5b08c135e46d8da2e64f94c3be04d
+  data.tar.gz: 005d0c7bd07a446107f2dd09c235f05eb6d3aa56
+SHA512:
+  metadata.gz: 2bd353785c1572705fcd30ab41c6a240b80549de720e3a2d6444a9ef4f19fda8714d0d3b5180fce3318f55e30be09d7a68e9e71c395645199a5b84f71871d203
+  data.tar.gz: 41634e73d39c0836589804163e0e19c1eedaf869931c19dcdcfdfdd9aeca70737d98c770a6634b8f3ddc8752cb325d2720442a543bf068a50ae71cce34125cce

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+if ENV["TRAVIS"]
+  gem "coveralls", require: false
+end
+
+if ENV["BYEBUG"]
+  gem "byebug"
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Neighborland, Inc.
+
+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,230 @@
+# Pres: A Simple Rails Presenter
+
+## What?
+
+A Presenter is a rendering class that wraps a model. Presenters are an
+alternative to an unorganized mass of helper methods in your Rails application.
+
+The `pres` gem is a lightweight presenter solution.
+
+## How and Why?
+
+Decorators add methods to a model. `pres` does not do that. `pres` encourages you
+to whitelist model methods (via delegation).
+
+Other presenter libraries mix in all the methods from the Rails ViewContext to
+make it easy to call those methods in the Presenter class. This causes method
+bloat. `pres` instead injects the ViewContext as a dependency into the
+Presenter class, and uses `method_missing` to delegate to those methods.
+
+## Install
+
+Add it to your Gemfile:
+
+```ruby
+gem "pres"
+```
+
+Include the `Presents` module:
+
+```ruby
+class ApplicationController
+  include Presents
+end
+```
+
+Add `app/presenters` to your application's autoload paths in `application.rb`:
+
+```ruby
+config.autoload_paths += %W( #{ config.root }/app/presenters )
+```
+
+#### Example Usage
+
+Create a presenter class in `app/presenters`:
+
+```ruby
+class DogePresenter < Presenter
+  # explicitly delegate methods to the model
+  delegate :name, to: :object
+
+  def know_your_meme_link
+    # Rails helpers are available via the view context
+    link_to "Know your meme", "http://knowyourmeme.com/memes/doge"
+  end
+
+  def name_header
+    # object is the Doge
+    content_tag(:h1, objec†.name)  
+  end
+
+  def signed_in_status
+    # controller methods are accessible via the view context
+    if signed_in?
+      "Signed in"
+    else
+      "Signed out"
+    end
+  end  
+end
+```
+
+Wrap your model object in your controller with `present`:
+
+```ruby
+class DogesController
+  def show
+  end
+
+  private
+
+  def doge
+    @doge ||= present(Doge.find(params[:id]))
+  end  
+end
+```
+
+Use the presenter object in `doges/show.haml.html`
+
+```haml
+= doge.name_header
+.status
+  You are #{ doge.signed_in_status }
+.links
+  .meme-link= doge.know_your_meme_link
+```
+
+#### Collection Example
+
+Create a presenter class in `app/presenters`:
+
+```ruby
+class DogePresenter < Presenter
+  # same as above
+end
+```
+
+Wrap your model object in your controller with `present`:
+
+```ruby
+class DogesController
+  def index
+  end
+
+  private
+
+  def doges
+    @doges ||= present(Doge.all)
+  end  
+end
+```
+
+Use the presenter objects in `doges/index.haml.html`
+
+```haml
+This renders "doges/_doge.html.haml" for each item, as usual:
+= render @doges
+
+Or use each:
+- doges.each do |doge|
+  = doge.name_header
+```
+
+#### Present with options
+
+Use keyword arguements (or an options hash) to pass additional options to a
+Presenter:
+
+```ruby
+class UserPresenter
+  def initialize(object, view_context, cool: false)
+    super
+    @cool = cool
+  end  
+end
+
+user = User.new
+present(user, cool: true)
+=> #<UserPresenter object: #<User> ...>
+```
+
+#### Render a custom Presenter
+
+By default, a presenter class corresponding to the model class name is
+constructed. To specify a different class, pass the `presenter:` key, followed
+by any additional arguments:
+
+```ruby
+user = User.new
+present(user, presenter: NiceUserPresenter, cool: true)
+=> #<NiceUserPresenter object: #<User> ...>
+```
+
+#### Render a collection
+
+```ruby
+present(User.first(5))
+=> [#<UserPresenter object: #<User> ...>]
+```
+
+#### Creating presenters in views
+
+You should create presenters in your controllers. If you would like to create
+a presenter in your view code, make the `presents` method visible to your views:
+
+```ruby
+class ApplicationController
+  include Presents
+  helper_method :present
+end
+```
+
+## More Goodness
+
+#### Presenters are objects
+
+You can mix in common methods. Move everything in `application_helper.rb` to
+`app/presenters/shared`:
+
+```ruby
+module Shared
+  def logout_link
+    # whatever
+  end
+end
+
+class DogePresenter < Presenter
+  include Shared
+end
+```
+
+You can override methods without resorting to convoluted method names:
+
+```ruby
+class DogePresenter < Presenter
+  include Shared
+
+  def logout_link
+    # whoa this one is different!
+  end
+end
+```
+
+#### Presenters can create other presenters
+
+```ruby
+class DogePresenter < Presenter
+  def cats
+    present(object.cats)
+  end  
+end
+```
+
+```haml
+= render doge.cats
+```
+
+## References
+
+* http://nithinbekal.com/posts/rails-presenters/
+* https://github.com/drapergem/draper

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: [:test]
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = %w(test/**/*.rb)
+  t.verbose = false
+end

data/lib/pres/presenter.rb

@@ -0,0 +1,14 @@
+# Base Presenter class
+# Construct with object, view_context, and optional options
+class Presenter < Struct.new(:object, :view_context, :options)
+  delegate :id, :to_partial_path, to: :object
+
+  # Send missing symbols to view_context
+  def method_missing(symbol, *args, &block)
+    view_context.send(symbol, *args, &block)
+  end
+
+  def respond_to?(symbol, _ = false)
+    super || view_context.respond_to?(symbol, true)
+  end
+end

data/lib/pres/presents.rb

@@ -0,0 +1,31 @@
+module Presents
+  private
+
+  # Wrap an object or collection of objects with a presenter class.
+  #
+  # object    - a ruby class
+  # presenter - a Presenter class (optional)
+  #
+  # Examples
+  #
+  # user = User.new
+  # present(user, cool: true)
+  # => #<UserPresenter object: #<User> ...>
+  #
+  # user = User.new
+  # present(user, presenter: NiceUserPresenter, cool: true)
+  # => #<NiceUserPresenter object: #<User> ...>
+  #
+  # present([user])
+  # => [#<UserPresenter object: #<User> ...>]
+  #
+  # Returns a new Presenter object or array of new Presenter objects
+  def present(object, presenter: nil, **args)
+    if object.respond_to?(:to_ary)
+      object.map { |item| present(item, presenter: presenter, **args) }
+    else
+      presenter ||= Object.const_get("#{ object.class.name }Presenter")
+      presenter.new(object, view_context, **args)
+    end
+  end
+end

data/lib/pres/version.rb

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

data/lib/pres.rb

@@ -0,0 +1,4 @@
+require "active_support/core_ext/module/delegation"
+require "pres/version"
+require "pres/presenter.rb"
+require "pres/presents.rb"

data/test/presenter_test.rb

@@ -0,0 +1,22 @@
+require "test_helper"
+
+describe Presenter do
+  it "delegates to view_context" do
+    view_context = FakeViewContext.new
+    presenter = Presenter.new(nil, view_context)
+    assert presenter.respond_to?(:current_user)
+    assert presenter.respond_to?(:link_to)
+    view_context.expects(:link_to)
+    presenter.link_to "something"
+  end
+
+  it "is constructed without options" do
+    assert Presenter.new(nil, nil)
+  end
+
+  it "is constructed with options" do
+    presenter = Presenter.new(nil, nil, something: 42, secrets: "none")
+    assert_equal 42, presenter.options[:something]
+    assert_equal "none", presenter.options[:secrets]
+  end
+end

data/test/presents_test.rb

@@ -0,0 +1,54 @@
+require "test_helper"
+
+describe Presents do
+  class Doge
+  end
+
+  class DogePresenter < Presenter
+  end
+
+  class VeryDogePresenter < Presenter
+  end
+
+  class FakeController
+    include Presents
+
+    def wrap(object)
+      present(object)
+    end
+
+    def very_wrap(object)
+      present(object, presenter: VeryDogePresenter)
+    end
+
+    def view_context
+      FakeViewContext.new
+    end
+  end
+
+  let(:controller) { FakeController.new }
+
+  it "creates the default presenter" do
+    presenter = controller.wrap(Doge.new)
+    assert presenter.is_a?(DogePresenter)
+  end
+
+  it "creates the specified presenter" do
+    presenter = controller.very_wrap(Doge.new)
+    assert presenter.is_a?(VeryDogePresenter)
+  end
+
+  it "creates an array of default presenters" do
+    presenters = controller.wrap([Doge.new, Doge.new])
+    assert presenters.is_a?(Array)
+    assert_equal 2, presenters.size
+    assert presenters[0].is_a?(DogePresenter)
+  end
+
+  it "creates an array of specified presenters" do
+    presenters = controller.very_wrap([Doge.new, Doge.new])
+    assert presenters.is_a?(Array)
+    assert_equal 2, presenters.size
+    assert presenters[0].is_a?(VeryDogePresenter)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+if ENV["TRAVIS"]
+  require "coveralls"
+  Coveralls.wear!
+end
+
+require "minitest/autorun"
+require "mocha/mini_test"
+require "byebug" if ENV["BYEBUG"]
+require "pres"
+
+class FakeViewContext
+  # An example of a method mixed into the view_context
+  def current_user
+    nil
+  end
+
+  private
+
+  # An example of a private method provided by the view_context
+  def link_to(*_)
+    nil
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: pres
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tee Parham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: A Simple Rails Presenter base class and controller helper
+email:
+- tee@neighborland.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pres.rb
+- lib/pres/presenter.rb
+- lib/pres/presents.rb
+- lib/pres/version.rb
+- test/presenter_test.rb
+- test/presents_test.rb
+- test/test_helper.rb
+homepage: https://github.com/neighborland/pres
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Simple Rails Presenter
+test_files:
+- Gemfile
+- Rakefile
+- test/presenter_test.rb
+- test/presents_test.rb
+- test/test_helper.rb
+has_rdoc: