rozi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 100b9a40deb4353ee5c210b4559d0c61457abddf
+  data.tar.gz: b1e50676fdd98f846eea6a9e322bec93b2a83755
+SHA512:
+  metadata.gz: a70dc9fb2f08fbb68e5e8dd9960f05b9e28174ca28d5d1395aee1d8eef283db57dcd52541f4130af5828325d4f52e99d81fd4ff141f50ff1e765d969ed2a6999
+  data.tar.gz: 16b38ee7d75b4debe5ac1e2814694eb5d25e34bc36f110c4d6211d84cefddb901b46bad06282c419bed38296608cca4d5a73cea4b3b416b2ccf5d7f7fb3b2e79

data/lib/rozi/ozi_functions.rb

@@ -0,0 +1,62 @@
+
+module Rozi
+
+  ##
+  # Contains general functions for working with Ozi Explorer file formats.
+  #
+  module OziFunctions
+    ##
+    # Escapes commas so the text can be used in Ozi file formats.
+    #
+    # @param [String] text
+    # @return [String]
+    #
+    def escape_text(text)
+      text.gsub(/,/, 209.chr.encode("UTF-8", "ISO-8859-1"))
+    end
+
+    ##
+    # Converts the input to an RGB color represented by an integer.
+    #
+    # @param [String, Integer] color Can be a RRGGBB hex string or an integer.
+    # @return [Integer]
+    #
+    # @example
+    #   interpret_color(255)      # 255
+    #   interpret_color("ABCDEF") # 15715755
+    #
+    def interpret_color(color)
+      if color.is_a? String
+        # Turns RRGGBB into BBGGRR for hex conversion.
+        color = color[-2..-1] << color[2..3] << color[0..1]
+        color = color.to_i(16)
+      end
+
+      color
+    end
+
+    ##
+    # Opens a file handle with the correct settings for writing an Ozi
+    # Explorer file format.
+    #
+    # @param [String] path
+    # @return [File]
+    #
+    def open_file_for_writing(path)
+      if block_given?
+        file = File.open(path, "w") { |f|
+          f.set_encoding("ISO-8859-1", "UTF-8", crlf_newline: true)
+          yield f
+        }
+
+        return nil
+      else
+        file = File.open(path, "w")
+        file.set_encoding("ISO-8859-1", "UTF-8", crlf_newline: true)
+
+        return file
+      end
+    end
+  end
+
+end

data/lib/rozi/track.rb

@@ -0,0 +1,58 @@
+
+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_accessor :line_width, :color, :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
+    }
+
+    def initialize(args={})
+      @points = args[:points] || []
+
+      DEFAULTS.each_pair { |key, value| set(key, value) }
+
+      args.each_pair { |key, value| set(key, value) }
+    end
+
+    ##
+    # @returns [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

@@ -0,0 +1,39 @@
+
+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

@@ -0,0 +1,59 @@
+
+require "rozi/ozi_functions"
+
+module Rozi
+
+  class TrackWriter
+
+    include OziFunctions
+
+    ##
+    # Writes the track to +file+ as an Ozi Explorer .plt file.
+    #
+    # @param [AddressKit::Ozi::Track] track
+    # @param [File, #write] file
+    #
+    def write(track, file)
+      write_inner = Proc.new { |track, file|
+        file.write(<<-TEXT)
+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")
+        }
+      }
+
+      if file.is_a? String
+        open_file_for_writing(file) { |f|
+          write_inner.call(track, f)
+        }
+      else
+        write_inner.call(track, file)
+      end
+    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/version.rb

@@ -0,0 +1,4 @@
+
+module Rozi
+  VERSION = "0.0.1"
+end

data/lib/rozi/waypoint.rb

@@ -0,0 +1,90 @@
+
+require "rozi/ozi_functions"
+
+module Rozi
+
+  ##
+  # Represents a waypoint in Ozi Explorer.
+  #
+  class Waypoint
+
+    include OziFunctions
+
+    # TODO: Finish list of symbols.
+    SYMBOLS = {:default => 3, :house => 10}
+
+    attr_accessor :number, :name, :latitude, :longitude, :date,
+      :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 = 3
+      @display_format = 4
+      @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_format,
+       @fg_color, @bg_color, @description, @pointer_direction, @altitude,
+       @font_size, @font_style, @symbol_size]
+    end
+
+    def symbol=(value)
+      if value.is_a? Symbol
+        value = SYMBOLS[value]
+      end
+
+      @symbol = value
+    end
+
+    ##
+    # Returns the symbol as a +Symbol+ by default. Pass +:number+ to return
+    # the symbol as a integer.
+    #
+    def symbol(format=:symbol)
+      @@symbols_rev ||= SYMBOLS.invert()
+
+      case format
+      when :symbol then @@symbols_rev[@symbol]
+      when :number then @symbol
+      end
+    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

data/lib/rozi/waypoint_writer.rb

@@ -0,0 +1,48 @@
+
+require "rozi/ozi_functions"
+
+module Rozi
+
+  ##
+  # This class writes a list of waypoints to a ".wpt" file that can be opened
+  # by Ozi Explorer.
+  #
+  class WaypointWriter
+
+    include OziFunctions
+
+    def write(waypoints, file)
+      write_inner = Proc.new { |waypoints, file|
+        file.write <<-TEXT
+OziExplorer Waypoint File Version 1.1
+WGS 84
+Reserved 2
+
+        TEXT
+
+        waypoints.each { |wpt|
+          file.write(waypoint_to_text(wpt))
+          file.write("\n")
+        }
+      }
+
+      if file.is_a? String
+        file = open_file_for_writing(file) { |f|
+          write_inner.call(waypoints, f)
+        }
+      else
+        write_inner.call(waypoints, file)
+      end
+    end
+
+    def waypoint_to_text(waypoint)
+      wpt = waypoint.to_a()
+      wpt.map! { |item| item.is_a?(String) ? escape_text(item) : item }
+      wpt.map! { |item| item.nil? ? "" : item }
+      wpt.map! { |item| item.is_a?(Float) ? item.round(6) : item }
+
+      "%d,%s,%f,%f,%s,%d,1,%d,%d,%d,%s,%d,,,%d,%d,%d,%d" % wpt
+    end
+  end
+
+end

data/test/rozi/track_point_test.rb

@@ -0,0 +1,35 @@
+
+require "rozi/track_point"
+require "minitest/autorun"
+
+module Rozi
+
+  class TrackPointTest < Minitest::Test
+    def test_initialize_defaults
+      point = TrackPoint.new()
+
+      TrackPoint::DEFAULTS.each_pair { |key, value|
+        assert_equal value, point.send(key)
+      }
+    end
+
+    def test_initialize_with_args
+      attrs = {latitude: 123.45, longitude: 567.89, break: 1}
+      point = TrackPoint.new(attrs)
+
+      attrs.each_pair { |key, value|
+        assert_equal value, point.send(key)
+      }
+    end
+
+    def test_to_a
+      point = TrackPoint.new(latitude: 123.45, longitude: 234.56)
+
+      assert_equal(
+        [123.45, 234.56, 0, -777, 0, "", ""],
+        point.to_a()
+      )
+    end
+  end
+
+end

data/test/rozi/track_test.rb

@@ -0,0 +1,27 @@
+
+require "rozi/track"
+
+module Rozi
+
+  class TrackTest < Minitest::Test
+    def test_initialize_defaults
+      t = Track.new()
+
+      Track::DEFAULTS.each_pair { |key, value|
+        assert_equal value, t.send(key)
+      }
+    end
+
+    def test_initialize_with_args
+      points = [:foo, :bar]
+      attrs = {points: points, line_width: 2, type: 10}
+
+      t = Track.new(attrs)
+
+      attrs.each_pair { |key, value|
+        assert_equal value, t.send(key)
+      }
+    end
+  end
+
+end

data/test/rozi/track_writer_test.rb

@@ -0,0 +1,64 @@
+
+require "stringio"
+
+require "rozi/track_writer"
+
+module Rozi
+
+  class TrackWriterTest < Minitest::Test
+    def test_write
+      point1 = mock()
+      point1.expects(:to_a).returns([12.34, 56.78, 0, -777, 0, "", ""])
+
+      point2 = mock()
+      point2.expects(:to_a).returns([23.45, 67.89, 0, -777, 0, "", ""])
+
+      track = mock()
+      track.expects(:attributes).returns([2, 255, "foo, bar", 1, 0, 0, 0])
+      track.expects(:points).twice.returns([point1, point2])
+
+      file = StringIO.new()
+
+      subject = TrackWriter.new()
+      subject.write(track, file)
+
+      file.rewind()
+
+      assert_equal(<<-TRACK, file.read())
+OziExplorer Track Point File Version 2.1
+WGS 84
+Altitude is in Feet
+Reserved 3
+0,2,255,fooÑ bar,1,0,0,0
+2
+  12.340000,56.780000,0,-777.0,0.0000000,,
+  23.450000,67.890000,0,-777.0,0.0000000,,
+      TRACK
+    end
+
+    def test_track_attributes_to_text
+      subject = TrackWriter.new()
+
+      track = mock()
+      track.expects(:attributes).returns([2, 0, "foo, bar", 1, 0, 0, 0])
+
+      assert_equal(
+        "0,2,0,fooÑ bar,1,0,0,0",
+        subject.track_attributes_to_text(track)
+      )
+    end
+
+    def test_track_point_to_text
+      subject = TrackWriter.new()
+
+      point = mock()
+      point.expects(:to_a).returns([12.34, 56.78, 0, -777, 0, "", ""])
+
+      assert_equal(
+        "  12.340000,56.780000,0,-777.0,0.0000000,,",
+        subject.track_point_to_text(point)
+      )
+    end
+  end
+
+end

data/test/rozi/waypoint_test.rb

@@ -0,0 +1,41 @@
+
+require "rozi/waypoint"
+
+module Rozi
+
+  class WaypointTest < Minitest::Test
+    def test_initialize
+      wp = Waypoint.new(number: 5, name: "Test point")
+
+      assert_equal "Test point", wp.name
+      assert_equal 5, wp.number
+
+      assert_raises(ArgumentError) {
+        # Invalid attribute "foo".
+        wp = Waypoint.new(foo: 123)
+      }
+    end
+
+    def test_symbol
+      wp = Waypoint.new()
+      wp.symbol = :house
+
+      assert_equal :house, wp.symbol
+      assert_equal 10, wp.symbol(:number)
+    end
+
+    def test_colors
+      wp = Waypoint.new()
+
+      wp.fg_color = "000000"
+      assert_equal 0, wp.fg_color
+
+      wp.fg_color = "ABCDEF"
+      assert_equal 15715755, wp.fg_color
+
+      wp.fg_color = 128
+      assert_equal 128, wp.fg_color
+    end
+  end
+
+end

data/test/rozi/waypoint_writer_test.rb

@@ -0,0 +1,63 @@
+
+require "rozi/waypoint_writer"
+require "rozi/waypoint"
+
+module Rozi
+
+  class WaypointWriterTest < Minitest::Test
+    def setup
+      @subject = WaypointWriter.new()
+    end
+
+    def test_write
+      waypoints = []
+      waypoints << Waypoint.new(
+        name: "Test", latitude: 60.872030, longitude: 12.049732
+      )
+      waypoints << Waypoint.new(
+        name: "Test 2", latitude: 61.872030, longitude: 12.049732
+      )
+      waypoints << Waypoint.new(
+        name: "Test 3", latitude: 60.872030, longitude: 13.049732
+      )
+
+      file = StringIO.new()
+
+      @subject.write(waypoints, file)
+
+      expected_output = <<-TEXT.chomp
+OziExplorer Waypoint File Version 1.1
+WGS 84
+Reserved 2
+
+-1,Test,60.872030,12.049732,,3,1,4,0,65535,,0,,,-777,6,0,17
+-1,Test 2,61.872030,12.049732,,3,1,4,0,65535,,0,,,-777,6,0,17
+-1,Test 3,60.872030,13.049732,,3,1,4,0,65535,,0,,,-777,6,0,17
+      TEXT
+    end
+
+    def test_waypoint_to_text
+      wpt = Waypoint.new(name: "test")
+
+      assert_equal(
+        "-1,test,0.000000,0.000000,,3,1,4,0,65535,,0,,,-777,6,0,17",
+        @subject.waypoint_to_text(wpt)
+      )
+
+      wpt = Waypoint.new(name: "test", symbol: :house)
+
+      assert_equal(
+        "-1,test,0.000000,0.000000,,10,1,4,0,65535,,0,,,-777,6,0,17",
+        @subject.waypoint_to_text(wpt)
+      )
+
+      wpt = Waypoint.new(name: "test", description: "æøå, ÆØÅ")
+
+      assert_equal(
+        "-1,test,0.000000,0.000000,,3,1,4,0,65535,æøåÑ ÆØÅ,0,,,-777,6,0,17",
+        @subject.waypoint_to_text(wpt)
+      )
+    end
+  end
+
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: rozi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tomas Sandven
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-06 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: tomas191191@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rozi.rb
+- lib/rozi/ozi_functions.rb
+- lib/rozi/track.rb
+- lib/rozi/track_point.rb
+- lib/rozi/track_writer.rb
+- lib/rozi/version.rb
+- lib/rozi/waypoint.rb
+- lib/rozi/waypoint_writer.rb
+- test/rozi/track_point_test.rb
+- test/rozi/track_test.rb
+- test/rozi/track_writer_test.rb
+- test/rozi/waypoint_test.rb
+- test/rozi/waypoint_writer_test.rb
+homepage: 
+licenses:
+- GPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A gem for working with several Ozi Explorer file formats
+test_files:
+- test/rozi/waypoint_test.rb
+- test/rozi/track_point_test.rb
+- test/rozi/track_writer_test.rb
+- test/rozi/waypoint_writer_test.rb
+- test/rozi/track_test.rb