rozi 0.0.7 → 0.1.3

data/README.rdoc

@@ -1,127 +0,0 @@
-{<img src="https://badge.fury.io/rb/rozi.svg" alt="Gem Version" />}[http://badge.fury.io/rb/rozi]
-
-= Rozi
-
-Rozi is a Ruby gem for working with all Ozi Explorer file formats. Currently
-the implemented functionality is:
-
-- Creating Waypoint files.
-- Creating Track files.
-- Creating Name Search Text (.nst) files.
-
-== Files.
-
-Text based file formats read by Ozi Explorer should be encoded as ISO-8859-1
-and use CR LF line endings (\\r\\n). If you pass file paths to Rozi's write
-functions (rather than file objects) Rozi will handle this for you. If that
-isn't an alternative you either have to handle this yourself, or you can use
-{Rozi.open_file_for_writing}.
-
-  file = Rozi.open_file_for_writing("file_path.wpt")
-  file.write("Østre aker\n")   # Writes "Østre aker\r\n" in ISO-8859-1.
-
-  # Does the same thing, but closes the file for you when you're done.
-  Rozi.open_file_for_writing("file_path.wpt") { |file|
-    file.write("Østre aker\n")
-  }
-
-== Colors.
-
-Any time you set colors in Rozi, you can either use the three-byte integer
-representation that Ozi Explorer expects, or you can use a hex string like
-"RRGGBB" and Rozi will convert it for you. Example:
-
-  # Identical.
-  Rozi::Waypoint.new(bg_color: "ABCDEF")
-  Rozi::Waypoint.new(bg_color: 15715755)
-
-  # Identical.
-  Rozi::Waypoint.new(bg_color: "FF0000")
-  Rozi::Waypoint.new(bg_color: 255)
-
-== Creating Waypoint files.
-
-Waypoint files are created in Rozi by creating an array of {Rozi::Waypoint}
-instances and writing them to a file using {Rozi.write_waypoints}:
-
-Example:
-
-  waypoints = [
-    Rozi::Waypoint.new(latitude: -12.7, longitude: -58.0, name: "South America"),
-    Rozi::Waypoint.new(latitude: 43.7, longitude: -103.7, name: "North America"),
-    Rozi::Waypoint.new(latitude: 49.6, longitude: 20.9, name: "Europe")
-  ]
-
-  Rozi.write_waypoints(waypoints, "file_path.wpt")
-
-Every aspect of the waypoint can be customized on the {Rozi::Waypoint} instance
-(display format, symbol, background- and foreground colors, description, font
-size etc.)
-
-== Creating Track files.
-
-Track files are created in Rozi by creating a {Rozi::Track} instance with two or
-more {Rozi::TrackPoint} instances, then writing them to a file using
-{Rozi.write_track}.
-
-Example:
-
-  track = Rozi::Track.new()
-
-  track << Rozi::TrackPoint.new(latitude: 39.8, longitude: -3.4)
-  track << Rozi::TrackPoint.new(latitude: 46.6, longitude: 3.1)
-  track << Rozi::TrackPoint.new(latitude: 50.79, longitude: 10.3)
-  track << Rozi::TrackPoint.new(latitude: 49.04, longitude: 31.5)
-
-  Rozi.write_track(track, "file_path.plt")
-
-Both {Rozi::Track} and {Rozi::TrackPoint} has lots of customizable attributes to
-change the appearance of the track.
-
-== Creating NST files.
-
-See {Ozi Explorer: Name
-Search}[http://www.oziexplorer3.com/namesearch/wnamesrch.html] for information
-about Name Search. An NST file has to be converted into a Name Database using
-the {"Name Search
-Creator"}[http://www.oziexplorer3.com/namesearch/namesearch_setup.exe] tool
-before they can be used by Ozi Explorer.
-
-In Rozi, an NST file is represented by a {Rozi::NameSearchText} object. This
-object lets you control the coordinate system (lat/lng or UTM) of the name
-database, as well as the datum, UTM Zone and Hemisphere (if applicable). You can
-also add a comment to the top of the exported file using
-{Rozi::NameSearchText#comment}. By default, decimal lat/lng coordinates are used
-with the WGS 84 datum.
-
-{Rozi::Name} objects are added to the {Rozi::NameSearchText} instance, which is
-then written to a file using {Rozi.write_nst}.
-
-Example:
-
-  nst = Rozi::NameSearchText.new
-  nst.comment = "Generated #{Time.now}"
-
-  nst << Rozi::Name.new("Place name", "Feature code", nil, 12.3456, 23.4567)
-
-  Rozi.write_nst(nst, "file_path.nst")
-
-Example using UTM with the "Norsk" datum:
-
-  nst = Rozi::NameSearchText.new
-  nst.comment = "Generated #{Time.now}"
-  nst.utm = true
-  nst.utm_zone = "33"
-  nst.datum = "Norsk"
-  nst.hemisphere = "N"
-
-  nst << Rozi::Name.new("Place name", "Feature code", nil, 67890.12, 56789.01)
-
-  # UTM Zone overridden.
-  nst << Rozi::Name.new("Place name", "Feature code", "32", 67890.12, 56789.01)
-
-  Rozi.write_nst(nst, "file_path.nst")
-
-Note, text in name search files (names and feature codes) cannot contain
-commas. There is no mechanism for escaping commas or substituting them with
-different symbols like in waypoint files.

data/lib/rozi/name.rb

@@ -1,23 +0,0 @@
-
-module Rozi
-
-  ##
-  # This class represents a name in an Ozi Explorer name database.
-  #
-  # @note The +name+, +lat+ and +lng+ fields must be set, or runtime errors will
-  #   be raised when attempting to write to file.
-  #
-  class Name
-
-    attr_accessor :name, :feature_code, :zone, :lat, :lng
-
-    def initialize(name=nil, feature_code=nil, zone=nil, lat=nil, lng=nil)
-      @name = name
-      @feature_code = feature_code
-      @zone = zone
-      @lat = lat
-      @lng = lng
-    end
-  end
-
-end

data/lib/rozi/name_search_text.rb

@@ -1,43 +0,0 @@
-
-require "rozi/ozi_functions"
-
-module Rozi
-
-  ##
-  # A name search text (.nst) file is a text file that can be converted into a
-  # name database used by Ozi Explorer's "name search" functionality. This class
-  # represents such a file and can be written to disk using
-  # {Rozi::NameSearchTextWriter}.
-  #
-  class NameSearchText
-
-    attr_accessor :comment, :datum, :names, :latlng,
-      :utm, :utm_zone, :hemisphere
-
-    include OziFunctions
-
-    def initialize
-      @comment = ""
-      @datum = "WGS 84"
-      @names = []
-
-      @latlng = true
-      @utm = false
-      @utm_zone = nil
-      @hemisphere = nil
-    end
-
-    def <<(name)
-      @names << name
-    end
-
-    def datum=(datum)
-      if not datum_valid?(datum)
-        fail ArgumentError, %(Invalid datum: "#{datum}")
-      end
-
-      @datum = datum
-    end
-  end
-
-end

data/lib/rozi/name_search_text_writer.rb

@@ -1,71 +0,0 @@
-
-module Rozi
-
-  ##
-  # A class for writing {Rozi::NameSearchText} objects to files.
-  #
-  # @note Text in name search files (names and feature codes) cannot contain
-  #   commas. There is no mechanism for escaping commas or substituting them
-  #   with different symbols like in waypoint files.
-  #
-  class NameSearchTextWriter
-
-    ##
-    # Writes +nst+ to +file+.
-    #
-    # @param [Rozi::NameSearchText] nst
-    # @param [File, StringIO] file an open file object
-    #
-    def write(nst, file)
-      if nst.comment
-        nst.comment.each_line { |line|
-          file.write ";#{line.chomp}\n"
-        }
-      end
-
-      file.write construct_first_line(nst) << "\n"
-      file.write construct_second_line(nst) << "\n"
-
-      nst.names.each { |name|
-        file.write name_to_line(name) << "\n"
-      }
-
-      return nil
-    end
-
-    private
-
-    def construct_first_line(nst)
-      first_line = "#1,"
-
-      if nst.utm
-        first_line << "UTM,#{nst.utm_zone}"
-
-        if nst.hemisphere
-          first_line << ",#{nst.hemisphere}"
-        end
-      else
-        first_line << ","
-      end
-
-      return first_line
-    end
-
-    def construct_second_line(nst)
-      "#2,#{nst.datum}"
-    end
-
-    def name_to_line(name)
-      if not name.name or not name.lat or not name.lng
-        fail "name, lat and lng must be set!"
-      end
-
-      if name.name.include?(",") or name.feature_code.include?(",")
-        fail ArgumentError, "Text cannot contain commas"
-      end
-
-      "#{name.name},#{name.feature_code},#{name.zone},#{name.lat},#{name.lng}"
-    end
-  end
-
-end

data/lib/rozi/track.rb

@@ -1,67 +0,0 @@
-
-require "rozi/ozi_functions"
-
-module Rozi
-
-  ##
-  # This class represents a Track in Ozi Explorer. It contains attributes
-  # about the track's appearance as well as a list of track points.
-  #
-  class Track
-    attr_accessor :points
-
-    attr_reader :color
-    attr_accessor :line_width, :description, :skip_value, :type,
-      :fill_type, :fill_color
-
-    DEFAULTS = {
-      line_width: 2,
-      color: 255,
-      description: "",
-      skip_value: 1,
-      type: 0,
-      fill_type: 0,
-      fill_color: 0
-    }
-
-    include OziFunctions
-
-    def initialize(args={})
-      @points = args[:points] || []
-
-      DEFAULTS.each_pair { |key, value| set(key, value) }
-
-      args.each_pair { |key, value| set(key, value) }
-    end
-
-    def color=(color)
-      @color = interpret_color(color)
-    end
-
-    ##
-    # @return [Array] the attributes of the track as an Array
-    #
-    def attributes
-      [@line_width, @color, @description, @skip_value,
-       @type, @fill_type, @fill_color]
-    end
-
-    ##
-    # Allows adding points to the track using the `<<` syntax.
-    #
-    def <<(point)
-      @points << point
-    end
-
-    private
-
-    def set(key, value)
-      begin
-        self.send(key.to_s() + "=", value)
-      rescue NoMethodError
-        fail ArgumentError, "Not a valid attribute: #{key}"
-      end
-    end
-  end
-
-end

data/lib/rozi/track_point.rb

@@ -1,39 +0,0 @@
-
-module Rozi
-
-  class TrackPoint
-    attr_accessor :latitude, :longitude, :break, :altitude, :date,
-      :date_string, :time_string
-
-    DEFAULTS = {
-      break: 0,
-      altitude: -777,
-      date: 0,
-      date_string: "",
-      time_string: ""
-    }
-
-    def initialize(args={})
-      DEFAULTS.each_pair { |key, value| set(key, value) }
-
-      args.each_pair { |key, value| set(key, value) }
-    end
-
-    def to_a
-      [@latitude, @longitude, @break, @altitude,
-       @date, @date_string, @time_string]
-    end
-
-    private
-
-    def set(key, value)
-      begin
-        self.send(key.to_s() + "=", value)
-      rescue NoMethodError
-        fail ArgumentError, "Not a valid attribute: #{key}"
-      end
-    end
-
-  end
-
-end

data/lib/rozi/track_writer.rb

@@ -1,50 +0,0 @@
-
-require "rozi/ozi_functions"
-
-module Rozi
-
-  class TrackWriter
-
-    include OziFunctions
-
-    ##
-    # Writes the track to +file+ as an Ozi Explorer track file. The file
-    # extension should be ".plt".
-    #
-    # @param [AddressKit::Ozi::Track] track
-    # @param [File, String, #write] file
-    #
-    def write(track, file)
-      file.write <<-TEXT.gsub(/^[ ]{8}/, "")
-        OziExplorer Track Point File Version 2.1
-        WGS 84
-        Altitude is in Feet
-        Reserved 3
-      TEXT
-
-      file.write(track_attributes_to_text(track))
-      file.write("\n")
-
-      file.write(track.points.count.to_s() + "\n")
-
-      track.points.each { |point|
-        file.write(track_point_to_text(point))
-        file.write("\n")
-      }
-    end
-
-    def track_attributes_to_text(track)
-      attrs = track.attributes
-      attrs.map! { |item| item.is_a?(String) ? escape_text(item) : item }
-
-      "0,%d,%d,%s,%d,%d,%d,%d" % attrs
-    end
-
-    def track_point_to_text(point)
-      p = point.to_a()
-
-      "  %.6f,%.6f,%d,%.1f,%.7f,%s,%s" % p
-    end
-  end
-
-end

data/lib/rozi/waypoint.rb

@@ -1,90 +0,0 @@
-
-require "rozi/ozi_functions"
-
-module Rozi
-
-  ##
-  # Represents a waypoint in Ozi Explorer.
-  #
-  class Waypoint
-
-    include OziFunctions
-
-    DISPLAY_FORMATS = {
-      :number_only => 0,
-      :name_only => 1,
-      :number_and_name => 2,
-      :name_with_dot => 3,
-      :name_with_symbol => 4,
-      :symbol_only => 5,
-      :comment_with_symbol => 6,
-      :man_overboard => 7,
-      :marker => 8
-    }
-
-    attr_accessor :number, :name, :latitude, :longitude, :date, :symbol,
-      :display_format, :description, :pointer_direction, :altitude,
-      :font_size, :font_style, :symbol_size
-
-    attr_reader :fg_color, :bg_color
-
-    def initialize(args={})
-      @number = -1
-      @name = ""
-      @latitude = 0.0
-      @longitude = 0.0
-      @date = nil
-      @symbol = 0
-      @display_format = :name_with_dot
-      @fg_color = 0
-      @bg_color = 65535
-      @description = ""
-      @pointer_direction = 0
-      @altitude = -777
-      @font_size = 6
-      @font_style = 0
-      @symbol_size = 17
-
-      args.each_pair { |key, value|
-        begin
-          self.send(key.to_s() + "=", value)
-        rescue NoMethodError
-          fail ArgumentError, "Not a valid attribute: #{key}"
-        end
-      }
-    end
-
-    def to_a
-      [@number,
-       @name,
-       @latitude,
-       @longitude,
-       @date,
-       @symbol,
-       DISPLAY_FORMATS[@display_format],
-       @fg_color,
-       @bg_color,
-       @description,
-       @pointer_direction,
-       @altitude,
-       @font_size,
-       @font_style,
-       @symbol_size]
-    end
-
-    ##
-    # Sets the foreground color. Accepts a hex string or a decimal value.
-    #
-    def fg_color=(color)
-      @fg_color = interpret_color(color)
-    end
-
-    ##
-    # Sets the background color. Accepts a hex string or a decimal value.
-    #
-    def bg_color=(color)
-      @bg_color = interpret_color(color)
-    end
-  end
-
-end