rcap 1.3.1 → 2.0.0

data/lib/rcap/cap_1_0/area.rb

@@ -1,207 +1,32 @@
 module RCAP
   module CAP_1_0
+
     # An Area object is valid if
     # * it has an area description
     # * all Circle objects contained in circles are valid
     # * all Geocode objects contained in geocodes are valid
     # * all Polygon objects contained in polygons are valid
     # * altitude has a value if ceiling is set
-    class Area
-      include Validation
-
-      # @return [String] Textual description of area.
-      attr_accessor( :area_desc )
-      # @return [Numeric] Expressed in feet above sea level
-      attr_accessor( :altitude )
-      # @return [Numeric] Expressed in feet above sea level. 
-      attr_accessor( :ceiling )
-      # @return [Array<Circle>]
-      attr_reader( :circles )
-      # @return [Array<Geocode>]
-      attr_reader( :geocodes )
-      # @return [Array<Polygon>]
-      attr_reader( :polygons )
-
-      validates_presence_of( :area_desc )
-      validates_collection_of( :circles, :geocodes, :polygons, allow_empty: true )
-      validates_dependency_of( :ceiling, on: :altitude )
-
-      XML_ELEMENT_NAME       = 'area'     
-      AREA_DESC_ELEMENT_NAME = 'areaDesc' 
-      ALTITUDE_ELEMENT_NAME  = 'altitude' 
-      CEILING_ELEMENT_NAME   = 'ceiling'  
-
-      XPATH           = "cap:#{ XML_ELEMENT_NAME }"       
-      AREA_DESC_XPATH = "cap:#{ AREA_DESC_ELEMENT_NAME }" 
-      ALTITUDE_XPATH  = "cap:#{ ALTITUDE_ELEMENT_NAME }"  
-      CEILING_XPATH   = "cap:#{ CEILING_ELEMENT_NAME }"   
-
-      # @example
-      #   Area.new( area_desc: 'Cape Town CBD' )
-      # @param [Hash] attributes Area attributes
-      # @option attributes [String] :area_desc Area description
-      # @option attributes [Numeric] :altitude Altitude above sea level (in feet)
-      # @option attributes [Numeric] :ceiling Ceiling above sea level (in feet)
-      # @option attributes [Array<Circle>] :circles Collection of {Circle} 
-      # @option attributes [Array<Geocode>] :geocodes Collection of {Geocode} 
-      # @option attributes [Array<Polygon>] :polygons Collection of {Polygon}
-      def initialize( attributes = {})
-        @area_desc = attributes[ :area_desc ]
-        @altitude  = attributes[ :altitude ]
-        @ceiling   = attributes[ :ceiling ]
-        @circles   = Array( attributes[ :circles ])
-        @geocodes  = Array( attributes[ :geocodes ])
-        @polygons  = Array( attributes[ :polygons ])
-      end
-
-      # Creates a new {Polygon} object and adds it to the {#polygons} array.
-      #
-      # @see Polygon#initialize
-      # @param [Hash] polygon_attributes see {Polygon#initialize}
-      # @return [Polygon]
-      def add_polygon( polygon_attributes = {})
-        polygon = Polygon.new( polygon_attributes )
-        @polygons << polygon
-        polygon
-      end
-
-      # Creates a new {Circle} object and adds it to the {#circles} array.
-      #
-      # @see Circle#initialize
-      # @param [Hash] circle_attributes see {Circle#initialize}
-      # @return [Circle]
-      def add_circle( circle_attributes = {})
-        circle = Circle.new( circle_attributes )
-        @circles << circle
-        circle
-      end
-
-      # Creates a new {Geocode} object and adds it to the {#geocodes} array.
-      #
-      # @see Geocode#initialize
-      # @param [Hash] geocode_attributes see {Geocode#initialize}
-      # @return [Geocode]
-      def add_geocode( geocode_attributes = {})
-        geocode = Geocode.new( geocode_attributes )
-        @geocodes << geocode
-        geocode
-      end
-
-      # @return [REXML::Element]
-      def to_xml_element 
-        xml_element = REXML::Element.new( XML_ELEMENT_NAME )
-        xml_element.add_element( AREA_DESC_ELEMENT_NAME ).add_text( @area_desc.to_s )
-        add_to_xml_element = lambda do |element, object|
-          element.add_element( object.to_xml_element )
-          element
-        end
-        @polygons.inject( xml_element, &add_to_xml_element )
-        @circles.inject( xml_element, &add_to_xml_element )
-        @geocodes.inject( xml_element, &add_to_xml_element )
-        xml_element.add_element( ALTITUDE_ELEMENT_NAME ).add_text( @altitude.to_s ) unless @altitude.blank?
-        xml_element.add_element( CEILING_ELEMENT_NAME ).add_text( @ceiling.to_s )   unless @altitude.blank?
-        xml_element
-      end
-
-      # @return [String] XML representation of the Area
-      def to_xml 
-        self.to_xml_element.to_s
-      end
-
-      # Implements an equality operator for the Area object. Two Area objects are equal if all their attributes are equal.
-      #
-      # @param [Area] other Area object to compare
-      # @return [true,false]
-      def ==( other )
-        comparison_attributes = lambda{ |area| [ area.area_desc, area.altitude, area.ceiling, area.circles, area.geocodes, area.polygons ]}
-        comparison_attributes.call( self ) == comparison_attributes.call( other )
-      end
-
-      # @return [String]
-      def inspect 
-        area_inspect = "Area Description: #{ @area_desc }\n"+
-                       "Polygons:\n"+
-                       @polygons.map{ |polygon| "  " + polygon.inspect }.join("\n" )+"\n"+
-                       "Circles:          #{ @circles.inspect }\n"+
-                       "Geocodes:         #{ @geocodes.inspect }\n"
-        RCAP.format_lines_for_inspect( 'AREA', area_inspect )
-      end
+    class Area < RCAP::Base::Area
 
-      # Returns the area description
-      #
       # @return [String]
-      def to_s
-        @area_desc
-      end
-
-      # @param [REXML::Element] area_xml_element
-      # @return [Area]
-      def self.from_xml_element( area_xml_element ) 
-        self.new( :area_desc => RCAP.xpath_text( area_xml_element, AREA_DESC_XPATH, Alert::XMLNS ),
-                  :altitude  => (( alt = RCAP.xpath_text( area_xml_element, ALTITUDE_XPATH, Alert::XMLNS )) ? alt.to_f : nil ),
-                  :ceiling   => (( ceil = RCAP.xpath_text( area_xml_element, CEILING_XPATH, Alert::XMLNS )) ? ceil.to_f : nil ),
-                  :circles   => RCAP.xpath_match( area_xml_element, Circle::XPATH, Alert::XMLNS ).map{ |circle_element| Circle.from_xml_element( circle_element )},
-                  :geocodes  => RCAP.xpath_match( area_xml_element, Geocode::XPATH, Alert::XMLNS ).map{ |geocode_element| Geocode.from_xml_element( geocode_element )},
-                  :polygons  => RCAP.xpath_match( area_xml_element, Polygon::XPATH, Alert::XMLNS ).map{ |polygon_element| Polygon.from_xml_element( polygon_element )})
+      def xmlns
+        Alert::XMLNS
       end
 
-      AREA_DESC_YAML = 'Area Description' 
-      ALTITUDE_YAML  = 'Altitude'         
-      CEILING_YAML   = 'Ceiling'          
-      CIRCLES_YAML   = 'Circles'          
-      GEOCODES_YAML  = 'Geocodes'         
-      POLYGONS_YAML  = 'Polygons'         
-
-      # @return [String] YAML representation of object
-      def to_yaml( options = {} ) 
-        RCAP.attribute_values_to_hash(
-          [ AREA_DESC_YAML, @area_desc ],
-          [ ALTITUDE_YAML,  @altitude ],
-          [ CEILING_YAML,   @ceiling ],
-          [ CIRCLES_YAML,   @circles.map{ |circle| [ circle.lattitude, circle.longitude, circle.radius ]} ],
-          [ GEOCODES_YAML,  @geocodes.inject({}){|h,geocode| h.merge( geocode.name => geocode.value )}],
-          [ POLYGONS_YAML,  @polygons ]
-        ).to_yaml( options )
+      # @return [Class]
+      def polygon_class
+        Polygon
       end
 
-      # @param [Hash] area_yaml_data
-      # @return [Area]
-      def self.from_yaml_data( area_yaml_data )  
-        self.new( :area_desc => area_yaml_data[ AREA_DESC_YAML ],
-                  :altitude  => area_yaml_data[ ALTITUDE_YAML ],
-                  :ceiling   => area_yaml_data[ CEILING_YAML ],
-                  :circles   => Array( area_yaml_data[ CIRCLES_YAML ]).map{ |circle_yaml_data| Circle.from_yaml_data( circle_yaml_data )},
-                  :geocodes  => Array( area_yaml_data[ GEOCODES_YAML ]).map{ |name, value| Geocode.new( :name => name, :value => value )},
-                  :polygons  => Array( area_yaml_data[ POLYGONS_YAML ]).map{ |polyon_yaml_data| Polygon.from_yaml_data( polyon_yaml_data )})
-      end
-
-      AREA_DESC_KEY = 'area_desc'  
-      ALTITUDE_KEY  = 'altitude'   
-      CEILING_KEY   = 'ceiling'    
-      CIRCLES_KEY   = 'circles'    
-      GEOCODES_KEY  = 'geocodes'   
-      POLYGONS_KEY  = 'polygons'   
-
-      # @return [Hash]
-      def to_h 
-        RCAP.attribute_values_to_hash( [ AREA_DESC_KEY, @area_desc ],
-                                       [ ALTITUDE_KEY,  @altitude ],
-                                       [ CEILING_KEY,   @ceiling ],
-                                       [ CIRCLES_KEY,   @circles.map{  |circle|  circle.to_h }],
-                                       [ GEOCODES_KEY,  @geocodes.map{ |geocode| geocode.to_h }],
-                                       [ POLYGONS_KEY,  @polygons.map{ |polygon| polygon.to_h }])
+      # @return [Class]
+      def circle_class
+        Circle
       end
 
-      # @param [Hash] area_hash
-      # @return [Area]
-      def self.from_h( area_hash ) 
-        self.new(
-          :area_desc => area_hash[ AREA_DESC_KEY ],
-          :altitude  => area_hash[ ALTITUDE_KEY ],
-          :ceiling   => area_hash[ CEILING_KEY ],
-          :circles   => Array( area_hash[ CIRCLES_KEY ]).map{ |circle_hash| Circle.from_h( circle_hash )},
-          :geocodes  => Array( area_hash[ GEOCODES_KEY ]).map{ |geocode_hash| Geocode.from_h( geocode_hash )},
-          :polygons  => Array( area_hash[ POLYGONS_KEY ]).map{ |polygon_hash| Polygon.from_h( polygon_hash )})
+      # @return [Class]
+      def geocode_class
+        Geocode
       end
     end
   end

data/lib/rcap/cap_1_0/circle.rb

@@ -1,108 +1,10 @@
 module RCAP
   module CAP_1_0
+
     # A Circle object is valid if
     # * it has a valid lattitude and longitude
     # * it has a radius with a value greater than zero
-    class Circle < Point
-      include Validation
-
-      # @return [Numeric] Expresed in kilometers 
-      attr_accessor( :radius )
-
-      validates_presence_of( :radius )
-      validates_numericality_of( :radius , greater_than_or_equal: 0 )
-
-      XML_ELEMENT_NAME = 'circle' 
-
-      XPATH = 'cap:circle' 
-
-      # @param [Hash] attributes
-      # @option attributes [Numeric] :lattitude
-      # @option attributes [Numeric] :longitude
-      # @option attributes [Numeric] :radius
-      def initialize( attributes = {} )
-        super( attributes )
-        @radius = attributes[ :radius ]
-      end
-
-      # Returns a string representation of the circle of the form
-      #  lattitude,longitude radius
-      #
-      # @return [String]
-      def to_s  
-        "#{ @lattitude },#{ @longitude } #{ @radius }"
-      end
-
-      # @return [String]
-      def inspect 
-        "(#{ self.to_s })"
-      end
-
-      # @return [REXML::Element]
-      def to_xml_element 
-        xml_element = REXML::Element.new( XML_ELEMENT_NAME )
-        xml_element.add_text( self.to_s )
-        xml_element
-      end
-
-      # @return [String]
-      def to_xml 
-        self.to_xml_element.to_s
-      end
-
-      # Parses a circle string of the form
-      #   lattitude,longitude radius
-      #
-      # @param [String] circle_string
-      # @return [Array(Float,Float,Float)]
-      def self.parse_circle_string( circle_string ) 
-        coordinates, radius = circle_string.split( ' ' )
-        lattitude, longitude = coordinates.split( ',' )
-        [ lattitude, longitude, radius ].map{ |e| e.to_f }
-      end
-
-      # @param [REXML::Element] circle_xml_element
-      # @return [Circle]
-      def self.from_xml_element( circle_xml_element ) 
-        lattitude, longitude, radius = self.parse_circle_string( circle_xml_element.text )
-        circle = self.new( :lattitude => lattitude,
-                           :longitude => longitude,
-                           :radius    => radius )
-      end
-
-      # Two circles are equivalent if their lattitude, longitude and radius are equal.
-      #
-      # @param [Circle] other
-      # @return [true,false]
-      def ==( other )
-        [ @lattitude, @longitude, @radius ] == [ other.lattitude, other.longitude, other.radius ]
-      end
-
-      # @param [Array(Numeric, Numeric, Numeric)] circle_yaml_data lattitude, longitude, radius 
-      # @return [Circle]
-      def self.from_yaml_data( circle_yaml_data ) 
-        lattitude, longitude, radius = circle_yaml_data
-        self.new( :lattitude => lattitude, :longitude => longitude, :radius => radius )
-      end
-
-      RADIUS_KEY    = 'radius'    
-      LATTITUDE_KEY = 'lattitude' 
-      LONGITUDE_KEY = 'longitude' 
-
-      # @return [Hash]
-      def to_h 
-        RCAP.attribute_values_to_hash( [ RADIUS_KEY,    @radius ],
-                                       [ LATTITUDE_KEY, @lattitude ],
-                                       [ LONGITUDE_KEY, @longitude ])
-      end
-
-      # @param [Hash]
-      # @return [Circle]
-      def self.from_h( circle_hash ) 
-        self.new( :radius    => circle_hash[ RADIUS_KEY ],
-                  :lattitude => circle_hash[ LATTITUDE_KEY ],
-                  :longitude => circle_hash[ LONGITUDE_KEY ])
-      end
+    class Circle < RCAP::Base::Circle
     end
   end
 end

data/lib/rcap/cap_1_0/event_code.rb

@@ -1,9 +1,14 @@
 module RCAP
   module CAP_1_0
     # Subclass of {Parameter}
-    class EventCode < Parameter
-      XML_ELEMENT_NAME = 'eventCode' 
-      XPATH = "cap:#{ XML_ELEMENT_NAME }" 
+    class EventCode < RCAP::Base::EventCode
+      XML_ELEMENT_NAME = 'eventCode'
+      XPATH = "cap:#{ XML_ELEMENT_NAME }"
+
+      # @return [String]
+      def xmlns
+        Alert::XMLNS
+      end
     end
   end
 end

data/lib/rcap/cap_1_0/geocode.rb

@@ -1,9 +1,14 @@
 module RCAP
   module CAP_1_0
     # Subclass of {Parameter}
-    class Geocode < Parameter
-      XML_ELEMENT_NAME = 'geocode' 
-      XPATH = "cap:#{ XML_ELEMENT_NAME }" 
+    class Geocode < RCAP::Base::Geocode
+      XML_ELEMENT_NAME = 'geocode'
+      XPATH = "cap:#{ XML_ELEMENT_NAME }"
+
+      # @return [String]
+      def xmlns
+        Alert::XMLNS
+      end
     end
   end
 end