giblish 0.2.11 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd6c3796d788f2eb0766ea43701aa2410077c888
-  data.tar.gz: 10e441b56cfa5086ceb663a4767a9e7e7b2e84e9
+  metadata.gz: d124070b2a70ba613898e4ec4a55c0077b4721f8
+  data.tar.gz: 9ea41006b11273f084ae4afd2172b0e0ee5c0679
 SHA512:
-  metadata.gz: c02ebe9d9f9722b68b7245b303a9884a46397beb8188d8175b1085033a4c31e81dc013f2885221449e481ae8bc0b13f65fcd2ed1bcf91ba553a321bdcc8c4303
-  data.tar.gz: '000569d7dbdf197b3bfedae58ba99e326ac20e36540f57a2aead9dbe5c458a32a2babf27cef1ce8d8450aa48208f9fe50bc0e632c4223505e8c664b2dcad74ec'
+  metadata.gz: 8c0bbd5e18a496e0405fcc9fb752102bb294d433914e46de814ad3923391b267ec8767711de17dd6258e235f2feb26126f3fc8107b8eb3040215c39a851ffe8f
+  data.tar.gz: 507dc447a1d08255a81c2cf678e3e7e0571be4317da4bc7ab2286da17ac76f93f7f21d0a2aa25eb2304a20f7c68e676cfb42dfa067e43f745a3db725beac520c

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+ - ruby

data/README.adoc

@@ -1,6 +1,8 @@
 = giblish
 Generate docs from asciidoc files in a git repo
 
+image::https://travis-ci.com/rillbert/giblish.svg?branch=master[build status]
+
 == Purpose
 
 giblish is used to convert a source directory tree containing AsciiDoc files to

data/Rakefile

@@ -14,6 +14,12 @@ Rake::TestTask.new(:current_test) do |t|
   # t.test_files = FileList["test/**/docid_test.rb"]
 end
 
+Rake::TestTask.new(:sandbox) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/sandbox_test.rb"]
+end
+
 
 # task :default => :spec
 task :default => :test

data/giblish.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
 
   # Usage: spec.add_runtime_dependency "[gem name]", [[version]]
-  spec.add_runtime_dependency "asciidoctor", "~>1.5", ">= 1.5.6.1"
+  spec.add_runtime_dependency "asciidoctor", "~>1.5", ">= 1.5.7.1"
   spec.add_runtime_dependency "asciidoctor-pdf", [">= 1.5.0.alpha.16"]
   spec.add_runtime_dependency "asciidoctor-rouge", ["~> 0.3"]
   spec.add_runtime_dependency "git", "~> 1.3"

data/lib/giblish/buildindex.rb

@@ -410,6 +410,7 @@ class GitSummaryIndexBuilder
   def initialize(repo)
     @branches = []
     @tags = []
+    @git_repo = repo
     @repo_url = repo.remote.url
   end
 
@@ -472,12 +473,32 @@ class GitSummaryIndexBuilder
     str = <<~TAG_INFO
       == Tags
 
+      |===
+      |Tag |Tag comment |Creator |Tagged commit 
+
     TAG_INFO
 
-    @tags.each do |t|
+    str << @tags.collect do |t|
       dirname = t.name.tr "/", "_"
-      str << " * link:#{dirname}/index.html[#{t.name}]\n"
-    end
+      c = @git_repo.gcommit(t.sha)
+
+      <<~A_ROW
+        |link:#{dirname}/index.html[#{t.name}]
+        |#{t.annotated? ? t.message : "-"}
+        |#{t.annotated? ? t.tagger.name : "-"}
+        |#{t.sha[0,8]}... committed at #{c.author.date}
+      A_ROW
+    end.join("\n")
+
+    str << "|===\n"
+
+    # @tags.each do |t|
+    #   dirname = t.name.tr "/", "_"
+    #   str << " * link:#{dirname}/index.html[#{t.name}]"
+    #   if t.annotated?
+    #     str << "created at #{t.tagger.date} by #{t.tagger.name} with message: #{t.message}"
+    #   end
+    # end
     str
   end
 end

data/lib/giblish/cmdline.rb

@@ -33,6 +33,15 @@ class CmdLineParser
                              For html this is a name of a css file, for pdf, this is
                              the name of an yml file. If no style is given 'giblish'
                              is used as default.
+  -i --include <regexp>      include only files with a filename that matches the supplied
+                             regexp (defaults to '.*\.(?i)adoc$' meaning it matches all
+                             files ending in .adoc case-insensitive). The matching is made
+                             on the _file name only_, not the full path (i.e. for the full 
+                             path /my/file.adoc, only file.adoc is used in the matching).
+  -j --exclude <regexp>      exclude files with filenames matching the supplied 
+                             regexp (no files are excluded by default). The matching is made
+                             on the _file name only_, not the full path (i.e. for the full 
+                             path /my/file.adoc, only file.adoc is used in the matching).
   -w --web-root <path>       Specifies the top dir (DirectoryRoot) of a file system
                              tree published by a web server. This switch is only used
                              when generating html. The typical use case is that giblish
@@ -95,15 +104,15 @@ ENDHELP
   def set_log_level
     log_level = @args[:logLevel] || "warn"
     case log_level
-    when "debug" then Giblog.logger.sev_threshold = Logger::DEBUG
-    when "info"  then Giblog.logger.sev_threshold = Logger::INFO
-    when "warn"  then Giblog.logger.sev_threshold = Logger::WARN
-    when "error" then Giblog.logger.sev_threshold = Logger::ERROR
-    when "fatal" then Giblog.logger.sev_threshold = Logger::FATAL
-    else
-      puts "Invalid log level specified. Run with -h to see supported levels"
-      puts USAGE
-      exit 1
+      when "debug" then Giblog.logger.sev_threshold = Logger::DEBUG
+      when "info"  then Giblog.logger.sev_threshold = Logger::INFO
+      when "warn"  then Giblog.logger.sev_threshold = Logger::WARN
+      when "error" then Giblog.logger.sev_threshold = Logger::ERROR
+      when "fatal" then Giblog.logger.sev_threshold = Logger::FATAL
+      else
+        puts "Invalid log level specified. Run with -h to see supported levels"
+        puts USAGE
+        exit 1
     end
   end
 
@@ -115,15 +124,18 @@ ENDHELP
   def parse_cmdline(cmdline_args)
     # default values for cmd line switches
     @args = {
-      help: false,
-      version: false,
-      force: true,
-      format: "html",
-      flatten: false,
-      suppressBuildRef: false,
-      localRepoOnly: false,
-      resolveDocid: false,
-      webRoot: false
+        help: false,
+        version: false,
+        force: true,
+        format: "html",
+        # note that the single quotes are important for the regexp
+        includeRegexp: '.*\.(?i)adoc$',
+        excludeRegexp: nil,
+        flatten: false,
+        suppressBuildRef: false,
+        localRepoOnly: false,
+        resolveDocid: false,
+        webRoot: false
     }
 
     # set default log level
@@ -136,24 +148,26 @@ ENDHELP
     next_arg = unflagged_args.first
     cmdline_args.each do |arg|
       case arg
-      when "-h", "--help"         then @args[:help]      = true
-      when "-v", "--version"      then @args[:version]   = true
-      when "-f", "--format   "    then next_arg = :format
-      when "-r", "--resource-dir" then next_arg = :resourceDir
-      when "-n", "--no-build-ref" then @args[:suppressBuildRef] = true
-      when "-g", "--git-branches" then next_arg = :gitBranchRegexp
-      when "-t", "--git-tags"     then next_arg = :gitTagRegexp
-      when "-c", "--local-only"   then @args[:localRepoOnly] = true
-      when "-d", "--resolve-docid" then @args[:resolveDocid] = true
-      when "-s", "--style"        then next_arg = :userStyle
-      when "-w", "--web-root"     then next_arg = :webRoot
-      when "--log-level"          then next_arg = :logLevel
-      else
-        if next_arg
-          @args[next_arg] = arg
-          unflagged_args.delete(next_arg)
-        end
-        next_arg = unflagged_args.first
+        when "-h", "--help"         then @args[:help]      = true
+        when "-v", "--version"      then @args[:version]   = true
+        when "-f", "--format   "    then next_arg = :format
+        when "-r", "--resource-dir" then next_arg = :resourceDir
+        when "-n", "--no-build-ref" then @args[:suppressBuildRef] = true
+        when "-i", "--include"      then next_arg = :includeRegexp
+        when "-j", "--exclude"      then next_arg = :excludeRegexp
+        when "-g", "--git-branches" then next_arg = :gitBranchRegexp
+        when "-t", "--git-tags"     then next_arg = :gitTagRegexp
+        when "-c", "--local-only"   then @args[:localRepoOnly] = true
+        when "-d", "--resolve-docid" then @args[:resolveDocid] = true
+        when "-s", "--style"        then next_arg = :userStyle
+        when "-w", "--web-root"     then next_arg = :webRoot
+        when "--log-level"          then next_arg = :logLevel
+        else
+          if next_arg
+            @args[next_arg] = arg
+            unflagged_args.delete(next_arg)
+          end
+          next_arg = unflagged_args.first
       end
     end
   end
@@ -187,7 +201,7 @@ ENDHELP
     # The user wants to parse a git repo, check that the srcDirRoot is within a
     # git repo if the user wants to generate git-branch specific docs
     @args[:gitRepoRoot] = Giblish::PathManager.find_gitrepo_root(
-      @args[:srcDirRoot]
+        @args[:srcDirRoot]
     )
     return unless @args[:gitRepoRoot].nil?
 

data/lib/giblish/core.rb

@@ -330,7 +330,17 @@ class TreeConverter
 
   # predicate that decides if a path is a asciidoc file or not
   def adocfile?(path)
-    path.extname.casecmp(".ADOC").zero? && path.file?
+    fs = path.basename.to_s
+
+    unless @options[:excludeRegexp].nil?
+      # exclude file if user wishes
+      er = Regexp.new @options[:excludeRegexp]
+      return false unless er.match(fs).nil?
+    end
+
+    # only include files
+    ir = Regexp.new @options[:includeRegexp]
+    return !ir.match(fs).nil?
   end
 
   # Register the asciidoctor extension that handles doc ids and traverse

data/lib/giblish/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: giblish
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.12
 platform: ruby
 authors:
 - Anders Rillbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-21 00:00:00.000000000 Z
+date: 2018-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,7 +61,7 @@ dependencies:
         version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.6.1
+        version: 1.5.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,7 +71,7 @@ dependencies:
         version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.6.1
+        version: 1.5.7.1
 - !ruby/object:Gem::Dependency
   name: asciidoctor-pdf
   requirement: !ruby/object:Gem::Requirement
@@ -138,6 +138,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.adoc
@@ -192,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: A tool for publishing asciidoc docs stored in git repos