form_input_field 0.8.55

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2a0c3247cbaa08d12349cd0d6b12380ac5e668a402cf9149202f5567b0e4889
+  data.tar.gz: 30480481a563778a1a011a5bef06eef416a72c43f14b17cb00e1e1adcb9d45f9
+SHA512:
+  metadata.gz: be003698c88287364e4ef3a698b3d94b4896bc76e149d603c1cdca99c64345c09f094ac6fa71f4c2e5c298f689ae5d0a80e9af4e0519641cc3972b84698786db
+  data.tar.gz: 6de3811df9c908b734b8d4b04171e503691001dd4836190d05b4c608b6dbf88443f9ce8eff0cb85991736a67444bd150c0c70b07a35eacbd4dfcdc8765ade851

data/lib/form_input_field/version.rb

@@ -0,0 +1,3 @@
+module FormInputField
+  VERSION = "0.8.55"
+end

data/lib/form_input_field.rb

@@ -0,0 +1,185 @@
+require "form_input_field/version"
+require 'rails'
+require 'action_view'
+
+module FormInputField
+
+  class InvalidSymbolError < StandardError ; end
+  class InvalidArgumentError < StandardError ; end
+
+
+  @@compatible_field_tags = [:check_box, :text_field, :color_field, :date_field, :datetime_field, :datetime_local_field, :email_field, :file_field, :hidden_field, :month_field, :number_field, :password_field, :phone_field, :radio_button, :range_field, :search_field, :telephone_field, :text_area, :time_field, :url_field, :week_field]
+
+
+
+# -----
+  def form_input_field(helper_sym, object_name, method, *args, **options)
+
+    if(not @@compatible_field_tags.include?(helper_sym))
+      raise InvalidSymbolError, 'WARNING: Invalid symbol given as parameter for helper_sym. Recieved the following symbol: ' + helper_sym.to_s + '. Valid symbols for helpers are as follows: ' + compatible_field_tags.to_s
+    end
+
+    # --- Establishing a list of valid parameters:
+    parameters =  [:label_text, :options, :label_options]
+    # -- Establishing the default values for said parameters:
+    values = {:options => {}, :label_text => false, :label_options => {}}
+
+    # -- Capturing extraneous parameters for non-conforming html elements:
+    if helper_sym == :check_box
+      parameters = parameters + [:checked_value, :unchecked_value]
+      values[:checked_value] = "1"
+      values[:unchecked_value] = "0"
+
+    elsif helper_sym == :radio_button
+      parameters = [:tag_value] + parameters
+      values[:tag_value] = false
+
+      if args.empty? || (not (args[0].is_a?(String) || args[0].is_a?(Symbol)))
+        raise InvalidArgumentError, "WARNING: Please supply valid argument for tag_value whilst using :radio_button for helper_sym."
+      end
+
+    end
+
+    # -- Continuing capture of valid parameters:
+    parameters = parameters + [:value_key]
+    values[:value_key]  = :values
+
+    # --- Iterate through argument list placing values into parameter hash-map:
+    count = 0
+    args.each do |argument|
+      parameter = parameters[count]
+      values[parameter] = argument
+      count += 1
+    end
+
+    # --- Iterate through option list placing values into parameter hash-map:
+    options.each do |parameter, argument|
+      if parameters.include?(parameter)
+        values[parameter] = argument
+        count += 1
+      else
+
+        # This captures the case in which a hash *concludes* the arguments list;
+        #   Ruby will put this into **options regardless - an annoying quirk.
+        # For example:
+        #   form_input_field(:text_field, :user, "email", "Email", {:class => "form-control"}
+        #   will assign {:class => "form-control", :disabled => false} into **options
+        #   This is despite the fact the trailing array is an explicit argument
+        #   that should be placed into *args
+
+        parameter_key = parameters[count]
+        if parameter_key == :options or parameter_key == :label_options
+          new_argument = {parameter => argument}
+          values[parameter_key] = values[parameter_key].merge(new_argument)
+        elsif parameter_key != parameter
+          raise InvalidArgumentError, "WARNING: Unknown explicitly declared parameter. Received: " + parameter.to_s + " with value: " + argument.to_s + ". Did you mean: " + parameter_key + " for a parameter?"
+        end
+      end
+    end
+
+    # --- Place potential value for an input element's value attribute:
+    value = {}
+    if values[:value_key] && defined?(flash)
+      value_key = values[:value_key]
+      if flash[value_key]
+        if (flash[value_key].is_a?(String) or flash[value_key].is_a?(Symbol))
+          value = {:value => flash[value_key]}
+        elsif flash[value_key].is_a?(Hash)
+          value = {:value => flash[value_key][method]}
+        end
+      end
+    end
+
+    # --- Build the label for the relevant html field:
+    if( not ((values[:label_text] == "") or (values[:label_text] == false)) )
+      label = label object_name, method, values[:label_text], values[:label_options]
+    else
+      label = ""
+    end
+
+    # --- Build the html element for the relevant field:
+    if(helper_sym == :radio_button)
+      input = self.send(helper_sym, object_name, method, values[:tag_value], values[:options].merge(value))
+    elsif(helper_sym == :check_box)
+      input = self.send(helper_sym, object_name, method, values[:options].merge(value), values[:checked_value], values[:unchecked_value])
+    else
+      input = self.send(helper_sym, object_name, method, values[:options].merge(value))
+    end
+
+    label + input
+
+  end
+
+
+
+
+# -----
+  def form_error_field(object_name, method, *args, **options)
+
+    # --- Establishing a list of valid parameters:
+    parameters = [:label_options, :error_key]
+    # -- Establishing the default values for said parameters:
+    values = {:label_options => {}, :error_key => :errors}
+
+    # --- Iterate through argument list placing values into parameter hash-map:
+    count = 0
+    args.each do |argument|
+      parameter = parameters[count]
+      values[parameter] = argument
+      count += 1
+    end
+
+    # --- Iterate through option list placing values into parameter hash-map:
+    options.each do |parameter, argument|
+      if parameters.include?(parameter)
+        values[parameter] = argument
+        count += 1
+      else
+
+        # This captures the case in which a hash *concludes* the arguments list;
+        #   Ruby will put this into **options regardless - an annoying quirk.
+        # For example:
+        #   form_input_field(:text_field, :user, "email", "Email", {:class => "form-control"}
+        #   will assign {:class => "form-control", :disabled => false} into **options
+        #   This is despite the fact the trailing array is an explicit argument
+        #   that should be placed into *args
+
+        parameter_key = parameters[count]
+        if parameter_key == :label_options
+          new_argument = {parameter => argument}
+          values[parameter_key] = values[parameter_key].merge(new_argument)
+        elsif parameter_key != parameter
+          raise InvalidArgumentError, "WARNING: Unknown explicitly declared parameter. Received: " + parameter.to_s + " with value: " + argument.to_s + ". Did you mean: " + parameter_key + " for a parameter?"
+        end
+      end
+    end
+
+    # --- Placing error label text:
+    error_text = ""
+    if values[:error_key] && defined?(flash)
+      error_key = values[:error_key]
+      if flash[error_key]
+        if (flash[error_key].is_a?(String) or flash[error_key].is_a?(Symbol))
+          error_text = flash[error_key]
+        elsif flash[error_key].is_a?(Hash)
+          error_text = flash[error_key][method][0]
+        end
+      end
+    end
+
+    if not (error_text == "")
+      label object_name, method, error_text, values[:label_options]
+    else
+      ""
+    end
+  end
+end # end of FormInputField
+
+# Place module into ActionView::Helpers::FormHelper:
+module ActionView
+  module Helpers
+    module FormHelper
+      include FormInputField
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: form_input_field
+version: !ruby/object:Gem::Version
+  version: 0.8.55
+platform: ruby
+authors:
+- Alan McKay
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/form_input_field.rb
+- lib/form_input_field/version.rb
+homepage: https://github.com/alanmmckay/form_input_field
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alanmmckay/form_input_field
+  source_code_uri: https://github.com/alanmmckay/form_input_field
+  bug_tracker_uri: https://github.com/alanmmckay/form_input_field/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: A gem for Ruby on Rails which wraps up functionality of maintaining values
+  for forms to factor cases where a POST fails model validation while also providing
+  a means to succinctly produce relevant error messages.
+test_files: []