Module: Kiba::Extend::ProjectConfig

Extended by:
Dry::Configurable
Defined in:
lib/kiba/extend/project_config.rb

Overview

Project-specific configuration settings.

All of these are optional. Ideally some of the project-specific settings from Kiba::Extend would be moved here.

Data modification collapse

Job tracking/handling collapse

Mermaid job graph generation collapse

Class Method Details

.blank_jobs ⇒ Array

Note:

It is NOT recommended that you set this manually. Generally, it should only be populated by project code or Kiba::Extend itself, in the course of running jobs or other commands.

This setting supports protection against errors due to unexpected empty job output or missing tables.

Returns:

  • (Array) —

    jobs run which did not write any output



55
 
# File 'lib/kiba/extend/project_config.rb', line 55

setting :blank_jobs, default: %i[], reader: true

.global_reversible_replacements ⇒ Hash{Regexp=>Hash}

Note:

The :replace values should always be Strings that do not naturally appear in the data, otherwise the reverse replace will mess up the data.

Configuration for making and reversing global replacements in your project via the Transforms::Replace::GlobalReversible and Transforms::Replace::GlobalReverse transforms.

The most common use for this setting is removing formatting or special characters from data values to avoid them complicating the internal data processing. The :replace values are reversed to normal values in client-facing worksheets and reports, and in final data prepared for ingest

Examples:

{
  /(?:\n|\r)/ => {replace: "%CR%", reversed: "\n"},
  /\t/ => {replace: "%TAB%", reversed: " "}
}

Returns:

  • (Hash{Regexp=>Hash}) —

    This Hash’s keys should be Regexps matching patterns in the original data that you wish to replace for the purposes of internal data processing. Each key’s value is a Hash with Symbol keys :replace and :reversed. The value of each of those keys is a String. :replace is what the original Regexp match should be replaced with. :reversed is what the :replace value should be changed to when the replacements are reversed.



41
42
43
 
# File 'lib/kiba/extend/project_config.rb', line 41

setting :global_reversible_replacements,
reader: true,
default: {}

.graph_dir ⇒ String, NilClass

Path to directory in which Mermaid .mmd files and generated image files will be stored. If not populated,

Returns:

  • (String, NilClass) 


64
 
# File 'lib/kiba/extend/project_config.rb', line 64

setting :graph_dir, reader: true, default: nil

.mermaid_config_path ⇒ nil, String

Returns path to project-specific JSON mermaid config, if defaults are not working for you.

Examples:

Use in project, assuming file is in top level of project repo

Kiba::Extend::ProjectConfig.config.mermaid_config_path = File.join(
  Bundler.root, "mmd_config.json"
)

Returns:

  • (nil, String) —

    path to project-specific JSON mermaid config, if defaults are not working for you



72
73
74
 
# File 'lib/kiba/extend/project_config.rb', line 72

setting :mermaid_config_path,
reader: true,
default: nil