aixm 1.1.0 → 1.2.0

data/lib/aixm/xy.rb

@@ -29,8 +29,11 @@ module AIXM
   #
   # @see https://gitlab.com/openflightmaps/ofmx/wikis/Coordinates
   class XY
+    include AIXM::Concerns::HashEquality
+
     EARTH_RADIUS = 6_371_008.8
 
+    # See the {overview}[AIXM::XY] for examples.
     def initialize(lat:, long:)
       self.lat, self.long = lat, long
     end
@@ -45,14 +48,14 @@ module AIXM
       [lat(:ofmx), long(:ofmx)].join(' '.freeze)
     end
 
+    # Latitude
+    #
     # @!attribute lat
-    def lat=(value)
-      @lat = float_for value
-      fail(ArgumentError, "invalid lat") unless (-90..90).include? @lat
-    end
-
-    # @param schema [Symbol, nil] either nil, +:aixm+ or +:ofmx+
-    # @return [String, Float] latitude
+    # @overload lat
+    #   @param schema [Symbol, nil] either +:aixm+ or +:ofmx+ or +nil+
+    #   @return [String, Float]
+    # @overload lat=(value)
+    #   @param value [String, Numeric]
     def lat(schema=nil)
       case schema
         when :ofmx then ("%011.8f" % @lat.abs.round(8)) + (@lat.negative? ? 'S' : 'N')
@@ -61,14 +64,19 @@ module AIXM
       end
     end
 
-    # @!attribute long
-    def long=(value)
-      @long = float_for value
-      fail(ArgumentError, "invalid long") unless (-180..180).include? @long
+    def lat=(value)
+      @lat = float_for value
+      fail(ArgumentError, "invalid lat") unless (-90..90).include? @lat
     end
 
-    # @param schema [Symbol, nil] either nil, +:aixm+ or +:ofmx+
-    # @return [Float, String] longitude
+    # Longitude
+    #
+    # @!attribute long
+    # @overload long
+    #   @param schema [Symbol, nil] either +:aixm+ or +:ofmx+ or +nil+
+    #   @return [String, Float]
+    # @overload long=(value)
+    #   @param value [String, Numeric]
     def long(schema=nil)
       case schema
         when :ofmx then ("%012.8f" % @long.abs.round(8)) + (@long.negative? ? 'W' : 'E')
@@ -77,18 +85,29 @@ module AIXM
       end
     end
 
-    # @return [Boolean] +false+ if both longitude and latitude have zero DMS
-    #   seconds which may indicate rounded or estimated coordinates
+    def long=(value)
+      @long = float_for value
+      fail(ArgumentError, "invalid long") unless (-180..180).include? @long
+    end
+
+    # Whether both longitude and latitude have zero DMS seconds (which may
+    # indicate rounded or estimated coordinates).
+    #
+    # @return [Boolean]
     def seconds?
       !(long.to_dms[-6,5].to_f.zero? && lat.to_dms[-6,5].to_f.zero?)
     end
 
-    # @return [AIXM::Component::Geometry::Point] convert to point
+    # Convert to point
+    #
+    # @return [AIXM::Component::Geometry::Point]
     def to_point
       AIXM.point(xy: self)
     end
 
-    # @return [AIXM::D] distance as calculated by use of the Haversine formula
+    # Distance as calculated by the Haversine formula
+    #
+    # @return [AIXM::D]
     def distance(other)
       if self == other
         AIXM.d(0, :m)
@@ -105,17 +124,9 @@ module AIXM
     end
 
     # @see Object#==
-    # @return [Boolean]
     def ==(other)
       self.class === other && lat == other.lat && long == other.long
     end
-    alias_method :eql?, :==
-
-    # @see Object#hash
-    # @return [Integer]
-    def hash
-      to_s.hash
-    end
 
     private
 

data/lib/aixm/z.rb

@@ -13,20 +13,36 @@ module AIXM
   # * +AIXM::GROUND+ - surface expressed as "0 ft QFE"
   # * +AIXM::UNLIMITED+ - no upper limit expressed as "FL 999"
   class Z
+    include AIXM::Concerns::HashEquality
     extend Forwardable
 
     CODES = %i(qfe qnh qne).freeze
 
+    # Whether height, elevation or altitude is zero.
+
     # @!method zero?
-    #   @return [Boolean] whether height, elevation or altitude is zero
+    # @return [Boolean]
     def_delegator :@alt, :zero?
 
-    # @return [Integer] altitude or elevation value
+    # Altitude or elevation value.
+    #
+    # @overload alt
+    #   @return [Integer]
+    # @overload alt=(value)
+    #   @param value [Integer]
     attr_reader :alt
 
-    # @return [Symbol] Q code - either +:qfe+ (height in feet), +:qnh+ (altitude in feet or +:qne+ (altitude as flight level)
+    # Q code
+    #
+    # @overload code
+    #   @return [Symbol] either +:qfe+ (height in feet), +:qnh+ (altitude in
+    #     feet or +:qne+ (altitude as flight level)
+    # @overload code=(value)
+    #   @param value [Symbol] either +:qfe+ (height in feet), +:qnh+ (altitude
+    #     in feet or +:qne+ (altitude as flight level)
     attr_reader :code
 
+    # See the {overview}[AIXM::Z] for examples.
     def initialize(alt, code)
       self.alt, self.code = alt, code
     end
@@ -52,43 +68,39 @@ module AIXM
       fail(ArgumentError, "invalid code") unless CODES.include? @code
     end
 
-    # @!method qfe?
-    # @!method qnh?
-    # @!method qne?
+    # Whether QFE, QNH or QNE.
     #
     # @example
     #   z = AIXM.z(123, :qnh)
     #   z.qnh?   # => true
     #   z.qfe?   # => false
     #
+    # @!method qfe?
+    # @!method qnh?
+    # @!method qne?
     # @return [Boolean]
     CODES.each do |code|
       define_method(:"#{code}?") { @code == code }
     end
 
-    # @return [Boolean] whether ground level or not
+    # Whether ground level
+    #
+    # @return [Boolean]
     def ground?
       qfe? && @alt == 0
     end
 
-    # @return [Symbol] unit - either +:fl+ (flight level) or +:ft+ (feet)
+    # Unit
+    #
+    # @return [Symbol] either +:fl+ (flight level) or +:ft+ (feet)
     def unit
       qne? ? :fl : :ft
     end
 
     # @see Object#==
-    # @return [Boolean]
     def ==(other)
       self.class === other && alt == other.alt && code == other.code
     end
-    alias_method :eql?, :==
-
-    # @see Object#hash
-    # @return [Integer]
-    def hash
-      to_s.hash
-    end
 
   end
-
 end

data/lib/aixm.rb

@@ -1,5 +1,6 @@
 require 'bigdecimal'
 require 'ostruct'
+require 'date'
 require 'time'
 require 'pathname'
 require 'securerandom'
@@ -10,6 +11,7 @@ require 'optparse'
 require 'builder'
 require 'nokogiri'
 require 'dry/inflector'
+require 'sun'
 
 require_relative 'aixm/object'
 
@@ -24,6 +26,12 @@ require_relative 'aixm/memoize'
 require_relative 'aixm/association'
 require_relative 'aixm/payload_hash'
 
+require_relative 'aixm/concerns/hash_equality'
+require_relative 'aixm/concerns/timetable'
+require_relative 'aixm/concerns/intensity'
+require_relative 'aixm/concerns/marking'
+require_relative 'aixm/concerns/remarks'
+
 require_relative 'aixm/document'
 require_relative 'aixm/xy'
 require_relative 'aixm/z'
@@ -34,6 +42,10 @@ require_relative 'aixm/a'
 require_relative 'aixm/w'
 require_relative 'aixm/p'
 
+require_relative 'aixm/schedule/date'
+require_relative 'aixm/schedule/day'
+require_relative 'aixm/schedule/time'
+
 require_relative 'aixm/component'
 require_relative 'aixm/component/address'
 require_relative 'aixm/component/service'
@@ -47,6 +59,7 @@ require_relative 'aixm/component/geometry/border'
 require_relative 'aixm/component/layer'
 require_relative 'aixm/component/vertical_limit'
 require_relative 'aixm/component/timetable'
+require_relative 'aixm/component/timesheet'
 require_relative 'aixm/component/runway'
 require_relative 'aixm/component/fato'
 require_relative 'aixm/component/helipad'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aixm
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Sven Schwyn
@@ -30,7 +30,7 @@ cert_chain:
   1+2Y1+i+4jd1B7qxIgOLxQTNIJiwE0sqU1itFfuesfgUACS7M0IV9u9Bp4hBGNEw
   5JcY2h7owdMxXIvgk1oakgldFJc=
   -----END CERTIFICATE-----
-date: 2022-03-05 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -75,21 +75,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: sun
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -103,7 +103,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -117,7 +117,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-sound
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -131,7 +131,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-matchers
+  name: minitest-sound
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -241,9 +241,15 @@ files:
 - lib/aixm/component/runway.rb
 - lib/aixm/component/service.rb
 - lib/aixm/component/surface.rb
+- lib/aixm/component/timesheet.rb
 - lib/aixm/component/timetable.rb
 - lib/aixm/component/vasis.rb
 - lib/aixm/component/vertical_limit.rb
+- lib/aixm/concerns/hash_equality.rb
+- lib/aixm/concerns/intensity.rb
+- lib/aixm/concerns/marking.rb
+- lib/aixm/concerns/remarks.rb
+- lib/aixm/concerns/timetable.rb
 - lib/aixm/config.rb
 - lib/aixm/constants.rb
 - lib/aixm/d.rb
@@ -271,6 +277,9 @@ files:
 - lib/aixm/payload_hash.rb
 - lib/aixm/r.rb
 - lib/aixm/refinements.rb
+- lib/aixm/schedule/date.rb
+- lib/aixm/schedule/day.rb
+- lib/aixm/schedule/time.rb
 - lib/aixm/shortcuts.rb
 - lib/aixm/version.rb
 - lib/aixm/w.rb
@@ -315,7 +324,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
+rubygems_version: 3.3.12
 signing_key:
 specification_version: 4
 summary: Builder for AIXM/OFMX aeronautical information