Class: DataShift::Loaders::Configuration

Inherits:
Configuration show all
Defined in:
lib/loaders/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.



39
40
41
42
43
44
45
 
# File 'lib/loaders/configuration.rb', line 39

def initialize
  @mandatory = []
  @allow_empty_rows = false
  @abort_on_failure = false
  @destroy_on_failure = true
  @header_row = 0
end

Class Attribute Details

.configuration=(value) ⇒ Object (writeonly)

Sets the attribute configuration

Parameters:

  • value —

    the value to set the attribute configuration to.



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

def configuration=(value)
  @configuration = value
end

Instance Attribute Details

#abort_on_failure ⇒ Object

Stop processing and abort if any row fails to import Default is false - row reported as failure but loading continues

Parameters:

  • (Boolean) 


32
33
34
 
# File 'lib/loaders/configuration.rb', line 32

def abort_on_failure
  @abort_on_failure
end

#allow_empty_rows ⇒ Object

Default is to stop processing once we hit a completely empty row. Over ride. WARNING maybe slow, as will process all rows as defined by Excel

Parameters:

  • (Boolean) 


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

def allow_empty_rows
  @allow_empty_rows
end

#destroy_on_failure ⇒ Object

Destroy failed objects - if object.save fails at any point destroy the current object - all or nothing Default is true - database is cleaned up

Parameters:

  • (Boolean) 


26
27
28
 
# File 'lib/loaders/configuration.rb', line 26

def destroy_on_failure
  @destroy_on_failure
end

#header_row ⇒ Object

Custom Readers

Raises:



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

def header_row
  raise MissingHeadersError, "Minimum row for Headers is 0 - passed #{@header_row}" if @header_row.to_i < 0
  @header_row
end

Class Method Details

.call ⇒ DataShift::Loaders::Configuration

Returns DataShift’s current configuration.

Returns:



55
56
57
 
# File 'lib/loaders/configuration.rb', line 55

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

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

Modify DataShift’s current Import configuration “‘ DataShift::Loaders::Configuration.configure do |config|

config.verbose = false

end “‘

Yields:



75
76
77
 
# File 'lib/loaders/configuration.rb', line 75

def self.configure
  yield call
end

.from_hash(options) ⇒ Object

Modify DataShift’s current Import configuration from an options hash



81
82
83
84
85
 
# File 'lib/loaders/configuration.rb', line 81

def self.from_hash( options )
  DataShift::Loaders::Configuration.configure do |config|
    config.mandatory = options[:mandatory] if(options[:mandatory])
  end
end

.reset ⇒ Object 



59
60
61
 
# File 'lib/loaders/configuration.rb', line 59

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