Skip to content
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

📚 Adding documentation for configuration #896

Merged
merged 1 commit into from
Jan 25, 2024
Merged
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
12 changes: 10 additions & 2 deletions lib/bulkrax.rb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ class Configuration
:export_path,
:field_mappings,
:file_model_class,
:fill_in_blank_source_identifiers,
:generated_metadata_mapping,
:import_path,
:multi_value_element_join_on,
Expand All @@ -35,12 +34,21 @@ class Configuration
:reserved_properties,
:server_name

##
# @return [#call] with arity 2. The first parameter is a {Bulkrax::ApplicationParser} and the
# second parameter is an Integer for the index of the record encountered in the import.
attr_accessor :fill_in_blank_source_identifiers

##
# Configure which persistence adapter you'd prefer to favor.
#
# @param adapter [Class<Bulkrax::PersistenceLayer::AbstractAdapter>]
attr_writer :persistence_adapter

##
# Configure the persistence adapter used for persisting imported data.
#
# @return [Bulkrax::PersistenceLayer::AbstractAdapter]
# @return [Class<Bulkrax::PersistenceLayer::AbstractAdapter>]
# @see Bulkrax::PersistenceLayer
def persistence_adapter
@persistence_adapter || derived_persistence_adapter
Expand Down
Loading