Class: Ruport::Formatter

Inherits:

Object

• Object
• Ruport::Formatter

show all

Includes:

RenderingTools

Defined in:

lib/ruport/formatter.rb

Overview

class ReverseController < Ruport::Controller
   stage :reversed_header, :reversed_body
end

class ReversedText < Ruport::Formatter

   # Hooks formatter up to controller
   renders :txt, :for => ReverseController

   # Implements ReverseController's :reversed_header hook
   # but can be used by any controller
   def build_reversed_header
      output << "#{options.header_text}\n"
      output << "The reversed text will follow\n"
   end

   # Implements ReverseController's :reversed_body hook
   # but can be used by any controller
   def build_reversed_body
      output << data.reverse << "\n"
   end

end

puts ReverseController.render_txt(:data => "apple",
                                :header_text => "Hello Mike, Hello Joe!")

-----
OUTPUT:

Hello Mike, Hello Joe!
The reversed text will follow
elppa

Defined Under Namespace

Modules: RenderingTools Classes: CSV, HTML, PDF, PrawnPDF, Template, TemplateNotDefined, Text

Instance Attribute Summary (collapse)

• - (Object) data

  Set by the :data attribute from Controller#render.

• - (Object) format

  Set automatically by Controller#render(format) or Controller#render_format.

• - (Object) options

  Provides a Controller::Options object for storing formatting options.

Class Method Summary (collapse)

• + (Object) build(stage, &block)

  Allows you to implement stages in your formatter using the following syntax:.

• + (Object) formats

  Gives a list of formats registered for this formatter.

• + (Object) renders(fmts, options = {})

  Registers the formatter with one or more Controllers.

• + (Object) save_as_binary_file

  Use to define that your formatter should save in binary format.

Instance Method Summary (collapse)

• - (Object) clear_output

  Clears the output.

• - (Object) erb(string, options = {})

  Evaluates the string using ERB and returns the results.

• - (Object) method_missing(id, *args)

  Provides a shortcut for per-format handlers.

• - (Object) output

  Stores a string used for outputting formatted data.

• - (Object) save_output(filename)

  Saves the output to a file.

• - (Object) template

  Returns the template currently set for this formatter.

Methods included from RenderingTools

#render_group, #render_grouping, #render_inline_grouping, #render_row, #render_table

# will only be called if formatter is called for html output
html { output << "Look, I'm handling html" }

240
241
242
243
244
245
246

# File 'lib/ruport/formatter.rb', line 240

def method_missing(id,*args)
  if self.class.formats.include?(id)
    yield() if format == id
  else
    super
  end
end

131
132
133

# File 'lib/ruport/formatter.rb', line 131

def data
  @data
end

134
135
136

# File 'lib/ruport/formatter.rb', line 134

def format
  @format
end

192
193
194

# File 'lib/ruport/formatter.rb', line 192

def options
  @options ||= Controller::Options.new
end

class ReversedText < Ruport::Formatter
   renders :txt, :for => ReverseController

   build :reversed_header do
      output << "#{options.header_text}\n"
      output << "The reversed text will follow\n"
   end

   build :reversed_body do
      output << data.reverse << "\n"
   end
end

171
172
173

# File 'lib/ruport/formatter.rb', line 171

def self.build(stage,&block)
  define_method "build_#{stage}", &block
end

176
177
178

# File 'lib/ruport/formatter.rb', line 176

def self.formats
  @formats ||= []
end

renders :pdf, :for => MyController
render :text, :for => [MyController,YourController]
renders [:csv,:html], :for => YourController

146
147
148
149
150
151
152
153

# File 'lib/ruport/formatter.rb', line 146

def self.renders(fmts,options={})
  Array(fmts).each do |format|
    Array(options[:for]).each do |o|
      o.send(:add_format,self,format)
      formats << format unless formats.include?(format)
    end
  end
end

214
215
216
217
218

# File 'lib/ruport/formatter.rb', line 214

def self.save_as_binary_file
  define_method :save_output do |filename|
    File.open(filename,"wb") {|f| f << output }
  end
end

204
205
206

# File 'lib/ruport/formatter.rb', line 204

def clear_output
  @output.replace("")
end

224
225
226
227
228
229
230
231

# File 'lib/ruport/formatter.rb', line 224

def erb(string,options={})
  require "erb"
  if string =~ /(\.r\w+)|(\.erb)$/
    ERB.new(File.read(string)).result(options[:binding]||binding)
  else
    ERB.new(string).result(options[:binding]||binding)
  end
end

186
187
188
189

# File 'lib/ruport/formatter.rb', line 186

def output
  return options.io if options.io
  @output ||= ""
end

209
210
211

# File 'lib/ruport/formatter.rb', line 209

def save_output(filename)
  File.open(filename,"w") {|f| f << output }
end

181
182
183

# File 'lib/ruport/formatter.rb', line 181

def template
  Template[options.template] rescue nil || Template[:default]
end