Module: Hecks::Projections::Reference

Extended by:
Hecks::Projector::Target
Defined in:
lib/hecks/projections/reference.rb

Overview

THE DSL REFERENCE PAGES, projected from the chapter's own Syntax aggregate — the tables come from the declaration, the prose is preserved from whatever is already committed.

THE FIRST PROJECTION THAT EMITS A TREE. emits: :files says so, and the framework writes the map rather than inferring one: a Hash of path => contents and a Hash that merely holds strings are the same object to Ruby, so only the projection can know which it meant. This is the case the output contract was designed for and deliberately left unimplemented until something real needed it.

NOT PURE, and it cannot be. Doc::Reference.pages READS the committed pages to harvest their prose, so the existing directory is an input — passed as from: rather than assumed, so the projection never reaches for a path of its own choosing.

Class Method Summary collapse

Methods included from Hecks::Projector::Target

projection_declares, projection_emits, projection_key, projection_requires, projects_as

Class Method Details

.call(bluebook:, options: {}) ⇒ Object 



28
29
30
31
32
33
34
35
 
# File 'lib/hecks/projections/reference.rb', line 28

def call(bluebook:, options: {})
  from = options[:from] or
    raise ArgumentError,
          ":reference harvests prose from the committed pages, so it needs " \
          "`from:` — the directory they live in"

  Doc::Reference.pages(from)
end