bridgetown-plausible 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02d2d3172cbd56ad3c8f02f1f1e73d3efcf80f50fdc6d00f83b646f96843c1e8
-  data.tar.gz: 53e005bd002e70c96d034b27f31f1e1c340ec58a92f0046937e5017f6d447880
+  metadata.gz: ef9d4b3c76fedec78de06f8b46a922c9012cacf3ce84c28110adf96e9057e615
+  data.tar.gz: 043260ff038a709878448323b6d3c94460398fb1d15d99d7b68579f85bda2c25
 SHA512:
-  metadata.gz: 0e7ca25707d7d6038f3005338fbb7ed6c62ec5a6eee29400466d424e54efda534eaeffb9d3d73b919a4e05fab4ccf8425442578a5f724b16889b4538f93ce05e
-  data.tar.gz: 33b8b638102fd64948321e50f5f2ee7c830fee4a1e763703f138dcc14d83d15e098b8a5b53f6725e97021ca9df4850fd615f4d6842e7bf13676377283fb18ddb
+  metadata.gz: c3759ae9fe192e9eb781c177b46e8a5a63168d44f0165d0b4046b8d2146c1646d78afefd9d8b7dbac2114fc904c9035573451bb96f6e92fc0a3ae2cb6f00706a
+  data.tar.gz: c6583e55413b8a4321a3b9f703d0fef1c52fc64cf1694d88fe71ed79efd06f7e35fd66b28c3ea6a7781acfc43622500c5bc09b63ea9d5faf381652b89fb77640

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [1.1.0](https://www.github.com/bt-rb/bridgetown-plausible/compare/v1.0.2...v1.1.0) (2022-09-22)
+
+
+### Features
+
+* make server configurable ([#11](https://www.github.com/bt-rb/bridgetown-plausible/issues/11)) ([5c5cd29](https://www.github.com/bt-rb/bridgetown-plausible/commit/5c5cd296477bee6eb6ce38e32051968291995d44))
+
+### [1.0.2](https://www.github.com/bt-rb/bridgetown-plausible/compare/v1.0.1...v1.0.2) (2021-12-22)
+
+
+### Bug Fixes
+
+* use correct link to repo in gemspec and render safe html ([#9](https://www.github.com/bt-rb/bridgetown-plausible/issues/9)) ([02e61b9](https://www.github.com/bt-rb/bridgetown-plausible/commit/02e61b9930240c3b2810627da1e4b357c7563b33))
+* use correct package name in automation ([#10](https://www.github.com/bt-rb/bridgetown-plausible/issues/10)) ([82eb300](https://www.github.com/bt-rb/bridgetown-plausible/commit/82eb3002ce83d822cab96cbe722c1516635fa8dc))
+* use the correct url for the automation in our readme docs ([b2b5961](https://www.github.com/bt-rb/bridgetown-plausible/commit/b2b596132b4452d93cfca8e6227c82d766a8691d))
+
 ### [1.0.1](https://www.github.com/bt-rb/bridgetown-plausible/compare/v1.0.0...v1.0.1) (2021-02-06)
 
 

data/README.md

@@ -35,7 +35,7 @@
 Use the automation to add to your site:
 
 ```sh
-bundle exec bridgetown apply https://github.com/btrb/bridgetown-plausible
+bundle exec bridgetown apply https://github.com/bt-rb/bridgetown-plausible
 ```
 
 ## System requirements
@@ -56,7 +56,7 @@ or add manually in `Gemfile`:
 
 ```ruby
 group :bridgetown_plugins do
-  gem "bridgetown-plausible", "~> 0.1.0"
+  gem "bridgetown-plausible", "~> 1.1.0"
 end
 ```
 
@@ -74,6 +74,14 @@ plausible:
   # Type: String
   # Required: true
   domain: example.com
+  # Your Plausible instance domain.
+  # Only set this if you are self-hosting Plausible on your own domain.
+  # Requires https.
+  #
+  # Type: String
+  # Required: false
+  # Default: "plausible.io"
+  server: selfhosted-plausible.com
 ```
 
 ## Usage

data/Rakefile

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

data/bridgetown-plausible.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Andrew Mason"]
   spec.email = ["andrewmcodes@protonmail.com"]
   spec.summary = "Plausible Analytics Plugin for Bridgetown"
-  spec.description = "A Liquid tag to add Plausible analytics to your site."
-  spec.homepage = "https://github.com/btrb/#{spec.name}"
+  spec.description = "Provides a Liquid Tag and ERB Helper to add Plausible analytics to your Bridgetown site."
+  spec.homepage = "https://github.com/bt-rb/#{spec.name}"
   spec.license = "MIT"
   spec.metadata = {
     "bug_tracker_uri" => "#{spec.homepage}/issues",

data/bridgetown.automation.rb

@@ -1,16 +1,27 @@
-say_status :plausible, "Installing the bridgetown-plausible-tag plugin..."
+say_status :plausible, "Installing the bridgetown-plausible plugin..."
 
 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"
 
-add_bridgetown_plugin "bridgetown-plausible-tag"
+if server_name == ""
+  append_to_file "bridgetown.config.yml" do
+    <<~YAML
 
-append_to_file "bridgetown.config.yml" do
-  <<~YAML
+      plausible:
+        domain: #{domain_name}
+    YAML
+  end
+else
+  append_to_file "bridgetown.config.yml" do
+    <<~YAML
 
-    plausible:
-      domain: #{domain_name}
-  YAML
+      plausible:
+        domain: #{domain_name}
+        server: #{server_name}
+    YAML
+  end
 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/andrewmcodes/bridgetown-plausible-tag"
+say_status :plausible, "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", "~> 0.19.2"
+gem "bridgetown", "~> 1.1.0"
 group :bridgetown_plugins do
   gem "bridgetown-plausible", path: "../"
 end

data/demo/bridgetown.config.yml

@@ -27,4 +27,12 @@ plausible:
   #
   # Type: String
   # Required: true
-  domain: example.com
+  domain: tracked-site.com
+  # Your Plausible instance domain.
+  # Only set this if you are self-hosting Plausible on your own domain.
+  # Requires https.
+  #
+  # Type: String
+  # Required: false
+  # Default: "plausible.io"
+  server: selfhosted-plausible.com

data/demo/plugins/site_builder.rb

@@ -1,4 +1,3 @@
 class SiteBuilder < Bridgetown::Builder
   # write builders which subclass SiteBuilder in plugins/builder
 end
-

data/lib/bridgetown-plausible/builder.rb

@@ -5,11 +5,11 @@ module Bridgetown
     class Builder < Bridgetown::Builder
       def build
         liquid_tag "plausible" do |_attributes, tag|
-          render
+          render.html_safe
         end
 
         helper "plausible" do
-          render
+          render.html_safe
         end
       end
 
@@ -17,12 +17,13 @@ module Bridgetown
 
       def render
         domain = options.dig(:domain)&.strip
+        server = options.dig(:server)&.strip || "plausible.io"
 
         tag = if domain
-          markup_for_domain(domain)
+          markup_for_snippet(domain, server)
         else
           Bridgetown.logger.warn "Plausible", "Domain not configured."
-          markup_for_domain("NOT CONFIGURED")
+          markup_for_snippet("NOT CONFIGURED", server)
         end
 
         return wrap_with_comment(tag) unless Bridgetown.environment.production?
@@ -30,8 +31,8 @@ module Bridgetown
         tag
       end
 
-      def markup_for_domain(domain)
-        "<script async defer data-domain=\"#{domain}\" src=\"https://plausible.io/js/plausible.js\"></script>"
+      def markup_for_snippet(domain, server)
+        "<script async defer data-domain=\"#{domain}\" src=\"https://#{server}/js/plausible.js\"></script>"
       end
 
       def wrap_with_comment(tag)

data/lib/bridgetown-plausible/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-plausible
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew Mason
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-06 00:00:00.000000000 Z
+date: 2022-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -100,7 +100,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
-description: A Liquid tag to add Plausible analytics to your site.
+description: Provides a Liquid Tag and ERB Helper to add Plausible analytics to your
+  Bridgetown site.
 email:
 - andrewmcodes@protonmail.com
 executables: []
@@ -142,15 +143,15 @@ files:
 - lib/bridgetown-plausible.rb
 - lib/bridgetown-plausible/builder.rb
 - lib/bridgetown-plausible/version.rb
-homepage: https://github.com/btrb/bridgetown-plausible
+homepage: https://github.com/bt-rb/bridgetown-plausible
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/btrb/bridgetown-plausible/issues
-  changelog_uri: https://github.com/btrb/bridgetown-plausible/blob/main/CHANGELOG.md
-  documentation_uri: https://github.com/btrb/bridgetown-plausible
-  homepage_uri: https://github.com/btrb/bridgetown-plausible
-  source_code_uri: https://github.com/btrb/bridgetown-plausible
+  bug_tracker_uri: https://github.com/bt-rb/bridgetown-plausible/issues
+  changelog_uri: https://github.com/bt-rb/bridgetown-plausible/blob/main/CHANGELOG.md
+  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: 
 rdoc_options: []
 require_paths: