rspec-documentation 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a33d3b35a6feaea6cdb730424eabca522ee5592f7e944b9c751713b12c3c35d5
-  data.tar.gz: 90be4151f65ecb8e0e4a74f70c85cdae67df5d78ed31acd0cc2fa2c7da72a2f2
+  metadata.gz: 283bdf52a7ed9f190175ab2d12dc9e1d206a90b0cfdb439713e506921efb2853
+  data.tar.gz: acab855a9d1ce848cf6d11fd5662a99b61d7ac1349ac49edb46519c59e327463
 SHA512:
-  metadata.gz: f357c76176c0f5cc9a2061a51dfa3fceb59f05d75fe5173ed211dee64e1e4c07bb6309448757f1172f7b79f4b80f0c55c8fca99ca430eb17bb2b1766390ca1de
-  data.tar.gz: b5598da557e010fb880dd001297d5d7796f46b7f2f2e7bf39847eec33073402f852f14f8113474c3ba00f950ee5b53b20af2d259b584a0bd5fe23cac707591bb
+  metadata.gz: ca29bcf6ad430a865f329586db18807a8d5b2f07f545051b803ed936d4c4bf606d2b1cc554b09db575cc813b48ba6538aac000a01b047a2a76d75daafe7444f2
+  data.tar.gz: 38d5455b372da3ea5798acdd10e28c86bfec33bc4ab697417122edc3a0d7912d257b16af3c245601fdba7a20c2aad185ec15160ee2fb9b821dd6e938a6a94ce5

data/Gemfile

@@ -8,10 +8,11 @@ gemspec
 gem 'rake', '~> 13.0'
 
 gem 'devpack', '~> 0.4.1'
+gem 'nokogiri', '~> 1.15'
 gem 'rspec', '~> 3.0'
 gem 'rspec-file_fixtures', '~> 0.1.6'
 gem 'rspec-its', '~> 1.3'
-gem 'rubocop', '~> 1.51'
+gem 'rubocop', '~> 1.52'
 gem 'rubocop-rake', '~> 0.6.0'
 gem 'rubocop-rspec', '~> 2.22'
 gem 'strong_versions', '~> 0.4.5'

data/Gemfile.lock

@@ -5,6 +5,7 @@ PATH
       htmlbeautifier (~> 1.4)
       kramdown (~> 2.4)
       kramdown-parser-gfm (~> 1.1)
+      nokogiri (~> 1.15)
       paintbrush (~> 0.1.3)
       redcarpet (~> 3.6)
       rouge (~> 4.1)
@@ -25,11 +26,14 @@ GEM
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
+    nokogiri (1.15.2-x86_64-linux)
+      racc (~> 1.4)
     paint (2.3.0)
     paintbrush (0.1.3)
     parallel (1.23.0)
     parser (3.2.2.1)
       ast (~> 2.4.1)
+    racc (1.6.2)
     rainbow (3.1.1)
     rake (13.0.6)
     redcarpet (3.6.0)
@@ -54,7 +58,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.51.0)
+    rubocop (1.52.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -64,7 +68,7 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     rubocop-capybara (2.18.0)
       rubocop (~> 1.41)
@@ -87,12 +91,13 @@ PLATFORMS
 
 DEPENDENCIES
   devpack (~> 0.4.1)
+  nokogiri (~> 1.15)
   rake (~> 13.0)
   rspec (~> 3.0)
   rspec-documentation!
   rspec-file_fixtures (~> 0.1.6)
   rspec-its (~> 1.3)
-  rubocop (~> 1.51)
+  rubocop (~> 1.52)
   rubocop-rake (~> 0.6.0)
   rubocop-rspec (~> 2.22)
   strong_versions (~> 0.4.5)

data/lib/rspec/documentation/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Documentation
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

data/lib/rspec_documentation/formatters/ruby.rb

@@ -16,7 +16,9 @@ module RSpecDocumentation
       def rendered_output
         formatter = Rouge::Formatters::HTML.new
         lexer = Rouge::Lexers::Ruby.new
-        formatter.format(lexer.lex(subject.inspect))
+        io = StringIO.new
+        PP.pp(subject, io)
+        formatter.format(lexer.lex(io.string))
       end
 
       def render_raw?

data/lib/rspec_documentation/formatters/xml.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RSpecDocumentation
+  module Formatters
+    # Produces prettified XML to from an RSpec `subject` value.
+    class Xml
+      def initialize(subject:)
+        @subject = subject
+      end
+
+      def prettified_output
+        nil
+      end
+
+      def rendered_output
+        formatter = Rouge::Formatters::HTML.new
+        lexer = Rouge::Lexers::XML.new
+        formatter.format(lexer.lex(Nokogiri::XML.parse(subject).to_xml))
+      end
+
+      def render_raw?
+        false
+      end
+
+      private
+
+      attr_reader :subject
+    end
+  end
+end

data/lib/rspec_documentation/formatters.rb

@@ -5,6 +5,7 @@ require_relative 'formatters/html'
 require_relative 'formatters/ansi'
 require_relative 'formatters/json'
 require_relative 'formatters/yaml'
+require_relative 'formatters/xml'
 
 module RSpecDocumentation
   # Provides a set of formatters for rendering the value of a `subject` in an RSpec example into

data/lib/rspec_documentation/html_element.rb

@@ -47,7 +47,8 @@ module RSpecDocumentation
         html: Formatters::Html,
         ansi: Formatters::Ansi,
         json: Formatters::Json,
-        yaml: Formatters::Yaml
+        yaml: Formatters::Yaml,
+        xml: Formatters::Xml
       }.fetch(spec.format, Formatters::Ruby).new(subject: spec.subject)
     end
 

data/lib/rspec_documentation/page_collection.rb

@@ -7,7 +7,7 @@ module RSpecDocumentation
     attr_reader :failures, :page_paths
 
     def initialize(page_paths:)
-      @page_paths = page_paths.sort
+      @page_paths = page_paths.sort_by(&:to_s)
       @buffer = {}
       @failures = []
     end

data/lib/rspec_documentation/spec.rb

@@ -24,7 +24,6 @@ module RSpecDocumentation
     def subject
       raise Error, "Code block did not define an example (e.g. with `it`).\n#{spec}" if examples.empty?
       raise Error, "Code block did not define a subject:\n#{spec}" if subjects.empty?
-      raise Error, "Cannot define more than one example per code block:\n#{spec}" if subjects.size > 1
 
       subjects.last
     end
@@ -74,7 +73,7 @@ module RSpecDocumentation
       @example_group ||= binding.eval(
         <<-SPEC, __FILE__, __LINE__.to_i
           ::RSpec::Core::ExampleGroup.describe do
-            after { RSpecDocumentation::Spec.subjects << subject }
+            after { RSpecDocumentation::Spec.subjects << subject if RSpecDocumentation::Spec.subjects.empty? }
             include_context '__rspec_documentation' do
               #{spec}
             end

data/lib/rspec_documentation.rb

@@ -17,6 +17,8 @@ require 'json'
 require 'yaml'
 require 'date'
 require 'time'
+require 'pp' # rubocop:disable Lint/RedundantRequireStatement
+require 'stringio'
 
 require_relative 'rspec_documentation/rspec'
 require_relative 'rspec_documentation/util'

data/rspec-documentation/pages/000-Introduction.md

@@ -18,6 +18,6 @@ it { is_expected.to eql 'my subject' }
 ```
 ````
 
-See the [Quickstart](introduction/quickstart.html) setup guide to build your first _RSpec Documentation_ project.
+See the [Quickstart](quickstart.html) setup guide to build your first _RSpec Documentation_ project.
 
 Browse the [Examples](examples.html) to get a better idea of the typical usage patterns.

data/rspec-documentation/pages/030-Examples/{010-Basic.md → 010-Basic Usage.md }

@@ -6,7 +6,7 @@ This example uses a regular ```` ```rspec ```` code block.
 
 The spec defines a `subject`, a simple comparison is made on its value to satisfy the test, and the value of `subject` is viewable on the _Output_ tab.
 
-Any _RSpec_ test is valid, including one-liner syntax like this:
+Any _RSpec_ test that defines a `subject` is valid, including one-liner syntax like this:
 
 ### Markdown
 
@@ -25,27 +25,3 @@ subject { 'my value' }
 
 it { is_expected.to eql 'my value' }
 ```
-
-## Regular `it` blocks
-
-### Markdown
-
-````markdown
-```rspec
-subject { 'my value' }
-
-it 'contains some expected text' do
-  expect(subject).to eql 'my value'
-end
-```
-````
-
-### Output
-
-```rspec
-subject { 'my other value' }
-
-it 'contains some expected text' do
-  expect(subject).to include 'other value'
-end
-```

data/rspec-documentation/pages/030-Examples/011-Multiple Expectations.md

@@ -0,0 +1,23 @@
+# Multiple Expectations
+
+Add as many expectations as you like:
+
+## Markdown
+
+````markdown
+```rspec
+subject { 'my value' }
+
+it { is_expected.to eql 'my value' }
+it { is_expected.to be_a String }
+```
+````
+
+## Output
+
+```rspec
+subject { 'my value' }
+
+it { is_expected.to eql 'my value' }
+it { is_expected.to be_a String }
+```

data/rspec-documentation/pages/030-Examples/012-Regular it Blocks.md

@@ -0,0 +1,23 @@
+## Regular `it` blocks
+
+### Markdown
+
+````markdown
+```rspec
+subject { 'my value' }
+
+it 'contains some expected text' do
+  expect(subject).to eql 'my value'
+end
+```
+````
+
+### Output
+
+```rspec
+subject { 'my other value' }
+
+it 'contains some expected text' do
+  expect(subject).to include 'other value'
+end
+```

data/rspec-documentation/pages/030-Examples/040-JSON.md

@@ -1,6 +1,6 @@
 # JSON
 
-If your code outputs _JSON_, use the ```` ```rspec:json``` ```` formatter to prettify your _JSON_ output. Note that your code must produce a raw _JSON_ string in order to use this formatter, it does not convert _Ruby_ objects into _JSON_.
+If your code outputs _JSON_, use the ```` ```rspec:json ```` formatter to prettify your _JSON_ output. Note that your code must produce a raw _JSON_ string in order to use this formatter, it does not convert _Ruby_ objects into _JSON_.
 
 ## Markdown
 

data/rspec-documentation/pages/030-Examples/050-YAML.md

@@ -1,7 +1,6 @@
 # YAML
 
-
-If your code outputs _YAML_, use the ```` ```rspec:yaml``` ```` formatter to prettify your _YAML_ output. Note that your code must produce a raw _YAML_ string in order to use this formatter, it does not convert _Ruby_ objects into _YAML_.
+If your code outputs _YAML_, use the ```` ```rspec:yaml ```` formatter to prettify your _YAML_ output. Note that your code must produce a raw _YAML_ string in order to use this formatter, it does not convert _Ruby_ objects into _YAML_.
 
 ## Markdown
 

data/rspec-documentation/pages/030-Examples/060-XML.md

@@ -0,0 +1,25 @@
+# XML
+
+If your code outputs _XML_, use the ```` ```rspec:xml ```` formatter to prettify your _XML_ output. Note that your code must produce a raw _XML_ string in order to use this formatter, it does not convert _Ruby_ objects into _XML_.
+
+## Markdown
+
+````markdown
+```rspec:xml
+subject { '<?xml version="1.0" encoding="UTF-8"?><foo><bar>baz</bar></foo>' }
+
+it 'has expected key/value' do
+  expect(Nokogiri::XML.parse(subject).xpath('//foo/bar').text).to eql 'baz'
+end
+```
+````
+
+## Output
+
+```rspec:xml
+subject { '<?xml version="1.0" encoding="UTF-8"?><foo><bar>baz</bar></foo>' }
+
+it 'has expected key/value' do
+  expect(Nokogiri::XML.parse(subject).xpath('//foo/bar').text).to eql 'baz'
+end
+```

data/rspec-documentation/spec_helper.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'nokogiri'
+
 RSpec::Documentation.configure do |config|
   config.context do
     let(:foo) { 'baz' }

data/rspec-documentation.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'htmlbeautifier', '~> 1.4'
   spec.add_runtime_dependency 'kramdown', '~> 2.4'
   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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-documentation
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-04 00:00:00.000000000 Z
+date: 2023-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: paintbrush
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,7 @@ files:
 - lib/rspec_documentation/formatters/html.rb
 - lib/rspec_documentation/formatters/json.rb
 - lib/rspec_documentation/formatters/ruby.rb
+- lib/rspec_documentation/formatters/xml.rb
 - lib/rspec_documentation/formatters/yaml.rb
 - lib/rspec_documentation/html_element.rb
 - lib/rspec_documentation/javascript_bundle.rb
@@ -196,17 +211,20 @@ files:
 - rspec-documentation-0.1.0.gem
 - rspec-documentation.gemspec
 - rspec-documentation/pages/000-Introduction.md
-- rspec-documentation/pages/000-Introduction/000-Quickstart.md
+- rspec-documentation/pages/001-Quickstart.md
 - rspec-documentation/pages/010-File System.md
 - rspec-documentation/pages/010-File System/000-Ordering.md
 - rspec-documentation/pages/010-File System/010-Documentation Bundle.md
 - rspec-documentation/pages/020-Running Tests.md
 - rspec-documentation/pages/030-Examples.md
-- rspec-documentation/pages/030-Examples/010-Basic.md
+- rspec-documentation/pages/030-Examples/010-Basic Usage.md
+- rspec-documentation/pages/030-Examples/011-Multiple Expectations.md
+- rspec-documentation/pages/030-Examples/012-Regular it Blocks.md
 - rspec-documentation/pages/030-Examples/020-HTML.md
 - rspec-documentation/pages/030-Examples/030-ANSI.md
 - rspec-documentation/pages/030-Examples/040-JSON.md
 - rspec-documentation/pages/030-Examples/050-YAML.md
+- rspec-documentation/pages/030-Examples/060-XML.md
 - rspec-documentation/pages/040-Spec Helper.md
 - rspec-documentation/pages/050-Linking.md
 - rspec-documentation/pages/060-Configuration.md