asciidoctor-jenkins-extensions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb1de6bbfef89d0eca8d18655598ad6b506579e4
+  data.tar.gz: 048acf1c7f174f52868c244abdc4956e4c36df5c
+SHA512:
+  metadata.gz: d3a2f33d658a5b66bc8de2d39cd47de3d82b5fb99572417fa1f08e9e9e229b2b5076ab00c5f4b86c061e968b4a15b75406a96c2f031cb0899aa9ab8a92afb5f2
+  data.tar.gz: 4dab70e2a1c188b719910b5b2a754e3ce68392b2ca372e0c18ec2a108a83ea34d01ff7289277197cae9b0e2148339e33a29cbf8e63ef683b0d860a22af01422d

data/asciidoctor-jenkins-extensions.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asciidoctor/jenkins/extensions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "asciidoctor-jenkins-extensions"
+  spec.version       = Asciidoctor::Jenkins::Extensions::VERSION
+  spec.authors       = ["R. Tyler Croy"]
+  spec.email         = ["tyler@monkeypox.org"]
+
+  spec.summary       = "a collection of Asciidoctor extensions which enable more advanced
+formatting in Jenkins-related content.
+"
+  spec.description   = "a collection of Asciidoctor extensions which enable more advanced
+formatting in Jenkins-related content.
+"
+  spec.homepage      = 'https://github.com/jenkins-infra/asciidoctor-jenkins-extensions'
+
+
+  root = File.dirname(__FILE__)
+  spec.files         = Dir.glob("#{root}/lib/**/*.rb").map { |f| f.gsub("#{root}/", '') }
+  spec.files         << File.basename(__FILE__)
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+
+  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 "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'ci_reporter', '~> 2.0'
+  spec.add_development_dependency 'ci_reporter_rspec', '~> 1.0'
+end

data/lib/asciidoctor/jenkins/extensions.rb

@@ -0,0 +1,10 @@
+module Asciidoctor
+  module Jenkins
+    module Extensions
+    end
+  end
+end
+
+Dir.glob("#{File.dirname(__FILE__)}/extensions/**/*.rb").each do |f|
+  require f
+end

data/lib/asciidoctor/jenkins/extensions/pipeline-block.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby
+
+require 'colorize'
+require 'asciidoctor/extensions'
+require 'coderay'
+
+Asciidoctor::Extensions.register do
+  block do
+    named :pipeline
+    on_context :listing
+    name_positional_attributes 'format'
+
+    process do |parent, reader, attrs|
+      format = (attrs.delete('format') || '')
+      codelines = reader.lines()
+      script = nil
+      declarative = nil
+
+      # Find where our "// Script" comment is for highlighting the Pipeline
+      # Script syntax
+      script_index = codelines.find_index { |c| c.match(/\/\/ (script)(.*)?\/\//i) } || -1
+      decl_index = codelines.find_index { |c| c.match(/\/\/ (declarative)(.*)?\/\//i) } || -1
+
+      # It would be great to re-use the [source] block styling, but it turns
+      # out that our parser is going to delete WHATEVER style attribute we
+      # would give the block if we used #create_listing_block()
+      #
+      # Ouch: <https://github.com/asciidoctor/asciidoctor/blob/master/lib/asciidoctor/parser.rb#L1086-L1087>
+      snippet = ['<div class="pipeline-block">']
+
+      if decl_index >= 0
+        # Default to reading until the end of codelines
+        last_line = -1
+
+        if script_index > decl_index
+          last_line = script_index - 1
+        end
+        declarative = codelines[(decl_index + 1) .. last_line].join("\n").chomp
+
+        # If the declarative block is empty, we should just pretend it doesn't
+        # exist. This is helpful for making notes/todos where Declarative isn't
+        # applicable
+        if declarative.empty?
+          declarative = nil
+        else
+          declarative = CodeRay::Duo[:groovy, :html, {:css => :style}].highlight(declarative)
+          declarative = declarative.gsub(/\/\/ +&lt;(\d+)&gt;/) {
+            m = $~
+            parent.document.callouts.register(m[1])
+            create_inline(parent, :callout, m[1], :id => parent.document.callouts.read_next_id).convert
+          }
+
+          snippet << <<-EOF
+  <div class="listingblock pipeline-declarative">
+    <div class="title">Jenkinsfile (Declarative Pipeline)</div>
+    <div class="content">
+  EOF
+          snippet << <<-EOF
+  <pre class="CodeRay highlight nowrap"><code class="language-groovy" data-lang="groovy">#{declarative}</code></pre>
+  EOF
+          snippet << '</div></div>'
+        end
+      end
+
+      if script_index >= 0
+        # Default to reading until the end of codelines
+        last_line = -1
+
+        # If our decl_index is lower than script_index, that means Declarative
+        # was listed first, so we need to stop short of it
+        if decl_index > script_index
+          last_line = decl_index - 1
+        end
+
+        script = codelines[(script_index + 1) .. last_line].join("\n").chomp
+
+        # If the script block is empty, we should just pretend it doesn't
+        # exist. This is helpful for highlighting blocks where a script example
+        # is yet to be written
+        unless script.empty?
+          # Since we have a declarative block, let's show that by default and
+          # hide this but leave a bread-crumb
+          unless declarative.nil?
+            snippet << <<-EOF
+  <div class="pipeline-script-expand">
+    <a href="#" onclick="javascript:$(this).parent().siblings('.pipeline-script').toggle(); return false;">Toggle Scripted Pipeline</a>
+    <em>(Advanced)</em>
+  </div>
+  EOF
+          end
+
+          script = CodeRay::Duo[:groovy, :html, {:css => :style}].highlight(script)
+          script = script.gsub(/\/\/ +&lt;(\d+)&gt;/) {
+            m = $~
+            parent.document.callouts.register(m[1])
+            create_inline(parent, :callout, m[1], :id => parent.document.callouts.read_next_id).convert
+          }
+
+          snippet << <<-EOF
+  <div class="listingblock pipeline-script"
+        style="display: #{(declarative.nil? or 'none') or 'inherit'}">
+    <div class="title">Jenkinsfile (Scripted Pipeline)</div>
+    <div class="content">
+  EOF
+          snippet << <<-EOF
+  <pre class="CodeRay highlight nowrap"><code class="language-groovy" data-lang="groovy">#{script}</code></pre>
+  EOF
+          snippet << '</div></div>'
+        end
+      end
+
+      snippet << '</div>'
+
+      # Fortunately Awestruct sets a handy docfile attribute so we can print a
+      # useful warning
+      docfile = parent.document.attributes['docfile']
+
+      if script_index < 0
+        $stderr.puts "WARNING: [pipeline] block lacks `// Script //` section in #{docfile}".red
+      end
+
+      if decl_index < 0
+        $stderr.puts "WARNING: [pipeline] block lacks `// Declarative //` section in #{docfile}".red
+      end
+
+      create_pass_block(parent, snippet.join(''), attrs)
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Asciidoctor
+  module Jenkins
+    module Extensions
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-jenkins-extensions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- R. Tyler Croy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-23 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
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter_rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |
+  a collection of Asciidoctor extensions which enable more advanced
+  formatting in Jenkins-related content.
+email:
+- tyler@monkeypox.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- asciidoctor-jenkins-extensions.gemspec
+- lib/asciidoctor/jenkins/extensions.rb
+- lib/asciidoctor/jenkins/extensions/pipeline-block.rb
+- lib/asciidoctor/jenkins/extensions/version.rb
+homepage: https://github.com/jenkins-infra/asciidoctor-jenkins-extensions
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: a collection of Asciidoctor extensions which enable more advanced formatting
+  in Jenkins-related content.
+test_files: []