jekyll-turbo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8a3adb518ea5e07065d2d63003f9bae7f3c629ffd24090732a3c8d32b2e6f4d
+  data.tar.gz: 0b52a99ffbda14ef0598d2f88416ca9dad8ccecbcb103b28d431830c8dd949c4
+SHA512:
+  metadata.gz: b12dd0620e655d9bce0111a617aee570e1906f4e6772030480cba8c37bbf2a808e402ed8cb5dab4d8fb8b81036c1c7551b1a9f2f17016dd3e1d9c7e4844edc11
+  data.tar.gz: 74c6d9e3403c5f952e9bd8fda0407f8f19bf4c8a9ad90da7689007c598cdb35155194c13fcbb503d8600ade7ae11bf895f82ef8e10d57d9fbaf49329103ec246

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Naming/FileName:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-02
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 maikhel
+
+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,92 @@
+# Jekyll::Turbo
+
+[![Build Status](https://github.com/maikhel/jekyll-turbo/actions/workflows/main.yml/badge.svg)](https://github.com/maikhel/jekyll-turbo/actions)
+
+**jekyll-turbo** is a simple Jekyll plugin that brings [Hotwire Turbo Drive](https://turbo.hotwired.dev/) to your static site. It automatically injects the necessary `<script type="module">` tag into your HTML files at build time.
+
+## Installation
+
+1. Add the following to your site's `Gemfile`:
+
+   ```ruby
+   gem 'jekyll-turbo'
+   ```
+
+2. Add the following to your site's `_config.yml`:
+
+   ```yml
+   plugins:
+     - jekyll-turbo
+   ```
+
+   **Note**: if `jekyll --version` is less than `3.5` use:
+
+   ```yml
+   gems:
+     - jekyll-turbo
+   ```
+
+3. In your terminal, execute:
+
+   ```bash
+   bundle
+   ```
+
+4. (re)start your Jekyll server with:
+
+   ```bash
+   jekyll serve
+   ```
+
+## Usage
+
+Install the plugin as described above.
+The plugin will automatically inject this tag into the `<head>` of all your generated `.html` pages:
+
+```HTML
+<script type="module" src="https://cdn.jsdelivr.net/npm/@hotwired/turbo@8.0.4/dist/turbo.es2017-esm.js"></script>
+```
+Then, you can immediately use all Hotwire Turbo features on the client side, such as Turbo Drive and Turbo Frames.
+
+**⚠️ Tip:** Note that the `github-pages` gem runs in `safe` mode and only allows [a defined set of plugins](https://pages.github.com/versions/). To use this gem in GitHub Pages, you need to build your site locally or use a CI (e.g. [Github Workflow](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow)).
+
+[Click here for more information.](https://jekyllrb.com/docs/continuous-integration/github-actions/)
+
+## Planned Features
+This plugin is currently zero-config and focused on simplicity. Future improvements may include:
+
+- [ ] Option to serve Turbo locally instead of using a CDN
+- [ ] Support for customizing the Turbo version
+- [ ] Configuration via `_config.yml`
+
+Feel free to open an issue or contribute via pull request if you'd like to help!
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/maikhel/jekyll-turbo. 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/maikhel/jekyll-turbo/blob/main/CODE_OF_CONDUCT.md).
+
+1. [Fork this repository](https://github.com/maikhel/jekyll-turbo/fork)
+2. Create your branch (`git checkout -b feat/my-new-feature`)
+3. Commit your changes (`git commit -m 'Add cool feature'`)
+4. Push to the branch (git push origin feat/my-new-feature)
+5. Create a new Pull Request
+
+### Development
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Testing
+
+Use the following command to run tests and RuboCop check:
+
+```bash
+rake
+```
+
+## 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 Jekyll::Turbo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/maikhel/jekyll-turbo/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/jekyll/turbo/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Turbo
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll/turbo.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "jekyll"
+
+module Jekyll
+  module Turbo
+    # Jekyll::Turbo::Injector is a Jekyll plugin that injects a <script> tag
+    # for Hotwire Turbo into the HTML <head> of each generated page.
+    #
+    # It enables Turbo Drive functionality in static Jekyll sites by automatically
+    # including the Turbo JavaScript via CDN.
+    #
+    # This class is designed to be used as part of the jekyll-turbo gem.
+    #
+    # Usage:
+    # - Add `jekyll-turbo` to your Gemfile and `_config.yml` plugins list
+    class Injector
+      CDN_URL = "https://cdn.jsdelivr.net/npm/@hotwired/turbo@8.0.4/dist/turbo.es2017-esm.js"
+
+      def self.add_script(page)
+        return unless page.output_ext == ".html" && page.output.include?("</head>")
+
+        turbo_script = <<~HTML
+          <script type="module" src="#{CDN_URL}"></script>
+        HTML
+
+        # Inject the Turbo script just before </head>
+        page.output = page.output.sub("</head>", "#{turbo_script}\n</head>")
+      end
+
+      # Hook into the post_render step for each page
+      Jekyll::Hooks.register :pages, :post_render do |page|
+        Jekyll::Turbo::Injector.add_script(page)
+      end
+    end
+  end
+end

data/lib/jekyll-turbo.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "jekyll/turbo/version"
+require "jekyll/turbo"

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-turbo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- maikhel
+bindir: exe
+cert_chain: []
+date: 2025-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: jekyll-turbo is a plugin for Jekyll that seamlessly integrates Hotwire's
+  Turbo Drive into your static site. It automatically injects the necessary script
+  tag into your HTML output to enable client-side Turbo features, such as Turbo Drive
+  and Turbo Frames.
+email:
+- mlecicki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/jekyll-turbo.rb
+- lib/jekyll/turbo.rb
+- lib/jekyll/turbo/version.rb
+homepage: https://github.com/maikhel/jekyll-turbo/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/maikhel/jekyll-turbo/
+  source_code_uri: https://github.com/maikhel/jekyll-turbo/
+  changelog_uri: https://github.com/maikhel/jekyll-turbo/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/maikhel/jekyll-turbo/issues
+  documentation_uri: https://github.com/maikhel/jekyll-turbo#readme
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A Jekyll plugin that automatically injects Turbo Drive to enable faster,client-side
+  page transitions.
+test_files: []