bridgetown-plausible 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef9d4b3c76fedec78de06f8b46a922c9012cacf3ce84c28110adf96e9057e615
-  data.tar.gz: 043260ff038a709878448323b6d3c94460398fb1d15d99d7b68579f85bda2c25
+  metadata.gz: 10343f5050a55a466fe11cd10ec55761b7053e7e1a67a81108f2805c9f4f6cb7
+  data.tar.gz: 904bb7ecfaa65c5cd1a973e9f845f05bde996eabec8174788e49d1c04e05a352
 SHA512:
-  metadata.gz: c3759ae9fe192e9eb781c177b46e8a5a63168d44f0165d0b4046b8d2146c1646d78afefd9d8b7dbac2114fc904c9035573451bb96f6e92fc0a3ae2cb6f00706a
-  data.tar.gz: c6583e55413b8a4321a3b9f703d0fef1c52fc64cf1694d88fe71ed79efd06f7e35fd66b28c3ea6a7781acfc43622500c5bc09b63ea9d5faf381652b89fb77640
+  metadata.gz: 9a2f9182c506d83656ade3fb971b1d3c74b6fc5e922a4ae78c3f9e8c404799f7ee55ffc94aab502a465f8cd6523579b6e8c66efff77359ba096cf6f103735978
+  data.tar.gz: a832d653bf4cabad842bd604bd5ee7a613b8052f6ee62582318a9f9edfcd239829605929d7523a63145ee328c6994fdf00afc49260db8afa6dbccfa7d5a117c9

data/.github/workflows/lint.yml

@@ -13,13 +13,11 @@ jobs:
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, 'ci skip')"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v6
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0.0
+          ruby-version: "3.3"
+          bundler-cache: true
       - name: Run bin/lint
-        run: |
-          gem install bundler -v 2.2.7
-          bundle install
-          bin/lint
+        run: bin/lint

data/.github/workflows/release.yml

@@ -4,37 +4,34 @@ on:
   push:
     branches:
       - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
 jobs:
   release-please:
     runs-on: ubuntu-latest
     steps:
-      - uses: GoogleCloudPlatform/release-please-action@v2
+      - uses: googleapis/release-please-action@v5
         id: release
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          release-type: ruby
-          package-name: bridgetown-plausible
-          bump-minor-pre-major: true
-          version-file: "lib/bridgetown-plausible/version.rb"
-      - uses: actions/checkout@v2
+          config-file: release-please-config.json
+          manifest-file: .release-please-manifest.json
+      - uses: actions/checkout@v6
         if: ${{ steps.release.outputs.release_created }}
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0.0
+          ruby-version: "3.3"
+          bundler-cache: true
         if: ${{ steps.release.outputs.release_created }}
-      - run: |
-          gem install bundler -v 2.2.7
-          bundle install
-          bundle exec rake
+      - run: bundle exec rake
         if: ${{ steps.release.outputs.release_created }}
       - name: release gem
         run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
           gem build *.gemspec
           gem push *.gem
         env:
-          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+          GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_AUTH_TOKEN }}
         if: ${{ steps.release.outputs.release_created }}

data/.github/workflows/test.yml

@@ -9,19 +9,31 @@ on:
       - main
 
 jobs:
-  lint:
+  test:
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, 'ci skip')"
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # Bridgetown 1.3 — oldest supported, sanity-check on newest Ruby
+          - { ruby: "3.1", bridgetown: "~> 1.3.4" }
+          - { ruby: "3.3", bridgetown: "~> 1.3.4" }
+          # Bridgetown 2.0 — first 2.x line (helper/filter scoping options deprecated)
+          - { ruby: "3.2", bridgetown: "~> 2.0.0" }
+          # Bridgetown 2.1 — Active Support removed (verifies .html_safe still works)
+          - { ruby: "3.2", bridgetown: "~> 2.1.0" }
+          # Bridgetown 2.2 — current
+          - { ruby: "3.3", bridgetown: "~> 2.2.0" }
+    env:
+      BRIDGETOWN_VERSION: ${{ matrix.bridgetown }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v6
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0.0
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          cache-version: "${{ matrix.ruby }}-${{ matrix.bridgetown }}"
       - name: Run specs
-        run: |
-          gem install bundler -v 2.2.7
-          bundle install
-          rake
-        env:
-          COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+        run: bundle exec rake

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "2.0.0"
+}

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [2.0.0](https://github.com/bt-rb/bridgetown-plausible/compare/bridgetown-plausible-v1.1.0...bridgetown-plausible/v2.0.0) (2026-05-21)
+
+
+### ⚠ BREAKING CHANGES
+
+* requires init :"bridgetown-plausible"; drops Bridgetown < 1.3 support. Users on older Bridgetown should stay on bridgetown-plausible 1.1.x.
+
+### Features
+
+* make server configurable ([#11](https://github.com/bt-rb/bridgetown-plausible/issues/11)) ([5c5cd29](https://github.com/bt-rb/bridgetown-plausible/commit/5c5cd296477bee6eb6ce38e32051968291995d44))
+* support Bridgetown 2.x (and 1.3+) ([#15](https://github.com/bt-rb/bridgetown-plausible/issues/15))` ([28aa6f1](https://github.com/bt-rb/bridgetown-plausible/commit/28aa6f152d54640db0bd3eb5b59675dede49c137))
+
+
+### Bug Fixes
+
+* correct logo url ([#1](https://github.com/bt-rb/bridgetown-plausible/issues/1)) ([22db435](https://github.com/bt-rb/bridgetown-plausible/commit/22db43569e90375c1895f20c232607a93f9bf023))
+* correct test action name ([1d0526a](https://github.com/bt-rb/bridgetown-plausible/commit/1d0526a7eb1fe608dfba174b11b76490870d6dc2))
+* fix gem name in release action ([a3614df](https://github.com/bt-rb/bridgetown-plausible/commit/a3614df2cdddea6314b9baddcb697b3aa07b0c7f))
+* use correct link to repo in gemspec and render safe html ([#9](https://github.com/bt-rb/bridgetown-plausible/issues/9)) ([02e61b9](https://github.com/bt-rb/bridgetown-plausible/commit/02e61b9930240c3b2810627da1e4b357c7563b33))
+* use correct package name in automation ([#10](https://github.com/bt-rb/bridgetown-plausible/issues/10)) ([82eb300](https://github.com/bt-rb/bridgetown-plausible/commit/82eb3002ce83d822cab96cbe722c1516635fa8dc)), closes [#6](https://github.com/bt-rb/bridgetown-plausible/issues/6) [#7](https://github.com/bt-rb/bridgetown-plausible/issues/7)
+* use the correct url for the automation in our readme docs ([b2b5961](https://github.com/bt-rb/bridgetown-plausible/commit/b2b596132b4452d93cfca8e6227c82d766a8691d)), closes [#4](https://github.com/bt-rb/bridgetown-plausible/issues/4)
+
 ## [1.1.0](https://www.github.com/bt-rb/bridgetown-plausible/compare/v1.0.2...v1.1.0) (2022-09-22)
 
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020-present Andrew Mason
+Copyright (c) 2020-2026 Andrew Mason
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -6,7 +6,7 @@
 
 <p align="center">
   <a href="https://badge.fury.io/rb/bridgetown-plausible"><img src="https://badge.fury.io/rb/bridgetown-plausible.svg" alt="Gem Version" height="18"></a>
-  <img src="https://img.shields.io/github/license/bt-rb/.github">
+  <img src="https://img.shields.io/github/license/bt-rb/bridgetown-plausible" alt="license">
   <img src="https://github.com/bt-rb/bridgetown-plausible/workflows/Test/badge.svg" alt="test">
   <img src="https://github.com/bt-rb/bridgetown-plausible/workflows/Lint/badge.svg" alt="lint">
   <img src="https://github.com/bt-rb/bridgetown-plausible/workflows/Release/badge.svg" alt="release">
@@ -22,6 +22,7 @@
 - [Quickstart](#quickstart)
 - [System requirements](#system-requirements)
 - [Installation](#installation)
+- [Upgrading from 1.x](#upgrading-from-1x)
 - [Configuration](#configuration)
 - [Usage](#usage)
   - [Liquid](#liquid)
@@ -40,30 +41,56 @@ bundle exec bridgetown apply https://github.com/bt-rb/bridgetown-plausible
 
 ## System requirements
 
-- Ruby >= `2.5`
 - Bundler
-- Bridgetown >= `0.16`
+- Ruby >= `3.1`
+- Bridgetown >= `1.3` (tested against Bridgetown 1.3.x, 2.0.x, 2.1.x, and 2.2.x)
+
+Bridgetown itself sets its own Ruby floor: 1.3.x needs `>= 2.7`, 2.0.x needs `>= 3.1`, 2.1.x and 2.2.x need `>= 3.2`. This gem requires `>= 3.1` to match what we test in CI; if you need Ruby 2.7 or 3.0 on Bridgetown 1.3, stay on `bridgetown-plausible "~> 1.1"`.
 
 ## Installation
 
-Automatically add to `Gemfile`:
+Add to your `Gemfile`:
 
 ```bash
 bundle add bridgetown-plausible -g bridgetown_plugins
 ```
 
-or add manually in `Gemfile`:
+or manually:
 
 ```ruby
 group :bridgetown_plugins do
-  gem "bridgetown-plausible", "~> 1.1.0"
+  gem "bridgetown-plausible", "~> 2.0"
 end
 ```
 
-Run `bundle install` and then modify your `bridgetown.config.yml` configuration to point to your Plausible domain.
+Then configure the plugin in your `config/initializers.rb` — the recommended path is to pass your domain (and self-hosted server, if applicable) inline:
+
+```ruby
+Bridgetown.configure do |config|
+  # ...your existing config...
+
+  init :"bridgetown-plausible" do
+    domain "example.com"
+    # server "stats.example.com"  # optional, defaults to plausible.io
+  end
+end
+```
+
+Alternatively, you can configure via `bridgetown.config.yml` (see [Configuration](#configuration) below) and use the bare `init :"bridgetown-plausible"` form. Precedence is per-key: any kwarg you pass overrides the matching YAML key, and keys you don't pass continue to come from YAML. So passing only `domain` in the init block will still pick up `server` from `bridgetown.config.yml` if it's set there.
+
+## Upgrading from 1.x
+
+Version 2.0 is a breaking change:
+
+- **Requires Bridgetown >= 1.3.** If you're on an older Bridgetown, stay on `bridgetown-plausible "~> 1.1"` until you can upgrade.
+- **The gem no longer auto-registers on `require`.** You must explicitly opt in by adding `init :"bridgetown-plausible"` to your `config/initializers.rb` (see [Installation](#installation)). Without this, builds calling `<%= plausible %>` will raise `NameError: undefined local variable or method 'plausible'`, and `{% plausible %}` will raise `Liquid::SyntaxError`.
+- **Ruby >= 3.1** (matching what we test in CI). See [System requirements](#system-requirements) for the per-Bridgetown-version Ruby floors set by Bridgetown itself.
+- **Active Support was removed from Bridgetown in 2.1.** The plugin's `.html_safe` calls continue to work via `bridgetown-foundation`, which Bridgetown ships by default — no action needed.
 
 ## Configuration
 
+You can configure via the initializer kwargs shown in [Installation](#installation), or via `bridgetown.config.yml`:
+
 ```yml
 # bridgetown.config.yml
 
@@ -86,7 +113,7 @@ plausible:
 
 ## Usage
 
-This plugin provides the `plausible` Liquid tag & ERB helper to your site. If `BRIDGETOWN_ENV` is not `production`, than the tag will be wrapped in an HTML comment to prevent console erros in development. Make sure you set `BRIDGETOWN_ENV="production"` when you deploy in your script or in Netlify/Vercel/etc.
+This plugin provides the `plausible` Liquid tag & ERB helper to your site. If `BRIDGETOWN_ENV` is not `production`, then the tag will be wrapped in an HTML comment to prevent console errors in development. Make sure you set `BRIDGETOWN_ENV="production"` when you deploy in your script or in Netlify/Vercel/etc.
 
 Use the tag in the head of your document:
 
@@ -114,4 +141,4 @@ Please make sure to read the [Contributing Guide](.github/CONTRIBUTING.md) befor
 
 [MIT](https://opensource.org/licenses/MIT)
 
-Copyright (c) 2021-present, Andrew Mason
+Copyright (c) 2020-2026, Andrew Mason

data/bridgetown-plausible.gemspec

@@ -16,18 +16,18 @@ Gem::Specification.new do |spec|
     "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md",
     "documentation_uri" => spec.homepage.to_s,
     "homepage_uri" => spec.homepage.to_s,
-    "source_code_uri" => spec.homepage.to_s
+    "source_code_uri" => spec.homepage.to_s,
+    "rubygems_mfa_required" => "true"
   }
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|script|spec|features|frontend)/}) }
-  spec.test_files = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
 
-  spec.add_dependency "bridgetown", ">= 0.16", "< 2.0"
+  spec.add_dependency "bridgetown", ">= 1.3"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "nokogiri", "~> 1.16"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "standard", "~> 0.12"
+  spec.add_development_dependency "standard", "~> 1.41"
 end

data/bridgetown.automation.rb

@@ -4,24 +4,34 @@ domain_name = ask("What's your Plausible domain?")
 server_name = ask("If you are self-hosting Plausible, what's your instance domain? Leave blank if not self-hosting to default to plausible.io")
 add_bridgetown_plugin "bridgetown-plausible"
 
-if server_name == ""
-  append_to_file "bridgetown.config.yml" do
-    <<~YAML
+init_block = if server_name.to_s.strip.empty?
+  <<~RUBY
 
-      plausible:
-        domain: #{domain_name}
-    YAML
-  end
+    init :"bridgetown-plausible" do
+      domain #{domain_name.inspect}
+    end
+  RUBY
 else
-  append_to_file "bridgetown.config.yml" do
-    <<~YAML
+  <<~RUBY
+
+    init :"bridgetown-plausible" do
+      domain #{domain_name.inspect}
+      server #{server_name.inspect}
+    end
+  RUBY
+end
 
-      plausible:
-        domain: #{domain_name}
-        server: #{server_name}
-    YAML
+if File.exist?("config/initializers.rb")
+  if File.read("config/initializers.rb").include?(%(init :"bridgetown-plausible"))
+    say_status :plausible, "config/initializers.rb already calls `init :\"bridgetown-plausible\"` — skipping."
+  else
+    # Indent the init block to match the surrounding Bridgetown.configure block
+    indented = init_block.lines.map { |l| (l == "\n") ? l : "  #{l}" }.join
+    inject_into_file "config/initializers.rb", indented, before: /^end\s*\z/
   end
+else
+  say_status :plausible, "config/initializers.rb not found. bridgetown-plausible 2.x requires Bridgetown >= 1.3."
+  say_status :plausible, "Upgrade Bridgetown to 1.3+ (and configure via config/initializers.rb), or use bridgetown-plausible `~> 1.1` for older Bridgetown sites."
 end
 
-say_status :plausible, "All set! Double-check the plausible block in your config file and review docs at"
-say_status :plausible, "https://github.com/bt-rb/bridgetown-plausible"
+say_status :plausible, "All set! Review docs at https://github.com/bt-rb/bridgetown-plausible"

data/demo/Gemfile

@@ -16,7 +16,7 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 #
 # Happy Bridgetowning!
 
-gem "bridgetown", "~> 1.1.0"
+gem "bridgetown", "~> 2.2"
 group :bridgetown_plugins do
   gem "bridgetown-plausible", path: "../"
 end

data/demo/config/initializers.rb

@@ -0,0 +1,5 @@
+Bridgetown.configure do |config|
+  template_engine "liquid"
+
+  init :"bridgetown-plausible"
+end

data/demo/src/_layouts/default.liquid

@@ -6,6 +6,7 @@
     <title>{{ metadata.title }}</title>
     <meta name="description" content="{{ metadata.description }}" />
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/mini.css/3.0.1/mini-default.min.css">
+    {% plausible %}
   </head>
   <body class="{{ page.layout }} {{ page.page_class }}">
     <header>

data/lib/bridgetown-plausible/builder.rb

@@ -45,5 +45,3 @@ module Bridgetown
     end
   end
 end
-
-Bridgetown::Plausible::Builder.register

data/lib/bridgetown-plausible/version.rb

@@ -2,6 +2,6 @@
 
 module Bridgetown
   module Plausible
-    VERSION = "1.1.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/bridgetown-plausible.rb

@@ -2,3 +2,14 @@
 
 require "bridgetown"
 require "bridgetown-plausible/builder"
+require "bridgetown-plausible/version"
+
+Bridgetown.initializer :"bridgetown-plausible" do |config, domain: nil, server: nil|
+  # `config.set` deep-merges the new hash into any existing one (e.g. from bridgetown.config.yml),
+  # so per-key precedence works as expected: kwargs override matching YAML keys, and any keys not
+  # passed as kwargs survive from YAML.
+  overrides = {"domain" => domain, "server" => server}.compact
+  config.set "plausible", overrides if overrides.any?
+
+  config.builder Bridgetown::Plausible::Builder
+end

data/release-please-config.json

@@ -0,0 +1,11 @@
+{
+  "packages": {
+    ".": {
+      "release-type": "ruby",
+      "package-name": "bridgetown-plausible",
+      "bump-minor-pre-major": true,
+      "version-file": "lib/bridgetown-plausible/version.rb"
+    }
+  },
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-plausible
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Andrew Mason
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2026-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.16'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.16'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -50,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -92,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '1.41'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '1.41'
 description: Provides a Liquid Tag and ERB Helper to add Plausible analytics to your
   Bridgetown site.
 email:
@@ -116,6 +110,7 @@ files:
 - ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".release-please-manifest.json"
 - ".rspec"
 - CHANGELOG.md
 - Gemfile
@@ -131,6 +126,7 @@ files:
 - bridgetown.automation.rb
 - demo/Gemfile
 - demo/bridgetown.config.yml
+- demo/config/initializers.rb
 - demo/plugins/builders/.keep
 - demo/plugins/site_builder.rb
 - demo/src/404.html
@@ -143,6 +139,7 @@ files:
 - lib/bridgetown-plausible.rb
 - lib/bridgetown-plausible/builder.rb
 - lib/bridgetown-plausible/version.rb
+- release-please-config.json
 homepage: https://github.com/bt-rb/bridgetown-plausible
 licenses:
 - MIT
@@ -152,7 +149,8 @@ metadata:
   documentation_uri: https://github.com/bt-rb/bridgetown-plausible
   homepage_uri: https://github.com/bt-rb/bridgetown-plausible
   source_code_uri: https://github.com/bt-rb/bridgetown-plausible
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,15 +158,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Plausible Analytics Plugin for Bridgetown
 test_files: []