cloudflare-turnstile-rails 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae18cf79497e4415f5e55355501f6d0699bd6c697c770fc7cff4032f691b98f4
-  data.tar.gz: 995935bd9b57cfac7022a235a61109d052c6f2163f25340b675109dd9e2fce86
+  metadata.gz: b7a94bbf6a29069c0d4f5f291ca3e80d368942aad2e03f20ae7b64091f9d900e
+  data.tar.gz: 3156465de7ffac378b48b61250377536272acd9bd15998d61be263701fe92657
 SHA512:
-  metadata.gz: 5a0fa9c6c4f076a8b8ad8f44687ce321c30a9715048e4a77c3bd4bcf939fa751c0ca0b9660e05eedd6745af1392e9c85f2685429e040576d255e5acb20bfdc63
-  data.tar.gz: 990129c6c08a33c5fb5d52b93d85d9d549787d88eff8751eb1b80bacd2ef6525e31db1211f34846a92ddb660a6a05c8dd192b34a7239f61d7253f63b4239df5a
+  metadata.gz: e7304843b0657e901e07f3264e6ab6676914af2b9d6a8f38a0778b53587cff1ba7454c71793fe45cac69bb7741e8264e3495337fb4544bd5f88551e569847a5d
+  data.tar.gz: 808592cee1ae30ea1a6c19a9887bfe62d33979b991810bb078bec618a0e2e37ec4a93152d7f5552c4786245a25f4497e2ab7f0cdf925c387f0e5588468cb4a52

data/README.md

@@ -1,13 +1,15 @@
 # Cloudflare Turnstile Rails
 
-[![Gem Version](https://img.shields.io/gem/v/cloudflare-turnstile-rails.svg)](https://rubygems.org/gems/cloudflare-turnstile-rails)
-[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
-[![Lint Status](https://github.com/vkononov/cloudflare-turnstile-rails/actions/workflows/lint.yml/badge.svg)](https://github.com/vkononov/cloudflare-turnstile-rails/actions/workflows/lint.yml)
-[![Test Status](https://github.com/vkononov/cloudflare-turnstile-rails/actions/workflows/test.yml/badge.svg)](https://github.com/vkononov/cloudflare-turnstile-rails/actions/workflows/test.yml)
+[![Gem Version](https://img.shields.io/gem/v/cloudflare-turnstile-rails.svg?label=Gem&logo=rubygems&logoColor=white)](https://rubygems.org/gems/cloudflare-turnstile-rails)
+[![Ruby](https://img.shields.io/badge/Ruby-2.6%20to%204.0-CC342D?logo=ruby&logoColor=white)](https://github.com/vkononov/cloudflare-turnstile-rails/blob/main/.github/workflows/test.yml)
+[![Rails](https://img.shields.io/badge/Rails-5.0%20to%208.1-D30001?logo=rubyonrails&logoColor=white)](https://github.com/vkononov/cloudflare-turnstile-rails/blob/main/Appraisals)
+[![Test Matrix](https://img.shields.io/github/actions/workflow/status/vkononov/cloudflare-turnstile-rails/test.yml?branch=main&label=Test%20Matrix&logo=github)](https://github.com/vkononov/cloudflare-turnstile-rails/actions/workflows/test.yml)
+[![Lint](https://img.shields.io/github/actions/workflow/status/vkononov/cloudflare-turnstile-rails/lint.yml?branch=main&label=Lint&logo=github)](https://github.com/vkononov/cloudflare-turnstile-rails/actions/workflows/lint.yml)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
 Cloudflare Turnstile gem for Ruby on Rails with built-in Turbo and Turbolinks support and CSP compliance.
 
-Supports `Rails >= 5.0` with `Ruby >= 2.6.0`.
+Supports **Rails 5.0 → latest** and **Ruby 2.6 → latest**, with the full Rails/Ruby matrix tested daily in CI.
 
 [!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/vkononov)
 
@@ -87,10 +89,35 @@ Supports `Rails >= 5.0` with `Ruby >= 2.6.0`.
    <%= cloudflare_turnstile_tag %>
    ```
 
-  That's it! Though it is recommended to match your `theme` and `language` to your app's design and locale:
+  That's it! By default the widget auto-detects the visitor's `theme` and `language`.
+
+* To match your app's design and locale, set defaults once in the initializer and they'll apply to every `cloudflare_turnstile_tag` automatically:
+
+  ```ruby
+  Cloudflare::Turnstile::Rails.configure do |config|
+    config.default_data = {
+      theme: 'light',
+      language: 'en'
+    }
+  end
+  ```
+
+  Values may also be a proc, evaluated at render time — useful for following the current locale:
+
+  ```ruby
+  config.default_data = { language: -> { I18n.locale } }
+  ```
+
+* You can still override any default (or add extra options) on an individual tag via the `data:` option. Per-tag values take precedence over the configured defaults:
+
+   ```erb
+   <%= cloudflare_turnstile_tag data: { theme: 'dark' } %>
+   ```
+
+* To drop a configured default on a single tag (so its attribute isn't rendered at all), pass `nil` for that key:
 
    ```erb
-   <%= cloudflare_turnstile_tag data: { theme: 'light', language: 'en' } %>
+   <%= cloudflare_turnstile_tag data: { theme: nil } %>
    ```
 
 * For all available **data-**\* options (e.g., `action`, `cdata`, `theme`, etc.), refer to the official Cloudflare client-side rendering docs:

data/lib/cloudflare/turnstile/rails/configuration.rb

@@ -3,7 +3,7 @@ module Cloudflare
     module Rails
       class Configuration
         attr_writer :script_url
-        attr_accessor :site_key, :secret_key, :render, :onload, :auto_populate_response_in_test_env
+        attr_accessor :site_key, :secret_key, :render, :onload, :default_data, :auto_populate_response_in_test_env
 
         def initialize
           @script_url = Cloudflare::SCRIPT_URL
@@ -11,6 +11,7 @@ module Cloudflare
           @secret_key = nil
           @render = nil
           @onload = nil
+          @default_data = {}
           @auto_populate_response_in_test_env = true
         end
 

data/lib/cloudflare/turnstile/rails/helpers.rb

@@ -7,7 +7,7 @@ module Cloudflare
         def cloudflare_turnstile_tag(site_key: nil, include_script: true, **html_options) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
           site_key ||= Rails.configuration.site_key
           html_options[:class] = Cloudflare::WIDGET_CLASS unless html_options.key?(:class)
-          html_options[:data] ||= {}
+          html_options[:data] = cloudflare_turnstile_default_data.merge(html_options[:data] || {})
           html_options[:data][:sitekey] ||= site_key
 
           script_tag = nil
@@ -27,6 +27,16 @@ module Cloudflare
           widget = content_tag(:div, '', html_options)
           safe_join([script_tag, widget].compact, "\n")
         end
+
+        private
+
+        # Resolves the configured default data attributes, evaluating any
+        # callable values (e.g. a proc bound to I18n.locale) at render time.
+        def cloudflare_turnstile_default_data
+          (Rails.configuration.default_data || {}).transform_values do |value|
+            value.respond_to?(:call) ? value.call : value
+          end
+        end
       end
     end
   end

data/lib/cloudflare/turnstile/rails/version.rb

@@ -1,7 +1,7 @@
 module Cloudflare
   module Turnstile
     module Rails
-      VERSION = '1.0.1'.freeze
+      VERSION = '1.1.0'.freeze
     end
   end
 end

data/lib/generators/cloudflare_turnstile/templates/cloudflare_turnstile.rb

@@ -16,6 +16,15 @@ Cloudflare::Turnstile::Rails.configure do |config|
   # config.render = 'explicit'
   # config.onload = 'onloadTurnstileCallback'
 
+  # Optional: Default data-* attributes applied to every `cloudflare_turnstile_tag`.
+  # These are merged into each widget and can be overridden per tag via the `data:` option.
+  # See https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#configuration-options
+  # Values may be a proc, evaluated at render time (e.g. to follow the current locale).
+  # config.default_data = {
+  #   theme: 'auto',
+  #   language: -> { I18n.locale }
+  # }
+
   # In the Rails Test environment, automatically fill in a dummy response if none was provided.
   # This lets you keep existing controller tests without having to add
   # params["cf-turnstile-response"] manually in every test.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare-turnstile-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Vadim Kononov
@@ -9,34 +9,6 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: actionview
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -59,12 +31,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
-- Appraisals
 - LICENSE.txt
 - README.md
-- Rakefile
-- eslint.config.js
 - lib/cloudflare/turnstile/rails.rb
 - lib/cloudflare/turnstile/rails/assets/javascripts/cloudflare_turnstile_helper.js
 - lib/cloudflare/turnstile/rails/configuration.rb
@@ -93,7 +61,6 @@ files:
 - lib/cloudflare/turnstile/rails/version.rb
 - lib/generators/cloudflare_turnstile/install_generator.rb
 - lib/generators/cloudflare_turnstile/templates/cloudflare_turnstile.rb
-- package.json
 homepage: https://github.com/vkononov/cloudflare-turnstile-rails
 licenses:
 - MIT
@@ -116,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Cloudflare Turnstile gem for Rails with built-in Turbo and Turbolinks support
   and CSP compliance

data/.rubocop.yml

@@ -1,46 +0,0 @@
-plugins:
-  - rubocop-md
-  - rubocop-minitest
-  - rubocop-performance
-  - rubocop-rake
-
-AllCops:
-  TargetRubyVersion: 2.6.0
-  NewCops: enable
-  Exclude:
-    - .git/**/*
-    - node_modules/**/*
-    - vendor/bundle/**/*
-
-Layout/IndentationConsistency:
-  Exclude:
-    - README.md
-
-Layout/InitialIndentation:
-  Exclude:
-    - README.md
-
-Layout/LineLength:
-  Max: 120
-  Exclude:
-    - lib/cloudflare/turnstile/rails/constants/*.rb
-    - cloudflare-turnstile-rails.gemspec
-
-Layout/SpaceInsideHashLiteralBraces:
-  Enabled: false
-
-Metrics/MethodLength:
-  Max: 12
-
-Minitest/MultipleAssertions:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/EmptyElse:
-  Exclude:
-    - README.md
-
-Style/FrozenStringLiteralComment:
-  EnforcedStyle: never

data/Appraisals

@@ -1,69 +0,0 @@
-appraise 'rails-5.0' do
-  gem 'rails', '~> 5.0.0'
-  if RUBY_VERSION >= '3.4.0'
-    gem 'base64'
-    gem 'mutex_m'
-  end
-end
-
-appraise 'rails-5.1' do
-  gem 'rails', '~> 5.1.0'
-  if RUBY_VERSION >= '3.4.0'
-    gem 'base64'
-    gem 'mutex_m'
-  end
-end
-
-appraise 'rails-5.2' do
-  gem 'rails', '~> 5.2.0'
-  if RUBY_VERSION >= '3.4.0'
-    gem 'base64'
-    gem 'mutex_m'
-  end
-end
-
-appraise 'rails-6.0' do
-  gem 'rails', '~> 6.0.0'
-  if RUBY_VERSION >= '3.4.0'
-    gem 'drb'
-    gem 'mutex_m'
-  end
-end
-
-appraise 'rails-6.1' do
-  gem 'rails', '~> 6.1.0'
-  if RUBY_VERSION >= '3.4.0'
-    gem 'drb'
-    gem 'mutex_m'
-  end
-end
-
-if RUBY_VERSION >= '2.7.0'
-  appraise 'rails-7.0' do
-    gem 'rails', '~> 7.0.0'
-    if RUBY_VERSION >= '3.4.0'
-      gem 'drb'
-      gem 'mutex_m'
-    end
-  end
-
-  appraise 'rails-7.1' do
-    gem 'rails', '~> 7.1.0'
-  end
-end
-
-if RUBY_VERSION >= '3.1.0'
-  appraise 'rails-7.2' do
-    gem 'rails', '~> 7.2.0'
-  end
-end
-
-if RUBY_VERSION >= '3.2.0'
-  appraise 'rails-8.0' do
-    gem 'rails', '~> 8.0.0'
-  end
-
-  appraise 'rails-8.1' do
-    gem 'rails', '~> 8.1.0'
-  end
-end

data/Rakefile

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

data/eslint.config.js

@@ -1,232 +0,0 @@
-import js from '@eslint/js';
-import globals from 'globals';
-
-export default [
-  js.configs.recommended,
-  {
-    ignores: [
-      'node_modules/**',
-      'vendor/**',
-      'tmp/**',
-      'test/generators/tmp/**',
-      'eslint.config.js'
-    ]
-  },
-  {
-    files: ['**/*.js'],
-    languageOptions: {
-      ecmaVersion: 5,
-      sourceType: 'script',
-      globals: {
-        ...globals.browser,
-        turnstile: 'readonly',
-        Turbolinks: 'readonly'
-      }
-    },
-    rules: {
-      'for-direction': 'error',
-      'getter-return': 'error',
-      'no-mixed-operators': 'error',
-      'no-await-in-loop': 'error',
-      'no-compare-neg-zero': 'error',
-      'no-cond-assign': 'error',
-      'no-console': 'warn',
-      'no-constant-condition': 'error',
-      'no-control-regex': 'error',
-      'no-debugger': 'error',
-      'no-dupe-args': 'error',
-      'no-dupe-keys': 'error',
-      'no-duplicate-case': 'error',
-      'no-empty': 'error',
-      'no-empty-character-class': 'error',
-      'no-ex-assign': 'error',
-      'no-extra-boolean-cast': 'error',
-      'no-extra-parens': 'off',
-      'no-extra-semi': 'error',
-      'no-func-assign': 'error',
-      'no-inner-declarations': ['error', 'both'],
-      'no-invalid-regexp': 'error',
-      'no-irregular-whitespace': 'error',
-      'no-obj-calls': 'error',
-      'no-prototype-builtins': 'error',
-      'no-regex-spaces': 'error',
-      'no-sparse-arrays': 'error',
-      'no-template-curly-in-string': 'off',
-      'no-unexpected-multiline': 'error',
-      'no-unreachable': 'error',
-      'no-unsafe-finally': 'error',
-      'no-unsafe-negation': 'error',
-      'use-isnan': 'error',
-      'valid-typeof': 'error',
-
-      // BEST PRACTICES
-      'accessor-pairs': 'error',
-      'array-callback-return': 'error',
-      'block-scoped-var': 'error',
-      'consistent-return': 'error',
-      curly: 'error',
-      'default-case': 'error',
-      'dot-location': ['error', 'property'],
-      'dot-notation': 'error',
-      eqeqeq: 'error',
-      'guard-for-in': 'error',
-      'no-alert': 'error',
-      'no-caller': 'error',
-      'no-case-declarations': 'error',
-      'no-div-regex': 'error',
-      'no-else-return': 'error',
-      'no-empty-function': 'error',
-      'no-empty-pattern': 'error',
-      'no-eq-null': 'error',
-      'no-eval': 'error',
-      'no-extend-native': 'error',
-      'no-extra-bind': 'error',
-      'no-extra-label': 'error',
-      'no-fallthrough': 'error',
-      'no-floating-decimal': 'error',
-      'no-global-assign': 'error',
-      'no-implicit-coercion': 'error',
-      'no-implicit-globals': 'error',
-      'no-implied-eval': 'error',
-      'no-invalid-this': 'off',
-      'no-iterator': 'error',
-      'no-labels': 'error',
-      'no-lone-blocks': 'error',
-      'no-loop-func': 'error',
-      'no-magic-numbers': 'off',
-      'no-multi-spaces': 'error',
-      'no-multi-str': 'error',
-      'no-new': 'off',
-      'no-new-func': 'error',
-      'no-new-wrappers': 'error',
-      'no-octal': 'error',
-      'no-octal-escape': 'error',
-      'no-param-reassign': 'error',
-      'no-proto': 'error',
-      'no-redeclare': 'error',
-      'no-restricted-properties': 'error',
-      'no-return-assign': 'error',
-      'no-return-await': 'error',
-      'no-script-url': 'error',
-      'no-self-assign': 'error',
-      'no-self-compare': 'error',
-      'no-sequences': 'error',
-      'no-throw-literal': 'error',
-      'no-unmodified-loop-condition': 'error',
-      'no-unused-expressions': 'error',
-      'no-unused-labels': 'error',
-      'no-useless-call': 'error',
-      'no-useless-concat': 'error',
-      'no-useless-escape': 'error',
-      'no-useless-return': 'error',
-      'no-void': 'error',
-      'no-warning-comments': 'error',
-      'no-with': 'error',
-      'prefer-promise-reject-errors': 'error',
-      radix: 'error',
-      'require-await': 'error',
-      'vars-on-top': 'error',
-      'wrap-iife': 'error',
-      yoda: 'error',
-
-      // STRICT MODE - allow function-level strict mode for IIFEs
-      strict: ['error', 'function'],
-
-      // VARIABLES
-      'no-delete-var': 'error',
-      'no-label-var': 'error',
-      'no-restricted-globals': 'error',
-      'no-shadow': 'error',
-      'no-shadow-restricted-names': 'error',
-      'no-undef': 'warn',
-      'no-undef-init': 'error',
-      'no-undefined': 'error',
-      'no-unused-vars': 'error',
-      'no-use-before-define': 'error',
-
-      // STYLISTIC ISSUES
-      'array-bracket-spacing': ['error', 'never'],
-      'block-spacing': 'error',
-      'brace-style': ['error', 'stroustrup'],
-      camelcase: 'error',
-      'comma-dangle': ['error', 'never'],
-      'comma-spacing': 'error',
-      'comma-style': 'error',
-      'computed-property-spacing': ['error', 'never'],
-      'consistent-this': ['error', 'null'],
-      'eol-last': ['error', 'always'],
-      'func-call-spacing': ['error', 'never'],
-      'func-name-matching': ['error', 'always'],
-      'func-style': 'off',
-      'function-paren-newline': ['error', 'never'],
-      indent: ['error', 2],
-      'key-spacing': ['error', {beforeColon: false, afterColon: true}],
-      'keyword-spacing': ['error', {after: true}],
-      'linebreak-style': ['error', 'unix'],
-      'lines-between-class-members': ['error', 'always'],
-      'max-depth': ['error', 4],
-      'max-len': ['error', 120, 4],
-      'max-nested-callbacks': ['error', 3],
-      'max-params': ['error', 5],
-      'max-statements': ['error', 30],
-      'max-statements-per-line': ['error', {max: 2}],
-      'multiline-comment-style': ['error', 'starred-block'],
-      'new-cap': 'error',
-      'new-parens': 'error',
-      'no-array-constructor': 'error',
-      'no-bitwise': 'error',
-      'no-lonely-if': 'error',
-      'no-mixed-spaces-and-tabs': 'error',
-      'no-multiple-empty-lines': ['error', {max: 1, maxBOF: 0, maxEOF: 0}],
-      'no-negated-condition': 'error',
-      'no-nested-ternary': 'error',
-      'no-new-object': 'error',
-      'no-tabs': 'error',
-      'no-trailing-spaces': 'error',
-      'no-unneeded-ternary': 'error',
-      'no-whitespace-before-property': 'error',
-      'nonblock-statement-body-position': ['error', 'beside'],
-      'object-curly-spacing': ['error', 'never'],
-      'operator-assignment': ['error', 'always'],
-      'operator-linebreak': 'error',
-      'padded-blocks': ['error', 'never'],
-      'padding-line-between-statements': [
-        'error',
-        {blankLine: 'always', prev: '*', next: 'block'},
-        {blankLine: 'always', prev: '*', next: 'block'},
-        {blankLine: 'always', prev: '*', next: 'class'},
-        {blankLine: 'always', prev: '*', next: 'export'},
-        {blankLine: 'always', prev: '*', next: 'multiline-block-like'},
-        {blankLine: 'always', prev: 'block', next: '*'},
-        {blankLine: 'always', prev: 'block-like', next: '*'},
-        {blankLine: 'always', prev: 'class', next: '*'},
-        {blankLine: 'always', prev: 'default', next: '*'},
-        {blankLine: 'always', prev: 'multiline-block-like', next: '*'},
-        {blankLine: 'never', prev: 'import', next: 'import'}
-      ],
-      'quote-props': ['error', 'as-needed'],
-      quotes: ['error', 'single'],
-      semi: ['error', 'always'],
-      'semi-spacing': ['error', {before: false, after: true}],
-      'semi-style': ['error', 'last'],
-      'space-before-blocks': ['error', 'always'],
-      'space-before-function-paren': ['error', 'never'],
-      'space-in-parens': ['error', 'never'],
-      'space-infix-ops': 'error',
-      'space-unary-ops': ['error', {words: true, nonwords: false}],
-      'spaced-comment': ['error', 'always'],
-      'switch-colon-spacing': ['error', {before: false, after: true}],
-      'template-tag-spacing': ['error', 'always'],
-      'unicode-bom': ['error', 'never'],
-      'wrap-regex': 'error',
-
-      // ES6+ rules - disabled for older browser compatibility
-      'no-var': 'off',
-      'prefer-const': 'off',
-      'prefer-arrow-callback': 'off',
-      'prefer-rest-params': 'off',
-      'prefer-spread': 'off',
-      'prefer-template': 'off'
-    }
-  }
-];

data/package.json

@@ -1,14 +0,0 @@
-{
-  "name": "cloudflare-turnstile-rails",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.17.0",
-    "eslint": "^9.17.0",
-    "globals": "^15.14.0"
-  }
-}