Skip to content

Add default_values configuration #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,15 @@ UserImport.new(file: my_file) do
end
```


### Set default values

You can set default values for every model record with the `default_values` option:

```ruby
UserImport.new(file: csv_file, default_values: {batch: '2024a'})
```

### Skip import

You can skip the import of a model by calling `skip!` in an
Expand Down
4 changes: 3 additions & 1 deletion lib/csv_importer.rb
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,9 @@ def header
def rows
csv.rows.map.with_index(2) do |row_array, line_number|
Row.new(header: header, line_number: line_number, row_array: row_array, model_klass: config.model,
identifiers: config.identifiers, after_build_blocks: config.after_build_blocks)
identifiers: config.identifiers, after_build_blocks: config.after_build_blocks,
after_set_attributes_blocks: config.after_set_attributes_blocks,
default_values: config.default_values)
end
end

Expand Down
7 changes: 7 additions & 0 deletions lib/csv_importer/config.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,27 @@ class Config
attribute :identifiers # Array[Symbol] or Proc
attribute :when_invalid, Symbol, default: proc { :skip }
attribute :after_build_blocks, Array[Proc], default: []
attribute :after_set_attributes_blocks, Array[Proc], default: []
attribute :after_save_blocks, Array[Proc], default: []
attribute :default_values, Hash, default: {}

def initialize_copy(orig)
super
self.column_definitions = orig.column_definitions.dup
self.identifiers = orig.identifiers.dup
self.after_save_blocks = orig.after_save_blocks.dup
self.after_build_blocks = orig.after_build_blocks.dup
self.after_set_attributes_blocks = orig.after_set_attributes_blocks.dup
end

def after_build(block)
self.after_build_blocks << block
end

def after_set_attributes(block)
self.after_set_attributes_blocks << block
end

def after_save(block)
self.after_save_blocks << block
end
Expand Down
4 changes: 4 additions & 0 deletions lib/csv_importer/dsl.rb
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ def after_build(&block)
config.after_build(block)
end

def after_set_attributes(&block)
config.after_set_attributes(block)
end

def after_save(&block)
config.after_save(block)
end
Expand Down
7 changes: 6 additions & 1 deletion lib/csv_importer/row.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ class Row
attribute :model_klass
attribute :identifiers # Array[Symbol] or Proc
attribute :after_build_blocks, Array[Proc], default: []
attribute :after_set_attributes_blocks, Array[Proc], default: []
attribute :default_values, Hash, default: {}
attribute :skip, Virtus::Attribute::Boolean, default: false

# The model to be persisted
Expand All @@ -21,6 +23,7 @@ def model

set_attributes(model)

after_set_attributes_blocks.each { |block| instance_exec(model, &block) }
after_build_blocks.each { |block| instance_exec(model, &block) }
model
end
Expand Down Expand Up @@ -97,6 +100,8 @@ def find_model
model = build_model
set_attributes(model)

after_set_attributes_blocks.each { |block| instance_exec(model, &block) }

identifiers = model_identifiers(model)
return nil if identifiers.empty?

Expand All @@ -107,7 +112,7 @@ def find_model
end

def build_model
model_klass.new
model_klass.new(default_values)
end

def skip!
Expand Down
12 changes: 12 additions & 0 deletions spec/csv_importer_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,18 @@ class ImportUserCSVByFirstName
}.to_not raise_error(NoMethodError, "undefined method `downcase' for nil:NilClass")
end

it "sets default attributes" do
csv_content = "Email,Confirmed,First name,last_name
[email protected] , true, bob ,,"
default_values = {created_by_user_id: 123}
import = ImportUserCSV.new(content: csv_content, default_values: default_values)

import.run!

model = import.report.created_rows.first.model
expect(model).to have_attributes({created_by_user_id: 123})
end

describe "#when_invalid" do
it "could abort" do
csv_content = "email,confirmed,first_name,last_name
Expand Down