makeover 1.0.0.rc1 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: bc00466b91b8719cfb7e1373f7f37671f807a964
-  data.tar.gz: 0ebc94022e9c2e1146d4e15a515f1d0f7b1343c4
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2ViYWIwNmRiYTM2MjEzZDExZjhhNGQ4NGMyZGNiNjgyNzMyMzYxOA==
+  data.tar.gz: !binary |-
+    MTQyNzZhZWViZjlkN2ViMjc5OGMwNzcwZjg1ZDlhNDU5NjkyZGU1Mg==
 SHA512:
-  metadata.gz: 331489eeaf921f18402795ecccaab6d34a19413b77a15b0eb4fa2cd8252f08ff49f9f45f477243249dcd1fff869599c24c75647179daf031f686caa28109f86d
-  data.tar.gz: 272d5eb00ba6faa63fa2143383a04fb2ed12ab491fa29bb941337d1f0ded69daf5ec1e969ddf9314b7ba828ade962cdaf64fa6d912ea67050077b7430400d11c
+  metadata.gz: !binary |-
+    NjEwZWIyM2I1ZjgxMDdjZWY5ZGE1MzFkYmYyNzk5MjIwYTBlZWZjOTY1NzQ2
+    OTI4MjE0MjJmOWM4MzQxODU1N2Q4ODYyZDA4ZDYwOWYxYzU2ZjFjZTIzMGQy
+    MTVkYWFjMmU4MjI2MTM3ZjBkOTIyYTZlNGI5Mzk5ZDQ4ZjMwZWU=
+  data.tar.gz: !binary |-
+    MjA1ZWJmODg4MGYwOTM0OTQ5YWUxNjA3ZGFhNzEwNjc5NTZmZTdjZDUxMDM0
+    MGY5NDNjNzI4YjNiOTRlNjc2OWJhY2MxNjllM2M3N2NjYzQ2ZjY3Y2E5YmVl
+    YjhhNWNlYjg0ZWNkZjUyMGVhNTFhY2E4ZjE0YjE5NzU2YTBmYWI=

data/README.md

@@ -1,9 +1,10 @@
 # Makeover
 
-[![Build Status](https://travis-ci.org/tubbo/presenters.svg?branch=master)](https://travis-ci.org/tubbo/presenters)
+[![Build Status](https://travis-ci.org/tubbo/makeover.svg?branch=master)](https://travis-ci.org/tubbo/makeover)
 [![Code Climate](https://codeclimate.com/github/tubbo/presenters/badges/gpa.svg)](https://codeclimate.com/github/tubbo/presenters)
 [![Issue Count](https://codeclimate.com/github/tubbo/presenters/badges/issue_count.svg)](https://codeclimate.com/github/tubbo/presenters)
 [![Test Coverage](https://codeclimate.com/github/tubbo/presenters/badges/coverage.svg)](https://codeclimate.com/github/tubbo/presenters/coverage)
+[![Documentation](http://inch-ci.org/github/tubbo/makeover.svg?branch=master)](http://inch-ci.org/github/tubbo/makeover)
 
 A [decorator][] library for [Rails][] applications, inspired by
 [Draper][], but with an emphasis on architectural simplicity. Makeover

data/lib/generators/makeover/install/install_generator.rb

@@ -7,7 +7,8 @@ module Makeover
 
     MIXIN = "\n\s\sinclude Makeover::Presentable\n"
 
-    def copy_makeover
+    # Copy presenters into the project.
+    def copy_presenters
       %w(application collection).each do |type|
         filename = "app/presenters/#{type}_presenter.rb"
         if File.exist? Rails.root.join(filename).to_s
@@ -16,6 +17,7 @@ module Makeover
       end
     end
 
+    # Inject mixins into ApplicationRecord and ApplicationController
     def inject_mixin
       insert_into_file(
         'app/models/application_record.rb',

data/lib/generators/presenter/presenter_generator.rb

@@ -5,10 +5,12 @@ class PresenterGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('../templates', __FILE__)
   class_option :collection, type: :boolean, default: false
 
+  # Create a new presenter.
   def copy_presenter
     template "#{presenter}.rb.erb", "app/presenters/#{file_name}_presenter.rb"
   end
 
+  # Create corresponding test for presenter.
   def copy_test
     template(
       "#{test}.rb.erb",

data/lib/makeover/engine.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 module Makeover
   # Rails integration for the library. Sets up configuration.
   class Engine < ::Rails::Engine

data/lib/makeover/presentable.rb

@@ -30,11 +30,13 @@ module Makeover
       end
     end
 
-    class_methods do
+    # :nodoc:
+    # @!parse extend Makeover::Presentable::ClassMethods
+    module ClassMethods
       # Configure the class used to present records by default
       # within this object.
       #
-      # @param [Class] custom_presenter_class
+      # @param custom_presenter_class [Class]
       def presented_by(custom_presenter_class)
         self.presenter_class = custom_presenter_class
       end
@@ -42,7 +44,7 @@ module Makeover
       # Configure the class used to present collections by default
       # within this object.
       #
-      # @param [Class] custom_presenter_class
+      # @param custom_presenter_class [Class]
       def collection_presented_by(custom_presenter_class)
         self.collection_presenter_class = custom_presenter_class
       end
@@ -51,10 +53,9 @@ module Makeover
     # Presents the given model or the current object with the current
     # object's configured presenter or the given class in +with:+.
     #
-    # @param [Object]     model - Model class to present. (optional)
-    # @option [Class]     :with - Presenter object that wraps the model.
-    # @option [Hash]  **context - Additional context for the presenter in
-    #                     key/value pairs.
+    # @param model [Object] Model class to present. (optional)
+    # @param with [Class] Presenter object that wraps the model.
+    # @param context [Hash] Additional context for the presenter.
     def present(model = nil, with: nil, **context)
       model ||= self
       with ||= model.try(:presenter_class) || presenter_class

data/lib/makeover/presenter.rb

@@ -2,8 +2,14 @@
 module Makeover
   # Base Presenter class for all decorator objects.
   class Presenter < Delegator
+    # @!attribute [r] model
+    #   @return [Object] Object being delegated to.
     attr_reader :model
 
+    # Wrap a new model as a presenter object.
+    #
+    # @param model [Object] Model object to wrap.
+    # @param context [Hash] Extra context for the presenter.
     def initialize(model, **context)
       @model = model
       context.each do |option, value|
@@ -11,14 +17,47 @@ module Makeover
       end
     end
 
+    # Wraps +ActiveSupport#delegate+ to specifically delegate methods to
+    # the underlying object.
+    #
+    # @param methods [Array<Symbol>] *methods
+    # @param to [Symbol] :to
+    # @param options [Hash]
+    # @option options [Boolean] :allow_nil
+    # @option options [Boolean] :allow_blank
     def self.delegate(*methods, to: :model, **options)
       super(*methods, to: to, **options)
     end
 
+    # Delegate translation methods to i18n
+    delegate :t, to: I18n
+
+    # Figure out model class of presenter so we can delegate to the
+    # proper model_name instance.
+    def self.model_class
+      name.gsub(/Presenter/, '').classify.constantize
+    end
+
+    class << self
+      # Delegate model name lookups to model class of this presenter.
+      delegate :model_name, to: :model_class
+    end
+
+    # No-op for Draper support.
+    def self.delegate_all
+      # noop
+    end
+
+    # Return the model object.
+    #
+    # @return [Object]
     def __getobj__
       @model
     end
 
+    # Delegate to view context to run helper methods.
+    #
+    # @return [Makeover::Helpers]
     def helpers
       @helpers ||= Helpers.new
     end

data/lib/makeover/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Makeover
-  VERSION = '1.0.0.rc1'
+  VERSION = '1.0.0.rc2'
 end

data/lib/makeover.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 require 'makeover/engine'
 require 'makeover/version'
 

metadata

@@ -1,167 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: makeover
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - Tom Scott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-22 00:00:00.000000000 Z
+date: 2016-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   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: rspec-rails
   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: capybara
   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: poltergeist
   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: generator_spec
   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: rubocop
   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: yard
   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: travis-release
   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: codeclimate-test-reporter
   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: pry-byebug
   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'
 description: View model library for Rails applications. Extracted from brother.ly.
@@ -203,19 +203,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ! '>'
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: View model library for Rails applications.
 test_files: []
-has_rdoc: