livery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9346fcf616e20f17e894e0067d5608c37f6e616ed4d9e32cc493cc5b389e10e3
+  data.tar.gz: 22d43934954cc145d5c0b3feec6c8513790de32b58b43f55cca8188b850f3b5b
+SHA512:
+  metadata.gz: ae804d9cbed9af03626966850e162f31e164ba7f011d6b6b2e71d2351ad8c78593a115c9c4f4926a6ecda92faff360065a0fb2e889c451d19644fc647383a228
+  data.tar.gz: 96ceffc94eaeb28529663c5e2a17ce58ff8bfe9fdbb4af0ade4bbd608fb120c7fd019a5b6e7ae99e11ec59a8e818f8507dd8394284a1b6cba5fa8c174d9149fa

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in livery.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    livery (0.1.0)
+      activesupport (~> 6.0.0.rc1)
+      i18n (>= 0.7, < 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0.rc1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.4)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  livery!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Freebird, Inc.
+
+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,148 @@
+# Livery
+
+A simple presenter library for Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'livery'
+```
+
+## Usage
+
+Presenter classes that wrap models should be named
+`[ModelName]Presenter`, and inherit from `Livery::Presenter`.
+
+The underlying model object is called a `resource`, and is passed in
+initialization. Let's say we have a `Post` model:
+
+```ruby
+# app/models/post.rb
+
+class Post < ApplicationRecord
+  # title: string, body: text
+  belongs_to :author
+end
+```
+
+An empty `PostPresenter` would look like:
+
+```ruby
+# app/presenters/post_presenter.rb
+
+class PostPresenter < Livery::Presenter
+  resource :post
+end
+```
+
+By default, no methods are added except `resource` and, as an alias,
+the name of the resource; in this case `post`. So you should define
+methods or explicitly delegate them to the underlying object:
+
+```ruby
+# app/presenters/post_presenter.rb
+
+class PostPresenter < Livery::Presenter
+  resource :post
+
+  delegate :title,
+           :body,
+           to: :post
+
+  def posted_at
+    if post.created_at.present?
+      post.created_at.strftime('%a, %b %d %Y')
+    else
+      'Not posted yet'
+    end
+  end
+end
+
+# example:
+post = Post.new title: 'An aviation point of view'
+post_presenter = PostPresenter.new(post)
+post_presenter.title # => 'An aviation point of view'
+post_presenter.posted_at # => 'Not posted yet'
+```
+
+### Controllers
+
+Livery provides some convenience methods to wrap model objects with
+presenters, and to ensure that only presenters are passed to the view:
+
+```ruby
+# app/controllers/application_controller.rb
+
+class ApplicationController < ActionController::Base
+  include Livery::Controller # add this line
+end
+```
+
+The `use_presenters!` method overrides `view_assigns` so that instance
+variables are not passed to views. It also defines a `present()`
+method to explicitly pass them:
+
+```ruby
+# app/controllers/posts_controller.rb
+
+class PostsController < ApplicationController
+  use_presenters!
+
+  def show
+    @post = Post.find(params[:id])
+    present(current_post: @post)
+  end
+end
+```
+
+`present` will find the `PostPresenter` class to wrap the `@post`
+model object, and assign it to the `@current_post` instance variable
+in the view:
+
+```erb
+# app/views/posts/show.html.erb:
+
+<h1><%= @current_post.title ></h1>
+<h2>Posted at <%= @current_post.posted_at %></h2>
+```
+
+### Presenter associations
+
+Given an associated model (`post.author`) with a presenter class:
+
+```ruby
+class AuthorPresenter < Livery::Presenter
+  resource :author
+
+  def full_name
+    author.given_name + ' ' + author.surname
+  end
+end
+```
+
+you can use `presenter_association`:
+
+```ruby
+class PostPresenter < Livery::Presenter
+  resource :post
+
+  presenter_association :author
+
+  # ...
+end
+
+PostPresenter.new(post).author.full_name # => "Amelia Earhart"
+```
+
+## Development
+
+Run `bin/rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`,
+and then run `bundle exec rake release`, which will create a git tag
+for the version, push git commits and tags, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "livery"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/livery/controller.rb

@@ -0,0 +1,20 @@
+module Livery
+  module Controller
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def use_presenters!
+        define_method "view_assigns" do
+          @_presenters || {}
+        end
+      end
+    end
+
+    def present(hsh)
+      @_presenters ||= {}
+      hsh.each_with_object(@_presenters) do |(k, v), acc|
+        acc[k] = Livery::Presenter.to_presenter(v)
+      end
+    end
+  end
+end

data/lib/livery/presenter.rb

@@ -0,0 +1,90 @@
+module Livery
+  class Presenter
+    attr_reader :resource
+
+    def initialize(resource, options = {})
+      @resource = resource
+      options.each do |k, v|
+        raise ArgumentError, "cannot initialize `resource` variable" if k.to_s == "resource"
+        instance_variable_set("@#{k}", v)
+      end
+    end
+
+    class << self
+      def formatted_datetime(*names)
+        names.each do |name|
+          define_method name do
+            value = @resource.public_send(name)
+            I18n.l(value)
+          end
+        end
+      end
+
+      def method_added(sym)
+        raise "can't override resource on a subclass of Presenter" if sym == :resource
+      end
+
+      def presenter_association(*names, source: nil, namespace: nil)
+        names.each do |name|
+          instance_variable_name = "@#{name}".to_sym
+
+          define_method name do
+            return instance_variable_get(instance_variable_name) if instance_variable_defined?(instance_variable_name)
+
+            association_resource = source.present? ? @resource.instance_exec(&source) : @resource.public_send(name)
+
+            association_presenter = Presenter.to_presenter(association_resource, namespace: namespace)
+
+            instance_variable_set(instance_variable_name, association_presenter)
+            association_presenter
+          end
+        end
+      end
+
+      def presenterize(klass, namespace: nil)
+        [namespace.presence, "#{klass}Presenter"].compact.join('::').constantize
+      end
+
+      def resource(sym)
+        define_method sym do
+          @resource
+        end
+      end
+
+      def to_presenter(object, namespace: nil)
+        return object.map { |o| to_presenter_single(o, namespace: namespace) } if object.is_a?(Enumerable)
+        to_presenter_single(object, namespace: namespace)
+      end
+
+      private
+
+      def to_presenter_single(object, namespace: nil)
+        return nil if object.nil?
+
+        klass = object.class
+
+        if klass < Presenter
+          object
+        else
+          presenterize(klass, namespace: namespace).new(object)
+        end
+      end
+    end
+
+    def t(*args)
+      I18n.t(self.class.name.underscore + args.shift, *args)
+    end
+
+    def t!(*args)
+      I18n.t!(self.class.name.underscore + args.shift, *args)
+    end
+
+    def to_model
+      raise 'Presenter objects should not be used for forms. Call .resource on this Presenter'
+    end
+
+    def to_param(*args)
+      @resource.to_param(*args)
+    end
+  end
+end

data/lib/livery/rspec/helper.rb

@@ -0,0 +1,16 @@
+module Livery
+  module RSpec
+    module Helper
+      def presenter_receives_instance_doubles!
+        before(:each) do
+          allow(Livery::Presenter).to receive(:to_presenter_single) do |obj, namespace: nil|
+            next nil unless obj.present?
+
+            klass = obj.instance_variable_get(:@doubled_module).target
+            Livery::Presenter.presenterize(klass, namespace: namespace).new(obj)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/livery/version.rb

@@ -0,0 +1,3 @@
+module Livery
+  VERSION = "0.1.0"
+end

data/lib/livery.rb

@@ -0,0 +1,8 @@
+require "active_support/all"
+
+require "livery/version"
+require "livery/presenter"
+require "livery/controller"
+
+module Livery
+end

data/livery.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "livery/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "livery"
+  spec.version       = Livery::VERSION
+  spec.authors       = ["Michael Hoy", "Kevin Mannix", "John Russell"]
+  spec.email         = ["dev@getfreebird.com"]
+
+  spec.summary       = %q{A library for presenter objects for use in Rails.}
+  spec.description   = %q{A library for presenter objects for use in Rails.}
+  spec.homepage      = "https://www.getfreebird.com"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test/|spec/|features/|.ruby-version)}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "activesupport", "~> 6.0.0.rc1"
+  spec.add_dependency "i18n", ">= 0.7", "< 2"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: livery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Hoy
+- Kevin Mannix
+- John Russell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: A library for presenter objects for use in Rails.
+email:
+- dev@getfreebird.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- lib/livery.rb
+- lib/livery/controller.rb
+- lib/livery/presenter.rb
+- lib/livery/rspec/helper.rb
+- lib/livery/version.rb
+- livery.gemspec
+homepage: https://www.getfreebird.com
+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.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A library for presenter objects for use in Rails.
+test_files: []