al_analytics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 288bcac5557544e999beda5b82eb92d488b595e2543fb2ced541552092129cd2
+  data.tar.gz: 89e1a046ade9be53cdf305a5090f8ad88d90b0312797937c1058b5dfe5b3706a
+SHA512:
+  metadata.gz: def9278e280992b61a33a381e20efa550a657b9d309c8e89e8d3fe0e85a6fa9446d3c4684308daaaffd59e8aabdc0080a9b6a129cb019500201892555cf724d4
+  data.tar.gz: c929f9d4e0c0fce8e79cfdf968b40bd428c05dd38c5cfe5ca893e31cb12455f7031865a3139c3e983a6f370079ddcaff6b1b10e3e220ae266e21eb1caa6b6cf5

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.1.0 - 2026-02-07
+- Initial gem release.
+- Added support for modern al-folio analytics config keys with legacy `analytics:` fallback.
+- Added optional cookie-consent script attributes and provider enable flags.

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Maruan Al-Shedivat.
+
+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,67 @@
+# Al-Analytics
+
+A Jekyll plugin that provides integrations with various analytics services for al-folio sites.
+
+## Supported Analytics Services
+
+- Google Analytics
+- Cronitor Analytics
+- Pirsch Analytics
+- OpenPanel Analytics
+
+## Installation
+
+Add this line to your Jekyll site's Gemfile:
+
+```ruby
+gem 'al_analytics'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+1. Add the plugin to your site's `_config.yml`:
+
+```yaml
+plugins:
+  - al_analytics
+```
+
+2. Configure your analytics services in `_config.yml`:
+
+```yaml
+enable_cookie_consent: false
+
+enable_google_analytics: true
+google_analytics: "G-XXXXXXXXXX"
+
+enable_cronitor_analytics: false
+cronitor_analytics: "XXXXXXXXX"
+
+enable_pirsch_analytics: false
+pirsch_analytics: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+
+enable_openpanel_analytics: false
+openpanel_analytics: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
+```
+
+The plugin also supports the legacy `analytics:` hash used by earlier releases.
+
+3. Add the analytics tag to your layout file (e.g., `_layouts/default.html`):
+
+```liquid
+{% al_analytics_scripts %}
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub.

data/lib/al_analytics.rb

@@ -0,0 +1,105 @@
+require "jekyll"
+
+module AlAnalytics
+  class AnalyticsTag < Liquid::Tag
+    def render(context)
+      site = context.registers[:site]
+      return "" unless site
+
+      output = []
+      cookie_attrs = cookie_consent_attrs(site)
+
+      google_id = analytics_value(site, "google_analytics", "google")
+      if enabled?(site, "enable_google_analytics", google_id)
+        output << <<~HTML
+          <!-- Google Analytics -->
+          <script#{cookie_attrs} async src="https://www.googletagmanager.com/gtag/js?id=#{google_id}"></script>
+          <script#{cookie_attrs}>
+            window.dataLayer = window.dataLayer || [];
+            function gtag() {
+              window.dataLayer.push(arguments);
+            }
+            gtag("js", new Date());
+            gtag("config", "#{google_id}");
+          </script>
+        HTML
+      end
+
+      cronitor_id = analytics_value(site, "cronitor_analytics", "cronitor")
+      if enabled?(site, "enable_cronitor_analytics", cronitor_id)
+        output << <<~HTML
+          <!-- Cronitor RUM -->
+          <script#{cookie_attrs} async src="https://rum.cronitor.io/script.js"></script>
+          <script#{cookie_attrs}>
+            window.cronitor =
+              window.cronitor ||
+              function () {
+                (window.cronitor.q = window.cronitor.q || []).push(arguments);
+              };
+            cronitor("config", { clientKey: "#{cronitor_id}" });
+          </script>
+        HTML
+      end
+
+      pirsch_id = analytics_value(site, "pirsch_analytics", "pirsch")
+      if enabled?(site, "enable_pirsch_analytics", pirsch_id)
+        output << <<~HTML
+          <script#{cookie_attrs} defer src="https://api.pirsch.io/pa.js" id="pianjs" data-code="#{pirsch_id}"></script>
+        HTML
+      end
+
+      openpanel_id = analytics_value(site, "openpanel_analytics", "openpanel")
+      if enabled?(site, "enable_openpanel_analytics", openpanel_id)
+        output << <<~HTML
+          <script#{cookie_attrs}>
+            window.op =
+              window.op ||
+              function (...args) {
+                (window.op.q = window.op.q || []).push(args);
+              };
+            window.op("init", {
+              clientId: "#{openpanel_id}",
+              trackScreenViews: true,
+              trackOutgoingLinks: true,
+              trackAttributes: true,
+            });
+          </script>
+          <script#{cookie_attrs} async defer src="https://openpanel.dev/op1.js"></script>
+        HTML
+      end
+
+      output.join("\n")
+    end
+
+    private
+
+    def cookie_consent_attrs(site)
+      site.config["enable_cookie_consent"] ? ' type="text/plain" data-category="analytics"' : ""
+    end
+
+    def analytics_value(site, key, legacy_key)
+      value = site.config[key]
+      return value unless blank?(value)
+
+      legacy_config = site.config["analytics"]
+      return nil unless legacy_config.is_a?(Hash)
+
+      legacy_config[legacy_key]
+    end
+
+    def enabled?(site, flag_key, value)
+      return false if blank?(value)
+
+      flag = site.config[flag_key]
+      return true if flag.nil?
+
+      !!flag
+    end
+
+    def blank?(value)
+      value.nil? || value.to_s.strip.empty?
+    end
+  end
+end
+
+Liquid::Template.register_tag("al_analytics_scripts", AlAnalytics::AnalyticsTag)

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: al_analytics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- al-org
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+description: Jekyll plugin extracted from al-folio that renders Google Analytics,
+  Cronitor RUM, Pirsch, and OpenPanel scripts with optional cookie-consent attributes.
+email:
+- dev@al-org.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/al_analytics.rb
+homepage: https://github.com/al-org-dev/al-analytics
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/al-org-dev/al-analytics
+  source_code_uri: https://github.com/al-org-dev/al-analytics
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Analytics integration tags for al-folio Jekyll sites
+test_files: []