has_helpers 5.0.2

data/lib/has_helpers/test_helpers/shoulda_helpers.rb

@@ -0,0 +1,249 @@
+# typed: false
+# frozen_string_literal: true
+
+module ShouldaHelpers
+  module Tests
+    class ActiveSupport::TestCase
+      def self.should_test_location_field(entity, locations)
+        should allow_value((locations + [nil, ""]).shuffle.first).for(entity)
+        should_not allow_value(["test", "</", "abc123", "&nbsp;"].shuffle.first).for(entity)
+      end
+
+      def self.should_test_name_field(entity, length)
+        should ensure_length_of(entity).is_at_least(0).is_at_most(length)
+        if length > 8
+          should allow_value("Kansas City").for(entity)
+          should allow_value("-- Hey --").for(entity)
+          should allow_value(" t o").for(entity)
+          should allow_value("& you").for(entity)
+          should allow_value("21 Jump").for(entity)
+          should allow_value("Brookside").for(entity)
+        end
+        should allow_value("k c").for(entity)
+        should allow_value("- H-").for(entity)
+        should allow_value(" t").for(entity)
+        should allow_value("& u").for(entity)
+        should allow_value("21 ").for(entity)
+        should allow_value("brok").for(entity)
+        should_not allow_value(">*").for(entity).with_message(Validations.name_msg)
+        should_not allow_value("< test").for(entity).with_message(Validations.name_msg)
+      end
+
+      def self.should_test_zipcode_field(entity)
+        should allow_value("k c").for(entity)
+        should allow_value("55555").for(entity)
+        should allow_value("55555-5555").for(entity)
+        should allow_value("55555 5555").for(entity)
+        should allow_value("55555.5555").for(entity)
+        should allow_value("(888)88-9999").for(entity)
+        should allow_value(" ,-99999").for(entity)
+        should_not allow_value("blah").for(entity).with_message(Validations.zipcode_msg)
+        should_not allow_value("b lah").for(entity).with_message(Validations.zipcode_msg)
+        should_not allow_value("3333").for(entity).with_message(Validations.zipcode_msg)
+        should_not allow_value("333333").for(entity).with_message(Validations.zipcode_msg)
+      end
+
+      def self.should_test_phone_field(entity)
+        should allow_value("9134456677").for(entity)
+        should allow_value("913 345 6677").for(entity)
+        should allow_value(" 2134456677 ").for(entity)
+        should allow_value("613-445-6677").for(entity)
+        should allow_value("983445-6677").for(entity)
+        should allow_value("(888)8888888").for(entity)
+        should allow_value(" 913-4256677").for(entity)
+        should allow_value("903-445 6627").for(entity)
+        should allow_value("9134466677 ").for(entity)
+        should allow_value("913-4556677").for(entity)
+        should allow_value("513.445-6677").for(entity)
+        should allow_value("555.555.8888").for(entity)
+        should_not allow_value(">*").for(entity).with_message(Validations.phone_msg)
+        should_not allow_value("< test").for(entity).with_message(Validations.phone_msg)
+        should_not allow_value("www.test..com").for(entity).with_message(Validations.phone_msg)
+        should_not allow_value("www.test.c").for(entity).with_message(Validations.phone_msg)
+        should_not allow_value("www-test.com").for(entity).with_message(Validations.phone_msg)
+        should_not allow_value("abc").for(entity).with_message(Validations.phone_msg)
+        should_not allow_value("123").for(entity).with_message(Validations.phone_msg)
+        should_not allow_value("&*()").for(entity).with_message(Validations.phone_msg)
+        should_not allow_value("www.test-com").for(entity).with_message(Validations.phone_msg)
+      end
+
+      def self.should_test_url_field(entity)
+        should allow_value("http://www.example.com").for(entity)
+        should allow_value("www.example.com:8001").for(entity)
+        should allow_value("http://www.exmple.com/1/abc?test=test").for(entity)
+        should allow_value("http://finane.example.com").for(entity)
+        should allow_value("http://www.example.com/1/abc?test=test").for(entity)
+        should allow_value("www.example.com").for(entity)
+        should allow_value("http://fiance.example.com").for(entity)
+        should allow_value("finance.example.com").for(entity)
+        should allow_value("http://finance.example.com.ag").for(entity)
+        should_not allow_value(">*").for(entity).with_message(Validations.url_msg)
+        should_not allow_value("< test").for(entity).with_message(Validations.url_msg)
+        should_not allow_value("www.test..com").for(entity).with_message(Validations.url_msg)
+        should_not allow_value("www.test.c").for(entity).with_message(Validations.url_msg)
+        should_not allow_value("www-test.com").for(entity).with_message(Validations.url_msg)
+        should_not allow_value("abc").for(entity).with_message(Validations.url_msg)
+        should_not allow_value("123").for(entity).with_message(Validations.url_msg)
+        should_not allow_value("&*()").for(entity).with_message(Validations.url_msg)
+        should_not allow_value("www.test-com").for(entity).with_message(Validations.url_msg)
+      end
+
+      def self.should_test_positive_percent_field(entity)
+        should allow_value("100").for(entity)
+        should allow_value("99").for(entity)
+        should allow_value("1").for(entity)
+        should allow_value("44").for(entity)
+        should allow_value("99.999").for(entity)
+        should allow_value("0.001").for(entity)
+        should_not allow_value("101").for(entity).with_message(Validations.positive_percent_msg)
+        should_not allow_value("0.2222").for(entity).with_message(Validations.positive_percent_msg)
+        should_not allow_value("abc").for(entity).with_message(Validations.positive_percent_msg)
+        should_not allow_value("&").for(entity).with_message(Validations.positive_percent_msg)
+        should_not allow_value("-44").for(entity).with_message(Validations.positive_percent_msg)
+        should_not allow_value("-44.4").for(entity).with_message(Validations.positive_percent_msg)
+        should_not allow_value("-44.4444").for(entity).with_message(Validations.positive_percent_msg)
+      end
+
+      def self.should_test_age_field(entity)
+        should allow_value("100").for(entity)
+        should allow_value(" 99").for(entity)
+        should allow_value("1 ").for(entity)
+        should allow_value("44").for(entity)
+        should allow_value("0").for(entity)
+        should allow_value("110").for(entity)
+        should_not allow_value("111").for(entity).with_message(Validations.age_msg)
+        should_not allow_value("-1").for(entity).with_message(Validations.age_msg)
+        should_not allow_value("abc").for(entity).with_message(Validations.age_msg)
+        should_not allow_value("&").for(entity).with_message(Validations.age_msg)
+      end
+
+      def self.should_test_percent_field(entity)
+        should allow_value("100").for(entity)
+        should allow_value(" 99").for(entity)
+        should allow_value("1 ").for(entity)
+        should allow_value("44").for(entity)
+        should allow_value("0").for(entity)
+        should allow_value("110").for(entity)
+        should_not allow_value("161").for(entity).with_message(Validations.positive_percent_msg)
+        should_not allow_value("-1").for(entity).with_message(Validations.positive_percent_msg)
+        should_not allow_value("abc").for(entity).with_message(Validations.positive_percent_msg)
+        should_not allow_value("&").for(entity).with_message(Validations.positive_percent_msg)
+      end
+
+      def self.should_test_positive_dollar_field(entity)
+        should allow_value("0").for(entity)
+        should allow_value("1").for(entity)
+        should allow_value("100").for(entity)
+        should allow_value("1000").for(entity)
+        should allow_value("1000.99").for(entity)
+        should allow_value("1,000,00").for(entity)
+        should allow_value("$1,000.00").for(entity)
+        should allow_value("1,000,000").for(entity)
+        should allow_value("1 000 000.01").for(entity)
+        should_not allow_value("-1").for(entity).with_message(Validations.positive_dollar_msg)
+        should_not allow_value("0.2222").for(entity).with_message(Validations.positive_dollar_msg)
+        should_not allow_value("ewrt").for(entity).with_message(Validations.positive_dollar_msg)
+      end
+
+      def self.should_test_dollar_field(entity)
+        should allow_value("0").for(entity)
+        should allow_value("1").for(entity)
+        should allow_value("100").for(entity)
+        should allow_value("1000").for(entity)
+        should allow_value("1000.99").for(entity)
+        should allow_value("1,000,00").for(entity)
+        should allow_value("$1,000.00").for(entity)
+        should allow_value("1,000,000").for(entity)
+        should allow_value("1 000 000.01").for(entity)
+        should allow_value("-0").for(entity)
+        should allow_value("-1").for(entity)
+        should allow_value("-100").for(entity)
+        should allow_value("-1000").for(entity)
+        should allow_value("-1000.99").for(entity)
+        should allow_value("-1,000,00").for(entity)
+        should allow_value("-$1,000.00").for(entity)
+        should allow_value("-1,000,000").for(entity)
+        should allow_value("-1 000 000.01").for(entity)
+        should_not allow_value("0.2222").for(entity).with_message(Validations.dollar_msg)
+        should_not allow_value("ewrt").for(entity).with_message(Validations.dollar_msg)
+      end
+
+      def self.should_test_number_field(entity, length)
+        if length > 8
+          should allow_value("1,000,00").for(entity)
+          should allow_value("1,000.00").for(entity)
+          should allow_value("1,000,000").for(entity)
+          should allow_value("1 000 000").for(entity)
+        end
+        should allow_value("0").for(entity)
+        should allow_value("1").for(entity)
+        should allow_value("100").for(entity)
+        should allow_value("1000").for(entity)
+        should_not allow_value("-1").for(entity).with_message(Validations.number_msg)
+        should_not allow_value("werq").for(entity).with_message(Validations.number_msg)
+      end
+
+      def self.should_test_rails_name_field(entity, length)
+        should assign_to(entity)
+        should ensure_length_of(entity).is_at_least(0).is_at_most(length)
+        should allow_value("kc_s").for(entity)
+        should allow_value("hey").for(entity)
+        should allow_value("yo_").for(entity)
+        should allow_value("_jmp").for(entity)
+        if length > 8
+          should allow_value("kc_star_what").for(entity)
+          should allow_value("hey").for(entity)
+          should allow_value("yo_sucka").for(entity)
+          should allow_value("_jump_street").for(entity)
+        end
+        should_not allow_value(">*").for(entity).with_message(Validations.rails_name_msg)
+        should_not allow_value("< test").for(entity).with_message(Validations.rails_name_msg)
+        should_not allow_value("test-er").for(entity).with_message(Validations.rails_name_msg)
+        should_not allow_value("yo dude").for(entity).with_message(Validations.rails_name_msg)
+      end
+
+      def self.should_test_taxid_field(entity)
+        should allow_value("51-5998888").for(entity)
+        should allow_value("010000000").for(entity)
+        should allow_value(" ").for(entity)
+        should allow_value(" 514998888 ").for(entity)
+        should allow_value("545998888").for(entity)
+        should allow_value("51 5998858").for(entity)
+        should allow_value("44.5559999").for(entity)
+        should_not allow_value("ab-cdefgh").for(entity).with_message(Validations.taxid_msg)
+        should_not allow_value("001000000").for(entity).with_message(Validations.taxid_msg)
+        should_not allow_value("abc").for(entity).with_message(Validations.taxid_msg)
+        should_not allow_value("<").for(entity).with_message(Validations.taxid_msg)
+        should_not allow_value("&").for(entity).with_message(Validations.taxid_msg)
+      end
+
+      def self.should_test_ssn_field(entity)
+        should allow_value("515-99-8888").for(entity)
+        should allow_value("515998488").for(entity)
+        should allow_value(" ").for(entity)
+        should allow_value(" 514998888 ").for(entity)
+        should allow_value("544.99 8888").for(entity)
+        should allow_value("515 99 8858").for(entity)
+        should allow_value("444.33.6666").for(entity)
+        should_not allow_value("ab-444fgh").for(entity).with_message(Validations.ssn_msg)
+        should_not allow_value("abc").for(entity).with_message(Validations.ssn_msg)
+        should_not allow_value("56599858>").for(entity).with_message(Validations.ssn_msg)
+        should_not allow_value("33445<").for(entity).with_message(Validations.ssn_msg)
+        should_not allow_value("3456356&").for(entity).with_message(Validations.ssn_msg)
+        should_not allow_value("/23452").for(entity).with_message(Validations.ssn_msg)
+      end
+
+      def self.should_accept_nested_attributes_for(*attr_names)
+        klass = self.name.gsub(/Test$/, "").constantize
+        context "#{klass}" do
+          attr_names.each do |association_name|
+            should "accept nested attrs for #{association_name}" do
+              assert klass.instance_methods.include?("#{association_name}_attributes=".to_sym),
+                     "#{klass} does not accept nested attributes for #{association_name}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/has_helpers/ui_attributes.rb

@@ -0,0 +1,39 @@
+# typed: false
+# frozen_string_literal: true
+
+module HasHelpers::UIAttributes
+  module HTMLAttributes
+    class HTMLAttrs < ::SimpleDelegator
+      def to_partial_path # ActiveModel interface
+        "has_helpers/ui_attributes/html_attrs"
+      end
+    end
+
+    include ::HasHelpers::Attributes::GuardedAttributes
+
+    attr_accessor :skin
+    attr_writer :data
+
+    def data
+      @data ||= {}
+    end
+
+    guarded_attr_accessor :html_attrs, guard: :to_html_attrs do
+      raw_html_attrs.tap do |attrs|
+        attrs[:class] = [attrs[:class], skin].reject(&:blank?).join(" ") if skin
+        data.each do |k, v|
+          attrs["data_#{ k }"] = v
+        end
+      end
+    end
+
+    def raw_html_attrs
+      @html_attrs ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName
+    end
+  end
+
+  include HTMLAttributes
+  include ::HasHelpers::Attributes::GuardedAttributes
+
+  guarded_attr_accessor :icon, guard: :to_icon
+end

data/lib/has_helpers/utils/action.rb

@@ -0,0 +1,87 @@
+# typed: false
+# frozen_string_literal: true
+
+# Represents an action to be taken on a page or form in terms of
+# either a link or an submit button which the user may click.
+#
+# == Link Actions
+# Link actions need only to set the +service+ option.
+# NOTE: setting +name+ or +value+ will change the action to a submit
+# (see "Submit Actions" below).
+#
+#   Action.new(:service => "Click me".to_service("http://shadyurl.com"))
+#
+# == Submit Actions
+# For submit inputs set the +input+ option.
+#
+#   Action.new(Input.new(:name => "find", :value => "Find", :label => "Seek"))
+#   Action.new(:input => { :name => "find", :value => "Find", :label => "Seek" })
+#
+# == Automagical conversions
+# +Service+ and +Input+ objects may be converted to +Action+ objcets by calling
+# +to_action+ on them.
+#
+# +actions+:
+# This should be set to a collection of Actions or objects which can be converted
+# using `to_action`. This convertibility greatly simplifies code like this
+#
+#   Action.new(
+#     :actions => [
+#       Service.new("http://example.com"),
+#       Input.new(:name => "Export", :value => "pdf" )
+#       # Could also nest an Action here!
+#     ]
+#   )
+#
+# which is equivalent to this much friendlier code:
+#   Action.new(
+#     :actions => {
+#       "http://example.com".to_service,
+#       { :name => "Export", :value => "pdf" }.to_input
+#     }
+#   )
+
+class Action # Lawsuit
+  DEFAULT_ICON = :caret_down
+
+  include HasHelpers::Attributes
+  include HasHelpers::UIAttributes
+  attr_writer :service, :icon
+  attr_accessor :render_object, :nested, :label
+
+  guarded_collection :actions # TODO: Implement a collection which guards appended elements *
+
+  guarded_attr_accessor :service, :input, auto_guard: true
+
+  def icon
+    icon_or_default.try(:to_icon)
+  end
+
+  def to_action
+    self
+  end
+
+  def cast_actions # TODO: Implement a collection which guards appended elements *
+    actions.map(&:to_action).tap do |a|
+      a.each { |action| action.set_nested! }
+    end
+  end
+
+  # ActiveModel interface
+  def to_partial_path
+    "has_helpers/actions/action"
+  end
+
+  protected
+
+  def set_nested!
+    self.nested = true
+    service.nested = true if service
+  end
+
+  private
+
+  def icon_or_default
+    @icon.nil? ? (actions.any? ? DEFAULT_ICON : nil) : @icon
+  end
+end

data/lib/has_helpers/utils/active_record_utils.rb

@@ -0,0 +1,40 @@
+# typed: false
+# frozen_string_literal: true
+
+module HasHelpers::ActiveRecordUtils # TODO: move this to has_data_imports
+  def remove_prefix(klass, data, prefix = nil)
+    data_without_prefix = {}
+    prefix ||= klass.to_s.downcase
+    if prefix.present?
+      klass.lookup_attributes_precedence.each do |key, column_name|
+        value = data[key_with_prefix(key, prefix)] # in case params is a hash and we need to search by prefix/digit -> advisor_id, advisor_import_key, advisor_one_id. advisor_two_id
+        value = value.send("normalize_#{key}") if value.respond_to?("normalize_#{key}") # normalizing the value if the method is available and needed.
+        data_without_prefix[column_name] = value if value.present?
+      end
+    end
+    data_without_prefix
+  end
+
+  def key_with_prefix(key, prefix = "", digit = nil)
+    prefix.present? ? [prefix, digit, key].compact.join("_") : key
+  end
+
+  def metadata_colums
+    [
+      "created_at",
+      "created_by",
+      "created_by_id",
+      "created_by_username",
+      "express_step",
+      "id",
+      "import_key",
+      "last_viewed_at",
+      "organization",
+      "organization_id",
+      "updated_at",
+      "updated_by",
+      "updated_by_id",
+      "updated_by_username"
+    ]
+  end
+end

data/lib/has_helpers/utils/alert.rb

@@ -0,0 +1,42 @@
+# typed: true
+# frozen_string_literal: true
+
+# The class name "Alert" was chosen to match the name of the corresponding entities in Bootstrap.
+class HasHelpers::Alert
+  include HasHelpers::Attributes
+  include HasHelpers::UIAttributes
+
+  SUCCESS = :success
+  INFO = :info
+  WARNING = :warning
+  DANGER = :danger
+  TYPES = [SUCCESS, INFO, WARNING, DANGER]
+
+  ###### variables ######
+  attr_writer :type
+
+  #=== Examples
+  #   HasHelpers::Alert.new("Detail")
+  #   HasHelpers::Alert.new("Detail 1", "Detail 2")
+  #   HasHelpers::Alert.new("Detail 1", "Detail 2", type: HasHelpers::Alert::SUCCESS)
+  def initialize(*args, **options)
+    super(details: args, **options)
+  end
+
+  def details=(value)
+    @details = Array(value)
+  end
+
+  def details
+    @details ||= []
+  end
+
+  def type
+    @type ||= INFO
+  end
+
+  # ActiveModel interface
+  def to_partial_path
+    "has_helpers/alerts/alert"
+  end
+end

data/lib/has_helpers/utils/container.rb

@@ -0,0 +1,46 @@
+# typed: true
+# frozen_string_literal: true
+
+module HasHelpers
+  class Container
+    include HasHelpers::Attributes
+    include HasHelpers::UIAttributes
+
+    attr_writer :tag, # Tag corresponds to the HTML element tag which should be rendered: div, ul, section, etc.
+                :renderable
+
+    def tag
+      @tag ||= :div
+    end
+
+    def to_container(**attrs)
+      assign_attributes(attrs)
+      self
+    end
+
+    def to_renderable
+      self
+    end
+
+    def to_partial_path
+      "/has_helpers/containers/#{ template }"
+    end
+
+    def renderable
+      @renderable && @renderable.to_renderable
+    end
+
+    def any?
+      renderable.try(:any?)
+    end
+
+    alias present? any?
+
+    private
+
+    def template
+      # Add templates here as needed
+      :container
+    end
+  end
+end

data/lib/has_helpers/utils/dataset.rb

@@ -0,0 +1,34 @@
+# typed: false
+# frozen_string_literal: true
+
+module HasHelpers
+  class Dataset
+    include HasHelpers::Attributes
+    include HasHelpers::UIAttributes
+
+    attr_accessor :table
+    attr_writer :data
+
+    def to_renderable
+      Container.new(
+        renderable: data.map do |row|
+          Container.new(
+            renderable: row.map do |cell|
+              Container.new(
+                renderable: cell,
+                tag: :span,
+                skin: "cell"
+              )
+            end,
+            skin: "row"
+          )
+        end,
+        skin: [*skin, "dataset", *(table && "table")].join(" ")
+      )
+    end
+
+    def data
+      @data ||= []
+    end
+  end
+end

data/lib/has_helpers/utils/email_notifier.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Email Notifier. Previously ::Frameworkhq::Notifier
+class HasHelpers::EmailNotifier < ActionMailer::Base
+  def system(subject:, to: from_address, from: from_address, body: {})
+    @body = body
+    mail(to: to, from: from, subject: subject, date: Time.zone.now)
+  end
+
+  private
+
+  def from_address
+    "#{::HasHelpers::Application.current_application.name} <kyle@onehq.com>"
+  end
+end

data/lib/has_helpers/utils/icon.rb

@@ -0,0 +1,66 @@
+# typed: false
+# frozen_string_literal: true
+
+class HasHelpers::Icon
+  include ::HasHelpers::Attributes::AttributeAssignment
+  include ::HasHelpers::UIAttributes::HTMLAttributes
+
+  attr_accessor :orientation, :name
+  attr_writer :attributes
+
+  # Handle options passed to new. Hash args are assigned to attributes like ActiveRecord does.
+  # ==== Examples
+  #   ::HasHelpers::Icon.new("calendar")
+  #   ::HasHelpers::Icon.new("plane", :orientation => :flip_horizontal)
+  #   ::HasHelpers::Icon.new("plane", :orientation => "rotate-90")
+  def initialize(icon_name, **options)
+    self.name = icon_name
+    assign_attributes(**options)
+  end
+
+  def to_icon(**options)
+    assign_attributes(**options)
+    self
+  end
+
+  # Renders a string representation of the current Icon. This is currently set to
+  # render as Font Awesome class names but could be easily altered (perhaps using
+  # optional settings) if needed.
+  #
+  # === Examples
+  #   ::HasHelpers::Icon.new("calendar").to_s                                             #=> "fa fa-calendar"
+  #   ::HasHelpers::Icon.new("calendar", :category_green).to_s                            #=> "fa fa-calendar category-green"
+  #   ::HasHelpers::Icon.new("plane", :orientation => :flip_horizantal).to_s              #=> "fa fa-plane fa-flip-horizontal"
+  #   ::HasHelpers::Icon.new("plane", :category_green, :orientation => "rotate-90").to_s  #=> "fa fa-plane fa-rotate-90 category-green"
+  #   ::HasHelpers::Icon.new("plane", :attributes => [:category_green, :category_disabled], :orientation => "rotate-90").to_s       #=> "fa fa-plane fa-rotate-90 category-green"
+  def to_s
+    [
+      "fa fa-#{ name }",
+      *("fa-#{orientation}" if orientation),
+      *attributes
+    ].join(" ").tr("_", "-")
+  end
+
+  alias skin to_s
+
+  # Returns an Array of attributes assigned to the current icon. The result is
+  # mutable and may be used to append, remove or modify the current attributes.
+  #
+  # === Examples
+  #   icon = ::HasHelpers::Icon.new("calendar", :julian)
+  #   icon.attributes  # => [ :julian ]
+  #
+  #   icon.attributes << :reformed
+  #   icon.attributes  # => [ :julian, :reformed ]
+  def attributes
+    @attributes ||= Array(@attributes)
+  end
+
+  def to_renderable
+    self
+  end
+
+  def to_partial_path
+    "has_helpers/icons/icon"
+  end
+end

data/lib/has_helpers/utils/input.rb

@@ -0,0 +1,45 @@
+# typed: false
+# frozen_string_literal: true
+
+# Represents a user input on a form.
+#
+#   Input.new(:name => "Find")
+#
+# If +service+ is set in addition to +name+ or +value+ the submit will
+# be wrapped in a form element.
+class Input
+  DEFAULT_TYPE = :submit
+
+  include HasHelpers::Attributes
+  include HasHelpers::UIAttributes
+  attr_writer :label, :value, :actions, :type
+  attr_accessor :name
+
+  def label
+    @label || name.to_s.titleize
+  end
+
+  def value
+    @value || name
+  end
+
+  guarded_attr_accessor :icon, :service, auto_guard: true
+  guarded_collection :actions, auto_guard: true
+
+  def to_input
+    self
+  end
+
+  def to_action
+    ::Action.new(input: self)
+  end
+
+  # ActiveModel interface
+  def to_partial_path
+    "has_helpers/inputs/input"
+  end
+
+  def type
+    @type ||= DEFAULT_TYPE
+  end
+end