Class: Kramdown::Converter::Rfc2629
- Includes:
- Utils::Html
- Defined in:
- lib/kramdown-rfc2629.rb
Overview
Converts a Kramdown::Document to HTML.
Constant Summary collapse
- KRAMDOWN_PERSISTENT =
:stopdoc:
- KRAMDOWN_PERSISTENT_VERBOSE =
/v/ === KRAMDOWN_PERSISTENT
- INDENTATION =
Defines the amount of indentation used when nesting XML tags.
2
- SVG_COLORS =
Hash.new {|h, k| k}
- B_W_THRESHOLD =
a little brighter than 1/2 0xFF -> white
hex_to_lin("a4")
- SVG_NAMESPACES =
{"xmlns"=>"http://www.w3.org/2000/svg", "xlink"=>"http://www.w3.org/1999/xlink"}
- DEFAULT_AASVG =
"aasvg --spaces=1"
- ARTWORK_TYPES =
%w(ascii-art binary-art call-flow hex-dump svg)
- STYLES =
{ul: 'symbols', ol: 'numbers', dl: 'hanging'}
- HTML_TAGS_WITH_BODY =
['div', 'script']
- ALIGNMENTS =
{ default: :left, left: :left, right: :right, center: :center}
- COLS_ALIGN =
{ "l" => :left, "c" => :center, "r" => :right}
- REFCACHEDIR =
ENV["KRAMDOWN_REFCACHEDIR"] || ".refcache"
- KRAMDOWN_OFFLINE =
warn “*** REFCACHEDIR #REFCACHEDIR”
- KRAMDOWN_REFCACHE_REFETCH =
- XML_RESOURCE_ORG_MAP =
- subdirectory name, cache ttl in seconds, does it provide for ?anchor=
{ "RFC" => ["bibxml", 86400*7, false, ->(fn, n){ [name = "reference.RFC.#{"%04d" % n.to_i}.xml", "https://bib.ietf.org/public/rfc/bibxml/#{name}"] } # was "https://www.rfc-editor.org/refs/bibxml/#{name}"] } ], "I-D" => ["bibxml3", false, false, ->(fn, n){ [fn, "https://datatracker.ietf.org/doc/bibxml3/draft-#{n.sub(/\Adraft-/, '')}.xml"] } ], "BCP" => ["bibxml-rfcsubseries", 86400*7, false, ->(fn, n){ Rfc2629::bcp_std_ref("BCP", n) } ], "STD" => ["bibxml-rfcsubseries", 86400*7, false, ->(fn, n){ Rfc2629::bcp_std_ref("STD", n) } ], "W3C" => "bibxml4", "3GPP" => "bibxml5", "SDO-3GPP" => "bibxml5", "ANSI" => "bibxml2", "CCITT" => "bibxml2", "FIPS" => "bibxml2", # "IANA" => "bibxml2", overtaken by bibxml8 "IEEE" => "bibxml6", # copied over to bibxml6 2019-02-27 "ISO" => "bibxml2", "ITU" => "bibxml2", "NIST" => "bibxml2", "OASIS" => "bibxml2", "PKCS" => "bibxml2", "DOI" => ["bibxml7", 86400, true, ->(fn, n){ ["computed-#{fn}", [:DOI, n] ] }, true # always_altproc ], # emulate old 24 h cache "IANA" => ["bibxml8", 86400, true], # ditto }
- XML_RESOURCE_ORG_HOST =
ENV["XML_RESOURCE_ORG_HOST"] || "bib.ietf.org"
- XML_RESOURCE_ORG_PREFIX =
ENV["XML_RESOURCE_ORG_PREFIX"] || "https://#{XML_RESOURCE_ORG_HOST}/public/rfc"
- KRAMDOWN_USE_TOOLS_SERVER =
- KRAMDOWN_REFCACHETTL =
(e = ENV["KRAMDOWN_REFCACHETTL"]) ? e.to_i : 3600
- KRAMDOWN_NO_TARGETS =
- KRAMDOWN_KEEP_TARGETS =
- EMPH =
{ em: "emph", strong: "strong"}
- TYPOGRAPHIC_SYMS =
{ :mdash => [::Kramdown::Utils::Entities.entity('mdash')], :ndash => [::Kramdown::Utils::Entities.entity('ndash')], :hellip => [::Kramdown::Utils::Entities.entity('hellip')], :laquo_space => [::Kramdown::Utils::Entities.entity('laquo'), ::Kramdown::Utils::Entities.entity('nbsp')], :raquo_space => [::Kramdown::Utils::Entities.entity('nbsp'), ::Kramdown::Utils::Entities.entity('raquo')], :laquo => [::Kramdown::Utils::Entities.entity('laquo')], :raquo => [::Kramdown::Utils::Entities.entity('raquo')] }
- MATH_LATEX_FILENAME =
File. '../../data/math.json', __FILE__
- MATH_LATEX =
JSON.parse(File.read(MATH_LATEX_FILENAME, encoding: Encoding::UTF_8))
- MATH_REPLACEMENTS =
- MATH_COMBININGMARKS =
- ITEM_RE =
'\s*(?:"([^"]*)"|([^,]*?))\s*'
- IREF_RE =
%r{\A(!\s*)?#{ITEM_RE}(?:,#{ITEM_RE})?\z}
Class Method Summary collapse
- .bcp_std_ref(t, n) ⇒ Object
- .hex_to_lin(h) ⇒ Object
- .process_markdown(v) ⇒ Object
-
.process_markdown1(v) ⇒ Object
Uuh.
- .process_markdown_to_rexml(v) ⇒ Object
Instance Method Summary collapse
- #capture_croak(t, err) ⇒ Object
-
#clean_pcdata(parts) ⇒ Object
hack, will become unnecessary with XML2RFCv3.
-
#clean_pcdatav3(parts) ⇒ Object
hack, will become unnecessary with v3 tables.
- #convert(el, indent = -INDENTATION,, opts = {}) ⇒ Object
- #convert1(el, indent, opts = {}) ⇒ Object
- #convert_a(el, indent, opts) ⇒ Object
-
#convert_abbreviation(el, indent, opts) ⇒ Object
XXX: This is wrong.
- #convert_blank(el, indent, opts) ⇒ Object
- #convert_blockquote(el, indent, opts) ⇒ Object
- #convert_br(el, indent, opts) ⇒ Object
- #convert_codeblock(el, indent, opts) ⇒ Object
- #convert_codespan(el, indent, opts) ⇒ Object
- #convert_comment(el, indent, opts) ⇒ Object
- #convert_contact(el, indent, opts) ⇒ Object
- #convert_dd(el, indent, opts) ⇒ Object
- #convert_dl(el, indent, opts) ⇒ Object
-
#convert_dt(el, indent, opts) ⇒ Object
SERIOUSLY BAD HACK:.
- #convert_em(el, indent, opts) ⇒ Object (also: #convert_strong)
- #convert_entity(el, indent, opts) ⇒ Object
-
#convert_footnote(el, indent, opts) ⇒ Object
XXX: footnotes into crefs???.
- #convert_header(el, indent, opts) ⇒ Object
-
#convert_hr(el, indent, opts) ⇒ Object
misuse for page break.
- #convert_html_element(el, indent, opts) ⇒ Object
-
#convert_img(el, indent, opts) ⇒ Object
misuse the tag!.
- #convert_iref(el, indent, opts) ⇒ Object
- #convert_li(el, indent, opts) ⇒ Object
-
#convert_math(el, indent, opts) ⇒ Object
XXX: This is missing sup/sub support, which needs to be added.
- #convert_p(el, indent, opts) ⇒ Object
- #convert_raw(el, indent, opts) ⇒ Object
- #convert_root(el, indent, opts) ⇒ Object
- #convert_smart_quote(el, indent, opts) ⇒ Object
-
#convert_table(el, indent, opts) ⇒ Object
This only works for tables with headers.
- #convert_td(el, indent, opts) ⇒ Object (also: #convert_th)
- #convert_text(el, indent, opts) ⇒ Object
- #convert_thead(el, indent, opts) ⇒ Object (also: #convert_tbody, #convert_tfoot, #convert_tr)
- #convert_typographic_sym(el, indent, opts) ⇒ Object
- #convert_ul(el, indent, opts) ⇒ Object (also: #convert_ol)
- #convert_xml_comment(el, indent, opts) ⇒ Object (also: #convert_xml_pi, #convert_html_doctype)
- #convert_xref(el, indent, opts) ⇒ Object
- #correct_location(location) ⇒ Object
- #el_html_attributes(el) ⇒ Object
- #el_html_attributes_with(el, defattr) ⇒ Object
- #end_sections(to_level, indent, location) ⇒ Object
-
#get_and_cache_resource(url, cachefile, tvalid = 7200, tn = Time.now) ⇒ Object
this is now slightly dangerous as multiple urls could map to the same cachefile.
- #get_and_write_resource(url, fn) ⇒ Object
- #get_and_write_resource_persistently(url, fn) ⇒ Object
- #get_doi(refname) ⇒ Object
-
#initialize(*doc) ⇒ Rfc2629
constructor
Initialize the XML converter with the given Kramdown document
doc
. - #inner(el, indent, opts) ⇒ Object
- #inner_a(el, indent, opts) ⇒ Object
- #iref_attr(s) ⇒ Object
- #memoize(meth, *args) ⇒ Object
- #mk_artwork(artwork_attr, typ, content) ⇒ Object
- #munge_latex(s) ⇒ Object
-
#nobr_hack(s) ⇒ Object
replace this by actual <nobr> once that exists.
- #saner_generate_id(value) ⇒ Object
- #shell_prepare(opt) ⇒ Object
- #sourcecode_checkproc(preprocs, checks, postprocs, loc_str, result) ⇒ Object
- #sourcecode_proc(proc, loc_str, result) ⇒ Object
-
#svg_clean(s) ⇒ Object
expensive, risky.
- #svg_clean_kgt(s) ⇒ Object
- #svg_munch_color(c, fill) ⇒ Object
- #svg_munch_id(id) ⇒ Object
- #svg_tool_process(t, svg_opt, txt_opt, result) ⇒ Object
Constructor Details
#initialize(*doc) ⇒ Rfc2629
Initialize the XML converter with the given Kramdown document doc
.
337 338 339 340 341 342 343 344 |
# File 'lib/kramdown-rfc2629.rb', line 337 def initialize(*doc) super @sec_level = 1 @location_delta = 100000 # until reset @location_correction = 0 # pre-scanning corrections @in_dt = 0 @footnote_names_in_use = {} end |
Class Method Details
.bcp_std_ref(t, n) ⇒ Object
1209 1210 1211 1212 1213 |
# File 'lib/kramdown-rfc2629.rb', line 1209 def self.bcp_std_ref(t, n) warn "*** #{t} anchors not supported in v2 format" unless $options.v3 [name = "reference.#{t}.#{"%04d" % n.to_i}.xml", "#{XML_RESOURCE_ORG_PREFIX}/bibxml-rfcsubseries/#{name}"] # FOR NOW end |
.hex_to_lin(h) ⇒ Object
433 434 435 |
# File 'lib/kramdown-rfc2629.rb', line 433 def self.hex_to_lin(h) h.to_i(16)**2.22 # approximating sRGB gamma end |
.process_markdown(v) ⇒ Object
400 401 402 |
# File 'lib/kramdown-rfc2629.rb', line 400 def self.process_markdown(v) process_markdown1(v)[3..-6] # skip <t>...</t>\n end |
.process_markdown1(v) ⇒ Object
Uuh. Heavy coupling.
394 395 396 397 398 |
# File 'lib/kramdown-rfc2629.rb', line 394 def self.process_markdown1(v) # Uuh. Heavy coupling. doc = ::Kramdown::Document.new(v, $global_markdown_options) $stderr.puts doc.warnings.to_yaml unless doc.warnings.empty? doc.to_rfc2629 end |
Instance Method Details
#capture_croak(t, err) ⇒ Object
512 513 514 515 516 517 518 |
# File 'lib/kramdown-rfc2629.rb', line 512 def capture_croak(t, err) if err != '' err.lines do |l| warn "*** [#{t}:] #{l.chomp}" end end end |
#clean_pcdata(parts) ⇒ Object
hack, will become unnecessary with XML2RFCv3
809 810 811 812 813 814 815 816 817 818 819 |
# File 'lib/kramdown-rfc2629.rb', line 809 def clean_pcdata(parts) # hack, will become unnecessary with XML2RFCv3 clean = '' irefs = '' # warn "clean_parts: #{parts.inspect}" parts.each do |p| md = p.match(%r{([^<]*)(.*)}) clean << md[1] irefs << md[2] # breaks for spanx... don't emphasize in headings! end [clean, irefs] end |
#clean_pcdatav3(parts) ⇒ Object
hack, will become unnecessary with v3 tables
821 822 823 824 825 826 827 828 829 830 831 832 833 |
# File 'lib/kramdown-rfc2629.rb', line 821 def clean_pcdatav3(parts) # hack, will become unnecessary with v3 tables clean = '' parts.each do |p| next if p.empty? d = REXML::Document.new("<foo>#{p}</foo>") t = REXML::XPath.each(d.root, "//text()").to_a.join if t != p warn "** simplified markup #{p.inspect} into #{t.inspect} in table heading" end clean << t end clean end |
#convert(el, indent = -INDENTATION,, opts = {}) ⇒ Object
350 351 352 353 354 355 |
# File 'lib/kramdown-rfc2629.rb', line 350 def convert(el, indent = -INDENTATION, opts = {}) if el.children[-1].type == :raw raw = convert1(el.children.pop, indent, opts) end "#{convert1(el, indent, opts)}#{end_sections(1, indent, el.[:location])}#{raw}" end |
#convert1(el, indent, opts = {}) ⇒ Object
357 358 359 360 |
# File 'lib/kramdown-rfc2629.rb', line 357 def convert1(el, indent, opts = {}) nopts = el.rfc2629_fix(opts) send("convert_#{el.type}", el, indent, nopts) end |
#convert_a(el, indent, opts) ⇒ Object
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 |
# File 'lib/kramdown-rfc2629.rb', line 1054 def convert_a(el, indent, opts) gi = el.attr.delete('gi') res = inner(el, indent, opts) target = el.attr['target'] if target[0..1] == "{{" # XXX ignoring all attributes and content s = ::Kramdown::Converter::Rfc2629::process_markdown(target) # if res != '' && s[-2..-1] == '/>' # if s =~ /\A<([-A-Za-z0-9_.]+) / # gi ||= $1 # end # s[-2..-1] = ">#{res}</#{gi}>" # end return s end if target[0] == "#" # handle [](#foo) as xref as in RFC 7328 el.attr['target'] = target = target[1..-1] if target.downcase == res.downcase res = '' # get rid of raw anchors leaking through end gi ||= "xref" else gi ||= "eref" end "<#{gi}#{el_html_attributes(el)}>#{res}</#{gi}>" end |
#convert_abbreviation(el, indent, opts) ⇒ Object
XXX: This is wrong
1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 |
# File 'lib/kramdown-rfc2629.rb', line 1506 def convert_abbreviation(el, indent, opts) # XXX: This is wrong if opts[:noabbrev] return el.value end value = el.value ix = value.gsub(/[\s\p{Z}]+/, " ") title = @root.[:abbrev_defs][ix] if title.nil? warn "*** abbrev mismatch: value = #{value.inspect} ix = #{ix.inspect}" else title = nil if title.empty? end if title == "<bcp14>" && $options.v3 return "<bcp14>#{value}</bcp14>" end hacked_value = value nobr = false if title && title =~ /\A<nobr>(\z|\s)/ nobr = true _nobr, title = title.split(' ', 2) hacked_value = nobr_hack(value) if title.nil? || title.empty? return hacked_value # we have "exhausted" this abbrev -- suppress normal meaning end end if title && title[0] == "#" target, title = title.split(' ', 2) if target == "#" target = value else target = target[1..-1] end else target = nil end if item = title pairs = title.split(Parser::RFC2629Kramdown::IREF_START).each_slice(2).to_a replacement = pairs.map {|x,| s = x.strip; s unless s.empty?}.compact.join(" ") irefs = pairs.map {|_,x| x && [x]}.compact warn "@@@ ABBREV MISMATCH #{irefs}" if title.scan(Parser::RFC2629Kramdown::IREF_START) != irefs if irefs.empty? subitem = value else iref = irefs.map{|a,| iref_attr(a)}.join('') end unless replacement.empty? replacement = nobr_hack(replacement) if nobr # XXX this can break XML replacement = ::Kramdown::Converter::Rfc2629::process_markdown(replacement) hacked_value = replacement end else item = value end iref ||= "<iref#{html_attributes(item: item, subitem: subitem)}/>" if target "#{iref}<xref#{html_attributes(target: target, format: "none")}>#{hacked_value}</xref>" else "#{iref}#{hacked_value}" end end |
#convert_blank(el, indent, opts) ⇒ Object
374 375 376 |
# File 'lib/kramdown-rfc2629.rb', line 374 def convert_blank(el, indent, opts) "\n" end |
#convert_blockquote(el, indent, opts) ⇒ Object
781 782 783 784 785 786 787 788 789 790 791 792 793 794 |
# File 'lib/kramdown-rfc2629.rb', line 781 def convert_blockquote(el, indent, opts) text = inner(el, indent, opts) if $options.v3 gi = el.attr.delete('gi') if gi && gi != 'ul' "#{' '*indent}<#{gi}#{el_html_attributes(el)}>\n#{text}#{' '*indent}</#{gi}>\n" else "#{' '*indent}<ul#{el_html_attributes_with(el, {"empty" => 'true'})}><li>\n#{text}#{' '*indent}</li></ul>\n" end else text = "<t></t>" unless text =~ /</ # empty block quote "#{' '*indent}<t><list style='empty'#{el_html_attributes(el)}>\n#{text}#{' '*indent}</list></t>\n" end end |
#convert_br(el, indent, opts) ⇒ Object
1046 1047 1048 1049 1050 1051 1052 |
# File 'lib/kramdown-rfc2629.rb', line 1046 def convert_br(el, indent, opts) if $options.v3 "<br />" else "<vspace />" end end |
#convert_codeblock(el, indent, opts) ⇒ Object
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 |
# File 'lib/kramdown-rfc2629.rb', line 620 def convert_codeblock(el, indent, opts) # el.attr['anchor'] ||= saner_generate_id(el.value) -- no longer in 1.0.6 result = el.value gi = el.attr.delete('gi') blockclass = el.attr.delete('class') if blockclass == 'language-tbreak' result = result.lines.map {|line| [line.chomp, 0]} spaceind = 0 result.each_with_index {|pair, index| if pair[0] == '' result[spaceind][1] += 1 pair[0] = nil unless index == spaceind else spaceind = index end } # $stderr.puts(result.inspect) result = result.map {|line, space| "<![CDATA[#{line.gsub(/^\s+/) {|s| "\u00A0" * s.size}}]]><vspace blankLines=\"#{space}\"/>" if line }.compact.join("\n") "#{' '*indent}<t>#{result}</t>\n" else artwork_attr = {} t = nil if blockclass classes = blockclass.split(' ') classes.each do |cl| if md = cl.match(/\Alanguage-(.*)/) t = artwork_attr["type"] = md[1] # XXX overwrite else $stderr.puts "*** Unimplemented codeblock class: #{cl}" end end end # compensate for XML2RFC idiosyncrasy by insisting on a blank line unless el.attr.delete('tight') result[0,0] = "\n" unless result[0,1] == "\n" end el.attr.each do |k, v| if md = k.match(/\A(?:artwork|sourcecode)-(.*)/) el.attr.delete(k) artwork_attr[md[1]] = v end end case t when "aasvg", "ditaa", "goat", "math", "math-asciitex", "mermaid", "mscgen", "plantuml", "plantuml-utxt", "protocol", "protocol-aasvg", "protocol-goat", "railroad", "railroad-utf8" if gi warn "*** Can't set GI #{gi} for composite SVG artset" end result, result1 = memoize(:svg_tool_process, t, artwork_attr.delete("svg-options"), artwork_attr.delete("txt-options"), result) retart = mk_artwork(artwork_attr, "ascii-art", "<![CDATA[#{result}#{result =~ /\n\Z/ ? '' : "\n"}]]>") if result1 # nest TXT in artset with SVG retsvg = mk_artwork(artwork_attr, "svg", result1.sub(/.*?<svg/m, "<svg")) retart = "<artset>#{retsvg}#{retart}</artset>" end "#{' '*indent}<figure#{el_html_attributes(el)}>#{retart}</figure>\n" else gi ||= ( if !$options.v3 || !t || ARTWORK_TYPES.include?(t) || artwork_attr["align"] "artwork" else "sourcecode" end ) loc_str = if anchor = el.attr['anchor'] "##{anchor}" elsif lineno = el.[:location] "#{correct_location(lineno)}" else "UNKNOWN" end preprocs = el.attr.delete("pre") checks = el.attr.delete("check") postprocs = el.attr.delete("post") case t when "cbor" warn "** There is no sourcecode-type “cbor”." warn "** Do you mean “cbor-diag” (diagnostic notation)" warn "** or “cbor-pretty” (annotated hex-dump)?" when "json" checks ||= "json" when /\A(.*)-from-yaml\z/ t = $1 preprocs ||= "yaml2json" end preprocs = (preprocs || '').split("-") checks = (checks || '').split("-") postprocs = (postprocs || '').split("-") result = sourcecode_checkproc(preprocs, checks, postprocs, loc_str, result) "#{' '*indent}<figure#{el_html_attributes(el)}><#{gi}#{html_attributes(artwork_attr)}><![CDATA[#{result}#{result =~ /\n\Z/ ? '' : "\n"}]]></#{gi}></figure>\n" end end end |
#convert_codespan(el, indent, opts) ⇒ Object
1347 1348 1349 1350 |
# File 'lib/kramdown-rfc2629.rb', line 1347 def convert_codespan(el, indent, opts) attrstring = el_html_attributes_with(el, {"style" => 'verb'}) "<spanx#{attrstring}>#{escape_html(el.value)}</spanx>" end |
#convert_comment(el, indent, opts) ⇒ Object
1037 1038 1039 1040 1041 1042 1043 1044 |
# File 'lib/kramdown-rfc2629.rb', line 1037 def convert_comment(el, indent, opts) ## Don't actually output all those comments into the XML: # if el.options[:category] == :block # "#{' '*indent}<!-- #{el.value} -->\n" # else # "<!-- #{el.value} -->" # end end |
#convert_contact(el, indent, opts) ⇒ Object
1102 1103 1104 |
# File 'lib/kramdown-rfc2629.rb', line 1102 def convert_contact(el, indent, opts) "<contact#{el_html_attributes(el)}/>" end |
#convert_dd(el, indent, opts) ⇒ Object
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 |
# File 'lib/kramdown-rfc2629.rb', line 906 def convert_dd(el, indent, opts) if $options.v3 out = '' if !opts[:haddt] out ="#{' '*indent}<dt/>\n" # you can't make this one up end opts[:haddt] = false out << "#{' '*indent}<dd#{el_html_attributes(el)}>\n#{inner(el, indent, opts)}#{' '*indent}</dd>\n" else output = ' '*indent if @in_dt == 1 @in_dt = 0 else output << "<t#{el_html_attributes(el)}>" end res = inner(el, indent+INDENTATION, opts.merge(unpacked: true)) # if el.children.empty? || el.children.first.options[:category] != :block output << res << (res =~ /\n\Z/ ? ' '*indent : '') # else FIXME: The latter case is needed for more complex cases # output << "\n" << res << ' '*indent # end output << "</t>\n" end end |
#convert_dl(el, indent, opts) ⇒ Object
877 878 879 880 881 882 883 884 885 886 887 888 889 890 |
# File 'lib/kramdown-rfc2629.rb', line 877 def convert_dl(el, indent, opts) if $options.v3 if hangindent = el.attr.delete('hangIndent') el.attr['indent'] ||= hangindent # new attribute name wins end vspace = el.attr.delete('vspace') if vspace && !el.attr['newline'] el.attr['newline'] = 'true' end "#{' '*indent}<dl#{el_html_attributes(el)}>\n#{inner(el, indent, opts.dup)}#{' '*indent}</dl>\n" else convert_ul(el, indent, opts) end end |
#convert_dt(el, indent, opts) ⇒ Object
SERIOUSLY BAD HACK:
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 |
# File 'lib/kramdown-rfc2629.rb', line 931 def convert_dt(el, indent, opts) # SERIOUSLY BAD HACK: if $options.v3 out = '' if opts[:haddt] out ="#{' '*indent}<dd><t/></dd>\n" # you can't make this one up end opts[:haddt] = true out << "#{' '*indent}<dt#{el_html_attributes(el)}>#{inner(el, indent, opts)}</dt>\n" else close = "#{' '*indent}</t>\n" * @in_dt @in_dt = 1 vspace = opts[:vspace] vspaceel = "<vspace blankLines='#{vspace}'/>" if vspace ht = escape_html(inner(el, indent, opts), :attribute) # XXX this may leave gunk "#{close}#{' '*indent}<t#{el_html_attributes(el)} hangText=\"#{ht}\">#{vspaceel}\n" end end |
#convert_em(el, indent, opts) ⇒ Object Also known as: convert_strong
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 |
# File 'lib/kramdown-rfc2629.rb', line 1389 def convert_em(el, indent, opts) if $options.v3 gi = el.type "<#{gi}#{el_html_attributes(el)}>#{inner(el, indent, opts)}</#{gi}>" else attrstring = el_html_attributes_with(el, {"style" => EMPH[el.type]}) span, irefs = clean_pcdata(inner_a(el, indent, opts)) "<spanx#{attrstring}>#{span}</spanx>#{irefs}" end end |
#convert_entity(el, indent, opts) ⇒ Object
1401 1402 1403 |
# File 'lib/kramdown-rfc2629.rb', line 1401 def convert_entity(el, indent, opts) entity_to_str(el.value) end |
#convert_footnote(el, indent, opts) ⇒ Object
XXX: footnotes into crefs???
1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 |
# File 'lib/kramdown-rfc2629.rb', line 1352 def convert_footnote(el, indent, opts) # XXX: footnotes into crefs??? # this would be more like xml2rfc v3: # "\n#{' '*indent}<cref>\n#{inner(el.value, indent, opts).rstrip}\n#{' '*indent}</cref>" content = inner(el.value, indent, opts).strip content = content.sub(/\A<t>(.*)<\/t>\z/m) {$1} name = ::Kramdown::Parser::RFC2629Kramdown.idref_cleanup(el.[:name]) o_name = name.dup while @footnote_names_in_use[name] do if name =~ /_\d+\z/ name.succ! else name << "_1" end end @footnote_names_in_use[name] = true attrstring = el_html_attributes_with(el, {"anchor" => name}) if $options.v3 if o_name[-1] == "-" # Ignore HTML attributes. Hmm. content else # do not indent span-level so we can stick to previous word. Good? "<cref#{attrstring}>#{content}</cref>" end else content = escape_html(content, :text) # text only... "\n#{' '*indent}<cref#{attrstring}>#{content}</cref>" end end |
#convert_header(el, indent, opts) ⇒ Object
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 |
# File 'lib/kramdown-rfc2629.rb', line 835 def convert_header(el, indent, opts) # todo: handle appendix tags el = el.deep_clone = @doc ? @doc. : @options # XXX: 0.11 vs. 0.12 if [:auto_ids] && !el.attr['anchor'] el.attr['anchor'] = saner_generate_id(el.[:raw_text]) end if $options.v3 if sl = el.attr.delete('slugifiedName') # could do general name- play attrstring = html_attributes({'slugifiedName' => sl}) end # noabbrev: true -- Workaround for https://github.com/ietf-tools/xml2rfc/issues/683 nm = inner(el, indent, opts.merge(noabbrev: true)) if ttl = el.attr['title'] warn "*** Section has two titles: >>#{ttl}<< and >>#{nm}<<" warn "*** Do you maybe have a loose IAL?" end irefs = "<name#{attrstring}>#{nm}</name>" # else clean, irefs = clean_pcdata(inner_a(el, indent, opts)) el.attr['title'] = clean end "#{end_sections(el.[:level], indent, el.[:location])}#{' '*indent}<section#{@sec_level += 1; el_html_attributes(el)}>#{irefs}\n" end |
#convert_hr(el, indent, opts) ⇒ Object
misuse for page break
860 861 862 |
# File 'lib/kramdown-rfc2629.rb', line 860 def convert_hr(el, indent, opts) # misuse for page break "#{' '*indent}<t><vspace blankLines='999' /></t>\n" end |
#convert_html_element(el, indent, opts) ⇒ Object
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 |
# File 'lib/kramdown-rfc2629.rb', line 951 def convert_html_element(el, indent, opts) res = inner(el, indent, opts) if el.[:category] == :span "<#{el.value}#{el_html_attributes(el)}" << (!res.empty? ? ">#{res}</#{el.value}>" : " />") else output = '' output << ' '*indent if !el.[:parent_is_raw] output << "<#{el.value}#{el_html_attributes(el)}" if !res.empty? && el.[:parse_type] != :block output << ">#{res}</#{el.value}>" elsif !res.empty? output << ">\n#{res}" << ' '*indent << "</#{el.value}>" elsif HTML_TAGS_WITH_BODY.include?(el.value) output << "></#{el.value}>" else output << " />" end output << "\n" if el.[:outer_element] || !el.[:parent_is_raw] output end end |
#convert_img(el, indent, opts) ⇒ Object
misuse the tag!
1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 |
# File 'lib/kramdown-rfc2629.rb', line 1262 def convert_img(el, indent, opts) # misuse the tag! if a = el.attr alt = a.delete('alt').strip alt = '' if alt == '!' # work around re-wrap uglyness if src = a.delete('src') a['target'] = src end end if alt == ":include:" # Really bad misuse of tag... ann = el.attr.delete('ann') anchor = el.attr.delete('anchor') || ( # not yet warn "*** missing anchor for '#{src}'" src ) anchor = ::Kramdown::Parser::RFC2629Kramdown.idref_cleanup(anchor) anchor.gsub!('/', '_') # should take out all illegals to_insert = "" src.scan(/(W3C|3GPP|[A-Z-]+)[.]?([A-Za-z_0-9.\(\)\/\+-]+)/) do |t, n| never_altproc = n.sub!(/^[.]/, "") fn = "reference.#{t}.#{n}.xml" sub, ttl, _can_anchor, altproc, always_altproc = XML_RESOURCE_ORG_MAP[t] ttl ||= KRAMDOWN_REFCACHETTL # everything but RFCs might change a lot puts "*** Huh: #{fn}" unless sub if altproc && !never_altproc && (!KRAMDOWN_USE_TOOLS_SERVER || always_altproc) fn, url = altproc.call(fn, n) else url = "#{XML_RESOURCE_ORG_PREFIX}/#{sub}/#{fn}" fn = "alt-#{fn}" if never_altproc || KRAMDOWN_USE_TOOLS_SERVER end # if can_anchor # create anchor server-side for stand_alone: false # url << "?anchor=#{anchor}" # fn[/.xml$/] = "--anchor=#{anchor}.xml" # end to_insert = get_and_cache_resource(url, fn.gsub('/', '_'), ttl) to_insert.scrub! rescue nil # only do this for Ruby >= 2.1 begin d = REXML::Document.new(to_insert) d.xml_decl.nowrite d.delete d.doctype d.context[:attribute_quote] = :quote # Set double-quote as the attribute value delimiter d.root.attributes["anchor"] = anchor if t == "RFC" or t == "I-D" if KRAMDOWN_NO_TARGETS || !KRAMDOWN_KEEP_TARGETS d.root.attributes["target"] = nil REXML::XPath.each(d.root, "/reference/format") { |x| d.root.delete_element(x) } else REXML::XPath.each(d.root, "/reference/format") { |x| x.attributes["target"].sub!(%r{https?://www.ietf.org/internet-drafts/}, %{https://www.ietf.org/archive/id/}) if t == "I-D" } end elsif t == "IANA" d.root.attributes["target"].sub!(%r{\Ahttp://www.iana.org/assignments/}, 'https://www.iana.org/assignments/') end if ann el = ::Kramdown::Converter::Rfc2629::process_markdown_to_rexml(ann).root el.name = "annotation" d.root.add_element(el) end to_insert = d.to_s rescue Exception => e warn "** Can't manipulate reference XML: #{e}" broken = true to_insert = nil end # this may be a bit controversial: Don't break the build if reference is broken if KRAMDOWN_OFFLINE || broken unless to_insert to_insert = "<reference anchor='#{anchor}'> <front> <title>*** BROKEN REFERENCE ***</title> <author> <organization/> </author> <date/> </front> </reference>" warn "*** KRAMDOWN_OFFLINE: Inserting broken reference for #{fn}" end else exit 66 unless to_insert # EX_NOINPUT end end to_insert else "<xref#{el_html_attributes(el)}>#{alt}</xref>" end end |
#convert_iref(el, indent, opts) ⇒ Object
1502 1503 1504 |
# File 'lib/kramdown-rfc2629.rb', line 1502 def convert_iref(el, indent, opts) iref_attr(el.attr['target']) end |
#convert_li(el, indent, opts) ⇒ Object
892 893 894 895 896 897 898 899 900 901 902 903 904 |
# File 'lib/kramdown-rfc2629.rb', line 892 def convert_li(el, indent, opts) res_a = inner_a(el, indent, opts) if el.children.empty? || el.children.first.[:category] == :span res = res_a.join('') else # merge multiple <t> elements res = res_a.select { |x| x.strip != '' }.map { |x| x.sub(/\A\s*<t>(.*)<\/t>\s*\Z/m) { $1} }.join("#{' '*indent}<vspace blankLines='1'/>\n").gsub(%r{(</list>)\s*<vspace blankLines='1'/>}) { $1 }.gsub(%r{<vspace blankLines='1'/>\s*(<list)}) { $1 } end "#{' '*indent}<t#{el_html_attributes(el)}>#{res}#{(res =~ /\n\Z/ ? ' '*indent : '')}</t>\n" end |
#convert_math(el, indent, opts) ⇒ Object
XXX: This is missing sup/sub support, which needs to be added
1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 |
# File 'lib/kramdown-rfc2629.rb', line 1443 def convert_math(el, indent, opts) # XXX: This is wrong el = el.deep_clone if el.[:category] == :block el.attr['artwork-type'] ||= '' el.attr['artwork-type'] += (el.attr['artwork-type'].empty? ? '' : ' ') + 'math' artwork_attr = {} el.attr.each do |k, v| if md = k.match(/\Aartwork-(.*)/) el.attr.delete(k) artwork_attr[md[1]] = v end end result, err, _s = Open3.capture3("tex2mail -noindent -ragged -by_par -linelength=69", stdin_data: el.value); # warn "*** tex2mail not in path?" unless s.success? -- doesn't have useful status capture_croak("tex2mail", err) "#{' '*indent}<figure#{el_html_attributes(el)}><artwork#{html_attributes(artwork_attr)}><![CDATA[#{result}#{result =~ /\n\Z/ ? '' : "\n"}]]></artwork></figure>\n" else type = 'spanx' if $options.v3 type = 'contact' result = munge_latex(el.value) attrstring = el_html_attributes_with(el, {"fullname" => result.chomp, "asciiFullname" => ''}) else warn "*** no support for inline math in XML2RFCv2" type = 'spanx' attrstring = el_html_attributes_with(el, {"style" => 'verb'}) content = escape_html(el.value, :text) end "<#{type}#{attrstring}>#{content}</#{type}>" end end |
#convert_p(el, indent, opts) ⇒ Object
382 383 384 385 386 387 388 |
# File 'lib/kramdown-rfc2629.rb', line 382 def convert_p(el, indent, opts) if (el.children.size == 1 && el.children[0].type == :img) || opts[:unpacked] inner(el, indent, opts) # Part of the bad reference hack else "#{' '*indent}<t#{el_html_attributes(el)}>#{inner(el, indent, opts)}</t>\n" end end |
#convert_raw(el, indent, opts) ⇒ Object
1382 1383 1384 1385 |
# File 'lib/kramdown-rfc2629.rb', line 1382 def convert_raw(el, indent, opts) end_sections(1, indent, el.[:location]) + el.value + (el.[:category] == :block ? "\n" : '') end |
#convert_root(el, indent, opts) ⇒ Object
1573 1574 1575 |
# File 'lib/kramdown-rfc2629.rb', line 1573 def convert_root(el, indent, opts) result = inner(el, indent, opts) end |
#convert_smart_quote(el, indent, opts) ⇒ Object
1422 1423 1424 |
# File 'lib/kramdown-rfc2629.rb', line 1422 def convert_smart_quote(el, indent, opts) entity_to_str(smart_quote_entity(el)) end |
#convert_table(el, indent, opts) ⇒ Object
This only works for tables with headers
995 996 997 998 999 |
# File 'lib/kramdown-rfc2629.rb', line 995 def convert_table(el, indent, opts) # This only works for tables with headers alignment = el.[:alignment].map { |al| ALIGNMENTS[al]} cols = (el.attr.delete("cols") || "").split(' ') "#{' '*indent}<texttable#{el_html_attributes(el)}>\n#{inner(el, indent, opts.merge(table_alignment: alignment, table_cols: cols))}#{' '*indent}</texttable>\n" end |
#convert_td(el, indent, opts) ⇒ Object Also known as: convert_th
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 |
# File 'lib/kramdown-rfc2629.rb', line 1008 def convert_td(el, indent, opts) if alignment = opts[:table_alignment] alignment = alignment.shift if cols = opts[:table_cols].shift md = cols.match(/(\d*(|em|[%*]))([lrc])/) if md[1].to_i != 0 widthval = md[1] widthval << "em" if md[2].empty? widthopt = "width='#{widthval}' " end alignment = COLS_ALIGN[md[3]] || :left end end if alignment xmlres = inner_a(el, indent, opts) if $options.v3 res = clean_pcdatav3(xmlres) else res, irefs = clean_pcdata(xmlres) warn "*** lost markup #{irefs} in table heading" unless irefs.empty? end "#{' '*indent}<ttcol #{widthopt}align='#{alignment}'#{el_html_attributes(el)}>#{res.empty? ? " " : res}</ttcol>\n" # XXX need clean_pcdata else res = inner(el, indent, opts) "#{' '*indent}<c#{el_html_attributes(el)}>#{res.empty? ? " " : res}</c>\n" end end |
#convert_text(el, indent, opts) ⇒ Object
378 379 380 |
# File 'lib/kramdown-rfc2629.rb', line 378 def convert_text(el, indent, opts) escape_html(el.value, :text) end |
#convert_thead(el, indent, opts) ⇒ Object Also known as: convert_tbody, convert_tfoot, convert_tr
1001 1002 1003 |
# File 'lib/kramdown-rfc2629.rb', line 1001 def convert_thead(el, indent, opts) inner(el, indent, opts) end |
#convert_typographic_sym(el, indent, opts) ⇒ Object
1414 1415 1416 1417 1418 1419 1420 |
# File 'lib/kramdown-rfc2629.rb', line 1414 def convert_typographic_sym(el, indent, opts) if (result = @options[:typographic_symbols][el.value]) escape_html(result, :text) else TYPOGRAPHIC_SYMS[el.value].map {|e| entity_to_str(e) }.join('') end end |
#convert_ul(el, indent, opts) ⇒ Object Also known as: convert_ol
866 867 868 869 870 871 872 873 874 |
# File 'lib/kramdown-rfc2629.rb', line 866 def convert_ul(el, indent, opts) opts = opts.merge(vspace: el.attr.delete('vspace')) attrstring = el_html_attributes_with(el, {"style" => STYLES[el.type]}) if opts[:unpacked] "#{' '*indent}<list#{attrstring}>\n#{inner(el, indent, opts)}#{' '*indent}</list>\n" else "#{' '*indent}<t><list#{attrstring}>\n#{inner(el, indent, opts)}#{' '*indent}</list></t>\n" end end |
#convert_xml_comment(el, indent, opts) ⇒ Object Also known as: convert_xml_pi, convert_html_doctype
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 |
# File 'lib/kramdown-rfc2629.rb', line 973 def convert_xml_comment(el, indent, opts) if el.value =~ /\A<\?line (([-+]?)[0-9]+)\?>\z/ lineno = $1.to_i case $2 when '' # absolute @location_delta = lineno - el.[:location] when '+', '-' # correction (pre-scanning!) @location_correction += lineno end end if el.[:category] == :block && !el.[:parent_is_raw] ' '*indent + el.value + "\n" else el.value end end |
#convert_xref(el, indent, opts) ⇒ Object
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 |
# File 'lib/kramdown-rfc2629.rb', line 1081 def convert_xref(el, indent, opts) gi = el.attr.delete('gi') text = el.attr.delete('text') target = el.attr['target'] if target[0] == "&" "#{target};" else if target =~ %r{\A\w+:(?://|.*@)} gi ||= "eref" else gi ||= "xref" end if text tail = ">#{Rfc2629::process_markdown(text)}</#{gi}>" else tail = "/>" end "<#{gi}#{el_html_attributes(el)}#{tail}" end end |
#correct_location(location) ⇒ Object
346 347 348 |
# File 'lib/kramdown-rfc2629.rb', line 346 def correct_location(location) location + @location_delta + @location_correction end |
#el_html_attributes(el) ⇒ Object
309 310 311 |
# File 'lib/kramdown-rfc2629.rb', line 309 def el_html_attributes(el) html_attributes(el.attr) end |
#el_html_attributes_with(el, defattr) ⇒ Object
312 313 314 |
# File 'lib/kramdown-rfc2629.rb', line 312 def el_html_attributes_with(el, defattr) html_attributes(defattr.merge(el.attr)) end |
#end_sections(to_level, indent, location) ⇒ Object
796 797 798 799 800 801 802 803 804 805 806 807 |
# File 'lib/kramdown-rfc2629.rb', line 796 def end_sections(to_level, indent, location) if indent < 0 indent = 0 end if @sec_level >= to_level delta = (@sec_level - to_level) @sec_level = to_level "#{' '*indent}</section>\n" * delta else $stderr.puts "** #{correct_location(location)}: Bad section nesting: start heading level at 1 and increment by 1" end end |
#get_and_cache_resource(url, cachefile, tvalid = 7200, tn = Time.now) ⇒ Object
this is now slightly dangerous as multiple urls could map to the same cachefile
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 |
# File 'lib/kramdown-rfc2629.rb', line 1148 def get_and_cache_resource(url, cachefile, tvalid = 7200, tn = Time.now) fn = "#{REFCACHEDIR}/#{cachefile}" Dir.mkdir(REFCACHEDIR) unless Dir.exist?(REFCACHEDIR) f = File.stat(fn) rescue nil unless KRAMDOWN_REFCACHE_REFETCH if !KRAMDOWN_OFFLINE && (!f || tn - f.mtime >= tvalid) if f = "renewing (stale by #{"%.1f" % ((tn-f.mtime)/86400)} days)" fetch_timeout = 10 # seconds, give up quickly if just renewing else = "fetching" fetch_timeout = 60 # seconds; long timeout needed for Travis end $stderr.puts "#{fn}: #{} from #{url}" if Array === url begin case url[0] when :DOI ref = get_doi(url[1]) File.write(fn, ref) end rescue Exception => e warn "*** Error fetching #{url[0]} #{url[1].inspect}: #{e}" end elsif ENV["HAVE_WGET"] `cd #{REFCACHEDIR}; wget -t 3 -T #{fetch_timeout} -Nnv "#{url}"` # ignore errors if offline (hack) begin File.utime nil, nil, fn rescue Errno::ENOENT warn "Can't fetch #{url} -- is wget in path?" end else require 'open-uri' require 'socket' require 'openssl' require 'timeout' begin Timeout::timeout(fetch_timeout) do if $http begin # belt and suspenders get_and_write_resource_persistently(url, fn) rescue Exception => e warn "*** Can't get with persistent HTTP: #{e}" get_and_write_resource(url, fn) end else get_and_write_resource(url, fn) end end rescue OpenURI::HTTPError, Errno::EHOSTUNREACH, Errno::ECONNREFUSED, SocketError, Timeout::Error => e warn "*** #{e} while fetching #{url}" end end end begin File.read(fn) # this blows up if no cache available after fetch attempt rescue Errno::ENOENT => e warn "*** #{e} for #{fn}" end end |
#get_and_write_resource(url, fn) ⇒ Object
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 |
# File 'lib/kramdown-rfc2629.rb', line 1113 def get_and_write_resource(url, fn) = {} if ENV["KRAMDOWN_DONT_VERIFY_HTTPS"] [:ssl_verify_mode] = OpenSSL::SSL::VERIFY_NONE end # workaround for OpenSSL on Windows... # URI.open(url, **options) do |uf| # not portable to older versions OpenURI.open_uri(url, **) do |uf| s = uf.read if uf.status[0] != "200" warn "*** Status code #{status} while fetching #{url}" else File.write(fn, s) end end end |
#get_and_write_resource_persistently(url, fn) ⇒ Object
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 |
# File 'lib/kramdown-rfc2629.rb', line 1129 def get_and_write_resource_persistently(url, fn) t1 = Time.now response = $http.request(URI(url)) if response.code != "200" raise "Status code #{response.code} while fetching #{url}" else File.write(fn, response.body) end t2 = Time.now warn "(#{"%.3f" % (t2 - t1)} s)" if KRAMDOWN_PERSISTENT_VERBOSE end |
#get_doi(refname) ⇒ Object
1141 1142 1143 1144 1145 |
# File 'lib/kramdown-rfc2629.rb', line 1141 def get_doi(refname) lit = doi_fetch_and_convert(refname, fuzzy: true) anchor = "DOI_#{refname.gsub("/", "_")}" KramdownRFC::ref_to_xml(anchor, lit) end |
#inner(el, indent, opts) ⇒ Object
370 371 372 |
# File 'lib/kramdown-rfc2629.rb', line 370 def inner(el, indent, opts) inner_a(el, indent, opts).join('') end |
#inner_a(el, indent, opts) ⇒ Object
362 363 364 365 366 367 368 |
# File 'lib/kramdown-rfc2629.rb', line 362 def inner_a(el, indent, opts) indent += INDENTATION el.children.map do |inner_el| nopts = inner_el.rfc2629_fix(opts) send("convert_#{inner_el.type}", inner_el, indent, nopts) end end |
#iref_attr(s) ⇒ Object
1479 1480 1481 1482 1483 1484 1485 1486 1487 |
# File 'lib/kramdown-rfc2629.rb', line 1479 def iref_attr(s) md = s.match(IREF_RE) attr = { item: md[2] || md[3], subitem: md[4] || md[5], primary: md[1] && 'true', } "<iref#{html_attributes(attr)}/>" end |
#memoize(meth, *args) ⇒ Object
497 498 499 500 501 502 503 504 505 506 507 508 509 510 |
# File 'lib/kramdown-rfc2629.rb', line 497 def memoize(meth, *args) require 'digest' Dir.mkdir(REFCACHEDIR) unless Dir.exist?(REFCACHEDIR) kdrfc_version = Gem.loaded_specs["kramdown-rfc2629"].version.to_s.gsub('.', '_') rescue "UNKNOWN" fn = "#{REFCACHEDIR}/kdrfc-#{kdrfc_version}-#{meth}-#{Digest::SHA256.hexdigest(Marshal.dump(args))[0...40]}.cache" begin out = Marshal.load(File.binread(fn)) rescue StandardError => e # warn e.inspect out = method(meth).call(*args) File.binwrite(fn, Marshal.dump(out)) end out end |
#mk_artwork(artwork_attr, typ, content) ⇒ Object
777 778 779 |
# File 'lib/kramdown-rfc2629.rb', line 777 def mk_artwork(artwork_attr, typ, content) "<artwork #{html_attributes(artwork_attr.merge("type" => typ))}>#{content}</artwork>" end |
#munge_latex(s) ⇒ Object
1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 |
# File 'lib/kramdown-rfc2629.rb', line 1431 def munge_latex(s) MATH_REPLACEMENTS.each do |o, n| s.gsub!(o, n) end MATH_COMBININGMARKS.each do |m, n| re = /\\#{m[1..-1]}\{(\X)\}/ s.gsub!(re) { "#$1#{n}" } end s end |
#nobr_hack(s) ⇒ Object
replace this by actual <nobr> once that exists
1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 |
# File 'lib/kramdown-rfc2629.rb', line 1489 def nobr_hack(s) # replace this by actual <nobr> once that exists # https://github.com/ietf-tools/xml2rfc/blob/main/xml2rfc/utils.py#L42 s.gsub(/([-\s\/])(?!\s)/) { case rep = $1 when /\A\s\z/ "\u00A0" # nbsp when "-" "\u2011" # nbhy -- XXX this might mangle dashes else "#{rep}\u2060" end } end |
#saner_generate_id(value) ⇒ Object
390 391 392 |
# File 'lib/kramdown-rfc2629.rb', line 390 def saner_generate_id(value) generate_id(value).gsub(/-+/, '-') end |
#shell_prepare(opt) ⇒ Object
520 521 522 |
# File 'lib/kramdown-rfc2629.rb', line 520 def shell_prepare(opt) " " << opt.shellsplit.shelljoin end |
#sourcecode_checkproc(preprocs, checks, postprocs, loc_str, result) ⇒ Object
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 |
# File 'lib/kramdown-rfc2629.rb', line 746 def sourcecode_checkproc(preprocs, checks, postprocs, loc_str, result) preprocs.each do |proc| result = sourcecode_proc(proc, loc_str, result) end if preprocs check_input = result checks.each do |check| case check when "skipheader" check_input = handle_artwork_sourcecode(check_input).sub(/.*?\n\n/m, '') when "json" # check for 8792; undo if needed: begin JSON.load(handle_artwork_sourcecode(check_input)) rescue => e err1 = "*** #{loc_str}: JSON isn't: #{JSON.dump(e.[0..40])}\n" begin JSON.load("{" << check_input << "}") rescue => e warn err1 << "*** not even with braces added around: #{JSON.dump(e.[0..40])}" end end else warn "*** #{loc_str}: unknown check '#{check}'" end end if checks postprocs.each do |proc| result = sourcecode_proc(proc, loc_str, result) end if postprocs result end |
#sourcecode_proc(proc, loc_str, result) ⇒ Object
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 |
# File 'lib/kramdown-rfc2629.rb', line 724 def sourcecode_proc(proc, loc_str, result) case proc when "dedent" result = remove_indentation(result) when /\Afold(\d*)(left(\d*))?(dry)?\z/ fold = [$1.to_i, # col 0 for '' ($3.to_i if $2), # left 0 for '', nil if no "left" $4] # dry result = fix_unterminated_line(fold8792_1(trim_empty_lines_around(result), *fold)) # XXX when "yaml2json" begin y = YAML.safe_load(result, aliases: true, filename: loc_str) result = JSON.pretty_generate(y) rescue => e warn "*** #{loc_str}: YAML isn't: #{e.}\n" end else warn "*** #{loc_str}: unknown proc '#{proc}'" end result end |
#svg_clean(s) ⇒ Object
expensive, risky
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 |
# File 'lib/kramdown-rfc2629.rb', line 481 def svg_clean(s) # expensive, risky d = REXML::Document.new(s) REXML::XPath.each(d.root, "//*[@shape-rendering]") { |x| x.attributes["shape-rendering"] = nil } #; warn x.inspect } REXML::XPath.each(d.root, "//*[@text-rendering]") { |x| x.attributes["text-rendering"] = nil } #; warn x.inspect } REXML::XPath.each(d.root, "//*[@stroke]") { |x| x.attributes["stroke"] = svg_munch_color(x.attributes["stroke"], false) } REXML::XPath.each(d.root, "//*[@fill]") { |x| x.attributes["fill"] = svg_munch_color(x.attributes["fill"], true) } REXML::XPath.each(d.root, "//*[@id]") { |x| x.attributes["id"] = svg_munch_id(x.attributes["id"]) } ## REXML::XPath.each(d.root, "//rect") { |x| x.attributes["style"] = "fill:none;stroke:black;stroke-width:1" unless x.attributes["style"] } # Fix for mermaid: REXML::XPath.each(d.root, "//polygon") { |x| x.attributes["rx"] = nil; x.attributes["ry"] = nil } d.to_s rescue => detail warn "*** Can't clean SVG: #{detail}" d end |
#svg_clean_kgt(s) ⇒ Object
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 |
# File 'lib/kramdown-rfc2629.rb', line 459 def svg_clean_kgt(s) d = REXML::Document.new(s) REXML::XPath.each(d.root, "/xmlns:svg", SVG_NAMESPACES) do |x| if (w = x.attributes["width"]) && (h = x.attributes["height"]) x.attributes["viewBox"] = "0 0 %d %d" % [w, h] end if x.attributes["viewBox"] x.attributes["width"] = nil x.attributes["height"] = nil end end REXML::XPath.each(d.root, "//rect|//line|//path") do |x| x.attributes["fill"] = "none" x.attributes["stroke"] = "black" x.attributes["stroke-width"] = "1.5" end d.to_s rescue => detail warn "*** Can't clean SVG: #{detail}" d end |
#svg_munch_color(c, fill) ⇒ Object
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 |
# File 'lib/kramdown-rfc2629.rb', line 440 def svg_munch_color(c, fill) c = SVG_COLORS[c] case c when /\A#(..)(..)(..)\z/ if hex_to_lin($1)*0.2126 + hex_to_lin($2)*0.7152 + hex_to_lin($3)*0.0722 >= B_W_THRESHOLD 'white' else 'black' end when 'none' 'none' if fill # delete for stroke else c end end |
#svg_munch_id(id) ⇒ Object
429 430 431 |
# File 'lib/kramdown-rfc2629.rb', line 429 def svg_munch_id(id) id.gsub(/[^-._A-Za-z0-9]/) {|x| "_%02X" % x.ord} end |
#svg_tool_process(t, svg_opt, txt_opt, result) ⇒ Object
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 |
# File 'lib/kramdown-rfc2629.rb', line 526 def svg_tool_process(t, svg_opt, txt_opt, result) require 'tempfile' file = Tempfile.new("kramdown-rfc") file.write(result) file.close dont_clean = false dont_check = false svg_opt = shell_prepare(svg_opt) if svg_opt txt_opt = shell_prepare(txt_opt) if txt_opt case t when "protocol", "protocol-goat", "protocol-aasvg" cmdparm = result.lines.map(&:strip).select {|x| x != ''}.join(',') result, err, _s = Open3.capture3("protocol #{Shellwords.escape(cmdparm)}#{txt_opt}", stdin_data: '') if t == "protocol-goat" file.unlink file = Tempfile.new("kramdown-rfc") file.write(result) file.close result1, err, _s = Open3.capture3("goat#{svg_opt} #{file.path}", stdin_data: result); dont_clean = true elsif t == "protocol-aasvg" result1, err, _s = Open3.capture3("#{DEFAULT_AASVG}#{svg_opt}", stdin_data: result); dont_clean = true dont_check = true else result1 = nil end when "goat" result1, err, _s = Open3.capture3("goat#{svg_opt} #{file.path}", stdin_data: result); dont_clean = true when "aasvg" result1, err, _s = Open3.capture3("#{DEFAULT_AASVG}#{svg_opt}", stdin_data: result); dont_clean = true dont_check = true when "ditaa" # XXX: This needs some form of option-setting result1, err, _s = Open3.capture3("ditaa #{file.path} --svg -o -#{svg_opt}", stdin_data: result); when "mscgen" result1, err, _s = Open3.capture3("mscgen -T svg -i #{file.path} -o -#{svg_opt}", stdin_data: result); when "mermaid" result1, err, _s = Open3.capture3("mmdc -i #{file.path}#{svg_opt}", stdin_data: result); # -b transparent outpath = file.path + ".svg" result1 = File.read(outpath) rescue '' # don't die before providing error message File.unlink(outpath) rescue nil # ditto when "plantuml", "plantuml-utxt" plantuml = "@startuml\n#{result}\n@enduml" result1, err, _s = Open3.capture3("plantuml -pipe -tsvg#{svg_opt}", stdin_data: plantuml); result, err1, _s = Open3.capture3("plantuml -pipe -tutxt#{txt_opt}", stdin_data: plantuml) if t == "plantuml-utxt" err << err1.to_s when "railroad", "railroad-utf8" result1, err1, _s = Open3.capture3("kgt -l abnf -e svg#{svg_opt}", stdin_data: result); result1 = svg_clean_kgt(result1); dont_clean = true result, err, _s = Open3.capture3("kgt -l abnf -e rr#{t == "railroad" ? "text" : "utf8"}#{txt_opt}", stdin_data: result); err << err1.to_s when "math", "math-asciitex" result1, err, _s = Open3.capture3("tex2svg --font STIX --speech=false#{svg_opt} #{Shellwords.escape(' ' << result)}"); begin raise Errno::ENOENT if t == "math-asciitex" result, err1, s = Open3.capture3("utftex -m #{txt_opt}", stdin_data: result) if s.exitstatus != 0 warn "** utftex: #{err1.inspect}" raise Errno::ENOENT end rescue Errno::ENOENT warn "** utftex not working, falling back to asciitex" unless t == "math-asciitex" result, err1, _s = Open3.capture3("asciitex -f #{file.path}#{txt_opt}") end err << err1 end capture_croak(t, err) # warn ["text:", result.inspect] # warn ["svg:", result1.inspect] file.unlink if result1 result1 = svg_clean(result1) unless dont_clean unless dont_check file = Tempfile.new("kramdown-rfc") file.write(result1) file.close result1, err, _s = Open3.capture3("svgcheck -qa #{file.path}"); file.unlink # warn ["svgcheck:", result1.inspect] capture_croak("svgcheck", err) end if result1 == '' warn "*** could not create svg for #{result.inspect[0...20]}..." exit 65 # EX_DATAERR end end [result, result1] # text, svg end |