Class: View::Formatter Abstract

Inherits:

Object

• Object
• View::Formatter

show all

Defined in:

lib/view/formatter.rb

Overview

Instance Attribute Summary (collapse)

• - (Object) block readonly

  Returns the value of attribute block.

• - (Object) template readonly

  Returns the value of attribute template.

• - (Object) value readonly

  Returns the value of attribute value.

Class Method Summary (collapse)

• + (Object) as(type)

  Specify your own name for the formatter.

• + (Object) inherited(formatter)

  When you inherit from View::Formatter, the formatters goes on the list, but in reverse order, so that newer formatters kan override older ones.

• + (Object) skip_blank_formatter

  By default, blank values (nil, empty strings, etc), will override any formatter you specified.

• + (String) type

  The type of the formatter, either set via .as or automatically deducted from the class name.

Instance Method Summary (collapse)

• - (Object) all_options

  All options, unfiltered.

• - (String) format abstract

  If you didn't specify a format instance method inside specific formatters, this will raise an error.

• - (String) format!

  The final result of the formatter, with the block captured if given.

• - (Hash) options

  The "safe" options that you can toss around to helper methods.

• - (Object) to_s

  A hook for formatters to override so they can inject code between above the formatting, without all their inherited classes knowing about it.

6
7
8

# File 'lib/view/formatter.rb', line 6

def block
  @block
end

6
7
8

# File 'lib/view/formatter.rb', line 6

def template
  @template
end

6
7
8

# File 'lib/view/formatter.rb', line 6

def value
  @value
end

class SomeStrangeName < View::Formatter
  as :real_name
end

View.format @foo, :as => :real_name

36
37
38

# File 'lib/view/formatter.rb', line 36

def self.as(type)
  @type = type
end

19
20
21
22

# File 'lib/view/formatter.rb', line 19

def self.inherited(formatter)
  super
  formatters.unshift(formatter)
end

class IHandleMyOwnBlank < View::Formatter
  skip_blank_formatter
  # etc...
end

61
62
63

# File 'lib/view/formatter.rb', line 61

def self.skip_blank_formatter
  @skip_blank_formatter = true
end

44
45
46

# File 'lib/view/formatter.rb', line 44

def self.type
  @type || name.split('::').last.underscore
end

130
131
132

# File 'lib/view/formatter.rb', line 130

def all_options
  @options
end

70
71
72
73

# File 'lib/view/formatter.rb', line 70

def format
  msg = "The '#{self.class.type}' formatter needs to implement the #format method."
  raise NotImplementedError.new(msg)
end

120
121
122
123
124
125
126

# File 'lib/view/formatter.rb', line 120

def format!
  if block
    captured_value
  else
    to_s
  end
end

class Sentence < View::Formatter
  self.allowed_options = [ :words_connector, :last_word_connector ]

  def format
    value.to_sentence(options)
  end
end

class Link < View::Formatter
  self.reserved_options = [ :to ]

  def format
    template.link_to(value.to_s, all_options[:to], options)
  end
end

108
109
110
111
112

# File 'lib/view/formatter.rb', line 108

def options
  default_options.merge(all_options).delete_if do |key, value|
    option_not_allowed?(key)
  end
end

136
137
138

# File 'lib/view/formatter.rb', line 136

def to_s
  format
end