nmea_plus 1.0.21 → 1.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db0e4959ebe3bd2d2f46175a6cbd052f5b99a5c1b7d461d7f635ef6a65452d7e
-  data.tar.gz: 7594efb6386c115204299607570ec261d0d74b4b19f1a692c055324299637e64
+  metadata.gz: b7c0c98fc5071f09522c714c193ed0f2ee652f81c4f2691451ddfd67f571b0d7
+  data.tar.gz: 2608a5591399530744687f78a58ddb885984d76d7dfbc7297533ebc432713b5b
 SHA512:
-  metadata.gz: b7878dc5548c2d9778ba96bbed2944969704ae8c8d0ba21facc21374618913c14c74d62718061e2dad5ed687edc1d7e948f15341f29f4e8495154e3a82997630
-  data.tar.gz: 60836811880f70a3060edabe8bab457a97c06846e8bf8f8ca14f7a9b681c4dd1f7bcfa130e52aa02dbae080e3cf0f03d5c8add6aa1396cb67bc147a357e69465
+  metadata.gz: 794ae47cd9e5a59cbc437dcef6694040e8979d71578d142ab3ed42416185d6efead51231416f7ad87b84221f90328ca3b2d38b66ee571419d9f0e9b863e5bb0c
+  data.tar.gz: 135a44b2005b71cb4834975af78afd0b06fadfd3c9911df8f188126837f6677bcb5f62241b246fc411bea12fe9191ccabb5d2b505ffe448a3b3d3c916a9cd733

data/README.md

@@ -2,7 +2,8 @@
 
 [![Gem Version](https://badge.fury.io/rb/nmea_plus.svg)](https://rubygems.org/gems/nmea_plus)
 [![Build Status](https://travis-ci.org/ianfixes/nmea_plus.svg)](https://travis-ci.org/ianfixes/nmea_plus)
-[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/nmea_plus/1.0.21)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/nmea_plus/1.0.22)
+[![Documentation completeness](http://inch-ci.org/github/ianfixes/nmea_plus.svg?branch=master)](http://inch-ci.org/github/ianfixes/nmea_plus)
 
 [NMEA Plus](https://github.com/ianfixes/nmea_plus) is a Ruby gem for parsing and decoding "GPS" messages: NMEA, AIS, and any other similar formats of short messaging typically used by marine equipment.  It provides convenient access (by name) to the fields of each message type, and a stream reader designed for use with Ruby Blocks.
 

data/lib/nmea_plus/message/ais/vdm_payload/mmsi_info.rb

@@ -12,6 +12,7 @@ module NMEAPlus
           # @return [Integer]
           attr_reader :id
 
+          # Seed the object with the MMSI.  The ID contains all info.
           # @param mmsi [Integer] The MMSI
           def initialize(mmsi)
             @id = mmsi

data/lib/nmea_plus/message/ais/vdm_payload/payload.rb

@@ -42,6 +42,8 @@ module NMEAPlus
           end
 
           # Return an object by its class name, or nil if it isn't defined
+          # @param class_identifier [String] The ruby class identifier
+          # @return [Object] An object of the given class
           def _object_by_name(class_identifier)
             Object::const_get(class_identifier).new
           rescue ::NameError

data/lib/nmea_plus/message/ais/vdm_payload/sub_area.rb

@@ -104,8 +104,25 @@ module NMEAPlus
 
           # Container for bearing / distance
           class ShapePoint
+            # @overload bearing
+            #   @return [Integer]
+            # @overload bearing=(Integer)
+            #   Sets bearing
+            #   @param [Integer] new value
             attr_accessor :bearing
+
+            # @overload distance
+            #   @return [Integer]
+            # @overload distance=(Integer)
+            #   Sets distance
+            #   @param [Integer] new value
             attr_accessor :distance
+
+            # @overload scale_factor
+            #   @return [Integer]
+            # @overload scale_factor=(Integer)
+            #   Sets scale factor
+            #   @param [Integer] new value
             attr_accessor :scale_factor
 
             # @!parse attr_reader :distance_meters

data/lib/nmea_plus/message/ais/vdm_payload/vdm_msg6d1022f61.rb

@@ -54,6 +54,7 @@ module NMEAPlus
           bit_reader :battery_flat?, 6
           bit_reader :battery_low?, 7
 
+          # Operation mode (integer code)
           # @!parse attr_reader :operation_mode
           # @return [Integer]
           def operation_mode

data/lib/nmea_plus/message/nmea/dcn.rb

@@ -57,6 +57,7 @@ module NMEAPlus
         # 3 = Lane identification transmissions
         field_reader :fix_data_basis, 16, :_integer
 
+        # Textual description of fix data basis
         # @!parse attr_reader :fix_data_basis_description
         # @return [String]
         def fix_data_basis_description

data/lib/nmea_plus/message/nmea/dtm.rb

@@ -8,12 +8,14 @@ module NMEAPlus
         field_reader :code, 1, :_string
         field_reader :subcode, 2, :_string
 
+        # Latitude offset in degrees
         # @!parse attr_reader :latitude_offset
         # @return [Float]
         def latitude_offset
           self.class.nsew_signed_float(@fields[3], @fields[4])
         end
 
+        # Longitude offset in degrees
         # @!parse attr_reader :longitude_offset
         # @return [Float]
         def longitude_offset

data/lib/nmea_plus/message/nmea/gga.rb

@@ -8,12 +8,14 @@ module NMEAPlus
       class GGA < NMEAPlus::Message::NMEA::NMEAMessage
         field_reader :fix_time, 1, :_utctime_hms
 
+        # Latitude in degrees
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
           self.class.degrees_minutes_to_decimal(@fields[2], @fields[3])
         end
 
+        # Longitude in degrees
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude

data/lib/nmea_plus/message/nmea/gll.rb

@@ -6,12 +6,14 @@ module NMEAPlus
       # GLL - Geographic Position - Latitude/Longitude
       class GLL < NMEAPlus::Message::NMEA::NMEAMessage
 
+        # Latitude in degrees
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
           self.class.degrees_minutes_to_decimal(@fields[1], @fields[2])
         end
 
+        # Longitude in degrees
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude

data/lib/nmea_plus/message/nmea/gns.rb

@@ -8,12 +8,14 @@ module NMEAPlus
       class GNS < NMEAPlus::Message::NMEA::NMEAMessage
         field_reader :fix_time, 1, :_utctime_hms
 
+        # Latitude in degrees
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
           self.class.degrees_minutes_to_decimal(@fields[2], @fields[3])
         end
 
+        # Longitude in degrees
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude

data/lib/nmea_plus/message/nmea/hdg.rb

@@ -6,12 +6,14 @@ module NMEAPlus
       # HDG - Heading - Deviation & Variation
       class HDG < NMEAPlus::Message::NMEA::HDM
 
+        # Magnetic deviation in degrees
         # @!parse attr_reader :magnetic_deviation_degrees
         # @return [Float]
         def magnetic_deviation_degrees
           self.class.nsew_signed_float(@fields[2], @fields[3])
         end
 
+        # Magnetic variation in degrees
         # @!parse attr_reader :magnetic_variation_degrees
         # @return [Float]
         def magnetic_variation_degrees

data/lib/nmea_plus/message/nmea/oln.rb

@@ -11,16 +11,17 @@ module NMEAPlus
         # container for Omega lane indicators
         class OmegaLanePair
           # @return [String]
-          attr_accessor :label
+          attr_reader :label
 
           # first item in the pair
           # @return [Float]
-          attr_accessor :first
+          attr_reader :first
 
           # second item in the pair
           # @return [Float]
-          attr_accessor :second
+          attr_reader :second
 
+          # Create an instance of this container class
           # @param arr [Array] a string and 2 integers
           def initialize(arr)
             @label  = arr[0]

data/lib/nmea_plus/message/nmea/rma.rb

@@ -8,12 +8,14 @@ module NMEAPlus
 
         field_reader :blink_warning, 1, :_av_boolean
 
+        # Latitude in degrees
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
           self.class.degrees_minutes_to_decimal(@fields[2], @fields[3])
         end
 
+        # Longitude in degrees
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude
@@ -25,6 +27,7 @@ module NMEAPlus
         field_reader :speed_over_ground_knots, 8, :_float
         field_reader :track_made_good_degrees_true, 9, :_float
 
+        # Magnetic variation in degrees
         # @!parse attr_reader :magnetic_variation_degrees
         # @return [Float]
         def magnetic_variation_degrees

data/lib/nmea_plus/message/nmea/rmb.rb

@@ -12,12 +12,14 @@ module NMEAPlus
         field_reader :waypoint_to, 4, :_integer
         field_reader :waypoint_from, 5, :_integer
 
+        # Waypoint latitude in degrees
         # @!parse attr_reader :waypoint_latitude
         # @return [Float]
         def waypoint_latitude
           self.class.degrees_minutes_to_decimal(@fields[6], @fields[7])
         end
 
+        # Waypoint longitude in degrees
         # @!parse attr_reader :waypoint_longitude
         # @return [Float]
         def waypoint_longitude

data/lib/nmea_plus/message/nmea/rmc.rb

@@ -6,6 +6,7 @@ module NMEAPlus
       # RMC - Recommended Minimum Navigation Information
       class RMC < NMEAPlus::Message::NMEA::NMEAMessage
 
+        # UTC time
         # @!parse attr_reader :utc_time
         # @return [Time]
         def utc_time
@@ -14,12 +15,14 @@ module NMEAPlus
 
         field_reader :active?, 2, :_av_boolean
 
+        # Latitude in degrees
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
           self.class.degrees_minutes_to_decimal(@fields[3], @fields[4])
         end
 
+        # Longitude in degrees
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude
@@ -29,6 +32,7 @@ module NMEAPlus
         field_reader :speed_over_ground_knots, 7, :_float
         field_reader :track_made_good_degrees_true, 8, :_float
 
+        # Magnetic variation in degrees
         # @!parse attr_reader :magnetic_variation_degrees
         # @return [Float]
         def magnetic_variation_degrees

data/lib/nmea_plus/message/nmea/rnn.rb

@@ -7,6 +7,7 @@ module NMEAPlus
       class RNN < NMEAPlus::Message::NMEA::NMEAMessage
         field_reader :route_number, 1, :_integer
 
+        # Waypoint numbers
         # @!parse attr_reader :waypoints
         # @return [Array<Integer>]
         def waypoints

data/lib/nmea_plus/message/nmea/slc.rb

@@ -10,25 +10,26 @@ module NMEAPlus
         class SLCStationReport
           # Used in lat/lon calculation
           # @return [Boolean]
-          attr_accessor :used_in_calculation
+          attr_reader :used_in_calculation
 
           # Status: Blink Warning Flag
           # @return [Boolean]
-          attr_accessor :blink_warning
+          attr_reader :blink_warning
 
           # Status: Cycle Lock Warning Flag
           # @return [Boolean]
-          attr_accessor :cycle_lock_warning
+          attr_reader :cycle_lock_warning
 
           # Status: SNR Warning Flag
           # @return [Boolean]
-          attr_accessor :snr_warning
+          attr_reader :snr_warning
 
           # SNR value, 000 to 999
           # @return [Integer]
-          attr_accessor :snr
+          attr_reader :snr
 
           # @param arr [Array<String, Integer>] a string and 2 integers
+          # @param is_master [Boolean] Whether this station is the master
           def initialize(arr, is_master)
             @arr = arr
             @used_in_calculation  = is_master ? true : NMEA::NMEAMessage._av_boolean(arr[0])

data/lib/nmea_plus/message/nmea/str.rb

@@ -15,6 +15,7 @@ module NMEAPlus
       # @see VTG
       class STR < NMEAPlus::Message::NMEA::NMEAMessage
 
+        # Tracking reference
         # @!parse attr_reader :tracking_reference
         # @return [Symbol]
         def tracking_reference

data/lib/nmea_plus/message/nmea/vtg.rb

@@ -13,6 +13,7 @@ module NMEAPlus
 
         field_reader :track_degrees_true, 1, :_float
 
+        # Track in degrees, magnetic
         # @!parse attr_reader :track_degrees_magnetic
         # @return [Float]
         def track_degrees_magnetic
@@ -21,6 +22,7 @@ module NMEAPlus
           @fields[f].to_f
         end
 
+        # Speed in knots
         # @!parse attr_reader :speed_knots
         # @return [Float]
         def speed_knots
@@ -29,6 +31,7 @@ module NMEAPlus
           @fields[f].to_f
         end
 
+        # Speed in km/h
         # @!parse attr_reader :speed_kmh
         # @return [Float]
         def speed_kmh
@@ -37,6 +40,7 @@ module NMEAPlus
           @fields[f].to_f
         end
 
+        # FAA Mode
         # @!parse attr_reader :faa_mode
         # @return [String]
         def faa_mode

data/lib/nmea_plus/message/nmea/wpl.rb

@@ -5,12 +5,14 @@ module NMEAPlus
     module NMEA
       # WPL - Waypoint Location
       class WPL < NMEAPlus::Message::NMEA::NMEAMessage
+        # Latitude in degrees
         # @!parse attr_reader :latitude
         # @return [Float]
         def latitude
           self.class.degrees_minutes_to_decimal(@fields[1], @fields[2])
         end
 
+        # Longitude in degrees
         # @!parse attr_reader :longitude
         # @return [Float]
         def longitude

data/lib/nmea_plus/message/nmea/zda.rb

@@ -6,6 +6,7 @@ module NMEAPlus
       # ZDA - Time & Date - UTC, day, month, year and local time zone
       class ZDA < NMEAPlus::Message::NMEA::NMEAMessage
 
+        # UTC Time
         # @!parse attr_reader :utc_time
         # @return [Time]
         def utc_time

data/lib/nmea_plus/version.rb

@@ -1,3 +1,3 @@
 module NMEAPlus
-  VERSION = '1.0.21'.freeze
+  VERSION = '1.0.22'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nmea_plus
 version: !ruby/object:Gem::Version
-  version: 1.0.21
+  version: 1.0.22
 platform: ruby
 authors:
 - Ian Katz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-22 00:00:00.000000000 Z
+date: 2018-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: racc
@@ -70,20 +70,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.50.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.50.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: 0.50.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -164,20 +164,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
 description: "A pure-ruby parser and decoder toolkit for NMEA messages (GPS, AIS,
   and other similar formats)\n                          that provides convenient access
   to all data fields.  All standard NMEA messages,\n                          nearly