giblish 0.2.12 → 0.3.0

data/lib/giblish/docinfo.rb

@@ -0,0 +1,85 @@
+require "pathname"
+
+module Giblish
+  # Container class for bundling together the data we cache for
+  # each asciidoc file we come across
+  class DocInfo
+    # Cache git info
+    class DocHistory
+      attr_accessor :date
+      attr_accessor :author
+      attr_accessor :message
+    end
+
+    attr_accessor :converted
+    attr_accessor :title
+    attr_accessor :doc_id
+    attr_accessor :purpose_str
+    attr_accessor :status
+    attr_accessor :history
+    attr_accessor :error_msg
+    attr_accessor :stderr
+    # these two members can have encoding issues when
+    # running in a mixed Windows/Linux setting.
+    # that is why the explicit utf-8 read methods are
+    # provided.
+    attr_accessor :rel_path
+    attr_accessor :src_file
+
+    def relPath_utf8
+      return nil if @rel_path.nil?
+      @rel_path.to_s.encode("utf-8")
+    end
+
+    def srcFile_utf8
+      return nil if @src_file.nil?
+      @src_file.to_s.encode("utf-8")
+    end
+
+    def initialize(adoc: nil, dst_root_abs: nil, adoc_stderr: "")
+      @src_file = nil
+      @history = []
+      @converted = true
+      @stderr = adoc_stderr
+      return unless adoc
+
+      # Get the purpose info if it exists
+      @purpose_str = get_purpose_info adoc
+
+      # fill in doc meta data
+      d_attr = adoc.attributes
+      @doc_id = d_attr["docid"]
+      @src_file = d_attr["docfile"]
+      @title = adoc.doctitle
+      return if dst_root_abs.nil?
+
+      # Get the relative path beneath the root dir to the doc
+      @rel_path = Pathname.new(
+          "#{d_attr['outdir']}/#{d_attr['docname']}#{d_attr['docfilesuffix']}"
+      ).relative_path_from(dst_root_abs)
+    end
+
+    def to_s
+      "DocInfo: title: #{@title} src_file: #{@src_file}"
+    end
+
+    private
+
+    def get_purpose_info(adoc)
+      # Get the 'Purpose' section if it exists
+      purpose_str = ""
+      adoc.blocks.each do |section|
+        next unless section.is_a?(Asciidoctor::Section) &&
+            (section.level == 1) &&
+            (section.name =~ /^Purpose$/)
+
+        # 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"
+        end
+      end
+      purpose_str
+    end
+  end
+end

data/lib/giblish/gititf.rb

@@ -74,6 +74,7 @@ module Giblish
         end
       end
       hsh_array << hsh if hsh
+      hsh_array
     end
 
     # Execute engine for git commands,

data/lib/giblish/utils.rb

@@ -6,8 +6,8 @@ class Giblog
   def self.setup
     return if defined? @logger
     @logger = Logger.new(STDOUT)
-    @logger.formatter = proc do |_severity, datetime, _progname, msg|
-      "#{datetime.strftime('%H:%M:%S')} - #{msg}\n"
+    @logger.formatter = proc do |severity, datetime, _progname, msg|
+      "#{datetime.strftime('%H:%M:%S')} #{severity} - #{msg}\n"
     end
   end
 
@@ -41,14 +41,16 @@ module Giblish
     def initialize(src_root, dst_root, resource_dir = nil)
       # 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
+      # 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
 
+    def dst_root_abs=(dst_root)
       # Make sure that the destination root exists and expand it to an
       # absolute path
       Pathname.new(dst_root).mkpath
       @dst_root_abs = Pathname.new(dst_root).realpath
-
-      # 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
 
     # Public: Get the relative path from the source root dir to the
@@ -150,6 +152,8 @@ module Giblish
     end
   end
 
+  # runs the supplied block but redirect stderr to a string
+  # returns the string containing stderr contents
   def with_captured_stderr
     old_stderr = $stderr
     $stderr = StringIO.new("", "w")
@@ -160,9 +164,29 @@ module Giblish
   end
   module_function :with_captured_stderr
 
+  # transforms strings to valid asciidoctor id strings
   def to_valid_id(input_str)
     id_str = "_#{input_str.downcase}"
     id_str.gsub(%r{[^a-z0-9]+},"_")
   end
   module_function :to_valid_id
+
+  # See https://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
+  # Cross-platform way of finding an executable in the $PATH.
+  #
+  # 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|
+        exe = File.join(path, "#{cmd}#{ext}")
+        return exe if File.executable?(exe) && !File.directory?(exe)
+      }
+    end
+    return nil
+  end
+  module_function :which
+
+
 end

data/lib/giblish/version.rb

@@ -1,3 +1,3 @@
 module Giblish
-  VERSION = "0.2.12".freeze
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: giblish
 version: !ruby/object:Gem::Version
-  version: 0.2.12
+  version: 0.3.0
 platform: ruby
 authors:
 - Anders Rillbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-30 00:00:00.000000000 Z
+date: 2018-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.7.1
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-diagram
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: asciidoctor-pdf
   requirement: !ruby/object:Gem::Requirement
@@ -138,6 +152,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -156,10 +171,13 @@ files:
 - giblish.gemspec
 - lib/giblish.rb
 - lib/giblish/application.rb
+- lib/giblish/buildgraph.rb
 - lib/giblish/buildindex.rb
 - lib/giblish/cmdline.rb
 - lib/giblish/core.rb
+- lib/giblish/docconverter.rb
 - lib/giblish/docid.rb
+- lib/giblish/docinfo.rb
 - lib/giblish/gititf.rb
 - lib/giblish/pathtree.rb
 - lib/giblish/utils.rb
@@ -193,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A tool for publishing asciidoc docs stored in git repos