chic 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd0f4b4ac3b5b6097ea4670bad650de8b39f011c59a73101f3b82552f9f14bac
-  data.tar.gz: c199afc9dd72faa4f8f9fc8a466cb6fce82df91d926053044cfd1b8a95a428c1
+  metadata.gz: d229620e4cecbd12bf3c5b6c179977c4547684796855055190f816461994613d
+  data.tar.gz: 9fce4389d3ae6d75ec20329ba923094fdec7f27c34c9adc1f2292f78e2f7269c
 SHA512:
-  metadata.gz: d3d6312d529f55e22af639948e8116ce0940741594a0414a023d67bfc31078b683e24b7cb9945413546cb65f582688a69422b3bb273147a9de81e86a766f42db
-  data.tar.gz: 1e6bf540de26573830f280d8688b6c032595ca7526d9eb0742ae6cd637457ef2a9453628f7c4a48580c91666e55895d08d3a5a65b6420d6fcbabd8198fded850
+  metadata.gz: a8ccc7f570009c3ddaceb44b7c017835ee188a712a65c6f9ac0fe02bae404742ad32de302a214eaae115ef019887a7d7f2f4c387b10e75822fe4e08fb95e9ef3
+  data.tar.gz: efb4967023205dd1f4322679f79e3609eaa5aecacd80a45f40f46556fdb2d8c8651764096faafcf31ba8f12f47d1d6678f43db90f0e64da7579c6b8a0bb72f42

data/README.md

@@ -1,86 +1,354 @@
 # Chic
 
-Opinionated presentation layer comprised of presenters and formatters.
+An opinionated presentation layer comprising presenters and formatters.
+
+Chic was borne out of a need for a simple PORO-style presentation layer for Rails applications to help DRY up formatting logic in views and view helpers.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To get started, add this line to your Gemfile and install it using Bundler:
 
-    gem 'chic'
+```ruby
+gem 'chic'
+```
 
-And then execute:
+## Usage
 
-    $ bundle
+Though it is not a requirement, for ease of reference it is assumed that you will be using this library in a Rails application where you will be creating presenters for your models.
 
-Or install it yourself as:
+### Creating Presenters
 
-    $ gem install chic
+Create a presenter by deriving from `Chic::Presenter`, and then declare which attributes should return formatters or presenters.
 
-## Usage
+```ruby
+# app/presenters/foo_presenter.rb
 
-### Being Presentable
+class FooPresenter < Chic::Presenter
+  formats :baz
+  
+  presents bar: 'BarPresenter'
+end
+```
 
-Make objects easily presentable by:
+### Using Presenters
+
+Include `Chic::Presentable` to make your objects presentable:
 
 ```ruby
-class Foo
+# app/models/foo.rb
+
+class Foo < ApplicationRecord
   include Chic::Presentable
+  
+  belongs_to :bar
 end
 ```
 
-### Creating Presenters
+Instantiate a presenter by calling `.present` on the presenter class, for example in a Rails view:
 
-Present presentables with a presenter by inheriting from `Chic::Presenter`:
+```erb
+<% FooPresenter.present @foo do |foo_presenter| %>
+  <!-- ... -->
+<% end %>
+```
+
+Collections can be presented using `.present_each`:
+
+```erb
+<% FooPresenter.present_each @foos do |foo_presenter, foo| %>
+  <!-- ... -->
+<% end %>
+```
+
+You can also include the view helpers:
 
 ```ruby
-class FooPresenter < Chic::Presenter
-  # ...
+module ApplicationHelper
+  include Chic::Helpers::View
 end
 ```
 
-You can also include `Chic::Presents` and `Chic::Formats` as needed:
+Which will allow you to instantiate presenters without having to use the class name:
+
+```erb
+<% present @foo do |foo_presenter| %>
+  <!-- ... -->
+<% end %>
+
+<% present_each @foos do |foo_presenter, foo| %>
+  <!-- ... -->
+<% end %>
+```
+
+See the [Conventions](#conventions) section below for more on using presenters.
+
+### Creating Formatters
+
+Formatters format values by deriving from `Chic::Formatters::Nil` and overriding the private `value` method:
 
 ```ruby
-class FooPresenter
-  include Chic::Formats
-  include Chic::Presents
-  # ...
+# app/formatters/date_time_formatter.rb
+
+class DateTimeFormatter < Chic::Formatters::Nil
+  private
+
+  def value
+    return if object.blank?
+
+    object.strftime('%-d %b %Y %H:%M')
+  end
 end
 ```
 
-**Note:** You need to make sure that the object being presented and the context in which it is being presented, for example the view, are accessible through `object` and `context` on the presenter instance respectively.
+**Note:** You should always return `nil` if the object being formatted is blank so that the `Nil` formatter behaves correctly.
 
-### Using Presenters
+Provide additional formatter options as chainable methods:
+
+```ruby
+# app/formatters/date_time_formatter.rb
+
+class DateTimeFormatter < Chic::Formatters::Nil
+  def format=(value)
+    @format = value
+    self
+  end
+  
+  private
+
+  def value
+    return if object.blank?
+
+    object.strftime(@format || '%-d %b %Y %H:%M')
+  end
+end
+```
 
-Presenters should be instantiated from views using `.present`:
+### Using Formatters
+
+Declare formatted values in presenters using `formats`:
 
 ```ruby
+# app/presenters/foo_presenter.rb
+
+class FooPresenter < Chic::Presenter
+  formats :created_at,
+          with: 'DateTimeFormatter'
+end
+```
+
+Render formatted values by calling `#to_s` on the formatter returned, which happens implicitly in Rails views for example:
+
+```erb
 <% FooPresenter.present @foo do |foo_presenter, _foo| %>
-  <!-- ... -->
+  <%= foo_presenter.created_at %>
 <% end %>
 ```
 
-Collections can be presented using `.present_each`:
+#### Configurable options
+
+If the formatter derives from `Chic::Formatters::Nil`, then configure a blank value to be used:
 
 ```ruby
-<% FooPresenter.present_each @foos do |foo_presenter, _foo| %>
-  <!-- ... -->
+# app/presenters/foo_presenter.rb
+
+class FooPresenter < Chic::Presenter
+  formats :created_at,
+          with: 'DateTimeFormatter',
+          options: {
+            blank_value: '(Not yet created)'
+          }
+end
+```
+
+If the formatter supports additional options using chainable methods as described above, configure those options in the same way: 
+
+```ruby
+# app/presenters/foo_presenter.rb
+
+class FooPresenter < Chic::Presenter
+  formats :created_at,
+          with: 'DateTimeFormatter',
+          options: {
+            format: '%-d %B %Y at %H:%M'
+          }
+end
+```
+
+If needed, override those options where the formatted value is being rendered:
+
+```erb
+<% FooPresenter.present @foo do |foo_presenter, _foo| %>
+  <%= foo_presenter.created_at.format('%c').blank_value('–') %>
 <% end %>
 ```
 
-If you've made use of the view helpers, you can drop the class name:
+#### Named formatters
+
+Optionally configure formatters with a name, for example in a Rails initializer:
+
+```ruby
+# config/initializers/chic.rb
+
+require 'chic'
+
+Chic.configure do |config|
+  config.formatters.merge!(
+    date_time: 'DateTimeFormatter'
+  )
+end
+```
+
+Allowing you to refer to those formatters by name instead of by class:
 
 ```ruby
-<% present @foo do |foo_presenter, _foo| %>
+# app/presenters/foo_presenter.rb
+
+class FooPresenter < Chic::Presenter
+  formats :created_at,
+          with: :date_time
+end
+```
+
+## Logging
+
+If a presenter class for an object you're trying to present can't be found, an entry at debug level will be made to the configured logger.
+
+You can configure the logger to be used:
+
+```ruby
+# config/initializers/chic.rb
+
+require 'chic'
+
+Chic.configure do |config|
+  config.logger = Logger.new($stdout)
+end
+```
+
+It may be beneficial to know about missing presenter classes sooner than later, in which case you can enable exceptions when it makes sense to do so – for example, a Rails application in any environment other than production:
+
+```ruby
+# config/initializers/chic.rb
+
+require 'chic'
+
+Chic.configure do |config|
+  config.raise_exceptions = Rails.env.production? == false
+end
+```
+
+## Conventions
+
+A few helpful conventions that have gone a long way to keep things maintainable.
+
+### Naming presenter classes
+
+Presenter class names are derived by appending `Presenter` to the `#model_name` or the class name of the object being presented. It is strongly recommended that you stick to this convention, but if you need to change it – for example you might have overridden `#model_name` – you can do so by defining a `#presenter_class` method: 
+
+```ruby
+# app/forms/user/sign_up_form.rb
+
+class User::SignUpForm < User
+  include Chic::Presentable
+  
+  def self.model_name
+    ActiveModel::Name.new(self, nil, 'User')
+  end
+
+  def presenter_class
+    User::SignUpFormPresenter
+  end
+end
+```
+
+### Instantiate presenters in views only
+
+Try not instantiate presenters outside of the view layer if possible.
+
+**Don't**
+
+```ruby
+# app/controllers/foo_controller.rb
+
+class FoosController < ApplicationController
+  def show
+    @foo = Foo.find(params[:id])
+    @foo_presenter = FooPresenter.new(@foo)
+  end
+end
+```
+
+```erb
+<!-- app/views/foos/_show.html.erb -->
+
+<%= link_to @foo_presenter.created_at, foo_path(@foo) %>
+```
+
+**Do**
+
+```ruby
+# app/controllers/foo_controller.rb
+
+class FoosController < ApplicationController
+  def show
+    @foo = Foo.find(params[:id])
+  end
+end
+```
+
+```erb
+<!-- app/views/foos/_show.html.erb -->
+
+<% present @foo do |foo_presenter| %>
+  <%= link_to foo_presenter.created_at, foo_path(@foo) %>
+<% end %>
+```
+
+### Keep presenter instances scoped to only the view in which they're being used
+
+It can get messy if you pass presenter instances to other views, try avoid that if possible.
+
+**Don't**
+
+```erb
+<% present @foo do |foo_presenter| %>
   <!-- ... -->
+  <%= render partial: 'path/to/partial', locals: { foo: foo_presenter } %>
 <% end %>
 ```
 
-And:
+**Do**
 
-```ruby
-<% present_each @foo do |foo_presenter, _foo| %>
+```erb
+<% present @foo do |foo_presenter| %>
   <!-- ... -->
+  <%= render partial: 'path/to/partial', locals: { foo: @foo } %>
+<% end %>
+```
+
+### Use presenters and formatters for presentation only
+
+It may be tempting to use presenters for conditional logic, but it's far better to use the original object for anything other than presentation.
+
+**Don't**
+
+```erb
+<% present_each @foos do |foo_presenter, foo| %>
+  <% if foo_presenter.created_at %>
+    <%= link_to foo_presenter.created_at, foo_path(foo_presenter) %>
+  <% end
+<% end %>
+```
+
+**Note:** Passing a presenter instance to a route helper as shown would only work if the presenter declared `id` as a formatted attribute. While this may work, it is not predictable behaviour.
+
+**Do**
+
+```erb
+<% present_each @foos do |foo_presenter, foo| %>
+  <% if foo.created_at %>
+    <%= link_to foo_presenter.created_at, foo_path(foo) %>
+  <% end
 <% end %>
 ```
 

data/chic.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.7'
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'bundler', '~> 2.3.10'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rubocop', '~> 0.71'

data/lib/chic/configuration.rb

@@ -11,8 +11,9 @@ module Chic
       nil: Formatters::Nil
     }.freeze
 
-    attr_writer :logger,
-                :formatters
+    attr_writer :formatters,
+                :logger,
+                :raise_exceptions
 
     def formatters
       @formatters ||= FORMATTERS.dup
@@ -21,5 +22,9 @@ module Chic
     def logger
       @logger ||= Logger.new($stdout)
     end
+
+    def raise_exceptions
+      @raise_exceptions == true
+    end
   end
 end

data/lib/chic/errors.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module Chic
-  class PresentsOptionsNotValid < StandardError; end
-  class FormatsOptionsNotValid < StandardError; end
   class ConfigFormatterNotValid < StandardError; end
+  class FormatsOptionsNotValid < StandardError; end
+  class PresenterClassNotDefined < StandardError; end
+  class PresentsOptionsNotValid < StandardError; end
 end

data/lib/chic/presentable.rb

@@ -12,6 +12,8 @@ module Chic
 
     module_function
 
+    # rubocop: disable Metrics/AbcSize
+    # rubocop: disable Metrics/MethodLength
     def presenter_for(object)
       if object.respond_to?(:presenter_class)
         object.presenter_class
@@ -19,8 +21,14 @@ module Chic
         "#{object&.model_name || object.class.name}Presenter".constantize
       end
     rescue NameError, LoadError
+      if Chic.configuration.raise_exceptions
+        raise PresenterClassNotDefined, "Couldn't find a presenter for '#{object.class.name}'"
+      end
+
       Chic.configuration.logger&.debug "Couldn't find a presenter for '#{object.class.name}'"
       nil
     end
+    # rubocop: enable Metrics/AbcSize
+    # rubocop: enable Metrics/MethodLength
   end
 end

data/lib/chic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chic
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chic
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Lawrance Shepstone
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.3.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.3.10
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Opinionated presentation layer comprised of presenters and formatters.