rspec-documentation 0.0.2 → 0.0.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-documentation
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-26 00:00:00.000000000 Z
+date: 2023-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -128,28 +128,46 @@ files:
 - lib/rspec/documentation.rb
 - lib/rspec/documentation/version.rb
 - lib/rspec_documentation.rb
-- lib/rspec_documentation/ansi_html.rb
 - lib/rspec_documentation/configuration.rb
-- lib/rspec_documentation/context.rb
 - lib/rspec_documentation/document.rb
+- lib/rspec_documentation/documentation.rb
+- lib/rspec_documentation/formatters.rb
+- lib/rspec_documentation/formatters/ansi.rb
+- lib/rspec_documentation/formatters/html.rb
+- lib/rspec_documentation/formatters/json.rb
+- lib/rspec_documentation/formatters/ruby.rb
+- lib/rspec_documentation/formatters/yaml.rb
 - lib/rspec_documentation/html_element.rb
+- lib/rspec_documentation/javascript_bundle.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
 - lib/rspec_documentation/parsed_document.rb
+- lib/rspec_documentation/project_initialization.rb
 - lib/rspec_documentation/rspec.rb
-- lib/rspec_documentation/rspec/example_group.rb
 - lib/rspec_documentation/rspec/failure.rb
-- lib/rspec_documentation/rspec/reporter.rb
 - lib/rspec_documentation/spec.rb
+- lib/rspec_documentation/stylesheet_bundle.rb
+- lib/rspec_documentation/summary.rb
 - lib/rspec_documentation/util.rb
 - lib/tasks/rspec/documentation/generate.rake
+- lib/templates/000-Introduction.md.erb
+- lib/templates/010-Usage.md.erb
+- lib/templates/500-License.md.erb
+- lib/templates/bootstrap.js.erb
 - lib/templates/footer.html.erb
 - lib/templates/header.html.erb
 - lib/templates/layout.css.erb
 - lib/templates/layout.html.erb
+- lib/templates/layout.js.erb
+- lib/templates/modal_spec.html.erb
+- lib/templates/moon.svg.erb
+- lib/templates/script_tags.html.erb
+- lib/templates/stylesheet_links.html.erb
+- lib/templates/sun.svg.erb
 - lib/templates/tabbed_spec.html.erb
+- lib/templates/themes/bootstrap.min.css
 - lib/templates/themes/cerulean.css
 - lib/templates/themes/cosmo.css
 - lib/templates/themes/cyborg.css
@@ -178,14 +196,30 @@ 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/010-File System.md
 - rspec-documentation/pages/010-File System/000-Ordering.md
-- rspec-documentation/pages/010-File System/010-Standalone Directories.md
-- rspec-documentation/pages/010-File System/020-Standalone Directory/Example Page.md
-- rspec-documentation/pages/020-Running Specs.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/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/040-Spec Helper.md
+- rspec-documentation/pages/050-Linking.md
+- rspec-documentation/pages/060-Configuration.md
+- rspec-documentation/pages/060-Configuration/010-Context.md
+- rspec-documentation/pages/060-Configuration/020-Build Paths.md
+- rspec-documentation/pages/060-Configuration/030-Attribution.md
+- rspec-documentation/pages/070-Publishing.md
+- rspec-documentation/pages/500-License.md
+- rspec-documentation/spec_helper.rb
 - sig/rspec/documentation.rbs
 homepage: https://github.com/bobf/rspec-documentation
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/bobf/rspec-documentation
   source_code_uri: https://github.com/bobf/rspec-documentation

data/lib/rspec_documentation/ansi_html.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecDocumentation
-  # Outputs a string containing ANSI color code escape sequences into HTML with attached classes
-  # for each matched color code. Cleans any remaining escape codes.
-  class AnsiHTML
-    COLOR_CODES = [0, 1, 2, 3, 4, 5, 6, 7, 9].freeze
-
-    def initialize(content)
-      @content = content
-    end
-
-    def render
-      "<div class='ansi-html border m-1 p-4'><span>#{subbed_content}</span></div>"
-    end
-
-    private
-
-    attr_reader :content
-
-    def subbed_content
-      COLOR_CODES.reduce(content) do |string, color_code|
-        string.gsub("\e[3#{color_code}m", "</span><span class='ansi-color-#{color_code}'>")
-              .gsub("\e[0m", "</span><span class='ansi-color-reset'>")
-      end.gsub(/\e\[[0-9]+m/, '')
-    end
-  end
-end

data/lib/rspec_documentation/context.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecDocumentation
-  # Used to fetch missing methods called in examples, provides a context available to all
-  # examples to avoid repeated setup in each example. Usage:
-  #
-  # ```ruby
-  # RSpec::Documentation.configure do |config|
-  #   config.context do |context|
-  #     context.my_value = 'example value'
-  #   end
-  # end
-  # ```
-  #
-  # `my_value` will now be available in every example.
-  class Context
-    def initialize
-      @context = {}
-    end
-
-    private
-
-    def method_missing(key, *args, &block)
-      return _assign(key, *args, &block) if key.to_s.end_with?('=')
-      return super unless @context.key?(key)
-
-      @context.fetch(key)
-    end
-
-    def respond_to_missing?(_key, *_)
-      true
-    end
-
-    def _assign(key, *args, &block)
-      key = key.to_s.rpartition('=').first.to_sym
-
-      @context[key] = if block_given?
-                        block
-                      else
-                        args.first
-                      end
-    end
-  end
-end

data/lib/rspec_documentation/rspec/example_group.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecDocumentation
-  module RSpec
-    # Replicates behaviour of a regular RSpec example group but also defines `it_documents` as an
-    # alias for `it`.
-    class ExampleGroup < ::RSpec::Core::ExampleGroup
-      def self.it_documents(described_object, &block)
-        raise Error, 'Must pass an example object to `it_documents`' if described_object.nil?
-
-        metadata = { described_object: described_object }
-        ::RSpec::Core::Example.new(self, 'documentation', metadata, block)
-      end
-
-      class << self
-        def method_missing(...)
-          RSpecDocumentation.context.public_send(...)
-        end
-
-        def respond_to_missing?(*args)
-          RSpecDocumentation.context.respond_to_missing?(*args)
-        end
-      end
-    end
-  end
-end

data/lib/rspec_documentation/rspec/reporter.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecDocumentation
-  module RSpec
-    # RSpec reporter, compliant with RSpec::Core::Reporter. Stores outcomes of specs.
-    class Reporter
-      attr_reader :passed_examples, :failed_examples
-
-      def initialize
-        @passed_examples = []
-        @failed_examples = []
-      end
-
-      def described_object
-        raise Error, 'Code block did not contain an example.' if passed_examples.empty? && failed_examples.empty?
-
-        passed_examples&.first&.metadata&.fetch(:described_object)
-      end
-
-      def report(*_); end
-
-      def finish(*_); end
-
-      def example_passed(example)
-        raise Error, 'Cannot define more than one example per code block.' if passed_examples.size >= 1
-
-        passed_examples << example
-      end
-
-      def example_group_started(*_); end
-
-      def example_group_finished(*_); end
-
-      def example_started(*_); end
-
-      def example_finished(*_); end
-
-      def example_failed(example)
-        failed_examples << example
-      end
-
-      def fail_fast_limit_met?(*_); end
-    end
-  end
-end

data/rspec-documentation/pages/010-File System/010-Standalone Directories.md

@@ -1,17 +0,0 @@
-# Standalone Directories
-
-In most cases you will likely want each node on the tree to link to some content, but if you simply want to add a node to group together some other pages then create a directory without adding a matching _Markdown_ `.md` file.
-
-```
-rspec-documentation/
-└── pages/
-    ├── 000-Introduction.md
-    ├── 010-File System/
-    │   ├── 000-Ordering.md
-    │   ├── 010-Standalone Directories.md
-    │   └── 020-Standalone Directory/
-    │       └── Example Page.md
-    └── 010-File System.md
-```
-
-You can see this example standalone directory in the documentation tree on this page.

data/rspec-documentation/pages/010-File System/020-Standalone Directory/Example Page.md

@@ -1,3 +0,0 @@
-# Example Page
-
-Demonstrating standalone directories containing more `.md` files.

data/rspec-documentation/pages/020-Running Specs.md

@@ -1,11 +0,0 @@
-# Running Specs
-
-To run your test suite, just call the provided `rspec-documentation` command from your project directory:
-
-```console
-$ exe/rspec-documentation
-
-  Created 5 pages.
-
-  View your documentation here: /home/bob/dev/rspec-documentation/rspec-documentation/bundle/introduction.html
-```