rozi 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 025afb43aa2addc11320d73c12fb94089283b198
-  data.tar.gz: f8a5f17bcbcd4a215dce4f661069543819d856d0
+  metadata.gz: c63cdef86599183152c63d7c23102fa868709ffb
+  data.tar.gz: f2990a902a99c2264eb013bc0d046625a924ed51
 SHA512:
-  metadata.gz: ffc45b19f22f0391335bc8cc3a3e72c64f6a75d4f6f890fee5dd2d004fbd03c81251052faa526f89088f261bea56243a940aced00312fbbe2178a5e3675b38e5
-  data.tar.gz: 83241e9f3a10dea99775a32192c51c64fa1d4afc05a64ab3a7ee19889bb614468ff7dc27a147a7069f64d896481e83be092eafcd2907b8228cf43439afd52a44
+  metadata.gz: 9cfcc74f0d06872dda67073bd4ca1b3787e88ff9753f45c284781daf386a9c2b80f630c8229e79ea65073ad17356a40db1d54b4061dff5615d9d6497b716ab13
+  data.tar.gz: c713a377dc8004908d63b8b578c8366751a541039728894f983e6c06665e18472a7da53789619ee8e942c2230921438c9df8e76f447127d9e1db913d4fe2f8de

data/lib/rozi.rb

@@ -1,5 +1,8 @@
 
 module Rozi
+
+  PROJECT_DIR = File.expand_path("../", File.dirname(__FILE__))
+
   ##
   # Loads all ruby files under lib/rozi. Called automatically when requiring
   # "rozi.rb".

data/lib/rozi/module_functions.rb

@@ -0,0 +1,73 @@
+
+module Rozi
+
+  module_function
+
+  ##
+  # Opens a file handle with the correct settings for writing an Ozi Explorer
+  # file format.
+  #
+  # @overload open_file_for_writing(path)
+  #
+  #   @param [String] path
+  #   @return [File]
+  #
+  # @overload open_file_for_writing(path)
+  #
+  #   Can be called with a block, just file +File.open+.
+  #
+  #   @yieldparam [File] file
+  #   @return [void]
+  #
+  def open_file_for_writing(path)
+    file = File.open(path, "w")
+    file.set_encoding("ISO-8859-1", "UTF-8", crlf_newline: true)
+
+    if block_given?
+      yield file
+      file.close
+
+      return nil
+    else
+      return file
+    end
+  end
+
+  ##
+  # Writes an array of waypoints to a file.
+  #
+  # @see Rozi::WaypointWriter#write
+  #
+  def write_waypoints(waypoints, file)
+    @@wpt_writer ||= WaypointWriter.new
+
+    if file.is_a? String
+      open_file_for_writing(file) { |f|
+        @@wpt_writer.write(waypoints, f)
+      }
+    else
+      @@wpt_writer.write(waypoints, file)
+    end
+
+    return nil
+  end
+
+  ##
+  # Writes a track to a file.
+  #
+  # @see Rozi::TrackWriter#write
+  #
+  def write_track(track, file)
+    @@track_writer ||= TrackWriter.new
+
+    if file.is_a? String
+      open_file_for_writing(file) { |f|
+        @@track_writer.write(track, f)
+      }
+    else
+      @@track_writer.write(track, file)
+    end
+
+    return nil
+  end
+end

data/lib/rozi/ozi_functions.rb

@@ -34,29 +34,6 @@ module Rozi
 
       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

@@ -30,7 +30,7 @@ module Rozi
     end
 
     ##
-    # @returns [Array] the attributes of the track as an Array
+    # @return [Array] the attributes of the track as an Array
     #
     def attributes
       [@line_width, @color, @description, @skip_value,

data/lib/rozi/track_writer.rb

@@ -8,38 +8,29 @@ module Rozi
     include OziFunctions
 
     ##
-    # Writes the track to +file+ as an Ozi Explorer .plt file.
+    # Writes the track to +file+ as an Ozi Explorer track file. The file
+    # extension should be ".plt".
     #
     # @param [AddressKit::Ozi::Track] track
-    # @param [File, #write] file
+    # @param [File, String, #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 <<-TEXT.gsub(/^[ ]{8}/, "")
+        OziExplorer Track Point File Version 2.1
+        WGS 84
+        Altitude is in Feet
+        Reserved 3
+      TEXT
 
-        file.write(track.points.count.to_s() + "\n")
+      file.write(track_attributes_to_text(track))
+      file.write("\n")
 
-        track.points.each { |point|
-          file.write(track_point_to_text(point))
-          file.write("\n")
-        }
-      }
+      file.write(track.points.count.to_s() + "\n")
 
-      if file.is_a? String
-        open_file_for_writing(file) { |f|
-          write_inner.call(track, f)
-        }
-      else
-        write_inner.call(track, file)
-      end
+      track.points.each { |point|
+        file.write(track_point_to_text(point))
+        file.write("\n")
+      }
     end
 
     def track_attributes_to_text(track)

data/lib/rozi/version.rb

@@ -1,4 +1,4 @@
 
 module Rozi
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/rozi/waypoint.rb

@@ -10,10 +10,19 @@ module Rozi
 
     include OziFunctions
 
-    # TODO: Finish list of symbols.
-    SYMBOLS = {:default => 3, :house => 10}
-
-    attr_accessor :number, :name, :latitude, :longitude, :date,
+    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
 
@@ -25,8 +34,8 @@ module Rozi
       @latitude = 0.0
       @longitude = 0.0
       @date = nil
-      @symbol = 3
-      @display_format = 4
+      @symbol = 0
+      @display_format = :name_with_dot
       @fg_color = 0
       @bg_color = 65535
       @description = ""
@@ -46,30 +55,21 @@ module Rozi
     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
+      [@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
 
     ##

data/lib/rozi/waypoint_writer.rb

@@ -12,27 +12,17 @@ module Rozi
     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")
-        }
-      }
+      file.write <<-TEXT.gsub(/^[ ]{8}/, "")
+        OziExplorer Waypoint File Version 1.1
+        WGS 84
+        Reserved 2
+
+      TEXT
 
-      if file.is_a? String
-        file = open_file_for_writing(file) { |f|
-          write_inner.call(waypoints, f)
-        }
-      else
-        write_inner.call(waypoints, file)
-      end
+      waypoints.each { |wpt|
+        file.write(waypoint_to_text(wpt))
+        file.write("\n")
+      }
     end
 
     def waypoint_to_text(waypoint)

data/test/rozi/module_functions_test.rb

@@ -0,0 +1,97 @@
+
+require "tempfile"
+
+module Rozi
+  class ModuleFunctionsTest < Minitest::Test
+
+    def test_open_file_for_writing
+      temp_file_path { |file_path|
+        file = Rozi.open_file_for_writing file_path
+        file.write("foo\nbar\næøå")
+        file.close
+
+        text = File.read(file_path, mode: "rb").force_encoding("ISO-8859-1")
+
+        assert_equal "foo\r\nbar\r\næøå".encode("ISO-8859-1"), text
+      }
+    end
+
+    def test_open_file_for_writing_with_block
+      temp_file_path { |file_path|
+        f = nil
+
+        Rozi.open_file_for_writing(file_path) { |file|
+          assert_instance_of File, file
+
+          f = file
+        }
+
+        assert f.closed?
+      }
+    end
+
+    def test_write_waypoints
+      waypoints = [
+        Rozi::Waypoint.new(
+          latitude: 59.91273, longitude: 10.74609, name: "OSLO"
+        ),
+        Rozi::Waypoint.new(
+          latitude: 60.39358, longitude: 5.32476, name: "BERGEN"
+        ),
+        Rozi::Waypoint.new(
+          latitude: 62.56749, longitude: 7.68709, name: "ÅNDALSNES"
+        )
+      ]
+
+      temp_file_path { |file_path|
+        Rozi.write_waypoints(waypoints, file_path)
+
+        text = File.read(file_path, mode: "rb")
+        expected_output = read_test_file("expected_output_1.wpt")
+
+        assert_equal expected_output, text
+      }
+    end
+
+    def test_write_track
+      track = Rozi::Track.new()
+      track << Rozi::TrackPoint.new(latitude: 59.91273, longitude: 10.74609)
+      track << Rozi::TrackPoint.new(latitude: 60.39358, longitude: 5.32476)
+      track << Rozi::TrackPoint.new(latitude: 62.56749, longitude: 7.68709)
+
+      temp_file_path { |file_path|
+        Rozi.write_track(track, file_path)
+
+        text = File.read(file_path, mode: "rb")
+        expected_output = read_test_file("expected_output_1.plt")
+
+        assert_equal expected_output, text
+      }
+    end
+
+    private
+
+    def read_test_file(name)
+      path = File.join(Rozi::PROJECT_DIR, "test_data", name)
+
+      File.read(path, mode: "rb")
+    end
+
+    def temp_file_path(name="temp", suffix="")
+      path = Dir::Tmpname.make_tmpname(
+        "#{Dir::Tmpname.tmpdir}/rozi", "#{name}#{suffix}"
+      )
+
+      if block_given?
+        begin
+          yield path
+        ensure
+          File.unlink path if File.exist? path
+        end
+      else
+        return path
+      end
+    end
+
+  end
+end

data/test/rozi/track_point_test.rb

@@ -1,7 +1,4 @@
 
-require "rozi/track_point"
-require "minitest/autorun"
-
 module Rozi
 
   class TrackPointTest < Minitest::Test

data/test/rozi/track_test.rb

@@ -1,6 +1,4 @@
 
-require "rozi/track"
-
 module Rozi
 
   class TrackTest < Minitest::Test

data/test/rozi/track_writer_test.rb

@@ -1,8 +1,6 @@
 
 require "stringio"
 
-require "rozi/track_writer"
-
 module Rozi
 
   class TrackWriterTest < Minitest::Test

data/test/rozi/waypoint_test.rb

@@ -1,6 +1,4 @@
 
-require "rozi/waypoint"
-
 module Rozi
 
   class WaypointTest < Minitest::Test
@@ -16,14 +14,6 @@ module Rozi
       }
     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()
 

data/test/rozi/waypoint_writer_test.rb

@@ -1,7 +1,4 @@
 
-require "rozi/waypoint_writer"
-require "rozi/waypoint"
-
 module Rozi
 
   class WaypointWriterTest < Minitest::Test
@@ -40,21 +37,21 @@ Reserved 2
       wpt = Waypoint.new(name: "test")
 
       assert_equal(
-        "-1,test,0.000000,0.000000,,3,1,4,0,65535,,0,,,-777,6,0,17",
+        "-1,test,0.000000,0.000000,,0,1,3,0,65535,,0,,,-777,6,0,17",
         @subject.waypoint_to_text(wpt)
       )
 
-      wpt = Waypoint.new(name: "test", symbol: :house)
+      wpt = Waypoint.new(name: "test", symbol: 4)
 
       assert_equal(
-        "-1,test,0.000000,0.000000,,10,1,4,0,65535,,0,,,-777,6,0,17",
+        "-1,test,0.000000,0.000000,,4,1,3,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",
+        "-1,test,0.000000,0.000000,,0,1,3,0,65535,æøåÑ ÆØÅ,0,,,-777,6,0,17",
         @subject.waypoint_to_text(wpt)
       )
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rozi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tomas Sandven
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/rozi.rb
+- lib/rozi/module_functions.rb
 - lib/rozi/ozi_functions.rb
 - lib/rozi/track.rb
 - lib/rozi/track_point.rb
@@ -26,6 +27,7 @@ files:
 - lib/rozi/version.rb
 - lib/rozi/waypoint.rb
 - lib/rozi/waypoint_writer.rb
+- test/rozi/module_functions_test.rb
 - test/rozi/track_point_test.rb
 - test/rozi/track_test.rb
 - test/rozi/track_writer_test.rb
@@ -61,3 +63,5 @@ test_files:
 - test/rozi/track_writer_test.rb
 - test/rozi/waypoint_writer_test.rb
 - test/rozi/track_test.rb
+- test/rozi/module_functions_test.rb
+has_rdoc: