jekyll-formspree 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aa4984eed436b83f0f621cc7580986638e24ef05d03f66b33005f893f76f704
-  data.tar.gz: 4f2ce646ee36c3391739c98f66894579cb10f2944f24a20f0346beaf8d3a3a97
+  metadata.gz: 34e22818eb005587721e734268e8c3f0adcffcc46078b39c6ad1d492ff94f011
+  data.tar.gz: 641872f553ee208e93404b17fe033471c24a68bf0a21feeb7520af8eb677bef9
 SHA512:
-  metadata.gz: 529318e9cb954948b89ebf7b1e019043227b3f7a20188b0f730358cf7c1ad48ec3c9f9e3b49198bdbcf9e389215c119b790d42de5353164a3322707e5d554e0a
-  data.tar.gz: 4e9ccd4e58b3450860f2eb3cae6d29c727e2f1e28c121cc9d3388218878a359a24ff4dbc934a76acdc32b0822374e1e3a81439a3f0fea5147aec363b67559cfd
+  metadata.gz: 186d2a9af84e22a27fffffc67cabf0d663fa2ffa22124bc9a416f3b2b8dcea079130d4e8bf5503f09d88e87d42bd887e0e59739c26b37e3741a3e7e729387c10
+  data.tar.gz: d0ebf4133f03b6d99fa8bbdfe74ff77c0b8b2af20f13cf9522277411641a06fc9212c600c9bc20b401721d75b75292a9798297c2b9e765f52844b53777289025

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+## 0.1.0 — 2026-11-02
+
+### Changed
+
+- The default form posts to `https://formspree.io/f/<id>`, the current
+  Formspree endpoint, instead of the legacy `https://formspree.io/<id>`.
+  The prefix can be changed with `formspree: endpoint:` in `_config.yml`.
+- Custom `_includes/formspree.html` templates are rendered in the page's
+  Liquid context: `page`, `site`, `layout` and `{% include %}` now work
+  inside them. `formspree_id` is still available, and the new
+  `formspree_url` holds the full endpoint URL.
+- The default form uses an `email` input, labels tied to their fields and
+  `required` attributes. The form has a `formspree-form` class to style it.
+- `_includes/formspree.html` is also looked up in the site's theme.
+
+### Added
+
+- A build warning when the form ID is empty, e.g. a missing
+  `site.formspree_id`.
+- Tests (Minitest) and CI on Ruby 3.3, 3.4 and 4.0 with Jekyll 4.4, and
+  Ruby 3.3 with Jekyll 3.10.
+
+### Fixed
+
+- `{% formspree %}` without an ID now fails with a Liquid syntax error.
+- The plugin no longer modifies the site payload while rendering.
+
+### Internal
+
+- Code moved to `Jekyll::Formspree::Tag` (no more top-level `Formspree`
+  class), with the version in `lib/jekyll/formspree/version.rb`.
+- The gemspec declares its Jekyll (>= 3.8, < 5.0) and Ruby (>= 3.1)
+  requirements.
+
+## 0.0.7 — 2020-03-27
+
+- Last release of the original plugin.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Elaoin
+
+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,111 @@
+# Jekyll Formspree
+
+[![Gem Version](https://badge.fury.io/rb/jekyll-formspree.svg)](https://badge.fury.io/rb/jekyll-formspree)
+[![Tests](https://github.com/Elaoin/jekyll-formspree/actions/workflows/ci.yml/badge.svg)](https://github.com/Elaoin/jekyll-formspree/actions/workflows/ci.yml)
+
+A Jekyll plugin that adds a `{% formspree %}` Liquid tag to render a
+[Formspree](https://formspree.io) contact form.
+
+Requires Jekyll 3.8 to 4.x and Ruby 3.1 or later.
+
+## Installation
+
+Add the gem to your `Gemfile`:
+
+```ruby
+group :jekyll_plugins do
+  gem "jekyll-formspree"
+end
+```
+
+then run `bundle install`. If you list plugins in `_config.yml`, add it there too:
+
+```yaml
+plugins:
+  - jekyll-formspree
+```
+
+> GitHub Pages' built-in Jekyll build only runs [allow-listed plugins](https://pages.github.com/versions/).
+> To use this plugin there, build the site with a GitHub Actions workflow.
+
+## Usage
+
+Use your form ID, as shown on Formspree (`https://formspree.io/f/<form ID>`):
+
+```liquid
+{% formspree "xyzabcde" %}
+```
+
+or read it from a variable, for example from `_config.yml` (`formspree_id: xyzabcde`)
+or from the page's front matter:
+
+```liquid
+{% formspree site.formspree_id %}
+{% formspree page.form_id %}
+```
+
+If the ID is empty, the build prints a warning.
+
+## Default form
+
+Without a custom template, the tag renders:
+
+```html
+<form class="formspree-form" action="https://formspree.io/f/xyzabcde" method="POST" accept-charset="utf-8">
+  <label for="formspree-email">Your email</label>
+  <input type="email" id="formspree-email" name="email" autocomplete="email" required>
+  <label for="formspree-message">Your message</label>
+  <textarea id="formspree-message" name="message" rows="5" required></textarea>
+  <button type="submit">Send</button>
+</form>
+```
+
+preceded by a few lines of CSS scoped to `.formspree-form`.
+
+## Custom form
+
+Create `_includes/formspree.html` in your site (or in your theme). The tag
+renders it in the page's context, so `page`, `site` and `{% include %}`
+work as usual, with two extra variables:
+
+| Variable        | Value                                 |
+|-----------------|---------------------------------------|
+| `formspree_id`  | the form ID                           |
+| `formspree_url` | `https://formspree.io/f/<form ID>`    |
+
+```html
+<form action="{{ formspree_url }}" method="POST">
+  <input type="email" name="email" required>
+  <textarea name="message" required></textarea>
+  <input type="hidden" name="_subject" value="Message from {{ page.title }}">
+  <button type="submit">Send</button>
+</form>
+```
+
+## Configuration
+
+The endpoint prefix defaults to `https://formspree.io/f/`. To change it:
+
+```yaml
+formspree:
+  endpoint: https://formspree.io/f/
+```
+
+## Upgrading from 0.0.x
+
+- The default form now posts to `https://formspree.io/f/<id>` instead of
+  `https://formspree.io/<id>`. Use the form ID shown in your Formspree dashboard.
+- Custom templates keep working unchanged. To use the new endpoint, replace
+  `https://formspree.io/{{ formspree_id }}` with `{{ formspree_url }}`.
+
+## Development
+
+```sh
+bundle install
+bundle exec rake test
+JEKYLL_VERSION="~> 3.10" bundle update jekyll && bundle exec rake test
+```
+
+## License
+
+MIT, see [LICENSE](LICENSE).

data/lib/jekyll/formspree/default.html

@@ -0,0 +1,11 @@
+<style>
+  .formspree-form label, .formspree-form input, .formspree-form textarea { display: block; width: 100%; box-sizing: border-box; }
+  .formspree-form input, .formspree-form textarea { margin: 0.25em 0 1em; padding: 0.5em; font: inherit; }
+</style>
+<form class="formspree-form" action="{{ formspree_url | escape }}" method="POST" accept-charset="utf-8">
+  <label for="formspree-email">Your email</label>
+  <input type="email" id="formspree-email" name="email" autocomplete="email" required>
+  <label for="formspree-message">Your message</label>
+  <textarea id="formspree-message" name="message" rows="5" required></textarea>
+  <button type="submit">Send</button>
+</form>

data/lib/jekyll/formspree/tag.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Formspree
+    # {% formspree "FORM_ID" %} or {% formspree site.formspree_id %}
+    #
+    # Renders _includes/formspree.html (from the site, then from the theme),
+    # or the default form bundled with this gem. The template is rendered in
+    # the current Liquid context, so `page`, `site` and `{% include %}` work,
+    # with two extra variables:
+    #
+    #   formspree_id   the form ID
+    #   formspree_url  the form endpoint, https://formspree.io/f/<id>
+    #
+    # The endpoint prefix can be changed in _config.yml:
+    #
+    #   formspree:
+    #     endpoint: https://formspree.io/f/
+    class Tag < Liquid::Tag
+      DEFAULT_ENDPOINT = "https://formspree.io/f/"
+      INCLUDE_NAME = "formspree.html"
+      DEFAULT_TEMPLATE = File.expand_path("default.html", __dir__)
+
+      def initialize(tag_name, markup, parse_context)
+        super
+        @markup = markup.strip
+        raise Liquid::SyntaxError, "Syntax error in 'formspree': usage is {% formspree \"FORM_ID\" %}" if @markup.empty?
+
+        @id_expression = Liquid::Expression.parse(@markup)
+      end
+
+      def render(context)
+        site = context.registers[:site]
+        id = context.evaluate(@id_expression).to_s.strip
+        warn_missing_id(context) if id.empty?
+
+        path = template_path(site)
+        template = site.liquid_renderer.file(path).parse(File.read(path, **site.file_read_opts))
+
+        context.stack do
+          context["formspree_id"] = id
+          context["formspree_url"] = endpoint(site) + id
+          template.render!(context)
+        end
+      end
+
+      private
+
+      def endpoint(site)
+        config = site.config["formspree"]
+        endpoint = config["endpoint"] if config.is_a?(Hash)
+        endpoint.to_s.empty? ? DEFAULT_ENDPOINT : endpoint.to_s
+      end
+
+      def template_path(site)
+        site.includes_load_paths
+          .map { |dir| File.join(dir, INCLUDE_NAME) }
+          .find { |path| File.file?(path) } || DEFAULT_TEMPLATE
+      end
+
+      def warn_missing_id(context)
+        page = context.registers[:page]
+        where = page && page["path"] ? " in #{page["path"]}" : ""
+        Jekyll.logger.warn "Formspree:", "empty form ID for '{% formspree #{@markup} %}'#{where}"
+      end
+    end
+  end
+end

data/lib/jekyll/formspree/version.rb

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

data/lib/jekyll-formspree.rb

@@ -1,23 +1,7 @@
-require "jekyll"
-class Formspree < Liquid::Tag
-
-  def initialize(tagName, content, tokens)
-    super
-    @content = content
-  end
+# frozen_string_literal: true
 
-  def render(context)
-    @formspree_id = "#{context[@content.strip]}"
-
-    site = context.registers[:site]
-    tmpl_path = File.join site.in_source_dir(site.config["includes_dir"].to_s), "formspree.html"
-    if File.exist?(tmpl_path)
-      tmpl = File.read tmpl_path
-      tmpl = (Liquid::Template.parse tmpl).render site.site_payload.merge!({"formspree_id" => @formspree_id})
-    else
-      %Q{<style>.form-container { max-width: 100%; } .form-container input { position: relative; top: 0; left: 0; width: 100%; height: 20px; padding: 0 ; } .form-container textarea { position: relative; top: 0; left: 0; width: 100%; height: 80px; padding: 0; } </style> <form action="https://formspree.io/#{ @formspree_id }" method="POST" class='form-container'> <label>Your email:</label><br /><input type="text" name="_replyto" /> <label>Your message:</label><br /><textarea name="message"></textarea> <button type="submit">Send</button> </form>}
-    end
-  end
+require "jekyll"
+require_relative "jekyll/formspree/version"
+require_relative "jekyll/formspree/tag"
 
-  Liquid::Template.register_tag "formspree", self
-end
+Liquid::Template.register_tag("formspree", Jekyll::Formspree::Tag)

metadata

@@ -1,27 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-formspree
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Elaoin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-27 00:00:00.000000000 Z
-dependencies: []
-description: Generate form snippets for Formspree's contact forms
+date: 2026-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Adds a {% formspree %} Liquid tag to Jekyll that renders a Formspree
+  contact form, using your own _includes/formspree.html template or a default one.
 email: julien@elaoin.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
+- README.md
 - lib/jekyll-formspree.rb
+- lib/jekyll/formspree/default.html
+- lib/jekyll/formspree/tag.rb
+- lib/jekyll/formspree/version.rb
 homepage: https://github.com/Elaoin/jekyll-formspree
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/Elaoin/jekyll-formspree
+  changelog_uri: https://github.com/Elaoin/jekyll-formspree/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/Elaoin/jekyll-formspree/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -29,15 +60,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
-summary: Generate form snippets for Formspree's contact forms
+summary: Liquid tag that renders Formspree contact forms in Jekyll sites
 test_files: []