rozi 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c63cdef86599183152c63d7c23102fa868709ffb
-  data.tar.gz: f2990a902a99c2264eb013bc0d046625a924ed51
+  metadata.gz: 6351d00ff20f095a7a14131c0e4f44def5067d27
+  data.tar.gz: 416b900a4696699ec9247950c36d04bbaf1f7a26
 SHA512:
-  metadata.gz: 9cfcc74f0d06872dda67073bd4ca1b3787e88ff9753f45c284781daf386a9c2b80f630c8229e79ea65073ad17356a40db1d54b4061dff5615d9d6497b716ab13
-  data.tar.gz: c713a377dc8004908d63b8b578c8366751a541039728894f983e6c06665e18472a7da53789619ee8e942c2230921438c9df8e76f447127d9e1db913d4fe2f8de
+  metadata.gz: 9cf1116b403989c44d18d5d4fdf899144c374a513047ca6430144ca4a9bb353c2c0386580e8cd3a97d8611fc16ba59ec2b3dddd55344f72966a5f25c06ac283d
+  data.tar.gz: 9ff24557115520e3f45728fcf0ab587b034671344a74a5db31275ef4cf6197b9f04dc93bcd6c08f09bb5b12e00d15342951636adb7265c65bacdcf423671d90b

data/lib/rozi/datums.rb

@@ -0,0 +1,130 @@
+
+module Rozi
+
+  ##
+  # A list of datums accepted by Ozi Explorer.
+  #
+  DATUMS = [
+    "Adindan",
+    "Afgooye",
+    "Ain el Abd 1970",
+    "Anna 1 Astro 1965",
+    "Arc 1950",
+    "Arc 1960",
+    "Ascension Island 1958",
+    "Astro B4 Sorol Atoll",
+    "Astro Beacon 1945",
+    "Astro DOS 71/4",
+    "Astronomic Stn 1952",
+    "Australian Geodetic 1966",
+    "Australian Geodetic 1984",
+    "Australian Geocentric 1994 (GDA94)",
+    "Austrian",
+    "Bellevue (IGN)",
+    "Bermuda 1957",
+    "Bogota Observatory",
+    "Campo Inchauspe",
+    "Canton Astro 1966",
+    "Cape",
+    "Cape Canaveral",
+    "Carthage",
+    "CH-1903",
+    "Chatham 1971",
+    "Chua Astro",
+    "Corrego Alegre",
+    "Djakarta (Batavia)",
+    "DOS 1968",
+    "Easter Island 1967",
+    "Egypt",
+    "European 1950",
+    "European 1950 (Mean France)",
+    "European 1950 (Spain and Portugal)",
+    "European 1979",
+    "Finland Hayford",
+    "Gandajika Base",
+    "Geodetic Datum 1949",
+    "Guam 1963",
+    "GUX 1 Astro",
+    "Hartebeeshoek94",
+    "Hermannskogel",
+    "Hjorsey 1955",
+    "Hong Kong 1963",
+    "Hu-Tzu-Shan",
+    "Indian Bangladesh",
+    "Indian Thailand",
+    "Israeli",
+    "Ireland 1965",
+    "ISTS 073 Astro 1969",
+    "Johnston Island",
+    "Kandawala",
+    "Kerguelen Island",
+    "Kertau 1948",
+    "L.C. 5 Astro",
+    "Liberia 1964",
+    "Luzon Mindanao",
+    "Luzon Philippines",
+    "Mahe 1971",
+    "Marco Astro",
+    "Massawa",
+    "Merchich",
+    "Midway Astro 1961",
+    "Minna",
+    "NAD27 Alaska",
+    "NAD27 Bahamas",
+    "NAD27 Canada",
+    "NAD27 Canal Zone",
+    "NAD27 Caribbean",
+    "NAD27 Central",
+    "NAD27 CONUS",
+    "NAD27 Cuba",
+    "NAD27 Greenland",
+    "NAD27 Mexico",
+    "NAD27 San Salvador",
+    "NAD83",
+    "Nahrwn Masirah Ilnd",
+    "Nahrwn Saudi Arbia",
+    "Nahrwn United Arab",
+    "Naparima BWI",
+    "NGO1948",
+    "NTF France",
+    "Norsk",
+    "Observatorio 1966",
+    "Old Egyptian",
+    "Old Hawaiian",
+    "Oman",
+    "Ord Srvy Grt Britn",
+    "Pico De Las Nieves",
+    "Pitcairn Astro 1967",
+    "Potsdam Rauenberg DHDN",
+    "Prov So Amrican 1956",
+    "Prov So Chilean 1963",
+    "Puerto Rico",
+    "Pulkovo 1942 (1)",
+    "Pulkovo 1942 (2)",
+    "Qatar National",
+    "Qornoq",
+    "Reunion",
+    "Rijksdriehoeksmeting",
+    "Rome 1940",
+    "RT 90",
+    "S42       ",
+    "Santo (DOS)",
+    "Sao Braz",
+    "Sapper Hill 1943",
+    "Schwarzeck",
+    "South American 1969",
+    "South Asia",
+    "Southeast Base",
+    "Southwest Base",
+    "Timbalai 1948",
+    "Tokyo",
+    "Tristan Astro 1968",
+    "Viti Levu 1916",
+    "Wake-Eniwetok 1960",
+    "WGS 72",
+    "WGS 84",
+    "Yacare",
+    "Zanderij"
+  ]
+
+end

data/lib/rozi/module_functions.rb

@@ -70,4 +70,23 @@ module Rozi
 
     return nil
   end
+
+  ##
+  # Writes a {Rozi::NameSearchText} object to a file.
+  #
+  # @see Rozi::NameSearchTextWriter#write
+  #
+  def write_nst(nst, file)
+    @@nst_writer ||= NameSearchTextWriter.new
+
+    if file.is_a? String
+      open_file_for_writing(file) { |f|
+        @@nst_writer.write(nst, f)
+      }
+    else
+      @@nst_writer.write(nst, file)
+    end
+
+    return nil
+  end
 end

data/lib/rozi/name.rb

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

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

@@ -0,0 +1,63 @@
+
+module Rozi
+
+  ##
+  # A class for writing {Rozi::NameSearchText} objects to 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
+        raise "name, lat and lng must be set!"
+      end
+
+      "#{name.name},#{name.feature_code},#{name.zone},#{name.lat},#{name.lng}"
+    end
+  end
+
+end

data/lib/rozi/ozi_functions.rb

@@ -22,8 +22,8 @@ module Rozi
     # @return [Integer]
     #
     # @example
-    #   interpret_color(255)      # 255
-    #   interpret_color("ABCDEF") # 15715755
+    #   interpret_color(255)      # => 255
+    #   interpret_color("ABCDEF") # => 15715755
     #
     def interpret_color(color)
       if color.is_a? String
@@ -34,6 +34,15 @@ module Rozi
 
       color
     end
+
+    ##
+    # Checks if +datum+ is a valid datum according to Ozi Explorer.
+    #
+    # @return [Boolean] true if +datum+ is valid
+    #
+    def datum_valid?(datum)
+      Rozi::DATUMS.include? datum
+    end
   end
 
 end

data/lib/rozi/track.rb

@@ -8,7 +8,8 @@ module Rozi
   class Track
     attr_accessor :points
 
-    attr_accessor :line_width, :color, :description, :skip_value, :type,
+    attr_reader :color
+    attr_accessor :line_width, :description, :skip_value, :type,
       :fill_type, :fill_color
 
     DEFAULTS = {
@@ -21,6 +22,8 @@ module Rozi
       fill_color: 0
     }
 
+    include OziFunctions
+
     def initialize(args={})
       @points = args[:points] || []
 
@@ -29,6 +32,10 @@ module Rozi
       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
     #

data/lib/rozi/version.rb

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

data/test/rozi/name_search_text_test.rb

@@ -0,0 +1,28 @@
+
+module Rozi
+
+  class NameSearchTextTest < Minitest::Test
+
+    def setup
+      @subject = NameSearchText.new
+    end
+
+    def test_add_name
+      @subject << :foo
+      @subject << :bar
+
+      assert_equal [:foo, :bar], @subject.names
+    end
+
+    def test_set_datum
+      @subject.datum = "WGS 84"
+      @subject.datum = "Adindan"
+
+      assert_raises(ArgumentError) {
+        @subject.datum = "Foo bar"
+      }
+    end
+
+  end
+
+end

data/test/rozi/name_search_text_writer_test.rb

@@ -0,0 +1,114 @@
+
+require "stringio"
+
+module Rozi
+
+  class NameSearchTextWriterTest < Minitest::Test
+
+    def setup
+      @subject = NameSearchTextWriter.new
+    end
+
+    def test_write_wgs_84
+      expected_output = <<-NST.gsub(/ {8}/, "")
+        ;Foo
+        ;Bar
+        ;Baz
+        #1,,
+        #2,WGS 84
+        Oslo,Cities,,12.34,56.78
+        Bergen,Cities,,23.45,67.89
+      NST
+
+      nst = NameSearchText.new
+      nst.comment = "Foo\nBar\nBaz"
+      nst << Name.new("Oslo", "Cities", nil, 12.34, 56.78)
+      nst << Name.new("Bergen", "Cities", nil, 23.45, 67.89)
+
+      output = write_to_string nst
+
+      assert_equal expected_output, output
+    end
+
+    def test_write_wgs_utm
+      expected_output = <<-NST.gsub(/ {8}/, "")
+        #1,UTM,32V,N
+        #2,Norsk
+        Oslo,Cities,,12.34,56.78
+        Bergen,Cities,33,23.45,67.89
+      NST
+
+      nst = NameSearchText.new
+      nst.utm = true
+      nst.utm_zone = "32V"
+      nst.hemisphere = "N"
+      nst.datum = "Norsk"
+
+      nst << Name.new("Oslo", "Cities", nil, 12.34, 56.78)
+      nst << Name.new("Bergen", "Cities", "33", 23.45, 67.89)
+
+      output = write_to_string nst
+
+      assert_equal expected_output, output
+    end
+
+    def test_construct_first_line_latlng
+      nst = NameSearchText.new
+      nst.utm = false
+
+      assert_equal "#1,,", @subject.send(:construct_first_line, nst)
+    end
+
+    def test_construct_first_line_utm
+      nst = NameSearchText.new
+      nst.utm = true
+      nst.utm_zone = "32"
+      nst.hemisphere = "N"
+
+      assert_equal "#1,UTM,32,N", @subject.send(:construct_first_line, nst)
+
+      nst.hemisphere = nil
+
+      assert_equal "#1,UTM,32", @subject.send(:construct_first_line, nst)
+    end
+
+    def test_construct_second_line
+      nst = NameSearchText.new
+      nst.datum = "Egypt"
+
+      assert_equal "#2,Egypt", @subject.send(:construct_second_line, nst)
+    end
+
+    def test_name_to_line
+      name = Rozi::Name.new "Foo", "Bar", nil, 12.34, 56.78
+
+      expected_output = "Foo,Bar,,12.34,56.78"
+      output = @subject.send :name_to_line, name
+
+      assert_equal expected_output, output
+    end
+
+    def test_name_to_line_missing_components
+      name1 = Rozi::Name.new nil, "Bar", nil, 12.34, 56.78
+      name2 = Rozi::Name.new "Foo", "Bar", nil, nil, nil
+      name3 = Rozi::Name.new nil, "Bar", nil, nil, nil
+
+      [name1, name2, name3].each { |name|
+        assert_raises(RuntimeError) {
+          @subject.send(:name_to_line, name)
+        }
+      }
+    end
+
+    def write_to_string(nst)
+      file = StringIO.new
+
+      @subject.write(nst, file)
+
+      file.rewind
+      return file.read
+    end
+
+  end
+
+end

data/test/rozi/ozi_functions_test.rb

@@ -0,0 +1,33 @@
+
+module Rozi
+
+  class OziFunctionsTest < Minitest::Test
+    def setup
+      @subject = Class.new {
+        include OziFunctions
+      }.new
+    end
+
+    def test_escape_text
+      assert_equal "FooÑ barÑ baz", @subject.escape_text("Foo, bar, baz")
+    end
+
+    def test_interpret_color_integer
+      assert_equal 255, @subject.interpret_color(255)
+    end
+
+    def test_interpret_color_hash
+      assert_equal 15715755, @subject.interpret_color("ABCDEF")
+    end
+
+    def test_datum_valid?
+      assert @subject.datum_valid?("WGS 84")
+      assert @subject.datum_valid?("Norsk")
+      assert @subject.datum_valid?("Egypt")
+
+      refute @subject.datum_valid?("Coolywobbles")
+      refute @subject.datum_valid?("Rambunctious")
+    end
+  end
+
+end

metadata

@@ -1,25 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: rozi
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Tomas Sandven
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-06 00:00:00.000000000 Z
+date: 2014-09-18 00:00:00.000000000 Z
 dependencies: []
-description: |2
-      Contains classes for creating Waypoint files and Track files for Ozi
-      Explorer.
+description: A gem for working with several Ozi Explorer file formats
 email: tomas191191@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/rozi.rb
+- lib/rozi/datums.rb
 - lib/rozi/module_functions.rb
+- lib/rozi/name.rb
+- lib/rozi/name_search_text.rb
+- lib/rozi/name_search_text_writer.rb
 - lib/rozi/ozi_functions.rb
 - lib/rozi/track.rb
 - lib/rozi/track_point.rb
@@ -28,6 +30,9 @@ files:
 - lib/rozi/waypoint.rb
 - lib/rozi/waypoint_writer.rb
 - test/rozi/module_functions_test.rb
+- test/rozi/name_search_text_test.rb
+- test/rozi/name_search_text_writer_test.rb
+- test/rozi/ozi_functions_test.rb
 - test/rozi/track_point_test.rb
 - test/rozi/track_test.rb
 - test/rozi/track_writer_test.rb
@@ -58,10 +63,13 @@ 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
 - test/rozi/module_functions_test.rb
+- test/rozi/ozi_functions_test.rb
+- test/rozi/waypoint_test.rb
+- test/rozi/name_search_text_writer_test.rb
+- test/rozi/track_point_test.rb
+- test/rozi/name_search_text_test.rb
+- test/rozi/waypoint_writer_test.rb
 has_rdoc: