forme 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81ec9ce1b755276902340c709aa7addbd73b6b80252fcf0cbaac236098c62ac1
-  data.tar.gz: 35e17dd67304585e027dca62d6181eff1d30a0fcc7aa128879c9d8d54fd78f55
+  metadata.gz: 13efa41ba160d80619b779cda0ad94581b37695e9fb8caedc696d26c91c92d87
+  data.tar.gz: 6558cf408b4573b3822c566c8e48b856de47009c6293831e0cdcc3fed7f4ebc2
 SHA512:
-  metadata.gz: 16f13f8ba1ba9fdae6b26b80f0b2e1fa2ce9ef520a3a29936597771f9f5424d2b49afc6debdb173e2aee6d672a471bb1aa8cee8e73d82ce7f5d30a1fc8ced578
-  data.tar.gz: 89d6f1ef00b4a9b28b55d9a6f42fb5250d10eaec78a7921d6220451f2fe7ea5c4ecea7907bcef5567e5e1dbcb60ccf2ec52195a6a4bfaacf2c4c353c785e9049
+  metadata.gz: 42d8dd057d905a8cb44610c9b3c20c9d055d0f0495b8ec94b020a637d0b10f5c1919ebc697e0b4f8970a29fcb511661cc56d622dc1d91eb8f347ab62fe36d7c4
+  data.tar.gz: 10beb8c2109850be4c1fb5d0c46d13218269c8b65f604cda930024eab8ff3838f32ab70256696d93f5c17f3e011d5dad0450511051a6abda40e75e37c1bbf2eb

data/CHANGELOG

@@ -1,3 +1,9 @@
+=== 2.3.0 (2022-11-15)
+
+* Add forme/bs5 for Bootstrap 5 support (janko) (#106)
+
+* Raise exception if attempting to load Roda forme_set plugin without setting :secret option (janko) (#104) 
+
 === 2.2.0 (2022-06-28)
 
 * Use inputmode and pattern attributes instead of type=number for integer fields in the Sequel forme plugin (jeremyevans)

data/README.rdoc

@@ -1264,12 +1264,17 @@ You can mark a configuration as the default using:
 
   Forme.default_config = :mine
 
-=== Bootstrap 3 Support
+=== Bootstrap Support
 
-Forme ships with support for Bootstrap 3-4 HTML formatting. This support is shipped in
+Forme ships with support for Bootstrap 5 HTML formatting. This support is shipped in
 it's own file, so if you don't use it, you don't pay the memory penalty for loading
 it.
 
+  require 'forme/bs5'
+  Forme.default_config = :bs5
+
+There is also support for Bootstrap versions 3-4:
+
   require 'forme/bs3'
   Forme.default_config = :bs3
 

data/lib/forme/bs5.rb

@@ -0,0 +1,213 @@
+# frozen-string-literal: true
+
+module Forme
+  register_config(:bs5, formatter: :bs5, wrapper: :bs5, error_handler: :bs5, serializer: :bs5, labeler: :bs5, helper: :bs5, tag_wrapper: :bs5, set_wrapper: :div)
+
+  # Update the <tt>:class</tt> entry in the +attr+ hash with the given +classes+,
+  # adding the classes before any existing classes.
+  def self.attr_classes_after(attr, *classes)
+    attr[:class] = merge_classes(*classes, attr[:class])
+  end
+
+  class ErrorHandler::Bootstrap5
+    Forme.register_transformer(:error_handler, :bs5, new)
+
+    def call(tags, input)
+      attr = input.opts[:error_attr]
+      attr = attr ? attr.dup : {}
+
+      unless attr[:class] && attr[:class].include?("invalid-tooltip")
+        Forme.attr_classes(attr, "invalid-feedback")
+      end
+
+      attr[:id] ||= input.opts[:error_id]
+
+      [tags, input.tag(:div, attr, input.opts[:error])]
+    end
+  end
+
+  class Formatter::Bootstrap5 < Formatter
+    Forme.register_transformer(:formatter, :bs5, self)
+
+    private
+
+    def normalize_options
+      super
+
+      if @opts[:error]
+        # remove "error" class
+        @attr[:class] = @attr[:class].to_s.sub(/\s*error$/,'')
+        @attr.delete(:class) if @attr[:class].to_s == ''
+
+        Forme.attr_classes(@attr, "is-invalid")
+      end
+
+      if @opts[:help]
+        if @opts[:helper_attr] && @opts[:helper_attr][:id]
+          @attr["aria-describedby"] ||= @opts[:helper_attr][:id]
+        end
+      end
+    end
+  end
+
+  # Formatter that adds "readonly" for most input types,
+  # and disables select/radio/checkbox inputs.
+  #
+  # Registered as :bs5_readonly.
+  class Formatter::Bs5ReadOnly < Formatter
+    Forme.register_transformer(:formatter, :bs5_readonly, self)
+
+    private
+
+    # Disabled checkbox inputs.
+    def format_checkbox
+      @attr[:disabled] = :disabled
+      super
+    end
+
+    # Use a span with text instead of an input field.
+    def _format_input(type)
+      @attr[:readonly] = :readonly
+      super
+    end
+
+    # Disabled radio button inputs.
+    def format_radio
+      @attr[:disabled] = :disabled
+      super
+    end
+
+    # Use a span with text of the selected values instead of a select box.
+    def format_select
+      @attr[:disabled] = :disabled
+      super
+    end
+
+    # Use a span with text instead of a text area.
+    def format_textarea
+      @attr[:readonly] = :readonly
+      super
+    end
+  end
+
+  # Use a <table class="table"> tag to wrap the inputs.
+  #
+  # Registered as :bs5_table.
+  class InputsWrapper::Bs5Table
+    Forme.register_transformer(:inputs_wrapper, :bs5_table, new)
+
+    # Wrap the inputs in a <table> tag.
+    def call(form, opts, &block)
+      attr = opts[:attr] ? opts[:attr].dup : { :class=>'table table-bordered'}
+      form.tag(:table, attr) do
+        if legend = opts[:legend]
+          form.tag(:caption, opts[:legend_attr], legend)
+        end
+
+        if (labels = opts[:labels]) && !labels.empty?
+          form.tag(:tr, {}, labels.map{|l| form._tag(:th, {}, l)})
+        end
+
+        yield
+      end
+    end
+  end
+
+  class Labeler::Bootstrap5 < Labeler::Explicit
+    Forme.register_transformer(:labeler, :bs5, new)
+
+    def call(tag, input)
+      floating_label = (input.opts[:wrapper_attr] || {})[:class].to_s.include?("form-floating")
+      input.opts[:label_position] ||= :after if floating_label
+
+      tags = super
+      return tags if floating_label
+
+      attr = tags.find { |tag| tag.is_a?(Tag) && tag.type == :label }.attr
+
+      label_class = case input.type
+      when :radio, :checkbox
+        "form-check-label"
+      else
+        "form-label"
+      end
+      Forme.attr_classes_after(attr, label_class)
+
+      tags
+    end
+  end
+
+  class Helper::Bootstrap5
+    Forme.register_transformer(:helper, :bs5, new)
+
+    def call(tag, input)
+      attr = input.opts[:helper_attr]
+      attr = attr ? attr.dup : {}
+      Forme.attr_classes(attr, 'form-text')
+      [tag, input.tag(:div, attr, input.opts[:help])]
+    end
+  end
+
+  class Wrapper::Bootstrap5 < Wrapper
+    Forme.register_transformer(:wrapper, :bs5, new)
+
+    def call(tag, input)
+      attr = input.opts[:wrapper_attr] ? input.opts[:wrapper_attr].dup : { }
+
+      case input.type
+      when :submit, :reset, :hidden
+        super
+      when :radio, :checkbox
+        Forme.attr_classes_after(attr, "form-check")
+        input.tag(:div, attr, super)
+      else
+        input.tag(:div, attr, super)
+      end
+    end
+  end
+
+  class Serializer::Bootstrap5 < Serializer
+    Forme.register_transformer(:serializer, :bs5, new)
+
+    BUTTON_STYLES = %w[
+      btn-primary btn-secondary btn-success btn-danger btn-warning btn-info btn-light btn-dark btn-link
+      btn-outline-primary btn-outline-secondary btn-outline-success btn-outline-danger btn-outline-warning btn-outline-info btn-outline-light btn-outline-dark
+    ].freeze
+
+    def call(tag)
+      return super unless tag.is_a?(Tag)
+
+      attr_class = case tag.type
+      when :input
+        # default to <input type="text"...> if not set
+        tag.attr[:type] = :text if tag.attr[:type].nil?
+
+        case tag.attr[:type].to_sym
+        when :checkbox, :radio
+          "form-check-input"
+        when :range
+          "form-range"
+        when :color
+          %w"form-control form-control-color"
+        when :submit, :reset
+          classes = ["btn"]
+          classes << "btn-primary" if (tag.attr[:class].to_s.split(" ") & BUTTON_STYLES).empty?
+          classes
+        when :hidden
+          # nothing
+        else
+          unless tag.attr[:class] && tag.attr[:class].include?("form-control-plaintext")
+            "form-control"
+          end
+        end
+      when :textarea
+        "form-control"
+      when :select
+        "form-select"
+      end
+      Forme.attr_classes_after(tag.attr, *attr_class) if attr_class
+
+      super
+    end
+  end
+end

data/lib/forme/version.rb

@@ -6,7 +6,7 @@ module Forme
   MAJOR = 2
 
   # The minor version of Forme, updated for new feature releases of Forme.
-  MINOR = 2
+  MINOR = 3
 
   # The patch version of Forme, updated only for bug fixes from the last
   # feature release.

data/lib/forme.rb

@@ -96,7 +96,8 @@ module Forme
     Form.form(*a, &block)
   end
 
-  # Update the <tt>:class</tt> entry in the +attr+ hash with the given +classes+.
+  # Update the <tt>:class</tt> entry in the +attr+ hash with the given +classes+,
+  # adding the classes after any existing classes.
   def self.attr_classes(attr, *classes)
     attr[:class] = merge_classes(attr[:class], *classes)
   end

data/lib/roda/plugins/forme_set.rb

@@ -13,7 +13,9 @@ class Roda
 
       # Set the HMAC secret.
       def self.configure(app, opts = OPTS, &block)
-        app.opts[:forme_set_hmac_secret] = opts[:secret] || app.opts[:forme_set_hmac_secret]
+        unless app.opts[:forme_set_hmac_secret] = opts[:secret] || app.opts[:forme_set_hmac_secret]
+          raise RodaError, "must provide :secret option to forme_set plugin"
+        end
 
         if block
           app.send(:define_method, :_forme_set_handle_error, &block)
@@ -27,8 +29,8 @@ class Roda
 
       # Map of error types to error messages
       ERROR_MESSAGES = {
-        :missing_data=>"_forme_set_data parameter not submitted",
-        :missing_hmac=>"_forme_set_data_hmac parameter not submitted",
+        :missing_data=>"_forme_set_data parameter not submitted, make sure the forme_set Sequel plugin is loaded",
+        :missing_hmac=>"_forme_set_data_hmac parameter not submitted, make sure the forme_set Sequel plugin is loaded",
         :hmac_mismatch=>"_forme_set_data_hmac does not match _forme_set_data",
         :csrf_mismatch=>"_forme_set_data CSRF token does not match submitted CSRF token",
         :missing_namespace=>"no content in expected namespace"

data/lib/sequel/plugins/forme_set.rb

@@ -1,5 +1,7 @@
 # frozen-string-literal: true
 
+require_relative '../../forme'
+
 module Sequel # :nodoc:
   module Plugins # :nodoc:
     # The forme_set plugin makes the model instance keep track of which form

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forme
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Jeremy Evans
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-28 00:00:00.000000000 Z
+date: 2022-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -157,6 +157,7 @@ description: |
   2) Have a simple API
   3) Support forms both with and without related objects
   4) Allow compiling down to different types of output
+  5) Integrate easily into web frameworks
 email: code@jeremyevans.net
 executables: []
 extensions: []
@@ -168,9 +169,9 @@ files:
 - CHANGELOG
 - MIT-LICENSE
 - README.rdoc
-- Rakefile
 - lib/forme.rb
 - lib/forme/bs3.rb
+- lib/forme/bs5.rb
 - lib/forme/erb.rb
 - lib/forme/form.rb
 - lib/forme/input.rb
@@ -193,24 +194,6 @@ files:
 - lib/sequel/plugins/forme.rb
 - lib/sequel/plugins/forme_i18n.rb
 - lib/sequel/plugins/forme_set.rb
-- spec/all.rb
-- spec/bs3_reference_spec.rb
-- spec/bs3_sequel_plugin_spec.rb
-- spec/bs3_spec.rb
-- spec/erb_helper.rb
-- spec/erubi_capture_helper.rb
-- spec/forme_coverage.rb
-- spec/forme_spec.rb
-- spec/rails_integration_spec.rb
-- spec/roda_integration_spec.rb
-- spec/sequel_helper.rb
-- spec/sequel_i18n_helper.rb
-- spec/sequel_i18n_plugin_spec.rb
-- spec/sequel_plugin_spec.rb
-- spec/sequel_set_plugin_spec.rb
-- spec/shared_erb_specs.rb
-- spec/sinatra_integration_spec.rb
-- spec/spec_helper.rb
 homepage: http://github.com/jeremyevans/forme
 licenses:
 - MIT
@@ -220,7 +203,7 @@ metadata:
   documentation_uri: http://forme.jeremyevans.net
   mailing_list_uri: https://github.com/jeremyevans/forme/discussions
   source_code_uri: https://github.com/jeremyevans/forme
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--quiet"
 - "--line-numbers"
@@ -243,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key: 
+signing_key:
 specification_version: 4
 summary: HTML forms library
 test_files: []

data/Rakefile

@@ -1,82 +0,0 @@
-require "rake"
-require "rake/clean"
-
-NAME = 'forme'
-VERS = lambda do
-  require File.expand_path("../lib/forme/version", __FILE__)
-  Forme.version
-end
-CLEAN.include ["#{NAME}-*.gem", "rdoc", "coverage", '**/*.rbc']
-
-# Gem Packaging and Release
-
-desc "Packages #{NAME}"
-task :package=>[:clean] do |p|
-  sh %{gem build #{NAME}.gemspec}
-end
-
-desc "Upload #{NAME} gem to rubygems"
-task :release=>[:package] do
-  sh %{gem push ./#{NAME}-#{VERS.call}.gem} 
-end
-
-### RDoc
-
-RDOC_DEFAULT_OPTS = ["--line-numbers", "--inline-source", '--title', 'Forme']
-
-begin
-  gem 'hanna-nouveau'
-  RDOC_DEFAULT_OPTS.concat(['-f', 'hanna'])
-rescue Gem::LoadError
-end
-
-rdoc_task_class = begin
-  require "rdoc/task"
-  RDoc::Task
-rescue LoadError
-  require "rake/rdoctask"
-  Rake::RDocTask
-end
-
-RDOC_OPTS = RDOC_DEFAULT_OPTS + ['--main', 'README.rdoc']
-
-rdoc_task_class.new do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.options += RDOC_OPTS
-  rdoc.rdoc_files.add %w"README.rdoc CHANGELOG MIT-LICENSE lib/**/*.rb"
-end
-
-### Specs
-
-desc "Run specs"
-task :spec do
-  sh "#{FileUtils::RUBY} #{'-w' if RUBY_VERSION >= '3'} spec/all.rb"
-end
-task :default => :spec
-
-desc "Run specs with coverage"
-task :spec_cov do
-  ENV['COVERAGE'] = '1'
-  sh "#{FileUtils::RUBY} spec/all.rb"
-end
-
-### Other
-
-desc "Print #{NAME} version"
-task :version do
-  puts VERS.call
-end
-
-desc "Check syntax of all .rb files"
-task :check_syntax do
-  Dir['**/*.rb'].each{|file| print `#{ENV['RUBY'] || :ruby} -c #{file} | fgrep -v "Syntax OK"`}
-end
-
-desc "Start an IRB shell using the extension"
-task :irb do
-  require 'rbconfig'
-  ruby = ENV['RUBY'] || File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
-  irb = ENV['IRB'] || File.join(RbConfig::CONFIG['bindir'], File.basename(ruby).sub('ruby', 'irb'))
-  sh %{#{irb} -I lib -r forme}
-end
-

data/spec/all.rb

@@ -1,2 +0,0 @@
-$: << 'lib'
-Dir.new(File.dirname(__FILE__)).each{|f| require_relative f if f.end_with?('_spec.rb')}