html-proofer-unrendered-markdown 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bcaedb6cbdc6a1d0e3acba5bf8c65fb5ec359de852a0c8efae0957794252c49
+  data.tar.gz: 38603c47d58355bc9b55e2ceffe8618acdae0a45de5fed87f07e5470a8425676
+SHA512:
+  metadata.gz: 1e7831ff8308ee8c5bf3a39757c18069d9ee5f9d05c82337126b049d3ee9575f8e2717774a9800dd33df3ddfc279a4305ec7d42ec8a2681964bf66490b87cb59
+  data.tar.gz: 6f9c2f88392af2ae9b0739f217bf52659e32084890facbddcd9c227fd0f849d3f8c7b9042368106faf69e55e3d504d7074b0193eb5fd7840c336ac11d45bee69

data/.docker/Dockerfile

@@ -0,0 +1,9 @@
+FROM ruby:2.6
+
+WORKDIR /gem
+COPY . /gem
+RUN gem install bundler
+RUN bundle install
+
+# Start the main process.
+CMD ["rake"]

data/.github/workflows/ruby_publish.yml

@@ -0,0 +1,120 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches:
+    - '*'
+    tags:
+    - '*'
+  pull_request:
+
+jobs:
+  build:
+    name: Build, Test and Publish Ruby Gem
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+
+    - name: Fetch all history for all tags and branches
+      run: |
+        git fetch --prune --tags --force
+        echo "REF: ${{ github.ref }}"
+
+    - name: Install GitVersion
+      uses: gittools/actions/gitversion/setup@v0.9.2
+      if: startsWith(github.ref, 'refs/tags/') != true # Only use GitVersion for unstable builds
+      with:
+        versionSpec: '5.2.x'
+
+    - name: Execute GitVersion
+      id: gitversion
+      if: startsWith(github.ref, 'refs/tags/') != true
+      uses: gittools/actions/gitversion/execute@v0.9.2
+
+    - name: Create gem version number
+      id: gemversion
+      uses: actions/github-script@0.9.0
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        script: |
+          const gemVersion = (function() {
+            const ref = '${{ github.ref }}';
+            const tagPrefix = 'refs/tags/';
+
+            if (ref.startsWith(tagPrefix)) {
+              // If a tag ref is being built, just return the tag verbatim
+              return ref.substring(tagPrefix.length);
+            }
+
+            return '${{ steps.gitversion.outputs.legacySemVerPadded }}';
+          })();
+
+          core.setOutput('version', gemVersion);
+
+    - name: Test with Rake
+      env:
+        GEM_VERSION: ${{ steps.gemversion.outputs.version }}
+      run: |
+        docker-compose up --build
+
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Cache dependencies
+      uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: ${{ runner.os }}-gems-
+
+    - name: Bundle install
+      run: |
+        gem install bundler
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+
+    - name: Build gem
+      id: gem
+      env:
+        GEM_VERSION: ${{ steps.gemversion.outputs.version }}
+      run: |
+        GEM_BUILD_NAME=$(gem build html-proofer-unrendered-markdown.gemspec | awk '/File/ {print $2}')
+        echo "Gem filename: '${GEM_BUILD_NAME}'"
+        echo "::set-output name=name::${GEM_BUILD_NAME}"
+
+    - name: Upload artifact
+      uses: actions/upload-artifact@v2-preview
+      with:
+        name: ${{ steps.gem.outputs.name }}
+        path: ${{ steps.gem.outputs.name }}
+
+    - name: Publish to GPR
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        OWNER: SwedbankPay
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: Bearer ${GITHUB_TOKEN}\n" > $HOME/.gem/credentials
+        set -e
+        gem push --KEY github \
+                 --host https://rubygems.pkg.github.com/${OWNER} \
+                 ${{ steps.gem.outputs.name }} \
+          || echo "push failed ($?) probably due to version '${{ steps.gemversion.outputs.version }}' already existing in GPR."
+
+    - name: Publish to RubyGems
+      if: startsWith(github.ref, 'refs/tags/') # Only publish tagged commits
+      env:
+        RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+        gem push ${{ steps.gem.outputs.name }}

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at daniel.granerud@payex.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in html-proofer-unrendered-markdown.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    html-proofer-unrendered-markdown (0.0.1.pre.INVALID)
+      html-proofer (~> 3.0, >= 3.15.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    diff-lcs (1.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.12.2)
+    ffi (1.12.2-x64-mingw32)
+    html-proofer (3.15.3)
+      addressable (~> 2.3)
+      mercenary (~> 0.3)
+      nokogumbo (~> 2.0)
+      parallel (~> 1.3)
+      rainbow (~> 3.0)
+      typhoeus (~> 1.3)
+      yell (~> 2.0)
+    mercenary (0.4.0)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    nokogiri (1.10.9-x64-mingw32)
+      mini_portile2 (~> 2.4.0)
+    nokogumbo (2.0.2)
+      nokogiri (~> 1.8, >= 1.8.4)
+    parallel (1.19.1)
+    public_suffix (4.0.4)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    yell (2.2.2)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.1.4)
+  html-proofer-unrendered-markdown!
+  rake (~> 12.0)
+  rspec (~> 3.5, >= 3.5.0)
+  vcr (~> 3.0, >= 3.0.3)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Daniel Granerud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Html::Proofer::Unrendered::Markdown
+
+Adds extra html validation to html generated by Markdown documents.
+
+In this version it only checks for unrendered Markdown links, looking for
+anything that matches a `][`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'html-proofer-unrendered-markdown'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install html-proofer-unrendered-markdown
+```
+
+Add the following to your [HTML-Proofer][html-proofer] setup:
+
+```rb
+:check_unrendered_link => true
+```
+
+## Development
+
+Run docker, or run `bundle exec rake install`.
+
+To release a new version, tag the commit and push.
+
+## Contributing
+
+Bug reports and pull requests are welcome.
+
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+[code of conduct](https://github.com/swedbankpay/html-proofer-unrendered-markdown/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Html::Proofer::Unrendered::Markdown project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/html-proofer-unrendered-markdown/blob/master/CODE_OF_CONDUCT.md).
+
+[html-proofer]: https://github.com/gjtorikian/html-proofer

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "html/proofer/unrendered/markdown"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,12 @@
+version: '3.7'
+
+services:
+  checker:
+    build:
+      context: .
+      cache_from:
+        - ruby:2.6
+      dockerfile: .docker/Dockerfile
+    container_name: html_checker
+    volumes:
+      - .:/gem

data/html-proofer-unrendered-markdown.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/html/proofer/unrendered/markdown/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "html-proofer-unrendered-markdown"
+  spec.version       = Html::Proofer::Unrendered::Markdown::VERSION
+  spec.authors       = ["Daniel Granerud"]
+  spec.email         = ["daniel.granerud@payex.com"]
+
+  spec.summary       = "Adds extra validation to rendered markdown"
+  spec.homepage      = "https://github.com/SwedbankPay/html-proofer-unrendered-markdown"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "rake", "~> 12.3.1"
+  spec.add_runtime_dependency 'html-proofer', '~> 3.0', '>= 3.15.1'
+  spec.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'
+  spec.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.3'
+end

data/lib/html-proofer-unrendered-markdown.rb

@@ -0,0 +1,10 @@
+require "html/proofer/unrendered/markdown/version"
+require_relative "unrendered-link-checker"
+
+module Html
+    module Proofer
+        module Unerendered
+            class Error < StandardError; end
+        end
+    end
+end

data/lib/html/proofer/unrendered/markdown/version.rb

@@ -0,0 +1,10 @@
+module Html
+  module Proofer
+    module Unrendered
+      module Markdown
+        @version = ENV['GEM_VERSION'] || '0.0.1-INVALID'
+        VERSION = @version
+      end
+    end
+  end
+end

data/lib/unrendered-link-checker.rb

@@ -0,0 +1,10 @@
+class Chercker < ::HTMLProofer::Check
+    def run
+        return unless @options[:check_unrendered_link]
+        @html.xpath("//*[text()[contains(.,'][')]]").each do |node|
+            line = node.line
+            content = node.to_s
+            add_issue("Contains unrendered link ][! #{content}", line: line)
+          end
+    end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: html-proofer-unrendered-markdown
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Daniel Granerud
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: html-proofer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.15.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.15.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+description: 
+email:
+- daniel.granerud@payex.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".docker/Dockerfile"
+- ".github/workflows/ruby_publish.yml"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- html-proofer-unrendered-markdown.gemspec
+- lib/html-proofer-unrendered-markdown.rb
+- lib/html/proofer/unrendered/markdown/version.rb
+- lib/unrendered-link-checker.rb
+homepage: https://github.com/SwedbankPay/html-proofer-unrendered-markdown
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/SwedbankPay/html-proofer-unrendered-markdown
+  source_code_uri: https://github.com/SwedbankPay/html-proofer-unrendered-markdown
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Adds extra validation to rendered markdown
+test_files: []