Class: Precheck::CopyrightDateRule

Inherits:
AbstractTextMatchRule show all
Defined in:
precheck/lib/precheck/rules/copyright_date_rule.rb

Constant Summary

Constants inherited from AbstractTextMatchRule

AbstractTextMatchRule::WORD_SEARCH_TYPES

Instance Attribute Summary

Attributes inherited from FastlaneCore::ConfigItem

#allow_shell_conversion, #code_gen_default_value, #code_gen_sensitive, #conflict_block, #conflicting_options, #default_value, #default_value_dynamic, #deprecated, #description, #display_in_shell, #env_name, #env_names, #key, #optional, #sensitive, #short_option, #skip_type_validation, #verify_block

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AbstractTextMatchRule

#allowed_lowercased_words, #remove_safe_words, #rule_block

Methods inherited from TextRule

#handle_item?

Methods inherited from Rule

#check_item, #customize_with_data, default_value, #friendly_name, #handle_item?, #initialize, #inspect, #item_field_supported?, #needs_customization?, #perform_check, #rule_block, #skip_item_not_meant_for_this_rule, #to_s

Methods inherited from FastlaneCore::ConfigItem

#auto_convert_value, #data_type, #deprecated_description, #doc_default_value, #ensure_array_type_passes_validation, #ensure_boolean_type_passes_validation, #ensure_generic_type_passes_validation, #fetch_env_value, #help_default_value, #initialize, #is_string, #string?, #to_s, #update_code_gen_default_value_if_able!, #valid?, #verify!

Constructor Details

This class inherits a constructor from Precheck::Rule

Class Method Details

.descriptionObject



17
18
19
# File 'precheck/lib/precheck/rules/copyright_date_rule.rb', line 17

def self.description
  "using a copyright date that is any different from this current year, or missing a date"
end

.env_nameObject



9
10
11
# File 'precheck/lib/precheck/rules/copyright_date_rule.rb', line 9

def self.env_name
  "RULE_COPYRIGHT_DATE"
end

.friendly_nameObject



13
14
15
# File 'precheck/lib/precheck/rules/copyright_date_rule.rb', line 13

def self.friendly_name
  "Incorrect, or missing copyright date"
end

.keyObject



5
6
7
# File 'precheck/lib/precheck/rules/copyright_date_rule.rb', line 5

def self.key
  :copyright_date
end

Instance Method Details

#lowercased_words_to_look_forObject



33
34
35
# File 'precheck/lib/precheck/rules/copyright_date_rule.rb', line 33

def lowercased_words_to_look_for
  [DateTime.now.year.to_s]
end

#pass_if_empty?Boolean

Returns:



21
22
23
# File 'precheck/lib/precheck/rules/copyright_date_rule.rb', line 21

def pass_if_empty?
  return false
end

#supported_fields_symbol_setObject



25
26
27
# File 'precheck/lib/precheck/rules/copyright_date_rule.rb', line 25

def supported_fields_symbol_set
  [:copyright].to_set
end

#word_search_typeObject



29
30
31
# File 'precheck/lib/precheck/rules/copyright_date_rule.rb', line 29

def word_search_type
  WORD_SEARCH_TYPES[:fail_on_exclusion]
end