giblish 0.2.10 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb962b716663c8038be0fd8d1feb776fb9599c3f
-  data.tar.gz: d61b007e06a669d9ab66ec2ad48956d8398e4b88
+  metadata.gz: dd6c3796d788f2eb0766ea43701aa2410077c888
+  data.tar.gz: 10e441b56cfa5086ceb663a4767a9e7e7b2e84e9
 SHA512:
-  metadata.gz: b72b8e142902a804886ea31f2f8b80b03cb258ee685b3814a07088792d7a51ad4c0a09007d1e76463d2f8ba46374e116d136189b617eb06cfabf61cf5ab76ab7
-  data.tar.gz: f1a36cb786567a7e7f0c2d306bce3293888fc041be05e2314d3c49a95237a302a525286a60e7d706f9b1ef4d10e41adde7d4126d6031bbfd8a8e3b29549a4d7a
+  metadata.gz: c02ebe9d9f9722b68b7245b303a9884a46397beb8188d8175b1085033a4c31e81dc013f2885221449e481ae8bc0b13f65fcd2ed1bcf91ba553a321bdcc8c4303
+  data.tar.gz: '000569d7dbdf197b3bfedae58ba99e326ac20e36540f57a2aead9dbe5c458a32a2babf27cef1ce8d8450aa48208f9fe50bc0e632c4223505e8c664b2dcad74ec'

data/data/testdocs/wellformed/source_highlighting/highlight_source.adoc

@@ -0,0 +1,38 @@
+= Simple Source highlighting
+giblish test suite
+
+== Purpose
+
+To check that source code is correctly highlighted when generating docs.
+
+== Examples
+
+
+[source,ruby]
+.A ruby example
+....
+require 'asciidoctor'
+#Some comment
+a = Asciidoctor::load("mydoc.txt")
+....
+
+[source,cs]
+.A C# example
+----
+class MyFancyClass
+{
+  ///
+  /// Documentation goes here...
+  public MyFancyClass()
+  {
+    var x = DoIt();
+  }
+}
+----
+
+[source,bash]
+.A Bash Example
+----
+myVar="${?}"
+git pull ${myVar}
+----

data/giblish.gemspec

@@ -31,13 +31,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 10.0"
 
   # Usage: spec.add_runtime_dependency "[gem name]", [[version]]
-  spec.add_runtime_dependency "git", "~> 1.3"
   spec.add_runtime_dependency "asciidoctor", "~>1.5", ">= 1.5.6.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"
   # needed by asciidoctor-pdf, see instructions at
   # https://github.com/asciidoctor/asciidoctor-pdf/releases
   spec.add_runtime_dependency "prawn-svg", "~> 0.27.1"

data/lib/giblish/buildindex.rb

@@ -22,18 +22,32 @@ class DocInfo
   attr_accessor :doc_id
   attr_accessor :purpose_str
   attr_accessor :status
-  attr_accessor :relPath
-  attr_accessor :srcFile
   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 :relPath
+  attr_accessor :srcFile
+
+  def relPath_utf8
+    return nil if @relPath.nil?
+    @relPath.to_s.encode("utf-8")
+  end
+
+  def srcFile_utf8
+    return nil if @srcFile.nil?
+    @srcFile.to_s.encode("utf-8")
+  end
 
   def initialize
     @history = []
   end
 
   def to_s
-    "DocInfo: title: #{@title} srcFile: #{@srcFile}"
+    "DocInfo: title: #{@title} srcFile: #{srcFile_utf8}"
   end
 end
 
@@ -173,8 +187,8 @@ class BasicIndexBuilder
       @nof_missing_titles += 1
       doc_info.title = "NO TITLE FOUND (#{@nof_missing_titles}) !"
     end
-    return "<<#{doc_info.relPath}#,#{doc_info.title}>>",
-    "<<#{Giblish.to_valid_id(doc_info.title)},details>>\n"
+    return "<<#{doc_info.relPath_utf8}#,#{doc_info.title}>>".encode("utf-8"),
+    "<<#{Giblish.to_valid_id(doc_info.title)},details>>\n".encode("utf-8")
   end
 
   # Generate an adoc string that will display as
@@ -206,7 +220,7 @@ class BasicIndexBuilder
       tree_entry_converted prefix_str, d
     else
       # no converted file exists, show what we know
-      "#{prefix_str} FAIL: #{d.srcFile}      <<#{d.srcFile},details>>\n"
+      "#{prefix_str} FAIL: #{d.srcFile_utf8}      <<#{d.srcFile_utf8},details>>\n"
     end
   end
 
@@ -245,11 +259,11 @@ class BasicIndexBuilder
 
   def generate_detail_fail(d)
     <<~FAIL_INFO
-      === #{d.srcFile}
+      === #{d.srcFile_utf8}
 
       Source file::
 
-      #{d.srcFile}
+      #{d.srcFile_utf8}
 
       Error detail::
       #{d.stderr}
@@ -262,15 +276,15 @@ class BasicIndexBuilder
   def generate_detail(d)
     # Generate detail info
     <<~DETAIL_SRC
-      [[#{Giblish.to_valid_id(d.title)}]]
-      === #{d.title}
+      [[#{Giblish.to_valid_id(d.title.encode("utf-8"))}]]
+      === #{d.title.encode("utf-8")}
 
       #{d.purpose_str}
 
       #{generate_conversion_info d}
 
       Source file::
-      #{d.srcFile}
+      #{d.srcFile_utf8}
 
       #{generate_history_info d}
 
@@ -344,20 +358,13 @@ class GitRepoIndexBuilder < BasicIndexBuilder
     # Get the commit history of the doc
     # (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|
+    gi.file_log(info.srcFile_utf8).each do |i|
       h = DocInfo::DocHistory.new
       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

@@ -25,6 +25,13 @@ class DocConverter
     mkdirs: true
   }.freeze
 
+  # the giblish attribute defaults used if nothing else
+  # is required by the user
+  DEFAULT_ATTRIBUTES = {
+    "source-highlighter" => "rouge",
+    "xrefstyle" => "short"
+  }.freeze
+
   # setup common options that are used regardless of the
   # specific output format used
   attr_reader :converter_options
@@ -40,6 +47,7 @@ class DocConverter
 
     @user_style = options[:userStyle]
     @converter_options = COMMON_CONVERTER_OPTS.dup
+    @converter_options[:attributes] = DEFAULT_ATTRIBUTES.dup
     @converter_options[:backend] = options[:backend]
   end
 
@@ -111,7 +119,8 @@ class DocConverter
   #                   that the derived class supports
   def add_backend_options(backend_opts, backend_attribs)
     @converter_options = @converter_options.merge(backend_opts)
-    @converter_options[:attributes] = backend_attribs
+    @converter_options[:attributes] =
+      @converter_options[:attributes].merge(backend_attribs)
   end
 end
 
@@ -124,6 +133,9 @@ class HtmlConverter < DocConverter
   def initialize(options)
     super options
 
+    # require access to asciidoc-rouge
+    require "asciidoctor-rouge"
+
     # handle needed assets for the styling (css et al)
     html_attrib = setup_web_assets options[:webRoot]
 
@@ -151,7 +163,7 @@ class HtmlConverter < DocConverter
     @user_style &&
       attrib["stylesheet"] =
         /\.(css|CSS)$/ =~ @user_style ? @user_style : "#{@user_style}.css"
-
+    Giblog.logger.debug {"stylesheet attributes: #{attrib}"}
     attrib
   end
 

data/lib/giblish/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: giblish
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
 platform: ruby
 authors:
 - Anders Rillbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2018-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: git
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
+        version: '10.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +86,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0.alpha.16
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: prawn-svg
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,7 @@ files:
 - data/testdocs/wellformed/docidtest/docid_1.adoc
 - data/testdocs/wellformed/docidtest/docid_2.adoc
 - data/testdocs/wellformed/simple.adoc
+- data/testdocs/wellformed/source_highlighting/highlight_source.adoc
 - exe/giblish
 - giblish.gemspec
 - lib/giblish.rb
@@ -177,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A tool for publishing asciidoc docs stored in git repos