giblish 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e38f7e5d6b0e752d4a081bab4c3f362a20053888
-  data.tar.gz: 535c89158d9396bf8c8ea1d93fe5be5225701a47
+  metadata.gz: 9ce62a2152e7a0d0f5a9b238503148ea15ab5801
+  data.tar.gz: 91650c824ddc81f807a59730f0daacec2892e154
 SHA512:
-  metadata.gz: d775b989e458b15aab346052f8793108b0ade054acffdc3fc49010feb6ae481b90e728e865763850b3ede4eacbe9c00ef7dbac879cc8bfdf7e1756309358f471
-  data.tar.gz: 5ffccee2062d585e0ef2471fcc430b620c13df2f3ab72bfb794bfc219cc9284883a393b0c7cde5191fd3edc0291d5faf038dfd15b26035faa7549ddd4636176c
+  metadata.gz: 6623e343fcad2aa0c20217c18998825a84a5c20d5216da49629e0e63992a50cfc257cf4c489583e00ec159e9fc9bc129803fd680e543349ce105ae2c25f7ed23
+  data.tar.gz: 38aa18b7a25dad7c91bd43872a5862fd81ff7e9623f9b9fd31f2ff8347b68e7a7b55b2a80d182b796d5839272f34a0d7224fe539a71dc16a1b88e36aaed316f1

data/data/testdocs/wellformed/adorned_purpose.adoc

@@ -0,0 +1,17 @@
+= Testing the 'purpose' section
+:toc:
+:docid: WF-002
+:numbered:
+
+== Purpose
+
+To test how asciidoc formatting in the *_purpose_* section are shown in the index page.
+
+List item::
+Item one
+
+ * Unordered item 1
+ * Unordered item 2
+
+ . Ordered item 1
+ . Ordered item 2

data/giblish.gemspec

@@ -1,7 +1,9 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'giblish/version'
+
+require "giblish/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "giblish"
@@ -9,10 +11,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Anders Rillbert"]
   spec.email         = ["anders.rillbert@kutso.se"]
 
-  spec.summary       = %q{A tool for publishing asciidoc docs stored in git repos}
-  spec.description   = %q{A tool for publishing asciidoc docs stored in git repos}
-  spec.homepage      = "http://www.example.com"
+  spec.summary       = "A tool for publishing asciidoc docs stored in git repos"
+  spec.description   = "A tool for publishing asciidoc docs stored in git repos"
+  spec.homepage      = "https://github.com/rillbert/giblish"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.3"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.

data/lib/giblish/buildindex.rb

@@ -5,6 +5,7 @@ require "pathname"
 require "git"
 require_relative "cmdline"
 require_relative "pathtree"
+require_relative "gititf"
 
 # Container class for bundling together the data we cache for
 # each asciidoc file we come across
@@ -39,11 +40,12 @@ end
 # Base class with common functionality for all index builders
 class BasicIndexBuilder
   # set up the basic index building info
-  def initialize(path_manager)
+  def initialize(path_manager, handle_docid = false)
     @paths = path_manager
     @nof_missing_titles = 0
     @added_docs = []
     @src_str = ""
+    @manage_docid = handle_docid
   end
 
   # creates a DocInfo instance, fills it with basic info and
@@ -57,9 +59,6 @@ class BasicIndexBuilder
     info.converted = true
     info.stderr = adoc_stderr
 
-    # Get the doc id if it exists
-    info.doc_id = adoc.attributes["docid"]
-
     # Get the purpose info if it exists
     info.purpose_str = get_purpose_info adoc
 
@@ -71,9 +70,19 @@ class BasicIndexBuilder
       @paths.dst_root_abs
     )
 
-    # Get the source file path and title
+    # Get the doc id if it exists
+    info.doc_id = adoc.attributes["docid"]
+
+    # Get the source file path
     info.srcFile = adoc.attributes["docfile"]
-    info.title = adoc.doctitle
+
+    # If a docid exists, set titel to docid - title if we care about
+    # doc ids.
+    info.title = if !info.doc_id.nil? && @manage_docid
+                   "#{info.doc_id} - #{adoc.doctitle}"
+                 else
+                   adoc.doctitle
+                 end
 
     # Cache the created DocInfo
     @added_docs << info
@@ -131,6 +140,8 @@ class BasicIndexBuilder
                   (section.level == 1) &&
                   (section.name =~ /^Purpose$/)
       purpose_str = "Purpose::\n\n"
+
+      # filter out 'odd' text, such as lists etc...
       section.blocks.each do |bb|
         next unless bb.is_a?(Asciidoctor::Block)
         purpose_str << "#{bb.source}\n+\n"
@@ -294,8 +305,8 @@ end
 
 # A simple index generator that shows a table with the generated documents
 class SimpleIndexBuilder < BasicIndexBuilder
-  def initialize(path_manager)
-    super path_manager
+  def initialize(path_manager, manage_docid = false)
+    super path_manager, manage_docid
   end
 
   def add_doc(adoc, adoc_stderr)
@@ -306,8 +317,8 @@ end
 # Builds an index of the generated documents and includes some git metadata
 # repository
 class GitRepoIndexBuilder < BasicIndexBuilder
-  def initialize(path_manager, git_repo_root)
-    super path_manager
+  def initialize(path_manager, manage_docid, git_repo_root)
+    super path_manager, manage_docid
 
     # initialize state variables
     @git_repo_root = git_repo_root
@@ -331,13 +342,22 @@ class GitRepoIndexBuilder < BasicIndexBuilder
     info.srcFile = Pathname.new(info.srcFile).relative_path_from(@git_repo_root).to_s
 
     # Get the commit history of the doc
-    @git_repo.log(50).object("*#{info.srcFile}").each do |l|
+    # (use a homegrown git log to get 'follow' flag)
+    gi = Giblish::GitItf.new(@git_repo_root)
+    gi.file_log(info.srcFile.to_s).each do |i|
       h = DocInfo::DocHistory.new
-      h.date = l.date
-      h.message = l.message
-      h.author = l.author.name
+      h.date = i["date"]
+      h.message = i["message"]
+      h.author = i["author"]
       info.history << h
     end
+    # @git_repo.log(50).object("*#{info.srcFile}").each do |l|
+    #   h = DocInfo::DocHistory.new
+    #   h.date = l.date
+    #   h.message = l.message
+    #   h.author = l.author.name
+    #   info.history << h
+    # end
   end
 
   protected

data/lib/giblish/core.rb

@@ -93,6 +93,7 @@ class DocConverter
 
     Giblog.logger.debug { "converter_options: #{@converter_options}" }
     # do the actual conversion
+
     Asciidoctor.convert_file filepath, @converter_options
   end
 
@@ -236,9 +237,12 @@ class TreeConverter
     # prepare the index page if requested
     unless @options[:suppressBuildRef]
       @index_builder = if @options[:gitRepoRoot]
-                         GitRepoIndexBuilder.new(@paths, options[:gitRepoRoot])
+                         GitRepoIndexBuilder.new(@paths,
+                                                 options[:resolveDocid],
+                                                 options[:gitRepoRoot])
                        else
-                         SimpleIndexBuilder.new(@paths)
+                         SimpleIndexBuilder.new(@paths,
+                                                options[:resolveDocid])
                        end
     end
 
@@ -288,8 +292,9 @@ class TreeConverter
   end
 
   def walk_dirs
-    # pass 1: collect all found doc ids if user wishes
-    collect_doc_ids if @options[:resolveDocid]
+    # collect all doc ids and enable replacement of known doc ids with
+    # valid references to adoc files
+    manage_doc_ids if @options[:resolveDocid]
 
     # traverse the src file tree and convert all files that ends with
     # .adoc or .ADOC
@@ -311,11 +316,15 @@ class TreeConverter
 
   private
 
+  # predicate that decides if a path is a asciidoc file or not
   def adocfile?(path)
-    path.extname.casecmp(".ADOC").zero?
+    path.extname.casecmp(".ADOC").zero? && path.file?
   end
 
-  def collect_doc_ids
+  # Register the asciidoctor extension that handles doc ids and traverse
+  # the source tree to collect all :docid: attributes found in document
+  # headers.
+  def manage_doc_ids
     # Register the docid preprocessor hook
     Giblish.register_extensions
 
@@ -331,7 +340,6 @@ class TreeConverter
     end
     idc
   end
-
 end
 
 class GitRepoParser

data/lib/giblish/gititf.rb

@@ -0,0 +1,92 @@
+require "open3"
+require_relative "utils"
+
+module Giblish
+  # A home-grown interface class to git. Used for situations when the
+  # 'official' ruby git gem does not support an operation that is needed.
+  class GitItf
+    attr_reader :repo_root
+    attr_reader :git_dir
+
+    def initialize(path)
+      @repo_root = Giblish::PathManager.find_gitrepo_root(path)
+      if @repo_root.nil?
+        raise ArgumentError("The path: @{path} is not within a git repo!")
+      end
+      @git_dir = @repo_root + ".git"
+    end
+
+    # Get the log history of the supplied file as an array of
+    # hashes, each entry has keys:
+    # sha
+    # date
+    # author
+    # email
+    # parent
+    # message
+    def file_log(filename)
+      o, e, s = exec_cmd("log", %w[--follow --date=iso --], filename)
+      raise "Failed to get git log for #{filename}!!\n#{e}" if s.exitstatus != 0
+
+      process_log_output(o)
+    end
+
+    private
+
+    # Process the log output from git
+    # (This is copied to 90% from the ruby-git gem)
+    def process_log_output(output)
+      in_message = false
+      hsh_array = []
+      hsh = nil
+
+      output.each_line do |line|
+        line = line.chomp
+
+        if line[0].nil?
+          in_message = !in_message
+          next
+        end
+
+        if in_message
+          hsh["message"] << "#{line[4..-1]}\n"
+          next
+        end
+
+        key, *value = line.split
+        key = key.sub(":", "").downcase
+        value = value.join(" ")
+
+        case key
+        when "commit"
+          hsh_array << hsh if hsh
+          hsh = { "sha" => value, "message" => "", "parent" => [] }
+        when "parent"
+          hsh["parent"] << value
+        when "author"
+          tmp = value.split("<")
+          hsh["author"] = tmp[0].strip
+          hsh["email"] = tmp[1].sub(">", "").strip
+        when "date"
+          hsh["date"] = DateTime.parse(value)
+        else
+          hsh[key] = value
+        end
+      end
+      hsh_array << hsh if hsh
+    end
+
+    # Execute engine for git commands,
+    # Returns same as capture3 (stdout, stderr, Process.Status)
+    def exec_cmd(cmd, flags, args)
+      # always add the git dir to the cmd to ensure that git is executed
+      # within the expected repo
+      gd_flag = "--git-dir=#{@git_dir}"
+      wt_flag = "--work-tree=#{@repo_root}"
+      flag_str = flags.join(" ")
+      git_cmd = "git #{gd_flag} #{wt_flag} #{cmd} #{flag_str} #{args}"
+      Giblog.debug { "running: #{git_cmd}" }
+      Open3.capture3(git_cmd.to_s)
+    end
+  end
+end

data/lib/giblish/utils.rb

@@ -130,7 +130,7 @@ module Giblish
       if sr.exist?
         sr.directory? ? sr.realpath : sr.dirname.realpath
       else
-        sr.ascend.expand_path
+        sr.parent.expand_path
       end
     end
 
@@ -151,12 +151,12 @@ module Giblish
   end
 
   def with_captured_stderr
-    old_stdout = $stderr
+    old_stderr = $stderr
     $stderr = StringIO.new("", "w")
     yield
     $stderr.string
   ensure
-    $stderr = old_stdout
+    $stderr = old_stderr
   end
   module_function :with_captured_stderr
 

data/lib/giblish/version.rb

@@ -1,3 +1,3 @@
 module Giblish
-  VERSION = "0.2.7"
+  VERSION = "0.2.8".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: giblish
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Anders Rillbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,7 @@ files:
 - bin/setup
 - data/testdocs/malformed/no_header.adoc
 - data/testdocs/toplevel.adoc
+- data/testdocs/wellformed/adorned_purpose.adoc
 - data/testdocs/wellformed/docidtest/docid_1.adoc
 - data/testdocs/wellformed/docidtest/docid_2.adoc
 - data/testdocs/wellformed/simple.adoc
@@ -143,6 +144,7 @@ files:
 - lib/giblish/cmdline.rb
 - lib/giblish/core.rb
 - lib/giblish/docid.rb
+- lib/giblish/gititf.rb
 - lib/giblish/pathtree.rb
 - lib/giblish/utils.rb
 - lib/giblish/version.rb
@@ -155,7 +157,7 @@ files:
 - resources/images/giblish_logo.png
 - resources/images/giblish_logo.svg
 - resources/themes/giblish.yml
-homepage: http://www.example.com
+homepage: https://github.com/rillbert/giblish
 licenses:
 - MIT
 metadata: {}
@@ -167,7 +169,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="