Class: DataShift::Exporters::Configuration

Inherits:
Configuration show all
Defined in:
lib/exporters/configuration.rb

Class Attribute Summary collapse

Instance Attribute Summary collapse

Attributes inherited from Configuration

#dummy_run, #exclude, #exclude_associations, #expand_associations, #force_inclusion_of_columns, #include_all_columns, #mandatory, #remove_columns, #remove_rails, #strict, #update_and_validate, #verbose, #with

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Configuration

#op_type_in_scope?, #op_types_in_scope, #prep_remove_list, rails_columns, #with_all?

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



37
38
39
40
41
42
43
 
# File 'lib/exporters/configuration.rb', line 37

def initialize
  super
  @abort_on_failure = false
  @csv_delimiter = ','
  @json = false
  @sheet_name = ''
end

Class Attribute Details

.configuration=(value) ⇒ Object (writeonly)

Sets the attribute configuration

Parameters:

  • value —

    the value to set the attribute configuration to.



57
58
59
 
# File 'lib/exporters/configuration.rb', line 57

def configuration=(value)
  @configuration = value
end

Instance Attribute Details

#abort_on_failure ⇒ Boolean

Default is false

Parameters:

  • Stop (Boolean) —

    processing and abort if a row fails to export

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/exporters/configuration.rb', line 20

def abort_on_failure
  @abort_on_failure
end

#csv_delimiter ⇒ Char

Parameters:

  • Char (Char) —

    to use as the column delimter for csv format

Returns:

  • (Char) 


25
26
27
 
# File 'lib/exporters/configuration.rb', line 25

def csv_delimiter
  @csv_delimiter
end

#json ⇒ Boolean

Parameters:

  • Export (Boolean) —

    association data in single column in JSON format

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/exporters/configuration.rb', line 30

def json
  @json
end

#sheet_name ⇒ String

Parameters:

  • Name (String) —

    for worksheet, otherwise uses Class name

Returns:

  • (String) 


35
36
37
 
# File 'lib/exporters/configuration.rb', line 35

def sheet_name
  @sheet_name
end

Class Method Details

.call ⇒ DataShift::Exporters::Configuration

Returns DataShift’s current configuration.

Returns:



46
47
48
 
# File 'lib/exporters/configuration.rb', line 46

def self.call
  @configuration ||= Exporters::Configuration.new
end

.configure {|call| ... } ⇒ Object

Modify DataShift’s current Export configuration “‘ DataShift::Exporters::Configuration.configure do |config|

config.abort_on_failure = false

end “‘

Yields:



66
67
68
 
# File 'lib/exporters/configuration.rb', line 66

def self.configure
  yield call
end

.from_hash(options) ⇒ Object

Modify DataShift’s current Export configuration from an options hash



72
73
74
75
76
77
78
79
 
# File 'lib/exporters/configuration.rb', line 72

def self.from_hash( options )

  DataShift::Configuration.from_hash(options)

  DataShift::Exporters::Configuration.configure do |config|
    config.csv_delimiter = options[:csv_delimiter] if(options[:csv_delimiter])
  end
end

.reset ⇒ Object 



50
51
52
 
# File 'lib/exporters/configuration.rb', line 50

def self.reset
  @configuration = Exporters::Configuration.new
end