Class: Manual

Inherits:
Shoes show all
Includes:
Shoes::Highlighter::Markup
Defined in:
lib/shoes/manual/app.rb

Constant Summary collapse

IMAGE_RE = 
/\!(\{([^}\n]+)\})?([^!\n]+\.\w+)\!/
CODE_RE = 
/\{{3}(?:\s*\#![^\n]+)?(.+?)\}{3}/m
PARA_RE = 
/\s*?(\{{3}(?:.+?)\}{3})|\n\n/m
NL = 
"\n"
LANG = 


DOCS =



Shoes::Manual.load_docs(LANG)


PNUMS =



mk_page_numbers DOCS


PEND =



PNUMS.length


COLORS =



Shoes::COLORS


VERSION =



Shoes::VERSION





Class Method Summary
collapse





Instance Method Summary
collapse






Class Method Details





.mk_page_numbers(docs) ⇒ Object










234
235
236
237
238
239
240
241
242
243




# File 'lib/shoes/manual/app.rb', line 234

def self.mk_page_numbers(docs)
  pnum = []
  docs.length.times do |i|
    pnum << [i, nil]
    docs[i][1][:sections].length.times do |j|
      pnum << [i, j]
    end
  end
  pnum
end













Instance Method Details





#color_page ⇒ Object










188
189
190
191
192
193
194
195
196
197
198
199
200
201




# File 'lib/shoes/manual/app.rb', line 188

def color_page
  COLORS.each do |color, v|
    r, g, b = v.red, v.green, v.blue
    c = v.dark? ? white : black
    stack width: 0.33, height: 55, margin_top: 5 do
      clr = send(color)
      background clr
      # para fg(strong(color), c), align: 'center'
      para fg('. ', clr), fg(strong(color), c), fg(' .', clr), align: 'center'
      para fg("rgb(#{r}, #{g}, #{b})", c), align: 'center'
    end
  end
  para NL
end












#decoration(datas, re, &blk) ⇒ Object










477
478
479
480
481
482
483
484
485
486
487
488
489
490




# File 'lib/shoes/manual/app.rb', line 477

def decoration(datas, re, &blk)
  datas.map do |data|
    if data.is_a? String
      txts = [data]
      data.match re do |md|
        n = data.index md[0]
        txts = [data[0...n], blk[md[1]], decoration([data[n + md[0].length..-1]], re, &blk)]
      end
      txts
    else
      data
    end
  end.flatten
end












#fill_rest_of_line ⇒ Object







Hack to consume remaining space to the right of a flow. Used to rely on NL’s, but with new text flowing, that doesn’t work anymore.















494
495
496
497




# File 'lib/shoes/manual/app.rb', line 494

def fill_rest_of_line
  flow width: 1.0 do
  end
end












#find_pnum(page) ⇒ Object










226
227
228
229
230
231
232




# File 'lib/shoes/manual/app.rb', line 226

def find_pnum(page)
  return 999 if page == 'Search'
  TOC_LIST.each_with_index do |e, i|
    title = e
    return i if title == page
  end
end












#get_title_and_desc(pnum) ⇒ Object










35
36
37
38
39
40
41
42
43
44
45




# File 'lib/shoes/manual/app.rb', line 35

def get_title_and_desc(pnum)
  chapter, section = PNUMS[pnum]
  return nil unless chapter
  if section
    [pnum, DOCS[chapter][1][:sections][section][1][:title],
     DOCS[chapter][1][:sections][section][1][:description],
     DOCS[chapter][1][:sections][section][1][:methods]]
  else
    [pnum, DOCS[chapter][0], DOCS[chapter][1][:description], []]
  end
end












#html_manual ⇒ Object










245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262




# File 'lib/shoes/manual/app.rb', line 245

def html_manual
  dir = @app.ask_save_folder
  return unless dir
  FileUtils.mkdir_p File.join(dir, 'static')
  FileUtils.mkdir_p File.join(dir, 'snapshots')
  %w(shoes-icon.png shoes-manual-apps.png manual.css code_highlighter.js code_highlighter_ruby.js)
    .each { |x| FileUtils.cp "#{Shoes::Manual::ROOT_DIR}/static/#{x}", "#{dir}/static" }
  Dir[File.join Shoes::Manual::ROOT_DIR, 'static/man-*.png'].each { |x| FileUtils.cp x, "#{dir}/static" }
  Dir[File.join DIR, 'snapshots/sample*.png'].each { |x| FileUtils.cp x, "#{dir}/snapshots" }

  TOC_LIST.length.times do |n|
    num, title, desc, methods = get_title_and_desc n
    open File.join(dir, "#{TOC_LIST[n][0]}.html"), 'wb:utf-8' do |f|
      html = mk_html(title, desc, methods, TOC_LIST[n + 1], get_title_and_desc(n + 1), mk_sidebar_list(num))
      f.puts html.force_encoding('UTF-8')
    end
  end
end












#index(pnum = 0) ⇒ Object










25
26
27
28
29
30
31
32
33




# File 'lib/shoes/manual/app.rb', line 25

def index(pnum = 0)
  # font LANG == 'ja' ? 'MS UI Gothic' : 'Arial'
  # style Link, underline: false, weight: 'bold'
  # style LinkHover, stroke: '#06E'
  self.scroll_top = 0
  TOC.clear; TOC_LIST.clear
  table_of_contents.each { |toc| TOC << toc }
  pnum == '999' ? mk_search_page : manual(*get_title_and_desc(pnum.to_i))
end












#manual(pnum, docs_title, docs_description, docs_methods) ⇒ Object










57
58
59
60
61
62
63
64
65
66
67
68
69
70
71




# File 'lib/shoes/manual/app.rb', line 57

def manual(pnum, docs_title, docs_description, docs_methods)
  flow do
    show_header docs_title
    show_toc
    paras = mk_paras docs_description
    flow width: 0.75, margin: [20, 0, 20, 0] do
      show_page paras, true
      show_methods docs_methods
      para link('top') { visit "/manual/0" }, "  ",
           link('prev') { visit "/manual/#{(pnum - 1) % PEND}" }, "  ",
           link('next') { visit "/manual/#{(pnum + 1) % PEND}" }, "  ",
           link('end') { visit "/manual/#{PEND - 1}" }
    end
  end
end












#manual_p(str) ⇒ Object










374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394




# File 'lib/shoes/manual/app.rb', line 374

def manual_p(str)
  str.gsub(/\n+\s*/, " ")
    .gsub(/&/, '&amp;').gsub(/>/, '&gt;').gsub(/>/, '&lt;').gsub(/"/, '&quot;')
    .gsub(/`(.+?)`/m, '<code>\1</code>').gsub(/\[\[BR\]\]/i, "<br />\n")
    .gsub(/\^(.+?)\^/m, '\1')
    .gsub(/'''(.+?)'''/m, '<strong>\1</strong>').gsub(/''(.+?)''/m, '<em>\1</em>')
    .gsub(/\[\[((http|https):\/\/\S+?)\]\]/m, '<a href="\1" target="_new">\1</a>')
    .gsub(/\[\[((http|https):\/\/\S+?) (.+?)\]\]/m, '<a href="\1" target="_new">\3</a>')
    .gsub(/\[\[(\S+?)\]\]/m) do
      ms, mn = Regexp.last_match[1].split(".", 2)
      if mn
        '<a href="' + ms + '.html#' + mn + '">' + mn + '</a>'
      else
        '<a href="' + ms + '.html">' + ms + '</a>'
      end
    end
    .gsub(/\[\[(\S+?) (.+?)\]\]/m, '<a href="\1.html">\2</a>')
    .gsub(/\!(\{[^}\n]+\})?([^!\n]+\.\w+)\!/) do
      '<img src="' + "static/#Regexp.last_match[2]" + '" />'
    end
end












#marker(txt, term) ⇒ Object










462
463
464
465
466
467
468
469




# File 'lib/shoes/manual/app.rb', line 462

def marker(txt, term)
  if term && txt
    tmp = txt.split(term).map { |s| [s, bg(term, yellow)] }.flatten
    txt =~ /#{term}$/ ? tmp : tmp[0...-1]
  else
    [txt]
  end
end












#mk_deco(datas) ⇒ Object










471
472
473
474
475




# File 'lib/shoes/manual/app.rb', line 471

def mk_deco(datas)
  datas = decoration(datas, /`(.+?)`/m) { |s| fg code(s), rgb(255, 30, 0) }
  datas = decoration(datas, /'''(.+?)'''/m) { |s| strong s }
  decoration(datas, /''(.+?)''/m) { |s| em s }
end












#mk_executable(code) ⇒ Object










180
181
182
183
184
185
186




# File 'lib/shoes/manual/app.rb', line 180

def mk_executable(code)
  if code =~ /\# Not yet available/
    "Shoes.app{para 'Sorry, not yet available...'}"
  else
    code
  end
end












#mk_html(title, desc, methods, next_file, next_title, menu) ⇒ Object










264
265
266
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




# File 'lib/shoes/manual/app.rb', line 264

def mk_html(title, desc, methods, next_file, next_title, menu)
  man = self
  html = Nokogiri::HTML::Builder.new do |h|
    h.html(lang: LANG) do
      h.head do
        h.meta charset: 'utf-8'
        h.title "The Shoes 4 Manual // #{title}"
        h.script type: "text/javascript", src: "static/code_highlighter.js"
        h.script type: "text/javascript", src: "static/code_highlighter_ruby.js"
        h.style type: "text/css" do
          h.text "@import 'static/manual.css';"
        end
      end
      h.body do
        h.div.main! do
          h.div.manual! do
            h.h2 "The Shoes 4 Manual #{VERSION}"
            h.h1 title

            paras = man.mk_paras desc
            h.div(class: 'intro') { h << man.manual_p(paras.shift) }

            html_paragraph = proc do
              paras.each do |str|
                if str =~ CODE_RE
                  h.pre { h.code(class: 'rb') { h.text Regexp.last_match[1].gsub(/^\s*?\n/, '') } }
                else
                  cmd, str = case str
                    when /\A==== (.+) ====/ then [:h4, Regexp.last_match[1]]
                    when /\A=== (.+) ===/ then [:h3, Regexp.last_match[1]]
                    when /\A== (.+) ==/ then [:h2, Regexp.last_match[1]]
                    when /\A= (.+) =/ then [:h1, Regexp.last_match[1]]
                    when /\A\{COLORS\}/
                      COLORS.each do |color, v|
                        f = v.dark? ? "white" : "black"
                        h.div(class: 'color', style: "background: #{color}; color: #{f}") { h.h3 color.to_s; h.p("rgb(%d, %d, %d)" % [v.red, v.green, v.blue]) }
                      end
                    when /\A\{SAMPLES\}/
                      man.mk_sample_names.each do |name|
                        name = name[0...-3]
                        h.div(class: 'sample') do
                          h.h3 name
                          h.text '<a href="snapshots/%s.png"><img src="snapshots/%s.png" alt="%s" border=0 width=50 height=50></a>' % [name, name, name]
                        end
                      end
                    when /\A \* (.+)/m
                      h.ul { Regexp.last_match[1].split(/^ \* /).each { |x| h << man.manual_p(x) } }; nil
                    else
                      [:p_, str]
                    end
                  h.send(cmd) { h << man.manual_p(str) } if cmd.is_a?(Symbol)
                end
              end
            end

            html_paragraph.call

            methods.each do |m, d|
              n = m.index("\u00BB")
              n ? (sig, val = m[0...n - 1], m[n - 1..-1]) : (sig, val = m, nil)
              aname = sig[/^[^(=]+=?/].gsub(/\s/, '').downcase
              h.a(name: aname)
              h.div(class: 'divmethod') do
                h.a sig, href: "##{aname}"
                h.text val if val
              end
              h.div(class: 'desc') do
                paras = man.mk_paras d
                html_paragraph.call
              end
            end

            h.p(class: 'next') { h.text "Next: "; h.a(href: "#{next_file[0]}.html") { h.text next_title[1] } } if next_title
          end
          h.div(class: 'sidebar') do
            h.img src: "static/shoes-icon.png"
            h.ul do
              h.li { h.a(class: 'prime', href: "./") { h.text "HELP" } }
              menu.each do |m|
                h.li do
                  unless m.is_a?(Array)
                    h.a(href: "#{m}.html") { h.text m }
                  else
                    h.ul(class: 'sub') do
                      m.each do |sm  |
                        h.li { h.a(href: "#{sm}.html") { h.text sm }  }
                      end
                    end
                  end
                end
              end
            end
          end
        end
      end
    end
  end.to_html

  "<!DOCTYPE html>\n#{html}"
end












#mk_links(txts, term = nil) ⇒ Object










167
168
169
170
171
172
173
174




# File 'lib/shoes/manual/app.rb', line 167

def mk_links(txts, term = nil)
  txts.map { |txt| txt.gsub(IMAGE_RE, '') }
    .map { |txt| txt =~ /\[\[(\S+?)\]\]/m ? (t = Regexp.last_match[1].split('.'); link(ins(*marker(t.last, term))) { visit "/manual/#{find_pnum t.first}" }) : txt }
    .map do|txt|
      txt =~ /\[\[(\S+?) (.+?)\]\]/m ? (url = Regexp.last_match[1]; link(ins(*marker(Regexp.last_match[2], term))) { visit url =~ /^http/ ? url : "/manual/#{find_pnum url}" }) :
      (txt.is_a?(String) ? marker(txt, term) : txt)
    end
end












#mk_paras(str) ⇒ Object










176
177
178




# File 'lib/shoes/manual/app.rb', line 176

def mk_paras(str)
  str.split(PARA_RE) - ['']
end












#mk_sample_names ⇒ Object










215
216
217
218
219
220
221
222
223
224




# File 'lib/shoes/manual/app.rb', line 215

def mk_sample_names
  Dir[File.join(DIR, 'samples/sample*.rb')].map do |file|
    orig_name = File.basename file
    dummy_name = orig_name.sub(/sample(.*)\.rb/)do
      first, second = Regexp.last_match[1].split('-')
      "%02d%s%s" % [first.to_i, ('-' if second), second]
    end
    [dummy_name, orig_name]
  end.sort.map(&:last)
end












#mk_search_page ⇒ Object










396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415




# File 'lib/shoes/manual/app.rb', line 396

def mk_search_page
  s = self
  flow do
    show_header 'Search'
    show_toc

    flow width: 0.8, margin: [10, 0, 20, 0] do
      el = edit_line width: 300
      tagline link('search'){
        term = el.text.strip
        unless term.empty?
          descs, methods = s.search term
          @f.clear { s.show_search_result term, descs, methods }
        end
      }
      stack(height: 20) {}
      @f = flow {}
    end
  end
end












#mk_sidebar_list(num) ⇒ Object










365
366
367
368
369
370
371
372




# File 'lib/shoes/manual/app.rb', line 365

def mk_sidebar_list(num)
  toc = []
  [0..3, 4..9, 10..16, 17..32, 33..37].each do |r|
    toc.push TOC_LIST[r.first][0]
    toc.push(TOC_LIST[r.first + 1..r.last].to_a.map(&:first)) if r.include?(num)
  end
  toc
end












#sample_page ⇒ Object










203
204
205
206
207
208
209
210
211
212
213




# File 'lib/shoes/manual/app.rb', line 203

def sample_page
  mk_sample_names.each do |file|
    stack width: 80 do
      inscription file[0...-3]
      image File.join(DIR, "snapshots/#{file[0..-3]}png"), width: 50, height: 50 do
        Dir.chdir(File.join DIR, 'samples') { instance_eval(IO.read(file), file, 0) }
      end
      para NL
    end
  end
end












#search(term) ⇒ Object










417
418
419
420
421
422
423
424
425
426
427
428
429




# File 'lib/shoes/manual/app.rb', line 417

def search(term)
  descs, methods = [], []
  PNUMS.each_with_index do |(chapter, section), pnum|
    _pnum, docs_title, docs_description, docs_methods = get_title_and_desc(pnum)
    paras = mk_paras(docs_description)
    descs << [chapter, section, docs_title, paras] if paras.map { |txt| txt.gsub(CODE_RE, '').gsub(IMAGE_RE, '') }.join(' ').index(term)
    docs_methods.each do |docs_method|
      m, d = docs_method
      methods << [chapter, section, docs_title, docs_method] if m.index(term) || d.gsub(CODE_RE, '').gsub(IMAGE_RE, '').index(term)
    end
  end
  [descs, methods]
end












#show_header(docs_title) ⇒ Object










73
74
75
76
77
78
79
80
81




# File 'lib/shoes/manual/app.rb', line 73

def show_header(docs_title)
  background snow..white, angle: 90
  background midnightblue..black, height: 90
  flow width: 500 do
    para fg("The Shoes 4 Manual #{VERSION}", gray), left: 120, top: 10
    title fg(docs_title, white), left: 120, top: 30, font: 'Coolvetica'
  end
  image(File.join(DIR, 'static/shoes-icon.png'), width: 110, height: 110).move 5, -12
end












#show_methods(docs_methods, term = nil) ⇒ Object










97
98
99
100
101
102
103
104
105
106
107
108
109
110
111




# File 'lib/shoes/manual/app.rb', line 97

def show_methods(docs_methods, term = nil)
  docs_methods.each do |m, d|
    flow do
      background rgb(60, 60, 60), curve: 5
      n = m.index("\u00BB")
      if n
        para '  ', fg(strong(m[0...n]), white), fg(strong(m[n..-1]), rgb(160, 160, 160))
      else
        para '  ', fg(strong(m), white)
      end
    end
    para NL
    show_page mk_paras(d), false, term
  end
end












#show_page(paras, intro = false, term = nil) ⇒ Object










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




# File 'lib/shoes/manual/app.rb', line 113

def show_page(paras, intro = false, term = nil)
  s = self
  paras.each_with_index do |text, i|
    if text =~ CODE_RE
      text.gsub CODE_RE do |lines|
        lines = lines.split NL
        n = lines[1] =~ /\#\!ruby/ ? 2 : 1
        code = lines[n...-1].join(NL + '  ')
        flow do
          background rgb(190, 190, 190), curve: 5
          inscription link(fg('Run this', magenta)) { eval s.mk_executable(code), TOPLEVEL_BINDING }, '  ', align: 'right'
          if code.include? 'te-su-to'
            para fg(code('  ' + code), maroon), NL, margin: [-10, 10, 0, 20]
          else
            para(*highlight('  ' + code, nil).map { |e| code e }, NL * 2, margin: [-10, 10, 0, 20])
          end
        end
        fill_rest_of_line
        para NL
      end
      next
    end

    if text =~ /\A \* (.+)/m
      Regexp.last_match[1].split(/^ \* /).each do |txt|
        image File.join(DIR, 'static/shoes-icon.png'), width: 20, height: 20
        flow(width: 510) { show_paragraph txt, intro, i, term }
        para NL
      end
    else
      show_paragraph text, intro, i, term
    end
  end
end












#show_paragraph(txt, intro, i, term = nil) ⇒ Object










148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165




# File 'lib/shoes/manual/app.rb', line 148

def show_paragraph(txt, intro, i, term = nil)
  txt = txt.gsub("\n", ' ').gsub(/\^(.+?)\^/m, '\1').gsub(/\[\[BR\]\]/i, "\n")
  txts = txt.split(/(\[\[\S+?\]\])/m).map { |s| s.split(/(\[\[\S+? .+?\]\])/m) }.flatten
  case txts[0]
  when /\A==== (.+) ====/ then caption(*marker(Regexp.last_match[1], term), size: 24); para NL
  when /\A=== (.+) ===/ then tagline(*marker(Regexp.last_match[1], term), size: 12, weight: 'bold')
  when /\A== (.+) ==/ then subtitle(*marker(Regexp.last_match[1], term))
  when /\A= (.+) =/ then title(*marker(Regexp.last_match[1], term))
  when /\A\{COLORS\}/ then flow { color_page }
  when /\A\{SAMPLES\}/ then flow { sample_page }
  else
    para(*mk_deco(mk_links(txts, term).flatten), NL, (intro && i.zero?) ? { size: 16 } : '')
    txt.gsub IMAGE_RE do
      image File.join(Shoes::Manual::ROOT_DIR, "static/#{Regexp.last_match[3]}"), eval("{#{Regexp.last_match[2] || 'margin_left: 50'}}")
      fill_rest_of_line
    end
  end
end












#show_search_result(term, descs, methods) ⇒ Object










431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460




# File 'lib/shoes/manual/app.rb', line 431

def show_search_result(term, descs, methods)
  s = self
  if descs.empty? && methods.empty?
    subtitle 'Not Found'
  else
    methods.each do |(chapter, _section, docs_title, docs_method)|
      flow margin: [10, 10, 0, 5] do
        background rgb(200, 200, 200), curve: 5
        para "#{DOCS[chapter][0]}: #{docs_title.sub('The', '').split(' ').first}: ",
             link(docs_method[0]) { @f.clear { title docs_title; s.show_methods [docs_method], term } }, NL
      end
      stack(height: 2) {}
    end
    descs.each do |(chapter, section, docs_title, paras)|
      flow margin_left: 10 do
        if section
          background gray, curve: 5
          tagline link(fg(docs_title, white)) { @f.clear { title docs_title; s.show_page paras, true, term } }, width: 320
          inscription "Sub-Section under #{DOCS[chapter][0]}", stroke: lightgray, width: 180
        else
          background black(0.8), curve: 5
          subtitle link(fg(docs_title, white)) { @f.clear { title docs_title; s.show_page paras, true, term } }, width: 320
          inscription 'Section Header', stroke: lightgray, width: 100
        end
      end
      stack(height: 2) {}
    end
    para NL
  end
end












#show_toc ⇒ Object










83
84
85
86
87
88
89
90
91
92
93
94
95




# File 'lib/shoes/manual/app.rb', line 83

def show_toc
  s = self
  stack height: 30
  flow width: 0.2, margin_left: 10 do
    flow(margin_right: 20) do
      background black(0.7), curve: 5
      inscription "Not findng it?\n", 'Try ', link(fg 'Search', white) { visit '/manual/999' }, '!', align: 'center', stroke: lightgray
    end
    stack(height: 10) {}
    para(*TOC)
    para link(fg 'to_html', green) { s.html_manual }
  end
end












#table_of_contents ⇒ Object










47
48
49
50
51
52
53
54
55




# File 'lib/shoes/manual/app.rb', line 47

def table_of_contents
  PNUMS.map.with_index do |e, pnum|
    chapter, section = e
    title = section ? DOCS[chapter][1][:sections][section][1][:title] : DOCS[chapter][0]
    title = title.sub('The', '').split(' ').first
    TOC_LIST << [title, section]
    section ? ['   ', link(title) { visit "/manual/#{pnum}" }, "\n"] : [link(fg(title, magenta)) { visit "/manual/#{pnum}" }, "\n"]
  end.flatten
end