pres 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c06c75be9b53fdecc5325840ecbba90b7d062222b25a5e71e5094973c322af8d
-  data.tar.gz: 03ce29f50efdc1d15fca1a0d98a97f62f9850e5377503b6f4c82e68da92c15d5
+  metadata.gz: 4fcb5ff4379eb2e6e8a3f93f5774253c5e9700dbfb4dc38ee406633dc8a97cf1
+  data.tar.gz: 183813355351056d0ed31642b13dcb37d23fe2058febc7cf40a49fe89692d122
 SHA512:
-  metadata.gz: 32556643dc9b412e0f8e83cc661d3e0028a9589ffe70df7d2a1951b2ec16d3ecf4e9b9a0b3c88c320cbb5846f726641403c1ee0a75b8a36b6046dd570b926604
-  data.tar.gz: ff202c4d645cd39f3482d6099270b4f21de6befa9892f165e9c4c9c6b884b140d38493f581b23236c9de2e3a1c94f8927a71ee33a7646635de928c9ad02f5c62
+  metadata.gz: bfcf47dd97b4b68f1c4236829773c9864d580307371e27e00e10d9964f90850c2804aff9d6a6746dd8d49d4586aa1f7bd0237c8123b04fabd4a923ad9cc41e36
+  data.tar.gz: ce1bc25ff680fa951b43155769d116579f2aae2c83b6cfedf0fe0660a4ed21ab096606493cd280dcee4dbbb634db96bcfcbcb9c0f55d7a147657386bb777a094

data/README.md

@@ -1,7 +1,7 @@
 # `pres`
 
 [![Gem Version](https://badge.fury.io/rb/pres.svg)](http://badge.fury.io/rb/pres)
-[![Build Status](https://travis-ci.org/neighborland/pres.svg)](https://travis-ci.org/neighborland/pres)
+[![Build Status](https://github.com/neighborland/pres/actions/workflows/ruby.yml/badge.svg)](https://github.com/neighborland/pres/actions/workflows/ruby.yml)
 
 ## What?
 
@@ -16,8 +16,7 @@ solution with no runtime gem dependencies.
 
 ## How and Why?
 
-Presenters are an alternative to an unorganized mass of helper
-methods in your ruby application.
+Presenters are an alternative to an unorganized pile of helper methods in your rails application.
 
 Rails' `ViewContext` contains convenience methods for views, such as `link_to`,
 `url_for`, `truncate`, `number_to_currency`, etc. It's the thing that makes
@@ -42,12 +41,25 @@ gem "pres"
 Include the `Pres::Presents` module:
 
 ```ruby
-class ApplicationController
+class ApplicationHelper
   include Pres::Presents
 end
 ```
 
-### Usage
+This will make the `present` method available in your views.
+
+## Use
+
+There are two main approaches:
+
+(1) Follow the traditional rails way with view templates, but move your helper methods into a presenter class.
+You'll probably want to start here if you have an existing rails app.
+
+(2) Create self-contained rendering components (see "Components" below).
+
+You can use both techniques.
+
+### (1) With View Templates
 
 The quickest way to get started is to use the `Pres::Presenter` base class.
 
@@ -65,7 +77,7 @@ class DogePresenter < Pres::Presenter
 
   def name_header
     # object is the Doge used to initialize the presenter
-    content_tag(:h1, object.name)  
+    content_tag(:h1, object.name)
   end
 
   def signed_in_status
@@ -75,41 +87,36 @@ class DogePresenter < Pres::Presenter
     else
       "Signed out"
     end
-  end  
+  end
 end
 ```
 
-Wrap your model object in a presenter in your controller with `present`:
+Standard rails controller method:
 
 ```ruby
 class DogesController
   def show
-    @doge = present(Doge.find(params[:id]))
+    @doge = Doge.find(params[:id])
   end
 end
 ```
 
-Use the presenter object in `doges/show.haml.html`
+Wrap your model object in a presenter in your view with `present`:
+
+`doges/show.haml.html`
 
 ```haml
-= @doge.name_header
-.status
-  You are #{@doge.signed_in_status}
-.links
-  .meme-link= @doge.know_your_meme_link
+- present(@doge) do |doge|
+  = doge.name_header
+  .status
+    You are #{doge.signed_in_status}
+  .links
+    .meme-link= doge.know_your_meme_link
 ```
 
 #### Collections
 
-Create a presenter class in `app/presenters`:
-
-```ruby
-class DogePresenter < Pres::Presenter
-  # same as above
-end
-```
-
-Build an array of presenters in your controller with `present`:
+Standard rails controller method:
 
 ```ruby
 class DogesController
@@ -119,21 +126,76 @@ class DogesController
 end
 ```
 
-Use the presenter objects in `doges/index.haml.html`
+Build an array of presenters in your view with `present`:
+
+`doges/index.haml.html`
 
 This renders "doges/_doge.html.haml" for each item, following rails' usual conventions:
 
 ```haml
-= render @doges
+= render present(@doges)
 ```
 
 Or use each:
 
 ```haml
-- @doges.each do |doge|
+- present(@doges).each do |doge|
   = doge.name_header
 ```
 
+## (2) Components
+
+You can use `pres` to build components that directly render HTML:
+
+_Note: `#sanitize` is a method on the `view_context`._
+
+```ruby
+class NameHeader < Pres::Presenter
+  def render
+    return unless object&.name
+    <<~HTML.html_safe
+      <h1>#{sanitize(object.name.titleize)}</h1>
+    HTML
+  end
+end
+
+user = User.new(name: "joe cool <")
+
+NameHeader.new(user, view_context).render
+=> "<h1>Joe Cool &lt;</h1>"
+
+present(user, presenter: NameHeader).render
+=> "<h1>Joe Cool &lt;</h1>"
+```
+
+You may notice that you could do without `pres` altogether when you don't need
+the `view_context` helper methods:
+
+```ruby
+class PlusTwo
+  def initialize(object)
+    @object = object
+  end
+
+  def render
+    return unless @object
+    <<~HTML.html_safe
+      <p>#{@object + 2}</p>
+    HTML
+  end
+end
+
+PlusTwo.new(2).render
+=> "<p>4</p>"
+
+present(2, presenter: PlusTwo).render
+=> "<p>4</p>"
+```
+
+If `render` is confusing, name that method `#to_html` or something else.
+
+## Options
+
 #### Present with options
 
 Pass additional options to a Presenter as a hash. The presenter class exposes the
@@ -145,6 +207,7 @@ user = User.new
 # These two lines are the same:
 # 1. explicit
 presenter = UserPresenter.new(user, view_context, something: 123)
+
 # 2. using #present
 presenter = present(user, something: 123)
 => #<UserPresenter object: #<User> ...>
@@ -179,38 +242,6 @@ present(User.new)
 # => #<MyPresenter object: #<User> ...>
 ```
 
-#### Create presenters in views
-
-You can create a presenter in your view code. First make the `present` method
-visible to your views by declaring it a `helper_method`:
-
-```ruby
-class ApplicationController
-  include Pres::Presents
-  helper_method :present
-end
-```
-
-Then you can create presenters inline in a view:
-
-```haml
-- present(@doge) do |doge|
-  = doge.name_header
-```
-
-You can override methods as usual:
-
-```ruby
-class DogePresenter < Pres::Presenter
-  include Shared
-
-  def truncated_name(length: 60)
-    # override
-    super(length: length)
-  end
-end
-```
-
 #### Presenters can create other presenters
 
 Presenters can wrap child objects in presenters of their own.
@@ -219,7 +250,7 @@ Presenters can wrap child objects in presenters of their own.
 class DogePresenter < Pres::Presenter
   def cats
     present(object.cats)
-  end  
+  end
 end
 ```
 

data/lib/pres/presents.rb

@@ -51,12 +51,12 @@ module Pres
     #
     # Returns a new Presenter object or array of new Presenter objects
     # Yields a new Presenter object if a block is given
-    def present(object, presenter: nil, **args)
+    def present(object, presenter: nil, **kwargs)
       if object.respond_to?(:to_ary)
-        object.map { |item| present(item, presenter: presenter, **args) }
+        object.map { |item| present(item, presenter:, **kwargs) }
       else
         presenter ||= presenter_klass(object)
-        wrapper = presenter.new(object, view_context, **args)
+        wrapper = presenter.new(object, view_context, **kwargs)
         block_given? ? yield(wrapper) : wrapper
       end
     end

data/lib/pres/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pres
-  VERSION = "1.6.0"
+  VERSION = "2.0.0"
 end

data/lib/pres/view_delegation.rb

@@ -7,9 +7,9 @@ module Pres
     end
 
     # Send missing methods to view_context first
-    def method_missing(method, *args, &block)
+    def method_missing(method, ...)
       if view_context.respond_to?(method, true)
-        view_context.send(method, *args, &block)
+        view_context.send(method, ...)
       else
         super
       end

metadata

@@ -1,44 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: pres
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Tee Parham
 - Scott Jacobsen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-31 00:00:00.000000000 Z
-dependencies:
-- !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: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
+date: 2024-12-02 00:00:00.000000000 Z
+dependencies: []
 description: A Simple Rails Presenter base class and controller helper
 email:
 - tee@neighborland.com
@@ -57,8 +29,9 @@ files:
 homepage: https://github.com/neighborland/pres
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -66,15 +39,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.5.23
+signing_key:
 specification_version: 4
 summary: A Simple Rails Presenter
 test_files: []