Skip to content

Commit

Permalink
πŸ“š Adding documentation for configuration
Browse files Browse the repository at this point in the history
This builds on a [question asked in Slack][1]

[1]: https://samvera.slack.com/archives/C03S9FS60KW/p1705681632335919
  • Loading branch information
jeremyf committed Jan 24, 2024
1 parent 3ae6402 commit b464623
Showing 1 changed file with 10 additions and 2 deletions.
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

0 comments on commit b464623

Please sign in to comment.