rails-fort 0.1.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 08b7b0c97e01bf4cbec192e7a1af23030317ccb0
-  data.tar.gz: c02deb8fe42a71bbf114af126027c8907ac9a68b
+SHA256:
+  metadata.gz: 4def9cb0b3f3e14b33e1b34efa92e70dba9d7aea7f57cfe69c1d141cbfc5f149
+  data.tar.gz: 17bace62f5d924ecf13daf02f8836eb48f3a3e07ee96c7f14235988d1c5d00cf
 SHA512:
-  metadata.gz: ae70e99e7537819869c0bff39d097ef2fa500dd0ec2dacc1c7a01c06ae1ee054ee87dbdcf110afbede9e2f2989c9bd2f33270ebec333aadb58dcf2801baa523d
-  data.tar.gz: e225f341e2f4d99089a6d01f57f01907c74111e3f1dab6e4c7c5f8f178f55b963c1b9c367c5a0f798668c7a35d6ad3fa5539a64fdad9ab860e5c392d6f3de9db
+  metadata.gz: a5a4098a1bb92800febb3bd8ac7df48994b2e5d2b79a8eb144c13dbd98f4f7f5c91d57a2d1071777c5faecb91b1e8c1637e07e0f0bacef54ea75235f35278e6e
+  data.tar.gz: 0e54e8564ebceee75c96101308abf3bb31b293def4ba571e098f68366ebf68fae0f0a8f4b2b8966753be216be70536e2105afc2ca13a62e5e4dada221e176194

data/.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.0', '3.1', '3.2', '3.3']
+        rails: ['6.0', '6.1', '7.0', '7.1', '7.2', '8.0']
+        exclude:
+          # Rails 7.2+ requires Ruby 3.1+
+          - ruby: '3.0'
+            rails: '7.2'
+          - ruby: '3.0'
+            rails: '8.0'
+
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Run tests
+      run: bundle exec rake
+
+    - name: Run RuboCop
+      run: bundle exec rubocop
+
+  security:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: true
+
+    - name: Security audit
+      run: bundle exec bundle-audit --update

data/.gitignore

@@ -1,9 +1,38 @@
+## Ruby/Bundler
 /.bundle/
-/.yardoc
+/vendor/bundle/
 /Gemfile.lock
+
+## Documentation
+/.yardoc/
 /_yardoc/
-/coverage/
 /doc/
-/pkg/
+/rdoc/
+
+## Testing
+/coverage/
 /spec/reports/
+/test/tmp/
+/test/version_tmp/
+
+## Build artifacts
+/pkg/
 /tmp/
+*.gem
+
+## IDE and OS files
+.DS_Store
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.ruby-version
+.ruby-gemset
+
+## Environment
+.env
+.env.local
+
+## Logs
+npm-debug.log

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'vendor/**/*'
+    - 'bin/**/*'
+    - 'app/assets/javascripts/fort.js'
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - '*.gemspec'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Gemspec/AddRuntimeDependency:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.0] - 2026-05-30
+
+First modern release on RubyGems.
+
+### Added
+
+- New vanilla JavaScript implementation (`fort.js`) — no jQuery, no `document.body` rewriting
+- `fort.css` as a first-class stylesheet (include via `*= require fort`)
+- Support for `fort-ignore` class in addition to `ignore`
+- Accessible progress bar attributes (`role="progressbar"`, `aria-*`)
+- Explicit `railties` runtime dependency (>= 6.0, < 9.0)
+- GitHub Actions CI, RuboCop, bundler-audit, RSpec
+- CHANGELOG, UPGRADE_GUIDE, and modern README
+
+### Changed
+
+- **Breaking (JS):** Replaced legacy vendored `fort.min.js` with `FortProgress` class
+- **Breaking (Ruby):** Minimum Ruby 3.0, Rails 6.0+
+- `config/fort.yml` format unchanged (`type`, `value`, `height`, `duration`, `alignment`)
+- Progress bar DOM uses `.fort-bar` (legacy `.top-one` / `.top-two` classes retained in CSS for compatibility)
+
+### Removed
+
+- jQuery dependency
+- Legacy vendor `fort.min.js` and `fort.min.css`
+- Travis CI
+
+### Notes
+
+- Original upstream Fort.js GitHub repository is unavailable; JS is maintained in this gem
+
+## [0.2.0] - Previous Release
+
+- jQuery-based integration with vendored Fort.js
+- Form completion progress bar with `config/fort.yml`
+
+---
+
+For upgrade instructions, see [UPGRADE_GUIDE.md](UPGRADE_GUIDE.md)

data/CODE_OF_CONDUCT.md

@@ -11,3 +11,4 @@ Project maintainers have the right and responsibility to remove, edit, or reject
 Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
 
 This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
+

data/Gemfile

@@ -1,4 +1,9 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in rails-fort.gemspec
 gemspec
+
+if (rails_version = ENV.fetch("RAILS_VERSION", nil))
+  gem "railties", "~> #{rails_version}.0"
+end

data/README.md

@@ -1,101 +1,138 @@
 # Rails::Fort
 
-[![Build Status](https://travis-ci.org/ethirajsrinivasan/rails-fort.svg?branch=master)](https://travis-ci.org/ethirajsrinivasan/rails-fort)
-[![Code Climate](https://codeclimate.com/github/ethirajsrinivasan/rails-fort/badges/gpa.svg)](https://codeclimate.com/github/ethirajsrinivasan/rails-fort)
-[![security](https://hakiri.io/github/ethirajsrinivasan/rails-fort/master.svg)](https://hakiri.io/github/ethirajsrinivasan/rails-fort/master)
+[![CI](https://github.com/ethirajsrinivasan/rails-fort/actions/workflows/ci.yml/badge.svg)](https://github.com/ethirajsrinivasan/rails-fort/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/rails-fort.svg)](https://badge.fury.io/rb/rails-fort)
 
+Modern progress bar for form completion
 
- rails-fort gem gives you modern progress bar for form completion
+## Requirements
+
+- Ruby >= 3.0
+- Rails >= 6.0
+- No jQuery required
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rails-fort'
+gem 'rails-fort', '~> 1.0'
 ```
 
 And then execute:
 
-    $ bundle install
+```bash
+bundle install
+```
 
-Or install it yourself as:
+### Asset Pipeline Setup
 
-    $ gem install rails-fort
+**For Rails 6.x / 7.x with Sprockets:**
 
-To use this gem add this require statement to your application.js file:
+In `app/assets/javascripts/application.js`:
 
-	//= require fort
+```javascript
+//= require rails_fort
+```
 
-and in application.css file
+In `app/assets/stylesheets/application.css`:
 
-	*= require fort
+```css
+*= require fort
+```
 
+**For Rails 7+ with Import Maps:**
 
-## Usage
+Add to `config/importmap.rb`:
 
-rails-fort will automatically detect all `<input>` inside form
+```ruby
+pin "rails_fort", to: "rails_fort.js"
+pin "fort", to: "fort.js"
+```
 
-Certain fields:
+Import in `application.js`:
 
-If you want to exclude certain fields add a class named 'ignore' to the field. rails-fort will not detect the field after you do so.
+```javascript
+import "rails_fort"
+```
 
-Example
+Include `fort.css` through your stylesheet pipeline or asset host.
 
-		<input type="text" class='ignore'>
+## Usage
 
+Rails-Fort tracks `input`, `textarea`, and `select` fields inside forms and shows a fixed progress bar as the user completes the form.
 
-You can also set default configuration in fort.yml under config folder, example
+### Exclude fields
 
-	height: '20px'
-	duration: '3s'
-	alignment: 'bottom'
-	type: 'solid'
-	value: '#009DFF'
+Add `ignore` or `fort-ignore` to skip a field:
 
+```html
+<input type="text" class="ignore">
+```
 
-Effects:
+### Configuration (`config/fort.yml`)
 
-   * Solid
+```yaml
+height: '20px'
+duration: '3s'
+alignment: 'bottom'
+type: 'solid'
+value: '#009DFF'
+```
 
-      	type: 'solid'
-     	value: '#009DFF'
+### Effects
 
-   * Gradient
+**Solid**
 
-	   	type: 'gradient'
-	   	value: ["#009DFF", "#47B9FF"]
+```yaml
+type: 'solid'
+value: '#009DFF'
+```
+
+**Gradient** (two colors)
+
+```yaml
+type: 'gradient'
+value: ['#009DFF', '#47B9FF']
+```
+
+**Sections**
 
-	   	Note: Only two values can be passed
+```yaml
+type: 'sections'
+value: ['#009DFF', '#4AF2A1', '#FB5229']
+```
 
-   * Sections
+**Flash**
 
-   		type: 'sections'
-   		value: ["#009DFF", "#4AF2A1", "#FB5229"]
+```yaml
+type: 'flash'
+value: ['#009DFF', '#000', '#6638F0']
+```
 
-   * Flash
+**Merge**
 
-   		type: 'flash'
-   		value: ["#009DFF", "#000", "#6638F0"]
+```yaml
+type: 'merge'
+value: '#009DFF'
+```
 
-   * Merge
+## Upgrading
 
-   		type: 'merge'
-   		value: '#009DFF'
+Upgrading from the legacy **0.x** gem? See [UPGRADE_GUIDE.md](UPGRADE_GUIDE.md) for **1.0.0**.
 
-effects can be added by changing type and value fields in fort.yml
+## JavaScript
 
+The progress bar is implemented in vanilla JavaScript (`app/assets/javascripts/fort.js`) and vendored inside this gem. The original [Fort.js](https://github.com/idriskhenchil/Fort.js) repository by Idris Khenchil is no longer available; this gem maintains a compatible `fort.yml` API with a new implementation.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ethirajsrinivasan/rails-fort. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ethirajsrinivasan/rails-fort. Contributors are expected to adhere to the [Contributor Covenant](CODE_OF_CONDUCT.md) code of conduct.
 
-##Thanks
-
-Thanks to [Idris Khenchil](https://github.com/idriskhenchil/Fort.js) for writing an awesome fort plugin.
+## Thanks
 
+Thanks to Idris Khenchil for the original Fort.js form progress bar concept.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new
-task :default => :spec
+task default: :spec

data/UPGRADE_GUIDE.md

@@ -0,0 +1,107 @@
+# Upgrade Guide: Rails-Fort 0.x to 1.0.0
+
+## Overview
+
+Rails-Fort **1.0.0** is the first modern release on RubyGems. It combines Ruby/Rails modernization (Ruby 3.0+, Rails 6.0+) with a **rewritten JavaScript engine** while keeping the same `config/fort.yml` format.
+
+## What Changed
+
+### Ruby & Rails
+
+| Component | 0.x | 1.0.0 |
+|-----------|-----|-------|
+| Ruby | >= 2.7 (varied) | >= 3.0 |
+| Rails | >= 4.2 | >= 6.0 |
+
+### JavaScript
+
+| Topic | 0.x | 1.0.0 |
+|-------|-----|-------|
+| jQuery | Required | **Not required** |
+| Implementation | Vendored legacy `fort.min.js` | New `fort.js` (`FortProgress`) |
+| CSS | Bundled minified vendor file | `*= require fort` in your stylesheet manifest |
+| DOM behavior | Rewrote `document.body` innerHTML | Inserts progress bar elements only |
+| Ignore class | `ignore` | `ignore` or `fort-ignore` |
+| Upstream repo | idriskhenchil/Fort.js (now 404) | Maintained in this gem |
+
+### Unchanged
+
+- `config/fort.yml` keys: `height`, `duration`, `alignment`, `type`, `value`
+- Effect types: `solid`, `gradient`, `sections`, `flash`, `merge`
+- `//= require rails_fort` in `application.js`
+
+## Upgrade Steps
+
+### 1. Update Gemfile
+
+```ruby
+gem 'rails-fort', '~> 1.0'
+```
+
+```bash
+bundle update rails-fort
+```
+
+### 2. Add stylesheet (new in 1.0)
+
+In `app/assets/stylesheets/application.css` (or equivalent):
+
+```css
+*= require fort
+```
+
+### 3. Remove jQuery requirement
+
+You no longer need jQuery for rails-fort. Remove any load order that existed only for this gem.
+
+### 4. Keep `config/fort.yml`
+
+Existing configuration should work as-is, for example:
+
+```yaml
+height: '20px'
+duration: '3s'
+alignment: 'bottom'
+type: 'solid'
+value: '#009DFF'
+```
+
+### 5. Test your forms
+
+1. Load a page with a form
+2. Confirm the progress bar appears (top or bottom per `alignment`)
+3. Fill fields and verify width/color effects
+4. Confirm fields with class `ignore` are skipped
+
+## Troubleshooting
+
+### Progress bar not visible
+
+- Ensure **both** JS and CSS are included (`rails_fort` + `fort` stylesheet)
+- Check the browser console for errors
+- Verify `config/fort.yml` is valid YAML
+
+### Custom CSS targeting old markup
+
+1.0 still applies `.top-one` and `.top-two` on bar elements for compatibility. Prefer `.fort-bar` for new custom styles.
+
+### Turbo / Turbolinks
+
+Re-initialize on page change if needed:
+
+```javascript
+document.addEventListener("turbo:load", function () {
+  if (window._railsFortInstance) {
+    window._railsFortInstance.destroy();
+    window._railsFortInstance = new FortProgress(/* your config */);
+    window._railsFortInstance.init();
+  }
+});
+```
+
+For Sprockets-only apps, a full page load re-runs `rails_fort.js.erb` automatically.
+
+## Getting Help
+
+- [GitHub Issues](https://github.com/ethirajsrinivasan/rails-fort/issues)
+- [CHANGELOG.md](CHANGELOG.md)