neo4j-asciidoctor-extensions 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dac414fc3be4c6ceaf02e3e3a1eadcf080e2a46c87a8587da72a368e7087937
-  data.tar.gz: e205eadc7743d01ecaf7f28ab7fd80eb6e0fc7717a4b7be1a4eb86fb3adc47b5
+  metadata.gz: 1ee63d095a6ddc2621c6a70a27e117360e43e9ae82c317f88168e165897103b7
+  data.tar.gz: d4fda2cdb54912ee593775587a0143e15938200938fafc53038651d456557eaa
 SHA512:
-  metadata.gz: 1d1b053f42228a46e6e9786211b42b5ee7bd79e9a616986f1f8635c74b24354b31bb922f839de73185f410ba7e9fd52ffd3e845d34cbebf22d724b47e410f784
-  data.tar.gz: 3517e30b390c9aeb4ec90da2041eb37f6b19da8fd754840b2b6b762d42225b2798c3c0790bef9a1458811ba3a4986086038188fe61a18ce6d64fdab30bd16295
+  metadata.gz: 2fe832f1eab6f10a280445cb1ebd69e860e69e3532de4e809843da531a9b37db2b186b7924d60af3d12f8ec35b795dec53617dcc86364feb2a8ee523f499b988
+  data.tar.gz: 57bd9149a7b881d1017af2e9925b88872f837abe8d1ba30891749bca8c988bbf608991502b7658be3d74d1595b7075de67f50b3a7c7d4fe242da67901140528a

data/Gemfile.lock

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

data/README.adoc

@@ -5,23 +5,47 @@ image:https://github.com/neo4j-contrib/neo4j-asciidoctor-extensions/workflows/CI
 
 This repository contains Asciidoctor extensions made by {uri-neo4j}[Neo4j] for processing and publishing AsciiDoc content.
 
-== Usage
+== Install
 
 [source,console]
 ----
 $ gem install neo4j-asciidoctor-extensions
-$ asciidoctor -r neo4j-asciidoctor-extensions doc.adoc
 ----
 
+== Usage
+
+=== CLI
+
+[source,console]
+----
+$ asciidoctor -r neo4j/asciidoctor/extensions doc.adoc
+----
+
+=== API
+
+[source,ruby]
+----
+require 'neo4j/asciidoctor/extensions'
+----
+
+In addition, you can require individual extension:
+
+[source,ruby]
+----
+require 'neo4j/asciidoctor/extensions/revealjs_linear_navigation'
+----
+
+See below for the complete list of extensions.
+
 == Extensions
 
-The Ruby Gem contains 6 distinct extensions:
+The Ruby gem contains 6 distinct extensions:
 
-=== `CourseDocumentAttributesPostProcessor`
+=== `course_document_attributes`
 
 A postprocessor that adds attributes about the course.
 
-===  `CypherSyntaxRoleTreeProcessor`
+=== `cypher_syntax_role`
 
 A tree processor that adds a role on code blocks using "cypher-syntax" as a language.
 
@@ -38,7 +62,7 @@ A tree processor that adds a role on code blocks using "cypher-syntax" as a lang
 ----
 ....
 
-=== `DocumentMetadataGeneratorPostProcessor`
+=== `document_metadata_generator`
 
 A postprocess that generates a metadata file (in YAML format) from a list of document attributes.
 
@@ -80,45 +104,27 @@ taxonomies:
       - 3-6
 ----
 
-=== `InlineHighlighter::MonospacedTextInlineMacro`
+=== `inline_highlighter_rouge`
 
 Inline syntax highlighter based on Rouge.
-Apply syntax highlighting on monospaced text cypher:
+It applies syntax highlighting on both monospaced text cypher and `src` inline macro:
 
 *Usage:*
 
 [source,adoc]
 ----
 [src-cypher]`MATCH (c:Customer {customerName: 'ABCCO'}) RETURN c.BOUGHT.productName`
-----
-
-Apply syntax highlighting on src inline macro:
-
-*Usage:*
-
-[source,adoc]
-----
-src:cypher[MATCH (c:Customer {customerName: 'ABCCO'}) RETURN c.BOUGHT.productName]
-----
-
-=== `InlineHighlighter::SrcInlineMacro`
-
-Apply syntax highlighting on src inline macro:
 
-*Usage:*
-
-[source,adoc]
-----
 src:cypher[MATCH (c:Customer {customerName: 'ABCCO'}) RETURN c.BOUGHT.productName]
 ----
 
-=== `RevealJsLinearNavigationTreeProcessor`
+=== `revealjs_linear_navigation`
 
 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.
 
-=== `RevealJsSpeakerNotesAggregatorTreeProcessor`
+=== `revealjs_speaker_notes_aggregator`
 A tree processor that aggregates multiple `[.notes]` blocks in a section (slide).
 
 *Usage:*

data/lib/neo4j/asciidoctor/extensions.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'extensions/course_document_attributes'
+require_relative 'extensions/cypher_syntax_role'
+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'

data/neo4j-asciidoctor-extensions.gemspec

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

data/spec/cypher_syntax_role_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'asciidoctor'
-require_relative '../lib/neo4j_asciidoctor_extensions/cypher_syntax_role'
+require_relative '../lib/neo4j/asciidoctor/extensions/cypher_syntax_role'
 
 describe Neo4j::AsciidoctorExtensions::CypherSyntaxRoleTreeProcessor do
   context 'convert to html5' do

data/spec/document_metadata_generator_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'asciidoctor'
-require_relative '../lib/neo4j_asciidoctor_extensions/document_metadata_generator'
+require_relative '../lib/neo4j/asciidoctor/extensions/document_metadata_generator'
 
 RSpec.configure do |config|
   config.after(:each) do

data/spec/inline_highlighter_rouge_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'asciidoctor'
-require_relative '../lib/neo4j_asciidoctor_extensions/inline_highlighter_rouge'
+require_relative '../lib/neo4j/asciidoctor/extensions/inline_highlighter_rouge'
 
 # rubocop:disable Metrics/LineLength
 describe Neo4j::AsciidoctorExtensions::InlineHighlighter::MonospacedTextInlineMacro do

data/spec/revealjs_linear_navigation_spec.rb

@@ -2,7 +2,7 @@
 
 require 'asciidoctor'
 require 'asciidoctor-revealjs'
-require_relative '../lib/neo4j_asciidoctor_extensions/revealjs_linear_navigation'
+require_relative '../lib/neo4j/asciidoctor/extensions/revealjs_linear_navigation'
 
 describe Neo4j::AsciidoctorExtensions::RevealJsLinearNavigationTreeProcessor do
   context 'convert to reveal.js' do

data/spec/revealjs_speaker_notes_aggregator_spec.rb

@@ -2,7 +2,7 @@
 
 require 'asciidoctor'
 require 'asciidoctor-revealjs'
-require_relative '../lib/neo4j_asciidoctor_extensions/revealjs_speaker_notes_aggregator'
+require_relative '../lib/neo4j/asciidoctor/extensions/revealjs_speaker_notes_aggregator'
 
 describe Neo4j::AsciidoctorExtensions::RevealJsSpeakerNotesAggregatorTreeProcessor do
   context 'convert to reveal.js' do

data/tasks/bundler.rake

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 begin
   require 'bundler/gem_tasks'
 rescue LoadError
-  warn $!.message
+  warn $ERROR_INFO.message
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neo4j-asciidoctor-extensions
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Guillaume Grossetie
@@ -125,19 +125,19 @@ files:
 - LICENSE
 - README.adoc
 - Rakefile
-- lib/neo4j_asciidoctor_extensions.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
-- lib/neo4j_asciidoctor_extensions/cypher_syntax_role/extension.rb
-- lib/neo4j_asciidoctor_extensions/document_metadata_generator.rb
-- lib/neo4j_asciidoctor_extensions/document_metadata_generator/extension.rb
-- lib/neo4j_asciidoctor_extensions/inline_highlighter_rouge.rb
-- lib/neo4j_asciidoctor_extensions/inline_highlighter_rouge/extension.rb
-- lib/neo4j_asciidoctor_extensions/revealjs_linear_navigation.rb
-- 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.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
+- lib/neo4j/asciidoctor/extensions/cypher_syntax_role/extension.rb
+- lib/neo4j/asciidoctor/extensions/document_metadata_generator.rb
+- lib/neo4j/asciidoctor/extensions/document_metadata_generator/extension.rb
+- lib/neo4j/asciidoctor/extensions/inline_highlighter_rouge.rb
+- lib/neo4j/asciidoctor/extensions/inline_highlighter_rouge/extension.rb
+- lib/neo4j/asciidoctor/extensions/revealjs_linear_navigation.rb
+- 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
 - neo4j-asciidoctor-extensions.gemspec
 - spec/.rubocop.yml
 - spec/cypher_syntax_role_spec.rb

data/lib/neo4j_asciidoctor_extensions.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'neo4j_asciidoctor_extensions/course_document_attributes'
-require_relative 'neo4j_asciidoctor_extensions/cypher_syntax_role'
-require_relative 'neo4j_asciidoctor_extensions/document_metadata_generator'
-require_relative 'neo4j_asciidoctor_extensions/inline_highlighter_rouge'
-require_relative 'neo4j_asciidoctor_extensions/revealjs_linear_navigation'
-require_relative 'neo4j_asciidoctor_extensions/revealjs_speaker_notes_aggregator'