rspec-documentation 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4561251ce0f9a08189548e24ea32ec4a502e97a20a3134a8c6bb01315f7952da
-  data.tar.gz: 8cce4e66da35bb1368a49b446d578b7717fd83a5f52a2a7ae288c285b8ead2b5
+  metadata.gz: 33437a93f6595a9ed9fe7b0970b2736e8c2a83db3d63038021d8878f8b75065e
+  data.tar.gz: 3b973515d7a23afc87cb2ee2124ce07a41bed3a4a8e53d431b4bc70fa594fee1
 SHA512:
-  metadata.gz: ba00f0c0350732c3c3e367255707aeb7de8f99cb2fb28153ea0cf0ba6e0b3a882d00c098075c46c2ec98b9ec1f90dee33bf985e5823aa096bdec5f1821602d0f
-  data.tar.gz: b4537305809b8b2097f33864dfa1c6a39cf91af072a36f7f60679896b09b29c45e6128eb023d2dd6979f1096e316bd3e26a6fa420f4248b61965dd632d3d97b7
+  metadata.gz: 60085cdc0fdd2c356d3783730683b88068a30e3093b5be151b062e0cf23c3c3dab6adc06b7facdf51e584e7ea532c804fe4613844bbdb96a9f9ed1f73c386c86
+  data.tar.gz: 76e43c185ae945964822c30dcee78221b182d9ad342fbbee720cf6d1947087eb25dde68085a0aefb5d9ec23d9e7ff12b702159cffb6c503ebedef63842746838

data/Gemfile.lock

@@ -1,13 +1,12 @@
 PATH
   remote: .
   specs:
-    rspec-documentation (0.0.10)
+    rspec-documentation (0.0.11)
       htmlbeautifier (~> 1.4)
       kramdown (~> 2.4)
       kramdown-parser-gfm (~> 1.1)
       nokogiri (~> 1.15)
       paintbrush (~> 0.1.3)
-      redcarpet (~> 3.6)
       rouge (~> 4.1)
       rspec (~> 3.12)
 
@@ -37,7 +36,6 @@ GEM
     racc (1.7.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    redcarpet (3.6.0)
     regexp_parser (2.8.1)
     rexml (3.2.5)
     rouge (4.1.2)
@@ -108,4 +106,4 @@ DEPENDENCIES
   strong_versions (~> 0.4.5)
 
 BUNDLED WITH
-   2.4.12
+   2.4.14

data/lib/rspec/documentation/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Documentation
-    VERSION = '0.0.10'
+    VERSION = '0.0.11'
   end
 end

data/lib/rspec_documentation/kramdown_html_converter.rb

@@ -6,11 +6,18 @@ module Kramdown
     # Applies a custom CSS class to Markdown tables when rendered to HTML.
     class HtmlRspecDocumentation < Converter::Html
       def convert_table(element, indent)
+        return super if rspec_documentation_example?
+
         element.attr['class'] ||= 'rspec-documentation-table table'
         super
       end
 
       def convert_header(element, indent)
+        if rspec_documentation_example?
+          element.attr['class'] = "no_toc #{element.attr['class']}"
+          return super
+        end
+
         [
           '<div class="heading">',
           super,
@@ -22,6 +29,12 @@ module Kramdown
       def link_icon
         @link_icon ||= RSpecDocumentation.template(:link, :svg).result
       end
+
+      private
+
+      def rspec_documentation_example?
+        @stack.any? { |frame| frame.attr['class']&.include?('rspec-documentation-example') }
+      end
     end
   end
 end

data/lib/rspec_documentation/project_initialization.rb

@@ -17,7 +17,9 @@ module RSpecDocumentation
 
     def print_welcome
       warn(paintbrush { blue "\nWelcome to #{cyan 'RSpec Documentation'}. A new project is being initialized.\n" })
-      warn(paintbrush { blue "If you want undo at any point, simply delete #{cyan 'rspec-documentation/'}.\n" })
+      warn(paintbrush do
+        blue "If you want to undo at any point, simply delete the #{cyan 'rspec-documentation/'}  directory.\n"
+      end)
     end
 
     def create_base_dir

data/lib/rspec_documentation.rb

@@ -4,9 +4,7 @@ require 'htmlbeautifier'
 require 'kramdown'
 require 'kramdown-parser-gfm'
 require 'paintbrush'
-require 'redcarpet'
 require 'rouge'
-require 'rouge/plugins/redcarpet'
 require 'rspec'
 require 'rake'
 
@@ -32,7 +30,6 @@ require_relative 'rspec_documentation/parsed_document'
 require_relative 'rspec_documentation/html_element'
 require_relative 'rspec_documentation/formatters'
 require_relative 'rspec_documentation/spec'
-require_relative 'rspec_documentation/markdown_renderer'
 require_relative 'rspec_documentation/documentation'
 require_relative 'rspec_documentation/page_collection'
 require_relative 'rspec_documentation/page_tree'

data/lib/templates/header.html.erb

@@ -1,4 +1,4 @@
-<div class="header text-end pt-3 pe-3">
+<div class="header text-end pt-3 pe-4">
   <% if homepage.nil? %>
     <h1 class="title"><%= title %></h1>
   <% else %>

data/lib/templates/modal_spec.html.erb

@@ -1,4 +1,10 @@
-<div class="modal fade example-modal" id="modal-<%= element_id %>-side-by-side" data-bs-backdrop="static" data-bs-keyboard="false" tabindex="-1" aria-labelledby="staticBackdropLabel" aria-hidden="true">
+<div class="modal fade example-modal rspec-documentation-example"
+     id="modal-<%= element_id %>-side-by-side"
+     data-bs-backdrop="static"
+     data-bs-keyboard="false"
+     tabindex="-1"
+     aria-labelledby="staticBackdropLabel"
+     aria-hidden="true">
   <div class="modal-dialog modal-xl" id="modal-dialog-<%= element_id %>">
     <div class="modal-content">
       <div class="modal-header">

data/lib/templates/tabbed_spec.html.erb

@@ -1,6 +1,6 @@
 <%= RSpecDocumentation.template('modal_spec').result(binding) %>
 
-<div class="consistent-height">
+<div class="consistent-height rspec-documentation-example">
 
   <ul class="nav nav-tabs" id="html-tabs-<%= element_id %>" role="tablist">
 

data/rspec-documentation/pages/400-Dependencies.md

@@ -0,0 +1,13 @@
+# Dependencies
+
+_RSpec::Documentation_ has the following notable dependencies:
+
+|Dependency|Purpose|
+|-|-|
+| [kramdown](https://kramdown.gettalong.org/) | Converts the parsed _Markdown_ document into _HTML_. Highly flexible, allowing _RSpec::Documentation_ to inject examples into the rendered output and perform numerous customizations. |
+| [RSpec](https://rspec.info/) | Runs all examples and provides detailed output of failures. |
+| [Rouge](https://github.com/rouge-ruby/rouge) | Syntax-highlights _Ruby_, _JSON_, _XML_, and _HTML_ output in examples. |
+| [kramdown-parser-gfm](https://github.com/kramdown/parser-gfm) | Extends `kramdown` to provide _GitHub Flavored Markdown_, allowing syntax most developers are familiar with (e.g. triple-backticks for code blocks). |
+| [HTML Beautifier](https://github.com/threedaymonk/htmlbeautifier) | Re-formats output generated with the `rspec:hthml` language specifier. |
+| [Nokogiri](https://nokogiri.org/) | Re-formats output generated with the `rspec:xml` language specifier. |
+| [Paintbrush](https://docs.bob.frl/paintbrush) | String colorization used in various outputs. |

data/rspec-documentation.gemspec

@@ -33,7 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'kramdown-parser-gfm', '~> 1.1'
   spec.add_runtime_dependency 'nokogiri', '~> 1.15'
   spec.add_runtime_dependency 'paintbrush', '~> 0.1.3'
-  spec.add_runtime_dependency 'redcarpet', '~> 3.6'
   spec.add_runtime_dependency 'rouge', '~> 4.1'
   spec.add_runtime_dependency 'rspec', '~> 3.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-documentation
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-21 00:00:00.000000000 Z
+date: 2023-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.3
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
@@ -155,7 +141,6 @@ files:
 - lib/rspec_documentation/html_element.rb
 - lib/rspec_documentation/javascript_bundle.rb
 - lib/rspec_documentation/kramdown_html_converter.rb
-- lib/rspec_documentation/markdown_renderer.rb
 - lib/rspec_documentation/page_collection.rb
 - lib/rspec_documentation/page_tree.rb
 - lib/rspec_documentation/page_tree_element.rb
@@ -240,6 +225,7 @@ files:
 - rspec-documentation/pages/060-Configuration/Table of Contents.md
 - rspec-documentation/pages/070-Publishing.md
 - rspec-documentation/pages/080-Rubocop.md
+- rspec-documentation/pages/400-Dependencies.md
 - rspec-documentation/pages/500-License.md
 - rspec-documentation/spec_helper.rb
 - sig/rspec/documentation.rbs

data/lib/rspec_documentation/markdown_renderer.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecDocumentation
-  class MarkdownRenderer < Redcarpet::Render::HTML
-    include Rouge::Plugins::Redcarpet
-  end
-end