neo4j-asciidoctor-extensions 0.0.3 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4a76564a648f37550de81012dd17b91d488e8791f217d5523c9d8f00b94f58a
-  data.tar.gz: cdb7b4e3c6e65ead430cdd7ef856ff8ec7257533f049460026c371bd7d6b5255
+  metadata.gz: caa3438245e79418824486f4b9eafe839bc450db9f5982dd85d4891d2cf23a97
+  data.tar.gz: 65cb62e0c737990e153621812c282e114d18520b94745349f5b7e31625445bc7
 SHA512:
-  metadata.gz: b8a83d07d04b37725b688e3b487b25ac96c5047fdbe29ab1222c6299347f0bf5c50f0da3820882aa09369aee708ffbd16d518ee858722cc5c4abecfbdaec9bbd
-  data.tar.gz: 61d3c1b09eb8c820200d143e805801e06e4257ebb6dc0a9b10545e53fe2df3ebd4d6c3a26789b245613bd783bbbbd5c65be104bc75cc7d75f76b5a542f028e3f
+  metadata.gz: 4aa57024bb9de75ae6d5b8a4ddffe4eab1b127479555d5da916625a6bc240739bfe126faf3c273beb6ab815669b8a5a6bd0530be2da4a7ca272492360e45345c
+  data.tar.gz: ce4dd22de8ba94d0d2cf5297ef02b7402d1e0efcd1f64b24e077153989968eb5eedc51610fb5b646fe20a50305141c18de4fc858c3456925045b8fe354eaa32c

data/.github/workflows/release.yml

@@ -0,0 +1,33 @@
+---
+name: Release
+on:
+  push:
+    tags:
+      - v*
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+      - name: Install and test
+        run: |
+          bundle install
+          bundle exec rake
+      - name: Configure credentials
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}" > $HOME/.gem/credentials
+        env:
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+      - name: Build gem
+        run: |
+          bundle exec rake build
+      - name: Publish to rubygems.org
+        run: |
+          gem push pkg/neo4j-asciidoctor-extensions-${GITHUB_REF#refs/tags/v}.gem
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    neo4j-asciidoctor-extensions (0.0.3)
+    neo4j-asciidoctor-extensions (0.1.2)
       asciidoctor (~> 2.0.0)
       asciidoctor-pdf (= 1.5.3)
       rouge (~> 3.18.0)

data/README.adoc

@@ -1,4 +1,5 @@
 = Neo4j Asciidoctor Extensions
+:caution-caption: :fire:
 :uri-neo4j: https://neo4j.com
 
 image:https://github.com/neo4j-contrib/neo4j-asciidoctor-extensions/workflows/CI/badge.svg[CI,link=https://github.com/neo4j-contrib/neo4j-asciidoctor-extensions/actions?query=workflow%3ACI]
@@ -41,15 +42,30 @@ See below for the complete list of extensions.
 
 The Ruby gem contains 6 distinct extensions:
 
-=== `course_document_attributes`
+=== Neo4j course attributes
 
-A postprocessor that adds attributes about the course.
+A postprocessor that adds attributes about a course on the `Document`.
 
-=== `cypher_syntax_role`
+[CAUTION]
+====
+This extension is tightly coupled to the course publishing project and should not be used for other purposes
+====
+
+[source,rb]
+----
+require 'neo4j/asciidoctor/extensions/course_document_attributes'
+----
+
+=== Cypher syntax role
 
 A tree processor that adds a role on code blocks using "cypher-syntax" as a language.
 
-*Usage:*
+==== Usage
+
+[source,rb]
+----
+require 'neo4j/asciidoctor/extensions/cypher_syntax_role'
+----
 
 [source]
 ....
@@ -62,11 +78,16 @@ A tree processor that adds a role on code blocks using "cypher-syntax" as a lang
 ----
 ....
 
-=== `document_metadata_generator`
+=== Metadata generator (YAML)
 
 A postprocess that generates a metadata file (in YAML format) from a list of document attributes.
 
-*Usage:*
+==== Usage
+
+[source,rb]
+----
+require 'neo4j/asciidoctor/extensions/document_metadata_generator'
+----
 
 .file.adoc
 [source,adoc]
@@ -79,7 +100,7 @@ A postprocess that generates a metadata file (in YAML format) from a list of doc
 ----
 
 .file.yml
-[source,adoc]
+[source,yaml]
 ----
 slug: intro-neo4j-4-0
 parent_path: /intro
@@ -104,12 +125,17 @@ taxonomies:
       - 3-6
 ----
 
-=== `inline_highlighter_rouge`
+=== Inline syntax highlighter based on Rouge
 
 Inline syntax highlighter based on Rouge.
 It applies syntax highlighting on both monospaced text cypher and `src` inline macro:
 
-*Usage:*
+==== Usage
+
+[source,rb]
+----
+require 'neo4j/asciidoctor/extensions/inline_highlighter_rouge'
+----
 
 [source,adoc]
 ----
@@ -118,16 +144,29 @@ It applies syntax highlighting on both monospaced text cypher and `src` inline m
 src:cypher[MATCH (c:Customer {customerName: 'ABCCO'}) RETURN c.BOUGHT.productName]
 ----
 
-=== `revealjs_linear_navigation`
+=== Linear navigation for reveal.js
 
 A tree process that "flatten" a reveal.js presentation to use a linear navigation.
 By default, the reveal.js converter will use a vertical navigation for the second levels of section titles (and below).
 This extension will effectively prevent that by using only first level section titles.
 
-=== `revealjs_speaker_notes_aggregator`
+==== Usage
+
+[source,rb]
+----
+require 'neo4j/asciidoctor/extensions/revealjs_linear_navigation'
+----
+
+=== Notes aggregator for reveal.js
+
 A tree processor that aggregates multiple `[.notes]` blocks in a section (slide).
 
-*Usage:*
+==== Usage
+
+[source,rb]
+----
+require 'neo4j/asciidoctor/extensions/revealjs_speaker_notes_aggregator'
+----
 
 [source,adoc]
 ----
@@ -145,3 +184,48 @@ Hello!
 This is another speaker note.
 --
 ----
+
+=== Document attribute update
+
+A tree processor that update an attribute depending on a given rule.
+
+==== Usage
+
+In the example below, we update the value of the `slug` attribute depending on the `stage` attribute:
+[source,rb]
+----
+require 'asciidoctor/extensions'
+require 'neo4j/asciidoctor/extensions/attribute_update/extension'
+
+Asciidoctor::Extensions.register do
+  ext = Neo4j::AsciidoctorExtensions::AttributeUpdateTreeProcessor
+  tree_processor ext.new attr_name: 'slug',
+                         update_rule: lambda { |document, value|
+                           case document.attr('stage')
+                           when 'production'
+                             value
+                           when 'development'
+                             "_dev_#{value}"
+                           else
+                             "_test_#{value}"
+                           end
+                         }
+end
+----
+
+== Release
+
+The release process is automated and relies on GitHub Actions.
+We are using the :robot: `neo4j-oss-build` account to publish on https://rubygems.org/gems/neo4j-asciidoctor-extensions.
+
+The `RUBYGEMS_API_KEY` secret is configured on GitHub.
+See the `.github/workflows/release.yml` file for details.
+
+The release will be performed when a tag is pushed, the procedure is:
+
+. Edit `neo4j-asciidoctor-extensions.gemspec` and update the version number `s.version`
+. Run `bundle exec rake` to make sure that everything is working
+. Commit both `neo4j-asciidoctor-extensions.gemspec` and `Gemfile.lock` files
+. Tag the version using `git tag vx.y.z` (don't forget the `v` prefix and replace `x.y.z` with an actual version)
+. Push your changes with the tag: `git push origin master --tags`
+

data/lib/neo4j/asciidoctor/extensions.rb

@@ -6,3 +6,4 @@ require_relative 'extensions/document_metadata_generator'
 require_relative 'extensions/inline_highlighter_rouge'
 require_relative 'extensions/revealjs_linear_navigation'
 require_relative 'extensions/revealjs_speaker_notes_aggregator'
+require_relative 'extensions/stage_slug'

data/lib/neo4j/asciidoctor/extensions/attribute_update/extension.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+
+module Neo4j
+  # Asciidoctor extensions by Neo4j
+  module AsciidoctorExtensions
+    include Asciidoctor
+
+    # A tree processor that update an attribute depending on a given rule.
+    #
+    class AttributeUpdateTreeProcessor < Extensions::TreeProcessor
+      use_dsl
+
+      def process(document)
+        if (attribute_name = @config[:attr_name]) &&
+           (current_value = document.attr attribute_name) &&
+           (update_rule = @config[:update_rule])
+          new_value = update_rule.call(document, current_value)
+          document.set_attr attribute_name, new_value if new_value != current_value
+        end
+        document
+      end
+    end
+
+    # A tree processor that update the "slug" attribute depending on the "stage" attribute.
+    #
+    class StageSlugTreeProcessor < AttributeUpdateTreeProcessor
+      TESTING_SLUG_PREFIX = '_testing_'
+
+      def initialize(config = nil)
+        super
+        @config[:attr_name] = 'slug'
+        @config[:update_rule] = lambda { |document, value|
+          case document.attr('stage')
+          when 'production'
+            value
+          else
+            "#{TESTING_SLUG_PREFIX}#{value}"
+          end
+        }
+      end
+    end
+  end
+end

data/lib/neo4j/asciidoctor/extensions/document_metadata_generator/extension.rb

@@ -69,7 +69,7 @@ module Neo4j
               attr_name = resolve_attr_name(attr_include)
               if document.attr? attr_name
                 attr_value = resolve_attribute_value(attr_name, document, value_type)
-                metadata[attr_name] = attr_value
+                metadata[attr_name.gsub('-', '_')] = attr_value
               end
             end
             metadata['title'] = document.doctitle
@@ -84,7 +84,7 @@ module Neo4j
       def resolve_value_type(attr_include)
         if attr_include.end_with? '*'
           ValueType::LIST_STRING
-        elsif attr_include.end_with? '*<>'
+        elsif (attr_include.end_with? '*&lt;&gt;') || (attr_include.end_with? '*<>')
           ValueType::LIST_TUPLES
         else
           ValueType::STRING
@@ -95,7 +95,7 @@ module Neo4j
         attr_include
           .gsub(/\*$/, '')
           .gsub(/\*&lt;&gt;$/, '')
-          .gsub('-', '_')
+          .gsub(/\*<>$/, '')
       end
 
       def write(metadata, outfile)
@@ -118,7 +118,7 @@ module Neo4j
           split_values(attr_name, document)
             .map do |tuple|
             key, value = tuple.split('=')
-            { 'key' => key.strip, 'values' => value.strip.split(';').map(&:strip).reject(&:empty?) }
+            { 'key' => key.strip, 'values' => (value && value.strip.split(';').map(&:strip).reject(&:empty?)) || [] }
           end
         else
           document.attr attr_name

data/lib/neo4j/asciidoctor/extensions/stage_slug.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+require_relative 'attribute_update/extension'
+
+Asciidoctor::Extensions.register do
+  tree_processor Neo4j::AsciidoctorExtensions::StageSlugTreeProcessor
+end

data/neo4j-asciidoctor-extensions.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = 'neo4j-asciidoctor-extensions'
-  s.version = '0.0.3'
+  s.version = '0.1.2'
   s.summary = 'Asciidoctor extensions by Neo4j.'
   s.description = 'Asciidoctor extensions by Neo4j.'
 

data/spec/document_metadata_generator_spec.rb

@@ -54,7 +54,7 @@ describe Neo4j::AsciidoctorExtensions::DocumentMetadataGeneratorPostProcessor do
       expect(metadata['slug']).to eql('introduction-neo4j-4-0')
       expect(metadata['tags']).to eql(%w[intro neo4j])
     end
-    it 'should generate metadata with taxonomies (list of tuples)' do
+    it 'should generate metadata with taxonomies (list of tuples) using document attribute' do
       input = <<~'ADOC'
         = Introduction to Neo4j 4.0
         :document-metadata-attrs-include: slug,tags*,taxonomies*<>
@@ -74,5 +74,80 @@ describe Neo4j::AsciidoctorExtensions::DocumentMetadataGeneratorPostProcessor do
       expect(taxonomies.detect { |taxonomy| taxonomy['key'] == 'programming_language' }['values']).to eql(%w[java])
       expect(taxonomies.detect { |taxonomy| taxonomy['key'] == 'neo4j_version' }['values']).to eql(%w[3-5 3-6])
     end
+    it 'should generate metadata with taxonomies (list of tuples) using document attribute with pass' do
+      input = <<~'ADOC'
+        = Introduction to Neo4j 4.0
+        :document-metadata-attrs-include: pass:[slug,tags*,taxonomies*<>]
+        :slug: introduction-neo4j-4-0
+        :tags:  intro , neo4j,,
+        :taxonomies:  os= linux,,programming_language =java, neo4j_version=3-5; 3-6;
+
+        This is a paragraph.
+      ADOC
+      Asciidoctor.convert(input, safe: 'safe', to_file: 'spec/output/test.html')
+      metadata = YAML.load_file('spec/output/test.yml')
+      expect(metadata['title']).to eql('Introduction to Neo4j 4.0')
+      expect(metadata['slug']).to eql('introduction-neo4j-4-0')
+      expect(metadata['tags']).to eql(%w[intro neo4j])
+      taxonomies = metadata['taxonomies']
+      expect(taxonomies.detect { |taxonomy| taxonomy['key'] == 'os' }['values']).to eql(%w[linux])
+      expect(taxonomies.detect { |taxonomy| taxonomy['key'] == 'programming_language' }['values']).to eql(%w[java])
+      expect(taxonomies.detect { |taxonomy| taxonomy['key'] == 'neo4j_version' }['values']).to eql(%w[3-5 3-6])
+    end
+    it 'should generate metadata with taxonomies (list of tuples) using CLI attribute' do
+      input = <<~'ADOC'
+        = Introduction to Neo4j 4.0
+        :slug: introduction-neo4j-4-0
+        :tags:  intro , neo4j,,
+        :taxonomies:  os= linux,,programming_language =java, neo4j_version=3-5; 3-6;
+
+        This is a paragraph.
+      ADOC
+      Asciidoctor.convert(input, safe: 'safe', to_file: 'spec/output/test.html', attributes: {
+                            'document-metadata-attrs-include' => 'slug,tags*,taxonomies*<>'
+                          })
+      metadata = YAML.load_file('spec/output/test.yml')
+      expect(metadata['title']).to eql('Introduction to Neo4j 4.0')
+      expect(metadata['slug']).to eql('introduction-neo4j-4-0')
+      expect(metadata['tags']).to eql(%w[intro neo4j])
+      taxonomies = metadata['taxonomies']
+      expect(taxonomies.detect { |taxonomy| taxonomy['key'] == 'os' }['values']).to eql(%w[linux])
+      expect(taxonomies.detect { |taxonomy| taxonomy['key'] == 'programming_language' }['values']).to eql(%w[java])
+      expect(taxonomies.detect { |taxonomy| taxonomy['key'] == 'neo4j_version' }['values']).to eql(%w[3-5 3-6])
+    end
+    it 'should replace - by _ in the attribute name' do
+      input = <<~'ADOC'
+        = Introduction to Neo4j 4.0
+        :slug: introduction-neo4j-4-0
+        :parent-path: /labs
+
+        This is a paragraph.
+      ADOC
+      Asciidoctor.convert(input, safe: 'safe', to_file: 'spec/output/test.html', attributes: {
+                            'document-metadata-attrs-include' => 'slug,parent-path'
+                          })
+      metadata = YAML.load_file('spec/output/test.yml')
+      expect(metadata['title']).to eql('Introduction to Neo4j 4.0')
+      expect(metadata['slug']).to eql('introduction-neo4j-4-0')
+      expect(metadata['parent_path']).to eql('/labs')
+    end
+    it 'should ignore empty value in taxonomies' do
+      input = <<~'ADOC'
+        = Introduction to Neo4j 4.0
+        :slug: introduction-neo4j-4-0
+        :taxonomies: neo4j_versions= , tags= intro ; neo4j;;
+
+        This is a paragraph.
+      ADOC
+      Asciidoctor.convert(input, safe: 'safe', to_file: 'spec/output/test.html', attributes: {
+                            'document-metadata-attrs-include' => 'slug,taxonomies*<>'
+                          })
+      metadata = YAML.load_file('spec/output/test.yml')
+      expect(metadata['title']).to eql('Introduction to Neo4j 4.0')
+      expect(metadata['slug']).to eql('introduction-neo4j-4-0')
+      taxonomies = metadata['taxonomies']
+      expect(taxonomies.detect { |taxonomy| taxonomy['key'] == 'neo4j_versions' }['values']).to eql([])
+      expect(taxonomies.detect { |taxonomy| taxonomy['key'] == 'tags' }['values']).to eql(%w[intro neo4j])
+    end
   end
 end

data/spec/stage_slug_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+require_relative '../lib/neo4j/asciidoctor/extensions/attribute_update/extension'
+
+describe Neo4j::AsciidoctorExtensions::StageSlugTreeProcessor do
+  context 'convert to html5' do
+    it 'should update slug' do
+      registry = Asciidoctor::Extensions.create
+      registry.tree_processor Neo4j::AsciidoctorExtensions::StageSlugTreeProcessor
+      input = <<~'ADOC'
+        = Introduction to Neo4j 4.0
+        :slug: intro-neo4j-4-0
+
+        {slug}
+      ADOC
+      output = Asciidoctor.convert(input, extension_registry: registry, standalone: false, doctype: 'inline')
+      (expect output).to eql '_testing_intro-neo4j-4-0'
+    end
+    it 'should not update slug' do
+      registry = Asciidoctor::Extensions.create
+      registry.tree_processor Neo4j::AsciidoctorExtensions::StageSlugTreeProcessor
+      input = <<~'ADOC'
+        = Introduction to Neo4j 4.0
+        :stage: production
+        :slug: intro-neo4j-4-0
+
+        {slug}
+      ADOC
+      output = Asciidoctor.convert(input, extension_registry: registry, standalone: false, doctype: 'inline')
+      (expect output).to eql 'intro-neo4j-4-0'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neo4j-asciidoctor-extensions
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.2
 platform: ruby
 authors:
 - Guillaume Grossetie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-23 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -117,6 +117,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rakeTasks"
 - ".rubocop.yml"
@@ -126,6 +127,7 @@ files:
 - README.adoc
 - Rakefile
 - lib/neo4j/asciidoctor/extensions.rb
+- lib/neo4j/asciidoctor/extensions/attribute_update/extension.rb
 - lib/neo4j/asciidoctor/extensions/course_document_attributes.rb
 - lib/neo4j/asciidoctor/extensions/course_document_attributes/extension.rb
 - lib/neo4j/asciidoctor/extensions/cypher_syntax_role.rb
@@ -138,6 +140,7 @@ files:
 - lib/neo4j/asciidoctor/extensions/revealjs_linear_navigation/extension.rb
 - lib/neo4j/asciidoctor/extensions/revealjs_speaker_notes_aggregator.rb
 - lib/neo4j/asciidoctor/extensions/revealjs_speaker_notes_aggregator/extension.rb
+- lib/neo4j/asciidoctor/extensions/stage_slug.rb
 - neo4j-asciidoctor-extensions.gemspec
 - spec/.rubocop.yml
 - spec/cypher_syntax_role_spec.rb
@@ -145,6 +148,7 @@ files:
 - spec/inline_highlighter_rouge_spec.rb
 - spec/revealjs_linear_navigation_spec.rb
 - spec/revealjs_speaker_notes_aggregator_spec.rb
+- spec/stage_slug_spec.rb
 - tasks/bundler.rake
 - tasks/lint.rake
 - tasks/rspec.rake
@@ -169,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Asciidoctor extensions by Neo4j.
@@ -180,3 +184,4 @@ test_files:
 - spec/inline_highlighter_rouge_spec.rb
 - spec/revealjs_linear_navigation_spec.rb
 - spec/revealjs_speaker_notes_aggregator_spec.rb
+- spec/stage_slug_spec.rb