Module: Markdown::Merge::WrapperSupport

Defined in:
lib/markdown/merge/wrapper_support.rb

Overview

Shared bootstrap helpers for backend-specific Markdown wrapper gems.

Constant Summary collapse

SHARED_REEXPORTS = 
{
  FileAligner: Markdown::Merge::FileAligner,
  ConflictResolver: Markdown::Merge::ConflictResolver,
  MergeResult: Markdown::Merge::MergeResult,
  TableMatchAlgorithm: Markdown::Merge::TableMatchAlgorithm,
  TableMatchRefiner: Markdown::Merge::TableMatchRefiner,
  CodeBlockMerger: Markdown::Merge::CodeBlockMerger,
  NodeTypeNormalizer: Markdown::Merge::NodeTypeNormalizer
}.freeze
WRAPPER_AUTOLOADS = 
{
  DebugLogger: 'debug_logger',
  CommentTracker: 'comment_tracker',
  FreezeNode: 'freeze_node',
  FileAnalysis: 'file_analysis',
  PartialTemplateMerger: 'partial_template_merger',
  SmartMerger: 'smart_merger',
  Backend: 'backend'
}.freeze

Class Method Summary collapse

Class Method Details

.configure_debug_logger!(debug_logger_module:, env_var_name:, log_prefix:) ⇒ Object 



64
65
66
67
68
 
# File 'lib/markdown/merge/wrapper_support.rb', line 64

def configure_debug_logger!(debug_logger_module:, env_var_name:, log_prefix:)
  debug_logger_module.extend(Ast::Merge::DebugLogger)
  debug_logger_module.env_var_name = env_var_name
  debug_logger_module.log_prefix = log_prefix
end

.configure_file_analysis_subclass!(klass, default_backend:, default_parser_options: nil) ⇒ Object 



70
71
72
73
74
75
76
 
# File 'lib/markdown/merge/wrapper_support.rb', line 70

def configure_file_analysis_subclass!(klass, default_backend:, default_parser_options: nil)
  install_singleton_value_method!(klass, :default_backend, default_backend)
  return unless default_parser_options

  install_singleton_value_method!(klass, :default_parser_options,
                                  default_parser_options)
end

.configure_partial_template_merger_subclass!(klass, default_backend:, file_analysis_class:, smart_merger_class:) ⇒ Object 



109
110
111
112
113
114
 
# File 'lib/markdown/merge/wrapper_support.rb', line 109

def configure_partial_template_merger_subclass!(klass, default_backend:, file_analysis_class:,
                                                smart_merger_class:)
  install_singleton_value_method!(klass, :default_backend, default_backend)
  install_singleton_value_method!(klass, :file_analysis_class, file_analysis_class)
  install_singleton_value_method!(klass, :smart_merger_class, smart_merger_class)
end

.configure_smart_merger_subclass!(klass, default_backend:, default_freeze_token: nil, default_inner_merge_code_blocks: nil, default_parser_options: nil, file_analysis_class: nil, template_parse_error_class: nil, destination_parse_error_class: nil) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/markdown/merge/wrapper_support.rb', line 78

def configure_smart_merger_subclass!(
  klass,
  default_backend:,
  default_freeze_token: nil,
  default_inner_merge_code_blocks: nil,
  default_parser_options: nil,
  file_analysis_class: nil,
  template_parse_error_class: nil,
  destination_parse_error_class: nil
)
  install_singleton_value_method!(klass, :default_backend, default_backend)
  install_singleton_value_method!(klass, :default_freeze_token, default_freeze_token) if default_freeze_token
  unless default_inner_merge_code_blocks.nil?
    install_singleton_value_method!(klass, :default_inner_merge_code_blocks,
                                    default_inner_merge_code_blocks)
  end
  if default_parser_options
    install_singleton_value_method!(klass, :default_parser_options,
                                    default_parser_options)
  end
  install_singleton_value_method!(klass, :file_analysis_class, file_analysis_class) if file_analysis_class
  if template_parse_error_class
    install_singleton_value_method!(klass, :template_parse_error_class,
                                    template_parse_error_class)
  end
  return unless destination_parse_error_class

  install_singleton_value_method!(klass, :destination_parse_error_class,
                                  destination_parse_error_class)
end

.install!(wrapper_module:, require_prefix:, default_freeze_token:, default_inner_merge_code_blocks:, registry_tag:, merger_class:, test_source: "# Test\n\nParagraph", category: :markdown) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/markdown/merge/wrapper_support.rb', line 29

def install!(
  wrapper_module:,
  require_prefix:,
  default_freeze_token:,
  default_inner_merge_code_blocks:,
  registry_tag:,
  merger_class:,
  test_source: "# Test\n\nParagraph",
  category: :markdown
)
  define_error_classes!(wrapper_module)
  define_constant_unless_present(wrapper_module, :DEFAULT_FREEZE_TOKEN, default_freeze_token)
  define_constant_unless_present(wrapper_module, :DEFAULT_INNER_MERGE_CODE_BLOCKS,
                                 default_inner_merge_code_blocks)

  SHARED_REEXPORTS.each do |name, value|
    define_constant_unless_present(wrapper_module, name, value)
  end

  WRAPPER_AUTOLOADS.each do |name, suffix|
    next if wrapper_module.const_defined?(name, false) || wrapper_module.autoload?(name)

    wrapper_module.send(:autoload, name, "#{require_prefix}/#{suffix}")
  end

  install_backend_loader!(wrapper_module)
  register_merge_gem!(
    registry_tag: registry_tag,
    require_path: require_prefix,
    merger_class: merger_class,
    test_source: test_source,
    category: category
  )
end