livery 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9346fcf616e20f17e894e0067d5608c37f6e616ed4d9e32cc493cc5b389e10e3
-  data.tar.gz: 22d43934954cc145d5c0b3feec6c8513790de32b58b43f55cca8188b850f3b5b
+  metadata.gz: a4376e5c7d1405dadf06cadaec945198934e89cfc14c4174b733d090997e4642
+  data.tar.gz: b8e5851416f68c68db929caac0a37317c0aadbe42b3293f6d8f806e6970104b3
 SHA512:
-  metadata.gz: ae804d9cbed9af03626966850e162f31e164ba7f011d6b6b2e71d2351ad8c78593a115c9c4f4926a6ecda92faff360065a0fb2e889c451d19644fc647383a228
-  data.tar.gz: 96ceffc94eaeb28529663c5e2a17ce58ff8bfe9fdbb4af0ade4bbd608fb120c7fd019a5b6e7ae99e11ec59a8e818f8507dd8394284a1b6cba5fa8c174d9149fa
+  metadata.gz: 8bf641aecf3d12f80bddcc64d70f6713ec611aa104b4b0517169bc5fafc2ce691671c79b5ee571ebe38dd844301f3294607503e4dba0bd3f7e391b1d45d77253
+  data.tar.gz: e957e505db44c852a157d1fadb5722aeb76285cdb6e23fa21e0fb1ae01e3b186ec2b3b550cab3093e05e458f876a48a70b749f239ee6f9cbaaaac6f6f3c0b4b8

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 2.6.3
+  - 2.5.5
+
+gemfile:
+  - gemfiles/active_support_5.1.0.gemfile
+  - gemfiles/active_support_5.2.0.gemfile
+  - gemfiles/active_support_6.0.0.rc1.gemfile

data/Appraisals

@@ -0,0 +1,11 @@
+active_support_versions = %w(
+  5.1.0
+  5.2.0
+  6.0.0.rc1
+)
+
+active_support_versions.each do |version|
+  appraise "active_support_#{version}" do
+    gem "activesupport", "~> #{version}"
+  end
+end

data/Gemfile

@@ -2,5 +2,4 @@ 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

@@ -1,19 +1,22 @@
 PATH
   remote: .
   specs:
-    livery (0.1.0)
-      activesupport (~> 6.0.0.rc1)
+    livery (0.2.0)
+      activesupport (>= 5.1)
       i18n (>= 0.7, < 2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.0.rc1)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.4)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
     concurrent-ruby (1.1.5)
     diff-lcs (1.3)
     i18n (1.6.0)
@@ -33,19 +36,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    zeitwerk (2.1.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  appraisal
   bundler (~> 1.16)
   livery!
   rake (~> 10.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.3
+   1.17.2

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/active_support_5.1.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/active_support_5.1.0.gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: ..
+  specs:
+    livery (0.1.0)
+      activesupport (>= 5.1)
+      i18n (>= 0.7, < 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    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.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 5.1.0)
+  appraisal
+  bundler (~> 1.16)
+  livery!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/gemfiles/active_support_5.2.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/active_support_5.2.0.gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: ..
+  specs:
+    livery (0.1.0)
+      activesupport (>= 5.1)
+      i18n (>= 0.7, < 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    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.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 5.2.0)
+  appraisal
+  bundler (~> 1.16)
+  livery!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/gemfiles/active_support_6.0.0.rc1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 6.0.0.rc1"
+
+gemspec path: "../"

data/gemfiles/active_support_6.0.0.rc1.gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: ..
+  specs:
+    livery (0.1.0)
+      activesupport (>= 5.1)
+      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)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    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.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 6.0.0.rc1)
+  appraisal
+  bundler (~> 1.16)
+  livery!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/lib/livery/controller.rb

@@ -1,8 +1,33 @@
 module Livery
   module Controller
-    extend ActiveSupport::Concern
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
 
     module ClassMethods
+      # Overrides +AbstractController#view_assigns+ to return
+      # presenters set with the +present+ method.
+      #
+      # When you call this method in a controller class, instance
+      # variables set in actions will no longer be shared with views.
+      #
+      # ==== Examples
+      #
+      #   # app/controllers/posts_controller.rb
+      #   class PostController < ApplicationController
+      #     include Livery::Controler
+      #     use_presenters!
+      #
+      #     def show
+      #       @post = Post.find(params[:id])
+      #       present(post_presenter: @post)
+      #     end
+      #   end
+      #
+      # In this example, the instance variable +@post+ will not be
+      # shared with the view. Instead, the +present+ method will
+      # create a presenter-wrapped object available as
+      # +@post_presenter+ in the view.
       def use_presenters!
         define_method "view_assigns" do
           @_presenters || {}
@@ -10,6 +35,81 @@ module Livery
       end
     end
 
+    # Pass presenters to the view. Must be used with the class method
+    # +use_presenters!+.
+    #
+    # +hsh+ A hash whose keys define the names of variables used in
+    # the view, and values the objects that will be presented. Each
+    # object must either be a presenter, or have a corresponding
+    # presenter class; e.g., a +Post+ model should have a
+    # +PostPresenter+ class. If an enumerable is passed, each object
+    # within is mapped over. An exception is raised otherwise.
+    #
+    # ==== Examples
+    #
+    # +present+ will wrap non-presenter objects with their presenter
+    # classes. Here, the +Post+ object is wrapped with a
+    # +PostPresenter+:
+    #
+    #   # app/controllers/posts_controller.rb
+    #   class PostsController < ApplicationController
+    #     include Livery::Controller
+    #     use_presenters!
+    #
+    #     def show
+    #       post = Post.find(params[:id])
+    #
+    #       present(post: post)
+    #     end
+    #   end
+    #
+    # This is equivalent to (without using +use_presenters!+):
+    #
+    #   # app/controllers/posts_controller.rb
+    #   class PostsController < ApplicationController
+    #     def show
+    #       post = Post.find(params[:id])
+    #
+    #       @post = PostPresenter.new(post)
+    #     end
+    #   end
+    #
+    # It can handle enumerables:
+    #
+    #   # app/controllers/posts_controller.rb
+    #   class PostsController < ApplicationController
+    #     include Livery::Controller
+    #     use_presenters!
+    #
+    #     def index
+    #       posts = Post.all
+    #
+    #       # Equivalent to:
+    #       # @posts = posts.map { |post| PostPresenter.new(post) }
+    #       present(posts: posts)
+    #     end
+    #   end
+    #
+    # And presenter objects will not be re-wrapped:
+    #
+    #   # app/controllers/posts_controller.rb
+    #   class PostsController < ApplicationController
+    #     include Livery::Controller
+    #     use_presenters!
+    #
+    #     def show
+    #       post_presenter = PostPresenter.new(current_user.post)
+    #
+    #       # Equivalent to:
+    #       # @post = post_presenter
+    #       present(post: post_presenter)
+    #     end
+    #   end
+    #
+    # Presenter classes are found via a simple naming convention; an
+    # object of some class +Model+ will be wrapped with a
+    # +ModelPresenter+. If a corresponding presenter class is not
+    # found, an error is raised.
     def present(hsh)
       @_presenters ||= {}
       hsh.each_with_object(@_presenters) do |(k, v), acc|

data/lib/livery/presenter.rb

@@ -25,13 +25,15 @@ module Livery
       end
 
       def presenter_association(*names, source: nil, namespace: nil)
+        raise ArgumentError, '`source` must be a block' unless source.nil? || source.is_a?(Proc)
+
         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_resource = source.nil? ? @resource.public_send(name) : @resource.instance_exec(&source)
 
             association_presenter = Presenter.to_presenter(association_resource, namespace: namespace)
 
@@ -42,7 +44,8 @@ module Livery
       end
 
       def presenterize(klass, namespace: nil)
-        [namespace.presence, "#{klass}Presenter"].compact.join('::').constantize
+        presenter_klass_string = [namespace, "#{klass}Presenter"].compact.join('::')
+        ActiveSupport::Inflector.constantize(presenter_klass_string)
       end
 
       def resource(sym)
@@ -72,11 +75,11 @@ module Livery
     end
 
     def t(*args)
-      I18n.t(self.class.name.underscore + args.shift, *args)
+      I18n.t(ActiveSupport::Inflector.underscore(self.class.name) + args.shift, *args)
     end
 
     def t!(*args)
-      I18n.t!(self.class.name.underscore + args.shift, *args)
+      I18n.t!(ActiveSupport::Inflector.underscore(self.class.name) + args.shift, *args)
     end
 
     def to_model

data/lib/livery/rspec/helper.rb

@@ -4,7 +4,7 @@ module Livery
       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?
+            next nil unless obj
 
             klass = obj.instance_variable_get(:@doubled_module).target
             Livery::Presenter.presenterize(klass, namespace: namespace).new(obj)

data/lib/livery/version.rb

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

data/lib/livery.rb

@@ -1,4 +1,5 @@
-require "active_support/all"
+require "active_support/i18n"
+require "active_support/inflector"
 
 require "livery/version"
 require "livery/presenter"

data/livery.gemspec

@@ -28,7 +28,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "appraisal"
 
-  spec.add_dependency "activesupport", "~> 6.0.0.rc1"
+  spec.add_dependency "activesupport", ">= 5.1"
   spec.add_dependency "i18n", ">= 0.7", "< 2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: livery
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Hoy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2019-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,20 +54,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0.rc1
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0.rc1
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +111,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
+- Appraisals
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -106,6 +122,13 @@ files:
 - bin/rake
 - bin/rspec
 - bin/setup
+- gemfiles/.bundle/config
+- gemfiles/active_support_5.1.0.gemfile
+- gemfiles/active_support_5.1.0.gemfile.lock
+- gemfiles/active_support_5.2.0.gemfile
+- gemfiles/active_support_5.2.0.gemfile.lock
+- gemfiles/active_support_6.0.0.rc1.gemfile
+- gemfiles/active_support_6.0.0.rc1.gemfile.lock
 - lib/livery.rb
 - lib/livery/controller.rb
 - lib/livery/presenter.rb
@@ -131,7 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A library for presenter objects for use in Rails.