Module: Sourcerer::Sync

Defined in:

lib/sourcerer/sync.rb,
lib/sourcerer/sync/cast.rb,
lib/sourcerer/sync/block_parser.rb

Overview

Canonical block synchronization and Liquid rendering for flat text files.

See Also:

• The main orchestrator class.
• The file-agnostic block parser.
• Sync/Cast documentation

Defined Under Namespace

Modules: BlockParser Classes: Cast

Class Method Summary

• .init(prime_path, target_path) ⇒ Cast::CastResult

  Bootstrap a brand-new target file from the prime template.

• .sync(prime_path, target_path) ⇒ Cast::CastResult

  Synchronise canonical blocks from ‘prime_path` into `target_path`.

Class Method Details

.init(prime_path, target_path) ⇒ Cast::CastResult

Bootstrap a brand-new target file from the prime template.

Parameters:

• prime_path (String)
• target_path (String)
• options (Hash) —

  Passed through to Sourcerer::Sync::Cast.init.

Returns:

• (Cast::CastResult)

# File 'lib/sourcerer/sync.rb', line 29

def self.init(prime_path, target_path, **)
  Cast.init(prime_path, target_path, **)
end

.sync(prime_path, target_path) ⇒ Cast::CastResult

Synchronise canonical blocks from ‘prime_path` into `target_path`.

Parameters:

• prime_path (String)
• target_path (String)
• options (Hash) —

  Passed through to Sourcerer::Sync::Cast.sync.

Returns:

• (Cast::CastResult)

# File 'lib/sourcerer/sync.rb', line 19

def self.sync(prime_path, target_path, **)
  Cast.sync(prime_path, target_path, **)
end