lib/helpers.rb

   1 # Nick's web site: Ruby helpers for processing
   2 #
   3 # Copyright © 2018-2019 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
  22 Xmlns = {
  23     'xhtml' => 'http://www.w3.org/1999/xhtml'
  24 }.freeze
  25
  26 def to_xhtml(subpath = "", item = @item)
  27     if item.identifier =~ '/index.*'
  28         ret =  "/" + subpath + "/index.xhtml"
  29     else
  30         ret = item.identifier.without_ext + "/" + subpath + "/index.xhtml"
  31     end
  32
  33     return ret.gsub(/\/+/, "/")
  34 end
  35
  36 def item_source(item = @item)
  37     filename = "content" + item.identifier
  38     filebase = filename.chomp(File.extname(filename))
  39
  40     [ if item.binary? then filebase + ".yaml" end,
  41       filename].compact.find { |f| File.file? f }
  42 end
  43
  44 def item_uri(item = @item, rep: :default)
  45     return item.path(rep: rep).gsub(/\/index.[^.]*$/, "/")
  46 end
  47
  48 def find_license(license)
  49     matches = @items.find_all("/license/" + license + ".*")
  50
  51     raise("License not defined: " + license) if !matches.length
  52     return matches.sort_by { |item| item.identifier } [0]
  53 end
  54
  55 # Return the first paragraph of the given item as a string.
  56 def item_longdesc(item)
  57     xml = Nokogiri::XML("<body xmlns='" + Xmlns["xhtml"] + "'>" +
  58                         item.compiled_content(snapshot: :rawbody) +
  59                         "</body>")
  60
  61     p = xml.xpath('//xhtml:p', Xmlns)
  62     if p.empty? then nil else p[0].xpath('string(.)') end
  63 end
  64
  65 def human_filesize(size)
  66     units = ["B", "KiB", "MiB", "GiB"]
  67
  68     for unit in units
  69         if (size < 1024)
  70             break
  71         end
  72
  73         size /= 1024.0
  74     end
  75
  76     sprintf("%.1f %s", size + 0.05, unit)
  77 end