Class: Draper::Base

Inherits:

Object

• Object
• Draper::Base

show all

Defined in:

lib/draper/base.rb

Constant Summary

DEFAULT_DENIED =

Object.new.methods << :method_missing

FORCED_PROXY =

[:to_param]

Instance Attribute Summary (collapse)

• - (Object) context

  Returns the value of attribute context.

• - (Object) model

  Returns the value of attribute model.

Class Method Summary (collapse)

• + (Object) allows(*input_allows)

  Specifies a white list of methods which may be proxied to to the wrapped object.

• + (Object) decorate(input, context = nil)

  Initialize a new decorator instance by passing in an instance of the source class.

• + (Object) decorates(input)

  Typically called within a decorator definition, this method specifies the name of the wrapped object class.

• + (Object) denies(*input_denied)

  Specifies a black list of methods which may not be proxied to to the wrapped object.

• + (Object) find(input)

  Proxies to the class specified by decorates to automatically lookup an object in the database and decorate it.

• + (Object) lazy_helpers

  Calling lazy_helpers will make the built-in and user-defined Rails helpers accessible as class methods in the decorator without using the h. or helpers. proxy.

• + (ActiveModel::Name) model_name

  Use primarily by form_for, this returns an instance of ActiveModel::Name set to the wrapped model's class name.

Instance Method Summary (collapse)

• - (Object) helpers (also: #h)

  Access the helpers proxy to call built-in and user-defined Rails helpers.

• - (Base) initialize(input, context = nil) constructor

  Initialize a new decorator instance by passing in an instance of the source class.

• - (Object) to_model

  Fetch the original wrapped model.

17
18
19
20
21
22
23

# File 'lib/draper/base.rb', line 17

def initialize(input, context = nil)
  input.inspect # forces evaluation of a lazy query from AR
  self.class.model_class = input.class if model_class.nil?
  @model = input
  self.context = context
  build_methods
end

5
6
7

# File 'lib/draper/base.rb', line 5

def context
  @context
end

5
6
7

# File 'lib/draper/base.rb', line 5

def model
  @model
end

73
74
75
76
77

# File 'lib/draper/base.rb', line 73

def self.allows(*input_allows)
  raise ArgumentError, "Specify at least one method (as a symbol) to allow when using allows" if input_allows.empty?
  raise ArgumentError, "Use either 'allows' or 'denies', but not both." unless (self.denied == DEFAULT_DENIED)
  self.allowed = input_allows
end

90
91
92

# File 'lib/draper/base.rb', line 90

def self.decorate(input, context = nil)
  input.respond_to?(:each) ? input.map{|i| new(i, context)} : new(input, context)
end

46
47
48
49

# File 'lib/draper/base.rb', line 46

def self.decorates(input)
  self.model_class = input.to_s.camelize.constantize
  model_class.send :include, Draper::ModelSupport
end

58
59
60
61
62

# File 'lib/draper/base.rb', line 58

def self.denies(*input_denied)
  raise ArgumentError, "Specify at least one method (as a symbol) to exclude when using denies" if input_denied.empty?
  raise ArgumentError, "Use either 'allows' or 'denies', but not both." if self.allowed?
  self.denied += input_denied
end

30
31
32

# File 'lib/draper/base.rb', line 30

def self.find(input)
  self.new(model_class.find(input))
end

109
110
111

# File 'lib/draper/base.rb', line 109

def self.lazy_helpers
  self.send(:include, Draper::LazyHelpers)
end

117
118
119

# File 'lib/draper/base.rb', line 117

def self.model_name
  ActiveModel::Name.new(model_class)
end

98
99
100

# File 'lib/draper/base.rb', line 98

def helpers
  @helpers ||= ApplicationController::all_helpers
end

124
125
126

# File 'lib/draper/base.rb', line 124

def to_model
  @model
end