giblish 0.6.1 → 0.7.0

data/lib/giblish/docconverter.rb

@@ -30,8 +30,9 @@ module Giblish
     # the path manager used by this converter
     attr_accessor :paths
 
-    def initialize(paths, options)
+    def initialize(paths, deployment_info, options)
       @paths = paths
+      @deployment_info = deployment_info
       @user_style = options[:userStyle]
       @converter_options = COMMON_CONVERTER_OPTS.dup
 
@@ -168,17 +169,14 @@ module Giblish
 
   # Converts asciidoc files to html5 output.
   class HtmlConverter < DocConverter
-    def initialize(paths, options)
-      super paths, options
+    def initialize(paths, deployment_info, options)
+      super paths, deployment_info, options
 
       # validate that things are ok on the resource front
       # and copy if needed
       @dst_asset_dir = @paths.dst_root_abs.join("web_assets")
       validate_and_copy_resources @dst_asset_dir
 
-      # convenience path to css dir
-      @dst_css_dir = @dst_asset_dir.join("css")
-
       # identify ourselves as an html converter
       add_backend_options({backend: "html5", fileext: "html"})
       # setup the attributes specific for this converter
@@ -188,28 +186,45 @@ module Giblish
     protected
 
     def add_doc_specific_attributes(filepath, is_src_file, attributes)
-      doc_attributes = {}
-      if @paths.resource_dir_abs and not @web_root
-        # user wants to use own styling without use of a
-        # web root. the correct css link is the relative path
-        # from the specific doc to the common css directory
-        css_rel_dir = if is_src_file
-                        # the filepath is a src path
-                        @paths.relpath_to_dir_after_generate(
-                          filepath,
-                          @dst_css_dir
-                        )
-                      else
-                        # the given file path is the destination path of
-                        # the generated file, find the relative path to the
-                        # css dir
-                        dst_dir = PathManager.closest_dir(filepath)
-                        @dst_css_dir.relative_path_from(dst_dir)
-                      end
-        doc_attributes["stylesdir"] = css_rel_dir.to_s
+      doc_attrib = {}
+      if @paths.resource_dir_abs
+        # user has given a resource dir, use the css from that dir
+        doc_attrib.merge!(
+            {
+                "linkcss" => 1,
+                "stylesheet" => @user_style ||= "giblish.css",
+                "copycss!" => 1
+            }
+        )
+        if @deployment_info.web_path.nil?
+          # user wants to deploy without web server, the css
+          # link shall thus be the relative path from the
+          # generated doc to the css directory
+          dst_css_dir = @dst_asset_dir.join("css")
+          css_rel_dir = if is_src_file
+                          # the filepath is a src path
+                          @paths.relpath_to_dir_after_generate(
+                              filepath,
+                              dst_css_dir
+                          )
+                        else
+                          # the given file path is the destination path of
+                          # the generated file, find the relative path to the
+                          # css dir
+                          dst_dir = PathManager.closest_dir(filepath)
+                          dst_css_dir.relative_path_from(dst_dir)
+                        end
+          doc_attrib["stylesdir"] = css_rel_dir.to_s
+        else
+          # user has given a web deployment path, the css shall then
+          # be linked using that path
+          doc_attrib["stylesdir"] = @deployment_info.web_path.join("css").cleanpath.to_s
+        end
       end
+        Giblog.logger.debug {"Rendered docs expect a css at: #{doc_attrib["stylesdir"]}"}
+        Giblog.logger.debug {"The expected css is named: #{doc_attrib["stylesheet"]}"}
 
-      attributes.merge!(doc_attributes)
+      attributes.merge!(doc_attrib)
     end
 
     private
@@ -220,29 +235,6 @@ module Giblish
       html_attrib = {
           "data-uri" => 1,
       }
-
-      if @paths.resource_dir_abs
-        # user wants to use own styling, set common attributes
-        html_attrib.merge!(
-            {
-                "linkcss" => 1,
-                "stylesheet" => @user_style ||= "giblish.css",
-                "copycss!" => 1
-            }
-        )
-
-        # check if user wants to use a web root path
-        @web_root = @paths.web_root_abs
-
-        if @web_root
-          # if user requested a web root to be used, the correct
-          # css link is the relative path from the web root to the
-          # css file. This is true for all documents
-          wr_rel = @dst_css_dir.relative_path_from @web_root
-          Giblog.logger.info {"Relative web root: #{wr_rel}"}
-          html_attrib["stylesdir"] = "/" << wr_rel.to_s
-        end
-      end
       html_attrib
     end
 
@@ -285,8 +277,8 @@ module Giblish
   end
 
   class PdfConverter < DocConverter
-    def initialize(paths, options)
-      super paths, options
+    def initialize(paths, deployment_info, options)
+      super paths, deployment_info, options
 
       # identify ourselves as a pdf converter
       add_backend_options({backend: "pdf", fileext: "pdf"})

data/lib/giblish/indexheadings.rb

@@ -41,7 +41,18 @@ module Giblish
     # of this class for each processed file
     @heading_index = {"file_infos" => []}
 
+    # prio order:
+    # 1. values in this hash
+    # 2. values taken from the document
+    # 3. default values
+    @id_elements = {
+#        prefix: "_",
+#        separator: "_"
+    }
+
     class << self
+      attr_accessor :id_elements
+
       def heading_index
         @heading_index
       end
@@ -67,7 +78,7 @@ module Giblish
         end
 
         Giblog.logger.info { "writing json to #{dst_dir.join("heading_index.json").to_s}" }
-        File.open(dst_dir.join("heading_index.json").to_s,"w") do |f|
+        File.open(dst_dir.join("heading_index.json").to_s, "w") do |f|
           f.write(heading_index.to_json)
         end
       end
@@ -87,6 +98,10 @@ module Giblish
       # processed the text)
       title = find_title reader.lines
 
+      # make sure we use the correct id elements when indexing
+      # sections
+      opts = set_id_attributes(reader.lines)
+
       # Index all headings in the doc
       Giblog.logger.debug { "indexing headings in #{src_path}" }
       sections = []
@@ -96,7 +111,7 @@ module Giblish
           "sections" => sections
       }
 
-      index_sections(reader,file_info_hash)
+      index_sections(reader, file_info_hash, opts)
 
       heading_index["file_infos"] << file_info_hash
       reader
@@ -105,7 +120,7 @@ module Giblish
     private
 
     # build the 'sections' array
-    def index_sections(reader, file_info_hash)
+    def index_sections(reader, file_info_hash, opts)
       sections = file_info_hash["sections"]
 
       heading_regex = Regexp.new(/^=+\s+(.*)$/)
@@ -137,17 +152,17 @@ module Giblish
           m = heading_regex.match(line)
           if m
             # we have an anchor and got a heading as expected, index it
-            section = { "id" => match_str }
+            section = {"id" => match_str}
             section["title"] = m[1].strip
             section["line_no"] = line_no
             sections << section
           else
-            Giblog.logger.debug {"Did not index the anchor: #{match_str} at line #{line_no}, probably not associated with a heading."}
+            Giblog.logger.debug { "Did not index the anchor: #{match_str} at line #{line_no}, probably not associated with a heading." }
           end
           state = :text
         when :heading
           # we got a heading without an accompanying anchor, index it
-          section = { "id" => get_unique_id(file_info_hash, match_str) }
+          section = {"id" => get_unique_id(file_info_hash, match_str, opts)}
           section["title"] = m[1].strip
           section["line_no"] = line_no
           sections << section
@@ -168,8 +183,46 @@ module Giblish
       title
     end
 
-    def get_unique_id(doc_heading_dict, heading_str)
-      id_base = Giblish.to_valid_id(heading_str)
+    # id elements prio:
+    # 1. values in class variable
+    # 2. values taken from doc
+    # 3. default values
+    def set_id_attributes(lines)
+      # default values
+      result = {
+          id_prefix: "_",
+          id_separator: "_"
+      }
+
+      # check if the doc specifies id attributes
+      Giblish.process_header_lines(lines) do |line|
+        m = /^:idprefix:(.*)$/.match(line)
+        n = /^:idseparator:(.*)$/.match(line)
+        if m
+          # We found a id prefix
+          result[:id_prefix] = m[1].strip
+        end
+        if n
+          # We found a id separator
+          result[:id_separator] = n[1].strip
+        end
+      end
+
+
+      if IndexHeadings.id_elements.has_key?(:id_prefix)
+        result[:id_prefix] = IndexHeadings.id_elements[:id_prefix]
+      end
+
+      if IndexHeadings.id_elements.has_key?(:id_separator)
+        result[:id_separator] = IndexHeadings.id_elements[:id_separator]
+      end
+
+      result
+    end
+
+    def get_unique_id(doc_heading_dict, heading_str, opts)
+
+      id_base = Giblish.to_valid_id(heading_str, opts[:id_prefix], opts[:id_separator])
       return id_base if !doc_heading_dict.key? id_base
 
       # handle the case with several sections with the same name
@@ -190,7 +243,6 @@ module Giblish
     end
   end
 
-
   # Helper method to register the docid preprocessor extension with
   # the asciidoctor engine.
   def register_index_heading_extension
@@ -198,5 +250,6 @@ module Giblish
       preprocessor IndexHeadings
     end
   end
+
   module_function :register_index_heading_extension
 end

data/lib/giblish/utils.rb

@@ -80,13 +80,43 @@ module Giblish
     end
   end
 
+  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
+                            end
+      @web_path = if web_path.nil?
+                    nil
+                  else
+                    Pathname.new("/#{web_path.to_s}/web_assets").cleanpath
+                  end
+    end
+
+    def search_assets_path(branch_dir=nil)
+      if branch_dir.nil?
+        @search_assets_path
+      else
+        @search_assets_path.join(branch_dir)
+      end
+    end
+
+    def search_assets_path=(path)
+      @search_assets_path = path
+    end
+  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 :web_root_abs
+    attr_reader :search_assets_abs
 
     # Public:
     #
@@ -96,20 +126,30 @@ module Giblish
     #            tree
     # resource_dir - a string or pathname with the directory containing
     #                resources
-    def initialize(src_root, dst_root, resource_dir = nil, web_root = nil)
+    # 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)
       # 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
+
       # Make sure that the resource dir exists if user gives a path to it
       resource_dir && (@resource_dir_abs = Pathname.new(resource_dir).realpath)
+    end
 
-      # Set web root if given by user
-      @web_root_abs = nil
-      if web_root
-        web_root = "/" + web_root unless web_root[0] == '/'
-        @web_root_abs = web_root ? Pathname.new(web_root) : nil
+    def search_assets_abs=(path)
+      if path.nil?
+        @search_assets_abs = nil
+        return
       end
+      # Make sure that the destination root exists and expand it to an
+      # absolute path
+      dir = Pathname.new(path)
+      dir.mkpath
+      @search_assets_abs = dir.realpath
     end
 
     def dst_root_abs=(dst_root)
@@ -174,18 +214,6 @@ module Giblish
       dir.relative_path_from(dst_abs)
     end
 
-    def reldir_from_web_root(path)
-      p = self.class.closest_dir path
-      return p if @web_root_abs.nil?
-      p.relative_path_from(@web_root_abs)
-    end
-
-    def reldir_to_web_root(path)
-      p = self.class.closest_dir path
-      return p if @web_root_abs.nil?
-      @web_root_abs.relative_path_from(p)
-    end
-
     def adoc_output_file(infile_path, extension)
       # Get absolute source dir path
       src_dir_abs = self.class.closest_dir infile_path
@@ -334,10 +362,10 @@ module Giblish
   module_function :with_captured_stderr
 
   # transforms strings to valid asciidoctor id strings
-  def to_valid_id(input_str)
-    id_str = "_#{input_str.strip.downcase}"
-    id_str.gsub!(%r{[^a-z0-9]+},"_")
-    id_str.chomp('_')
+  def to_valid_id(input_str,id_prefix="_", id_separator="_")
+    id_str = input_str.strip.downcase.gsub(%r{[^a-z0-9]+}, id_separator)
+    id_str = "#{id_prefix}#{id_str}"
+    id_str.chomp(id_separator)
   end
   module_function :to_valid_id
 
@@ -362,32 +390,38 @@ module Giblish
   # returns raw html that displays a search box to let the user
   # acces the text search functionality.
   #
-  # css          - the name of the css file to use for the search box layout
-  # cgi_path     - the path to a cgi script that implements the server side
+  # css          - the name of the css file to use for the search result layout
+  # cgi_path     - the (uri) path to a cgi script that implements the server side
   #                functionality of searching the text
-  # path_manager - an instance of the path manager class to keep track of all
-  #                destinations.
-  def generate_search_box_html(css, cgi_path, paths)
-
-    # button with magnifying glass icon (not working when deployed)
-    # <button id="search" type="submit"><i class="fa fa-search"></i></button>
+  # opts:
+  # :web_assets_top => string   # the path to the 'web_assets' dir as seen when serving
+  #                               the web server (eg www.mysite.com/blah/doc_root ->
+  #                               web_assets_top shall be '/blah/doc_root')
+  # :search_assets_top => string   # the path to where the 'heading.json' file is located (
+  #                                  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
       ++++
-        <form class="example" action="#{cgi_path}" style="margin:20px 0px 20px 0px;max-width:380px">
+        <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: 
             <input id="searchphrase" type="text" placeholder="Search.." name="searchphrase"/>
-            <button id="search" type="submit">Search</button>
+            <button id="search" type="submit"><i class="fa fa-search"></i></button>
             <br>
 
             <input id="ignorecase" type="checkbox" value="true" name="ignorecase" checked/>
             <label for="ignorecase">Ignore Case</label>
             &nbsp;&nbsp;
-            <input id="useregexp" type="checkbox" value="true" name="regexp"/>
+            <input id="useregexp" type="checkbox" value="true" name="useregexp"/>
             <label for="useregexp">Use Regexp</label>
 
-            <input type="hidden" name="topdir" value="#{paths.dst_root_abs}"</input>
-            <input type="hidden" name="reltop" value="#{paths.reldir_from_web_root(paths.dst_root_abs)}"</input>
-            <input type="hidden" name="css" value="#{css}"</input>
+            <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? }
         </form>
       ++++
 

data/lib/giblish/version.rb

@@ -1,3 +1,3 @@
 module Giblish
-  VERSION = "0.6.1".freeze
+  VERSION = "0.7.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: giblish
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Anders Rillbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2020-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0.beta.6
+        version: 1.5.0.rc.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0.beta.6
+        version: 1.5.0.rc.1
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -148,15 +148,17 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: 0.30.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.1
-description: A tool for publishing asciidoc docs stored in git repos
+        version: 0.30.0
+description: |
+  giblish generates indexed and searchable documents from a tree of
+  asciidoc files.
 email:
 - anders.rillbert@kutso.se
 executables:
@@ -168,6 +170,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- Changelog
 - Gemfile
 - LICENSE
 - README.adoc
@@ -181,6 +184,7 @@ files:
 - data/testdocs/wellformed/docidtest/docid_2.adoc
 - data/testdocs/wellformed/simple.adoc
 - data/testdocs/wellformed/source_highlighting/highlight_source.adoc
+- docgen/resources/css/adoc-colony.css
 - docgen/resources/css/giblish.css
 - docgen/resources/fonts/Ubuntu-B.ttf
 - docgen/resources/fonts/Ubuntu-BI.ttf
@@ -191,6 +195,7 @@ files:
 - docgen/resources/images/giblish_logo.svg
 - docgen/resources/themes/giblish.yml
 - docgen/scripts/Jenkinsfile
+- docgen/scripts/gen_adoc_org.sh
 - docgen/scripts/githook_examples/post-update.example
 - docs/setup_server.adoc
 - docs/setup_server_assets/Render Documents.png