asciidoctor-jenkins-extensions 0.3.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 445dba7fb8b6ae1688eee6fb08904a6e71106468
-  data.tar.gz: f8d07573f5a00e002a5adcd31fe31f3326e5e3f5
+SHA256:
+  metadata.gz: 8dbfccac22053bd1cce012851bf735a6a1d4e9312dcf56dcf622c4e5d6899491
+  data.tar.gz: 1606be519f9a6975d93e27ac3ab94eeaa7e39e7c4f2c28c09c7e59058950f3ba
 SHA512:
-  metadata.gz: 242d37614b4d6e1fa684e28b68bee6a4864f51983e33f5800101f503203223fd80077206dc3f704f1b3e512bd75a30ba4b5ab003cef79283f094adaf492cae83
-  data.tar.gz: ae66144435ae33aa3d617a276158e1f3a87363c8384b7bf61e85a98991ea595da0e17b62ee3abafb0241d20f628f477729caeddbc578ba268014f494a90c0226
+  metadata.gz: 3810c5eccd7c9ed188656e93f572e87ea55f904f84f3744367b1f5881bb0e843800bfc47538fe55e3a7ff5598625daaae756dee14d61e82446c2caff32101802
+  data.tar.gz: db6b264e816e904c6f596e1db293f2eec89478581cbb439c408fc5e4c6454f39ca913f8c775750adcfdace0b04e585ddec8158610a649838ab3579dda45b9052

data/asciidoctor-jenkins-extensions.gemspec

@@ -26,11 +26,11 @@ formatting in Jenkins-related content.
   spec.require_paths = ["lib"]
 
 
-  spec.add_dependency 'asciidoctor', '~> 1.5.5'
+  spec.add_dependency 'asciidoctor', '>= 1.5.5'
   spec.add_dependency 'coderay', '~> 1.1.1'
   spec.add_dependency 'colorize', '~> 0.8.1'
 
-  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-its"

data/lib/asciidoctor/jenkins/extensions/author-link.rb

@@ -0,0 +1,24 @@
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+
+#
+# Usage:
+# author:timja[Tim Jacomb]
+# author:timja[]
+#
+Asciidoctor::Extensions.register do
+  inline_macro do
+    named :author
+    name_positional_attributes 'label'
+
+    process do |parent, target, attrs|
+      if attrs['label']
+        label = %(#{attrs['label']})
+      else
+        label = %(#{target})
+      end
+      target = %(/blog/authors/#{target})
+      (create_anchor parent, label, type: :link, target: target).render
+    end
+  end
+end

data/lib/asciidoctor/jenkins/extensions/javadoc-link.rb

@@ -20,6 +20,14 @@ require 'asciidoctor/extensions'
 # jenkinsdoc:git:hudson.plugins.git.GitSCM[some label]
 # jenkinsdoc:git:hudson.plugins.git.GitSCM#anchor[]
 # jenkinsdoc:git:hudson.plugins.git.GitSCM#anchor[some label]
+#
+#
+# For component Javadoc:
+#
+# jenkinsdoc:component:remoting:hudson.remoting.Channel[]
+# jenkinsdoc:component:remoting:hudson.remoting.Channel[some label]
+# jenkinsdoc:component:remoting:hudson.remoting.Channel#anchor[]
+# jenkinsdoc:component:remoting:hudson.remoting.Channel#anchor[some label]
 
 Asciidoctor::Extensions.register do
   inline_macro do
@@ -29,8 +37,13 @@ Asciidoctor::Extensions.register do
     process do |parent, target, attrs|
 
       if target.include? ":"
-        parts = target.split(':', 2)
-        plugin = parts.first
+        parts = target.split(':', 3)
+
+        if parts.first == "component"
+          component = parts[1]
+        else
+          plugin = parts.first
+        end
         target = parts.last
       end
       classname = label = title = target
@@ -43,6 +56,13 @@ Asciidoctor::Extensions.register do
       classname.split('.').each do |part|
         if is_package && /[[:lower:]]/.match(part[0])
           package_parts.push(part)
+        elsif match = /(.*)#/.match(part)
+          class_part = match.captures
+          simpleclass_parts.push(class_part)
+          is_package = false
+
+          # escape once fragment has been found, required for complex fragments that contain a '.'
+          break
         else
           is_package = false
           simpleclass_parts.push(part)
@@ -52,22 +72,25 @@ Asciidoctor::Extensions.register do
       package = package_parts.join('.')
       simpleclass = simpleclass_parts.join('.')
 
-      if package.length > 0 || plugin
+      if package.length > 0 || plugin || component
         classname = classname.gsub(/#.*/, '')
         classurl = package.gsub(/\./, '/') + '/' + simpleclass + ".html"
 
-        classfrag = (target.include? "#") ? '#' + target.gsub(/.*#/, '') : ''
+        classfrag = (target.include? "#") ? '#' + target.gsub(/.*#/, '').gsub(/\(\)/, '--') : ''
 
         if plugin
           label = (attrs.has_key? 'label') ? attrs['label'] : %(#{classname} in #{plugin})
-          target = %(http://javadoc.jenkins.io/plugin/#{plugin}/#{classurl}#{classfrag})
+          target = %(https://javadoc.jenkins.io/plugin/#{plugin}/#{classurl}#{classfrag})
+        elsif component
+          label = (attrs.has_key? 'label') ? attrs['label'] : %(#{classname} in #{component})
+          target = %(https://javadoc.jenkins.io/component/#{component}/#{classurl}#{classfrag})
         else
           label = (attrs.has_key? 'label') ? attrs['label'] : classname
-          target = %(http://javadoc.jenkins.io/#{classurl}#{classfrag})
+          target = %(https://javadoc.jenkins.io/#{classurl}#{classfrag})
         end
       else
         label = (attrs.has_key? 'label') ? attrs['label'] : classname
-        target = %(http://javadoc.jenkins.io/byShortName/#{classname})
+        target = %(https://javadoc.jenkins.io/byShortName/#{classname})
       end
 
       title = %(Javadoc for #{classname})
@@ -84,12 +107,39 @@ Asciidoctor::Extensions.register do
 
     process do |parent, target, attrs|
 
+      classname = target
+
+      package_parts = Array.new
+      simpleclass_parts = Array.new
+
+      is_package = true
+
+      classname.split('.').each do |part|
+        match = /(.*)#/.match(part)
+        if is_package && /[[:lower:]]/.match(part[0])
+          package_parts.push(part)
+        elsif match = /(.*)#/.match(part)
+          class_part = match.captures
+          simpleclass_parts.push(class_part)
+          is_package = false
+
+          # escape once fragment has been found, required for complex fragments that contain a '.'
+          break
+        else
+          is_package = false
+          simpleclass_parts.push(part)
+        end
+      end
+
+      package = package_parts.join('.')
+      simpleclass = simpleclass_parts.join('.')
+
       classname = target.gsub(/#.*/, '')
-      classurl = classname.gsub(/\./, '/') + ".html"
+      classurl = package.gsub(/\./, '/') + '/' + simpleclass + ".html"
 
-      classfrag = (target.include? "#") ? '#' + target.gsub(/.*#/, '') : ''
+      classfrag = (target.include? "#") ? '#' + target.gsub(/.*#/, '').gsub(/\(\)/, '--') : ''
       label = (attrs.has_key? 'label') ? attrs['label'] : classname
-      target = %(http://stapler.kohsuke.org/apidocs/#{classurl}#{classfrag})
+      target = %(https://stapler.kohsuke.org/apidocs/#{classurl}#{classfrag})
 
       title = %(Javadoc for #{classname})
 
@@ -106,12 +156,38 @@ Asciidoctor::Extensions.register do
 
     process do |parent, target, attrs|
 
+      classname = target
+
+      package_parts = Array.new
+      simpleclass_parts = Array.new
+
+      is_package = true
+
+      classname.split('.').each do |part|
+        if is_package && /[[:lower:]]/.match(part[0])
+          package_parts.push(part)
+        elsif match = /(.*)#/.match(part)
+          class_part = match.captures
+          simpleclass_parts.push(class_part)
+          is_package = false
+
+          # escape once fragment has been found, required for complex fragments that contain a '.'
+          break
+        else
+          is_package = false
+          simpleclass_parts.push(part)
+        end
+      end
+
+      package = package_parts.join('.')
+      simpleclass = simpleclass_parts.join('.')
+
       classname = target.gsub(/#.*/, '')
-      classurl = classname.gsub(/\./, '/') + ".html"
+      classurl = package.gsub(/\./, '/') + '/' + simpleclass + ".html"
 
-      classfrag = (target.include? "#") ? '#' + target.gsub(/.*#/, '') : ''
+      classfrag = (target.include? "#") ? '#' + target.gsub(/.*#/, '').gsub(/\(\)/, '--') : ''
       label = (attrs.has_key? 'label') ? attrs['label'] : classname
-      target = %(http://docs.oracle.com/javase/7/docs/api/#{classurl}#{classfrag})
+      target = %(https://docs.oracle.com/javase/8/docs/api/#{classurl}#{classfrag})
 
       title = %(Javadoc for #{classname})
 

data/lib/asciidoctor/jenkins/extensions/jep-link.rb

@@ -0,0 +1,23 @@
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+
+#
+# Usage:
+# jep:201[Jenkins Configuration as Code]
+#
+Asciidoctor::Extensions.register do
+  inline_macro do
+    named :jep
+    name_positional_attributes 'label'
+
+    process do |parent, target, attrs|
+      if attrs['label']
+        label = %(JEP-#{target}: #{attrs['label']})
+      else
+        label = %(JEP-#{target})
+      end
+      target = %(https://github.com/jenkinsci/jep/blob/master/jep/#{target}/README.adoc)
+      (create_anchor parent, label, type: :link, target: target).render
+    end
+  end
+end

data/lib/asciidoctor/jenkins/extensions/jira-link.rb

@@ -0,0 +1,30 @@
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+
+#
+# Usage:
+# jira:JENKINS-12345[Issue description]
+#
+Asciidoctor::Extensions.register do
+  inline_macro do
+    named :jira
+    name_positional_attributes 'label'
+
+    process do |parent, target, attrs|
+      if target.include? "-"
+        issueId = target
+      else
+        issueId = %(JENKINS-#{target})
+      end
+
+      if attrs['label']
+        label = %(#{issueId}: #{attrs['label']})
+      else
+        label = issueId
+      end
+
+      target = %(https://issues.jenkins-ci.org/browse/#{issueId})
+      (create_anchor parent, label, type: :link, target: target).render
+    end
+  end
+end

data/lib/asciidoctor/jenkins/extensions/security-link.rb

@@ -0,0 +1,36 @@
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+
+#
+# Usage:
+# security:12345[Issue description, date]
+#
+Asciidoctor::Extensions.register do
+  inline_macro do
+    named :security
+    name_positional_attributes 'label', 'date'
+
+    process do |parent, target, attrs|
+      if target.include? "-"
+        issueId = target
+      else
+        issueId = %(SECURITY-#{target})
+      end
+
+      if attrs['label']
+        label = %(#{issueId}: #{attrs['label']})
+      else
+        label = issueId
+      end
+
+    if attrs['date']
+        target = %(https://jenkins.io/security/advisory/#{attrs['date']}/##{issueId})
+    else
+        # TODO(oleg_nenashev): Change to a security issue redirect service if it gets created
+        target = %(https://jenkins.io/security/advisories/)
+    end
+
+      (create_anchor parent, label, type: :link, target: target).render
+    end
+  end
+end

data/lib/asciidoctor/jenkins/extensions/version.rb

@@ -1,7 +1,7 @@
 module Asciidoctor
   module Jenkins
     module Extensions
-      VERSION = "0.3.0"
+      VERSION = "0.7.0"
     end
   end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-jenkins-extensions
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.7.0
 platform: ruby
 authors:
 - R. Tyler Croy
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-06-15 00:00:00.000000000 Z
+date: 2020-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.5
 - !ruby/object:Gem::Dependency
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -161,14 +161,18 @@ extra_rdoc_files: []
 files:
 - asciidoctor-jenkins-extensions.gemspec
 - lib/asciidoctor/jenkins/extensions.rb
+- lib/asciidoctor/jenkins/extensions/author-link.rb
 - lib/asciidoctor/jenkins/extensions/javadoc-link.rb
+- lib/asciidoctor/jenkins/extensions/jep-link.rb
+- lib/asciidoctor/jenkins/extensions/jira-link.rb
 - lib/asciidoctor/jenkins/extensions/pipeline-block.rb
 - lib/asciidoctor/jenkins/extensions/plugin-link.rb
+- lib/asciidoctor/jenkins/extensions/security-link.rb
 - lib/asciidoctor/jenkins/extensions/version.rb
 homepage: https://github.com/jenkins-infra/asciidoctor-jenkins-extensions
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -183,9 +187,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: a collection of Asciidoctor extensions which enable more advanced formatting
   in Jenkins-related content.