Class: SiSU_Txt_Markdown::Source::Scroll

Inherits:
SiSU_Txt_Markdown::Source show all
Includes:
SiSU_Decorate_Txt_Markdown, SiSU_Parts_Generic, SiSU_TextUtils
Defined in:
lib/sisu/txt_markdown.rb

Constant Summary collapse

@@endnotes = 
{ para: [], end: [] }

Instance Method Summary collapse

Methods included from SiSU_Decorate_Txt_Markdown

#bold, #cite, #close, #decorate, #heading, #hilite, #inline, #insert, #italics, #l0, #l1, #l2, #l3, #l4, #l5, #l6, #monospace, #open, #strike, #subscript, #superscript, #underscore

Methods included from SiSU_Parts_Generic

#footer_signature, #home, #home_txt, #i_choice, #i_home_button, #i_ico, #i_new, #rl_root, #root_http, #sisu, #sisu_txt, #sisudoc, #site, #the_icon, #the_text, #the_url, #txt_home, #txt_hp, #txt_hp_alias, #txt_signature, #urify, #url_close, #url_open

Methods inherited from SiSU_Txt_Markdown::Source

#read

Methods included from SiSU_Txt_Read

#read_generic

Constructor Details

#initialize(md, data, wrap_width) ⇒ Scroll

Returns a new instance of Scroll.



99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/sisu/txt_markdown.rb', line 99

def initialize(md,data,wrap_width)
  @md,@data,@wrap_width=md,data,wrap_width
  @env=SiSU_Env::InfoEnv.new(@md.fns)
  @tab="\t"
  @@endnotes_=case md.opt.selections.str
  when /--footnote/ then false
  when /--endnote/  then true
  else                   true
  end
  @plaintext={ body: [], open: [], close: [], head: [], metadata: [], tail: [] }
end

Instance Method Details

#break_line ⇒ Object 



114
115
116
 
# File 'lib/sisu/txt_markdown.rb', line 114

def break_line
  "\n"
end

#extract_endnotes(dob = '') ⇒ Object

Used for extraction of endnotes from paragraphs



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
 
# File 'lib/sisu/txt_markdown.rb', line 118

def extract_endnotes(dob='')
  notes=dob.obj.scan(/(?:#{Mx[:en_a_o]}|#{Mx[:en_b_o]})([\d*+]+\s+.+?)(?:#{Mx[:en_a_c]}|#{Mx[:en_b_c]})/)
  @n=[]
  notes.flatten.each do |n| #high cost to deal with <br> appropriately within plaintext, consider
    n=n.dup.to_s
    if n =~/#{Mx[:br_line]}|#{Mx[:br_nl]}/
      fix = n.split(/#{Mx[:br_line]}|#{Mx[:br_nl]}/) #watch #added
      fix.each do |x|
        unless x.empty? then @n << x
        end
      end
    else                     @n << n
    end
  end
  notes=@n.flatten
  notes.each do |e|
    util=(e.to_s =~/^\[[\d*+]+\]:/) \
    ? (SiSU_TextUtils::Wrap.new(e.to_s,@wrap_width,4,1))
    : (SiSU_TextUtils::Wrap.new(e.to_s,@wrap_width,1,1))
    wrap=util.line_wrap
    wrap=if wrap =~ /^\s*[\d*+]+\s+.+?\s*\Z/m
      wrap.gsub(/^(\s*)([\d*+]+)\s+(.+?)\s*\Z/m, <<-GSUB
\\1[\\2]: \\3
        GSUB
      )
    else
      wrap.gsub(/^(.+)\Z/m, <<-GSUB
\\1
        GSUB
      )
    end
    @@endnotes[:para] << "-#{wrap}"
    @@endnotes[:end] << '' << wrap
  end
  @@endnotes
end

#heading_decorated_inline(dob) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/sisu/txt_markdown.rb', line 194

def heading_decorated_inline(dob)
  if dob.is==:heading
    heading_inline = case dob.lc
    when 0 then decorate.heading.inline.l0
    when 1 then decorate.heading.inline.l1
    when 2 then decorate.heading.inline.l2
    when 3 then decorate.heading.inline.l3
    when 4 then decorate.heading.inline.l4
    when 5 then decorate.heading.inline.l5
    when 6 then decorate.heading.inline.l6
    end
    heading_inline + ' ' +  dob.obj + ' ' + heading_inline
  end
end

#heading_decorated_underscore(dob, times, p_num) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/sisu/txt_markdown.rb', line 208

def heading_decorated_underscore(dob,times,p_num)
  if dob.is==:heading
    #times=@wrap_width if times > @wrap_width
    case dob.lc
    when 0 then decorate.heading.underscore.l0*times + p_num << break_line*2
    when 1 then decorate.heading.underscore.l1*times + p_num << break_line*2
    when 2 then decorate.heading.underscore.l2*times + p_num << break_line*2
    when 3 then decorate.heading.underscore.l3*times + p_num << break_line*2
    when 4 then decorate.heading.underscore.l4*times + p_num << break_line*2
    when 5 then decorate.heading.underscore.l5*times + p_num << break_line*2
    when 6 then decorate.heading.underscore.l6*times + p_num << break_line*2
    end
  end
end

#markup(data) ⇒ Object

Used for major markup instructions



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/sisu/txt_markdown.rb', line 267

def markup(data)                                                       # Used for major markup instructions
  SiSU_Env::InfoEnv.new(@md.fns)
  @data_mod,@endnotes,@level,@cont,@copen,@plaintext_contents_close=Array.new(6){[]}
  (0..6).each { |x| @cont[x]=@level[x]=false }
  (4..6).each { |x| @plaintext_contents_close[x]='' }
  plaintext_tail #($1,$2)
  plaintext_metadata
  table_message='[table conversion awaited, see other document formats]'
  data.each do |dob|
    dob.obj=dob.obj.gsub(/#{Mx[:gr_o]}Th?#{Mx[:tc_p]}.+/um,"#{break_line}#{table_message}"). #fix
      gsub(/.+?#{Mx[:gl_o]}-##{Mx[:gl_c]}/,'').                              # remove dummy headings (used by html) #check also [~-]#
      gsub(/#{Mx[:fa_bold_o]}(.+?)#{Mx[:fa_bold_c]}/,
        "#{decorate.bold.open}\\1#{decorate.bold.close}").
      gsub(/#{Mx[:fa_italics_o]}(.+?)#{Mx[:fa_italics_c]}/,
        "#{decorate.italics.open}\\1#{decorate.italics.close}").
      gsub(/#{Mx[:fa_underscore_o]}(.+?)#{Mx[:fa_underscore_c]}/,
        "#{decorate.underscore.open}\\1#{decorate.underscore.close}").
      gsub(/#{Mx[:fa_subscript_o]}(.+?)#{Mx[:fa_subscript_c]}/,
        "#{decorate.subscript.open}\\1#{decorate.subscript.close}").
      gsub(/#{Mx[:fa_superscript_o]}(.+?)#{Mx[:fa_superscript_c]}/,
        "#{decorate.superscript.open}\\1#{decorate.superscript.close}").
      gsub(/#{Mx[:fa_insert_o]}(.+?)#{Mx[:fa_insert_c]}/,
        "#{decorate.insert.open}\\1#{decorate.insert.close}").
      gsub(/#{Mx[:fa_cite_o]}(.+?)#{Mx[:fa_cite_c]}/,
        "#{decorate.cite.open}\\1#{decorate.cite.close}").
      gsub(/#{Mx[:fa_strike_o]}(.+?)#{Mx[:fa_strike_c]}/,
        "#{decorate.strike.open}\\1#{decorate.strike.close}").
      gsub(/#{Mx[:fa_monospace_o]}(.+?)#{Mx[:fa_monospace_c]}/,
        "#{decorate.monospace.open}\\1#{decorate.monospace.close}")
    unless dob.is==:code
      dob.obj=dob.obj.gsub(/#{Mx[:lnk_o]}(.+?)#{Mx[:lnk_c]}#{Mx[:rel_o]}\S+?#{Mx[:rel_c]}/,'\1').
        gsub(/#{Mx[:url_o]}_(\S+?)#{Mx[:url_c]}/,'\1').
        gsub(/#{Mx[:lnk_o]}(.+?)#{Mx[:lnk_c]}#{Mx[:url_o]}(\S+?)#{Mx[:url_c]}/,'\1 [link: <\2>]').
        gsub(/#{Mx[:lnk_o]}(.+?)#{Mx[:lnk_c]}image/,'\1 [link: local image]').
        gsub(/#{Mx[:url_o]}(\S+?)#{Mx[:url_c]}/,"#{the_text.url_open}\\1#{the_text.url_close}")
      extract_endnotes(dob)
      dob.obj=dob.obj.gsub(/#{Mx[:en_a_o]}([\d*+]+)\s+(?:.+?)#{Mx[:en_a_c]}/,'[^\1]'). # endnote marker marked up
        gsub(/#{Mx[:en_b_o]}([\d*+]+)\s+(?:.+?)#{Mx[:en_b_c]}/,'[^\1]'). # endnote marker marked up
        gsub(/#{Mx[:gl_o]}(?:#lt|#060)#{Mx[:gl_c]}/,'<').
        gsub(/#{Mx[:gl_o]}(?:#gt|#062)#{Mx[:gl_c]}/,'>').
        gsub(/#{Mx[:gl_o]}#(?:038|amp)#{Mx[:gl_c]}/,'&').
        gsub(/#{Mx[:gl_o]}#033#{Mx[:gl_c]}/,'!').
        gsub(/#{Mx[:gl_o]}#035#{Mx[:gl_c]}/,'#').
        gsub(/#{Mx[:gl_o]}#042#{Mx[:gl_c]}/,'*').
        gsub(/#{Mx[:gl_o]}#045#{Mx[:gl_c]}/,'-').
        gsub(/#{Mx[:gl_o]}#047#{Mx[:gl_c]}/,'/').
        gsub(/#{Mx[:gl_o]}#095#{Mx[:gl_c]}/,'_').
        gsub(/#{Mx[:gl_o]}#123#{Mx[:gl_c]}/,'{').
        gsub(/#{Mx[:gl_o]}#125#{Mx[:gl_c]}/,'}').
        gsub(/#{Mx[:gl_o]}#126#{Mx[:gl_c]}/,'~').
        gsub(/#{Mx[:gl_o]}#169#{Mx[:gl_c]}/,'©').
        gsub(/#{Mx[:gl_o]}#092#{Mx[:gl_c]}/,'\\')
    end
    dob.obj=if dob.of==:block                                   # watch
      dob.obj.gsub(/#{Mx[:gl_o]}●#{Mx[:gl_c]}/m,"* ").
        gsub(/\n?#{Mx[:br_line]}\n?|\n?#{Mx[:br_nl]}\n?/m,break_line)
    else dob.obj.gsub(/\n?#{Mx[:br_line]}\n?|\n?#{Mx[:br_nl]}\n?/m,break_line*2)
    end
    if dob.is==:code
      dob.obj=dob.obj.gsub(/(^|[^}])_([<>])/m,'\1\2'). # _> _<
        gsub(/(^|[^}])_([<>])/m,'\1\2') # _<_<
    end
    dob.obj=dob.obj.gsub(/#{Mx[:url_o]}_(\S+?)#{Mx[:url_c]}/,'\1').
      gsub(/<a href=".+?">(.+?)<\/a>/m,'\1').
      gsub(/#{Mx[:mk_o]}:name#(\S+?)#{Mx[:mk_c]}/,'').                       # remove name links
      gsub(/&nbsp;|#{Mx[:nbsp]}/,' ').                                       # decide on
      gsub(/(?:^|[^_\\])#{Mx[:lnk_o]}(\S+?\.(?:png|jpg|gif)) .+?#{Mx[:lnk_c]}#{Mx[:url_o]}\S+?#{Mx[:url_c]}/,'    [ \1 ]'). #"[ #{dir.url.images_local}\/\\1 ]")
      gsub(/(?:^|[^_\\])#{Mx[:lnk_o]}(\S+?\.(?:png|jpg|gif)) .+?#{Mx[:lnk_c]}image/,'    [ \1 ]').
      gsub(/(?:^|[^_\\])\{\s*\S+?\.(?:png|jpg|gif)\s+.+?"(.*?)"\s*\}\S+/,'[image: "\1"]')
    if dob.obj !~/(^#{Rx[:meta]}|#{Mx[:br_eof]}|#{Mx[:br_endnotes]})/
      p_num=''
      #ocn
      if dob.is==:heading \
      or dob.is==:para
        plaintext_structure(dob,p_num)
      elsif dob.is==:group \
      or dob.is==:block \
      or dob.is==:verse \
      or dob.is==:code \
      or dob.is==:table
        @plaintext[:body] << dob.obj + p_num << break_line
      elsif dob.is==:break
        sp=' '
        ln='-'
        @plaintext[:body] <<=if dob.obj==Mx[:br_page] \
        or dob.obj==Mx[:br_page_new] \
        or dob.obj==Mx[:br_page_line]
          "#{break_line}#{ln*40}#{break_line*2}"
        elsif dob.obj ==Mx[:br_obj]
          "#{break_line}#{sp*20}*  *  *#{break_line*2}"
        end # following empty line (break_line) missing, fix
      end
      dob='' if (dob.obj =~/<a name="n\d+">/ \
        and dob.obj =~/^(-\{{2}~\d+|<!e[:_]\d+!>)/) # -endnote
      if dob ## Clean Prepared Text
        dob.obj=dob.obj.gsub(/<!.+!>/,' ').
          gsub(/<:\S+>/,' ')
      end
    end
  end
  @plaintext
end

#plaintext_metadata ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/sisu/txt_markdown.rb', line 154

def plaintext_metadata
  array=SiSU_Metadata::Summary.new(@md).plaintext.metadata
  array.each do |meta|
    tag,inf=meta.scan(/^.+?:\s|.+/)
    if tag and inf
      util=SiSU_TextUtils::Wrap.new(inf,@wrap_width,15,1)
      txt=util.line_wrap
      @plaintext[:metadata] <<<<WOK

#{@tab}#{tag}#{txt}
WOK
    end
  end
end

#plaintext_structure(dob = '', p_num = '') ⇒ Object

% Used to extract the structure of a document



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/sisu/txt_markdown.rb', line 222

def plaintext_structure(dob='',p_num='') #% Used to extract the structure of a document
  heading_decoration=:inline #(:inline|:underscore) #switch heading decoration between inline & underscore options
  util=nil
  wrapped=if dob.is==:para \
  || dob.is==:heading
    if dob.is==:heading
      util=(heading_decoration== :inline) \
      ? (SiSU_TextUtils::Wrap.new(heading_decorated_inline(dob),@wrap_width,0))
      : (SiSU_TextUtils::Wrap.new(dob.obj,@wrap_width,0))
    elsif dob.is==:para
      if dob.hang \
      and dob.hang =~/[0-9]/ \
      and dob.indent != dob.hang
        util=SiSU_TextUtils::Wrap.new(dob.obj,@wrap_width,dob.indent.to_i*2,dob.hang.to_i*2)
        #util=SiSU_TextUtils::Wrap.new(dob.obj,@wrap_width,dob.hang.to_i*2,0)
      elsif dob.indent =~/[1-9]/
        util=if dob.bullet_
          SiSU_TextUtils::Wrap.new("* #{dob.obj}",@wrap_width,dob.indent.to_i*2)
        else SiSU_TextUtils::Wrap.new(dob.obj,@wrap_width,dob.indent.to_i*2)
        end
      else
        util=if dob.bullet_
          SiSU_TextUtils::Wrap.new("* #{dob.obj}",@wrap_width,0)
        else SiSU_TextUtils::Wrap.new(dob.obj,@wrap_width,0)
        end
      end
    else util=SiSU_TextUtils::Wrap.new(dob.obj,@wrap_width,0)
    end
    dob.is==:heading ? util.no_wrap_no_breaks : util.line_wrap
  end
  if heading_decoration== :underscore \
  and dob.is==:heading
    @plaintext[:body] << wrapped + p_num # main text, contents, body KEEP
    @plaintext[:body] << heading_decorated_underscore(dob,wrapped.length,p_num)
  else
    @plaintext[:body] << wrapped + p_num << break_line # main text, contents, body KEEP
  end
  if @@endnotes[:para] \
  and not @@endnotes_
    @@endnotes[:para].each {|e| @plaintext[:body] << e << break_line}
  elsif @@endnotes[:para] \
  and @@endnotes_
  end
  @@endnotes[:para]=[]
end

#plaintext_tail ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/sisu/txt_markdown.rb', line 168

def plaintext_tail
#       env=SiSU_Env::InfoEnv.new(@md.fns)
  generator="Generated by: #{@md.project_details.project} #{@md.project_details.version} of #{@md.project_details.date_stamp} (#{@md.project_details.date})"  if @md.project_details.version
  lastdone="Last Generated on: #{Time.now}"
  rubyv="Ruby version: #{@md.ruby_version}"
  sc=if @md.sc_info
    "Source file:    #{@md.sc_filename}#{break_line}Version number: #{@md.sc_number}#{break_line}Version date:   #{@md.sc_date}#{break_line}"
  else ''
  end
  @plaintext[:tail] <<<<WOK
#{break_line}
plaintext (plain text):
   #{@md.file.output_path.markdown.url}/#{@md.file.base_filename.markdown}#{break_line}
Other versions of this document: #{break_line}
manifest:
   #{@md.file.output_path.manifest.url}/#{@md.file.base_filename.manifest}#{break_line}
at:
   #{@md.file.output_path.base.url}#{break_line}

#{sc}
* #{generator}
* #{rubyv}
* #{lastdone}
* SiSU #{the_url.sisu_txt}
WOK
end

#publish(plaintext) ⇒ Object 



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/sisu/txt_markdown.rb', line 369

def publish(plaintext)
  divider='='
  content=[]
  content << plaintext[:open]
  content << plaintext[:head]
  content << plaintext[:body]
  content << @@endnotes[:end] if @@endnotes_
  content << "#{break_line}#{divider*@wrap_width}#{break_line}"
  content << plaintext[:metadata]
  content << "#{break_line}#{divider*@wrap_width}#{break_line}" if @md.stmp =~/\w+/ #not used?
  content << plaintext[:tail]
  outputfile=SiSU_Env::FileOp.new(@md).write_file.markdown
  Txt_Output::Output.new.document(content,outputfile)
  @@endnotes={ para: [], end: [] }
end

#songsheet ⇒ Object 



110
111
112
113
 
# File 'lib/sisu/txt_markdown.rb', line 110

def songsheet
  plaintext=markup(@data)
  publish(plaintext)
end