Class: Plurimath::Math::Formula

Inherits:
Core
  • Object
show all
Defined in:
lib/plurimath/math/formula.rb

Constant Summary collapse

MATH_ZONE_TYPES = 
%i[
  omml
  latex
  mathml
  asciimath
].freeze
POWER_BASE_CLASSES = 
%w[powerbase power base].freeze
DERIVATIVE_CONSTS = 
[
  "𝑑",
  "ⅅ",
  "ⅆ",
  "d",
].freeze

Constants inherited from Core

Core::REPLACABLES

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Core

#ascii_fields_to_print, #class_name, #common_math_zone_conversion, #dump_mathml, #dump_nodes, #dump_omml, #dump_ox_nodes, #empty_tag, #extractable?, #filtered_values, #font_style_t_tag, #get, #gsub_spacing, #insert_t_tag, #invert_unicode_symbols, #is_binary_function?, #is_nary_function?, #is_nary_symbol?, #is_ternary_function?, #is_unary?, #latex_fields_to_print, #linebreak, #mathml_fields_to_print, #nary_intent_name, #omml_fields_to_print, #omml_nodes, #omml_parameter, #omml_tag_name, #ox_element, #prime_unicode?, #r_element, #replacable_values, #result, #separate_table, #set, #tag_name, #unicodemath_parens, #updated_object_values, #validate_mathml_fields, #variable_value, #variables

Constructor Details

#initialize(value = [], left_right_wrapper = true, display_style: true, input_string: nil, unitsml: false) ⇒ Formula

Returns a new instance of Formula.



22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/plurimath/math/formula.rb', line 22

def initialize(
  value = [],
  left_right_wrapper = true,
  display_style: true,
  input_string: nil,
  unitsml: false
)
  @value = value.is_a?(Array) ? value : [value]
  left_right_wrapper = false if @value.first.is_a?(Function::Left)
  @left_right_wrapper = left_right_wrapper
  @displaystyle = boolean_display_style(display_style)
  @unitsml = unitsml if unitsml
end

Instance Attribute Details

#displaystyle ⇒ Object

Returns the value of attribute displaystyle.



6
7
8
 
# File 'lib/plurimath/math/formula.rb', line 6

def displaystyle
  @displaystyle
end

#input_string ⇒ Object

Returns the value of attribute input_string.



6
7
8
 
# File 'lib/plurimath/math/formula.rb', line 6

def input_string
  @input_string
end

#left_right_wrapper ⇒ Object

Returns the value of attribute left_right_wrapper.



6
7
8
 
# File 'lib/plurimath/math/formula.rb', line 6

def left_right_wrapper
  @left_right_wrapper
end

#unitsml ⇒ Object

Returns the value of attribute unitsml.



6
7
8
 
# File 'lib/plurimath/math/formula.rb', line 6

def unitsml
  @unitsml
end

#value ⇒ Object

Returns the value of attribute value.



6
7
8
 
# File 'lib/plurimath/math/formula.rb', line 6

def value
  @value
end

Instance Method Details

#==(object) ⇒ Object 



36
37
38
39
40
41
 
# File 'lib/plurimath/math/formula.rb', line 36

def ==(object)
  object.respond_to?(:value) &&
    object.respond_to?(:left_right_wrapper) &&
    object.value == value &&
    object.left_right_wrapper == left_right_wrapper
end

#cloned_objects ⇒ Object 



225
226
227
228
229
230
 
# File 'lib/plurimath/math/formula.rb', line 225

def cloned_objects
  cloned_obj = value.map(&:cloned_objects)
  formula = self.class.new(cloned_obj)
  formula.left_right_wrapper = @left_right_wrapper
  formula
end

#extract_class_name_from_text ⇒ Object 



203
204
205
206
207
 
# File 'lib/plurimath/math/formula.rb', line 203

def extract_class_name_from_text
  return unless value.length < 2 && value.first.is_a?(Function::Text)

  value.first.parameter_one
end

#insert(values) ⇒ Object 



264
265
266
 
# File 'lib/plurimath/math/formula.rb', line 264

def insert(values)
  update(Array(value) + values)
end

#line_breaked_mathml(display_style, intent) ⇒ Object 



67
68
69
70
71
 
# File 'lib/plurimath/math/formula.rb', line 67

def line_breaked_mathml(display_style, intent)
  new_line_support.map do |formula|
    formula.to_mathml(display_style: display_style, intent: intent)
  end.join
end

#line_breaking(obj) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/plurimath/math/formula.rb', line 240

def line_breaking(obj)
  if result.size > 1
    breaked_result = result.first.last.omml_line_break(result)
    update(Array(breaked_result.shift))
    obj.update(breaked_result.flatten)
    reprocess_value(obj)
    return
  end

  value.each.with_index(1) do |object, index|
    object.line_breaking(obj)
    break obj.insert(value.slice!(index..value.size)) if obj.value_exist?
  end
end

#mathml_content(intent) ⇒ Object 



83
84
85
86
87
 
# File 'lib/plurimath/math/formula.rb', line 83

def mathml_content(intent)
  nodes = value.map { |val| val.to_mathml_without_math_tag(intent) }
  intent_post_processing(nodes, intent) if intent
  nodes
end

#mini_sized? ⇒ Boolean

Returns:

  • (Boolean) 


269
270
271
 
# File 'lib/plurimath/math/formula.rb', line 269

def mini_sized?
  true if value&.first&.mini_sized?
end

#nary_attr_value ⇒ Object 



209
210
211
 
# File 'lib/plurimath/math/formula.rb', line 209

def nary_attr_value
  value.first.nary_attr_value
end

#new_line_support(array = []) ⇒ Object 



232
233
234
235
236
237
238
 
# File 'lib/plurimath/math/formula.rb', line 232

def new_line_support(array = [])
  cloned = cloned_objects
  obj = self.class.new
  cloned.line_breaking(obj)
  array << cloned
  obj.value_exist? ? obj.new_line_support(array) : array
end

#omml_attrs ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/plurimath/math/formula.rb', line 101

def omml_attrs
  {
    "xmlns:m": "http://schemas.openxmlformats.org/officeDocument/2006/math",
    "xmlns:mc": "http://schemas.openxmlformats.org/markup-compatibility/2006",
    "xmlns:mo": "http://schemas.microsoft.com/office/mac/office/2008/main",
    "xmlns:mv": "urn:schemas-microsoft-com:mac:vml",
    "xmlns:o": "urn:schemas-microsoft-com:office:office",
    "xmlns:r": "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
    "xmlns:v": "urn:schemas-microsoft-com:vml",
    "xmlns:w": "http://schemas.openxmlformats.org/wordprocessingml/2006/main",
    "xmlns:w10": "urn:schemas-microsoft-com:office:word",
    "xmlns:w14": "http://schemas.microsoft.com/office/word/2010/wordml",
    "xmlns:w15": "http://schemas.microsoft.com/office/word/2012/wordml",
    "xmlns:wne": "http://schemas.microsoft.com/office/word/2006/wordml",
    "xmlns:wp": "http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing",
    "xmlns:wp14": "http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing",
    "xmlns:wpc": "http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas",
    "xmlns:wpg": "http://schemas.microsoft.com/office/word/2010/wordprocessingGroup",
    "xmlns:wpi": "http://schemas.microsoft.com/office/word/2010/wordprocessingInk",
    "xmlns:wps": "http://schemas.microsoft.com/office/word/2010/wordprocessingShape",
  }
end

#omml_content(display_style) ⇒ Object 



142
143
144
 
# File 'lib/plurimath/math/formula.rb', line 142

def omml_content(display_style)
  value&.map { |val| val.insert_t_tag(display_style) }
end

#reprocess_value(obj) ⇒ Object 



255
256
257
258
259
260
261
262
 
# File 'lib/plurimath/math/formula.rb', line 255

def reprocess_value(obj)
  new_obj = self.class.new([])
  self.line_breaking(new_obj)
  if new_obj.value_exist?
    obj.value.insert(0, Function::Linebreak.new)
    obj.value.insert(0, self.class.new(new_obj.value))
  end
end

#to_asciimath ⇒ Object 



43
44
45
46
47
 
# File 'lib/plurimath/math/formula.rb', line 43

def to_asciimath
  value.map(&:to_asciimath).join(" ")
rescue
  parse_error!(:asciimath)
end

#to_asciimath_math_zone(spacing = "", last = false, indent = true) ⇒ Object 



175
176
177
178
179
180
 
# File 'lib/plurimath/math/formula.rb', line 175

def to_asciimath_math_zone(spacing = "", last = false, indent = true)
  filtered_values(value, lang: :asciimath).map.with_index(1) do |object, index|
    last = index == @values.length
    object.to_asciimath_math_zone(new_space(spacing, indent), last, indent)
  end
end

#to_display(type = nil) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/plurimath/math/formula.rb', line 156

def to_display(type = nil)
  return type_error! unless MATH_ZONE_TYPES.include?(type.downcase.to_sym)

  math_zone = case type
              when :asciimath
                "  |_ \"#{to_asciimath}\"\n#{to_asciimath_math_zone("     ").join}"
              when :latex
                "  |_ \"#{to_latex}\"\n#{to_latex_math_zone("     ").join}"
              when :mathml
                "  |_ \"#{to_mathml.gsub(/\n\s*/, "")}\"\n#{to_mathml_math_zone("     ").join}"
              when :omml
                "  |_ \"#{to_omml.gsub(/\n\s*/, "")}\"\n#{to_omml_math_zone("     ", display_style: displaystyle).join}"
              end
  <<~MATHZONE.sub(/\n$/, "")
  |_ Math zone
  #{math_zone}
  MATHZONE
end

#to_html ⇒ Object 



95
96
97
98
99
 
# File 'lib/plurimath/math/formula.rb', line 95

def to_html
  value&.map(&:to_html)&.join(" ")
rescue
  parse_error!(:html)
end

#to_latex ⇒ Object 



89
90
91
92
93
 
# File 'lib/plurimath/math/formula.rb', line 89

def to_latex
  value&.map(&:to_latex)&.join(" ")
rescue
  parse_error!(:latex)
end

#to_latex_math_zone(spacing = "", last = false, indent = true) ⇒ Object 



182
183
184
185
186
187
 
# File 'lib/plurimath/math/formula.rb', line 182

def to_latex_math_zone(spacing = "", last = false, indent = true)
  filtered_values(value, lang: :latex).map.with_index(1) do |object, index|
    last = index == @values.length
    object.to_latex_math_zone(new_space(spacing, indent), last, indent)
  end
end

#to_mathml(display_style: displaystyle, split_on_linebreak: false, intent: false) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/plurimath/math/formula.rb', line 49

def to_mathml(display_style: displaystyle, split_on_linebreak: false, intent: false)
  return line_breaked_mathml(display_style, intent) if split_on_linebreak

  math_attrs = {
    xmlns: "http://www.w3.org/1998/Math/MathML",
    display: "block",
  }
  style_attrs = { displaystyle: boolean_display_style(display_style) }
  math  = ox_element("math", attributes: math_attrs)
  style = ox_element("mstyle", attributes: style_attrs)
  Utility.update_nodes(style, mathml_content(intent))
  Utility.update_nodes(math, [style])
  unitsml_post_processing(math.nodes, math)
  dump_nodes(math, indent: 2)
rescue
  parse_error!(:mathml)
end

#to_mathml_math_zone(spacing = "", last = false, indent = true) ⇒ Object 



189
190
191
192
193
194
 
# File 'lib/plurimath/math/formula.rb', line 189

def to_mathml_math_zone(spacing = "", last = false, indent = true)
  filtered_values(value, lang: :mathml).map.with_index(1) do |object, index|
    last = index == @values.length
    object.to_mathml_math_zone(new_space(spacing, indent), last, indent)
  end
end

#to_mathml_without_math_tag(intent) ⇒ Object 



73
74
75
76
77
78
79
80
81
 
# File 'lib/plurimath/math/formula.rb', line 73

def to_mathml_without_math_tag(intent)
  return mathml_content(intent) unless left_right_wrapper

  mathml_value = mathml_content(intent)
  attributes = intent_attribute(mathml_value) if intent
  mrow = ox_element("mrow", attributes: attributes)
  mrow[:unitsml] = true if unitsml
  Utility.update_nodes(mrow, mathml_value)
end

#to_omml(display_style: displaystyle, split_on_linebreak: false) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/plurimath/math/formula.rb', line 124

def to_omml(display_style: displaystyle, split_on_linebreak: false)
  objects = split_on_linebreak ? new_line_support : [self]

  para_element = Utility.ox_element("oMathPara", attributes: omml_attrs, namespace: "m")
  objects.each.with_index(1) do |object, index|
    para_element << Utility.update_nodes(
      Utility.ox_element("oMath", namespace: "m"),
      object.omml_content(boolean_display_style(display_style)),
    )
    next if objects.length == index

    para_element << omml_br_tag
  end
  dump_nodes(para_element, indent: 2)
rescue
  parse_error!(:omml)
end

#to_omml_math_zone(spacing = "", last = false, indent = true, display_style:) ⇒ Object 



196
197
198
199
200
201
 
# File 'lib/plurimath/math/formula.rb', line 196

def to_omml_math_zone(spacing = "", last = false, indent = true, display_style:)
  filtered_values(value, lang: :omml).map.with_index(1) do |object, index|
    last = index == @values.length
    object.to_omml_math_zone(new_space(spacing, indent), last, indent, display_style: display_style)
  end
end

#to_omml_without_math_tag(display_style) ⇒ Object 



146
147
148
 
# File 'lib/plurimath/math/formula.rb', line 146

def to_omml_without_math_tag(display_style)
  omml_content(display_style)
end

#to_unicodemath ⇒ Object 



150
151
152
153
154
 
# File 'lib/plurimath/math/formula.rb', line 150

def to_unicodemath
  Utility.html_entity_to_unicode(unicodemath_value).gsub(/\s\/\s/, "/")
rescue
  parse_error!(:unicodemath)
end

#update(object) ⇒ Object 



221
222
223
 
# File 'lib/plurimath/math/formula.rb', line 221

def update(object)
  self.value = Array(object)
end

#validate_function_formula ⇒ Object 



213
214
215
 
# File 'lib/plurimath/math/formula.rb', line 213

def validate_function_formula
  (value.none?(Function::Left) || value.none?(Function::Right))
end

#value_exist? ⇒ Boolean

Returns:

  • (Boolean) 


217
218
219
 
# File 'lib/plurimath/math/formula.rb', line 217

def value_exist?
  value && !value.empty?
end