RubyGems - open_gpx_2_kml - Versions diffs - 1.0.5 → 1.1.1 - Mend

open_gpx_2_kml 1.0.5 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

data/.rspec +1 -0
data/Gemfile.lock +1 -1
data/example/config.csv +9 -1
data/example/windowsconfig.csv +9 -1
data/lib/tf1_converter/config.rb +14 -1
data/lib/tf1_converter/csv_file.rb +10 -1
data/lib/tf1_converter/kml/placemark.rb +51 -0
data/lib/tf1_converter/kml_file.rb +4 -30
data/lib/tf1_converter/version.rb +1 -1
data/spec/environment/config.csv +8 -0
data/spec/fixtures/expected.kml +15 -15
data/spec/lib/tf1_converter/config_spec.rb +22 -0
data/spec/lib/tf1_converter/csv_file_spec.rb +15 -7
metadata +6 -4

data/.rspec ADDED Viewed

	@@ -0,0 +1 @@
1	+ --color

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    open_gpx_2_kml (1.0.5)
+    open_gpx_2_kml (1.1.1)
       builder (= 3.1.4)
       geo_swap (= 0.2.1)
       nokogiri (= 1.5.6)

data/example/config.csv CHANGED Viewed

@@ -54,4 +54,12 @@ false
 The color to use if the constant color switch is flipped (must be a key from the colors table)
 CONSTANT_COLOR
-Blue
+Blue
+use 'windows' to make file paths get translated to backslashes
+PLATFORM
+mac
+(use 'ON' to have symbol names output in kmz popups from symbols)
+GE_SYMBOL_NAME
+ON

data/example/windowsconfig.csv CHANGED Viewed

@@ -54,4 +54,12 @@ false
 The color to use if the constant color switch is flipped (must be a key from the colors table)
 CONSTANT_COLOR
-Blue
+Blue
+use 'windows' to make file paths get translated to backslashes
+PLATFORM
+windows
+(use 'ON' to have symbol names output in kmz popups from symbols)
+GE_SYMBOL_NAME
+ON

data/lib/tf1_converter/config.rb CHANGED Viewed

@@ -13,12 +13,21 @@ module TF1Converter
       end
     end
-    %w(icon_path icons colors input output use_constant_color).each do |name|
+    method_names = %w(icon_path icons colors input output use_constant_color platform ge_symbol_name)
+    method_names.each do |name|
       define_singleton_method(name.to_sym) do
         instance_variable_get("@#{name}")
       end
     end
+    def self.is_windows?
+      self.platform == 'WINDOWS'
+    end
+    def self.show_ge_symbol_names?
+      self.ge_symbol_name == 'ON'
+    end
     def self.parse_row(row)
       if @last_key == 'INPUT'
         @input = row[0]
@@ -36,6 +45,10 @@ module TF1Converter
         @use_constant_color = row[0].strip.downcase == 'true'
       elsif @last_key == 'CONSTANT_COLOR'
         @constant_color = row[0]
+      elsif @last_key == 'PLATFORM'
+        @platform = row[0].strip.upcase
+      elsif @last_key == 'GE_SYMBOL_NAME'
+        @ge_symbol_name = row[0].strip.upcase
       end
       if @current_control == 'ICONS'
         if row.compact.empty?

data/lib/tf1_converter/csv_file.rb CHANGED Viewed

@@ -11,11 +11,20 @@ module TF1Converter
       CSV.open(@path, 'wb') do |csv|
         csv << ['filename', 'name', 'meaning', 'time', 'lat', 'long', 'usng', 'elevation']
         @waypoints.each do |wp|
-          csv << [raw_path, wp.name, wp.icon_meaning, wp.timestamp, wp.lat, wp.long, wp.usng, ele_for(wp)]
+          csv << [full_filename, wp.name, wp.icon_meaning, wp.timestamp, wp.lat, wp.long, wp.usng, ele_for(wp)]
         end
       end
     end
+    def full_filename
+      name = CsvFile.translate_filename(@path)
+      if ::TF1Converter::Config.is_windows?
+        name.gsub("/", "\\")
+      else
+        name
+      end
+    end
     def raw_path
       CsvFile.raw_path(@path)
     end

data/lib/tf1_converter/kml/placemark.rb ADDED Viewed

@@ -0,0 +1,51 @@
+module TF1Converter
+  module Kml
+    class Placemark
+      attr_reader :waypoint, :filename
+      def initialize(waypoint, filename)
+        @waypoint = waypoint
+        @filename = filename
+      end
+      def write_to(xml)
+        xml.Placemark do
+          if ::TF1Converter::Config.show_ge_symbol_names?
+            xml.name(waypoint.name)
+          end
+          xml.Snippet(maxLines: '0')
+          xml.Style(id: 'normalPlacemark') do
+            xml.IconStyle do
+              xml.Icon do
+                xml.href("files/#{waypoint.icon_name}")
+              end
+            end
+          end
+          xml.description do
+            xml.cdata description_for(waypoint)
+          end
+          xml.Point do
+            xml.coordinates "#{waypoint.long},#{waypoint.lat}"
+          end
+        end
+      end
+      private
+      def description_for(waypoint)
+        desc = ""
+        desc << waypoint.timestamp
+        desc << '<br>' << waypoint.name
+        desc << '<br>' << waypoint.icon_meaning
+        desc << '<br>' << "Filename: #{filename}"
+        desc << "<br>" << "USNG:  #{waypoint.usng}"
+        desc << "<br>" << "Lat,Long:  #{waypoint.lat},#{waypoint.long}"
+        if waypoint.elevation.is_a? String
+          desc << "<br>" << "Elevation:  #{waypoint.elevation}"
+        end
+        return desc
+      end
+    end
+  end
+end

data/lib/tf1_converter/kml_file.rb CHANGED Viewed

@@ -1,4 +1,5 @@
 require_relative 'kml/track_node'
+require_relative 'kml/placemark'
 module TF1Converter
   class KmlFile
@@ -45,38 +46,11 @@ module TF1Converter
     end
     def write_waypoint_xml(waypoint, xml)
-      xml.Placemark do
-        xml.name(waypoint.name)
-        xml.Snippet(maxLines: '0')
-        xml.Style(id: 'normalPlacemark') do
-          xml.IconStyle do
-            xml.Icon do
-              xml.href("files/#{waypoint.icon_name}")
-            end
-          end
-        end
-        xml.description do
-          xml.cdata description_for(waypoint)
-        end
-        xml.Point do
-          xml.coordinates "#{waypoint.long},#{waypoint.lat}"
-        end
-      end
+      placemark = Kml::Placemark.new(waypoint, @filename)
+      placemark.write_to(xml)
     end
-    def description_for(waypoint)
-      desc = ""
-      desc << waypoint.timestamp
-      desc << '<br>' << waypoint.icon_meaning
-      desc << '<br>' << "Filename: #{@filename}"
-      desc << "<br>" << "USNG:  #{waypoint.usng}"
-      desc << "<br>" << "Lat,Long:  #{waypoint.lat},#{waypoint.long}"
-      if waypoint.elevation.is_a? String
-        desc << "<br>" << "Elevation:  #{waypoint.elevation}"
-      end
-    end
   end
 end

data/lib/tf1_converter/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module TF1Converter
-  VERSION = "1.0.5"
+  VERSION = "1.1.1"
 end

data/spec/environment/config.csv CHANGED Viewed

@@ -58,3 +58,11 @@ Custom 21,22.png,Route Blocked,&22
 Custom 22,23.png,Extra 23,&23
 Custom 23,24.png,Extra 24,&24
 Default,default.png,Default,
+(use 'windows' to make file paths get translated to backslashes)
+PLATFORM
+mac
+(use 'ON' to have symbol names output in kmz popups from symbols)
+GE_SYMBOL_NAME
+ON

data/spec/fixtures/expected.kml CHANGED Viewed

@@ -21,7 +21,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[18-OCT-09 2:17:38PM<br>Search Start<br>Filename: test<br>USNG:  15S WD 60922 8133<br>Lat,Long:  38.9199972,-92.2972443<br>Elevation:  159.7036133]]></description>
+        <description><![CDATA[18-OCT-09 2:17:38PM<br>001<br>Search Start<br>Filename: test<br>USNG:  15S WD 60922 8133<br>Lat,Long:  38.9199972,-92.2972443<br>Elevation:  159.7036133]]></description>
         <Point>
           <coordinates>-92.2972443,38.9199972</coordinates>
         </Point>
@@ -36,7 +36,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[18-OCT-09 2:18:07PM<br>Victim Detected<br>Filename: test<br>USNG:  15S WD 60946 8109<br>Lat,Long:  38.9197762,-92.2969611<br>Elevation:  206.8077393]]></description>
+        <description><![CDATA[18-OCT-09 2:18:07PM<br>002<br>Victim Detected<br>Filename: test<br>USNG:  15S WD 60946 8109<br>Lat,Long:  38.9197762,-92.2969611<br>Elevation:  206.8077393]]></description>
         <Point>
           <coordinates>-92.2969611,38.9197762</coordinates>
         </Point>
@@ -51,7 +51,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[18-OCT-09 2:18:36PM<br>Victim Confirmed<br>Filename: test<br>USNG:  15S WD 60928 8079<br>Lat,Long:  38.9195040,-92.2971813<br>Elevation:  228.6776123]]></description>
+        <description><![CDATA[18-OCT-09 2:18:36PM<br>003<br>Victim Confirmed<br>Filename: test<br>USNG:  15S WD 60928 8079<br>Lat,Long:  38.9195040,-92.2971813<br>Elevation:  228.6776123]]></description>
         <Point>
           <coordinates>-92.2971813,38.9195040</coordinates>
         </Point>
@@ -66,7 +66,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[18-OCT-09 2:19:49PM<br>Collection Point<br>Filename: test<br>USNG:  15S WD 60883 8039<br>Lat,Long:  38.9191455,-92.2977024<br>Elevation:  230.8405762]]></description>
+        <description><![CDATA[18-OCT-09 2:19:49PM<br>004<br>Collection Point<br>Filename: test<br>USNG:  15S WD 60883 8039<br>Lat,Long:  38.9191455,-92.2977024<br>Elevation:  230.8405762]]></description>
         <Point>
           <coordinates>-92.2977024,38.9191455</coordinates>
         </Point>
@@ -81,7 +81,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[18-OCT-09 2:20:33PM<br>Structure Damage / Safe<br>Filename: test<br>USNG:  15S WD 60912 8043<br>Lat,Long:  38.9191831,-92.2973642<br>Elevation:  234.6857910]]></description>
+        <description><![CDATA[18-OCT-09 2:20:33PM<br>005<br>Structure Damage / Safe<br>Filename: test<br>USNG:  15S WD 60912 8043<br>Lat,Long:  38.9191831,-92.2973642<br>Elevation:  234.6857910]]></description>
         <Point>
           <coordinates>-92.2973642,38.9191831</coordinates>
         </Point>
@@ -96,7 +96,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[18-OCT-09 2:21:40PM<br>Criminal Activity<br>Filename: test<br>USNG:  15S WD 60966 8093<br>Lat,Long:  38.9196337,-92.2967348<br>Elevation:  237.3294678]]></description>
+        <description><![CDATA[18-OCT-09 2:21:40PM<br>006<br>Criminal Activity<br>Filename: test<br>USNG:  15S WD 60966 8093<br>Lat,Long:  38.9196337,-92.2967348<br>Elevation:  237.3294678]]></description>
         <Point>
           <coordinates>-92.2967348,38.9196337</coordinates>
         </Point>
@@ -111,7 +111,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[18-OCT-09 2:22:29PM<br>Command Post<br>Filename: test<br>USNG:  15S WD 61002 8066<br>Lat,Long:  38.9193832,-92.2963225<br>Elevation:  239.7326660]]></description>
+        <description><![CDATA[18-OCT-09 2:22:29PM<br>007<br>Command Post<br>Filename: test<br>USNG:  15S WD 61002 8066<br>Lat,Long:  38.9193832,-92.2963225<br>Elevation:  239.7326660]]></description>
         <Point>
           <coordinates>-92.2963225,38.9193832</coordinates>
         </Point>
@@ -126,7 +126,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[18-OCT-09 2:23:14PM<br>Staging Area<br>Filename: test<br>USNG:  15S WD 61033 8055<br>Lat,Long:  38.9192829,-92.2959630<br>Elevation:  239.9730225]]></description>
+        <description><![CDATA[18-OCT-09 2:23:14PM<br>008<br>Staging Area<br>Filename: test<br>USNG:  15S WD 61033 8055<br>Lat,Long:  38.9192829,-92.2959630<br>Elevation:  239.9730225]]></description>
         <Point>
           <coordinates>-92.2959630,38.9192829</coordinates>
         </Point>
@@ -141,7 +141,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[18-OCT-09 2:24:06PM<br>Meaning 19<br>Filename: test<br>USNG:  15S WD 60985 8098<br>Lat,Long:  38.9196773,-92.2965171<br>Elevation:  238.5311279]]></description>
+        <description><![CDATA[18-OCT-09 2:24:06PM<br>009<br>Meaning 19<br>Filename: test<br>USNG:  15S WD 60985 8098<br>Lat,Long:  38.9196773,-92.2965171<br>Elevation:  238.5311279]]></description>
         <Point>
           <coordinates>-92.2965171,38.9196773</coordinates>
         </Point>
@@ -156,7 +156,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[18-OCT-09 2:25:24PM<br>Meaning 16<br>Filename: test<br>USNG:  15S WD 60909 8156<br>Lat,Long:  38.9202020,-92.2973907<br>Elevation:  237.5697021]]></description>
+        <description><![CDATA[18-OCT-09 2:25:24PM<br>010<br>Meaning 16<br>Filename: test<br>USNG:  15S WD 60909 8156<br>Lat,Long:  38.9202020,-92.2973907<br>Elevation:  237.5697021]]></description>
         <Point>
           <coordinates>-92.2973907,38.9202020</coordinates>
         </Point>
@@ -171,7 +171,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[18-OCT-09 2:26:20PM<br>Extra 21<br>Filename: test<br>USNG:  15S WD 60918 8213<br>Lat,Long:  38.9207150,-92.2972759<br>Elevation:  236.1278076]]></description>
+        <description><![CDATA[18-OCT-09 2:26:20PM<br>011<br>Extra 21<br>Filename: test<br>USNG:  15S WD 60918 8213<br>Lat,Long:  38.9207150,-92.2972759<br>Elevation:  236.1278076]]></description>
         <Point>
           <coordinates>-92.2972759,38.9207150</coordinates>
         </Point>
@@ -186,7 +186,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[18-OCT-09 2:26:40PM<br>Extra 22<br>Filename: test<br>USNG:  15S WD 60902 8223<br>Lat,Long:  38.9208083,-92.2974574<br>Elevation:  234.9260254]]></description>
+        <description><![CDATA[18-OCT-09 2:26:40PM<br>012<br>Extra 22<br>Filename: test<br>USNG:  15S WD 60902 8223<br>Lat,Long:  38.9208083,-92.2974574<br>Elevation:  234.9260254]]></description>
         <Point>
           <coordinates>-92.2974574,38.9208083</coordinates>
         </Point>
@@ -201,7 +201,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[18-OCT-09 2:27:10PM<br>Extra 23<br>Filename: test<br>USNG:  15S WD 60880 8191<br>Lat,Long:  38.9205154,-92.2977240<br>Elevation:  235.6469727]]></description>
+        <description><![CDATA[18-OCT-09 2:27:10PM<br>013<br>Extra 23<br>Filename: test<br>USNG:  15S WD 60880 8191<br>Lat,Long:  38.9205154,-92.2977240<br>Elevation:  235.6469727]]></description>
         <Point>
           <coordinates>-92.2977240,38.9205154</coordinates>
         </Point>
@@ -216,7 +216,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[18-OCT-09 2:29:16PM<br>Search Stop<br>Filename: test<br>USNG:  15S WD 60822 8145<br>Lat,Long:  38.9201116,-92.2983951<br>Elevation:  234.6857910]]></description>
+        <description><![CDATA[18-OCT-09 2:29:16PM<br>014<br>Search Stop<br>Filename: test<br>USNG:  15S WD 60822 8145<br>Lat,Long:  38.9201116,-92.2983951<br>Elevation:  234.6857910]]></description>
         <Point>
           <coordinates>-92.2983951,38.9201116</coordinates>
         </Point>
@@ -231,7 +231,7 @@
             </Icon>
           </IconStyle>
         </Style>
-        <description><![CDATA[Weber Home<br>Default<br>Filename: test<br>USNG:  15S WD 60826 8138<br>Lat,Long:  38.9200473,-92.2983507<br>Elevation:  235.8873291]]></description>
+        <description><![CDATA[Weber Home<br>2804 Wild Plum<br>Default<br>Filename: test<br>USNG:  15S WD 60826 8138<br>Lat,Long:  38.9200473,-92.2983507<br>Elevation:  235.8873291]]></description>
         <Point>
           <coordinates>-92.2983507,38.9200473</coordinates>
         </Point>

data/spec/lib/tf1_converter/config_spec.rb CHANGED Viewed

@@ -11,4 +11,26 @@ describe TF1Converter::Config do
     TF1Converter::Config.parse_row(['Blue', nil])
     TF1Converter::Config.colors['Blue'].should_not be_nil
   end
+  it "can load both platforms" do
+    TF1Converter::Config.parse_row(["PLATFORM"])
+    TF1Converter::Config.parse_row(['windows'])
+    TF1Converter::Config.platform.should == "WINDOWS"
+    TF1Converter::Config.is_windows?.should be_true
+    TF1Converter::Config.parse_row(["PLATFORM"])
+    TF1Converter::Config.parse_row(["mac"])
+    TF1Converter::Config.platform.should == "MAC"
+    TF1Converter::Config.is_windows?.should be_false
+  end
+  it 'has a configuration for displaying symbol names in google earth' do
+    TF1Converter::Config.parse_row(["GE_SYMBOL_NAME"])
+    TF1Converter::Config.parse_row(["ON"])
+    TF1Converter::Config.show_ge_symbol_names?.should be_true
+    TF1Converter::Config.parse_row(["GE_SYMBOL_NAME"])
+    TF1Converter::Config.parse_row(["OFF"])
+    TF1Converter::Config.show_ge_symbol_names?.should be_false
+  end
 end

data/spec/lib/tf1_converter/csv_file_spec.rb CHANGED Viewed

@@ -5,25 +5,33 @@ module TF1Converter
   describe CsvFile do
     describe '#to_csv!' do
+      let(:base_path){ '/some/long.path/with.file/test.gpx' }
+      let(:csv) { [] }
+      before do
+        CSV.stub(:open).and_yield(csv)
+      end
       it 'writes waypoints to the csv file' do
         waypoints = [double('waypoint').as_null_object]
-        base_path = '/some/long.path/with.file/test.gpx'
-        csv = []
-        CSV.stub(:open).and_yield(csv)
         CsvFile.new(waypoints, base_path).to_csv!
-        csv[1].first.should == '/some/long.path/with.file/test'
+        csv[1].first.should == '/some/long.path/with.file/test.csv'
       end
       it 'writes a blank string when theres no elevation' do
         waypoint = double('waypoint', elevation: Gpx::Waypoint::NoElevation).as_null_object
         waypoints = [waypoint]
-        base_path = '/some/long.path/with.file/test.gpx'
-        csv = []
-        CSV.stub(:open).and_yield(csv)
         CsvFile.new(waypoints, base_path).to_csv!
         csv[1].last.should == ''
       end
+      it "uses windows separators if the platform is windows" do
+        ::TF1Converter::Config.stub(platform: 'WINDOWS')
+        waypoints = [double('waypoint').as_null_object]
+        CsvFile.new(waypoints, base_path).to_csv!
+        csv[1].first.should == '\some\long.path\with.file\test.csv'
+      end
     end
     describe '.translate_filename' do

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_gpx_2_kml
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.1
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-05-10 00:00:00.000000000 Z
+date: 2013-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -165,6 +165,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rbenv-version
+- .rspec
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -182,6 +183,7 @@ files:
 - lib/tf1_converter/gpx/trackpoint.rb
 - lib/tf1_converter/gpx/waypoint.rb
 - lib/tf1_converter/gpx_file.rb
+- lib/tf1_converter/kml/placemark.rb
 - lib/tf1_converter/kml/track_color.rb
 - lib/tf1_converter/kml/track_node.rb
 - lib/tf1_converter/kml_file.rb
@@ -255,7 +257,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 634324867566425609
+      hash: 1029358299529324430
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -264,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 634324867566425609
+      hash: 1029358299529324430
 requirements: []
 rubyforge_project:
 rubygems_version: 1.8.23