pakyow-form 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38724ce5ba048f63242d25fd9e7e0e58d08baf6e1230078067bfa243ade4aeac
+  data.tar.gz: 4f56809e4b503cfc879fedd67b0cb9263da7528e81dcee6f84ba142d0e24fdfb
+SHA512:
+  metadata.gz: da7cbb0b434e38c6402758d84e3ad4becc4caeca18488531c68edf74f7c65b47ce222d05e32067e10faaad794d9ec8d6ae617cd7e6e17e1779160923f330be4f
+  data.tar.gz: c1f311416157209bbaa89ed22d288ecbb6442bb25b7f2b10501004c12a5351ad9e5108014ad8f8087e833da17d36366913860c058b82059c616efc34b7666e22

data/README.md

@@ -0,0 +1,29 @@
+# pakyow-form
+
+Forms for Pakyow.
+
+# Download
+
+The latest version of Pakyow Form can be installed with RubyGems:
+
+```
+gem install pakyow-form
+```
+
+Source code can be downloaded as part of the Pakyow project on Github:
+
+- https://github.com/pakyow/pakyow/tree/master/pakyow-form
+
+# License
+
+Pakyow Form is free and open-source under the [LGPLv3 license](https://choosealicense.com/licenses/lgpl-3.0/).
+
+# Support
+
+Found a bug? Tell us about it here:
+
+- https://github.com/pakyow/pakyow/issues
+
+We'd love to have you in the community:
+
+- http://pakyow.org/get-involved

data/lib/pakyow/form.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "pakyow/data"
+require "pakyow/presenter"
+require "pakyow/routing"
+
+require "pakyow/form/framework"

data/lib/pakyow/form/framework.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require "json"
+
+require "pakyow/framework"
+
+require "pakyow/support/extension"
+require "pakyow/support/inflector"
+
+module Pakyow
+  module Form
+    module ConnectionHelpers
+      def form
+        get(:__form)
+      end
+    end
+
+    class Framework < Pakyow::Framework(:form)
+      def boot
+        object.class_eval do
+          isolated :Controller do
+            # Clear form errors after a successful submission.
+            #
+            after "dispatch" do
+              if connection.form && connection.status < 400
+                data.ephemeral(:errors, form_id: connection.form[:id]).set([])
+              end
+            end
+          end
+
+          isolated :Connection do
+            include ConnectionHelpers
+          end
+
+          handle InvalidData, as: :bad_request do |error|
+            if connection.form && connection.form.include?(:origin)
+              errors = error.result.messages.flat_map { |type, messages|
+                case messages
+                when Array
+                  messages.map { |type_message|
+                    { field: type, message: "#{Support.inflector.humanize(type)} #{type_message}" }
+                  }
+                when Hash
+                  messages.flat_map { |field, field_messages|
+                    field_messages.map { |field_message|
+                      { field: field, message: "#{Support.inflector.humanize(field)} #{field_message}" }
+                    }
+                  }
+                end
+              }
+
+              if app.class.includes_framework?(:ui) && ui?
+                data.ephemeral(:errors, form_id: connection.form[:id]).set(errors)
+              else
+                connection.set(:__form_errors, errors)
+                connection.set(:__form_values, params.reject { |key| key == :form })
+                reroute connection.form[:origin], method: :get, as: :bad_request
+              end
+            else
+              reject
+            end
+          end
+
+          component :form do
+            def perform
+              errors = if connection.values.include?(:__form_errors)
+                connection.get(:__form_errors)
+              else
+                []
+              end
+
+              # We have to take over the management of form ids from presenter for error handling.
+              # If we're re-rendering a submitted form we reuse the id, otherwise create a new one.
+              #
+              form_id = if connection.form
+                connection.form[:id]
+              else
+                SecureRandom.hex(24)
+              end
+
+              expose :form_id, form_id
+
+              # Relate ephemeral errors to the form id.
+              #
+              expose :form_errors, data.ephemeral(:errors, form_id: form_id).set(errors)
+
+              # Expose submitted values to be presented in the form.
+              #
+              connection.get(:__form_values).to_h.each do |key, value|
+                expose connection.form[:binding], value
+              end
+            end
+
+            presenter do
+              render do
+                view.label(:form)[:id] = form_id
+                presented_form_binding = presentables.dig(:__form, :binding)
+                if presented_form_binding.nil? || presented_form_binding.to_sym == view.channeled_binding_name
+                  classify_form; classify_fields
+                  present_errors(form_errors)
+                end
+              end
+
+              private
+
+              def classify_form
+                if form_errors.any?
+                  attrs[:class] << :"ui-errored"
+                else
+                  attrs[:class].delete(:"ui-errored")
+                end
+              end
+
+              def classify_fields
+                view.each_binding_prop do |node|
+                  binding_name = node.label(:binding)
+                  error = form_errors.find { |e| e[:field] == binding_name }
+
+                  find(binding_name).with do |field|
+                    if error.nil?
+                      field.attrs[:class].delete(:"ui-errored")
+                      field.attrs[:title] = ""
+                    else
+                      field.attrs[:class] << :"ui-errored"
+                      field.attrs[:title] = error[:message]
+                    end
+                  end
+                end
+              end
+
+              def present_errors(errors)
+                if form_errors_presenter = component(:"form-errors")
+                  if error_presenter = form_errors_presenter.find(:error)
+                    error_presenter.present(errors)
+                  end
+
+                  if errors.empty?
+                    form_errors_presenter.attrs[:class] << :"ui-hidden"
+                  else
+                    form_errors_presenter.attrs[:class].delete(:"ui-hidden")
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: pakyow-form
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc1
+platform: ruby
+authors:
+- Bryan Powell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pakyow-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: pakyow-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: pakyow-presenter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: pakyow-routing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: pakyow-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+description: Forms for Pakyow
+email: bryan@metabahn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/pakyow/form.rb
+- lib/pakyow/form/framework.rb
+homepage: https://pakyow.org
+licenses:
+- LGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Pakyow Forms
+test_files: []