jekyll-respec 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 390de02b24f08210acec16cd074100bdf7c79455d722a54bc7725d5480079a36
+  data.tar.gz: fd189212e56c551b07045a165763c0dccd320e0c804b7cbe89cca9b05250bbb9
+SHA512:
+  metadata.gz: b50427170d4f82fdd031b27399c200b649be46c42203f8e3085bdb67b727b7485cf891b641c6b59956106f3457e048427de856a498380212a79d5577bd605cf0
+  data.tar.gz: 53e9fcd353a0a70e36cf65f135b54fae1db8dad767ad7c59372f3412b8d8a9d392f78f26a6c762101f5bc309a9dcc1b296fcb4648438726eac4bc95a265112c7

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "jekyll"

data/jekyll-respec.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# coding: utf-8
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-respec/version"
+
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = "2.2.2"
+  s.required_ruby_version = ">= 2.1.0"
+
+  s.name          = "jekyll-respec"
+  s.version       = Jekyll::Respec::VERSION
+  s.license       = "MIT"
+
+  s.summary       = "Convert markdown to HTML respec."
+
+  s.authors       = ["Ludovic Roux"]
+  s.email         = "ludovic.roux@cosmosoftware.io"
+  s.homepage      = "https://github.com/jekyll/jekyll-respec"
+
+  # all_files       = `git ls-files -z`.split("\x0")
+  s.files         = Dir["lib/**/*"]
+  s.require_paths = ["lib"]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w(README.md LICENSE Gemfile jekyll-respec.gemspec)
+
+  s.add_runtime_dependency("kramdown-respec", "~> 0.0")
+end

data/lib/converters/markdown-respec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'jekyll/converters/markdown'
+
+module Jekyll
+  module Converters
+    # Markdown converter.
+    # For more info on converters see https://jekyllrb.com/docs/plugins/converters/
+    class Markdown < Converter
+
+      # Rubocop does not allow reader methods to have names starting with `get_`
+      # To ensure compatibility, this check has been disabled on this method
+      #
+      # rubocop:disable Naming/AccessorMethodName
+      def get_processor
+        case @config["markdown"].downcase
+        when "redcarpet" then return RedcarpetParser.new(@config)
+        when "kramdown"  then return KramdownParser.new(@config)
+        when "rdiscount" then return RDiscountParser.new(@config)
+        when "kramdown-respec" then KramdownRespecParser.new(@config)
+        else
+          custom_processor
+        end
+      end
+
+      # Public: Provides you with a list of processors, the ones we
+      # support internally and the ones that you have provided to us (if you
+      # are not in safe mode.)
+
+      def valid_processors
+        %w(rdiscount kramdown kramdown-respec redcarpet) + third_party_processors
+      end
+
+    end
+  end
+end

data/lib/converters/markdown/kramdownrespec-parser.rb

@@ -0,0 +1,109 @@
+# Frozen-string-literal: true
+
+module Jekyll
+  module Converters
+    class Markdown
+      class KramdownRespecParser < KramdownParser
+
+        def initialize(config)
+          # super
+          unless defined?(KramdownRespec)
+            Jekyll::External.require_with_graceful_fail "kramdown-respec"
+          end
+          @main_fallback_highlighter = config["highlighter"] || "rouge"
+          @config = config["kramdown-respec"] || {}
+          @highlighter = nil
+          # setup
+        end
+
+        def convert(content)
+          document = Kramdown::Document.new(content, @config)
+          html_output = document.to_html
+          if @config["show_warnings"]
+            document.warnings.each do |warning|
+              Jekyll.logger.warn "Kramdown warning:", warning
+            end
+          end
+          html_output
+        end
+
+        private
+        # rubocop:disable Performance/HashEachMethods
+        def make_accessible(hash = @config)
+          hash.keys.each do |key|
+            hash[key.to_sym] = hash[key]
+            make_accessible(hash[key]) if hash[key].is_a?(Hash)
+          end
+        end
+        # rubocop:enable Performance/HashEachMethods
+
+        # config[kramdown][syntax_higlighter] >
+        #   config[kramdown][enable_coderay] >
+        #   config[highlighter]
+        # Where `enable_coderay` is now deprecated because Kramdown
+        # supports Rouge now too.
+
+        private
+        def highlighter
+          return @highlighter if @highlighter
+
+          if @config["syntax_highlighter"]
+            return @highlighter = @config[
+              "syntax_highlighter"
+            ]
+          end
+
+          @highlighter = begin
+            if @config.key?("enable_coderay") && @config["enable_coderay"]
+              Jekyll::Deprecator.deprecation_message(
+                "You are using 'enable_coderay', " \
+                "use syntax_highlighter: coderay in your configuration file."
+              )
+
+              "coderay"
+            else
+              @main_fallback_highlighter
+            end
+          end
+        end
+
+        private
+        def strip_coderay_prefix(hash)
+          hash.each_with_object({}) do |(key, val), hsh|
+            cleaned_key = key.to_s.gsub(%r!\Acoderay_!, "")
+
+            if key != cleaned_key
+              Jekyll::Deprecator.deprecation_message(
+                "You are using '#{key}'. Normalizing to #{cleaned_key}."
+              )
+            end
+
+            hsh[cleaned_key] = val
+          end
+        end
+
+        # If our highlighter is CodeRay we go in to merge the CodeRay defaults
+        # with your "coderay" key if it's there, deprecating it in the
+        # process of you using it.
+
+        private
+        def modernize_coderay_config
+          unless @config["coderay"].empty?
+            Jekyll::Deprecator.deprecation_message(
+              "You are using 'kramdown.coderay' in your configuration, " \
+              "please use 'syntax_highlighter_opts' instead."
+            )
+
+            @config["syntax_highlighter_opts"] = begin
+              strip_coderay_prefix(
+                @config["syntax_highlighter_opts"] \
+                  .merge(CODERAY_DEFAULTS) \
+                  .merge(@config["coderay"])
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-respec.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'jekyll-respec/version'
+require 'converters/markdown-respec'
+require 'converters/markdown/kramdownrespec-parser'
+
+module Respec
+end

data/lib/jekyll-respec/version.rb

@@ -0,0 +1,8 @@
+
+# frozen_string_literal: true
+
+module Jekyll
+  module Respec
+    VERSION = "0.0.0"
+  end
+end

data/lib/theme_template/_layouts/default.html

@@ -0,0 +1,53 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <% if @converter.root.options[:encoding] %>
+    <meta http-equiv="Content-type" content="text/html;charset=<%= @converter.root.options[:encoding] %>">
+    <% end %>
+<%
+extend ::Kramdown::Utils::Html
+title = ''
+h = @converter.root.children.find {|c| c.type == :header}
+if h
+  collector = lambda {|c| c.children.collect {|cc| cc.type == :text ? escape_html(cc.value, :text) : collector.call(cc)}.join('')}
+  title = collector.call(h)
+end
+%>
+    <title><%= title %></title>
+    <meta name="generator" content="kramdown <%= ::Kramdown::VERSION %>" />
+    <script 
+     src='https://www.w3.org/Tools/respec/respec-w3c' 
+     class='remove' async></script>
+    <script class='remove'>
+      var respecConfig = {
+        specStatus: "ED",
+        editors: [{
+          name: "Your Name",
+          url: "https://your-site.com",
+        }],
+        gitHub: "some-org/mySpec",
+        shortName: "dahut",
+        xref: "web-platform",
+        testSuiteURI: "https://example.com/test/suite/",
+      };
+    </script>
+  </head>
+  <body>
+    <section id='abstract'>
+      <p>
+        This is required.
+      </p>
+    </section>
+    <section id='sotd'>
+      <p>
+        This is required.
+      </p>
+    </section>
+    <section id='conformance'>
+      <p>
+        This is required for specifications that contain normative material.
+      </p>
+    </section>
+    {{ content }}
+  </body>
+</html>

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-respec
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Ludovic Roux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown-respec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: 
+email: ludovic.roux@cosmosoftware.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+- Gemfile
+- jekyll-respec.gemspec
+files:
+- Gemfile
+- LICENSE
+- README.md
+- jekyll-respec.gemspec
+- lib/converters/markdown-respec.rb
+- lib/converters/markdown/kramdownrespec-parser.rb
+- lib/jekyll-respec.rb
+- lib/jekyll-respec/version.rb
+- lib/theme_template/_layouts/default.html
+homepage: https://github.com/jekyll/jekyll-respec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 2
+summary: Convert markdown to HTML respec.
+test_files: []