Class: BasePresenter

Inherits:

SimpleDelegator

Object
SimpleDelegator
BasePresenter

show all

Defined in:: app/presenters/base_presenter.rb

Overview

Base presenter class with the basic pattern implementation
initialize with a model instance the rails view context

Direct Known Subclasses

CatalogItemPresenter, CatalogPresenter, Crm::BasePresenter, Crm::Report::ActivityPerformanceResultPresenter, Crm::Report::ChannelRevenueResultsPresenter, Crm::Report::CustomerPerformanceResultsPresenter, DeliveryPresenter, Edi::MiraklSeller::BaseMiraklPresenter, ExportedCatalogItemPacketPresenter, FaqPresenter, Feed::ItemPresenter, OrderPresenter, PostPresenter, RmaPresenter, Search::ActivityPresenter, Search::BudgetPresenter, Search::CertificationPresenter, Search::ContactPresenter, Search::CouponPresenter, Search::CreditApplicationPresenter, Search::CreditMemoPresenter, Search::CustomerPresenter, Search::DeliveryPresenter, Search::EmployeeReviewPresenter, Search::ExchangeRatePresenter, Search::InvoicePresenter, Search::InvoiceSummaryPresenter, Search::ItAssetPresenter, Search::ItemLedgerEntryPresenter, Search::ItemPresenter, Search::LedgerEntryPresenter, Search::LocatorRecordPresenter, Search::OpportunityPresenter, Search::OpportunitySummaryPresenter, Search::OrderPresenter, Search::OutgoingPaymentPresenter, Search::ProductCatalogPresenter, Search::PurchaseOrderPresenter, Search::QuotePresenter, Search::ReceiptPresenter, Search::RmaPresenter, Search::RoomConfigurationPresenter, Search::SalesCommissionPresenter, Search::ServiceJobPresenter, Search::SupplierItemPresenter, Search::SupportCasePresenter, Search::VoucherPresenter, SearchPresenter, ShowcasePresenter, VideoBasePresenter, Www::BasePresenter

Instance Attribute Summary collapse

#current_account ⇒ Object readonly
Returns the value of attribute current_account.
#options ⇒ Object readonly
Returns the value of attribute options.
#url_helper ⇒ Object readonly
Returns the value of attribute url_helper.

Delegated Instance Attributes collapse

#can? ⇒ Object
Alias for H#can?.
#capture ⇒ Object
Alias for H#capture.
#concat ⇒ Object
Alias for H#concat.
#content_tag ⇒ Object
Alias for H#content_tag.
#fa_icon ⇒ Object
Alias for H#fa_icon.
#link_to ⇒ Object
Alias for H#link_to.
#number_to_currency ⇒ Object
Alias for H#number_to_currency.
#simple_format ⇒ Object
Alias for H#simple_format.

Class Method Summary collapse

.presents(name) ⇒ void
Defines a named accessor returning the wrapped model.

Instance Method Summary collapse

#h ⇒ Object
The view context / helpers proxy.
#initialize(model, view = nil, options = nil) ⇒ BasePresenter constructor
A new instance of BasePresenter.
#present(attribute_name) ⇒ Object^?
Helper method which will first see if model responds to this method otherwise will simply return nil.
#r ⇒ Object
The wrapped model instance (short alias).
#safe_present(attribute_name) ⇒ Object^?
Like #present but swallows errors and returns nil.
#u ⇒ Object
The URL helper for route generation.

Constructor Details

#initialize(model, view = nil, options = nil) ⇒ `BasePresenter`

Returns a new instance of BasePresenter.

Parameters:

model (Object) —
the wrapped model instance
view (Object, nil) (defaults to: nil) —
view context (defaults to
ApplicationController.helpers)
options (Hash, nil) (defaults to: nil)

Options Hash (options):

current_account (Account) —
current account, exposed
as #current_account

# File 'app/presenters/base_presenter.rb', line 16

def initialize(model, view = nil, options = nil)
  options ||= {}
  @model = model
  @view = view
  @view ||= ApplicationController.helpers
  @url_helper ||= @view || Rails.application.routes.url_helpers
  @options = options
  @current_account = options[:current_account]
  super(@model)
end

Instance Attribute Details

#current_account ⇒ `Object` (readonly)

Returns the value of attribute current_account.



6
7
8

# File 'app/presenters/base_presenter.rb', line 6

def current_account
  @current_account
end

#options ⇒ `Object` (readonly)

Returns the value of attribute options.



6
7
8

# File 'app/presenters/base_presenter.rb', line 6

def options
  @options
end

#url_helper ⇒ `Object` (readonly)

Returns the value of attribute url_helper.



6
7
8

# File 'app/presenters/base_presenter.rb', line 6

def url_helper
  @url_helper
end

Class Method Details

.presents(name) ⇒ `void`

This method returns an undefined value.

Defines a named accessor returning the wrapped model.

Parameters:

name (Symbol, String) —
accessor name (e.g. :product_line)

# File 'app/presenters/base_presenter.rb', line 30

def self.presents(name)
  define_method(name) do
    @model
  end
end

Instance Method Details

#can? ⇒ `Object`

Alias for H#can?

Returns:

(Object) —
H#can?

See Also:

Module#delegate

8	# File 'app/presenters/base_presenter.rb', line 8 delegate :can?, :fa_icon, :link_to, :content_tag, :concat, :capture, :number_to_currency, :simple_format, to: :h

#capture ⇒ `Object`

Alias for H#capture

Returns:

(Object) —
H#capture

See Also:

Module#delegate

8	# File 'app/presenters/base_presenter.rb', line 8 delegate :can?, :fa_icon, :link_to, :content_tag, :concat, :capture, :number_to_currency, :simple_format, to: :h

#concat ⇒ `Object`

Alias for H#concat

Returns:

(Object) —
H#concat

See Also:

Module#delegate

8	# File 'app/presenters/base_presenter.rb', line 8 delegate :can?, :fa_icon, :link_to, :content_tag, :concat, :capture, :number_to_currency, :simple_format, to: :h

#content_tag ⇒ `Object`

Alias for H#content_tag

Returns:

(Object) —
H#content_tag

See Also:

Module#delegate

8	# File 'app/presenters/base_presenter.rb', line 8 delegate :can?, :fa_icon, :link_to, :content_tag, :concat, :capture, :number_to_currency, :simple_format, to: :h

#fa_icon ⇒ `Object`

Alias for H#fa_icon

Returns:

(Object) —
H#fa_icon

See Also:

Module#delegate

8	# File 'app/presenters/base_presenter.rb', line 8 delegate :can?, :fa_icon, :link_to, :content_tag, :concat, :capture, :number_to_currency, :simple_format, to: :h

#h ⇒ `Object`

The view context / helpers proxy.

Returns:

(Object) —
the view context



44
45
46

# File 'app/presenters/base_presenter.rb', line 44

def h
  @view
end

#link_to ⇒ `Object`

Alias for H#link_to

Returns:

(Object) —
H#link_to

See Also:

Module#delegate

8	# File 'app/presenters/base_presenter.rb', line 8 delegate :can?, :fa_icon, :link_to, :content_tag, :concat, :capture, :number_to_currency, :simple_format, to: :h

#number_to_currency ⇒ `Object`

Alias for H#number_to_currency

Returns:

(Object) —
H#number_to_currency

See Also:

Module#delegate

8	# File 'app/presenters/base_presenter.rb', line 8 delegate :can?, :fa_icon, :link_to, :content_tag, :concat, :capture, :number_to_currency, :simple_format, to: :h

#present(attribute_name) ⇒ `Object`^?

Helper method which will first see if model responds to this method
otherwise will simply return nil

Parameters:

attribute_name (Symbol, String) —
attribute or method name

Returns:

(Object, nil) —
the attribute value, or nil when undefined

# File 'app/presenters/base_presenter.rb', line 58

def present(attribute_name)
  attribute_key = attribute_name.to_sym
  return unless respond_to?(attribute_key) || r.respond_to?(attribute_key)

  send(attribute_key)
end

#r ⇒ `Object`

The wrapped model instance (short alias).

Returns:

(Object) —
the wrapped model



38
39
40

# File 'app/presenters/base_presenter.rb', line 38

def r
  @model
end

#safe_present(attribute_name) ⇒ `Object`^?

Like #present but swallows errors and returns nil.

Parameters:

attribute_name (Symbol, String) —
attribute or method name

Returns:

(Object, nil) —
the attribute value, or nil on error

# File 'app/presenters/base_presenter.rb', line 68

def safe_present(attribute_name)
  present(attribute_name)
rescue StandardError
  nil
end

#simple_format ⇒ `Object`

Alias for H#simple_format

Returns:

(Object) —
H#simple_format

See Also:

Module#delegate

8	# File 'app/presenters/base_presenter.rb', line 8 delegate :can?, :fa_icon, :link_to, :content_tag, :concat, :capture, :number_to_currency, :simple_format, to: :h

#u ⇒ `Object`

The URL helper for route generation.

Returns:

(Object) —
the URL helper



50
51
52

# File 'app/presenters/base_presenter.rb', line 50

def u
  @url_helper
end

Class: BasePresenter

Overview

Direct Known Subclasses

Instance Attribute Summary collapse

Delegated Instance Attributes collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model, view = nil, options = nil) ⇒ BasePresenter

Instance Attribute Details

#current_account ⇒ Object (readonly)

#options ⇒ Object (readonly)

#url_helper ⇒ Object (readonly)

Class Method Details

.presents(name) ⇒ void

Instance Method Details

#can? ⇒ Object

#capture ⇒ Object

#concat ⇒ Object

#content_tag ⇒ Object

#fa_icon ⇒ Object

#h ⇒ Object

#link_to ⇒ Object

#number_to_currency ⇒ Object

#present(attribute_name) ⇒ Object?

#r ⇒ Object

#safe_present(attribute_name) ⇒ Object?

#simple_format ⇒ Object

#u ⇒ Object

#initialize(model, view = nil, options = nil) ⇒ `BasePresenter`

#current_account ⇒ `Object` (readonly)

#options ⇒ `Object` (readonly)

#url_helper ⇒ `Object` (readonly)

.presents(name) ⇒ `void`

#can? ⇒ `Object`

#capture ⇒ `Object`

#concat ⇒ `Object`

#content_tag ⇒ `Object`

#fa_icon ⇒ `Object`

#h ⇒ `Object`

#link_to ⇒ `Object`

#number_to_currency ⇒ `Object`

#present(attribute_name) ⇒ `Object`^?

#r ⇒ `Object`

#safe_present(attribute_name) ⇒ `Object`^?

#simple_format ⇒ `Object`

#u ⇒ `Object`