rcap 2.7.0 → 2.7.3

data/lib/rcap/cap_1_1/parameter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_1
     # A Parameter object is valid if

data/lib/rcap/cap_1_1/point.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_1
     # A Point object is valid if

data/lib/rcap/cap_1_1/polygon.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_1
     # A Polygon object is valid if

data/lib/rcap/cap_1_1/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_1
     # A Resource object is valid if
@@ -6,8 +8,8 @@ module RCAP
       # @return [String] Dereferenced URI - contents of URI Base64 encoded
       attr_accessor(:deref_uri)
 
-      DEREF_URI_ELEMENT_NAME     = 'derefUri'
-      DEREF_URI_XPATH     = "cap:#{ DEREF_URI_ELEMENT_NAME }"
+      DEREF_URI_ELEMENT_NAME = 'derefUri'
+      DEREF_URI_XPATH = "cap:#{DEREF_URI_ELEMENT_NAME}"
 
       # @return [REXML::Element]
       def to_xml_element
@@ -50,7 +52,7 @@ module RCAP
         end
       end
 
-      DEREF_URI_YAML     = 'Derefrenced URI Data'
+      DEREF_URI_YAML = 'Derefrenced URI Data'
 
       def to_yaml_data
         RCAP.attribute_values_to_hash([RESOURCE_DESC_YAML, @resource_desc],
@@ -75,7 +77,7 @@ module RCAP
         end
       end
 
-      DEREF_URI_KEY     = 'deref_uri'
+      DEREF_URI_KEY = 'deref_uri'
 
       # @return [Hash]
       def to_h

data/lib/rcap/cap_1_2/alert.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
     # An Alert object is valid if
@@ -12,9 +14,9 @@ module RCAP
       XMLNS = 'urn:oasis:names:tc:emergency:cap:1.2'
       CAP_VERSION = '1.2'
 
-      STATUS_DRAFT    = 'Draft'
+      STATUS_DRAFT = 'Draft'
       # Valid values for status
-      VALID_STATUSES = [STATUS_ACTUAL, STATUS_EXERCISE, STATUS_SYSTEM, STATUS_TEST, STATUS_DRAFT]
+      VALID_STATUSES = [STATUS_ACTUAL, STATUS_EXERCISE, STATUS_SYSTEM, STATUS_TEST, STATUS_DRAFT].freeze
 
       # @return [String]
       def xmlns

data/lib/rcap/cap_1_2/area.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
     # An Area object is valid if

data/lib/rcap/cap_1_2/circle.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
     # A Circle object is valid if

data/lib/rcap/cap_1_2/event_code.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
     # Subclass of {Parameter}
     class EventCode < RCAP::Base::EventCode
       XML_ELEMENT_NAME = 'eventCode'
-      XPATH = "cap:#{ XML_ELEMENT_NAME }"
+      XPATH = "cap:#{XML_ELEMENT_NAME}"
 
       # @return [String]
       def xmlns

data/lib/rcap/cap_1_2/geocode.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
     # Subclass of {Parameter}
     class Geocode < RCAP::Base::Geocode
       XML_ELEMENT_NAME = 'geocode'
-      XPATH = "cap:#{ XML_ELEMENT_NAME }"
+      XPATH = "cap:#{XML_ELEMENT_NAME}"
 
       # @return [String]
       def xmlns

data/lib/rcap/cap_1_2/info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
     # In Info object is valid if
@@ -9,26 +11,28 @@ module RCAP
     # * all Resource objects in the resources collection are valid
     # * all Area objects in the areas collection are valid
     class Info < RCAP::Base::Info
-      RESPONSE_TYPE_SHELTER  = 'Shelter'
-      RESPONSE_TYPE_EVACUATE = 'Evacuate'
-      RESPONSE_TYPE_PREPARE  = 'Prepare'
-      RESPONSE_TYPE_EXECUTE  = 'Execute'
-      RESPONSE_TYPE_MONITOR  = 'Monitor'
-      RESPONSE_TYPE_ASSESS   = 'Assess'
-      RESPONSE_TYPE_NONE     = 'None'
+      RESPONSE_TYPE_SHELTER   = 'Shelter'
+      RESPONSE_TYPE_EVACUATE  = 'Evacuate'
+      RESPONSE_TYPE_PREPARE   = 'Prepare'
+      RESPONSE_TYPE_EXECUTE   = 'Execute'
+      RESPONSE_TYPE_MONITOR   = 'Monitor'
+      RESPONSE_TYPE_AVOID     = 'Avoid'
+      RESPONSE_TYPE_ASSESS    = 'Assess'
+      RESPONSE_TYPE_ALL_CLEAR = 'AllClear'
+      RESPONSE_TYPE_NONE      = 'None'
       # Valid values for response_type
-      VALID_RESPONSE_TYPES = [RESPONSE_TYPE_SHELTER, RESPONSE_TYPE_EVACUATE, RESPONSE_TYPE_PREPARE, RESPONSE_TYPE_EXECUTE, RESPONSE_TYPE_MONITOR, RESPONSE_TYPE_ASSESS, RESPONSE_TYPE_NONE]
+      VALID_RESPONSE_TYPES = [RESPONSE_TYPE_SHELTER, RESPONSE_TYPE_EVACUATE, RESPONSE_TYPE_PREPARE, RESPONSE_TYPE_EXECUTE, RESPONSE_TYPE_MONITOR, RESPONSE_TYPE_AVOID, RESPONSE_TYPE_ASSESS, RESPONSE_TYPE_ALL_CLEAR, RESPONSE_TYPE_NONE].freeze
 
       CERTAINTY_OBSERVED = 'Observed'
       # Valid valies for certainty
-      VALID_CERTAINTIES = [CERTAINTY_OBSERVED, CERTAINTY_LIKELY, CERTAINTY_POSSIBLE, CERTAINTY_UNLIKELY, CERTAINTY_UNKNOWN]
+      VALID_CERTAINTIES = [CERTAINTY_OBSERVED, CERTAINTY_LIKELY, CERTAINTY_POSSIBLE, CERTAINTY_UNLIKELY, CERTAINTY_UNKNOWN].freeze
 
       RESPONSE_TYPE_ELEMENT_NAME = 'responseType'
-      RESPONSE_TYPE_XPATH = "cap:#{ RESPONSE_TYPE_ELEMENT_NAME }"
+      RESPONSE_TYPE_XPATH = "cap:#{RESPONSE_TYPE_ELEMENT_NAME}"
 
       validates_length_of(:categories, minimum: 1)
       validates_inclusion_of_members_of(:response_types, in: VALID_RESPONSE_TYPES, allow_blank: true)
-      validates_inclusion_of(:certainty, allow_nil: true, in: VALID_CERTAINTIES, message: "can only be assigned the following values: #{ VALID_CERTAINTIES.join(', ') }")
+      validates_inclusion_of(:certainty, allow_nil: true, in: VALID_CERTAINTIES, message: "can only be assigned the following values: #{VALID_CERTAINTIES.join(', ')}")
 
       # @return [Array<String>] Collection of textual response types; elements must be from {VALID_RESPONSE_TYPES}
       attr_reader(:response_types)
@@ -113,27 +117,27 @@ module RCAP
 
       # @return [String]
       def inspect
-        info_inspect = "Language:       #{ @language }\n"\
-        "Categories:     #{ @categories.to_s_for_cap }\n"\
-        "Event:          #{ @event }\n"\
-        "Response Types: #{ @response_types.to_s_for_cap }\n"\
-        "Urgency:        #{ @urgency }\n"\
-        "Severity:       #{ @severity }\n"\
-        "Certainty:      #{ @certainty }\n"\
-        "Audience:       #{ @audience }\n"\
-        "Event Codes:    #{ @event_codes.inspect }\n"\
-        "Effective:      #{ @effective }\n"\
-        "Onset:          #{ @onset }\n"\
-        "Expires:        #{ @expires }\n"\
-        "Sender Name:    #{ @sender_name }\n"\
-        "Headline:       #{ @headline }\n"\
-        "Description:\n" +           @description.to_s.lines.map { |line| '  ' + line }.join("\n") + "\n"\
-          "Instruction:    #{ @instruction }\n"\
-        "Web:            #{ @web }\n"\
-        "Contact:        #{ @contact }\n"\
-        "Parameters:\n" +           @parameters.map { |parameter| '  ' + parameter.inspect }.join("\n") + "\n"\
-          "Resources:\n" +           @resources.map { |resource| '  ' + resource.inspect }.join("\n") + "\n"\
-          "Area:\n" +           @areas.map { |area| "  #{ area }" }.join("\n") + "\n"
+        info_inspect = "Language:       #{@language}\n"\
+        "Categories:     #{@categories.to_s_for_cap}\n"\
+        "Event:          #{@event}\n"\
+        "Response Types: #{@response_types.to_s_for_cap}\n"\
+        "Urgency:        #{@urgency}\n"\
+        "Severity:       #{@severity}\n"\
+        "Certainty:      #{@certainty}\n"\
+        "Audience:       #{@audience}\n"\
+        "Event Codes:    #{@event_codes.inspect}\n"\
+        "Effective:      #{@effective}\n"\
+        "Onset:          #{@onset}\n"\
+        "Expires:        #{@expires}\n"\
+        "Sender Name:    #{@sender_name}\n"\
+        "Headline:       #{@headline}\n"\
+        "Description:\n" + @description.to_s.lines.map { |line| '  ' + line }.join("\n") + "\n"\
+          "Instruction:    #{@instruction}\n"\
+        "Web:            #{@web}\n"\
+        "Contact:        #{@contact}\n"\
+        "Parameters:\n" + @parameters.map { |parameter| '  ' + parameter.inspect }.join("\n") + "\n"\
+          "Resources:\n" + @resources.map { |resource| '  ' + resource.inspect }.join("\n") + "\n"\
+          "Area:\n" + @areas.map { |area| "  #{area}" }.join("\n") + "\n"
         RCAP.format_lines_for_inspect('INFO', info_inspect)
       end
 
@@ -142,7 +146,7 @@ module RCAP
       #
       # @return [String]
       def to_s
-        "#{ @event }(#{ @urgency }/#{ @severity }/#{ @certainty })"
+        "#{@event}(#{@urgency}/#{@severity}/#{@certainty})"
       end
 
       # @param [REXML::Element] info_xml_element
@@ -159,7 +163,7 @@ module RCAP
 
       # @return [Hash]
       def to_yaml_data
-        parameter_to_hash = lambda { |hash, parameter| hash.merge(parameter.name => parameter.value) }
+        parameter_to_hash = ->(hash, parameter) { hash.merge(parameter.name => parameter.value) }
 
         RCAP.attribute_values_to_hash([LANGUAGE_YAML,       @language],
                                       [CATEGORIES_YAML,     @categories],
@@ -220,10 +224,10 @@ module RCAP
                                       [INSTRUCTION_KEY,    @instruction],
                                       [WEB_KEY,            @web],
                                       [CONTACT_KEY,        @contact],
-                                      [RESOURCES_KEY,      @resources.map { |resource| resource.to_h }],
-                                      [EVENT_CODES_KEY,    @event_codes.map { |event_code| event_code.to_h }],
-                                      [PARAMETERS_KEY,     @parameters.map { |parameter| parameter.to_h }],
-                                      [AREAS_KEY,          @areas.map { |area| area.to_h }])
+                                      [RESOURCES_KEY,      @resources.map(&:to_h)],
+                                      [EVENT_CODES_KEY,    @event_codes.map(&:to_h)],
+                                      [PARAMETERS_KEY,     @parameters.map(&:to_h)],
+                                      [AREAS_KEY,          @areas.map(&:to_h)])
       end
 
       # @param [Hash] info_hash

data/lib/rcap/cap_1_2/parameter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
     # A Parameter object is valid if

data/lib/rcap/cap_1_2/point.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
     # A Point object is valid if

data/lib/rcap/cap_1_2/polygon.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
     # A Polygon object is valid if

data/lib/rcap/cap_1_2/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
     # A Resource object is valid if
@@ -9,9 +11,9 @@ module RCAP
 
       validates_presence_of(:mime_type)
 
-      DEREF_URI_ELEMENT_NAME     = 'derefUri'
+      DEREF_URI_ELEMENT_NAME = 'derefUri'
 
-      DEREF_URI_XPATH     = "cap:#{ DEREF_URI_ELEMENT_NAME }"
+      DEREF_URI_XPATH = "cap:#{DEREF_URI_ELEMENT_NAME}"
 
       # @return [REXML::Element]
       def to_xml_element
@@ -54,7 +56,7 @@ module RCAP
         end
       end
 
-      DEREF_URI_YAML     = 'Derefrenced URI Data'
+      DEREF_URI_YAML = 'Derefrenced URI Data'
 
       # @param [Hash] options
       # @return [String]
@@ -65,7 +67,8 @@ module RCAP
           [MIME_TYPE_YAML,     @mime_type],
           [DEREF_URI_YAML,     @deref_uri],
           [SIZE_YAML,          @size],
-          [DIGEST_YAML,        @digest]).to_yaml(options)
+          [DIGEST_YAML,        @digest]
+        ).to_yaml(options)
       end
 
       # @param [Hash] resource_yaml_data
@@ -76,7 +79,7 @@ module RCAP
         end
       end
 
-      DEREF_URI_KEY     = 'deref_uri'
+      DEREF_URI_KEY = 'deref_uri'
 
       # @return [Hash]
       def to_h

data/lib/rcap/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   XML_PRETTY_PRINTER = REXML::Formatters::Pretty.new(2)
   XML_PRETTY_PRINTER.compact = true

data/lib/rcap/custom_validators.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Validation
   module ClassMethods
     CAP_NUMBER_REGEX  = Regexp.new('^-{0,1}\d*\.{0,1}\d+$')
@@ -27,7 +29,7 @@ module Validation
       }.merge!(attributes.extract_options!)
 
       validates_each(*attributes) do |object, attribute, collection|
-        next if ( collection.nil? && options[:allow_nil]) || ( collection.empty? && options[:allow_empty])
+        next if (collection.nil? && options[:allow_nil]) || (collection.empty? && options[:allow_empty])
         unless collection.all? { |member| options[:in].include?(member) }
           object.errors[attribute] << options[:message]
         end
@@ -40,7 +42,7 @@ module Validation
       }.merge!(attributes.extract_options!)
 
       validates_each(*attributes) do |object, attribute, collection|
-        next if ( collection.nil? && options[:allow_nil]) || ( collection.empty? && options[:allow_empty])
+        next if (collection.nil? && options[:allow_nil]) || (collection.empty? && options[:allow_empty])
         unless options[:minimum] && collection.length >= options[:minimum]
           object.errors[attribute] << options[:message]
         end
@@ -54,9 +56,7 @@ module Validation
 
       validates_each(*attributes) do |object, attribute, value|
         next if  value.nil? && options[:allow_nil]
-        unless value && value.valid?
-          object.errors[attribute] << options[:message]
-        end
+        object.errors[attribute] << options[:message] unless value&.valid?
       end
     end
 
@@ -66,8 +66,8 @@ module Validation
       }.merge!(attributes.extract_options!)
 
       validates_each(*attributes) do |object, attribute, collection|
-        next if ( collection.nil? && options[:allow_nil]) || ( collection.empty? && options[:allow_empty])
-        unless collection.all? { |element| element.valid? }
+        next if (collection.nil? && options[:allow_nil]) || (collection.empty? && options[:allow_empty])
+        unless collection.all?(&:valid?)
           object.errors[attribute] << options[:message]
         end
       end
@@ -107,16 +107,16 @@ module Validation
 
     def validates_numericality_of(*attributes)
       options = {
-        message: 'is not a number or does not meet a conditional requirement',
+        message: 'is not a number or does not meet a conditional requirement'
       }.merge!(attributes.extract_options!)
 
       re = options[:only_integer] ? CAP_INTEGER_REGEX : CAP_NUMBER_REGEX
 
       validates_each(*attributes) do |object, attribute, value|
         next if value.nil? && options[:allow_nil]
-        unless ( value.to_s =~ re) &&
-          ( options[:greater_than].nil? || value && value > options[:greater_than]) &&
-          ( options[:greater_than_or_equal].nil? || value && value >= options[:greater_than_or_equal])
+        unless (value.to_s =~ re) &&
+               (options[:greater_than].nil? || value && value > options[:greater_than]) &&
+               (options[:greater_than_or_equal].nil? || value && value >= options[:greater_than_or_equal])
           object.errors[attribute] << options[:message]
         end
       end

data/lib/rcap/extensions/array.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Array
   # Formats an array into a string suitable for a CAP message.
   #

data/lib/rcap/extensions/date.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class Date
-  alias_method :inspect, :to_s
+  alias inspect to_s
 
   # Returns a string representaion of the time suitable for CAP.
   # @return [String]

data/lib/rcap/extensions/date_time.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class DateTime
-  alias_method :inspect, :to_s
+  alias inspect to_s
 
   # Returns a string representaion of the time suitable for CAP.
   # @return [String]
@@ -15,6 +17,7 @@ class DateTime
   end
 
   private
+
   def utc_hours_offset
     offset * 24
   end

data/lib/rcap/extensions/float.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Float
   def blank?
     false

data/lib/rcap/extensions/integer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Integer
   def blank?
     false

data/lib/rcap/extensions/nil_class.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class NilClass
   def blank?
     true

data/lib/rcap/extensions/string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class String
   CAP_LIST_REGEX = Regexp.new('"([\w\s]+)"|(\S+)')
   WHITESPACE_REGEX = Regexp.new('^\s+$')
@@ -10,7 +12,7 @@ class String
   #   "one".for_cap_list       # => "one"
   #   "two words".for_cap_list # => "\"two words\""
   def for_cap_list
-    if self =~ /\s/
+    if /\s/.match?(self)
       '"' + self + '"'
     else
       self