neo4j-asciidoctor-extensions 0.0.1

data/neo4j-asciidoctor-extensions.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name = 'neo4j-asciidoctor-extensions'
+  s.version = '0.0.1'
+  s.summary = 'Asciidoctor extensions by Neo4j.'
+  s.description = 'Asciidoctor extensions by Neo4j.'
+
+  s.authors = ['Guillaume Grossetie']
+  s.email = ['ggrossetie@yuzutech.fr']
+  s.homepage = 'https://github.com/neo4j-contrib/neo4j-asciidoctor-extensions'
+  s.license = 'Apache'
+  s.metadata = {
+    'bug_tracker_uri' => 'https://github.com/neo4j-contrib/neo4j-asciidoctor-extensions/issues',
+    'source_code_uri' => 'https://github.com/neo4j-contrib/neo4j-asciidoctor-extensions'
+  }
+  s.files = `git ls-files`.split($RS)
+  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-pdf', '1.5.3'
+  s.add_runtime_dependency 'rouge', '~> 3.18.0'
+
+  s.add_development_dependency 'asciidoctor-revealjs', '~> 4.0'
+  s.add_development_dependency 'rake', '~> 12.3.2'
+  s.add_development_dependency 'rspec', '~> 3.8.0'
+  s.add_development_dependency 'rubocop', '~> 0.74.0'
+end

data/spec/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - ../.rubocop.yml
+
+Metrics/BlockLength:
+  Max: 500

data/spec/cypher_syntax_role_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require_relative '../lib/neo4j_asciidoctor_extensions/cypher_syntax_role'
+
+describe Neo4j::AsciidoctorExtensions::CypherSyntaxRoleTreeProcessor do
+  context 'convert to html5' do
+    it 'should add role syntax on cypher-syntax source block' do
+      input = <<~'ADOC'
+        [source,cypher-syntax]
+        ----
+        ()
+        (p)
+        (l)
+        (n)
+        ----
+      ADOC
+      output = Asciidoctor.convert(input, standalone: false)
+      (expect output).to eql %(<div class="listingblock syntax">
+<div class="content">
+<pre class="highlight"><code class="language-cypher-syntax" data-lang="cypher-syntax">()
+(p)
+(l)
+(n)</code></pre>
+</div>
+</div>)
+    end
+  end
+end

data/spec/document_metadata_generator_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require_relative '../lib/neo4j_asciidoctor_extensions/document_metadata_generator'
+
+RSpec.configure do |config|
+  config.after(:each) do
+    FileUtils.rm_rf('spec/output') unless ENV['DEBUG']
+  end
+
+  config.before(:each) do
+    FileUtils.mkdir_p('spec/output')
+  end
+end
+
+describe Neo4j::AsciidoctorExtensions::DocumentMetadataGeneratorPostProcessor do
+  context 'convert to html5' do
+    it 'should generate default metadata' do
+      input = <<~'ADOC'
+        = Introduction to Neo4j 4.0
+        :document-metadata-attrs-include:
+
+        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')
+    end
+    it 'should generate metadata with slug (string)' do
+      input = <<~'ADOC'
+        = Introduction to Neo4j 4.0
+        :document-metadata-attrs-include: slug
+        :slug: introduction-neo4j-4-0
+
+        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')
+    end
+    it 'should generate metadata with tags (list of strings)' do
+      input = <<~'ADOC'
+        = Introduction to Neo4j 4.0
+        :document-metadata-attrs-include: slug,tags*
+        :slug: introduction-neo4j-4-0
+        :tags:  intro , neo4j,,
+
+        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])
+    end
+    it 'should generate metadata with taxonomies (list of tuples)' do
+      input = <<~'ADOC'
+        = Introduction to Neo4j 4.0
+        :document-metadata-attrs-include: 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
+  end
+end

data/spec/inline_highlighter_rouge_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require_relative '../lib/neo4j_asciidoctor_extensions/inline_highlighter_rouge'
+
+# rubocop:disable Metrics/LineLength
+describe Neo4j::AsciidoctorExtensions::InlineHighlighter::MonospacedTextInlineMacro do
+  context 'convert to html5' do
+    it 'should apply syntax highlighting on monospaced text cypher' do
+      input = <<~'ADOC'
+        [src-cypher]`MATCH (c:Customer {customerName: 'ABCCO'}) RETURN c.BOUGHT.productName`
+      ADOC
+      output = Asciidoctor.convert(input, doctype: 'inline')
+      expect(output).to eql '<code class="rouge"><span style="color: #000000;font-weight: bold">MATCH</span><span style="color: #bbbbbb"> </span><span style="color: #990073">(</span><span style="background-color: #f8f8f8">c:</span><span style="background-color: #f8f8f8">Customer</span> <span style="color: #990073">{</span><span style="background-color: #f8f8f8">customerName:</span> <span style="color: #d14">\'ABCCO\'</span><span style="color: #990073">})</span> <span style="color: #000000;font-weight: bold">RETURN</span> <span style="background-color: #f8f8f8">c.BOUGHT.productName</span></code>'
+    end
+  end
+end
+
+describe Neo4j::AsciidoctorExtensions::InlineHighlighter::SrcInlineMacro do
+  context 'convert to html5' do
+    it 'should apply syntax highlighting on src inline macro' do
+      input = <<~'ADOC'
+        src:cypher[MATCH (c:Customer {customerName: 'ABCCO'}) RETURN c.BOUGHT.productName]
+      ADOC
+      output = Asciidoctor.convert(input, doctype: 'inline')
+      expect(output).to eql '<code class="rouge"><span style="color: #000000;font-weight: bold">MATCH</span><span style="color: #bbbbbb"> </span><span style="color: #990073">(</span><span style="background-color: #f8f8f8">c:</span><span style="background-color: #f8f8f8">Customer</span> <span style="color: #990073">{</span><span style="background-color: #f8f8f8">customerName:</span> <span style="color: #d14">\'ABCCO\'</span><span style="color: #990073">})</span> <span style="color: #000000;font-weight: bold">RETURN</span> <span style="background-color: #f8f8f8">c.BOUGHT.productName</span></code>'
+    end
+  end
+end
+# rubocop:enable Metrics/LineLength

data/spec/revealjs_linear_navigation_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'asciidoctor-revealjs'
+require_relative '../lib/neo4j_asciidoctor_extensions/revealjs_linear_navigation'
+
+describe Neo4j::AsciidoctorExtensions::RevealJsLinearNavigationTreeProcessor do
+  context 'convert to reveal.js' do
+    it 'should produce a linear navigation' do
+      input = <<~'ADOC'
+        = Introduction to Neo4j 4.0
+
+        == a
+
+        === b
+
+        ==== c
+
+        === d
+
+        == e
+
+        === f
+
+        == g
+
+        == h
+
+        === i
+
+        ==== j
+
+        ==== k
+
+        == l
+      ADOC
+      output = Asciidoctor.convert(input, backend: 'revealjs')
+      expect(output).to eql %(<section id="_a"><h2>a</h2></section>
+<section id="_b"><h2>b</h2></section>
+<section id="_c"><h2>c</h2></section>
+<section id="_d"><h2>d</h2></section>
+<section id="_e"><h2>e</h2></section>
+<section id="_f"><h2>f</h2></section>
+<section id="_g"><h2>g</h2></section>
+<section id="_h"><h2>h</h2></section>
+<section id="_i"><h2>i</h2></section>
+<section id="_j"><h2>j</h2></section>
+<section id="_k"><h2>k</h2></section>
+<section id="_l"><h2>l</h2></section>)
+    end
+  end
+end

data/spec/revealjs_speaker_notes_aggregator_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'asciidoctor-revealjs'
+require_relative '../lib/neo4j_asciidoctor_extensions/revealjs_speaker_notes_aggregator'
+
+describe Neo4j::AsciidoctorExtensions::RevealJsSpeakerNotesAggregatorTreeProcessor do
+  context 'convert to reveal.js' do
+    it 'should aggregate speaker notes' do
+      input = <<~'ADOC'
+        = Presentation
+
+        == Introduction
+
+        [.notes]
+        --
+        This is a speaker note.
+        --
+
+        Hello!
+
+        [.notes]
+        --
+        This is another speaker note.
+        --
+      ADOC
+      output = Asciidoctor.convert(input, backend: 'revealjs')
+      expect(output).to eql %(<section id="_introduction"><h2>Introduction</h2><div class="slide-content"><div class="paragraph"><p>Hello!</p></div>
+<aside class="notes"><div class="openblock"><div class="content"><div class="paragraph"><p>This is a speaker note.</p></div></div></div>
+<div class="openblock"><div class="content"><div class="paragraph"><p>This is another speaker note.</p></div></div></div></aside></div></section>)
+    end
+  end
+end

data/tasks/bundler.rake

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

data/tasks/lint.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new :lint

data/tasks/rspec.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new :spec
+rescue LoadError
+  warn $ERROR_INFO.message
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: neo4j-asciidoctor-extensions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Guillaume Grossetie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-pdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.18.0
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-revealjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+description: Asciidoctor extensions by Neo4j.
+email:
+- ggrossetie@yuzutech.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rakeTasks"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- 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
+- neo4j-asciidoctor-extensions.gemspec
+- spec/.rubocop.yml
+- spec/cypher_syntax_role_spec.rb
+- spec/document_metadata_generator_spec.rb
+- spec/inline_highlighter_rouge_spec.rb
+- spec/revealjs_linear_navigation_spec.rb
+- spec/revealjs_speaker_notes_aggregator_spec.rb
+- tasks/bundler.rake
+- tasks/lint.rake
+- tasks/rspec.rake
+homepage: https://github.com/neo4j-contrib/neo4j-asciidoctor-extensions
+licenses:
+- Apache
+metadata:
+  bug_tracker_uri: https://github.com/neo4j-contrib/neo4j-asciidoctor-extensions/issues
+  source_code_uri: https://github.com/neo4j-contrib/neo4j-asciidoctor-extensions
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Asciidoctor extensions by Neo4j.
+test_files:
+- spec/.rubocop.yml
+- spec/cypher_syntax_role_spec.rb
+- spec/document_metadata_generator_spec.rb
+- spec/inline_highlighter_rouge_spec.rb
+- spec/revealjs_linear_navigation_spec.rb
+- spec/revealjs_speaker_notes_aggregator_spec.rb