lokap-presenter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1309d832f67f5f6647903f2cf3a98a2c7e8ab5335229faa243cd54bd9cbbc977
+  data.tar.gz: 114a5bd96c592e832664df4c60749943fbfa9ae47f944d5b812913210c69a73f
+SHA512:
+  metadata.gz: 2afa4a16cfccd59e8f250488123a15c801b3fda63fb6675510e92f056da514104f3801a20feb67be681d53b15397f3fcc2e948d7a769005e1f236668e5ef28e6
+  data.tar.gz: a4ae06040ad7ac85a795fb41e929b8fd4b50ca5fc2db84a79280262c172f704c78ebe2990b16ade950ffdfc665a28a6d52babb720fc71c8e20cbcc942c1f25f9

data/.yardopts

@@ -0,0 +1,5 @@
+--private
+--markup-provider=redcarpet
+--markup=markdown
+-
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.0.1] - 2022-07-01
+
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "yard"
+gem "redcarpet"
+gem "github-markup"
+

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    lokap-presenter (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    github-markup (4.0.1)
+    minitest (5.15.0)
+    rake (13.0.6)
+    redcarpet (3.5.1)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  github-markup
+  lokap-presenter!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  redcarpet
+  yard
+
+BUNDLED WITH
+   2.3.14

data/README.md

@@ -0,0 +1,123 @@
+A simple Rails view presenter for those with discerning taste.  
+_From the Library of Knowledge and Power_
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lokap-presenter'
+```
+
+## Usage
+
+Call the presenter within your view using the `present` helper:
+
+```ruby
+present(object, :class_name).render('template')
+```
+
+Your Presenter will be searched for in:
+
+```
+app/presenters/<class_name>_presenter.rb
+```
+
+Templates will be searched for in:
+
+```
+app/views/presenters/<class_name>/_default.html.erb
+app/views/presenters/<class_name>/_<template>.html.erb
+```
+
+And can be used like so:
+
+```ruby
+present(@person, :emotion).render
+# => app/presenters/emotion_presenter.rb
+# => app/views/presenters/emotion/_default.html.erb
+
+present(@person, :emotion).render(:happy)
+# => app/presenters/emotion_presenter.rb
+# => app/views/presenters/emotion/_happy.html.erb
+
+present(@person, :emotion).render(:sad)
+# => app/presenters/emotion_presenter.rb
+# => app/views/presenters/emotion/_sad.html.erb
+```
+
+Access the presenter inside your presenter templates:
+
+```ruby
+presenter.show_emotion
+p.show_emotion
+```
+
+### The Presenter Class
+
+The class has full access to the view... and view helpers, etc.  
+_Think of this as a helper on steroids (but less angry)_
+
+```ruby
+class EmotionPresenter < Lokap::Presenter
+  presents :person
+  delegate :emotions, :moods, to: :human
+
+  def who_is_this
+    person
+  end
+
+  def show_emotion
+    emotions.logic
+  end
+
+  def show_mood
+    moods.logic
+  end
+end
+```
+
+### Default Templates
+
+If a specified template is not found, the presenter will attempt to render a
+default view.
+
+```ruby
+present(@person, :share).render(:twitter)
+
+# looks for /views/presenters/share/_twitter.html.erb (doesn't exist)
+# => /views/presenters/share/_default.html.erb
+```
+
+This will also work for templates inside subfolders:
+
+```ruby
+present(@person, :share).render('social/twitter')
+
+# looks for /views/presenters/share/social/_twitter.html.erb (doesn't exist)
+# => /views/presenters/share/social/_default.html.erb
+```
+
+## Examples
+
+Here are a few different ways to utilize presenters:
+
+```ruby
+# Render (Default)
+present(@person, :share).render
+present(@person, :share).render(:twitter)
+present(@person, :share).render('social/twitter')
+
+# Block
+present(@person, :share) do |p|
+  link_to p.text, p.url
+end
+
+# Object
+share = present(@person, :share)
+share.render(:twitter)
+share.render(:facebook)
+share.render(:email)
+```
+
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/lokap/presenter/ext/action_view.rb

@@ -0,0 +1,29 @@
+module Lokap
+  module ActionView
+    # Raised when `ActionView::Context` can't locate a presenter's template  
+    # _(We catch the error and attempt to render a default template)_
+    class MissingTemplate < ::ActionView::MissingTemplate; end
+
+    # Helper method which allows access to your presenters
+    #
+    # @example
+    #   present(@person, :share).render
+    #   present(@person, :share).render(:twitter)
+    #   present(@person, :share).render('social/twitter')
+    #
+    # @param entity [Object] The object to present
+    # @param klass [Object] The underscored class name of your presenter
+    # @param options [Hash] Passed to the presenter (and template)
+    #
+    # @return [Lokap::Presenter] an instance of your presenter
+    def present(entity, klass = nil, options={})
+      base_klass = klass ? klass.to_s.titleize.gsub(' ', '') : entity.class
+      klass = "#{base_klass}Presenter".constantize
+      presenter = klass.new(entity, self, options)
+      yield presenter and return if block_given?
+      presenter
+    end
+  end
+end
+
+ActionView::Base.send(:include, Lokap::ActionView)

data/lib/lokap/presenter.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+if defined?(ActiveSupport.on_load)
+  ActiveSupport.on_load(:action_view) do
+    require_relative 'presenter/ext/action_view'
+  end
+end
+
+module Lokap
+  #
+  # `Lokap::Presenter` is the base class for which all presenters inherit
+  #
+  # @attribute context
+  #   @return [ActionView] Rails view context
+  # @attribute options
+  #   @return [Hash] Options passed to the presenter and the template
+  #
+  class Presenter < SimpleDelegator
+    attr_reader   :context
+    attr_accessor :options
+
+    # Creates a new `Lokap::Presenter` object
+    # @see Lokap::ActionView#present
+    #
+    # @example
+    #   present(@person, :share).render
+    #   present(@person, :share).render(:twitter)
+    #   present(@person, :share).render('social/twitter')
+    #
+    # @param entity [Object] Object/entity to present
+    # @param context [ActionView::Context] Rails view context for rendering
+    # @param options [Hash] Options passed to the presenter and template
+    #
+    # @return [Lokap::Presenter]
+    def initialize(entity, context, options={})
+      @entity  = entity
+      @context = context
+      @options = options
+
+      super(@context)
+    end
+
+    # Renders the specified template for a presenter
+    # @param partial [String|Symbol] The name of the partial in `app/views/presenters`
+    # @return [String] HTML output
+    def render(partial=nil)
+      super partial_options(partial)
+    rescue Lokap::ActionView::MissingTemplate
+      super partial_options(default_path(partial))
+    end
+
+    private
+
+    # Defines a method to access the presented entity
+    # @param name [String|Symbol] Name of the entity
+    def self.presents(name)
+      define_method(name) { @entity }
+    end
+
+    # Makes the presenter available to it's templates via `p.<method>` or
+    # `presenter.<method>`
+    def locals
+      { presenter: self, p: self }.merge(options)
+    end
+
+    # Generate Hash options to pass to the renderer
+    # @param partial [String] path to the template's partial
+    # @return [Hash] These options are passed to `render :partial, <options>`
+    def partial_options(partial=nil)
+      {
+        partial: template_path(partial),
+        locals:  locals
+      }
+    end
+
+    # The full path of the template to be rendered
+    # @param partial [String] The name of the partial to render
+    # @return [String] Full path to the template's partial
+    def template_path(partial=nil)
+      template = partial || default_template
+      "/presenters/#{class_path}/#{template}".downcase
+    end
+
+    # Generates the name for the class segment of the path
+    # @note Removes `_presenter` from the resulting string if present
+    # @return [String] Path for the subclassed presenter
+    def class_path
+      self.class.name.underscore.gsub('_presenter', '')
+    end
+
+    # Generates the default partial path when a template is not found or specified
+    # @param partial [String] full path to the template's partial
+    # @returns [String] full path to the specified template or the default template
+    def default_path(partial=nil)
+      return unless partial
+      prefix = partial.to_s.split('/')[0..-2].join('/')
+      [prefix, default_template].compact.join('/')
+    end
+
+    # The default name for the template when specified template can't be found
+    def default_template
+      'default'
+    end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: lokap-presenter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Bair
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-07 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- adambair@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/lokap/presenter.rb
+- lib/lokap/presenter/ext/action_view.rb
+homepage: https://github.com/adambair/lokap-presenter
+licenses:
+- Nonstandard
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/adambair/lokap-presenter
+  source_code_uri: https://github.com/adambair/lokap-presenter
+  changelog_uri: https://github.com/adambair/lokap-presenter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.14
+signing_key:
+specification_version: 4
+summary: A view presenter for those with discerning taste
+test_files: []