nmea_plus 1.0.2 → 1.0.3

data/lib/nmea_plus/message_factory.rb

@@ -0,0 +1,92 @@
+
+module NMEAPlus
+
+  # The base class for MessageFactory objects, which are instantiated in the Parser.  MessageFactory objects
+  # create message classes with a common prefix and variable suffix.  In an NMEA example,
+  # the prefix might be GP and the suffixes might be AAM or GLL (making GPAAM and GPGLL).
+  #
+  # If you are creating more subclasses of MessageFactory, you are probably a developer adding more NMEA-style
+  # message factories to the parser, and you are working with the repo (not the gem).
+  # @abstract MessageFactory is meant to be extended by actual implementations of message parsing classes
+  class MessageFactory
+
+    # For dynamic loading purposes.  Don't mess this up!
+    # @abstract
+    # @return [String] The name of the parent module
+    def self.parent_module
+      "FIXME_parent_module"
+    end
+
+    # Sometimes we want to override the data_type specified in the message (e.g. __AAM) with an
+    # alternate type (like GPAAM) or a generic type (like AAM).  This is where we put that logic.
+    # @abstract
+    # @param data_type [String] The data_type of the NMEA message (e.g. the GPGLL of "$GPGLL,12,3,,4,5*00")
+    # @return [String] The data_type that we will attempt to use in decoding the message
+    def self.alternate_data_type(data_type)
+      data_type # in basic implementation, there is no alternative.
+    end
+
+    # Check whether a given object exists.  this will work for all consts but shhhhhhhhh
+    # @param class_identifier [String] The name of a ruby class
+    # @return [bool]
+    def self.message_class_exists?(class_identifier)
+      Object::const_get(class_identifier)
+      return true
+    rescue ::NameError
+      return false
+    end
+
+    # Shortcut for the full name to a message class built from this factory.
+    # @param data_type [String]
+    # @return [String] The fully qualified message class name
+    def self.message_class_name(data_type)
+      "NMEAPlus::Message::#{self.parent_module}::#{data_type}"
+    end
+
+    # Try to load a class for the data_type specified in the message.  If it doesn't exist,
+    # then try an alternate.  If that doesn't work, fail.
+    # @param data_type [String] The data type for a given message
+    # @return [String] The fully qualified message class name
+    def self.best_match_for_data_type(data_type)
+      return data_type if self.message_class_exists?(self.message_class_name(data_type))
+      self.alternate_data_type(data_type)
+    end
+
+    # Get a message class through reflection
+    # @param class_identifier [String] the fully-qualified name of the class to instantiate
+    # @return [Object] The object for that class string
+    def self.dynamically_get_message_object(class_identifier)
+      Object::const_get(class_identifier).new
+    rescue ::NameError => e
+      raise ::NameError, "Couldn't instantiate a #{class_identifier} object: #{e}"
+    end
+
+    # Choose what message class to create, and create it based on the first of the (unsplitted) fields -- which
+    # is the data_type
+    # @param message_prefix [String] The single-character prefix for this message type (e.g. "$", "!")
+    # @param fields [String] The entire payload of the message
+    # @param checksum [String] The two-character checksum of the message
+    # @return [NMEAPlus::Message] A message object
+    def self.create(message_prefix, fields, checksum)
+      # get the data type and adjust it if necessary (e.g. support for NMEA standard sentences like __AAM)
+      data_type = fields.split(',', 2)[0].upcase  # assumed to be 'GPGGA', etc
+      interpreted_type = self.best_match_for_data_type(data_type)
+      class_name = self.message_class_name(interpreted_type)
+
+      # create message and make sure it's the right type
+      message = self.dynamically_get_message_object(class_name)
+      unless message.is_a? NMEAPlus::Message::Base
+        fail ArgumentError, "Undefined message type #{data_type} (classname #{class_name})"
+      end
+
+      # assign its data and return it
+      message.checksum = checksum
+      message.payload = fields
+      message.prefix = message_prefix
+      message.interpreted_data_type = interpreted_type
+      message
+    end
+
+  end
+
+end

data/{gem/lib → lib}/nmea_plus/nmea_message_factory.rb

@@ -95,12 +95,17 @@ end
 
 module NMEAPlus
 
+  # Defines a factory for NMEA messages, which will all use {NMEAPlus::Message::NMEA::NMEAMessage} as their base
   class NMEAMessageFactory < MessageFactory
 
+    # @return [String] The name of the parent module: NMEA
     def self.parent_module
       'NMEA'
     end
 
+    # Match all NMEA messages as their generic counterparts.  GPGLL becomes GLL, etc.
+    # @param data_type [String] The data_type of the NMEA message (e.g. the GPGLL of "$GPGLL,12,3,,4,5*00")
+    # @return [String] The data_type that we will attempt to use in decoding the message (e.g. GLL)
     def self.alternate_data_type(data_type)
       # match last 3 digits (get rid of talker)
       data_type[2..4]

data/{gem/lib → lib}/nmea_plus/version.rb

@@ -1,3 +1,3 @@
 module NMEAPlus
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nmea_plus
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Ian Katz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: racc
@@ -158,105 +158,126 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '1.0'
-description: "A pure-ruby decoder toolkit for NMEA messages (GPS, AIS, and other similar
-  formats)\n                          that provides convenient access to all data
-  fields.  Nearly all standard NMEA messages,\n                          the most
-  common AIS messages, and some proprietary messages are supported.\n                         "
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+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.  Nearly all standard NMEA messages,\n                          the
+  most common AIS messages, and some proprietary messages are supported.\n                         "
 email:
 - ifreecarve@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- gem/lib/nmea_plus.rb
-- gem/lib/nmea_plus/ais_message_factory.rb
-- gem/lib/nmea_plus/generated_parser/parser.rb
-- gem/lib/nmea_plus/generated_parser/tokenizer.rb
-- gem/lib/nmea_plus/message/ais/base_ais.rb
-- gem/lib/nmea_plus/message/ais/vdm.rb
-- gem/lib/nmea_plus/message/ais/vdm_payload/vdm_msg.rb
-- gem/lib/nmea_plus/message/ais/vdm_payload/vdm_msg1.rb
-- gem/lib/nmea_plus/message/ais/vdm_payload/vdm_msg5.rb
-- gem/lib/nmea_plus/message/ais/vdm_payload/vdm_msg8.rb
-- gem/lib/nmea_plus/message/base.rb
-- gem/lib/nmea_plus/message/nmea/aam.rb
-- gem/lib/nmea_plus/message/nmea/alm.rb
-- gem/lib/nmea_plus/message/nmea/apa.rb
-- gem/lib/nmea_plus/message/nmea/apb.rb
-- gem/lib/nmea_plus/message/nmea/base_nmea.rb
-- gem/lib/nmea_plus/message/nmea/bod.rb
-- gem/lib/nmea_plus/message/nmea/bwc.rb
-- gem/lib/nmea_plus/message/nmea/bwr.rb
-- gem/lib/nmea_plus/message/nmea/bww.rb
-- gem/lib/nmea_plus/message/nmea/dbk.rb
-- gem/lib/nmea_plus/message/nmea/dbs.rb
-- gem/lib/nmea_plus/message/nmea/dbt.rb
-- gem/lib/nmea_plus/message/nmea/dcn.rb
-- gem/lib/nmea_plus/message/nmea/dpt.rb
-- gem/lib/nmea_plus/message/nmea/dtm.rb
-- gem/lib/nmea_plus/message/nmea/fsi.rb
-- gem/lib/nmea_plus/message/nmea/gbs.rb
-- gem/lib/nmea_plus/message/nmea/gga.rb
-- gem/lib/nmea_plus/message/nmea/glc.rb
-- gem/lib/nmea_plus/message/nmea/gll.rb
-- gem/lib/nmea_plus/message/nmea/gns.rb
-- gem/lib/nmea_plus/message/nmea/grs.rb
-- gem/lib/nmea_plus/message/nmea/gsa.rb
-- gem/lib/nmea_plus/message/nmea/gst.rb
-- gem/lib/nmea_plus/message/nmea/gsv.rb
-- gem/lib/nmea_plus/message/nmea/gtd.rb
-- gem/lib/nmea_plus/message/nmea/gxa.rb
-- gem/lib/nmea_plus/message/nmea/hdg.rb
-- gem/lib/nmea_plus/message/nmea/hdm.rb
-- gem/lib/nmea_plus/message/nmea/hdt.rb
-- gem/lib/nmea_plus/message/nmea/hfb.rb
-- gem/lib/nmea_plus/message/nmea/hsc.rb
-- gem/lib/nmea_plus/message/nmea/its.rb
-- gem/lib/nmea_plus/message/nmea/lcd.rb
-- gem/lib/nmea_plus/message/nmea/msk.rb
-- gem/lib/nmea_plus/message/nmea/mss.rb
-- gem/lib/nmea_plus/message/nmea/mtw.rb
-- gem/lib/nmea_plus/message/nmea/mwv.rb
-- gem/lib/nmea_plus/message/nmea/oln.rb
-- gem/lib/nmea_plus/message/nmea/osd.rb
-- gem/lib/nmea_plus/message/nmea/pashr.rb
-- gem/lib/nmea_plus/message/nmea/r00.rb
-- gem/lib/nmea_plus/message/nmea/rma.rb
-- gem/lib/nmea_plus/message/nmea/rmb.rb
-- gem/lib/nmea_plus/message/nmea/rmc.rb
-- gem/lib/nmea_plus/message/nmea/rot.rb
-- gem/lib/nmea_plus/message/nmea/rpm.rb
-- gem/lib/nmea_plus/message/nmea/rsa.rb
-- gem/lib/nmea_plus/message/nmea/rsd.rb
-- gem/lib/nmea_plus/message/nmea/rte.rb
-- gem/lib/nmea_plus/message/nmea/sfi.rb
-- gem/lib/nmea_plus/message/nmea/stn.rb
-- gem/lib/nmea_plus/message/nmea/tds.rb
-- gem/lib/nmea_plus/message/nmea/tfi.rb
-- gem/lib/nmea_plus/message/nmea/tpc.rb
-- gem/lib/nmea_plus/message/nmea/tpr.rb
-- gem/lib/nmea_plus/message/nmea/tpt.rb
-- gem/lib/nmea_plus/message/nmea/trf.rb
-- gem/lib/nmea_plus/message/nmea/ttm.rb
-- gem/lib/nmea_plus/message/nmea/vbw.rb
-- gem/lib/nmea_plus/message/nmea/vdr.rb
-- gem/lib/nmea_plus/message/nmea/vhw.rb
-- gem/lib/nmea_plus/message/nmea/vlw.rb
-- gem/lib/nmea_plus/message/nmea/vpw.rb
-- gem/lib/nmea_plus/message/nmea/vtg.rb
-- gem/lib/nmea_plus/message/nmea/vwr.rb
-- gem/lib/nmea_plus/message/nmea/wcv.rb
-- gem/lib/nmea_plus/message/nmea/wnc.rb
-- gem/lib/nmea_plus/message/nmea/wpl.rb
-- gem/lib/nmea_plus/message/nmea/xdr.rb
-- gem/lib/nmea_plus/message/nmea/xte.rb
-- gem/lib/nmea_plus/message/nmea/xtr.rb
-- gem/lib/nmea_plus/message/nmea/zda.rb
-- gem/lib/nmea_plus/message/nmea/zfo.rb
-- gem/lib/nmea_plus/message/nmea/ztg.rb
-- gem/lib/nmea_plus/message_factory.rb
-- gem/lib/nmea_plus/nmea_message_factory.rb
-- gem/lib/nmea_plus/version.rb
+- README.md
+- lib/nmea_plus.rb
+- lib/nmea_plus/ais_message_factory.rb
+- lib/nmea_plus/generated_parser/parser.rb
+- lib/nmea_plus/generated_parser/tokenizer.rb
+- lib/nmea_plus/message/ais/base_ais.rb
+- lib/nmea_plus/message/ais/vdm.rb
+- lib/nmea_plus/message/ais/vdm_payload/vdm_msg.rb
+- lib/nmea_plus/message/ais/vdm_payload/vdm_msg1.rb
+- lib/nmea_plus/message/ais/vdm_payload/vdm_msg5.rb
+- lib/nmea_plus/message/ais/vdm_payload/vdm_msg8.rb
+- lib/nmea_plus/message/base.rb
+- lib/nmea_plus/message/nmea/aam.rb
+- lib/nmea_plus/message/nmea/alm.rb
+- lib/nmea_plus/message/nmea/apa.rb
+- lib/nmea_plus/message/nmea/apb.rb
+- lib/nmea_plus/message/nmea/base_nmea.rb
+- lib/nmea_plus/message/nmea/bod.rb
+- lib/nmea_plus/message/nmea/bwc.rb
+- lib/nmea_plus/message/nmea/bwr.rb
+- lib/nmea_plus/message/nmea/bww.rb
+- lib/nmea_plus/message/nmea/dbk.rb
+- lib/nmea_plus/message/nmea/dbs.rb
+- lib/nmea_plus/message/nmea/dbt.rb
+- lib/nmea_plus/message/nmea/dcn.rb
+- lib/nmea_plus/message/nmea/dpt.rb
+- lib/nmea_plus/message/nmea/dtm.rb
+- lib/nmea_plus/message/nmea/fsi.rb
+- lib/nmea_plus/message/nmea/gbs.rb
+- lib/nmea_plus/message/nmea/gga.rb
+- lib/nmea_plus/message/nmea/glc.rb
+- lib/nmea_plus/message/nmea/gll.rb
+- lib/nmea_plus/message/nmea/gns.rb
+- lib/nmea_plus/message/nmea/grs.rb
+- lib/nmea_plus/message/nmea/gsa.rb
+- lib/nmea_plus/message/nmea/gst.rb
+- lib/nmea_plus/message/nmea/gsv.rb
+- lib/nmea_plus/message/nmea/gtd.rb
+- lib/nmea_plus/message/nmea/gxa.rb
+- lib/nmea_plus/message/nmea/hdg.rb
+- lib/nmea_plus/message/nmea/hdm.rb
+- lib/nmea_plus/message/nmea/hdt.rb
+- lib/nmea_plus/message/nmea/hfb.rb
+- lib/nmea_plus/message/nmea/hsc.rb
+- lib/nmea_plus/message/nmea/its.rb
+- lib/nmea_plus/message/nmea/lcd.rb
+- lib/nmea_plus/message/nmea/msk.rb
+- lib/nmea_plus/message/nmea/mss.rb
+- lib/nmea_plus/message/nmea/mtw.rb
+- lib/nmea_plus/message/nmea/mwv.rb
+- lib/nmea_plus/message/nmea/oln.rb
+- lib/nmea_plus/message/nmea/osd.rb
+- lib/nmea_plus/message/nmea/pashr.rb
+- lib/nmea_plus/message/nmea/r00.rb
+- lib/nmea_plus/message/nmea/rma.rb
+- lib/nmea_plus/message/nmea/rmb.rb
+- lib/nmea_plus/message/nmea/rmc.rb
+- lib/nmea_plus/message/nmea/rot.rb
+- lib/nmea_plus/message/nmea/rpm.rb
+- lib/nmea_plus/message/nmea/rsa.rb
+- lib/nmea_plus/message/nmea/rsd.rb
+- lib/nmea_plus/message/nmea/rte.rb
+- lib/nmea_plus/message/nmea/sfi.rb
+- lib/nmea_plus/message/nmea/stn.rb
+- lib/nmea_plus/message/nmea/tds.rb
+- lib/nmea_plus/message/nmea/tfi.rb
+- lib/nmea_plus/message/nmea/tpc.rb
+- lib/nmea_plus/message/nmea/tpr.rb
+- lib/nmea_plus/message/nmea/tpt.rb
+- lib/nmea_plus/message/nmea/trf.rb
+- lib/nmea_plus/message/nmea/ttm.rb
+- lib/nmea_plus/message/nmea/vbw.rb
+- lib/nmea_plus/message/nmea/vdr.rb
+- lib/nmea_plus/message/nmea/vhw.rb
+- lib/nmea_plus/message/nmea/vlw.rb
+- lib/nmea_plus/message/nmea/vpw.rb
+- lib/nmea_plus/message/nmea/vtg.rb
+- lib/nmea_plus/message/nmea/vwr.rb
+- lib/nmea_plus/message/nmea/wcv.rb
+- lib/nmea_plus/message/nmea/wnc.rb
+- lib/nmea_plus/message/nmea/wpl.rb
+- lib/nmea_plus/message/nmea/xdr.rb
+- lib/nmea_plus/message/nmea/xte.rb
+- lib/nmea_plus/message/nmea/xtr.rb
+- lib/nmea_plus/message/nmea/zda.rb
+- lib/nmea_plus/message/nmea/zfo.rb
+- lib/nmea_plus/message/nmea/ztg.rb
+- lib/nmea_plus/message_factory.rb
+- lib/nmea_plus/nmea_message_factory.rb
+- lib/nmea_plus/version.rb
 homepage: http://github.com/ifreecarve/nmea_plus
 licenses:
 - Apache 2.0
@@ -264,7 +285,7 @@ metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
-- gem/lib
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ~>