mystique 0.9.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2ab3b70d916e56b8cce430379cf148e049ad2681931f5ed0f81eaa089f2fc86
-  data.tar.gz: 9785cc05e6ef78b7228ff97da5b11d303f6ff2053ac7a124ee69f6b15e021516
+  metadata.gz: 02f8184f7dc42d547bf1a953219e7fc4fbb441a6bc435370a48bd971b218cd8d
+  data.tar.gz: 3e379ef4b394972fc13598a585bcfa8a182e5b1ea62fb33719fba79a37f2caf1
 SHA512:
-  metadata.gz: c85c86ccea8b6a7178a3dc18a17e0cdad8663be3d0861e3ae6043cd1e8ec1e5479a327ca672bb60785f42dbab313b8fe475daaa776dda06186a63e3015aebd26
-  data.tar.gz: 6e30f16fb9fcf8867a8a285c5c54bbdc4f865ea4ef0eea014a3927cff130f4cbde4d016b92f6e424291db02ddf64df88365d4ac4eda7f79ef16cd3bbb7b361fe
+  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.rb

@@ -1,38 +1,38 @@
 require "mystique/version"
 
 require "callable"
-require "string_plus"
 
 require "mystique/undefined"
+require "mystique/presenter_class"
 require "mystique/presenter"
 
 module Mystique
-  module_function
 
-  def present(object, with: nil, context: nil, &block)
+  def self.present(object, with: nil, context: nil, &block)
     begin
-      presenter_class = presenter_class_for(object, with)
+      presenter_class = PresenterClass.new(object, with).to_class
       presenter_class.for(object, context, &block)
     rescue NameError
       return object
     end
   end
 
-  def present_collection(collection, context: nil, &block)
-    return to_enum(:present_collection, collection, context: context, &block) unless block_given?
+  def self.present_collection(collection, context: nil, with: nil, &block)
+    return to_enum(:present_collection, collection, context: context, with: with, &block) unless block_given?
 
     collection.each do |element|
       case block.arity
       when 2
-        block.call( present(element, context: context), element )
+        block.call( present(element, context: context, with: with), element )
       else
-        block.call(present(element, context: context))
+        block.call(present(element, context: context, with: with))
       end
     end
   end
 
-  def presenter_class_for(object, with)
-    with || StringPlus.constantize("#{object.class}Presenter")
+  private
+
+  def self.presenter_class_for(object, with)
+    with || Object.send(:const_get, "#{object.class}Presenter")
   end
-  private :presenter_class_for
 end

data/lib/mystique/presenter.rb

@@ -10,9 +10,9 @@ module Mystique
     end
 
     def self.for(object, context=nil)
-      self.new(object, context).tap do |presenter|
+      new(object, context).tap { |presenter|
         yield presenter if block_given?
-      end
+      }
     end
 
     def context
@@ -21,29 +21,31 @@ 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_")
-
-      value = target.send(method, *args, &block)
-
-      case
-      when formatted_method?(method)
-        format( value )
-      when presented_method?(method)
-        Mystique.present(value, context: context)
-      else
-        value
-      end
+      return o.send(method, *args, &block) if method.to_s.start_with?("to_")
+
+      o.send(method, *args, &block).yield_self { |value|
+        case
+        when formatted_method?(method)
+          format( value )
+        when presented_method?(method)
+          Mystique.present(value, context: context)
+        when presented_collection?(method)
+          Mystique.present_collection(value, context: context, &block)
+        else
+          value
+        end
+      }
     end
 
     def formatted_method?(method)
@@ -54,16 +56,22 @@ module Mystique
       __presented_methods__.include?(method)
     end
 
+    def presented_collection?(method)
+      __presented_collections__.include?(method)
+    end
+
     def format(value)
-      result = if __formats__.keys.include?(value)
+      result = case
+               when __formats__.keys.include?(value)
                  __formats__[value]
-               elsif __regex_formats__.any? { |regex, _| value =~ regex}
+               when __regex_formats__.any? { |regex, _| value =~ regex}
                  __regex_formats__.select { |regex, _| value =~ regex}.first.last
-               elsif __class_formats__.any? { |klass, _| value.is_a?(klass)}
+               when __class_formats__.any? { |klass, _| value.is_a?(klass)}
                  __class_formats__.select { |klass, _| value.is_a?(klass)}.first.last
                else
                  value
                end
+
       Mystique.present(Callable(result).call(value, context))
     end
 
@@ -88,6 +96,12 @@ module Mystique
       end
     end
 
+    def self.present_collection(matcher)
+      if matcher.is_a?(Symbol)
+        __presented_collections__ << matcher
+      end
+    end
+
     def self.format_and_present(matcher)
       format_method(method)
       present_method(method)
@@ -97,6 +111,10 @@ module Mystique
       @__presented_methods__ ||= []
     end
 
+    def self.__presented_collections__
+      @__presented_collections__ ||= []
+    end
+
     def self.__formatted_methods__
       @__formatted_methods__ ||= []
     end
@@ -105,6 +123,10 @@ module Mystique
       self.class.__presented_methods__
     end
 
+    def __presented_collections__
+      self.class.__presented_collections__
+    end
+
     def __formatted_methods__
       self.class.__formatted_methods__
     end

data/lib/mystique/presenter_class.rb

@@ -0,0 +1,36 @@
+module Mystique
+  class PresenterClass
+    def initialize(object, with=nil)
+      @with   = with
+      @object = object
+    end
+
+    def to_class
+      with || Object.send(:const_get, class_name)
+    end
+
+    def class_name
+      return with.to_s if with
+
+      "#{base_class_name(object)}Presenter"
+    end
+
+    private
+
+    attr_reader :with
+    attr_reader :object
+
+    def base_class_name(for_object)
+      case for_object
+      when Symbol, String
+        for_object.to_s.split(/_/).map(&:capitalize).join
+      when Array
+        for_object.map { |current_object|
+          base_class_name(current_object)
+        }.join("::")
+      else
+        for_object.class.to_s
+      end
+    end
+  end
+end

data/lib/mystique/version.rb

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

data/mystique.gemspec

@@ -19,10 +19,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.8"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry-byebug"
   spec.add_runtime_dependency "callable"
-  spec.add_runtime_dependency "string_plus"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mystique
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Federico Iachetti
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: string_plus
-  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'
 description: Put a presenter in front of your objects.
 email:
 - iachetti.federico@gmail.com
@@ -113,6 +99,7 @@ files:
 - lib/mystique.rb
 - lib/mystique/null_context.rb
 - lib/mystique/presenter.rb
+- lib/mystique/presenter_class.rb
 - lib/mystique/presenters.rb
 - lib/mystique/presenters/hash_presenter.rb
 - lib/mystique/undefined.rb
@@ -122,7 +109,7 @@ homepage: https://github.com/iachettifederico/mystique
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,8 +124,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Ruby presenter gem.
 test_files: []