giblish 0.7.6 → 0.8.0

data/lib/giblish/pathtree.rb

@@ -1,5 +1,3 @@
-#!/usr/bin/env ruby
-
 # This class can convert the following paths:
 # basedir/file_1
 # basedir/file_2
@@ -19,8 +17,7 @@
 #     dir3
 #       file_5
 class PathTree
-  attr_reader :name
-  attr_reader :data
+  attr_reader :name, :data
 
   def initialize(tail = nil, data = nil)
     @children = []
@@ -37,7 +34,7 @@ class PathTree
     end
   end
 
-  def add_path(tail,data = nil)
+  def add_path(tail, data = nil)
     tail = tail.split("/") unless tail.is_a?(Array)
     return if tail.empty?
 

data/lib/giblish/utils.rb

@@ -2,22 +2,24 @@ require "logger"
 require "pathname"
 require "fileutils"
 
-class GiblogFormatter
-  def call severity, datetime, progname, msg
-    "#{datetime.strftime('%H:%M:%S')} #{severity} - #{msg}\n"
+# The logger used from within giblish
+class Giblog
+  # Defines the format for log messages from giblish.
+  class GiblogFormatter
+    def call(severity, datetime, _progname, msg)
+      "#{datetime.strftime('%H:%M:%S')} #{severity} - #{msg}\n"
+    end
   end
-end
 
-class Giblog
+  # bootstrap the application-wide logger object
   def self.setup
     return if defined? @logger
-    @logger = Logger.new(STDOUT)
+
+    @logger = Logger.new($stdout)
     @logger.formatter = GiblogFormatter.new
-    # @logger.formatter = proc do |severity, datetime, _progname, msg|
-    #   "#{datetime.strftime('%H:%M:%S')} #{severity} - #{msg}\n"
-    # end
   end
 
+  # returns the application-wide logger instance.
   def self.logger
     unless defined? @logger
       puts "!!!! Error: Trying to access logger before setup !!!!"
@@ -28,76 +30,81 @@ class Giblog
   end
 end
 
-
-
 # Public: Contains a number of generic utility methods.
 module Giblish
-
-  class UserInfoFormatter
-    SEVERITY_LABELS = { 'WARN' => 'WARNING', 'FATAL' => 'FAILED' }
-
-    # {:text=>"...",
-    #  :source_location=>#<Asciidoctor::Reader::Cursor:0x000055e65a8729e0
-    #          @file="<full adoc filename>",
-    #          @dir="<full src dir>",
-    #          @path="<only file name>",
-    #          @lineno=<src line no>
-    # }
-    def call severity, datetime, progname, msg
-      message = case msg
-                when ::String
-                  msg
-                when ::Hash
-                  # asciidoctor seem to emit a hash with error text and source location info
-                  # for warnings and errors
-                  str = ""
-                  str << "Line #{msg[:source_location].lineno.to_s} - " if msg[:source_location]
-                  str << "#{msg[:text].to_s}" if msg[:text]
-                  str
-                else
-                  msg.inspect
-                end
-      %(#{datetime.strftime('%H:%M:%S')} #{progname}: #{SEVERITY_LABELS[severity] || severity}: #{message}\n)
-    end
-  end
+  # a logger customized to process info received from asciidoctors
+  # stdout.
   class AsciidoctorLogger < ::Logger
+    # log formatter specialized for formatting messages from
+    # asciidoctor's stdout
+    class UserInfoFormatter
+      SEVERITY_LABELS = { "WARN" => "WARNING", "FATAL" => "FAILED" }.freeze
+
+      # The hash that can be emitted as the msg from asciidoctor have the
+      # following format:
+      # {:text=>"...",
+      #  :source_location=>#<Asciidoctor::Reader::Cursor:0x000055e65a8729e0
+      #          @file="<full adoc filename>",
+      #          @dir="<full src dir>",
+      #          @path="<only file name>",
+      #          @lineno=<src line no>
+      # }
+      def call(severity, datetime, progname, msg)
+        message = case msg
+                  when ::String
+                    msg
+                  when ::Hash
+                    # asciidoctor seem to emit a hash with error text and source location info
+                    # for warnings and errors
+                    str = String.new("")
+                    src_loc = msg.fetch(:source_location, nil)
+                    err_txt = msg.fetch(:text, nil)
+                    str << "Line #{src_loc.lineno} - " if src_loc
+                    str << err_txt.to_s if err_txt
+                    str
+                  else
+                    msg.inspect
+                  end
+        %(#{datetime.strftime('%H:%M:%S')} #{progname}: #{SEVERITY_LABELS[severity] || severity}: #{message}\n)
+      end
+    end
 
-    attr_reader :max_severity
-    attr_reader :user_info_str
+    attr_reader :max_severity, :user_info_str
 
-    def initialize user_info_log_level
-      super(STDOUT,progname: "(from asciidoctor)", formatter: UserInfoFormatter.new)
+    def initialize(user_info_log_level)
+      super($stdout, progname: "(from asciidoctor)", formatter: UserInfoFormatter.new)
       @user_info_str = StringIO.new
       @user_info_logger = ::Logger.new(@user_info_str, formatter: UserInfoFormatter.new, level: user_info_log_level)
     end
 
-    def add severity, message = nil, progname = nil
+    def add(severity, message = nil, progname = nil)
       if (severity ||= UNKNOWN) > (@max_severity ||= severity)
         @max_severity = severity
       end
-      @user_info_logger.add(severity,message,progname)
+      @user_info_logger.add(severity, message, progname)
       super
     end
   end
 
+  # returns the paths to the search assets and web assets
+  # in the deployment machine's file system.
   class DeploymentPaths
-
     attr_reader :web_path
 
     def initialize(web_path, search_asset_path)
       @search_assets_path = if search_asset_path.nil?
                               nil
                             else
-                              Pathname.new("/#{search_asset_path.to_s}").cleanpath
+                              Pathname.new("/#{search_asset_path}").cleanpath
                             end
       @web_path = if web_path.nil?
                     nil
                   else
-                    Pathname.new("/#{web_path.to_s}/web_assets").cleanpath
+                    Pathname.new("/#{web_path}/web_assets").cleanpath
                   end
     end
 
-    def search_assets_path(branch_dir=nil)
+    def search_assets_path(branch_dir = nil)
       if branch_dir.nil?
         @search_assets_path
       else
@@ -105,18 +112,13 @@ module Giblish
       end
     end
 
-    def search_assets_path=(path)
-      @search_assets_path = path
-    end
+    attr_writer :search_assets_path
   end
 
   # Helper class to ease construction of different paths for input and output
   # files and directories
   class PathManager
-    attr_reader :src_root_abs
-    attr_reader :dst_root_abs
-    attr_reader :resource_dir_abs
-    attr_reader :search_assets_abs
+    attr_reader :src_root_abs, :dst_root_abs, :resource_dir_abs, :search_assets_abs
 
     # Public:
     #
@@ -128,13 +130,12 @@ module Giblish
     #                resources
     # create_search_asset_dir - true if this instance shall create a dir for storing
     #                search artefacts, false otherwise
-    def initialize(src_root, dst_root, resource_dir = nil,create_search_asset_dir=false)
+    def initialize(src_root, dst_root, resource_dir = nil, create_search_asset_dir = false)
       # Make sure that the source root exists in the file system
       @src_root_abs = Pathname.new(src_root).realpath
       self.dst_root_abs = dst_root
 
-      self.search_assets_abs = create_search_asset_dir ?
-                                   @dst_root_abs.join("search_assets") : nil
+      self.search_assets_abs = (@dst_root_abs.join("search_assets") if create_search_asset_dir)
 
       # Make sure that the resource dir exists if user gives a path to it
       resource_dir && (@resource_dir_abs = Pathname.new(resource_dir).realpath)
@@ -208,7 +209,7 @@ module Giblish
     # return the relative path from a generated document to
     # the supplied folder given the corresponding absolute source
     # file path
-    def relpath_to_dir_after_generate(src_filepath,dir_path)
+    def relpath_to_dir_after_generate(src_filepath, dir_path)
       dst_abs = dst_abs_from_src_abs(src_filepath)
       dir = self.class.to_pathname(dir_path)
       dir.relative_path_from(dst_abs)
@@ -281,7 +282,7 @@ module Giblish
     #          - the directory itself when called with an existing directory
     #          - the parent dir when called with a non-existing file/directory
     def self.closest_dir(in_path)
-      sr = self.to_pathname(in_path)
+      sr = to_pathname(in_path)
       if sr.exist?
         sr.directory? ? sr.realpath : sr.dirname.realpath
       else
@@ -303,7 +304,7 @@ module Giblish
         return p if git_dir.directory?
       end
     end
-  end # end of PathManager
+  end
 
   # Helper method that provides the user with a way of processing only the
   # lines within the asciidoc header block.
@@ -345,7 +346,7 @@ module Giblish
   # end
   def process_header_lines_from_file(path)
     lines = File.readlines(path)
-    process_header_lines(lines,&Proc.new)
+    process_header_lines(lines, &Proc.new)
   end
   module_function :process_header_lines_from_file
 
@@ -362,8 +363,8 @@ module Giblish
   module_function :with_captured_stderr
 
   # transforms strings to valid asciidoctor id strings
-  def to_valid_id(input_str,id_prefix="_", id_separator="_")
-    id_str = input_str.strip.downcase.gsub(%r{[^a-z0-9]+}, id_separator)
+  def to_valid_id(input_str, id_prefix = "_", id_separator = "_")
+    id_str = input_str.strip.downcase.gsub(/[^a-z0-9]+/, id_separator)
     id_str = "#{id_prefix}#{id_str}"
     id_str.chomp(id_separator)
   end
@@ -375,18 +376,17 @@ module Giblish
   # Ex
   #   which('ruby') #=> /usr/bin/ruby
   def which(cmd)
-    exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-    ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-      exts.each { |ext|
+    exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+    ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
+      exts.each do |ext|
         exe = File.join(path, "#{cmd}#{ext}")
         return exe if File.executable?(exe) && !File.directory?(exe)
-      }
+      end
     end
-    return nil
+    nil
   end
   module_function :which
 
-
   # returns raw html that displays a search box to let the user
   # acces the text search functionality.
   #
@@ -401,14 +401,13 @@ module Giblish
   #                                  as seen from the local file system on the machine that
   #                                  runs the search script)
   def generate_search_box_html(css, cgi_path, opts)
-
     # Replace the button with the below to use a text-only version of the btn
     # <button id="search" type="submit">Search</button>
     <<~SEARCH_INFO
       ++++
         <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
         <form class="example" action="#{cgi_path}" style="margin:20px 0px 20px 0px;max-width:790px">
-            Search all documents: 
+            Search all documents:
             <input id="searchphrase" type="text" placeholder="Search.." name="searchphrase"/>
             <button id="search" type="submit"><i class="fa fa-search"></i></button>
             <br>
@@ -421,12 +420,11 @@ module Giblish
 
             <input type="hidden" name="searchassetstop" value="#{opts[:search_assets_top]}"</input>
             <input type="hidden" name="webassetstop" value="#{opts[:web_assets_top]}"</input>
-            #{'<input type="hidden" name="css" value="' + css +'"</input>' unless css.nil? }
+            #{%(<input type="hidden" name="css" value="#{css}"</input>) unless css.nil?}
         </form>
       ++++
 
     SEARCH_INFO
   end
   module_function :generate_search_box_html
-
 end

data/lib/giblish/version.rb

@@ -1,3 +1,3 @@
 module Giblish
-  VERSION = "0.7.6".freeze
+  VERSION = "0.8.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: giblish
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.0
 platform: ruby
 authors:
 - Anders Rillbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.20.3
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-mathematical
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.5
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
@@ -89,7 +103,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.10
+        version: 2.0.16
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -99,83 +113,83 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.10
+        version: 2.0.16
 - !ruby/object:Gem::Dependency
   name: asciidoctor-diagram
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: asciidoctor-pdf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.24'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.24'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: prawn-svg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.32.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.32.0
 description: |
   giblish generates indexed and searchable documents from a tree of
   asciidoc files.
@@ -258,14 +272,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A tool for publishing asciidoc docs stored in git repos