Module: Punctuated::Parsed::Operations

Included in:
Punctuated::Parsed
Defined in:
lib/punctuated/parsed/operations.rb

Overview

Implements punctuation queries and transformations over already parsed state.

Constant Summary collapse

QUERY_METHODS = 
[:start_with?, :end_with?].freeze
TRANSFORMING_METHODS = 
[:ensure, :ensure_start, :strip, :lstrip, :rstrip, :replace].freeze
METHODS = 
(QUERY_METHODS + TRANSFORMING_METHODS).freeze
METHOD_SIDES = 
{
  start_with?: :start,
  end_with?: :end,
  lstrip: :start,
  rstrip: :end
}.freeze

Instance Method Summary collapse

Instance Method Details

#end_with?(terminal = nil, options = nil, **keywords) ⇒ Boolean Also known as: at_end?

Returns:

  • (Boolean) 


31
32
33
34
 
# File 'lib/punctuated/parsed/operations.rb', line 31

def end_with?(terminal = nil, options = nil, **keywords)
  terminal, settings = terminal_and_options(terminal, options, keywords, allowed: [:placement])
  matches_terminal?(1, terminal, settings)
end

#ensure!(terminal = DEFAULT_TERMINALS, options = nil, **keywords) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/punctuated/parsed/operations.rb', line 39

def ensure!(terminal = DEFAULT_TERMINALS, options = nil, **keywords)
  terminal, settings = terminal_and_options(terminal, options, keywords, allowed: [:placement], default_terminal: DEFAULT_TERMINALS)
  terminals = Options.sides(terminal, label: "terminal", side: :end) { |value| validate_terminal(value) }
  placements = if settings.key?(:placement)
    Options.sides(settings[:placement], label: "placement", side: :end) { |value| Options.placement(value) }
  else
    [nil, nil]
  end
  changes = {}

  2.times do |side|
    fallback = terminals[side]
    next if fallback.nil?

    terminal_component = component(side, :terminal)
    placement = placements[side]
    if terminal_component.raw.empty?
      next if fallback.empty?

      terminal_change = { raw: fallback, placement: placement || :inside, placement_specified: true }
    elsif placement
      terminal_change = { placement: placement, placement_specified: true }
    else
      next
    end

    changes[side] = {
      terminal: terminal_change
    }
  end
  apply_component_changes(changes)
  self
end

#ensure_start!(terminal, options = nil, **keywords) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/punctuated/parsed/operations.rb', line 73

def ensure_start!(terminal, options = nil, **keywords)
  validate_single_terminal(terminal)
  settings = Options.hash(options, keywords, allowed: [:placement])
  if settings.key?(:placement)
    if settings[:placement].is_a?(Array)
      raise ArgumentError, "ensure_start placement does not accept Arrays"
    end
    settings[:placement] = [settings[:placement], nil]
  end
  ensure!([terminal, nil], settings, **{})
end

#lstrip!(options = nil, **keywords) ⇒ Object 



106
107
108
 
# File 'lib/punctuated/parsed/operations.rb', line 106

def lstrip!(options = nil, **keywords)
  side_strip!(0, options, keywords)
end

#replace!(replacements = nil, **keywords) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/punctuated/parsed/operations.rb', line 114

def replace!(replacements = nil, **keywords)
  settings = Options.hash(replacements, keywords, allowed: [:terminals, :wrappers], label: "replacement options")
  if settings.empty?
    raise ArgumentError, "replace requires wrappers and/or terminals"
  end

  normalised = {}
  settings.each do |kind_plural, value|
    normalised[kind_plural] = Options.sides(value, label: kind_plural.to_s) { |entry| entry }
  end

  # Resolve every Proc and validate every candidate before changing either side.

  changes = {}
  2.times do |side|
    pair_changes = {}
    { terminals: :terminal, wrappers: :wrapper }.each do |plural, kind|
      next unless normalised.key?(plural)

      replacement = replacement_change(normalised[plural][side], component(side, kind).raw)
      pair_changes[kind] = replacement if replacement
    end
    changes[side] = pair_changes unless pair_changes.empty?
  end
  apply_component_changes(changes)
  self
end

#rstrip!(options = nil, **keywords) ⇒ Object 



110
111
112
 
# File 'lib/punctuated/parsed/operations.rb', line 110

def rstrip!(options = nil, **keywords)
  side_strip!(1, options, keywords)
end

#start_with?(terminal = nil, options = nil, **keywords) ⇒ Boolean Also known as: at_start?

Returns:

  • (Boolean) 


26
27
28
29
 
# File 'lib/punctuated/parsed/operations.rb', line 26

def start_with?(terminal = nil, options = nil, **keywords)
  terminal, settings = terminal_and_options(terminal, options, keywords, allowed: [:placement])
  matches_terminal?(0, terminal, settings)
end

#strip!(options = nil, **keywords) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/punctuated/parsed/operations.rb', line 85

def strip!(options = nil, **keywords)
  settings = Options.hash(options, keywords, allowed: [:terminals, :wrappers], label: "strip options")
  terminal_settings = Options.sides(settings.fetch(:terminals, true), label: "terminals") { |value| validate_strip_value(value) }
  wrapper_settings = Options.sides(settings.fetch(:wrappers, nil), label: "wrappers") { |value| validate_strip_value(value) }
  changes = {}

  # Select everything against the original placements before coordinating any removals.

  2.times do |side|
    pair_changes = {}
    if strip_selected?(side, :terminal, terminal_settings[side])
      pair_changes[:terminal] = { raw: "" }
    end
    if strip_selected?(side, :wrapper, wrapper_settings[side])
      pair_changes[:wrapper] = { raw: "" }
    end
    changes[side] = pair_changes unless pair_changes.empty?
  end
  apply_component_changes(changes)
  self
end