rcap 2.4.1 → 2.7.3

data/lib/rcap/cap_1_2/alert.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
-
     # An Alert object is valid if
     # * it has an identifier
     # * it has a sender
@@ -10,13 +11,12 @@ module RCAP
     # * it has a valid scope value
     # * all Info objects contained in infos are valid
     class Alert < RCAP::Base::Alert
+      XMLNS = 'urn:oasis:names:tc:emergency:cap:1.2'
+      CAP_VERSION = '1.2'
 
-      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,6 +1,7 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
-
     # An Area object is valid if
     # * it has an area description
     # * all Circle objects contained in circles are valid
@@ -8,7 +9,6 @@ module RCAP
     # * all Polygon objects contained in polygons are valid
     # * altitude has a value if ceiling is set
     class Area < RCAP::Base::Area
-
       # @return [String]
       def xmlns
         Alert::XMLNS

data/lib/rcap/cap_1_2/circle.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
-
     # A Circle object is valid if
     # * it has a valid lattitude and longitude
     # * it has a radius with a value greater than zero

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,6 +1,7 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
-
     # In Info object is valid if
     # * it has an event
     # * it has an urgency with a valid value
@@ -10,31 +11,31 @@ 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"
+      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_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(', ')}")
 
       # @return [Array<String>] Collection of textual response types; elements must be from {VALID_RESPONSE_TYPES}
-      attr_reader( :response_types )
+      attr_reader(:response_types)
 
       # Initialises a new Info object which will be yielded to an attached block if given
       #
@@ -72,76 +73,72 @@ module RCAP
 
       # @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 = REXML::Element.new(XML_ELEMENT_NAME)
+        xml_element.add_element(LANGUAGE_ELEMENT_NAME).add_text(@language) 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)
         end
-        xml_element.add_element( EVENT_ELEMENT_NAME ).add_text( @event )
+        xml_element.add_element(EVENT_ELEMENT_NAME).add_text(@event)
         @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)
         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)
+        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
         @event_codes.each do |event_code|
-          xml_element.add_element( event_code.to_xml_element )
+          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(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
         @parameters.each do |parameter|
-          xml_element.add_element( parameter.to_xml_element )
+          xml_element.add_element(parameter.to_xml_element)
         end
         @resources.each do |resource|
-          xml_element.add_element( resource.to_xml_element )
+          xml_element.add_element(resource.to_xml_element)
         end
         @areas.each do |area|
-          xml_element.add_element( area.to_xml_element )
+          xml_element.add_element(area.to_xml_element)
         end
         xml_element
       end
 
       # @return [String]
       def to_xml
-        self.to_xml_element.to_s
+        to_xml_element.to_s
       end
 
       # @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"
-        RCAP.format_lines_for_inspect( 'INFO', info_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"
+        RCAP.format_lines_for_inspect('INFO', info_inspect)
       end
 
       # Returns a string representation of the event of the form
@@ -149,15 +146,15 @@ module RCAP
       #
       # @return [String]
       def to_s
-        "#{ @event }(#{ @urgency }/#{ @severity }/#{ @certainty })"
+        "#{@event}(#{@urgency}/#{@severity}/#{@certainty})"
       end
 
       # @param [REXML::Element] info_xml_element
       # @return [Info]
-      def self.from_xml_element( info_xml_element )
+      def self.from_xml_element(info_xml_element)
         super.tap do |info|
-          RCAP.xpath_match( info_xml_element, RESPONSE_TYPE_XPATH, Alert::XMLNS ).each do |element|
-            info.response_types << RCAP.strip_if_given( element.text )
+          RCAP.xpath_match(info_xml_element, RESPONSE_TYPE_XPATH, Alert::XMLNS).each do |element|
+            info.response_types << RCAP.strip_if_given(element.text)
           end
         end
       end
@@ -166,42 +163,42 @@ module RCAP
 
       # @return [Hash]
       def to_yaml_data
-        parameter_to_hash = lambda{ |hash, parameter| hash.merge( parameter.name => parameter.value )}
-
-        RCAP.attribute_values_to_hash( [ LANGUAGE_YAML,       @language ],
-                                       [ CATEGORIES_YAML,     @categories ],
-                                       [ EVENT_YAML,          @event ],
-                                       [ RESPONSE_TYPES_YAML, @response_types ],
-                                       [ URGENCY_YAML,        @urgency ],
-                                       [ SEVERITY_YAML,       @severity ],
-                                       [ CERTAINTY_YAML,      @certainty ],
-                                       [ AUDIENCE_YAML,       @audience ],
-                                       [ EFFECTIVE_YAML,      RCAP.to_s_for_cap( @effective )],
-                                       [ ONSET_YAML,          RCAP.to_s_for_cap( @onset )],
-                                       [ EXPIRES_YAML,        RCAP.to_s_for_cap( @expires )],
-                                       [ SENDER_NAME_YAML,    @sender_name ],
-                                       [ HEADLINE_YAML,       @headline ],
-                                       [ DESCRIPTION_YAML,    @description ],
-                                       [ INSTRUCTION_YAML,    @instruction ],
-                                       [ WEB_YAML,            @web ],
-                                       [ CONTACT_YAML,        @contact ],
-                                       [ EVENT_CODES_YAML,    @event_codes.inject({}, &parameter_to_hash )],
-                                       [ PARAMETERS_YAML,     @parameters.inject({}, &parameter_to_hash )],
-                                       [ RESOURCES_YAML,      @resources.map( &:to_yaml_data )],
-                                       [ AREAS_YAML,          @areas.map( &:to_yaml_data )])
+        parameter_to_hash = ->(hash, parameter) { hash.merge(parameter.name => parameter.value) }
+
+        RCAP.attribute_values_to_hash([LANGUAGE_YAML,       @language],
+                                      [CATEGORIES_YAML,     @categories],
+                                      [EVENT_YAML,          @event],
+                                      [RESPONSE_TYPES_YAML, @response_types],
+                                      [URGENCY_YAML,        @urgency],
+                                      [SEVERITY_YAML,       @severity],
+                                      [CERTAINTY_YAML,      @certainty],
+                                      [AUDIENCE_YAML,       @audience],
+                                      [EFFECTIVE_YAML,      RCAP.to_s_for_cap(@effective)],
+                                      [ONSET_YAML,          RCAP.to_s_for_cap(@onset)],
+                                      [EXPIRES_YAML,        RCAP.to_s_for_cap(@expires)],
+                                      [SENDER_NAME_YAML,    @sender_name],
+                                      [HEADLINE_YAML,       @headline],
+                                      [DESCRIPTION_YAML,    @description],
+                                      [INSTRUCTION_YAML,    @instruction],
+                                      [WEB_YAML,            @web],
+                                      [CONTACT_YAML,        @contact],
+                                      [EVENT_CODES_YAML,    @event_codes.inject({}, &parameter_to_hash)],
+                                      [PARAMETERS_YAML,     @parameters.inject({}, &parameter_to_hash)],
+                                      [RESOURCES_YAML,      @resources.map(&:to_yaml_data)],
+                                      [AREAS_YAML,          @areas.map(&:to_yaml_data)])
       end
 
       # @return [String]
-      def to_yaml( options = {} )
-        self.to_yaml_data.to_yaml( options )
+      def to_yaml(options = {})
+        to_yaml_data.to_yaml(options)
       end
 
       # @param [Hash] info_yaml_data
       # @return [Info]
-      def self.from_yaml_data( info_yaml_data )
+      def self.from_yaml_data(info_yaml_data)
         super.tap do |info|
-          Array( info_yaml_data [ RESPONSE_TYPES_YAML ]).each do |response_type|
-            info.response_types << RCAP.strip_if_given( response_type )
+          Array(info_yaml_data [RESPONSE_TYPES_YAML]).each do |response_type|
+            info.response_types << RCAP.strip_if_given(response_type)
           end
         end
       end
@@ -210,35 +207,35 @@ module RCAP
 
       # @return [Hash]
       def to_h
-        RCAP.attribute_values_to_hash( [ LANGUAGE_KEY,       @language ],
-                                       [ CATEGORIES_KEY,     @categories ],
-                                       [ EVENT_KEY,          @event ],
-                                       [ RESPONSE_TYPES_KEY, @response_types ],
-                                       [ URGENCY_KEY,        @urgency ],
-                                       [ SEVERITY_KEY,       @severity ],
-                                       [ CERTAINTY_KEY,      @certainty ],
-                                       [ AUDIENCE_KEY,       @audience ],
-                                       [ EFFECTIVE_KEY,      RCAP.to_s_for_cap( @effective )],
-                                       [ ONSET_KEY,          RCAP.to_s_for_cap( @onset )],
-                                       [ EXPIRES_KEY,        RCAP.to_s_for_cap( @expires )],
-                                       [ SENDER_NAME_KEY,    @sender_name ],
-                                       [ HEADLINE_KEY,       @headline ],
-                                       [ DESCRIPTION_KEY,    @description ],
-                                       [ 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 }])
+        RCAP.attribute_values_to_hash([LANGUAGE_KEY,       @language],
+                                      [CATEGORIES_KEY,     @categories],
+                                      [EVENT_KEY,          @event],
+                                      [RESPONSE_TYPES_KEY, @response_types],
+                                      [URGENCY_KEY,        @urgency],
+                                      [SEVERITY_KEY,       @severity],
+                                      [CERTAINTY_KEY,      @certainty],
+                                      [AUDIENCE_KEY,       @audience],
+                                      [EFFECTIVE_KEY,      RCAP.to_s_for_cap(@effective)],
+                                      [ONSET_KEY,          RCAP.to_s_for_cap(@onset)],
+                                      [EXPIRES_KEY,        RCAP.to_s_for_cap(@expires)],
+                                      [SENDER_NAME_KEY,    @sender_name],
+                                      [HEADLINE_KEY,       @headline],
+                                      [DESCRIPTION_KEY,    @description],
+                                      [INSTRUCTION_KEY,    @instruction],
+                                      [WEB_KEY,            @web],
+                                      [CONTACT_KEY,        @contact],
+                                      [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
       # @return [Info]
-      def self.from_h( info_hash )
+      def self.from_h(info_hash)
         super.tap do |info|
-          Array( info_hash[ RESPONSE_TYPES_KEY ]).each do |response_type|
-            info.response_types << RCAP.strip_if_given( response_type )
+          Array(info_hash[RESPONSE_TYPES_KEY]).each do |response_type|
+            info.response_types << RCAP.strip_if_given(response_type)
           end
         end
       end

data/lib/rcap/cap_1_2/parameter.rb

@@ -1,11 +1,10 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
-
     # A Parameter object is valid if
     # * it has a name
-    # * it has a value
     class Parameter < RCAP::Base::Parameter
-
       # @return [String]
       def xmlns
         Alert::XMLNS

data/lib/rcap/cap_1_2/point.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
-
     # A Point object is valid if
     # * it has a lattitude within the minimum and maximum lattitude values
     # * it has a longitude within the minimum and maximum longitude values

data/lib/rcap/cap_1_2/polygon.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 module RCAP
   module CAP_1_2
-
     # 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
-
-      validates_length_of( :points, :minimum => 4 )
+      validates_length_of(:points, minimum: 4, allow_blank: true)
 
       # @return [Class]
       def point_class