Module: Sourcerer

Defined in:
lib/sourcerer.rb,
lib/sourcerer/sync.rb,
lib/sourcerer/yaml.rb,
lib/sourcerer/jekyll.rb,
lib/sourcerer/builder.rb,
lib/sourcerer/version.rb,
lib/sourcerer/asciidoc.rb,
lib/sourcerer/rendering.rb,
lib/sourcerer/sync/cast.rb,
lib/sourcerer/templating.rb,
lib/sourcerer/source_skim.rb,
lib/sourcerer/util/pathifier.rb,
lib/sourcerer/mark_down_grade.rb,
lib/sourcerer/util/list_amend.rb,
lib/sourcerer/yaml_frontmatter.rb,
lib/sourcerer/sync/block_parser.rb,
lib/sourcerer/jekyll/liquid/tags.rb,
lib/sourcerer/source_skim/config.rb,
lib/sourcerer/jekyll/bootstrapper.rb,
lib/sourcerer/plaintext_converter.rb,
lib/sourcerer/source_skim/skimmer.rb,
lib/sourcerer/jekyll/monkeypatches.rb,
lib/sourcerer/jekyll/liquid/filters.rb,
lib/sourcerer/jekyll/liquid/file_system.rb,
lib/sourcerer/source_skim/markdown_skimmer.rb,
lib/asciidoctor/extensions/source-skim-tree-processor/extension.rb

Overview

A build-time code generator that creates assets such as new data, documentation, and even Ruby files from data extracted from AsciiDoc files, such as attributes and tagged regions.

Defined Under Namespace

Modules: AsciiDoc, Builder, Jekyll, MarkDownGrade, Rendering, SourceSkim, Sync, Templating, Util, Yaml, YamlFrontmatter Classes: PlainTextConverter

Constant Summary collapse

MARKDOWN_EXTS =

File extensions recognised as Markdown source files.

%w[.md .markdown].freeze
ASCIIDOC_EXTS =

File extensions recognised as AsciiDoc source files.

%w[.adoc .asciidoc .asc .ad].freeze
DEPRECATED_FACADE_METHODS = 
{
  # DO NOT add new public methods to this surface
  load_attributes: 'Sourcerer::AsciiDoc.load_attributes',
  load_include: 'Sourcerer::AsciiDoc.load_include',
  extract_tagged_content: 'Sourcerer::AsciiDoc.extract_tagged_content',
  generate_manpage: 'Sourcerer::AsciiDoc.generate_manpage',
  generate_html: 'Sourcerer::AsciiDoc.generate_html',
  extract_commands: 'Sourcerer::AsciiDoc.extract_commands',
  render_templates: 'Sourcerer::Rendering.render_templates',
  render_outputs: 'Sourcerer::Rendering.render_outputs',
  render_template: 'Sourcerer::Rendering.render_template',
  render_with_converter: 'Sourcerer::Rendering.render_with_converter'
}.freeze
VERSION = 
'0.4.0'

Class Method Summary collapse

Class Method Details

.extract_commands(file_path, role: 'testable') ⇒ Object 



88
89
90
91
 
# File 'lib/sourcerer.rb', line 88

def self.extract_commands file_path, role: 'testable'
  warn_deprecated_facade(:extract_commands)
  Sourcerer::AsciiDoc.extract_commands(file_path, role: role)
end

.extract_tagged_content(path_to_tagged_adoc, **options) ⇒ Object 



73
74
75
76
 
# File 'lib/sourcerer.rb', line 73

def self.extract_tagged_content path_to_tagged_adoc, **options
  warn_deprecated_facade(:extract_tagged_content)
  Sourcerer::AsciiDoc.extract_tagged_content(path_to_tagged_adoc, **options)
end

.generate_html(source_adoc, target_html, backend: 'asciidoctor-html5s') ⇒ Object 



83
84
85
86
 
# File 'lib/sourcerer.rb', line 83

def self.generate_html source_adoc, target_html, backend: 'asciidoctor-html5s'
  warn_deprecated_facade(:generate_html)
  Sourcerer::AsciiDoc.generate_html(source_adoc, target_html, backend: backend)
end

.generate_manpage(source_adoc, target_manpage) ⇒ Object 



78
79
80
81
 
# File 'lib/sourcerer.rb', line 78

def self.generate_manpage source_adoc, target_manpage
  warn_deprecated_facade(:generate_manpage)
  Sourcerer::AsciiDoc.generate_manpage(source_adoc, target_manpage)
end

.load_attributes(path) ⇒ Object 



59
60
61
62
 
# File 'lib/sourcerer.rb', line 59

def self.load_attributes path
  warn_deprecated_facade(:load_attributes)
  Sourcerer::AsciiDoc.load_attributes(path)
end

.load_include(path_to_main_adoc, tag: nil, tags: [], leveloffset: nil) ⇒ Object 



64
65
66
67
68
69
70
71
 
# File 'lib/sourcerer.rb', line 64

def self.load_include path_to_main_adoc, tag: nil, tags: [], leveloffset: nil
  warn_deprecated_facade(:load_include)
  Sourcerer::AsciiDoc.load_include(
    path_to_main_adoc,
    tag: tag,
    tags: tags,
    leveloffset: leveloffset)
end

.render_outputs(render_config) ⇒ Object 



98
99
100
101
 
# File 'lib/sourcerer.rb', line 98

def self.render_outputs render_config
  warn_deprecated_facade(:render_outputs)
  Sourcerer::Rendering.render_outputs(render_config)
end

.render_template(template_file, data_file, out_file, **options) ⇒ Object 



103
104
105
106
 
# File 'lib/sourcerer.rb', line 103

def self.render_template template_file, data_file, out_file, **options
  warn_deprecated_facade(:render_template)
  Sourcerer::Rendering.render_template(template_file, data_file, out_file, **options)
end

.render_templates(templates_config) ⇒ Object 



93
94
95
96
 
# File 'lib/sourcerer.rb', line 93

def self.render_templates templates_config
  warn_deprecated_facade(:render_templates)
  Sourcerer::Rendering.render_templates(templates_config)
end

.render_with_converter(render_entry) ⇒ Object 



108
109
110
111
 
# File 'lib/sourcerer.rb', line 108

def self.render_with_converter render_entry
  warn_deprecated_facade(:render_with_converter)
  Sourcerer::Rendering.render_with_converter(render_entry)
end