pres 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52e2c8712efee843e682f2e3182e2f64023915c3
-  data.tar.gz: c49375a53ac4065124d60d21abf975d7399f577b
+  metadata.gz: 245241e4780fa67fb2d4bfa415969da3469475f6
+  data.tar.gz: 17c852515fbd44b8d5c0fbce156cdab402b2edf5
 SHA512:
-  metadata.gz: fac9d779069f6e4cc5b17f476fd9755f79d9d942451c0f48d8cadc50bbc83207fcaa79b90b7085bd40f05b50e42d281b78fc5e068ed38fa650f23bb415aa2a6e
-  data.tar.gz: a04a2234a5025980b4063c40ca7a1c9817c7b6ece10ea44f0f50548a6ab3d56e109419157c070f69ab55f9a671e17b077dbed4aef205d4c79e9cca7a03ece43f
+  metadata.gz: deda6b5cd350392c43eccf280bbb814494752622e027e630cb4c9189e986acebf9c840abe0620b4c41bc58a32e0986963728fb02ad41aaa8db8b7ce5519338f0
+  data.tar.gz: 1a1da379bfeea98e5d7912a116c46f96c995e67e0e918b12bf65f7e5f22e883e41960ab08a492178f571cbe24790b5e01233a9d83ee923a2501eb31b8c8064e9

data/README.md

@@ -12,13 +12,21 @@ The `pres` gem is a lightweight presenter solution.
 
 ## How and Why?
 
-Decorators add methods to a model. `pres` does not do that. `pres` encourages you
-to whitelist model methods (via delegation).
+Rails' `ViewContext` contains convenience methods for views, such as `link_to`,
+`url_for`, `truncate`, `number_to_currency`, etc. It's the thing that makes
+Rails views nice to work with.
 
-Other presenter libraries mix in all the methods from the Rails ViewContext to
+Other presenter libraries mix in all the methods from the Rails `ViewContext` to
 make it easy to call those methods in the Presenter class. This causes method
-bloat. `pres` instead injects the ViewContext as a dependency into the
-Presenter class, and uses `method_missing` to delegate to those methods.
+bloat. `pres` instead injects the `ViewContext` as a dependency into the
+Presenter class, and uses `method_missing` to delegate to `ViewContext` methods.
+So `pres` produces small classes that contain and delegate to an existing object 
+that handles server-side rendering.
+
+## Presenter vs. Decorator
+
+Decorators add methods to a model. `pres` encourages you to whitelist model methods 
+via delegation.
 
 ## Install
 
@@ -128,11 +136,15 @@ end
 
 Use the presenter objects in `doges/index.haml.html`
 
-```haml
 This renders "doges/_doge.html.haml" for each item, as usual:
+
+```haml
 = render @doges
+```
 
 Or use each:
+
+```haml
 - doges.each do |doge|
   = doge.name_header
 ```
@@ -190,13 +202,12 @@ end
 
 #### Presenters are objects
 
-You can mix in common methods. Move everything in `application_helper.rb` to
-`app/presenters/shared`:
+You can mix in common methods.
 
 ```ruby
 module Shared
-  def logout_link
-    # whatever
+  def truncated_name(length: 40)
+    truncate object.name, length: length
   end
 end
 
@@ -211,8 +222,9 @@ You can override methods without resorting to convoluted method names:
 class DogePresenter < Presenter
   include Shared
 
-  def logout_link
+  def truncated_name(length: 60)
     # whoa this one is different!
+    super(length: length)
   end
 end
 ```

data/lib/pres/presenter.rb

@@ -1,8 +1,16 @@
 # Base Presenter class
 # Construct with object, view_context, and optional options
-class Presenter < Struct.new(:object, :view_context, :options)
+class Presenter
+  attr_accessor :object, :options, :view_context
+
   delegate :id, :to_partial_path, to: :object
 
+  def initialize(object, view_context = nil, options = {})
+    self.object = object
+    self.view_context = view_context
+    self.options = options
+  end
+
   # Send missing symbols to view_context
   def method_missing(symbol, *args, &block)
     view_context.send(symbol, *args, &block)

data/lib/pres/presents.rb

@@ -28,7 +28,7 @@ module Presents
       object.map { |item| present(item, presenter: presenter, **args) }
     else
       presenter ||= Presenter if object.nil?
-      presenter ||= Object.const_get("#{ object.class.name }Presenter")
+      presenter ||= Object.const_get("#{object.class.name}Presenter")
       presenter.new(object, view_context, **args)
     end
   end

data/lib/pres/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pres
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tee Parham
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2015-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -89,17 +89,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/pres.rb
 - lib/pres/presenter.rb
 - lib/pres/presents.rb
 - lib/pres/version.rb
-- test/presenter_test.rb
-- test/presents_test.rb
-- test/test_helper.rb
 homepage: https://github.com/neighborland/pres
 licenses:
 - MIT
@@ -120,13 +115,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A Simple Rails Presenter
-test_files:
-- Gemfile
-- Rakefile
-- test/presenter_test.rb
-- test/presents_test.rb
-- test/test_helper.rb
+test_files: []
+has_rdoc: 

data/Gemfile

@@ -1,11 +0,0 @@
-source "https://rubygems.org"
-
-if ENV["TRAVIS"]
-  gem "coveralls", require: false
-end
-
-if ENV["BYEBUG"]
-  gem "byebug"
-end
-
-gemspec

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-task default: [:test]
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.test_files = %w(test/**/*.rb)
-  t.verbose = false
-end

data/test/presenter_test.rb

@@ -1,22 +0,0 @@
-require "test_helper"
-
-describe Presenter do
-  it "delegates to view_context" do
-    view_context = FakeViewContext.new
-    presenter = Presenter.new(nil, view_context)
-    assert presenter.respond_to?(:current_user)
-    assert presenter.respond_to?(:link_to)
-    view_context.expects(:link_to)
-    presenter.link_to "something"
-  end
-
-  it "is constructed without options" do
-    assert Presenter.new(nil, nil)
-  end
-
-  it "is constructed with options" do
-    presenter = Presenter.new(nil, nil, something: 42, secrets: "none")
-    assert_equal 42, presenter.options[:something]
-    assert_equal "none", presenter.options[:secrets]
-  end
-end

data/test/presents_test.rb

@@ -1,59 +0,0 @@
-require "test_helper"
-
-describe Presents do
-  class Doge
-  end
-
-  class DogePresenter < Presenter
-  end
-
-  class VeryDogePresenter < Presenter
-  end
-
-  class FakeController
-    include Presents
-
-    def wrap(object)
-      present(object)
-    end
-
-    def very_wrap(object)
-      present(object, presenter: VeryDogePresenter)
-    end
-
-    def view_context
-      FakeViewContext.new
-    end
-  end
-
-  let(:controller) { FakeController.new }
-
-  it "creates the default presenter" do
-    presenter = controller.wrap(Doge.new)
-    assert presenter.is_a?(DogePresenter)
-  end
-
-  it "creates the specified presenter" do
-    presenter = controller.very_wrap(Doge.new)
-    assert presenter.is_a?(VeryDogePresenter)
-  end
-
-  it "creates an array of default presenters" do
-    presenters = controller.wrap([Doge.new, Doge.new])
-    assert presenters.is_a?(Array)
-    assert_equal 2, presenters.size
-    assert presenters[0].is_a?(DogePresenter)
-  end
-
-  it "creates an array of specified presenters" do
-    presenters = controller.very_wrap([Doge.new, Doge.new])
-    assert presenters.is_a?(Array)
-    assert_equal 2, presenters.size
-    assert presenters[0].is_a?(VeryDogePresenter)
-  end
-
-  it "creates the default presenter for nil object" do
-    presenter = controller.wrap(nil)
-    assert presenter.is_a?(Presenter)
-  end
-end

data/test/test_helper.rb

@@ -1,23 +0,0 @@
-if ENV["TRAVIS"]
-  require "coveralls"
-  Coveralls.wear!
-end
-
-require "minitest/autorun"
-require "mocha/mini_test"
-require "byebug" if ENV["BYEBUG"]
-require "pres"
-
-class FakeViewContext
-  # An example of a method mixed into the view_context
-  def current_user
-    nil
-  end
-
-  private
-
-  # An example of a private method provided by the view_context
-  def link_to(*_)
-    nil
-  end
-end