chic 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6ee27baaf52ccaffd000c9ffc37ba80e929ab93386c2f1dc2fb3d419d9cd86e
-  data.tar.gz: aebe4ade08bfff97f1fa3f4a96334dc4cb5cb9efdcbc108d6b00e1f81e781f1c
+  metadata.gz: 29c1b7b66f93c55e96cd4f3399b52a89461f32212c5752df80f3413a5c8898ce
+  data.tar.gz: 3cd78efa318d5614ab2c37a02c986bbe2f27760e1710591b32059889aa1c7cd4
 SHA512:
-  metadata.gz: 200473240b8f99cbef6229c0181a7e820df796b744f199f0b25bcb22656109c0338b14c63385f8fe6c6eaa06027bc97a33edd8e0635f995eb974d1635f449b48
-  data.tar.gz: 1b0dc1cc823cfd555e19f4c6aea0306a852fcef8ff9f66bb1c3f1c7189a6003368fb7f5497a825311c24dc65d8551e3779cd53f0c1da2f4192d8ac6f358f6115
+  metadata.gz: 101121d9551d426c4c6d8e39b75f96def4ae7bd22955d1c0a93ff6509e755bcad33eb55bc1bfbae0cbdbffae03c1aea459c82fcbc3dfad0410b5db77960e73ea
+  data.tar.gz: edef9ddd2761744818b172b34f1d6942fc2d3fafaf81ec6edc600e26eab36bfafb75d55916830931b74cf1e20679f657c81babf326ee5bc75e8241d6cdb370e8

data/.rubocop.yml

@@ -1,8 +1,11 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude:
+    - 'bin/**/*'
 
-Documentation:
-  Enabled: false
-
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
+
+Style/Documentation:
+  Enabled: false

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/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/chic.gemspec

@@ -23,8 +23,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.add_development_dependency 'bundler', '~> 2.3.10'
   spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rubocop', '>= 0.49.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 0.71'
 end

data/lib/chic/configuration.rb

@@ -11,15 +11,20 @@ module Chic
       nil: Formatters::Nil
     }.freeze
 
-    attr_writer :logger,
-                :formatters
+    attr_writer :formatters,
+                :logger,
+                :raise_exceptions
 
     def formatters
       @formatters ||= FORMATTERS.dup
     end
 
     def logger
-      @logger ||= Logger.new(STDOUT)
+      @logger ||= Logger.new($stdout)
+    end
+
+    def raise_exceptions
+      @raise_exceptions == true
     end
   end
 end

data/lib/chic/errors.rb

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

data/lib/chic/formats.rb

@@ -41,7 +41,6 @@ module Chic
       end
 
       # rubocop: disable Metrics/AbcSize
-      # rubocop: disable Metrics/CyclomaticComplexity
       def _validate_formats_options_with!(attributes, options)
         _raise_formats_options_not_valid '`with` must be a symbol or a class', attributes \
           if options.key?(:with) && !options[:with].is_a?(Symbol) && !options[:with].is_a?(Class)
@@ -49,9 +48,8 @@ module Chic
         _raise_formats_options_not_valid "`with` formatter :#{options[:with]} doesn't exist", attributes \
           if options.key?(:with) && options[:with].is_a?(Symbol) && !Chic.configuration.formatters.key?(options[:with])
       end
-      # rubocop: enable Metrics/AbcSize
-      # rubocop: enable Metrics/CyclomaticComplexity
 
+      # rubocop: enable Metrics/AbcSize
       def _validate_formats_options_value!(attributes, options)
         _raise_formats_options_not_valid '`value` must be a symbol or a lambda', attributes \
           if options.key?(:value) && !options[:value].is_a?(Symbol) && !options[:value].is_a?(Proc)
@@ -70,17 +68,33 @@ module Chic
 
     private
 
+    # rubocop: disable Metrics/MethodLength
     def _formatters
-      Chic.configuration.formatters
+      @_formatters ||= Chic.configuration.formatters.reduce({}) do |result, (key, klass)|
+        formatter = case klass
+                    when Class
+                      klass
+                    when String
+                      klass.constantize
+                    else
+                      raise ConfigFormatterNotValid, "Configured formatter for #{key} must be a class or class-string"
+                    end
+
+        result.merge(key => formatter)
+      end
     end
+    # rubocop: enable Metrics/MethodLength
 
     def _formats_options_value(attribute, options)
       return object&.public_send(attribute) unless options.is_a?(Hash) && options.key?(:value)
 
-      if options[:value].is_a?(Symbol)
+      case options[:value]
+      when Symbol
         send(options[:value])
-      elsif options[:value].is_a?(Proc)
+      when Proc
         instance_exec(&options[:value])
+      else
+        raise FormatsOptionsNotValid, "Options value for #{attribute} must be a symbol or a Proc"
       end
     end
 

data/lib/chic/formatters/nil.rb

@@ -17,7 +17,7 @@ module Chic
       private
 
       def value
-        object&.to_s
+        object.to_s
       end
     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/presents.rb

@@ -90,7 +90,7 @@ module Chic
 
     def present(object, with: nil)
       if object.is_a?(Enumerable)
-        object.map { |o| present(o, with) }
+        object.map { |o| present(o, with: with) }
       elsif with.present?
         with.new(object, context)
       elsif object.nil?
@@ -115,10 +115,13 @@ module Chic
     def _presents_options_value(attribute, options)
       return object&.public_send(attribute) unless options.is_a?(Hash) && options.key?(:value)
 
-      if options[:value].is_a?(Symbol)
+      case options[:value]
+      when Symbol
         send(options[:value])
-      elsif options[:value].is_a?(Proc)
+      when Proc
         instance_exec(&options[:value])
+      else
+        raise PresentsOptionsNotValid, "Options value for #{attribute} must be a symbol or a Proc"
       end
     end
   end

data/lib/chic/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Lawrance Shepstone
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-16 00:00:00.000000000 Z
+date: 2022-08-03 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
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: '0.71'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: '0.71'
 description: 
 email:
 - lawrance@collabcollective.com
@@ -81,6 +81,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/bundle
 - bin/console
 - bin/setup
 - chic.gemspec
@@ -111,15 +112,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Opinionated presentation layer comprised of presenters and formatters.