lib/helpers.rb

   1 # Nick's web site: Ruby helpers for processing
   2 #
   3 # Copyright © 2018-2021 Nick Bowler
   4 #
   5 # This program is free software: you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation, either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  17
  18 require 'nokogiri'
  19
  20 use_helper Nanoc::Helpers::Breadcrumbs
  21 use_helper Nanoc::Helpers::Blogging
  22
  23 Xmlns = {
  24     'xhtml' => 'http://www.w3.org/1999/xhtml'
  25 }.freeze
  26 $counters = {}
  27
  28 def to_xhtml(subpath = "", item = @item)
  29     if item.identifier =~ '/index.*'
  30         ret =  "/" + subpath + "/index.xhtml"
  31     else
  32         ret = item.identifier.without_ext + "/" + subpath + "/index.xhtml"
  33     end
  34
  35     return ret.gsub(/\/+/, "/")
  36 end
  37
  38 def item_source(item = @item)
  39     filename = "content" + item.identifier
  40     filebase = filename.chomp(File.extname(filename))
  41
  42     [ if item.binary? then filebase + ".yaml" end,
  43       filename].compact.find { |f| File.file? f }
  44 end
  45
  46 def item_uri(item = @item, rep: :default)
  47     return item.path(rep: rep).sub(%r{/index[.][^.]*$}, "/")
  48 end
  49
  50 def rep_uri(rep = @rep)
  51     return rep.path.sub(%r{/index[.][^.]*$}, "/")
  52 end
  53
  54 def find_license(license)
  55     matches = @items.find_all("/license/" + license + ".*")
  56
  57     raise("License not defined: " + license) if !matches.length
  58     return matches.sort_by { |item| item.identifier } [0]
  59 end
  60
  61 # Return the first paragraph of the given item as a string.
  62 def item_longdesc(item)
  63     xml = Nokogiri::XML("<body xmlns='" + Xmlns["xhtml"] + "'>" +
  64                         item.compiled_content(snapshot: :rawbody) +
  65                         "</body>")
  66
  67     p = xml.xpath('//xhtml:p', Xmlns)
  68     if p.empty? then nil else p[0].xpath('string(.)') end
  69 end
  70
  71 def counter(name = :default, item = @item)
  72     $counters[item] ||= {}
  73     $counters[item][name] ||= 0
  74
  75     name.to_s.capitalize + " " + ($counters[item][name] += 1).to_s
  76 end
  77
  78 def human_filesize(size)
  79     units = ["B", "KiB", "MiB", "GiB"]
  80     prec = 0
  81
  82     for unit in units
  83         if (size < 1024)
  84             break
  85         end
  86
  87         size /= 1024.0
  88         prec = 1
  89     end
  90
  91     sprintf("%.*f %s", prec, size + 0.05, unit)
  92 end