bridgetown_linkchecker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33912af51a7920e56eac3959a4807ab958547cd5f12e342bb86c33e70abf68cb
+  data.tar.gz: f997cdfd3f301ce45fc9106a825c3784f754fc856ff0c8efb10324a7804718e1
+SHA512:
+  metadata.gz: bb88ca5d7a31b966800a2a89f8c0eabd8d8896bf2b0acb623c3fd81f90c0f3a5cc6ed865b73782345f096e8b4a691131dbf357873af50d322cc614f88fa24427
+  data.tar.gz: ef9a56f06e7cc02bcc7a6b56b5ba5a38e4a5b5b00af143de860a7d2c7bae2230ca8c7c62938fb459290363b755e56c4ff7c9b2d93f17b1eb414dade492f9aee8

data/.github/workflows/tests.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - "*"
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: [2.7.7, 3.0.5, 3.1.3, 3.2.0]
+        bridgetown_version: [1.2.0]
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    # Has to be top level to cache properly
+    env:
+      BUNDLE_JOBS: 3
+      BUNDLE_PATH: "vendor/bundle"
+      BRIDGETOWN_VERSION: ${{ matrix.bridgetown_version }}
+    steps:
+      - uses: actions/checkout@master
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+      - name: Test with Rake
+        run: script/cibuild

data/.gitignore

@@ -0,0 +1,40 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+test/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack
+
+.env

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+  Exclude:
+    - .gitignore
+    - .rubocop.yml
+    - "*.gemspec"
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+    - Rakefile
+    - bridgetown.automation.rb
+
+    - script/**/*
+    - test/fixtures/**/*
+    - vendor/**/*

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+- ...
+
+## [0.1.0] - 2023-08-22
+
+- First version

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
+gem "nokogiri"
+
+group :test do
+  gem "minitest"
+  gem "minitest-profile"
+  gem "minitest-reporters"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present
+
+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,30 @@
+# Linkchecker plugin for Bridgetown
+
+A Bridgetown plugin to check for broken links in your site.
+
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+bundle add bridgetown_linkchecker
+```
+
+Then add the initializer to your configuration in `config/initializers.rb`:
+
+```ruby
+init :bridgetown_linkchecker
+```
+
+## Usage
+
+The plugin will automatically run when you run `bridgetown build` or `bridgetown serve`.
+
+## Contributing
+
+1. Fork it (https://github.com/username/my-awesome-plugin/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
+end
+
+task :default => :test

data/bridgetown.automation.rb

@@ -0,0 +1,51 @@
+# If your plugin requires a lot of steps to get set up, consider writing an automation to help guide users.
+# You could set up and configure all sorts of things, for example:
+#
+# add_gem("my_plugin")
+#
+# add_yarn_for_gem("my_plugin")
+#
+# add_initializer :"my_plugin" do
+#   <<~RUBY
+#     do
+#       some_config_key 12345
+#     end
+#   RUBY
+# end
+#
+# create_builder "my_nifty_builder.rb" do
+#   <<~RUBY
+#     class MyNeatBuilder < SiteBuilder
+#       def build
+#         puts MyPlugin.hello
+#       end
+#     end
+#   RUBY
+# end
+#
+# javascript_import do
+#   <<~JS
+#     import { MyPlugin } from "my_plugin"
+#   JS
+# end
+#
+# javascript_import 'import "my_plugin/frontend/styles/index.css"'
+#
+# create_file "src/_data/plugin_data.yml" do
+#   <<~YAML
+#     data:
+#       goes: here
+#   YAML
+# end
+#
+# color = ask("What's your favorite color?")
+#
+# append_to_file "bridgetown.config.yml" do
+#   <<~YAML
+#
+#     my_plugin:
+#       favorite_color: #{color}
+#   YAML
+# end
+#
+# Read the Automations documentation: https://www.bridgetownrb.com/docs/automations

data/bridgetown_linkchecker.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown_linkchecker/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "bridgetown_linkchecker"
+  spec.version = BridgetownLinkchecker::VERSION
+  spec.author = "Lars Peters"
+  spec.email = "lp@itpeters.com"
+  spec.summary = "Checks for broken links in your Bridgetown site."
+  spec.homepage = "https://github.com/lape/bridgetown_linkchecker"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|script|spec|features|frontend)/}) }
+  spec.require_paths = ["lib"]
+  # Uncomment this if you wish to supply a companion NPM package:
+  # spec.metadata      = { "yarn-add" => "bridgetown_linkchecker@#{BridgetownLinkchecker::VERSION}" }
+
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.add_dependency "bridgetown", ">= 1.2.0", "< 2.0"
+  spec.add_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.3"
+end

data/content/.keep

@@ -0,0 +1 @@
+l

data/lib/bridgetown_linkchecker/builder.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module BridgetownLinkchecker
+  class Builder < Bridgetown::Builder
+    def build
+      hook :posts, :post_render do |post|
+        # Parse the HTML content with Nokogiri
+        parsed_document = Nokogiri::HTML(post.content)
+
+        # Extract the href attributes from all the <a> tags
+        links = parsed_document.css("a").filter_map { |link| link["href"] }
+        links.each do |link|
+          # Check if the link is an external link
+          if link.start_with?("http") && !link_valid?(link)
+            Bridgetown.logger.info "Broken link:", "❌ #{link} (on '#{post.data["title"]}')"
+          end
+        end
+      end
+    end
+
+    def link_valid?(link)
+      uri = URI.parse(link.strip)
+      request = Net::HTTP.new(uri.host, uri.port)
+      request.use_ssl = (uri.scheme == "https")
+      path = uri.path unless uri.path.empty?
+      response = request.request_head(path || "/")
+      response_code = response.code.to_i
+      [200, 301].include?(response_code)
+    rescue StandardError
+      false
+    end
+  end
+end

data/lib/bridgetown_linkchecker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BridgetownLinkchecker
+  VERSION = "0.1.0"
+end

data/lib/bridgetown_linkchecker.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "bridgetown_linkchecker/builder"
+
+# @param config [Bridgetown::Configuration::ConfigurationDSL]
+Bridgetown.initializer :bridgetown_linkchecker do |config|
+  # Add code here which will run when a site includes
+  # `init :bridgetown_linkchecker`
+  # in its configuration
+
+  # Add default configuration data:
+  config.bridgetown_linkchecker ||= {}
+  config.bridgetown_linkchecker.my_setting ||= 123
+
+  # Register your builder:
+  config.builder BridgetownLinkchecker::Builder
+
+  # You can optionally supply a source manifest:
+  config.source_manifest(
+    origin: BridgetownLinkchecker,
+    components: File.expand_path("../components", __dir__),
+    layouts: File.expand_path("../layouts", __dir__),
+    content: File.expand_path("../content", __dir__)
+  )
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown_linkchecker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lars Peters
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description:
+email: lp@itpeters.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown.automation.rb
+- bridgetown_linkchecker.gemspec
+- content/.keep
+- lib/bridgetown_linkchecker.rb
+- lib/bridgetown_linkchecker/builder.rb
+- lib/bridgetown_linkchecker/version.rb
+homepage: https://github.com/lape/bridgetown_linkchecker
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.17
+signing_key:
+specification_version: 4
+summary: Checks for broken links in your Bridgetown site.
+test_files: []