gourami 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cc34cc23b4323b885cb63b0c82cd98921e0467fac34a97fcc584550f85de29d
-  data.tar.gz: '0737019b3dcb2cc40567287a94f4a3bd9dc13ef3b32a28e0e140b0745cc5a29e'
+  metadata.gz: 79b225001fdeb796c9a6224beb9c7c792f37ae0ae7f48be33a2a4ca27f938979
+  data.tar.gz: 9fa37364de4f3c646f51f864798029564629a012e16b85877822629d579650a4
 SHA512:
-  metadata.gz: fb5e34109e4c24fd1394e8888acee9d2a0ff99542fb9aadd9072f6e81ca9c7cb65f05d65ba7dfb505ea3ba520f803a9eceeaebd2b0fc2260bae740ce7ea60246
-  data.tar.gz: 55a3dffab397480607dfa1bb0edbee3b5d17a52c859e855423aec56b349a1a15542e47238b45c3edb5740d3c3680f0e363767da40e0edf7f93835c9f884f1b72
+  metadata.gz: 3b421bf22515e7380abf2a247e74e057ba26eed52d29dc7b2a8f2a13a0f2f72608f0ae6a2c1b0ca5ea4138a4b756b73cb8d9cf234f0bb416237c63c866b06f59
+  data.tar.gz: f7dd343730a9503d267f3c39ebb7b769eb62347283a69e5848f0a8e7766b1dcb2da5707eb0b71251eb0f39bdddce47d0fcee212493e811a06618bdbc20be2618

data/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "cSpell.words": [
+    "uids"
+  ]
+}

data/gourami.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "activesupport", ">= 5.1.7"
   spec.add_development_dependency "filewatcher", "~> 1.1.0"
+  spec.add_development_dependency "loofah", ">= 2.24.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "pry", "~>0.10"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/gourami/coercer.rb

@@ -11,7 +11,12 @@ module Gourami
     # @return [*]
     def setter_filter(attribute_name, value, options)
       type = options[:type]
-      value = send(:"coerce_#{type}", value, options) if type
+
+      if type
+        raise ":coerce_#{type} does not exist. Did you forget to add a plugin for :coerce_#{type}?" unless respond_to?(:"coerce_#{type}")
+
+        value = send(:"coerce_#{type}", value, options)
+      end
 
       super(attribute_name, value, options)
     end

data/lib/gourami/extensions/resources.rb

@@ -72,7 +72,7 @@ module Gourami
       #       validate_presence(:trim_end_time)   # validates `attributes[:social_broadcasts]["facebook_page-41"][:trim_end_time]`
       #     end
       #   end
-      def with_resource(resource_namespace, resource_uid, offset: nil, &_block)
+      def with_resource(resource_namespace, resource_uid = nil, offset: nil, &_block)
         @resource_namespace = resource_namespace
         @resource_uid = resource_uid
         @offset = offset
@@ -86,8 +86,10 @@ module Gourami
       # If a resource namespace is active (within with_resource block), find the resource using the namespace and uid.
       # Otherwise, return the form object.
       def current_resource
-        if @resource_namespace
+        if @resource_namespace && @resource_uid
           send(@resource_namespace)[@resource_uid]
+        elsif @resource_namespace
+          send(@resource_namespace)
         else
           super
         end
@@ -156,13 +158,21 @@ module Gourami
       end
 
       # TODO: YARD
-      def resource_has_errors?(resource_namespace, resource_uid)
-        resource_errors[resource_namespace][resource_uid.to_s].values.map(&:flatten).any?
+      def resource_has_errors?(resource_namespace, resource_uid = nil)
+        resource_errors[resource_namespace][resource_uid&.to_s].values.map(&:flatten).any?
       end
 
       # TODO: YARD
-      def resource_attribute_has_errors?(resource_namespace, resource_uid, attribute_name)
-        resource_errors[resource_namespace][resource_uid.to_s][attribute_name].any?
+      def resource_attribute_has_errors?(resource_namespace, resource_uid_or_attribute_name, attribute_name = nil)
+        if attribute_name.nil?
+          # 2 arguments: resource_namespace, attribute_name
+          attribute_name = resource_uid_or_attribute_name
+          resource_uid = nil
+        else
+          # 3 arguments: resource_namespace, resource_uid, attribute_name
+          resource_uid = resource_uid_or_attribute_name
+        end
+        resource_errors[resource_namespace][resource_uid&.to_s][attribute_name].any?
       end
 
       # Append an error to the given attribute for a resource.
@@ -174,7 +184,7 @@ module Gourami
       # @param error [Symbol, String]
       #   The error identifier.
       def append_resource_error(resource_namespace, resource_uid, attribute_name, error)
-        resource_errors[resource_namespace][resource_uid.to_s][attribute_name] << error
+        resource_errors[resource_namespace][resource_uid&.to_s][attribute_name] << error
       end
 
       # Determine if current form instance is valid by running the validations

data/lib/gourami/form.rb

@@ -88,5 +88,35 @@ module Gourami
     include Gourami::Validations
     include Gourami::Coercer
 
+    # Load and apply a plugin.
+    # Inspired by the plugin system from the Sequel gem. https://janko.io/the-plugin-system-of-sequel-and-roda/
+    # 
+    # @param name [Symbol, Module] a name to look up under Gourami::Plugins
+    #   (e.g. :sanitize loads gourami/plugins/sanitize and resolves
+    #   Gourami::Plugins::Sanitize), or a Module to apply directly.
+    def self.plugin(name, *args, &block)
+      plugin_module = load_plugin(name)
+
+      plugin_module.apply(self, *args, &block) if plugin_module.respond_to?(:apply)
+
+      extend(plugin_module::ClassMethods) if plugin_module.const_defined?(:ClassMethods)
+      include(plugin_module::InstanceMethods) if plugin_module.const_defined?(:InstanceMethods)
+
+      plugin_module.configure(self, *args, &block) if plugin_module.respond_to?(:configure)
+    end
+
+    def self.load_plugin(name)
+      return name if name.is_a?(Module)
+
+      const_name = name.to_s.split("_").map { |part| part[0].upcase + part[1..-1] }.join
+
+      unless Gourami::Plugins.const_defined?(const_name)
+        require "gourami/plugins/#{name}"
+      end
+
+      Gourami::Plugins.const_get(const_name)
+    end
+    private_class_method :load_plugin
+
   end
 end

data/lib/gourami/plugins/sanitize.rb

@@ -0,0 +1,37 @@
+# Optional plugin adding a :sanitized_string attribute type that strips dangerous HTML
+# using loofah. Not loaded by default - opt in with `plugin :sanitize`, and add
+# "loofah" to your own application's Gemfile/gemspec.
+#
+# @example
+#   class MyForm < Gourami::Form
+#     plugin :sanitize
+#
+#     attribute :bio, :type => :sanitized_string
+#   end
+module Gourami
+  module Plugins
+    module Sanitize
+      # Runs on every `plugin :sanitize` call; require is idempotent so this is safe to repeat.
+      def self.apply(_model, *)
+        require "loofah"
+      end
+
+      module InstanceMethods
+        # @param value [Object]
+        # @param options [Hash] forwarded to #coerce_string
+        # @return [String, nil]
+        def coerce_sanitized_string(value, options = {})
+          value = coerce_string(value, options)
+          return value if value.nil?
+
+          # Unescape first so entity-encoded tags (e.g. "&lt;script&gt;") are
+          # recognized as real HTML by Loofah instead of passing through as text.
+          unescaped_content = CGI.unescapeHTML(value)
+          sanitized_content = Loofah.html4_fragment(unescaped_content).scrub!(:prune).to_s
+          # Unescape again since loofah would turn a & back into &amp;
+          CGI.unescapeHTML(sanitized_content).strip
+        end
+      end
+    end
+  end
+end

data/lib/gourami/plugins.rb

@@ -0,0 +1,6 @@
+module Gourami
+  # Namespace that plugins live under, e.g. Gourami::Plugins::Sanitize is
+  # loaded and applied via `plugin :sanitize`.
+  module Plugins
+  end
+end

data/lib/gourami/version.rb

@@ -1,3 +1,3 @@
 module Gourami
-  VERSION = "2.0.0".freeze
+  VERSION = "2.2.0".freeze
 end

data/lib/gourami.rb

@@ -15,5 +15,6 @@ require "gourami/extensions/changes"
 require "gourami/extensions/resources"
 require "gourami/form"
 require "gourami/formatting_constants"
+require "gourami/plugins"
 require "gourami/validations"
 require "gourami/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gourami
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - TSMMark
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-22 00:00:00.000000000 Z
+date: 2026-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: loofah
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.24.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.24.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +105,7 @@ files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".ruby-version"
+- ".vscode/settings.json"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -110,6 +125,8 @@ files:
 - lib/gourami/form.rb
 - lib/gourami/formatting_constants.rb
 - lib/gourami/not_watching_changes_error.rb
+- lib/gourami/plugins.rb
+- lib/gourami/plugins/sanitize.rb
 - lib/gourami/required_attribute_error.rb
 - lib/gourami/validation_error.rb
 - lib/gourami/validations.rb
@@ -134,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Keep your Routes, Controllers and Models thin.