formstrap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ef711395960778d13a1deabebd22b2745d05b3f23cead8088c0213e051fca436
+  data.tar.gz: 14080e33cab4d2f4403188d0fac4c097a8ca1a5179465bf83eb0cc42c951161f
+SHA512:
+  metadata.gz: 79982ab77ff7cf658c946d0d4a8f574af5b1c6a95aad44ec746a48fde13341fe82fb9ea4f77e664324868a2671a2b37ea3d9aacc08d13ae24cb1cbd710e7a4cd
+  data.tar.gz: d400b9aa96761a49ad6cf07736e876110c4d5360ade1337888b4c86dbac3cb981254118dedb0a13cc4aa3d66951c7a1fb9630be1fbe42826dd0cbc0b185f03cc

data/.gitignore

@@ -0,0 +1,33 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/node_modules/
+
+# Ignore dummy app
+/test/dummy/log/*
+/test/dummy/tmp/*
+/test/dummy/db/*.sqlite3
+/test/dummy/db/*.sqlite3-*
+!/test/dummy/log/.keep
+!/test/dummy/tmp/.keep
+/test/dummy/tmp/pids/*
+!/test/dummy/tmp/pids/
+!/test/dummy/tmp/pids/.keep
+/test/dummy/storage/*
+!/test/dummy/storage/.keep
+/test/dummy/public/assets
+
+# Ingore editors
+/.idea
+/headmin.iml
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Formstap Changelog

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 vlamingsjef@gmail.com. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,28 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in formstrap.gemspec
+gemspec
+
+gem "capybara", ">= 3.26"
+gem "minitest", "~> 5.0"
+gem "minitest-spec-rails", "~> 6.1"
+gem "puma", "~> 5.2"
+gem "rails", "~> 7.0"
+gem "rake", "~> 13.0"
+gem "sprockets-rails", "~> 3.4"
+gem "sqlite3", "~> 1.4"
+gem "standard", "~> 1.7"
+gem "debug"
+
+# Dummy app
+gem "devise", "~> 4.8"
+gem "enumerize", "~> 2.3"
+gem "sassc-rails", "~> 2.1"
+gem "image_processing", "~> 1.2"
+gem "inline_svg", "~> 1.7"
+gem "kaminari", "~> 1.2"
+gem "route_translator", "~> 12.0"
+gem "acts_as_list", "~> 1.0"
+gem "breadcrumbs_on_rails", "~> 4.1"
+gem "importmap-rails", "~> 1.0"
+gem "hotwire-rails", "~> 0.1"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jef Vlamings
+
+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,118 @@
+# Formstrap
+
+An extensive Bootstrap form library to power your Ruby On Rails application.
+
+## Installation
+
+Add this line to your application's gemfile ```./Gemfile```
+
+```bash
+gem 'formstrap'
+```
+
+Afterwards, run:
+
+```bash
+bundle
+```
+
+## Usage
+
+### Getting started
+
+Use the Formstrap helpers ```formstrap_form_for``` or ```formstrap_form_with``` instead of the Ruby on Rails helpers
+```form_for``` or ```form_with```.
+
+An example:
+
+```erb
+<%= formstrap_form_for(@user) do |f| %>
+  <%= f.email :email, required: true %>
+  <%= f.password :password, required: true %>
+  <%= f.checkbox :remember_me, required: true %>
+  <%= f.submit "Log In" %>
+<% end %>
+```
+
+As you might have noticed, Formstrap uses different named form helpers than Ruby on Rails.
+
+If the original Rails helper needs to be accessed, it can be accessed by:
+
+```erb
+<%= formstrap_for_for(@user) do |f| %>
+  <%= f.text :name, formstrap: false %>
+  <%= f.text_field :name %>
+<% end %>
+```
+
+An overview of all the Formstrap / Ruby on Rails form helpers:
+
+| Type              | Formstrap helpers | Ruby on Rails helpers                       |
+|-------------------|-------------------|---------------------------------------------|
+| Association       | association       | N/A                                         |
+| Checkbox          | checkbox          | checkbox formstrap: false or check_box      |
+| Color             | color             | color formstrap: false or color_field       |
+| Date              | date              | date formstrap: false or date_field         |
+| Date range        | date_range        | N/A                                         |
+| Datetime          | datetime          | datetime formstrap: false or datetime_field |
+| Datetime range    | datetime_range    | N/A                                         |
+| Email             | email             | email formstrap: false or email_field       |
+| File              | file              | file formstrap: false or file_field         |
+| Flatpickr *       | flatpickr         | N/A                                         |
+| Flatpickr range * | flatpickr_range   | N/A                                         |
+| Hidden            | hidden            | hidden formstrap: false or hidden_field     |
+| Media             | media             | N/A                                         |
+| Number            | number            | number formstrap: false or number_field     |
+| Password          | password          | password formstrap: false or password_field |
+| RedactorX *       | redactorx         | N/A                                         |
+| Search            | search            | N/A                                         |
+| Select            | select            | select formstrap: false                     |
+| Switch            | switch            | N/A                                         |
+| Text              | text              | text formstrap: false or text_field         |
+| Textarea          | textarea          | textarea formstrap: false or text_area      |
+| URL               | url               | url formstrap: false or url_field           |
+| WYSIWYG *         | wysiwyg           | N/A                                         |
+
+\* Formstrap provides the implementation of these 3rd party libraries, however it is up to the user to provide the
+correct assets.
+
+As you might have noticed, Formstrap provides more helpers than what is standard in Ruby on Rails, e.g. ```Media```, ```Date range```, ```RedactorX``` ...
+
+### Altering Formstrap helpers
+
+Because Formstrap uses html and Ruby on Rails helpers behind the scenes to render its helpers, editing the Formstrap
+helpers is straightforward.
+
+As Formstrap is an engine, its views are within the gem. In order to have a copy of the views inside your application,
+run:
+
+```bash
+rails generate formstrap:views
+```
+
+This will create a directory ```./views/formstrap```, in which all the views (and its helpers) are copied in and can thus be
+inspected / altered. Because Formstrap is an engine, the application's local files take precedence over the engine's files.
+
+Note that on new releases, one can once more run:
+
+```bash
+rails generate formstrap:views
+```
+
+To get new or updated versions of the helpers. **This will override the files that are already present (and which might contain your personal adjustments)**.
+
+### Extending Formstrap helpers
+
+Extending Formstrap helpers is straightforward.
+
+Add your custom Formstrap (e.g. map) helper into the map ```./views/formstrap```. Formstrap makes it possible to access this helper is by its filename.
+
+
+```erb
+<%# custom Formstrap helper file: ./views/formstrap/_map.html.erb %>
+
+<%= formstrap_form_for(@user) do |f| %>
+    <%= f.map :address %>
+<% end %>
+```
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: %i[test]

data/app/assets/config/headmin_manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_tree ../javascripts

data/app/assets/javascripts/formstrap/config/i18n.js

@@ -0,0 +1,11 @@
+export default class {
+  static get locale () {
+    if (window.I18n === undefined) {
+      const locale = document.querySelector('html').getAttribute('lang')
+      window.I18n = {
+        locale: locale || 'en'
+      }
+    }
+    return window.I18n.locale
+  }
+}

data/app/assets/javascripts/formstrap/controllers/autocomplete_controller.js

@@ -0,0 +1,318 @@
+/* global fetch, Event */
+import { Controller } from '@hotwired/stimulus'
+
+export default class extends Controller {
+  static get targets () {
+    return ['input', 'dropdown', 'dropdownItem']
+  }
+
+  static get values () {
+    return {
+      url: String
+    }
+  }
+
+  connect () {
+    // Focus
+    this.inputTarget.addEventListener('focus', (event) => {
+      this.show()
+    })
+
+    // Navigation
+    this.inputTarget.addEventListener('keydown', (event) => {
+      this.handleKeydown(event)
+    })
+
+    // Typing
+    this.inputTarget.addEventListener('keyup', (event) => {
+      this.handleKeyup(event)
+    })
+
+    // Clicked outside dropdown
+    document.addEventListener('click', (event) => {
+      this.handleOutsideClick(event)
+    })
+  }
+
+  handleKeydown (event) {
+    const keyCode = parseInt(event.keyCode, 10)
+    if (this.isArrowKey(keyCode)) {
+      this.handleArrowKey(keyCode)
+    }
+
+    if (this.isEnterKey(keyCode)) {
+      this.selectActiveItem(event)
+    }
+  }
+
+  handleKeyup (event) {
+    // Ignore arrow keys or enters
+    const keyCode = parseInt(event.keyCode, 10)
+    if (this.isArrowKey(keyCode) || this.isEnterKey(keyCode)) {
+      return false
+    }
+
+    this.handleTextKey()
+  }
+
+  selectActiveItem (event) {
+    const activeItem = this.activeItem()
+    if (activeItem) {
+      this.deselectAll()
+      this.setValue(activeItem.getAttribute('value'))
+      event.preventDefault()
+    }
+  }
+
+  isEnterKey (keyCode) {
+    return keyCode === 13
+  }
+
+  handleArrowKey (keyCode) {
+    this.show()
+    switch (keyCode) {
+      case 38:
+        this.handleArrowUp()
+        break
+      case 40:
+        this.handleArrowDown()
+        break
+      default:
+    }
+  }
+
+  handleArrowUp () {
+    this.selectPreviousItem()
+  }
+
+  handleArrowDown () {
+    this.selectNextItem()
+  }
+
+  selectNextItem () {
+    const next = this.nextItem()
+    if (next) {
+      this.deselectAll()
+      next.classList.add('active')
+    }
+  }
+
+  nextItem () {
+    const current = this.activeItem()
+
+    // Select first item if nothing selected
+    if (!this.hasSelectedItem()) {
+      return this.firstItem()
+    }
+
+    if (this.isItemLast(current)) {
+      return this.firstItem()
+    } else {
+      const index = this.itemIndex(current)
+      return this.itemAtIndex(index + 1)
+    }
+  }
+
+  selectPreviousItem () {
+    const previous = this.previousItem()
+    if (previous) {
+      this.deselectAll()
+      previous.classList.add('active')
+    }
+  }
+
+  previousItem () {
+    const current = this.activeItem()
+
+    // Select last item if nothing selected
+    if (!this.hasSelectedItem()) {
+      return this.lastItem()
+    }
+
+    if (this.isItemFirst(current)) {
+      return this.lastItem()
+    } else {
+      const index = this.itemIndex(current)
+      return this.itemAtIndex(index - 1)
+    }
+  }
+
+  deselectAll () {
+    this.dropdownItemTargets.forEach(dropdownItem => {
+      dropdownItem.classList.remove('active')
+    })
+  }
+
+  itemAtIndex (index) {
+    return this.dropdownItemTargets[index]
+  }
+
+  firstItem () {
+    return this.itemAtIndex(0)
+  }
+
+  lastItem () {
+    return this.itemAtIndex(this.dropdownItemTargets.length - 1)
+  }
+
+  hasSelectedItem () {
+    return this.activeItem() !== undefined
+  }
+
+  activeItem () {
+    return this.dropdownItemTargets.find((item) => {
+      return item.classList.contains('active')
+    })
+  }
+
+  isItemLast (item) {
+    return this.itemIndex(item) === this.dropdownItemTargets.length - 1
+  }
+
+  isItemFirst (item) {
+    return this.itemIndex(item) === 0
+  }
+
+  itemIndex (item) {
+    return Array.from(this.dropdownItemTargets).indexOf(item)
+  }
+
+  handleTextKey () {
+    // 1. fetch info
+    this.fetchCollection().then((html) => {
+      // 2. render html
+      this.renderCollection(html)
+    }).then(() => {
+      // 3. Highlight
+      this.highlight()
+    }).then(() => {
+      // 4. Preselect first result
+      this.activateFirstItem()
+    }).then(() => {
+      // 5. Show results
+      this.show()
+    })
+  }
+
+  activateFirstItem () {
+    this.deselectAll()
+    this.firstItem().classList.add('active')
+  }
+
+  show () {
+    if (this.isDropdownEmpty()) {
+      this.dropdownTarget.classList.remove('d-none')
+    } else {
+      this.hide()
+    }
+  }
+
+  hide () {
+    this.dropdownTarget.classList.add('d-none')
+  }
+
+  isDropdownEmpty () {
+    return this.dropdownTarget.textContent.trim().length > 0
+  }
+
+  isArrowKey (keyCode) {
+    const arrowKeyCodes = [37, 38, 39, 40]
+    return arrowKeyCodes.includes(keyCode)
+  }
+
+  fetchCollection () {
+    if (this.isRemote()) {
+      return fetch(this.remoteURL()).then((response) => {
+        return response.text()
+      }).catch((error) => {
+        console.error('The URL you provided for the autocomplete collection didn\'t return a successful result', error)
+      })
+    } else {
+      return Promise.resolve(this.dropdownTarget.innerHTML)
+    }
+  }
+
+  remoteURL () {
+    // Set dummy base in case a relative path is provided as remote URL
+    const base = 'https://example.com'
+    const url = new URL(this.urlValue, base)
+
+    // Update pagination params
+    const params = new URLSearchParams(url.search)
+    params.set('search', this.value())
+    params.set('page', '1')
+    params.set('per_page', '6')
+    url.search = params.toString()
+
+    // Convert to string
+    let urlString = url.toString()
+
+    // Convert back to relative url if needed
+    if (urlString.includes(base)) {
+      urlString = urlString.replace(base, '')
+    }
+
+    return urlString
+  }
+
+  renderCollection (html) {
+    this.dropdownTarget.innerHTML = html
+  }
+
+  isRemote () {
+    return this.hasUrlValue
+  }
+
+  highlight () {
+    const query = this.value()
+    this.dropdownItemTargets.forEach(dropdownItem => {
+      let text = dropdownItem.innerHTML
+
+      // Clean up past results
+      text = text.replace(/<mark.*?>(.*?)<\/mark>/ig, '$1')
+
+      // Highlight query
+      if (query && query.length > 0) {
+        // Ignore all strings inside < >
+        const regex2 = new RegExp(`(?<!<[^>]*?)(&nbsp;)?(${query})`, 'gi')
+        text = text.replace(regex2, '<mark>$2</mark>')
+      }
+
+      dropdownItem.innerHTML = text
+    })
+  }
+
+  select (event) {
+    this.setValue(event.currentTarget.getAttribute('value'))
+  }
+
+  setValue (value) {
+    this.inputTarget.value = value
+    this.inputTarget.dispatchEvent(new Event('change'))
+    this.hide()
+  }
+
+  value () {
+    return this.inputTarget.value
+  }
+
+  numberOfCharacters () {
+    return this.value().length
+  }
+
+  handleOutsideClick (event) {
+    if (!this.isClickedInside(event)) {
+      this.hide()
+    }
+  }
+
+  isClickedInside (event) {
+    if (!event) {
+      return false
+    }
+    const inInput = this.inputTarget.contains(event.target)
+    const inDropdown = this.dropdownTarget.contains(event.target)
+
+    return (inInput || inDropdown)
+  }
+}