rspec-rfc-helper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77bf0b42fa2165a6521a2929936cb1a1b58ab359cb19bbe19681ff7e2767d75f
-  data.tar.gz: 42e537f5b31324440b1cf98ac49a23ae1aea884cfe734e660943441ee88acafa
+  metadata.gz: 617f5c1b9bb3004b21596e44926cb45b231460685238b6cb38166935fc653b48
+  data.tar.gz: 22d66950729d05cd571547409ef29d21b7eb848b3582a643639cf4d18e8d7b60
 SHA512:
-  metadata.gz: ca6a4cd4d10c244b4d2ab310d17a4e51f831c3c2e3bb97abd984996913f19d76621de9e93bde197dfc005616a73be1684351d4c1867f6cf958502d70f4317400
-  data.tar.gz: de7b0bc373efa3875b961354733c8ce5a9fc2405447d7d98d61c336fc7380bbdf8215eb8c7228c1b7a4076b2d77f80caa7c2811b6c4486695767deb4fdf48ca2
+  metadata.gz: 7f06421f6a3105af0546cba88114e226c014074c53c0cf30c0b1d129da26656b3cf95cd6a3b58cbc78caf894967afa9f504f3bc22a7eeec28c71c36142c1946a
+  data.tar.gz: 3af8fbb4a87448bab6349a3ffdf85da3f9acc92dfe4481fd55c9772c5c7966b2a196eaf1c43efda3a9a3fb60d6c63e6feb85bad0f33ef1104aa742b897a525d0

data/CHANGELOG.md

@@ -28,6 +28,23 @@ Please, keep them in this order when updating.
 
 ## [Unreleased]
 
+## [0.2.0] - 2023-11-10 - JSON report and fixes
+
+### Added
+
+- Support for beautified JSON reports
+- Links to details in summary table
+
+### Fixed
+
+- Don't display example type when empty
+
+## [0.1.1] - 2023-11-10 - Fixes
+
+### FIXED
+- Fix missing require in Specs class file
+- Fix invalid require in usage example README
+
 ## [0.1.0] - 2023-11-07 - Initial release
 
 Initial release

data/README.md

@@ -89,7 +89,7 @@ TXT
 ```rb
 # spec_helper.rb
 
-require 'rspec-rfc-helper'
+require 'rspec/rfc-helper'
 
 RSpec.configure do |config|
   config.before(:suite) do

data/lib/rspec/rfc_helper/json_renderer.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module RSpec
+  module RfcHelper
+    ##
+    # Markdown renderer for specs
+    class JsonRenderer
+      ##
+      # @param specs [RSpec::RfcHelper::Specs]
+      def initialize(specs)
+        @specs = specs
+      end
+
+      ##
+      # Generates a report in JSON format.
+      #
+      # @return [String]
+      def render
+        json = {
+          name:     @specs.name,
+          url:      @specs.specs_url,
+          specs:    specs,
+          sections: sections,
+        }
+
+        JSON.pretty_generate json
+      end
+
+      private
+
+      ##
+      # Extracts sections informations
+      #
+      # @return [Array<Hash>]
+      def sections
+        list = []
+
+        @specs.sections.each_pair do |number, section|
+          list.push id:     section[:id],
+                    title:  section[:title],
+                    number: number,
+                    url:    section[:url]
+        end
+
+        list
+      end
+
+      ##
+      # Extracts specs and examples
+      #
+      # @return [Array<Hash>]
+      def specs
+        list = []
+        @specs.specs.each do |spec|
+          list.push id:       spec.id,
+                    section:  spec.section,
+                    verb:     spec.verb,
+                    text:     spec.text,
+                    examples: examples(spec)
+        end
+
+        list
+      end
+
+      ##
+      # Extracts examples statuses from a spec
+      #
+      # @param spec [RSpec::RfcHelper::Spec]
+      #
+      # @return [Array<Hash>]
+      def examples(spec)
+        list = []
+        spec.examples.each do |example|
+          meta = example.metadata
+          list.push status:   meta[:last_run_status],
+                    type:     meta[:type],
+                    location: meta[:location]
+        end
+
+        list
+      end
+    end
+  end
+end

data/lib/rspec/rfc_helper/markdown_renderer.rb

@@ -106,15 +106,16 @@ module RSpec
       # @param spec [RSpec::RfcHelper::Spec]
       #
       # @return [String]
-      def detailed_spec_report_header(spec) # rubocop:disable Metrics/AbcSize
+      def detailed_spec_report_header(spec) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         section = "#{spec.section} - #{@specs.sections[spec.section][:title]}"
         spec_link = if @specs.sections[spec.section][:url]
                       "[#{section}](#{@specs.sections[spec.section][:url]})"
                     else
                       section
                     end
+        anchor = spec.id ? "<a id=\"#{spec.id}\"></a>" : ''
         <<~MD.chomp
-          ## #{status(spec.status, '○')} `#{spec.verb.upcase}` #{spec.id}
+          ## #{anchor}#{status(spec.status, '○')} `#{spec.verb.upcase}` #{spec.id}
 
           **Specification:** #{spec_link}
 
@@ -132,7 +133,8 @@ module RSpec
         lines = []
         spec.examples.each do |example|
           meta = example.metadata
-          lines << "| #{status(meta[:last_run_status])} | `#{meta[:type]}`: `#{meta[:location]}` |"
+          type = meta[:type] ? "`#{meta[:type]}`: " : ''
+          lines << "| #{status(meta[:last_run_status])} | #{type}`#{meta[:location]}` |"
         end
 
         return "**No related examples**\n" if lines.empty?
@@ -154,10 +156,10 @@ module RSpec
       #
       # @return [String]
       def main_table_row(spec)
-        id = spec.id ? "`#{spec.id}`" : ''
         section = @specs.sections[spec.section]
         section_link = section[:url] ? "[#{spec.section}](#{section[:url]})" : spec.section
-        "| #{status(spec.status)} | #{id} | #{section_link} | #{spec.verb} | #{paragraph(spec.text)} |"
+        id_link = spec.id ? "[`#{spec.id}`](##{spec.id})" : ''
+        "| #{status(spec.status)} | #{id_link} | #{section_link} | #{spec.verb} | #{paragraph(spec.text)} |"
       end
 
       ##

data/lib/rspec/rfc_helper/specs.rb

@@ -3,13 +3,15 @@
 require 'yaml'
 
 require_relative 'spec'
+require_relative 'markdown_renderer'
+require_relative 'json_renderer'
 
 module RSpec
   module RfcHelper
     ##
     # Spec collection
     class Specs
-      attr_reader :name, :specs_url, :sections
+      attr_reader :name, :specs_url, :sections, :specs
 
       ##
       # Instantiates a Spec collection from a YAML file.
@@ -123,6 +125,14 @@ module RSpec
         File.write file, RSpec::RfcHelper::MarkdownRenderer.new(self).render
       end
 
+      ##
+      # Saves the report in JSON
+      #
+      # @param file [String] Output file path
+      def save_json_report(file)
+        File.write file, RSpec::RfcHelper::JsonRenderer.new(self).render
+      end
+
       private
 
       ##

data/lib/rspec/rfc_helper/version.rb

@@ -2,6 +2,6 @@
 
 module Rspec
   module RfcHelper
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/rspec/rfc_helper.rb

@@ -30,5 +30,11 @@ module RSpec
 
       @specs.save_markdown_report file
     end
+
+    def self.save_json_report(file)
+      raise 'Did you start?' unless @specs
+
+      @specs.save_json_report file
+    end
   end
 end

data/report.md

@@ -1,32 +1,32 @@
 # Compliance status: RSpec RFC Helper
 
-Report generated on 2023-11-07 22:11:05 +0100
+Report generated on 2023-11-15 11:30:49 +0100
 
 Source specification: [https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blob/main/specification_example.md](https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blob/main/specification_example.md)
 
 | status | id | section | verb | text |
 |-------:|---:|---------|------|------|
-| <span style='color: green'>pass</span> | `features__have_version` | 2.1 | must | The RFC Helper <mark>MUST</mark> have a version number |
-| <span style='color: green'>pass</span> | `features__can_define_spec` | 2.1 | must | The RFC Helper <mark>MUST</mark> have methods to define specs that needs to be enforced and tracked. |
-| <span style='color: gray'>unknown</span> | `features__wrap_verbs` | 2.1 | must | To tackle this issue, the text used in a spec defined for the RFC Helper <mark>MUST</mark> wrap the right verb in the relevant  <br> paragraph into double square brackets, like, for example `<mark>VERB</mark>`. The same paragraph MAY be used in multiple specs, <br> with everytime a different verb wrapper. <br>  |
-| <span style='color: gray'>unknown</span> | `features__use_same_paragraph_twice` | 2.1 | may | To tackle this issue, the text used in a spec defined for the RFC Helper MUST wrap the right verb in the relevant  <br> paragraph into double square brackets, like, for example `<mark>VERB</mark>`. The same paragraph <mark>MAY</mark> be used in multiple specs, <br> with everytime a different verb wrapper. <br>  |
-| <span style='color: green'>pass</span> | `features__identify_specs_with_id` | 2.1 | must | Defined specs also need to be identifiable, so a unique ID <mark>MUST</mark> be assigned to them. |
-| <span style='color: gray'>unknown</span> | `features__no_verb_means_note` | 2.1 | note | When a portion of text is interesting but has no imperative verb in it, it still can be added, and the RFC Helper will <br> give it a status of "note". <br>  |
-| <span style='color: green'>pass</span> | `reporting__rfc_tag` | 2.2 | must | Once the RFC helper is configured in a RSpec suite, it <mark>MUST</mark> handle examples tagged with the `rfc` tag. |
-| <span style='color: green'>pass</span> | `reporting__rfc_with_single_id_or_list` | 2.2 | must | The RFC helper <mark>MUST</mark> handle a single ID, as well as an array of IDs. |
-| <span style='color: green'>pass</span> | `reporting__export_method` | 2.2 | must | The RFC Helper <mark>MUST</mark> have at least one method to export the generated report in a file. |
-| <span style='color: gray'>unknown</span> | `reporting__export_date` | 2.2 | must | The report <mark>MUST</mark> contain the generation date. |
-| <span style='color: gray'>unknown</span> | `usage__two_ways` | 3 | should | To have some flexibility, the helper <mark>SHOULD</mark> be useable in two ways: using the module `RSpec::RfcHelper`, or the classes. <br>  |
-| <span style='color: gray'>unknown</span> | `usage_module__start_method` | 3.1 | must | The `RSpec::RfcHelper` <mark>MUST</mark> have a method to "start" the helper |
-| <span style='color: gray'>unknown</span> | `usage_module__handle_examples` | 3.1 | must | It <mark>MUST</mark> have a method to add examples to specs once they are evaluated |
-| <span style='color: gray'>unknown</span> | `usage_module__export_method` | 3.1 | must | it <mark>MUST</mark> have a method to save the report |
+| <span style='color: green'>pass</span> | [`features__have_version`](#features__have_version) | 2.1 | must | The RFC Helper <mark>MUST</mark> have a version number |
+| <span style='color: green'>pass</span> | [`features__can_define_spec`](#features__can_define_spec) | 2.1 | must | The RFC Helper <mark>MUST</mark> have methods to define specs that needs to be enforced and tracked. |
+| <span style='color: gray'>unknown</span> | [`features__wrap_verbs`](#features__wrap_verbs) | 2.1 | must | To tackle this issue, the text used in a spec defined for the RFC Helper <mark>MUST</mark> wrap the right verb in the relevant  <br> paragraph into double square brackets, like, for example `<mark>VERB</mark>`. The same paragraph MAY be used in multiple specs, <br> with everytime a different verb wrapper. <br>  |
+| <span style='color: gray'>unknown</span> | [`features__use_same_paragraph_twice`](#features__use_same_paragraph_twice) | 2.1 | may | To tackle this issue, the text used in a spec defined for the RFC Helper MUST wrap the right verb in the relevant  <br> paragraph into double square brackets, like, for example `<mark>VERB</mark>`. The same paragraph <mark>MAY</mark> be used in multiple specs, <br> with everytime a different verb wrapper. <br>  |
+| <span style='color: green'>pass</span> | [`features__identify_specs_with_id`](#features__identify_specs_with_id) | 2.1 | must | Defined specs also need to be identifiable, so a unique ID <mark>MUST</mark> be assigned to them. |
+| <span style='color: gray'>unknown</span> | [`features__no_verb_means_note`](#features__no_verb_means_note) | 2.1 | note | When a portion of text is interesting but has no imperative verb in it, it still can be added, and the RFC Helper will <br> give it a status of "note". <br>  |
+| <span style='color: green'>pass</span> | [`reporting__rfc_tag`](#reporting__rfc_tag) | 2.2 | must | Once the RFC helper is configured in a RSpec suite, it <mark>MUST</mark> handle examples tagged with the `rfc` tag. |
+| <span style='color: green'>pass</span> | [`reporting__rfc_with_single_id_or_list`](#reporting__rfc_with_single_id_or_list) | 2.2 | must | The RFC helper <mark>MUST</mark> handle a single ID, as well as an array of IDs. |
+| <span style='color: green'>pass</span> | [`reporting__export_method`](#reporting__export_method) | 2.2 | must | The RFC Helper <mark>MUST</mark> have at least one method to export the generated report in a file. |
+| <span style='color: gray'>unknown</span> | [`reporting__export_date`](#reporting__export_date) | 2.2 | must | The report <mark>MUST</mark> contain the generation date. |
+| <span style='color: gray'>unknown</span> | [`usage__two_ways`](#usage__two_ways) | 3 | should | To have some flexibility, the helper <mark>SHOULD</mark> be useable in two ways: using the module `RSpec::RfcHelper`, or the classes. <br>  |
+| <span style='color: gray'>unknown</span> | [`usage_module__start_method`](#usage_module__start_method) | 3.1 | must | The `RSpec::RfcHelper` <mark>MUST</mark> have a method to "start" the helper |
+| <span style='color: gray'>unknown</span> | [`usage_module__handle_examples`](#usage_module__handle_examples) | 3.1 | must | It <mark>MUST</mark> have a method to add examples to specs once they are evaluated |
+| <span style='color: gray'>unknown</span> | [`usage_module__export_method`](#usage_module__export_method) | 3.1 | must | it <mark>MUST</mark> have a method to save the report |
 | <span style='color: gray'>unknown</span> |  | 3.2 | note | The RFC Helper SHOULD be used directly by instantiating a class. |
 | <span style='color: gray'>unknown</span> |  | 3.2 | note | The instance MUST provide methods to add sections |
 | <span style='color: gray'>unknown</span> |  | 3.2 | note | The instance MUST provide methods to define the specs |
 | <span style='color: gray'>unknown</span> |  | 3.2 | note | The instance MUST provide methods to generate the report |
 | <span style='color: gray'>unknown</span> |  | 3.2 | note | The instance MAY provide methods to load sections and specs from a file |
 
-## <span style='color: green'>○</span> `MUST` features__have_version
+## <a id="features__have_version"></a><span style='color: green'>○</span> `MUST` features__have_version
 
 **Specification:** 2.1 - Features
 
@@ -36,9 +36,9 @@ Source specification: [https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blo
 
 | Status | Reference |
 |:------:|-----------|
-| <span style='color: green'>passed</span> | ``: `./spec/rspec/rfc_helper_spec.rb:4` |
+| <span style='color: green'>passed</span> | `./spec/rspec/rfc_helper_spec.rb:4` |
 
-## <span style='color: green'>○</span> `MUST` features__can_define_spec
+## <a id="features__can_define_spec"></a><span style='color: green'>○</span> `MUST` features__can_define_spec
 
 **Specification:** 2.1 - Features
 
@@ -48,10 +48,10 @@ Source specification: [https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blo
 
 | Status | Reference |
 |:------:|-----------|
-| <span style='color: green'>passed</span> | ``: `./spec/rspec/rfc_helper/spec_spec.rb:10` |
-| <span style='color: green'>passed</span> | ``: `./spec/rspec/rfc_helper/specs_spec.rb:64` |
+| <span style='color: green'>passed</span> | `./spec/rspec/rfc_helper/spec_spec.rb:10` |
+| <span style='color: green'>passed</span> | `./spec/rspec/rfc_helper/specs_spec.rb:64` |
 
-## <span style='color: gray'>○</span> `MUST` features__wrap_verbs
+## <a id="features__wrap_verbs"></a><span style='color: gray'>○</span> `MUST` features__wrap_verbs
 
 **Specification:** 2.1 - Features
 
@@ -59,7 +59,7 @@ Source specification: [https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blo
 
 **No related examples**
 
-## <span style='color: gray'>○</span> `MAY` features__use_same_paragraph_twice
+## <a id="features__use_same_paragraph_twice"></a><span style='color: gray'>○</span> `MAY` features__use_same_paragraph_twice
 
 **Specification:** 2.1 - Features
 
@@ -67,7 +67,7 @@ Source specification: [https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blo
 
 **No related examples**
 
-## <span style='color: green'>○</span> `MUST` features__identify_specs_with_id
+## <a id="features__identify_specs_with_id"></a><span style='color: green'>○</span> `MUST` features__identify_specs_with_id
 
 **Specification:** 2.1 - Features
 
@@ -77,9 +77,9 @@ Source specification: [https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blo
 
 | Status | Reference |
 |:------:|-----------|
-| <span style='color: green'>passed</span> | ``: `./spec/rspec/rfc_helper/specs_spec.rb:75` |
+| <span style='color: green'>passed</span> | `./spec/rspec/rfc_helper/specs_spec.rb:75` |
 
-## <span style='color: gray'>○</span> `NOTE` features__no_verb_means_note
+## <a id="features__no_verb_means_note"></a><span style='color: gray'>○</span> `NOTE` features__no_verb_means_note
 
 **Specification:** 2.1 - Features
 
@@ -87,7 +87,7 @@ Source specification: [https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blo
 
 **No related examples**
 
-## <span style='color: green'>○</span> `MUST` reporting__rfc_tag
+## <a id="reporting__rfc_tag"></a><span style='color: green'>○</span> `MUST` reporting__rfc_tag
 
 **Specification:** 2.2 - Reporting
 
@@ -97,9 +97,9 @@ Source specification: [https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blo
 
 | Status | Reference |
 |:------:|-----------|
-| <span style='color: green'>passed</span> | ``: `./spec/rspec/rfc_helper/specs_spec.rb:91` |
+| <span style='color: green'>passed</span> | `./spec/rspec/rfc_helper/specs_spec.rb:91` |
 
-## <span style='color: green'>○</span> `MUST` reporting__rfc_with_single_id_or_list
+## <a id="reporting__rfc_with_single_id_or_list"></a><span style='color: green'>○</span> `MUST` reporting__rfc_with_single_id_or_list
 
 **Specification:** 2.2 - Reporting
 
@@ -109,9 +109,9 @@ Source specification: [https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blo
 
 | Status | Reference |
 |:------:|-----------|
-| <span style='color: green'>passed</span> | ``: `./spec/rspec/rfc_helper/specs_spec.rb:91` |
+| <span style='color: green'>passed</span> | `./spec/rspec/rfc_helper/specs_spec.rb:91` |
 
-## <span style='color: green'>○</span> `MUST` reporting__export_method
+## <a id="reporting__export_method"></a><span style='color: green'>○</span> `MUST` reporting__export_method
 
 **Specification:** 2.2 - Reporting
 
@@ -121,9 +121,9 @@ Source specification: [https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blo
 
 | Status | Reference |
 |:------:|-----------|
-| <span style='color: green'>passed</span> | ``: `./spec/rspec/rfc_helper/specs_spec.rb:103` |
+| <span style='color: green'>passed</span> | `./spec/rspec/rfc_helper/specs_spec.rb:103` |
 
-## <span style='color: gray'>○</span> `MUST` reporting__export_date
+## <a id="reporting__export_date"></a><span style='color: gray'>○</span> `MUST` reporting__export_date
 
 **Specification:** 2.2 - Reporting
 
@@ -131,7 +131,7 @@ Source specification: [https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blo
 
 **No related examples**
 
-## <span style='color: gray'>○</span> `SHOULD` usage__two_ways
+## <a id="usage__two_ways"></a><span style='color: gray'>○</span> `SHOULD` usage__two_ways
 
 **Specification:** 3 - Usage
 
@@ -139,7 +139,7 @@ Source specification: [https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blo
 
 **No related examples**
 
-## <span style='color: gray'>○</span> `MUST` usage_module__start_method
+## <a id="usage_module__start_method"></a><span style='color: gray'>○</span> `MUST` usage_module__start_method
 
 **Specification:** 3.1 - Using the module
 
@@ -147,7 +147,7 @@ Source specification: [https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blo
 
 **No related examples**
 
-## <span style='color: gray'>○</span> `MUST` usage_module__handle_examples
+## <a id="usage_module__handle_examples"></a><span style='color: gray'>○</span> `MUST` usage_module__handle_examples
 
 **Specification:** 3.1 - Using the module
 
@@ -155,7 +155,7 @@ Source specification: [https://gitlab.com/experimentslabs/rspec-rfc-helper/-/blo
 
 **No related examples**
 
-## <span style='color: gray'>○</span> `MUST` usage_module__export_method
+## <a id="usage_module__export_method"></a><span style='color: gray'>○</span> `MUST` usage_module__export_method
 
 **Specification:** 3.1 - Using the module
 

data/sig/rspec/rfc_helper/json_renderer.rbs

@@ -0,0 +1,12 @@
+module RSpec
+  module RfcHelper
+    class JsonRenderer
+      @specs: Specs
+
+      def examples: -> Array[Hash[Symbol, untyped]]
+      def render: -> String
+      def sections: -> Array[Hash[Symbol, untyped]]
+      def specs: -> Array[Hash[Symbol, untyped]]
+    end
+  end
+end

data/sig/rspec/rfc_helper/specs.rbs

@@ -18,6 +18,7 @@ module RSpec
       def each: -> void
       def find: -> Spec
       def ids: -> Array[Symbol]
+      def save_json_report: -> void
       def save_markdown_report: -> void
       def section_id: -> Symbol
     end

data/sig/rspec/rfc_helper.rbs

@@ -7,6 +7,8 @@ module RSpec
 
     def self.add_example: -> void
     def self.load_specs: -> void
+    def self.save_json_report: -> untyped
+    def self.save_markdown_report: -> untyped
     def self.start_from_file: -> void
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rfc-helper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-07 00:00:00.000000000 Z
+date: 2023-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -40,12 +40,14 @@ files:
 - README.md
 - Rakefile
 - lib/rspec/rfc_helper.rb
+- lib/rspec/rfc_helper/json_renderer.rb
 - lib/rspec/rfc_helper/markdown_renderer.rb
 - lib/rspec/rfc_helper/spec.rb
 - lib/rspec/rfc_helper/specs.rb
 - lib/rspec/rfc_helper/version.rb
 - report.md
 - sig/rspec/rfc_helper.rbs
+- sig/rspec/rfc_helper/json_renderer.rbs
 - sig/rspec/rfc_helper/markdown_renderer.rbs
 - sig/rspec/rfc_helper/spec.rbs
 - sig/rspec/rfc_helper/specs.rbs