rcap 2.5.0 → 2.7.4

data/lib/rcap/cap_1_0/alert.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
     # An Alert object is valid if
@@ -25,34 +27,28 @@ module RCAP
         Info
       end
 
-      PASSWORD_ELEMENT_NAME    = 'password'
+      PASSWORD_ELEMENT_NAME = 'password'
 
       # @return [REXML::Element]
       def to_xml_element
         xml_element = REXML::Element.new(XML_ELEMENT_NAME)
         xml_element.add_namespace(XMLNS)
-        xml_element.add_element(IDENTIFIER_ELEMENT_NAME).add_text(@identifier)   if @identifier
-        xml_element.add_element(SENDER_ELEMENT_NAME).add_text(@sender)           if @sender
-        xml_element.add_element(SENT_ELEMENT_NAME).add_text(@sent.to_s_for_cap)  if @sent
-        xml_element.add_element(STATUS_ELEMENT_NAME).add_text(@status)           if @status
-        xml_element.add_element(MSG_TYPE_ELEMENT_NAME).add_text(@msg_type)       if @msg_type
-        xml_element.add_element(PASSWORD_ELEMENT_NAME).add_text(@password)       if @password
-        xml_element.add_element(SOURCE_ELEMENT_NAME).add_text(@source)           if @source
-        xml_element.add_element(SCOPE_ELEMENT_NAME).add_text(@scope)             if @scope
-        xml_element.add_element(RESTRICTION_ELEMENT_NAME).add_text(@restriction) if @restriction
-        if @addresses.any?
-          xml_element.add_element(ADDRESSES_ELEMENT_NAME).add_text(@addresses.to_s_for_cap)
-        end
+        xml_element.add_element(IDENTIFIER_ELEMENT_NAME).add_text(@identifier.to_s)   if @identifier
+        xml_element.add_element(SENDER_ELEMENT_NAME).add_text(@sender.to_s)           if @sender
+        xml_element.add_element(SENT_ELEMENT_NAME).add_text(@sent.to_s_for_cap.to_s)  if @sent
+        xml_element.add_element(STATUS_ELEMENT_NAME).add_text(@status.to_s)           if @status
+        xml_element.add_element(MSG_TYPE_ELEMENT_NAME).add_text(@msg_type.to_s)       if @msg_type
+        xml_element.add_element(PASSWORD_ELEMENT_NAME).add_text(@password.to_s)       if @password
+        xml_element.add_element(SOURCE_ELEMENT_NAME).add_text(@source.to_s)           if @source
+        xml_element.add_element(SCOPE_ELEMENT_NAME).add_text(@scope.to_s)             if @scope
+        xml_element.add_element(RESTRICTION_ELEMENT_NAME).add_text(@restriction.to_s) if @restriction
+        xml_element.add_element(ADDRESSES_ELEMENT_NAME).add_text(@addresses.to_s_for_cap) if @addresses.any?
         @codes.each do |code|
-          xml_element.add_element(CODE_ELEMENT_NAME).add_text(code)
-        end
-        xml_element.add_element(NOTE_ELEMENT_NAME).add_text(@note) if @note
-        if @references.any?
-          xml_element.add_element(REFERENCES_ELEMENT_NAME).add_text(@references.join(' '))
-        end
-        if @incidents.any?
-          xml_element.add_element(INCIDENTS_ELEMENT_NAME).add_text(@incidents.join(' '))
+          xml_element.add_element(CODE_ELEMENT_NAME).add_text(code.to_s)
         end
+        xml_element.add_element(NOTE_ELEMENT_NAME).add_text(@note.to_s) if @note
+        xml_element.add_element(REFERENCES_ELEMENT_NAME).add_text(@references.join(' ')) if @references.any?
+        xml_element.add_element(INCIDENTS_ELEMENT_NAME).add_text(@incidents.join(' ')) if @incidents.any?
         @infos.each do |info|
           xml_element.add_element(info.to_xml_element)
         end
@@ -61,28 +57,29 @@ module RCAP
 
       # @return [String]
       def inspect
-        alert_inspect = ["CAP Version:  #{ CAP_VERSION }",
-                         "Identifier:   #{ @identifier }",
-                         "Sender:       #{ @sender }",
-                         "Sent:         #{ @sent }",
-                         "Status:       #{ @status }",
-                         "Message Type: #{ @msg_type }",
-                         "Password:     #{ @password }",
-                         "Source:       #{ @source }",
-                         "Scope:        #{ @scope }",
-                         "Restriction:  #{ @restriction }",
-                         "Addresses:    #{ @addresses.to_s_for_cap }",
+        alert_inspect = ["CAP Version:  #{CAP_VERSION}",
+                         "Identifier:   #{@identifier}",
+                         "Sender:       #{@sender}",
+                         "Sent:         #{@sent}",
+                         "Status:       #{@status}",
+                         "Message Type: #{@msg_type}",
+                         "Password:     #{@password}",
+                         "Source:       #{@source}",
+                         "Scope:        #{@scope}",
+                         "Restriction:  #{@restriction}",
+                         "Addresses:    #{@addresses.to_s_for_cap}",
                          'Codes:',
                          @codes.map { |code| '  ' + code }.join("\n"),
-                         "Note:         #{ @note }",
-                         "References:   #{ @references.join(' ')}",
-                         "Incidents:    #{ @incidents.join(' ')}",
+                         "Note:         #{@note}",
+                         'References:',
+                         @references.join("\n "),
+                         "Incidents:    #{@incidents.join(' ')}",
                          'Information:',
                          @infos.map { |info| '  ' + info.to_s }.join("\n")].join("\n")
         RCAP.format_lines_for_inspect('ALERT', alert_inspect)
       end
 
-      PASSWORD_XPATH    = "cap:#{ PASSWORD_ELEMENT_NAME }"
+      PASSWORD_XPATH = "cap:#{PASSWORD_ELEMENT_NAME}"
 
       # @param [REXML::Element] alert_xml_element
       # @return [RCAP::CAP_1_0::Alert]
@@ -92,7 +89,7 @@ module RCAP
         end
       end
 
-      PASSWORD_YAML    = 'Password'
+      PASSWORD_YAML = 'Password'
 
       # Returns a string containing the YAML representation of the alert.
       #
@@ -124,7 +121,7 @@ module RCAP
         end
       end
 
-      PASSWORD_KEY    = 'password'
+      PASSWORD_KEY = 'password'
 
       # Returns a Hash representation of an Alert object
       #
@@ -145,7 +142,7 @@ module RCAP
                                       [NOTE_KEY,         @note],
                                       [REFERENCES_KEY,   @references],
                                       [INCIDENTS_KEY,    @incidents],
-                                      [INFOS_KEY,        @infos.map { |info| info.to_h  }])
+                                      [INFOS_KEY,        @infos.map(&:to_h)])
       end
 
       # Initialises an Alert object from a Hash produced by Alert#to_h

data/lib/rcap/cap_1_0/area.rb

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

data/lib/rcap/cap_1_0/circle.rb

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

data/lib/rcap/cap_1_0/event_code.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
     # 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_0/geocode.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
     # 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_0/info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
     # In Info object is valid if
@@ -9,7 +11,7 @@ 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
-      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 [String]
       def xmlns

data/lib/rcap/cap_1_0/parameter.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
     # A Parameter object is valid if
     # * it has a name
-    # * it has a value
     class Parameter < RCAP::Base::Parameter
       # @return [REXML::Element]
       def to_xml_element
         xml_element = REXML::Element.new(self.class::XML_ELEMENT_NAME)
-        xml_element.add_text("#{ @name }=#{ @value }")
+        xml_element.add_text("#{@name}=#{@value}")
         xml_element
       end
 

data/lib/rcap/cap_1_0/point.rb

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

data/lib/rcap/cap_1_0/polygon.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_0
     # A Polygon object is valid if
-    # * it has a minimum of three points
+    # * if points are given it has a minimum of three points
     # * each Point object in the points collection is valid
     class Polygon < RCAP::Base::Polygon
       # @return [Class]

data/lib/rcap/cap_1_0/resource.rb

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

data/lib/rcap/cap_1_1/alert.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_1
     # An Alert object is valid if
@@ -12,9 +14,9 @@ module RCAP
       XMLNS = 'urn:oasis:names:tc:emergency:cap:1.1'
       CAP_VERSION = '1.1'
 
-      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_1/area.rb

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

data/lib/rcap/cap_1_1/circle.rb

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

data/lib/rcap/cap_1_1/event_code.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_1
     # 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_1/geocode.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_1
     # Subclass of {Parameter}
     class Geocode < RCAP::Base::Geocode
       XML_ELEMENT_NAME = 'geocode'
-      XPATH = "cap:#{ XML_ELEMENT_NAME }"
+      XPATH = "cap:#{XML_ELEMENT_NAME}"
 
       def xmlns
         Alert::XMLNS

data/lib/rcap/cap_1_1/info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_1
     # In Info object is valid if
@@ -19,16 +21,16 @@ module RCAP
       # 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]
+                              RESPONSE_TYPE_ASSESS, RESPONSE_TYPE_NONE].freeze
 
       CERTAINTY_OBSERVED = 'Observed'
       # Valid valies for certainty
       VALID_CERTAINTIES = [CERTAINTY_OBSERVED, CERTAINTY_LIKELY,
-                           CERTAINTY_POSSIBLE, CERTAINTY_UNLIKELY, CERTAINTY_UNKNOWN]
+                           CERTAINTY_POSSIBLE, CERTAINTY_UNLIKELY, CERTAINTY_UNKNOWN].freeze
 
       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)
@@ -64,7 +66,7 @@ module RCAP
       # @option attributes [Array<Resource>] :resources Collection of {Resource} objects
       # @option attributes [Array<Area>] :areas Collection of {Area} objects
       def initialize
-        @response_types =  []
+        @response_types = []
         super
       end
 
@@ -89,35 +91,35 @@ module RCAP
       end
 
       RESPONSE_TYPE_ELEMENT_NAME = 'responseType'
-      RESPONSE_TYPE_XPATH = "cap:#{ RESPONSE_TYPE_ELEMENT_NAME }"
+      RESPONSE_TYPE_XPATH = "cap:#{RESPONSE_TYPE_ELEMENT_NAME}"
 
       # @return [REXML::Element]
       def to_xml_element
         xml_element = REXML::Element.new(XML_ELEMENT_NAME)
-        xml_element.add_element(LANGUAGE_ELEMENT_NAME).add_text(@language) if @language
+        xml_element.add_element(LANGUAGE_ELEMENT_NAME).add_text(@language.to_s) if @language
         @categories.each do |category|
-          xml_element.add_element(CATEGORY_ELEMENT_NAME).add_text(category)
+          xml_element.add_element(CATEGORY_ELEMENT_NAME).add_text(category.to_s)
         end
-        xml_element.add_element(EVENT_ELEMENT_NAME).add_text(@event)
+        xml_element.add_element(EVENT_ELEMENT_NAME).add_text(@event.to_s)
         @response_types.each do |response_type|
-          xml_element.add_element(RESPONSE_TYPE_ELEMENT_NAME).add_text(response_type)
+          xml_element.add_element(RESPONSE_TYPE_ELEMENT_NAME).add_text(response_type.to_s)
         end
-        xml_element.add_element(URGENCY_ELEMENT_NAME).add_text(@urgency)
-        xml_element.add_element(SEVERITY_ELEMENT_NAME).add_text(@severity)
-        xml_element.add_element(CERTAINTY_ELEMENT_NAME).add_text(@certainty)
-        xml_element.add_element(AUDIENCE_ELEMENT_NAME).add_text(@audience) if @audience
+        xml_element.add_element(URGENCY_ELEMENT_NAME).add_text(@urgency.to_s)
+        xml_element.add_element(SEVERITY_ELEMENT_NAME).add_text(@severity.to_s)
+        xml_element.add_element(CERTAINTY_ELEMENT_NAME).add_text(@certainty.to_s)
+        xml_element.add_element(AUDIENCE_ELEMENT_NAME).add_text(@audience.to_s) if @audience
         @event_codes.each do |event_code|
           xml_element.add_element(event_code.to_xml_element)
         end
         xml_element.add_element(EFFECTIVE_ELEMENT_NAME).add_text(@effective.to_s_for_cap) if @effective
         xml_element.add_element(ONSET_ELEMENT_NAME).add_text(@onset.to_s_for_cap)         if @onset
         xml_element.add_element(EXPIRES_ELEMENT_NAME).add_text(@expires.to_s_for_cap)     if @expires
-        xml_element.add_element(SENDER_NAME_ELEMENT_NAME).add_text(@sender_name)          if @sender_name
-        xml_element.add_element(HEADLINE_ELEMENT_NAME).add_text(@headline)                if @headline
-        xml_element.add_element(DESCRIPTION_ELEMENT_NAME).add_text(@description)          if @description
-        xml_element.add_element(INSTRUCTION_ELEMENT_NAME).add_text(@instruction)          if @instruction
-        xml_element.add_element(WEB_ELEMENT_NAME).add_text(@web)                          if @web
-        xml_element.add_element(CONTACT_ELEMENT_NAME).add_text(@contact)                  if @contact
+        xml_element.add_element(SENDER_NAME_ELEMENT_NAME).add_text(@sender_name.to_s)     if @sender_name
+        xml_element.add_element(HEADLINE_ELEMENT_NAME).add_text(@headline.to_s)           if @headline
+        xml_element.add_element(DESCRIPTION_ELEMENT_NAME).add_text(@description.to_s)     if @description
+        xml_element.add_element(INSTRUCTION_ELEMENT_NAME).add_text(@instruction.to_s)     if @instruction
+        xml_element.add_element(WEB_ELEMENT_NAME).add_text(@web.to_s)                     if @web
+        xml_element.add_element(CONTACT_ELEMENT_NAME).add_text(@contact.to_s)             if @contact
         @parameters.each do |parameter|
           xml_element.add_element(parameter.to_xml_element)
         end
@@ -147,27 +149,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
 
@@ -176,14 +178,14 @@ module RCAP
       #
       # @return [String]
       def to_s
-        "#{ @event }(#{ @urgency }/#{ @severity }/#{ @certainty })"
+        "#{@event}(#{@urgency}/#{@severity}/#{@certainty})"
       end
 
       RESPONSE_TYPES_YAML = 'Response Types'
 
       # @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],
@@ -244,10 +246,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