rails_presenter 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,149 @@
+# Rails Presenter
+
+[![Build Status](https://travis-ci.org/dfmonaco/rails_presenter.png?branch=master)](https://travis-ci.org/dfmonaco/rails_presenter)
+
+##Before:
+
+```haml
+# app/views/purchase_orders/show.html.haml
+
+%h1 Purchase Order
+%div
+  %p
+    %strong Date:
+    %span= localize(@purchase_order.date, format: :long)
+  %p
+    %strong Number:
+    %span= @purchase_order.number
+
+%h2 Customer
+%div
+  %p
+    %strong Name:
+    %span= @purchase_order.customer.name
+  %p
+    %strong Phone:
+    %span= @purchase_order.customer.phone || '------'
+  %p
+    %strong Email:
+    %span= mail_to(@purchase_order.customer.email)
+
+  %table
+    %thead
+      %tr
+        %th N°
+        %th Quantity
+        %th Item
+        %th Unit Price
+        %th Discount
+        %th Amount
+
+    %tbody
+      - @purchase_order.items.includes(:product).each_with_index do |item, index|
+        %tr
+          %td= index + 1
+          %td= number_with_precision(item.quantity)
+          %td= item.product.name
+          %td= number_to_currency(item.unit_price)
+          %td= number_to_percentage(item.discount)
+          %td= number_to_currency(item.amount)
+
+%div
+  %p
+    %strong Subtotal:
+    %span= number_to_currency(@purchase_order.subtotal)
+  %p
+    %strong Vat:
+    %span= number_to_currency(@purchase_order.vat)
+  %p
+    %strong Total:
+    %span= number_to_currency(@purchase_order.total)
+
+```
+
+##After:
+
+```haml
+# app/views/purchase_orders/show.html.haml
+
+- present(@purchase_order) do |order_presenter|
+
+  %h1 Purchase Order
+  = order_presenter.with_attrs :date, :number
+
+  %h2 Customer
+  = order_presenter.customer.with_attrs :name, :phone, :email
+
+  %table
+    %thead
+      %tr
+        %th N°
+        %th Quantity
+        %th Item
+        %th Unit Price
+        %th Discount
+        %th Amount
+
+    %tbody
+      - order_presenter.items.each_with_index do |item_presenter, index|
+        %tr
+          %td= index + 1
+          %td= item_presenter.quantity
+          %td= item_presenter.product
+          %td= item_presenter.unit_price
+          %td= item_presenter.discount
+          %td= item_presenter.amount
+
+  = order_presenter.with_attrs :subtotal, :vat, :total
+```
+
+## How did we get here?
+
+```ruby
+# app/presenters/purchase_order_presenter.rb
+
+class PurchaseOrderPresenter < RailsPresenter::Base
+  present :customer
+
+  present :items do
+    includes(:product)
+  end
+
+  format :subtotal, :vat, :total, with: :number_to_currency
+
+  def date
+    h.localize(super, format: :long)
+  end
+end
+```
+
+```ruby
+# app/presenters/customer_presenter.rb
+
+class CustomerPresenter < RailsPresenter::Base
+  def email
+    h.mail_to super
+  end
+end
+```
+
+```ruby
+# app/presenters/item_presenter.rb
+
+class ItemPresenter < RailsPresenter::Base
+  present :product
+
+  format :quantity, with: :number_with_precision
+  format :unit_price, :amount, with: :number_to_currency
+  format :discount, with: :number_to_percentage
+end
+```
+
+```ruby
+# app/presenters/product_presenter.rb
+
+class ProductPresenter < RailsPresenter::Base
+end
+```
+
+

data/app/helpers/presenter_helper.rb

@@ -1,18 +1,3 @@
 module PresenterHelper
-  def present(object, template = self, &block)
-    if [Array, ActiveRecord::Relation].include? object.class
-      return object.map {|e| present(e)}
-    end
-
-    begin
-      presenter_class = "#{object.class}Presenter".constantize
-    rescue NameError
-      return object
-    end
-
-    presenter = presenter_class.new(object, template)
-
-    block.call(presenter) if block
-    presenter
-  end
+  include RailsPresenter::PresenterHelper
 end

data/app/views/shared/_show_with_attrs.html.erb

@@ -1,7 +1,7 @@
 <div class="show-with-attrs">
   <% attrs_hash.each do |name, value| %>
     <p>
-      <strong><%= name %></strong>
+      <strong><%= "#{name.to_s.titleize}: " %></strong>
       <span><%= value %></span>
     </p>
   <% end %>

data/lib/rails_presenter/base.rb

@@ -0,0 +1,182 @@
+require 'delegate'
+
+module RailsPresenter
+  class Base < SimpleDelegator
+    include RailsPresenter::PresenterHelper
+
+    @@nil_formatter = '----'
+
+    class << self
+      def location(*args)
+        define_method(:self_location, ->(location=nil) do
+          location ||= args.map do |p|
+            p = p.to_s
+            if p.delete! "@"
+              public_send("get_#{p}")
+            else
+              p
+            end
+          end
+
+          super(location)
+        end)
+      end
+
+      def present(*args, &block)
+        module_name = "#{name}Associations"
+
+        unless const_defined? module_name
+          include const_set(module_name, Module.new)
+        end
+
+        associations_module = const_get(module_name)
+
+        block ||= proc { self }
+
+        associations_module.module_eval do
+          args.each do |assoc_name|
+            define_method(assoc_name) do
+              instance_variable_get("@#{assoc_name}") ||
+              begin
+                association = if super().is_a?(Array) && super().respond_to?(:scoped)
+                  super().scoped
+                else
+                  super()
+                end
+                instance_variable_set("@#{assoc_name}", present(association.instance_eval(&block)))
+              end
+            end
+          end
+        end
+      end
+
+
+      def format(*attrs)
+        formatter = attrs.pop.values.first
+
+        module_name = formatter.to_s.camelize
+
+        unless const_defined? module_name
+          include const_set(module_name, Module.new)
+        end
+
+        formatter_module = const_get(module_name)
+
+        formatter_module.module_eval do
+          attrs.each do |attr|
+            define_method(attr) do
+              h.public_send(formatter, super())
+            end
+          end
+        end
+      end
+
+      def inherited(child_class)
+        child_class.instance_eval do
+          format_blank_attributes(*possible_blank_attributes) if based_on_active_record?
+        end
+      end
+
+      def format_blank_attributes(*attrs)
+        attr_module = Module.new do
+          attrs.each do |attr|
+            define_method(attr) do
+              return nil_formatter if super().blank?
+              super()
+            end
+          end
+        end
+
+        include const_set("BlankAttributes", attr_module)
+      end
+
+      private
+
+      def base_class
+        @base_class ||= to_s.chomp('Presenter').constantize
+      end
+
+      def based_on_active_record?
+        base_class.ancestors.include?(ActiveRecord::Base)
+      end
+
+      def possible_blank_attributes
+        base_class.column_names.reject do |attr|
+          ['id', 'created_at', 'updated_at'].include?(attr) ||
+          /_id\z/.match(attr) ||
+          base_class.validators_on(attr).any? {|v| !(v.options[:allow_nil] || v.options[:allow_blank])}
+        end
+      end
+    end
+
+    def initialize(base_object, template)
+      @template = template
+      super(base_object)
+    end
+
+    def present(object)
+      super(object, h)
+    end
+
+    def h
+      @template
+    end
+
+    def o
+      __getobj__
+    end
+
+    def to_s
+      respond_to?(:name) ? name : super
+    end
+
+    def with_attrs(*attrs)
+      attrs_hash = attrs.reduce({}) do |hash, attr|
+        if attr.is_a? Array
+          hash[attr.first]= attr.last.call(self)
+        else
+          hash[attr]= public_send(attr)
+        end
+        hash
+      end
+
+      h.render partial: 'shared/show_with_attrs', locals: {attrs_hash: attrs_hash}
+    end
+
+    def self_location(location = o)
+      h.polymorphic_path location
+    end
+
+    def link_to_self(options={})
+      text = options[:text] || self.to_s
+      path = options[:path] || self_location
+      h.link_to text, path
+    end
+
+    def nil_formatter
+      @@nil_formatter
+    end
+
+    def method_missing(method_name, *args)
+      case method_name.to_s
+      when /^h_(.*)$/
+        get_iv_from_view($1)
+      when /^get_(.*)$/
+        return o if o.is_a? $1.camelize.constantize
+        get_iv_from_view($1) || o.public_send($1)
+      else
+        super
+      end
+    end
+
+    private
+    def base_object_name
+      o.class.to_s.underscore
+    end
+
+    def get_iv_from_view(iv_name)
+      h.instance_variable_get("@#{iv_name}")
+    end
+
+  end
+end

data/lib/rails_presenter/presenter_helper.rb

@@ -0,0 +1,20 @@
+module RailsPresenter
+  module PresenterHelper
+    def present(object, template = self, &block)
+      if [Array, ActiveRecord::Relation].include? object.class
+        return object.map {|e| present(e)}
+      end
+
+      begin
+        presenter_class = "#{object.class}Presenter".constantize
+      rescue NameError
+        return object
+      end
+
+      presenter = presenter_class.new(object, template)
+
+      block.call(presenter) if block
+      presenter
+    end
+  end
+end

data/lib/rails_presenter/version.rb

@@ -1,3 +1,3 @@
 module RailsPresenter
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/rails_presenter.rb

@@ -1,4 +1,6 @@
-require "rails_presenter/engine"
+require 'rails_presenter/engine'
+require 'rails_presenter/presenter_helper'
+require 'rails_presenter/base'
 
 module RailsPresenter
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_presenter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000 Z
+date: 2013-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -82,17 +82,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- app/presenters/presenter.rb
 - app/helpers/presenter_helper.rb
 - app/views/shared/_show_with_attrs.html.erb
 - config/routes.rb
 - lib/tasks/rails_presenter_tasks.rake
 - lib/rails_presenter.rb
+- lib/rails_presenter/base.rb
 - lib/rails_presenter/engine.rb
 - lib/rails_presenter/version.rb
+- lib/rails_presenter/presenter_helper.rb
 - MIT-LICENSE
 - Rakefile
-- README.rdoc
+- README.md
 homepage: https://github.com/dfmonaco/rails_presenter
 licenses: []
 post_install_message: 
@@ -107,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 610965391
+      hash: 644764051
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -116,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 610965391
+      hash: 644764051
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25

data/README.rdoc

@@ -1,3 +0,0 @@
-= RailsPresenter
-
-This project rocks and uses MIT-LICENSE.

data/app/presenters/presenter.rb

@@ -1,180 +0,0 @@
-require 'delegate'
-
-class Presenter < SimpleDelegator
-  include PresenterHelper
-
-  @@nil_formatter = '----'
-
-  class << self
-    def location(*args)
-      define_method(:self_location, ->(location=nil) do
-        location ||= args.map do |p|
-          p = p.to_s
-          if p.delete! "@"
-            public_send("get_#{p}")
-          else
-            p
-          end
-        end
-
-        super(location)
-      end)
-    end
-
-    def present(*args, &block)
-      module_name = "#{name}Associations"
-
-      unless const_defined? module_name
-        include const_set(module_name, Module.new)
-      end
-
-      associations_module = const_get(module_name)
-
-      block ||= proc { self }
-
-      associations_module.module_eval do
-        args.each do |assoc_name|
-          define_method(assoc_name) do
-            instance_variable_get("@#{assoc_name}") ||
-            begin
-              association = if super().is_a?(Array) && super().respond_to?(:scoped)
-                super().scoped
-              else
-                super()
-              end
-              instance_variable_set("@#{assoc_name}", present(association.instance_eval(&block)))
-            end
-          end
-        end
-      end
-    end
-
-
-    def format(*attrs)
-      formatter = attrs.pop.values.first
-
-      module_name = formatter.to_s.camelize
-
-      unless const_defined? module_name
-        include const_set(module_name, Module.new)
-      end
-
-      formatter_module = const_get(module_name)
-
-      formatter_module.module_eval do
-        attrs.each do |attr|
-          define_method(attr) do
-            h.public_send(formatter, super())
-          end
-        end
-      end
-    end
-
-    def inherited(child_class)
-      child_class.instance_eval do
-        format_blank_attributes(*possible_blank_attributes) if based_on_active_record?
-      end
-    end
-
-    def format_blank_attributes(*attrs)
-      attr_module = Module.new do
-        attrs.each do |attr|
-          define_method(attr) do
-            return nil_formatter if super().blank?
-            super()
-          end
-        end
-      end
-
-      include const_set("BlankAttributes", attr_module)
-    end
-
-    private
-
-    def base_class
-      @base_class ||= to_s.chomp('Presenter').constantize
-    end
-
-    def based_on_active_record?
-      base_class.ancestors.include?(ActiveRecord::Base)
-    end
-
-    def possible_blank_attributes
-      base_class.column_names.reject do |attr|
-        ['id', 'created_at', 'updated_at'].include?(attr) ||
-        /_id\z/.match(attr) ||
-        base_class.validators_on(attr).any? {|v| !(v.options[:allow_nil] || v.options[:allow_blank])}
-      end
-    end
-  end
-
-  def initialize(base_object, template)
-    @template = template
-    super(base_object)
-  end
-
-  def present(object)
-    super(object, h)
-  end
-
-  def h
-    @template
-  end
-
-  def o
-    __getobj__
-  end
-
-  def to_s
-    respond_to?(:name) ? name : super
-  end
-
-  def with_attrs(*attrs)
-    attrs_hash = attrs.reduce({}) do |hash, attr|
-      if attr.is_a? Array
-        hash[attr.first]= attr.last.call(self)
-      else
-        hash[attr]= public_send(attr)
-      end
-      hash
-    end
-
-    h.render partial: 'shared/show_with_attrs', locals: {attrs_hash: attrs_hash}
-  end
-
-  def self_location(location = o)
-    h.polymorphic_path location
-  end
-
-  def link_to_self(options={})
-    text = options[:text] || self.to_s
-    path = options[:path] || self_location
-    h.link_to text, path
-  end
-
-  def nil_formatter
-    @@nil_formatter
-  end
-
-  def method_missing(method_name, *args)
-    case method_name.to_s
-    when /^h_(.*)$/
-      get_iv_from_view($1)
-    when /^get_(.*)$/
-      return o if o.is_a? $1.camelize.constantize
-      get_iv_from_view($1) || o.public_send($1)
-    else
-      super
-    end
-  end
-
-  private
-  def base_object_name
-    o.class.to_s.underscore
-  end
-
-  def get_iv_from_view(iv_name)
-    h.instance_variable_get("@#{iv_name}")
-  end
-
-end