aixm 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33661b6ab9022c54a9d41dad531b0f1c53f39eaf053a6c4b8361c50543b9ae01
-  data.tar.gz: add22919257222a6f06dae9de21f0f71c2b941a67e6bc52dba14bde5fbae6c9a
+  metadata.gz: a1dc4f9cb88ab4e481f835ca4d309142c6a17910b396f4293a6d9e7d3f946ec6
+  data.tar.gz: 244adc808983bc3e810fb5847051a89dbd0893df3d2c709943d2c7231acfb434
 SHA512:
-  metadata.gz: c1fb317e1791098f127c769e5f680bbf0c30ab823c73c48f392d6ea918f1ba4c6396d4e5cb43357ef1c867bad73e475d25be95b274bad7fd9ee17ce297dbbb6f
-  data.tar.gz: 904a2fa5c84b80bf14a67536fa2c0f2ab26b6d34dc3dc789e272116812994f86b9c3aff92b08d1cda9b3d3495abfe990eb922f0579fd779a1602963ba28ded59
+  metadata.gz: ac00f735cca36dc6b1b0ec00c671dcbcbdb1e14c0d051fc8d865737e9ac1363d5648f5df69098b0daf721688c541a79188cac3603a07e01f8719fde3c8070d91
+  data.tar.gz: 59d6ffb78fcb04104838bc4fb0ba50e7f3c5d526e921410e4300d08dafa08a2aa9cd1d637d374d7e5428d05c56e5f66186377a2f32fb6bff6c14ce5539044884

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## Main
+
+Nothing so far
+
+## 1.2.0
+
+#### Additions
+* `Timesheet` to add custom schedules to `Timetable`
+* `AIXM::Schedule::(Date|Day|Time)` for custom timetables
+* Interface to allow most class instances as Hash keys
+
+#### Fixes
+* Fix typo in `GUESSED_UNIT_TYPES_MAP`
+
 ## 1.1.0
 
 #### Breaking Changes

data/README.md

@@ -11,7 +11,7 @@ For now, only the parts needed to automize the AIP import of [open flightmaps](h
 
 * [Homepage](https://github.com/svoop/aixm)
 * [API](https://www.rubydoc.info/gems/aixm)
-* Author: [Sven Schwyn - Bitcetera](http://www.bitcetera.com)
+* Author: [Sven Schwyn - Bitcetera](https://bitcetera.com)
 
 ## Install
 
@@ -182,6 +182,7 @@ AIXM.config.ignored_errors = /invalid date/i
 * [Service](https://www.rubydoc.info/gems/aixm/AIXM/Component/Service.html)
 * [Surface](https://www.rubydoc.info/gems/aixm/AIXM/Component/Surface.html)
 * [Timetable](https://www.rubydoc.info/gems/aixm/AIXM/Component/Timetable.html)
+* [Timesheet](https://www.rubydoc.info/gems/aixm/AIXM/Component/Timesheet.html)
 * [VASIS](https://www.rubydoc.info/gems/aixm/AIXM/Component/VASIS.html)
 * [Vertical limit](https://www.rubydoc.info/gems/aixm/AIXM/Component/VerticalLimit.html)
 
@@ -274,6 +275,7 @@ ckmid --help
 ### AIXM
 * [AIXM](http://aixm.aero)
 * [AICM 4.5 documentation](https://openflightmaps.gitlab.io/ofmx/aixm/4.5/manual/aicm/)
+* [AICM 4.5 manual](https://www.aixm.aero/sites/aixm.aero/files/imce/library/aicm_manual_4-5.pdf)
 * [AIXM 4.5 specification](http://aixm.aero/document/aixm-45-specification)
 
 ### OFMX

data/lib/aixm/a.rb

@@ -24,6 +24,8 @@ module AIXM
   #   a.invert             # => #<AIXM::A -137.8° "22R">
   #   a.to_s(:runway)      # => "22R"
   class A
+    include AIXM::Concerns::HashEquality
+
     SUFFIX_INVERSIONS = {
       R: :L,
       L: :R
@@ -31,12 +33,23 @@ module AIXM
 
     RUNWAY_RE = /\A(0[1-9]|[12]\d|3[0-6])([A-Z])?\z/
 
-    # @return [Integer] angle in the range of -360 < angle < 360
+    # Angle in the range of -360 < angle < 360.
+    #
+    # @overload deg
+    #   @return [Integer]
+    # @overload deg=(value)
+    #   @param value [Integer]
     attr_reader :deg
 
-    # @return [Symbol, nil] one-letter suffix
+    # One-letter suffix.
+    #
+    # @overload suffix
+    #   @return [Symbol, nil]
+    # @overload suffix=(value)
+    #   @param value [Symbol, nil]
     attr_reader :suffix
 
+    # See the {overview}[AIXM::A] for examples.
     def initialize(value)
       case value
       when String
@@ -54,12 +67,16 @@ module AIXM
       %Q(#<#{self.class} #{to_s} #{to_s(:runway).inspect}>)
     end
 
-    # @return [Integer] within 0..359
+    # Degrees in the range of 0..359
+    #
+    # @return [Integer]
     def to_i
       (deg.round + 360) % 360
     end
 
-    # @return [Float] within 0.0..359.9~
+    # Degrees in the range of 0.0...360.0
+    #
+    # @return [Float]
     def to_f
       ((deg + 360) % 360).to_f
     end
@@ -96,20 +113,20 @@ module AIXM
       @suffix = value&.to_s&.to_sym
     end
 
-    # Invert an angle by 180 degrees
+    # Invert an angle by 180 degrees.
     #
     # @example
     #   AIXM.a(120).invert     # (300°)
     #   AIXM.a("34L").invert   # (160° suffix "R")
     #
-    # @return [AIXM::A] inverted angle
+    # @return [AIXM::A]
     def invert
       self.class.new(deg.negative? ? deg - 180 : deg + 180).tap do |angle|
         angle.suffix = SUFFIX_INVERSIONS.fetch(suffix, suffix)
       end
     end
 
-    # Check whether +other+ angle is the inverse
+    # Whether other angle is the inverse.
     #
     # @example
     #   AIXM.a(120).inverse_of? AIXM.a(300)       # => true
@@ -117,19 +134,19 @@ module AIXM
     #   AIXM.a("33X").inverse_of? AIXM.a("33X")   # => true
     #   AIXM.a("16R").inverse_of? AIXM.a("16L")   # => false
     #
-    # @return [Boolean] whether the inverted angle or not
+    # @return [Boolean]
     def inverse_of?(other)
       invert == other
     end
 
-    # Negate degrees
+    # Negate degrees.
     #
     # @return [AIXM::A]
     def -@
       deg.zero? ? self : self.class.new(-deg).tap { _1.suffix = suffix }
     end
 
-    # Add degrees
+    # Add degrees.
     #
     # @param value [Numeric, AIXM::A]
     # @return [AIXM::A]
@@ -144,7 +161,7 @@ module AIXM
       end
     end
 
-    # Subtract degrees
+    # Subtract degrees.
     #
     # @param value [Numeric, AIXM::A]
     # @return [AIXM::A]
@@ -153,16 +170,13 @@ module AIXM
     end
 
     # @see Object#==
-    # @return [Boolean]
     def ==(other)
       self.class === other  && deg == other.deg && suffix == other.suffix
     end
-    alias_method :eql?, :==
 
     # @see Object#hash
-    # @return [Integer]
     def hash
-      [deg, suffix].join.hash
+      [self.class, deg, suffix].join.hash
     end
   end
 

data/lib/aixm/association.rb

@@ -179,7 +179,7 @@ module AIXM
         (@has_many_attributes ||= []) << attribute
         # features
         define_method(attribute) do
-          instance_eval("@#{attribute} ||= AIXM::Association::Array.new")
+          instance_variable_get(:"@#{attribute}") || AIXM::Association::Array.new
         end
         # add_feature
         define_method(:"add_#{association}") do |object=nil, **options, &add_block|
@@ -190,6 +190,7 @@ module AIXM
           end
           instance_exec(object, **options, &association_block) if association_block
           fail(ArgumentError, "#{object.__class__} not allowed") unless class_names.any? { |c| object.is_a?(c.to_class) }
+          instance_eval("@#{attribute} ||= AIXM::Association::Array.new")
           send(attribute).send(:push, object)
           object.instance_variable_set(:"@#{inversion}", self)
           self

data/lib/aixm/classes.rb

@@ -11,6 +11,9 @@ module AIXM
     a: 'AIXM::A',
     w: 'AIXM::W',
     p: 'AIXM::P',
+    date: 'AIXM::Schedule::Date',
+    day: 'AIXM::Schedule::Day',
+    time: 'AIXM::Schedule::Time',
     address: 'AIXM::Component::Address',
     approach_lighting: 'AIXM::Component::ApproachLighting',
     organisation: 'AIXM::Feature::Organisation',
@@ -41,6 +44,7 @@ module AIXM
     obstacle: 'AIXM::Feature::Obstacle',
     obstacle_group: 'AIXM::Feature::ObstacleGroup',
     timetable: 'AIXM::Component::Timetable',
+    timesheet: 'AIXM::Component::Timesheet',
     vasis: 'AIXM::Component::VASIS'
   }.freeze
 

data/lib/aixm/component/address.rb

@@ -16,6 +16,7 @@ module AIXM
     class Address < Component
       include AIXM::Association
       include AIXM::Memoize
+      include AIXM::Concerns::Remarks
 
       public_class_method :new
 
@@ -39,15 +40,24 @@ module AIXM
       #   @return [AIXM::Feature] addressable feature
       belongs_to :addressable
 
-      # @return [Symbol] type of address (see {TYPES})
+      # Type of address
+      #
+      # @overload type
+      #   @return [Symbol] any of {TYPES}
+      # @overload type=(value)
+      #   @param value [Symbol] any of {TYPES}
       attr_reader :type
 
-      # @return [String] postal address, phone number, radio frequency etc
+      # Postal address, phone number, radio frequency etc
+      #
+      # @overload address
+      #   @return [String]
+      # @overload address=(value)
+      #   @param value [String]
       attr_reader :address
 
-      # @return [String, nil] free text remarks
-      attr_reader :remarks
-
+      # See the {cheat sheet}[AIXM::Component::Address] for examples on how to
+      # create instances of this class.
       def initialize(type:, address:)
         self.type, self.address = type, address
       end
@@ -72,10 +82,6 @@ module AIXM
         end
       end
 
-      def remarks=(value)
-        @remarks = value&.to_s
-      end
-
       # @return [String] UID markup
       def to_uid(as:, sequence:)
         builder = Builder::XmlMarkup.new(indent: 2)

data/lib/aixm/component/approach_lighting.rb

@@ -19,6 +19,8 @@ module AIXM
     class ApproachLighting < Component
       include AIXM::Association
       include AIXM::Memoize
+      include AIXM::Concerns::Intensity
+      include AIXM::Concerns::Remarks
 
       TYPES = {
         A: :cat_1,
@@ -41,35 +43,44 @@ module AIXM
         OTHER: :other   # specify in remarks
       }.freeze
 
-      INTENSITIES = {
-        LIL: :low,
-        LIM: :medium,
-        LIH: :high,
-        OTHER: :other   # specify in remarks
-      }.freeze
-
       # @!method approach_lightable
       #   @return [AIXM::Component::Runway::Direction, AIXM::Component::FATO::Direction] approach lighted entity
       belongs_to :approach_lightable
 
-      # @return [Symbol, nil] type of the approach lighting system (see {TYPES})
+      # Type of the approach lighting system
+      #
+      # @overload type
+      #   @return [Symbol] any of {TYPES}
+      # @overload type=(value)
+      #   @param value [Symbol] any of {TYPES}
       attr_reader :type
 
-      # @return [AIXM::D, nil] length
+      # Length
+      #
+      # @overload length
+      #   @return [AIXM::D, nil]
+      # @overload length=(value)
+      #   @param value [AIXM::D, nil]
       attr_reader :length
 
-      # @return [Symbol, nil] intensity of lights (see {INTENSITIES})
-      attr_reader :intensity
-
-      # @return [Boolean, nil] whether sequenced flash is available
+      # Whether sequenced flash is available
+      #
+      # @overload sequenced_flash
+      #   @return [Boolean, nil] +nil+ means unknown
+      # @overload sequenced_flash=(value)
+      #   @param value [Boolean, nil] +nil+ means unknown
       attr_reader :sequenced_flash
 
-      # @return [String, nil] description of the flash sequence
+      # Description of the flash sequence
+      #
+      # @overload flash_description
+      #   @return [String, nil]
+      # @overload flash_description=(value)
+      #   @param value [String, nil]
       attr_reader :flash_description
 
-      # @return [String, nil] free text remarks
-      attr_reader :remarks
-
+      # See the {cheat sheet}[AIXM::Component::ApproachLighting] for examples on
+      # how to create instances of this class.
       def initialize(type:)
         self.type = type
       end
@@ -88,10 +99,6 @@ module AIXM
         @length = value
       end
 
-      def intensity=(value)
-        @intensity = value.nil? ? nil : INTENSITIES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid intensity")
-      end
-
       def sequenced_flash=(value)
         fail(ArgumentError, "invalid sequenced flash") unless [true, false, nil].include? value
         @sequenced_flash = value
@@ -101,10 +108,6 @@ module AIXM
         @flash_description = value&.to_s
       end
 
-      def remarks=(value)
-        @remarks = value&.to_s
-      end
-
       # @return [String] UID markup
       def to_uid(as:)
         builder = Builder::XmlMarkup.new(indent: 2)

data/lib/aixm/component/fato.rb

@@ -30,6 +30,8 @@ module AIXM
     class FATO < Component
       include AIXM::Association
       include AIXM::Memoize
+      include AIXM::Concerns::Marking
+      include AIXM::Concerns::Remarks
 
       STATUSES = {
         CLSD: :closed,
@@ -63,24 +65,41 @@ module AIXM
       #   @return [AIXM::Component::Helipad] helipad situated on this FATO
       belongs_to :helipad
 
-      # @return [String] full name (e.g. "H1")
+      # Full name (e.g. "H1")
+      #
+      # @overload name
+      #   @return [String]
+      # @overload name=(value)
+      #   @param value [String]
       attr_reader :name
 
-      # @return [AIXM::R, nil] dimensions
+      # Dimensions
+      #
+      # @overload dimensions
+      #   @return [AIXM::R, nil]
+      # @overload dimensions=(value)
+      #   @param value [AIXM::R, nil]
       attr_reader :dimensions
 
-      # @return [String, nil] markings
-      attr_reader :marking
-
-      # @return [String, nil] profile description
+      # Profile description
+      #
+      # @overload profile
+      #   @return [String, nil]
+      # @overload profile=(value)
+      #   @param value [String, nil]
       attr_reader :profile
 
-      # @return [Symbol, nil] status of the FATO (see {STATUSES}) or +nil+ for normal operation
+      # Status of the FATO
+      #
+      # @overload status
+      #   @return [Symbol, nil] any of {STATUSES} or +nil+ for normal operation
+      # @overload status=(value)
+      #   @param value [Symbol, nil] any of {STATUSES} or +nil+ for normal
+      #     operation
       attr_reader :status
 
-      # @return [String, nil] free text remarks
-      attr_reader :remarks
-
+      # See the {cheat sheet}[AIXM::Component::FATO] for examples on how to
+      # create instances of this class.
       def initialize(name:)
         self.name = name
         self.surface = AIXM.surface
@@ -101,10 +120,6 @@ module AIXM
         @dimensions = value
       end
 
-      def marking=(value)
-        @marking = value&.to_s
-      end
-
       def profile=(value)
         @profile = value&.to_s
       end
@@ -113,10 +128,6 @@ module AIXM
         @status = value.nil? ? nil : (STATUSES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid status"))
       end
 
-      def remarks=(value)
-        @remarks = value&.to_s
-      end
-
       # @return [String] UID markup
       def to_uid
         builder = Builder::XmlMarkup.new(indent: 2)
@@ -157,6 +168,7 @@ module AIXM
       class Direction
         include AIXM::Association
         include AIXM::Memoize
+        include AIXM::Concerns::Remarks
 
         # @!method lightings
         #   @return [Array<AIXM::Component::Lighting>] installed lighting systems
@@ -177,7 +189,12 @@ module AIXM
         #   @return [AIXM::Component::FATO] FATO the FATO direction is further describing
         belongs_to :fato
 
-        # @return [AIXM::A] name of the FATO direction (e.g. "12" or "16L")
+        # Name of the FATO direction (e.g. "12" or "16L")
+        #
+        # @overload name
+        #   @return [AIXM::A]
+        # @overload name=(value)
+        #   @param value [AIXM::A]
         attr_reader :name
 
         # @return [AIXM::A, nil] (true) geographic bearing in degrees
@@ -187,9 +204,8 @@ module AIXM
         #   system
         attr_reader :vasis
 
-        # @return [String, nil] free text remarks
-        attr_reader :remarks
-
+        # See the {cheat sheet}[AIXM::Component::FATO] for examples on how to
+        #   create instances of this class.
         def initialize(name:)
           self.name = name
           self.vasis = AIXM.vasis
@@ -211,10 +227,6 @@ module AIXM
           @geographic_bearing = value
         end
 
-        def remarks=(value)
-          @remarks = value&.to_s
-        end
-
         # @return [AIXM::A] magnetic bearing in degrees
         def magnetic_bearing
           if geographic_bearing && fato.airport.declination

data/lib/aixm/component/frequency.rb

@@ -24,6 +24,8 @@ module AIXM
     class Frequency < Component
       include AIXM::Association
       include AIXM::Memoize
+      include AIXM::Concerns::Timetable
+      include AIXM::Concerns::Remarks
 
       TYPES = {
         STD: :standard,
@@ -39,29 +41,48 @@ module AIXM
       #   @return [AIXM::Component::Service] service the frequency belongs to
       belongs_to :service
 
-      # @return [AIXM::F] frequency for transmission (outgoing)
+      # Frequency for transmission (outgoing)
+      #
+      # @overload transmission_f
+      #   @return [AIXM::F]
+      # @overload transmission_f=(value)
+      #   @param value [AIXM::F]
       attr_reader :transmission_f
 
+
+      # Map from languages (ISO 639-1) to callsigns
+      #
       # @example
       #   { en: "STRASBOURG CONTROL", fr: "STRASBOURG CONTROLE" }
       #
-      # @return [Hash] map from languages (ISO 639-1) to callsigns
+      # @overload callsigns
+      #   @return [Hash]
+      # @overload callsigns=(value)
+      #   @param value [Hash]
       attr_reader :callsigns
 
+
+      # Frequency for reception (incoming)
+      #
       # @note One-way services such as ATIS should set this to +nil+ and simplex
-      #  (aka: non-duplex) communication should set this to {#transmission_f}.
-      # @return [AIXM::F, nil] frequency for reception (incoming)
+      #   (aka: non-duplex) communication should set this to {#transmission_f}.
+      #
+      # @overload reception_f
+      #   @return [AIXM::F, nil]
+      # @overload reception_f=(value)
+      #   @param value [AIXM::F, nil]
       attr_reader :reception_f
 
-      # @return [Symbol, nil] type of frequency (see {TYPES})
+      # Type of frequency
+      #
+      # @overload type
+      #   @return [Symbol, nil] any of {TYPES}
+      # @overload type=(value)
+      #   @param value [Symbol, nil] any of {TYPES}
       attr_reader :type
 
-      # @return [AIXM::Component::Timetable, nil] operating hours
-      attr_reader :timetable
-
-      # @return [String, nil] free text remarks
-      attr_reader :remarks
-
+      # See the {cheat sheet}[AIXM::Component::Frequency] for examples on how to
+      # create instances of this class.
       def initialize(transmission_f:, callsigns:)
         self.transmission_f, self.callsigns = transmission_f, callsigns
         self.reception_f = transmission_f
@@ -91,15 +112,6 @@ module AIXM
         @type = value.nil? ? nil : TYPES.lookup(value.to_s.to_sym, nil) || fail(ArgumentError, "invalid type")
       end
 
-      def timetable=(value)
-        fail(ArgumentError, "invalid timetable") unless value.nil? || value.is_a?(AIXM::Component::Timetable)
-        @timetable = value
-      end
-
-      def remarks=(value)
-        @remarks = value&.to_s
-      end
-
       # @return [String] UID markup
       def to_uid
         builder = Builder::XmlMarkup.new(indent: 2)

data/lib/aixm/component/geometry/arc.rb

@@ -16,9 +16,17 @@ module AIXM
       #
       # @see https://gitlab.com/openflightmaps/ofmx/wikis/Airspace#arc
       class Arc < Point
-        # @return [AIXM::XY] center point
+
+        # Center point
+        #
+        # @overload center_xy
+        #   @return [AIXM::XY]
+        # @overload center_xy=(value)
+        #   @param value [AIXM::XY]
         attr_reader :center_xy
 
+        # See the {cheat sheet}[AIXM::Component::Geometry::Arc] for examples on
+        # how to create instances of this class.
         def initialize(xy:, center_xy:, clockwise:)
           super(xy: xy)
           self.center_xy, self.clockwise = center_xy, clockwise
@@ -34,8 +42,13 @@ module AIXM
           @center_xy = value
         end
 
-        # @!attribute [w] clockwise
-        # @return [Boolean] wheter the arc is going clockwise (true) or not (false)
+        # Whether the arc is going clockwise
+        #
+        # @!attribute clockwise
+        # @overload clockwise?
+        #   @return [Boolean] clockwise (true) or counterclockwise (false)
+        # @overload clockwise=(value)
+        #   @param value [Boolean] clockwise (true) or counterclockwise (false)
         def clockwise?
           @clockwise
         end

data/lib/aixm/component/geometry/border.rb

@@ -17,9 +17,16 @@ module AIXM
       class Border < Point
         include AIXM::Memoize
 
-        # @return [String] name of the border
+        # Name of the border
+        #
+        # @overload name
+        #   @return [String]
+        # @overload name=(value)
+        #   @param value [String]
         attr_reader :name
 
+        # See the {cheat sheet}[AIXM::Component::Geometry::Border] for examples
+        # on how to create instances of this class.
         def initialize(xy:, name:)
           super(xy: xy)
           self.name = name

data/lib/aixm/component/geometry/circle.rb

@@ -20,12 +20,24 @@ module AIXM
         #   @return [AIXM::Component::Geometry] geometry this segment belongs to
         belongs_to :geometry, as: :segment
 
-        # @return [AIXM::XY] center point
+        # Center point
+        #
+        # @overload center_xy
+        #   @return [AIXM::XY]
+        # @overload center_xy=(value)
+        #   @param value [AIXM::XY]
         attr_reader :center_xy
 
-        # @return [AIXM::D] circle radius
+        # Circle radius
+        #
+        # @overload radius
+        #   @return [AIXM::D]
+        # @overload radius=(value)
+        #   @param value [AIXM::D]
         attr_reader :radius
 
+        # See the {cheat sheet}[AIXM::Component::Geometry::Circle] for examples
+        # on how to create instances of this class.
         def initialize(center_xy:, radius:)
           self.center_xy, self.radius = center_xy, radius
         end

data/lib/aixm/component/geometry/point.rb

@@ -20,9 +20,16 @@ module AIXM
         #   @return [AIXM::Component::Geometry] geometry this segment belongs to
         belongs_to :geometry, as: :segment
 
-        # @return [AIXM::XY] (starting) point
+        # (Starting) point
+        #
+        # @overload xy
+        #   @return [AIXM::XY]
+        # @overload xy=(value)
+        #   @param value [AIXM::XY]
         attr_reader :xy
 
+        # See the {cheat sheet}[AIXM::Component::Geometry::Point] for examples
+        # on how to create instances of this class.
         def initialize(xy:)
           self.xy = xy
         end