feat: added required field indicator

[candidosales]

• Added required label in the required fields

[candidosales]

@nvasilevski, could you review it?

[candidosales]

After changing how to render the space in the VSCode, I found the issue 🙏🏼 .

[candidosales]

@adrianna-chang-shopify , could you review it?

[candidosales]

@etiennebarrie , could you review it?

[nvasilevski]

I think this makes sense, pretty straightforward improvement. Let's have one more review

[adrianna-chang-shopify]

Changes make sense, a couple small comments. Thanks!

[etiennebarrie]

We might need to skip adding the class this if there are conditions like if:, unless:, allow_nil:, allow_blank:. I haven't checked how possible it is to do (I'm not sure the options are passed to the validator or just kept at the model level).

[candidosales]

I tried your suggestion but I didn't find any method to check if the parameter is required. The list of methods below.

:unicode_normalized?, :delete_suffix!, :squeeze!, :each_line, :delete, :squeeze, :lstrip!, :rstrip, :delete_prefix!, :rjust, :rpartition, :each_byte, :each_char, :each_codepoint, :tr!, :tr_s!, :rstrip!, :shell_split, :last, :inquiry, :slice!, :delete!, :html_safe, :%, :exclude?, :*, :+, :ends_with?, :starts_with?, :indent!, :strip_heredoc, :dasherize, :acts_like_string?, :to, :truncate, :+@, :-@, :parse_csv, :<=>, :<<, :==, :===, :=~, :[], :[]=, :to_d, :include?, :empty?, :eql?, :hash, :freeze, :inspect, :intern, :indent, :length, :size, :succ, :in_time_zone, :to_blob, :to_str, :to_sym, :to_s, :to_i, :to_f, :to_r, :to_date, :to_datetime, :pretty_print, :from, :dup, :unpack, :unpack1, :to_c, :at, :ext, :shellescape, :count, :partition, :first, :parameterize, :pathmap, :mb_chars, :is_utf8?, :to_time, :camelcase, :titlecase, :shellsplit, :sum, :next, :underscore, :pluralize, :casecmp, :singularize, :bytesize, :casecmp?, :match, :match?, :squish, :camelize, :succ!, :next!, :upto, :insert, :byteindex, :rindex, :humanize, :upcase_first, :downcase_first, :titleize, :tableize, :clear, :classify, :byterindex, :demodulize, :deconstantize, :chr, :foreign_key, :constantize, :byteslice, :safe_constantize, :remove, :getbyte, :dedup, :dump, :bytesplice, :scrub, :scrub!, :index, :setbyte, :undump, :downcase, :replace, :swapcase, :upcase!, :upcase, :reverse, :swapcase!, :hex, :oct, :downcase!, :lines, :bytes, :capitalize, :crypt, :grapheme_clusters, :prepend, :end_with?, :blank?, :codepoints, :sub, :split, :present?, :concat, :encode, :encode!, :ljust, :as_json, :squish!, :remove!, :scan, :chars, :capitalize!, :strip, :start_with?, :reverse!, :truncate_bytes, :chomp, :truncate_words, :lstrip, :ord, :gsub, :chop, :sub!, :gsub!, :append_as_bytes, :center, :delete_prefix, :delete_suffix, :each_grapheme_cluster, :slice, :chop!, :chomp!, :encoding, :force_encoding, :b, :valid_encoding?, :ascii_only?, :tr, :tr_s, :strip!, :unicode_normalize, :unicode_normalize!, :to_json, :to_json_raw, :to_json_raw_object, :between?, :clamp, :<=, :>=, :<, :>, :require_dependency, :to_param, :to_query, :presence_in, :in?, :html_safe?, :acts_like?, :with, :instance_variable_names, :presence, :to_yaml, :instance_values, :deep_dup, :with_options, :duplicable?, :pretty_print_cycle, :pretty_print_inspect, :pretty_print_instance_variables, :try, :try!, :trap, :singleton_class, :itself, :methods, :singleton_methods, :protected_methods, :private_methods, :public_methods, :instance_variables, :instance_variable_get, :instance_variable_set, :instance_variable_defined?, :remove_instance_variable, :instance_of?, :kind_of?, :is_a?, :display, :frozen?, :class, :then, :yield_self, :tap, :gem, :pretty_inspect, :public_send, :class_eval, :extend, :clone, :debugger, :!~, :nil?, :method, :respond_to?, :public_method, :singleton_method, :define_singleton_method, :object_id, :send, :to_enum, :enum_for, :equal?, :!, :__send__, :!=, :__id__, :instance_eval, :instance_exec, :singleton_method_added

[adrianna-chang-shopify]

We should be able to check validator.options here to accomplish this.

[candidosales]

I have tried use but not works as expected:

def attribute_required?(task, parameter_name)
    task.class.validators_on(parameter_name).any? do |validator|
    puts "Validator: #{validator.options.inspect}"
    validator.options[:presence] == true
    end
end

I have inspected the options and it isn't showing presence

Validator: {}
Validator: {with: /\A(\s?\d+(,\s?\d+\s?)*)\z/, allow_blank: true}
Validator: {in: [100, 200, 300], allow_nil: true}
Validator: {in: #<Proc:0x0000000145b92760 /Users/candidogomes/Documents/Projects/maintenance_tasks/test/dummy/app/tasks/maintenance/params_task.rb:41>, allow_nil: true}
Validator: {in: #<Proc:0x0000000145b92328 /Users/candidogomes/Documents/Projects/maintenance_tasks/test/dummy/app/tasks/maintenance/params_task.rb:42>, allow_nil: true}
Validator: {in: :dropdown_attr_options, allow_nil: true}
Validator: {in: Maintenance::DropdownOptions, allow_nil: true}
Validator: {within: [true, false], allow_nil: true}
Validator: {in: 100.., allow_nil: true}

[candidosales]

@adrianna-chang-shopify , could you review it? 🙏🏼

[adrianna-chang-shopify]

We should be able to check validator.options here to accomplish this.

[adrianna-chang-shopify]

Let's use the validator DSL instead of handcrafting a validator here, ie.:

task_class = Class.new(MaintenanceTasks::Task) do
  validates :required_attribute, presence: true
end