neo4j-asciidoctor-extensions 0.0.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9aa5c3d1385aa9d4dd4ac11820ffb24ab9dca9fd02b99bcffe6979031469adc
-  data.tar.gz: 129476850c9147c0fbc8accaf0309f59c787f2e4defb8a3c5ecd444a28060086
+  metadata.gz: 2ed2835da9be7c20ddf83b173cd740644a00986b0216e1d77d30ca65b359296a
+  data.tar.gz: 0b2d0ef0ec3f5d5c05910d8768e836d9147c045a4cd017f326fa1c261d2212bc
 SHA512:
-  metadata.gz: 6f0c5596adbf742abb16103642445284bb0be42720e1ed57fdc1f9cfa7322c0191261af133f2ae0c9a556696e0af2406e11157d935e5667c52793194101afe45
-  data.tar.gz: c0640a5f5a47220d006bcc2d84aca356dfdcadfb17554b1f121df9cb0aa2c81085566d0a946a8eab1842a36eda39a63b594802ce125522ad45a16062fe8f3986
+  metadata.gz: 5edbf5d0eb1e83d2d82dcbd3e9515f645b48b56d246bb30e9caa005079c7742967bac7bbffc3d73d415c3b968fa8346f3e8116557475e2c8a573e8155902461f
+  data.tar.gz: 83660797c903651ebcabbc8c167faaa19ac42685ad866641f4fb411f70c62a8512bfb986ceb1653a5c73c96753d2aee1a9fa2de08c2b0718fb1f5c97e33fad0d

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    neo4j-asciidoctor-extensions (0.0.5)
-      asciidoctor (~> 2.0.0)
+    neo4j-asciidoctor-extensions (0.3.0)
+      asciidoctor (~> 2.0)
       asciidoctor-pdf (= 1.5.3)
-      rouge (~> 3.18.0)
+      rouge (~> 3.18)
 
 GEM
   remote: https://rubygems.org/

data/README.adoc

@@ -216,7 +216,7 @@ end
 == Release
 
 The release process is automated and relies on GitHub Actions.
-We are using the :robot: `neo4j-oss-build` account to published on https://rubygems.org/gems/neo4j-asciidoctor-extensions.
+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.

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

@@ -17,18 +17,16 @@ module Neo4j
       TESTING_SLUG_PREFIX = '_testing_'
 
       def process(document)
-        if (docdir = document.attr 'docdir')
-          # TODO: this path should be configurable
-          path = File.expand_path('../build/online/asciidoctor-module-descriptor.yml', docdir)
-          if File.exist?(path)
+        if (module_descriptor_path = document.attr('module-descriptor-path'))
+          if File.exist?(module_descriptor_path)
             require 'yaml'
-            module_descriptor = YAML.load_file(path)
-            if (document_slug = document.attr 'slug') && document.attr('stage') != 'production'
+            module_descriptor = YAML.load_file(module_descriptor_path)
+            if (document_slug = document.attr('slug')) && document.attr('stage') != 'production'
               document_slug = "#{TESTING_SLUG_PREFIX}#{document_slug}"
-              document.set_attr 'slug', document_slug
+              document.set_attr('slug', document_slug)
             end
             set_attributes(document, document_slug, module_descriptor)
-            document.set_attribute 'module-name', module_descriptor['module_name']
+            document.set_attribute('module-name', module_descriptor['module_name'])
           end
         end
         document
@@ -38,17 +36,17 @@ module Neo4j
 
       def set_attributes(document, document_slug, module_descriptor)
         module_descriptor['pages'].each_with_index do |page, index|
-          document.set_attribute "module-toc-link-#{index}", page['url']
-          document.set_attribute "module-toc-title-#{index}", page['title']
+          document.set_attribute("module-toc-link-#{index}", page['url'])
+          document.set_attribute("module-toc-title-#{index}", page['title'])
           page_slug = page['slug']
           page_slug = "#{TESTING_SLUG_PREFIX}#{page_slug}" unless document.attr('stage') == 'production'
-          document.set_attribute "module-toc-slug-#{index}", page_slug
-          document.set_attribute "module-quiz-#{index}", page['quiz']
+          document.set_attribute("module-toc-slug-#{index}", page_slug)
+          document.set_attribute("module-quiz-#{index}", page['quiz'])
           next unless document_slug == page_slug
 
           set_next_attributes(document, page)
-          document.set_attribute 'module-quiz', page['quiz']
-          document.set_attribute 'module-certificate', page['certificate']
+          document.set_attribute('module-quiz', page['quiz'])
+          document.set_attribute('module-certificate', page['certificate'])
         end
       end
 
@@ -57,8 +55,8 @@ module Neo4j
 
         next_page_slug = page['next']['slug']
         next_page_slug = "#{TESTING_SLUG_PREFIX}#{next_page_slug}" unless document.attr('stage') == 'production'
-        document.set_attr 'module-next-slug', next_page_slug, false
-        document.set_attr 'module-next-title', page['next']['title'], false
+        document.set_attr('module-next-slug', next_page_slug, false)
+        document.set_attr('module-next-title', page['next']['title'], false)
       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/rouge/themes/neo.rb

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*- #
+# frozen_string_literal: true
+
+require 'rouge' unless defined? ::Rouge::Lexers
+
+module Rouge
+  module Themes
+    #
+    # Neo4j (default) theme
+    class Neo < CSSTheme
+      name 'neo'
+
+      style Comment::Multiline,
+            Comment::Preproc,
+            Comment::Single,
+            Comment::Special,
+            Comment, fg: '#75787b'
+      style Error,
+            Generic::Error,
+            Generic::Traceback, fg: '#960050'
+      style Keyword::Constant,
+            Keyword::Declaration,
+            Keyword::Reserved,
+            Name::Constant,
+            Keyword::Type, fg: '#1d75b3'
+      style Literal::String, fg: '#b35e14'
+      style Name::Function,
+            Operator, fg: '#2e383c'
+      style Name::Namespace,
+            Name::Label,
+            Literal::String::Delimiter,
+            Name::Property, fg: '#75438a'
+      style Name::Entity,
+            Name::Builtin::Pseudo,
+            Name::Variable::Global,
+            Name::Variable::Instance,
+            Name::Variable,
+            Text::Whitespace,
+            Text,
+            Name, fg: '#047d65'
+      style Keyword, fg: '#1d75b3'
+      style Literal::String::Symbol, fg: '#9c3328'
+    end
+  end
+end

data/lib/neo4j/rouge/themes/neo_forest.rb

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*- #
+# frozen_string_literal: true
+
+require 'rouge' unless defined? ::Rouge::Lexers
+
+module Rouge
+  module Themes
+    #
+    # Neo4j forest theme
+    class NeoForest < CSSTheme
+      name 'neo.forest'
+
+      style Comment::Multiline,
+            Comment::Preproc,
+            Comment::Single,
+            Comment::Special,
+            Comment, fg: '#75787b'
+      style Error,
+            Generic::Error,
+            Generic::Traceback, fg: '#960050'
+      style Name::Function,
+            Operator::Word,
+            Keyword,
+            Keyword::Constant,
+            Keyword::Declaration,
+            Keyword::Reserved,
+            Name::Constant,
+            Keyword::Type, fg: '#859900'
+      style Literal::String, fg: '#b58900'
+      style Literal::Number, fg: '#2aa198'
+      style Operator,
+            Name::Namespace,
+            Name::Label,
+            Literal::String::Delimiter,
+            Name::Property,
+            Name::Entity,
+            Name::Builtin::Pseudo,
+            Name::Variable::Global,
+            Name::Variable::Instance,
+            Name::Variable,
+            Text::Whitespace,
+            Text,
+            Name,
+            Literal::String::Symbol, fg: '#333333'
+    end
+  end
+end

data/neo4j-asciidoctor-extensions.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = 'neo4j-asciidoctor-extensions'
-  s.version = '0.0.5'
+  s.version = '0.3.0'
   s.summary = 'Asciidoctor extensions by Neo4j.'
   s.description = 'Asciidoctor extensions by Neo4j.'
 
@@ -18,9 +18,9 @@ Gem::Specification.new do |s|
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'asciidoctor', '~> 2.0.0'
+  s.add_runtime_dependency 'asciidoctor', '~> 2.0'
   s.add_runtime_dependency 'asciidoctor-pdf', '1.5.3'
-  s.add_runtime_dependency 'rouge', '~> 3.18.0'
+  s.add_runtime_dependency 'rouge', '~> 3.18'
 
   s.add_development_dependency 'asciidoctor-revealjs', '~> 4.0'
   s.add_development_dependency 'rake', '~> 12.3.2'

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neo4j-asciidoctor-extensions
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Guillaume Grossetie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: asciidoctor-pdf
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.18.0
+        version: '3.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.18.0
+        version: '3.18'
 - !ruby/object:Gem::Dependency
   name: asciidoctor-revealjs
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +141,8 @@ files:
 - 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
+- lib/neo4j/rouge/themes/neo.rb
+- lib/neo4j/rouge/themes/neo_forest.rb
 - neo4j-asciidoctor-extensions.gemspec
 - spec/.rubocop.yml
 - spec/cypher_syntax_role_spec.rb