Class: Brief::Document::Structure
- Inherits:
-
Object
- Object
- Brief::Document::Structure
- Defined in:
- lib/brief/document/structure.rb
Defined Under Namespace
Classes: Util
Instance Attribute Summary collapse
-
#content_lines ⇒ Object
Returns the value of attribute content_lines.
-
#fragment ⇒ Object
Returns the value of attribute fragment.
Instance Method Summary collapse
- #assign_id_attributes_to_pre_tags ⇒ Object
-
#create_wrappers ⇒ Object
Markdown rendered HTML comes in the forms of a bunch of siblings, and no parents.
- #find_heading_by(level, heading) ⇒ Object
- #find_pre_by_lang(lang) ⇒ Object
- #get_heading_details ⇒ Object
- #heading_details ⇒ Object
- #heading_element_tags ⇒ Object
- #heading_with_text(text) ⇒ Object
- #headings_at_level(level, options = {}) ⇒ Object
- #headings_with_text(text) ⇒ Object
- #highest_level ⇒ Object
-
#initialize(fragment, content_lines = []) ⇒ Structure
constructor
A new instance of Structure.
- #levels ⇒ Object
- #lowest_level ⇒ Object
- #prescan ⇒ Object
- #set_markings_on_headers ⇒ Object
Constructor Details
#initialize(fragment, content_lines = []) ⇒ Structure
Returns a new instance of Structure.
29 30 31 32 |
# File 'lib/brief/document/structure.rb', line 29 def initialize(fragment, content_lines = []) @fragment = fragment @content_lines = content_lines end |
Instance Attribute Details
#content_lines ⇒ Object
Returns the value of attribute content_lines.
27 28 29 |
# File 'lib/brief/document/structure.rb', line 27 def content_lines @content_lines end |
#fragment ⇒ Object
Returns the value of attribute fragment.
27 28 29 |
# File 'lib/brief/document/structure.rb', line 27 def fragment @fragment end |
Instance Method Details
#assign_id_attributes_to_pre_tags ⇒ Object
39 40 41 42 43 44 45 46 47 48 49 50 |
# File 'lib/brief/document/structure.rb', line 39 def pres = fragment.css('pre[lang]') pres.each do |pre| lang = pre.attr('lang') if match_data = lang.match(/\((\w+)\)/) pre.set_attribute 'id', match_data.captures.first pre.set_attribute 'lang', lang.gsub(/\((\w+)\)/,'') end end end |
#create_wrappers ⇒ Object
Markdown rendered HTML comes in the forms of a bunch of siblings, and no parents. We need to introduce the concept of ownership of sections of the document, by using the heading level (h1 - h6) as a form of rank.
All h1 elements will ‘own’ the h2,h3,h4,h5,h6 elements underneath them.
103 104 105 106 107 108 109 110 111 112 113 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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/brief/document/structure.rb', line 103 def create_wrappers return if @elements_have_been_wrapped elements = fragment.children # The different groups of elements mapping = [] # The current bucket of elements that is being # collected, will get reset whenever it runs into # an element that is a greater heading rank bucket = [] current_level = Util.level(elements.first) elements.each_cons(2) do |element, next_element| bucket << element # We will have run into a greater header, so close up the bucket # and put it into the mapping if Util.is_header?(next_element) && Util.level(next_element) >= current_level mapping.push([current_level, bucket]) bucket = [] end if Util.is_header?(element) current_level = Util.level(element) end end # we never ended up reaching a header, so close up and move on if !mapping.include?(bucket) mapping.push([current_level, bucket]) end base_fragment = Nokogiri::HTML.fragment("<div class='brief top level' />") mapping.map! do |item| level, group = item group.reject! { |i| i.text == "\n" } #puts "Mapping! #{ level } group length: #{ group.length }" if level == 0 #puts "== Condition A" base_fragment = fragment = Nokogiri::HTML.fragment("<div class='brief top level'>#{ group.map(&:to_html).join('') }</div>") elsif level <= lowest_level #puts "== Condition B" fragment = Nokogiri::HTML.fragment("<section>#{ group.map(&:to_html).join('') }</section>") elsif level > lowest_level #puts "== Condition C" # should be able to look at the document section mappings and # apply custom css classes to these based on the name of the section fragment = Nokogiri::HTML.fragment("<article>#{ group.map(&:to_html).join('') }</article>") end [level, [fragment]] end begin self.fragment = Brief::Document::Section::Builder.run(mapping, low: lowest_level, high: highest_level) rescue Brief::Document::Section::BuilderError ##puts "== Error, returning default fragment: #{ $! }" @fragment end end |
#find_heading_by(level, heading) ⇒ Object
213 214 215 216 217 |
# File 'lib/brief/document/structure.rb', line 213 def find_heading_by(level, heading) heading_details.find do |el| el.level.to_s == level.to_s && heading.to_s.strip == el.heading.to_s.strip end end |
#find_pre_by_lang(lang) ⇒ Object
209 210 211 |
# File 'lib/brief/document/structure.rb', line 209 def find_pre_by_lang(lang) fragment.css("pre[lang='#{lang}']").first end |
#get_heading_details ⇒ Object
223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/brief/document/structure.rb', line 223 def get_heading_details fragment.css('h1,h2,h3,h4,h5,h6').map do |el| if el.attr('data-level').to_i > 0 { level: el.attr('data-level'), heading: el.attr('data-heading'), line_number: el.attr('data-line-number'), element: el }.to_mash end end.compact end |
#heading_details ⇒ Object
219 220 221 |
# File 'lib/brief/document/structure.rb', line 219 def heading_details @heading_details ||= get_heading_details end |
#heading_element_tags ⇒ Object
92 93 94 |
# File 'lib/brief/document/structure.rb', line 92 def css("h1,h2,h3,h4,h5,h6") end |
#heading_with_text(text) ⇒ Object
196 197 198 199 200 201 |
# File 'lib/brief/document/structure.rb', line 196 def heading_with_text(text) headings_with_text(text).tap do |results| fail 'no section found with content: ' + text if results.length == 0 fail 'more than one section found with content: ' + text if results.length >= 2 end.first end |
#headings_at_level(level, options = {}) ⇒ Object
186 187 188 189 190 191 192 193 194 |
# File 'lib/brief/document/structure.rb', line 186 def headings_at_level(level, = {}) matches = heading_details.select { |el| el.level.to_i == level.to_i } if [:text] matches.map(&:text) else matches end end |
#headings_with_text(text) ⇒ Object
203 204 205 206 207 |
# File 'lib/brief/document/structure.rb', line 203 def headings_with_text(text) heading_details.select do |el| el.heading.to_s.strip == text.to_s.strip end end |
#highest_level ⇒ Object
178 179 180 |
# File 'lib/brief/document/structure.rb', line 178 def highest_level levels.max end |
#levels ⇒ Object
170 171 172 173 174 175 176 |
# File 'lib/brief/document/structure.rb', line 170 def levels l = fragment.css('[data-level]').map { |el| el.attr('data-level').to_i } l.reject!(&:nil?) l.reject! { |v| v.to_i == 0 } l.uniq! l end |
#lowest_level ⇒ Object
182 183 184 |
# File 'lib/brief/document/structure.rb', line 182 def lowest_level levels.min end |
#prescan ⇒ Object
34 35 36 37 |
# File 'lib/brief/document/structure.rb', line 34 def prescan set_markings_on_headers end |
#set_markings_on_headers ⇒ Object
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/brief/document/structure.rb', line 52 def set_markings_on_headers content_lines.each_with_index do |line, index| if line.match(/^#/) line = line.strip level = line.count('#') text = line.gsub('#', '').strip if level > 0 && text.length > 0 line_number = index + 1 heading = find_heading_by(level, text) # If it is a heading element, we map it to a line number in # the content that produced it. We also look for the special # syntax {attribute: value; other-attribute: value} which # lets us set attributes on the header if heading set_attributes = {"data-line-number" => line_number} if attribute_matchers = line.match(/\{(.*)\}/) attributes = attribute_matchers.captures.first.strip attributes.split(';').each do |pair| key, value = pair.split(':') set_attributes[key.to_s.strip] = value.to_s.strip end value = heading.element.text.to_s.split(/\{.*\}/).join("").strip heading.element.inner_html = value heading.element.set_attribute('data-heading', value) end set_attributes.each do |k,v| heading.element.set_attribute(k, v) end end end end end end |