aixm 0.3.5 → 0.3.6

data/lib/aixm/feature/airspace.rb

@@ -8,7 +8,7 @@ module AIXM
     # ===Cheat Sheet in Pseudo Code:
     #   airspace = AIXM.airspace(
     #     source: String or nil
-    #     id: String
+    #     id: String or nil   # nil is converted to an 8 character digest
     #     type: String or Symbol
     #     local_type: String or nil
     #     name: String or nil
@@ -16,6 +16,10 @@ module AIXM
     #   airspace.geometry << AIXM.point or AIXM.arc or AIXM.border or AIXM.circle
     #   airspace.layers << AIXM.layer
     #
+    # The +id+ is mandatory, however, you may omit it when initializing a new
+    # airspace or assign +nil+ to an existing airspace which will generate a 8
+    # character digest from +type+, +local_type+ and +name+.
+    #
     # Some regions define additional airspace types. In LF (France) for
     # intance, the types RMZ (radio mandatory zone) and TMZ (transponder
     # mandatory zone) exist. Such airspaces are usually specified together
@@ -105,6 +109,8 @@ module AIXM
         %Q(#<#{self.class} type=#{type.inspect} name=#{name.inspect}>)
       end
 
+      # The +id+ is mandatory, however, you may assign +nil+ which will generate
+      # an 8 character digest from +type+, +local_type+ and +name+.
       def id=(value)
         fail(ArgumentError, "invalid id") unless value.nil? || value.is_a?(String)
         @id = value&.uptrans || [type, local_type, name].to_digest.upcase

data/lib/aixm/feature/unit.rb

@@ -100,7 +100,7 @@ module AIXM
 
       # @return [String]
       def inspect
-        %Q(#<#{self.class} name=#{name.inspect} type=#{type.inspect}>)
+        %Q(#<#{original_class} name=#{name.inspect} type=#{type.inspect}>)
       end
 
       def organisation=(value)
@@ -118,7 +118,9 @@ module AIXM
       end
 
       # @!attribute class
+      # @note Use +original_class+ to query the Ruby object class.
       # @return [Symbol] class of unit (see {CLASSES})
+      alias_method :original_class, :class
       def class
         @klass
       end

data/lib/aixm/p.rb

@@ -0,0 +1,88 @@
+using AIXM::Refinements
+
+module AIXM
+
+  # pressure
+  #
+  # @example
+  #   AIXM.d(14, :bar)
+  class P
+    include Comparable
+    extend Forwardable
+
+    UNITS = {
+      p: { mpa: 0.000001, psi: 0.000145037738, bar: 0.00001, torr: 0.0075006 },
+      mpa: { p: 1_000_000, psi: 145.037738, bar: 10, torr: 7500.6 },
+      psi: { p: 6894.75729, mpa: 0.00689475729, bar: 0.0689475729, torr: 51.714816529374 },
+      bar: { p: 100000, mpa: 0.1, psi: 14.5037738, torr: 750.06 },
+      torr: { p: 133.322, mpa: 0.000133322, psi: 0.019336721305636, bar: 0.00133322 }
+    }.freeze
+
+    # @!method zero?
+    #   @return [Boolean] whether pressure is zero
+    def_delegator :@pres, :zero?
+
+    # @return [Float] pressure
+    attr_reader :pres
+
+    # @return [Symbol] unit (see {UNITS})
+    attr_reader :unit
+
+    def initialize(pres, unit)
+      self.pres, self.unit = pres, unit
+    end
+
+    # @return [String]
+    def inspect
+      %Q(#<#{self.class} #{to_s}>)
+    end
+
+    # @return [String] human readable representation (e.g. "14 bar")
+    def to_s
+      [pres, unit].join(' ')
+    end
+
+    def pres=(value)
+      fail(ArgumentError, "invalid pres") unless value.is_a?(Numeric) && value >= 0
+      @pres = value.to_f
+    end
+
+    def unit=(value)
+      fail(ArgumentError, "invalid unit") unless value.respond_to? :to_sym
+      @unit = value.to_sym.downcase
+      fail(ArgumentError, "invalid unit") unless UNITS.has_key? @unit
+    end
+
+    # @!method to_p
+    # @!method to_mpa
+    # @!method to_psi
+    # @!method to_bar
+    # @!method to_torr
+    # @return [AIXM::P] convert pressure
+    UNITS.each_key do |target_unit|
+      define_method "to_#{target_unit}" do
+        return self if unit == target_unit
+        self.class.new((pres * UNITS[unit][target_unit]).round(8), target_unit)
+      end
+    end
+
+    # @see Object#<=>
+    # @return [Integer]
+    def <=>(other)
+      pres <=> other.send(:"to_#{unit}").pres
+    end
+
+    # @see Object#==
+    # @return [Boolean]
+    def ==(other)
+      self.class === other  && (self <=> other).zero?
+    end
+    alias_method :eql?, :==
+
+    # @see Object#hash
+    # @return [Integer]
+    def hash
+      to_s.hash
+    end
+  end
+end

data/lib/aixm/refinements.rb

@@ -15,21 +15,6 @@ module AIXM
       "Ø" => "Oe"
     }.freeze
 
-    # @!method then_if
-    #   Same as +Object#then+ but only applied if the condition is true.
-    #
-    #   @example
-    #     "foobar".then_if(false) { |s| s.gsub(/o/, 'i') }   # => "foobar"
-    #     "foobar".then_if(true) { |s| s.gsub(/o/, 'i') }    # => "fiibar"
-    #
-    #   @note This is a refinement for +Object+
-    #   @return [Object]
-    refine Object do
-      def then_if(condition, &block)
-        condition ? self.then(&block) : self
-      end
-    end
-
     # @!method to_digest
     #   Builds a 4 byte hex digest from the Array payload.
     #
@@ -149,6 +134,21 @@ module AIXM
       end
     end
 
+    # @!method then_if
+    #   Same as +Object#then+ but only applied if the condition is true.
+    #
+    #   @example
+    #     "foobar".then_if(false) { |s| s.gsub(/o/, 'i') }   # => "foobar"
+    #     "foobar".then_if(true) { |s| s.gsub(/o/, 'i') }    # => "fiibar"
+    #
+    #   @note This is a refinement for +Object+
+    #   @return [Object]
+    refine Object do
+      def then_if(condition, &block)
+        condition ? self.then(&block) : self
+      end
+    end
+
     # @!method decapture
     #   Replace all groups with non-caputuring groups
     #

data/lib/aixm/shortcuts.rb

@@ -8,6 +8,8 @@ module AIXM
     d: D,
     f: F,
     a: A,
+    w: W,
+    p: P,
     address: Feature::Address,
     organisation: Feature::Organisation,
     unit: Feature::Unit,
@@ -15,8 +17,10 @@ module AIXM
     frequency: Component::Frequency,
     airport: Feature::Airport,
     runway: Component::Runway,
+    fato: Component::FATO,
     helipad: Component::Helipad,
     surface: Component::Surface,
+    lighting: Component::Lighting,
     airspace: Feature::Airspace,
     layer: Component::Layer,
     geometry: Component::Geometry,

data/lib/aixm/version.rb

@@ -1,3 +1,3 @@
 module AIXM
-  VERSION = "0.3.5".freeze
+  VERSION = "0.3.6".freeze
 end

data/lib/aixm/w.rb

@@ -0,0 +1,86 @@
+using AIXM::Refinements
+
+module AIXM
+
+  # Weight
+  #
+  # @example
+  #   AIXM.w(2.9, :t)
+  class W
+    include Comparable
+    extend Forwardable
+
+    UNITS = {
+      kg: { t: 0.001, lb: 2.204622622, ton: 0.00110231131 },
+      t: { kg: 1000, lb: 2204.622622, ton: 1.10231131 },
+      lb: { kg: 0.45359237, t: 0.00045359237, ton: 0.000499999999581 },
+      ton: { kg: 907.18474, t: 0.90718474, lb: 2000.00000013718828 }
+    }.freeze
+
+    # @!method zero?
+    #   @return [Boolean] whether weight is zero
+    def_delegator :@wgt, :zero?
+
+    # @return [Float] weight
+    attr_reader :wgt
+
+    # @return [Symbol] unit (see {UNITS})
+    attr_reader :unit
+
+    def initialize(wgt, unit)
+      self.wgt, self.unit = wgt, unit
+    end
+
+    # @return [String]
+    def inspect
+      %Q(#<#{self.class} #{to_s}>)
+    end
+
+    # @return [String] human readable representation (e.g. "123 t")
+    def to_s
+      [wgt, unit].join(' ')
+    end
+
+    def wgt=(value)
+      fail(ArgumentError, "invalid wgt") unless value.is_a?(Numeric) && value >= 0
+      @wgt = value.to_f
+    end
+
+    def unit=(value)
+      fail(ArgumentError, "invalid unit") unless value.respond_to? :to_sym
+      @unit = value.to_sym.downcase
+      fail(ArgumentError, "invalid unit") unless UNITS.has_key? @unit
+    end
+
+    # @!method to_kg
+    # @!method to_t
+    # @!method to_lb
+    # @!method to_ton
+    # @return [AIXM::W] convert weight
+    UNITS.each_key do |target_unit|
+      define_method "to_#{target_unit}" do
+        return self if unit == target_unit
+        self.class.new((wgt * UNITS[unit][target_unit]).round(8), target_unit)
+      end
+    end
+
+    # @see Object#<=>
+    # @return [Integer]
+    def <=>(other)
+      wgt <=> other.send(:"to_#{unit}").wgt
+    end
+
+    # @see Object#==
+    # @return [Boolean]
+    def ==(other)
+      self.class === other  && (self <=> other).zero?
+    end
+    alias_method :eql?, :==
+
+    # @see Object#hash
+    # @return [Integer]
+    def hash
+      to_s.hash
+    end
+  end
+end

data/lib/aixm/xy.rb

@@ -69,6 +69,12 @@ module AIXM
       end
     end
 
+    # @return [Boolean] +false+ if both longitude and latitude have zero DMS
+    #   seconds which may indicate rounded or estimated coordinates
+    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
     def to_point
       AIXM.point(xy: self)

data/{Rakefile → rakefile.rb}

@@ -9,4 +9,14 @@ Rake::TestTask.new do |t|
   t.warning = true
 end
 
+desc "Run local YARD documentation server"
+task :yard do
+  `rm -rf ./.yardoc`
+  Thread.new do
+    sleep 2
+    `open http://localhost:8808`
+  end
+  `yard server -r`
+end  
+
 task default: :test

data/spec/factory.rb

@@ -24,6 +24,14 @@ module AIXM
         AIXM.a('34L')
       end
 
+      def w
+        AIXM.w(1.5, :t)
+      end
+
+      def p
+        AIXM.p(0.5, :mpa)
+      end
+
       # Components
 
       def address
@@ -36,11 +44,22 @@ module AIXM
         end
       end
 
+      def lighting
+        AIXM.lighting(
+          position: :aiming_point
+        ).tap do |lighting|
+          lighting.description = "omnidirectional"
+          lighting.intensity = :medium
+          lighting.color = :green
+          lighting.remarks = "lighting remarks"
+        end
+      end
+
       def timetable
         AIXM.timetable(
           code: :sunrise_to_sunset
         ).tap do |timetable|
-          timetable.remarks =  "timetable remarks"
+          timetable.remarks = "timetable remarks"
         end
       end
 
@@ -317,9 +336,12 @@ module AIXM
           airport.z = AIXM.z(146, :qnh)
           airport.declination = 1.08
           airport.transition_z = AIXM.z(10_000, :qnh)
+          airport.operator = "Municipality of Pujaut"
           airport.remarks = "Restricted access"
           airport.add_runway(runway)
+          airport.add_fato(fato)
           airport.add_helipad(helipad)
+          airport.helipads.first.fato = airport.fatos.first   # necessary when using factories only
           airport.add_usage_limitation :permitted
           airport.add_usage_limitation(:reservation_required) do |reservation_required|
             reservation_required.add_condition { |c| c.aircraft = :glider }
@@ -339,6 +361,9 @@ module AIXM
           runway.surface.preparation = :paved
           runway.surface.condition = :good
           runway.surface.pcn = "59/F/A/W/T"
+          runway.surface.siwl_weight = AIXM.w(1500, :kg)
+          runway.surface.siwl_tire_pressure = AIXM.p(0.5, :mpa)
+          runway.surface.auw_weight = AIXM.w(30, :t)
           runway.surface.remarks = "Paved shoulder on 2.5m on each side of the RWY."
           runway.status = :closed
           runway.remarks = "Markings eroded"
@@ -348,18 +373,46 @@ module AIXM
           runway.forth.geographic_orientation = AIXM.a(165)
           runway.forth.vfr_pattern = :left_or_right
           runway.forth.remarks = "forth remarks"
+          runway.forth.add_lighting(lighting)
           runway.back.xy = AIXM.xy(lat: %q(43°59'25.31"N), long: %q(004°45'23.24"E))
           runway.back.z = AIXM.z(147, :qnh)
           runway.back.displaced_threshold = AIXM.xy(lat: %q(43°59'31.84"N), long: %q(004°45'20.85"E))
           runway.back.geographic_orientation = AIXM.a(345)
           runway.back.vfr_pattern = :left
           runway.back.remarks = "back remarks"
+          runway.back.add_lighting(lighting)
+        end
+      end
+
+      def fato
+        AIXM.fato(name: 'H1').tap do |fato|
+          fato.length = AIXM.d(35, :m)
+          fato.width = AIXM.d(35, :m)
+          fato.surface.composition = :concrete
+          fato.surface.preparation = :paved
+          fato.surface.condition = :fair
+          fato.surface.pcn = "30/F/A/W/U"
+          fato.surface.siwl_weight = AIXM.w(1500, :kg)
+          fato.surface.siwl_tire_pressure = AIXM.p(0.5, :mpa)
+          fato.surface.auw_weight = AIXM.w(8, :t)
+          fato.surface.remarks = "Cracks near the center"
+          fato.profile = "Northwest from RWY 12/30"
+          fato.marking = "Dashed white lines"
+          fato.status = :other
+          fato.remarks = "Authorizaton by AD operator required"
+          fato.add_direction(name: '35') do |direction|
+            direction.geographic_orientation = AIXM.a(355)
+            direction.remarks = "Avoid flight over residental area"
+            direction.add_lighting(lighting)
+          end
         end
       end
 
       def helipad
-        AIXM.helipad(name: 'H1').tap do |helipad|
-          helipad.xy = AIXM.xy(lat: %q(43°59'56.94"N), long: %q(004°45'05.56"E))
+        AIXM.helipad(
+          name: 'H1',
+          xy: AIXM.xy(lat: %q(43°59'56.94"N), long: %q(004°45'05.56"E))
+        ).tap do |helipad|
           helipad.z = AIXM.z(141, :qnh)
           helipad.length = AIXM.d(20, :m)
           helipad.width = AIXM.d(20, :m)
@@ -367,9 +420,15 @@ module AIXM
           helipad.surface.preparation = :paved
           helipad.surface.condition = :fair
           helipad.surface.pcn = "30/F/A/W/U"
-          helipad.surface.remarks = "Cracks near the center."
+          helipad.surface.siwl_weight = AIXM.w(1500, :kg)
+          helipad.surface.siwl_tire_pressure = AIXM.p(0.5, :mpa)
+          helipad.surface.auw_weight = AIXM.w(8, :t)
+          helipad.surface.remarks = "Cracks near the center"
+          helipad.marking = "Continuous white lines"
+          helipad.helicopter_class = 1
           helipad.status = :other
           helipad.remarks = "Authorizaton by AD operator required"
+          helipad.add_lighting(lighting)
         end
       end
 
@@ -470,11 +529,10 @@ module AIXM
       # Document
 
       def document
-        time = Time.parse('2018-01-01 12:00:00 +0100')
         AIXM.document(
           region: 'LF',
           namespace: '00000000-0000-0000-0000-000000000000',
-          created_at: time,
+          created_at: (time = Time.parse('2018-01-01 12:00:00 +0100')),
           effective_at: time
         ).tap do |document|
           document.features << organisation