Class: CsvRowModel::Export::File

Inherits:
Object
  • Object
show all
Defined in:
lib/csv_row_model/export/file.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(export_model_class, context = {}) ⇒ File

Returns a new instance of File.

Parameters:

  • export_model (Export) —

    export model class



7
8
9
10
 
# File 'lib/csv_row_model/export/file.rb', line 7

def initialize(export_model_class, context={})
  @export_model_class = export_model_class
  @context = context.to_h.symbolize_keys
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



4
5
6
 
# File 'lib/csv_row_model/export/file.rb', line 4

def context
  @context
end

#csv ⇒ Object (readonly)

Returns the value of attribute csv.



4
5
6
 
# File 'lib/csv_row_model/export/file.rb', line 4

def csv
  @csv
end

#export_model_class ⇒ Object (readonly)

Returns the value of attribute export_model_class.



4
5
6
 
# File 'lib/csv_row_model/export/file.rb', line 4

def export_model_class
  @export_model_class
end

#file ⇒ Object (readonly)

Returns the value of attribute file.



4
5
6
 
# File 'lib/csv_row_model/export/file.rb', line 4

def file
  @file
end

Instance Method Details

#append_model(source_model, context = {}) ⇒ Object Also known as: <<

Add a row_model to the

Parameters:

  • [] —

    source_model the source model of the export row model

  • context (Hash) (defaults to: {}) —

    the extra context given to the instance of the row model



19
20
21
22
23
 
# File 'lib/csv_row_model/export/file.rb', line 19

def append_model(source_model, context={})
  export_model_class.new(source_model, context.to_h.reverse_merge(self.context)).to_rows.each do |row|
    csv << row
  end
end

#generate(with_headers: true) ⇒ Object

Open a block to generate a file

Parameters:

  • with_headers (Boolean) (defaults to: true) —

    adds the header to the file if true



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/csv_row_model/export/file.rb', line 33

def generate(with_headers: true)
  @file = Tempfile.new([export_model_class.name, ".csv"])
  CSV.open(file.path, "wb") do |csv|
    @csv = csv
    export_model_class.setup(csv, context, with_headers: with_headers)
    yield self
  end
ensure
  @csv = nil
end

#generated? ⇒ Boolean

Returns true, if a csv file is generated.

Returns:

  • (Boolean) —

    true, if a csv file is generated



27
28
29
 
# File 'lib/csv_row_model/export/file.rb', line 27

def generated?
  !!file
end

#headers ⇒ Object 



12
13
14
 
# File 'lib/csv_row_model/export/file.rb', line 12

def headers
  export_model_class.headers
end

#to_s ⇒ Object 



44
45
46
 
# File 'lib/csv_row_model/export/file.rb', line 44

def to_s
  file.read
end