mystique 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6a1dbb9a3299b3f67616bf2ede3357984a31d59552f6b09994f93d1f100877f
-  data.tar.gz: e1bcc1e21a9100e6d7726b6cf669287e11f0490970e6b9c06c8b627d1e76c7af
+  metadata.gz: 02f8184f7dc42d547bf1a953219e7fc4fbb441a6bc435370a48bd971b218cd8d
+  data.tar.gz: 3e379ef4b394972fc13598a585bcfa8a182e5b1ea62fb33719fba79a37f2caf1
 SHA512:
-  metadata.gz: 29409b10c2b6a53917853cb50f7fca7acb67f956c855facde0a3ae7ac2a9a33b98eb3ff1bdc0461c609093516643aa9749d657a8aeba45adfafff53e1bf50799
-  data.tar.gz: 24479c27b05b802d70a80933ef932c7b5c6b10f141a7de29036b2a1fd60a2b601a007f364377cb9d9b973811e501792aad7f797213b39eab9236f94bdf9fd0f6
+  metadata.gz: c41407e8ae208303733524ff0688d3cb8fe6ff743f2460fd310f547ec06d2a01fa30fd39ce1186053c12f99effbc06e370f3ba697b9ffb52c1a067b402506c18
+  data.tar.gz: ea4e30ff77ded641e3e97915940566a5d72b5e7ea4430c67503bf7ae08157e880a9c3c5905b4e2501839cc827925a8bbe6dd7bdb0b3bfd790ff82579cd2f1a26

data/README.md

@@ -4,7 +4,7 @@ Mystique is a gem that implements the presenter pattern. It allows you to augmen
 
 ## How to present
 
-Mystique ships with the `.present` method, which wraps the target object in a presenter and yield the presenter if a block is given, or returns it. If there default presenter is not available, the original object gets yielded/returned.
+Mystique ships with the `.present` method, which wraps the target object in a presenter and yield the presenter if a block is given, and returns it. If there default presenter is not available, the original object gets yielded/returned.
 
 ```ruby
 Item = Struct.new(:name, :price)
@@ -26,10 +26,18 @@ The default presenter is inferred from the target object's class name. So, for t
 
 If `ItemPresenter` is not defined, you'll get back your original item.
 
+```ruby
+Other = Class.new
+
+other_presenter = Mystique.present(Other.new)
+
+other_presenter.class
+# => Other
+```
 
 ### Context
 
-The context is the object that, conveniently, provides the context in which the target object will be rendered.
+The context is the object that, conveniently, provides the context in which the original object will be rendered.
 
 Currently, the context defaults to a null context, which accepts any message sent and does nothing.
 
@@ -38,19 +46,34 @@ You can set the context in 3 ways:
 #### Using the `.context` method when defining your presenter:
 
 ```ruby
-class UserPresenter < Mystique::Presenter
-  context MyHelpers
+module UrlHelpers
+  def self.root_path
+    "/"
+  end
+end
 
-  # ...
+Web = Class.new
+
+class WebPresenter < Mystique::Presenter
+  context UrlHelpers
+
+  def root
+    h.root_path
+  end
 end
+
+web_presenter = Mystique.present(Web.new)
+
+web_presenter.root
+# => "/"
 ```
 
-This will set the `MyHelpers` module as the context for any instance of `UserPresenter`
+This will set the `UrlHelpers` module as the context for any instance of `WebPresenter`
 
 #### Passing it to the present method
 
 ```ruby
-user_presenter = Mystique.present(some_user, context: MyHelpers)
+user_presenter = Mystique.present(some_web_instance, context: UrlHelpers)
 ```
 
 Which will set `MyHelpers` as the context just for `user_presenter`
@@ -64,9 +87,11 @@ but if you pass a new context to a specific instance, it will use that one.
 
 ## Formatting
 
-Mystique provides a `format` method that allows you to define defaults for some response types.
+Mystique provides an `apply_format` method that allows you to define defaults for some response types.
+
+In every case, `apply_format` will accept a value or a block to return, which will yield the found value and the context.
 
-In every case, `format` will accept a value or a block to return, which will yield the found value and the context.
+In order to apply that format to a method, you must specify which method by calling `format`. If you forget to do this, Mystique will just retrieve the value from the original object and return that.
 
 ### Specific values
 
@@ -75,11 +100,14 @@ This is a great way to return a default String when you get a nil back (but it's
 ```ruby
 Item = Struct.new(:name, :price)
 class ItemPresenter < Mystique::Presenter
-  format nil, "N/A"
+  format :price
+
+  apply_format nil, "N/A"
 end
 
-item_presenter.price
-# => "N/A"
+Mystique.present(Item.new("Headphones")) do |item_presenter|
+  item_presenter.price            # => "N/A"
+end
 ```
 
 ### Classes
@@ -87,11 +115,21 @@ item_presenter.price
 You can pass a class name to the format method, and if the returned value is an instance of that class, it will return the specified value/block
 
 ```ruby
+module Helpers
+  def self.number_to_currency(number)
+    "$ %0.2f" % number
+  end
+end
+
+Item = Struct.new(:name, :price)
+
 class ItemPresenter < Mystique::Presenter
   context Helpers
-  format Float do |value, context|
+  apply_format Float do |value, context|
     context.number_to_currency(value)
   end
+
+  format :price
 end
 
 item_presenter = Mystique.present(Item.new("Rubik's Cube", 5.3))
@@ -111,10 +149,14 @@ module Helpers
   end
 end
 
+User = Struct.new(:name, :email)
+
 class UserPresenter < Mystique::Presenter
   context Helpers
 
-  format /\w+@\w+\.\w+/ do |email, context|
+  format :email
+  
+  apply_format /\w+@\w+\.\w+/ do |email, context|
     context.link_to(email, "mailto://#{email}")
   end
 end
@@ -130,16 +172,23 @@ user_presenter.email
 You can also set multiple matchers by using the `.format_multiple` method:
 
 ```ruby
-Mystique.present(Item.new("Wine", 50, 42.3)) do |presenter|
-  presenter.class
-  # => ItemPresenter
+require "time"
 
-  presenter.price
-  # => "$ 50.00"
+User = Struct.new(:last_log_in)
 
-  presenter.list_price
-  # => "$ 42.30"
+class UserPresenter < Mystique::Presenter
+  format :last_log_in
+  
+  format_multiple Date, Time do |value|
+    value.to_date.strftime("%-d %b %Y")
+  end
 end
+
+Mystique.present(User.new(Time.now)).last_log_in
+# => "29 Jul 2020"
+
+Mystique.present(User.new(Date.today)).last_log_in
+# => "29 Jul 2020"
 ```
 
 ## Installation

data/lib/mystique/presenter.rb

@@ -21,20 +21,20 @@ module Mystique
     alias :ctx :context
     alias :h :context
 
-    def target
+    def o
       @__object__
     end
 
     def inspect
-      "<#{self.class}(#{target.inspect}) context: #{context.inspect}>"
+      "<#{self.class}(#{o.inspect}) context: #{context.inspect}>"
     end
 
     private
 
     def method_missing(method, *args, &block)
-      return target.send(method, *args, &block) if method.to_s.start_with?("to_")
+      return o.send(method, *args, &block) if method.to_s.start_with?("to_")
 
-      target.send(method, *args, &block).yield_self { |value|
+      o.send(method, *args, &block).yield_self { |value|
         case
         when formatted_method?(method)
           format( value )

data/lib/mystique/version.rb

@@ -1,3 +1,3 @@
 module Mystique
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mystique
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Federico Iachetti
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-28 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler