gps2map 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3cc4350e15d0c62b55fb807c3a703fb0962d70f5077a6f016fe4cc5bee6be5f2
+  data.tar.gz: b5c53b6993f76aa8ed70fdeabc299afa03d1983520116ab8631e23cb889a2c83
+SHA512:
+  metadata.gz: a3993f4856b452e7bfdc2d19eebf8a02a5c958c5c35a7fda2efb7e3d00ffcf2b26448528c17da9973474b1a41e44e376555357b62beca4fc4e3354a4c9d79679
+  data.tar.gz: f801917602ccee3872e8cff9862a65f60c8068f309a885c2b2e66c8a4bbe80084f73c01ce80304c6edf7ce1b043467d1e81166f2d232a44ef178d5c837b66328

data/README.md

@@ -0,0 +1,21 @@
+# GPS2Map
+Creates a Google Map from an input file containing GPS co-ordinates ([GPX](https://en.wikipedia.org/wiki/GPS_Exchange_Format), [KML](https://en.wikipedia.org/wiki/Keyhole_Markup_Language) or [TCX](https://en.wikipedia.org/wiki/Training_Center_XML) format).
+
+## Installation
+```
+$ gem install gps2map
+```
+
+## Prerequisites
+A [Google Maps JavaScript API key](https://developers.google.com/maps/documentation/javascript/get-api-key) is required and must be specified in an environment variable named `GOOGLE_MAPS_API_KEY`.
+
+## Usage
+```
+gps2map generate <input.gpx|.kml|.tcx> <output.html>
+```
+
+## Licence
+The gem is available as open source under the terms of the [MIT Licence](https://opensource.org/licenses/MIT).
+
+## Copyright
+Copyright (C) 2018 John Topley.

data/bin/gps2map

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'gps2map'
+
+GPS2Map::GPS2Map.start(ARGV)

data/lib/core_ext/integer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Open up the Integer class to add a formatting method.
+class Integer
+  def to_comma_formatted
+    to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, '\\1,')
+  end
+end

data/lib/gps2map/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GPS2Map
+  VERSION = '1.0.0'
+end

data/lib/gps2map.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'open-uri'
+require 'ostruct'
+require 'thor'
+require 'erb'
+require 'csv'
+
+require_relative 'core_ext/integer'
+require_relative 'gps2map/version'
+
+# Namespace all the gem code.
+module GPS2Map
+  DIGITS          = 6
+  LATITUDE_OFFSET = 0.005000
+  MARKERS         = 15
+
+  Coordinate = Struct.new(:latitude, :longitude)
+  Marker     = Struct.new(:latitude, :longitude, :label)
+
+  # Class that takes an input file containing GPS co-ordinates and outputs an HTML file containing a
+  # Google Map of those co-ordinates.
+  class GPS2Map < Thor
+    desc 'generate <input.gpx|.kml|.tcx> <output.html>', 'Generates a Google Map from an input file'
+    option :markers, type: :numeric, default: MARKERS, desc: 'The number of markers to plot on the map'
+    def generate(input_file, output_file)
+      vars           = {}
+      vars[:api_key] = ENV['GOOGLE_MAPS_API_KEY'] || abort('No GOOGLE_MAPS_API_KEY provided.')
+      vars[:title]   = input_file
+      coordinates    = []
+      markers        = []
+      label          = 0
+      latitudes, longitudes = parse_file(input_file)
+      interval = latitudes.length / options[:markers]
+
+      latitudes.each_with_index do |latitude, i|
+        longitude = longitudes[i]
+        coordinates << Coordinate.new(latitude, longitude)
+        markers << Marker.new(latitude, longitude, label += 1) if i > 1 && (i % interval).zero?
+      end
+
+      vars[:coordinates]     = coordinates
+      vars[:markers]         = markers
+      vars[:map_centre_lat]  = mean_of(coordinates.map(&:latitude)) + LATITUDE_OFFSET
+      vars[:map_centre_long] = mean_of(coordinates.map(&:longitude))
+      vars[:map_start_lat]   = coordinates.first.latitude
+      vars[:map_start_long]  = coordinates.first.longitude
+      write_output_file(output_file, execute_template(vars))
+      puts "Plotted #{latitudes.length.to_comma_formatted} co-ordinates with #{markers.length} markers."
+    end
+
+    private
+
+    def execute_template(variables)
+      template = File.join(__dir__, 'map.erb')
+      context = OpenStruct.new(variables).instance_eval { binding }
+      # Set the ERB trim mode to suppress newlines.
+      ERB.new(File.read(template), 0, '>').result(context)
+    end
+
+    def mean_of(coordinates)
+      coordinates.sum.fdiv(coordinates.length).round(DIGITS)
+    end
+
+    def parse_file(input_file)
+      case File.extname(input_file).downcase
+      when '.gpx'
+        parse_gpx(input_file)
+      when '.kml'
+        parse_kml(input_file)
+      when '.tcx'
+        parse_tcx(input_file)
+      end
+    end
+
+    def parse(input_file, selector)
+      File.open(input_file, 'r') do |fi|
+        doc = Nokogiri::XML(fi)
+        doc.css(selector).each { |el| yield(el) }
+      end
+    end
+
+    def parse_gpx(input_file)
+      latitudes  = []
+      longitudes = []
+      parse(input_file, 'trkpt') do |el|
+        latitudes  << el['lat'].to_f.round(DIGITS)
+        longitudes << el['lon'].to_f.round(DIGITS)
+      end
+      [latitudes, longitudes]
+    end
+
+    def parse_kml(input_file)
+      latitudes  = []
+      longitudes = []
+      parse(input_file, 'Point coordinates') do |el|
+        # KML has longitude first.
+        longitudes << CSV.parse(el.text.strip).first.first.to_f.round(DIGITS)
+        latitudes  << CSV.parse(el.text.strip).first[1].to_f.round(DIGITS)
+      end
+      [latitudes, longitudes]
+    end
+
+    def parse_tcx(input_file)
+      latitudes  = []
+      longitudes = []
+      File.open(input_file, 'r') do |fi|
+        doc = Nokogiri::XML(fi)
+        doc.css('LatitudeDegrees').each { |el| latitudes << el.text.to_f.round(DIGITS) }
+        doc.css('LongitudeDegrees').each { |el| longitudes << el.text.to_f.round(DIGITS) }
+      end
+      [latitudes, longitudes]
+    end
+
+    def write_output_file(output_file, data)
+      File.open(output_file, 'w') { |fi| fi.write(data) }
+    end
+  end
+end

data/lib/map.erb

@@ -0,0 +1,59 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= title %></title>
+    <meta name="viewport" content="initial-scale=1.0">
+    <meta charset="utf-8">
+    <style>
+      /* Always set the map height explicitly to define the size of the div
+       * element that contains the map. */
+      #map {
+        height: 100%;
+      }
+      /* Optional: Makes the sample page fill the window. */
+      html, body {
+        height: 100%;
+        margin: 0;
+        padding: 0;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="map"></div>
+    <script>
+      var map;
+      function initMap() {
+        map = new google.maps.Map(document.getElementById('map'), {
+          center: { lat: <%= map_centre_lat %>, lng: <%= map_centre_long %> },
+          zoom: 12
+        });
+        var coordinates = [
+          <% coordinates.each do |coordinate| %>
+            { lat: <%= coordinate.latitude %>, lng: <%= coordinate.longitude %> },
+          <% end %>
+        ];
+        var polyline = new google.maps.Polyline({
+            path: coordinates,
+            geodesic: true,
+            strokeColor: '#0088FF',
+            strokeOpacity: 0.6,
+            strokeWeight: 6
+        });
+        polyline.setMap(map);
+        var flagMarker = new google.maps.Marker({
+          position: { lat: <%= map_start_lat %>, lng: <%= map_start_long %>},
+          map: map,
+          icon: 'https://developers.google.com/maps/documentation/javascript/examples/full/images/beachflag.png'
+        });
+        <% markers.each do |marker| %>
+        new google.maps.Marker({
+          position: { lat: <%= marker.latitude %>, lng: <%= marker.longitude %> },
+          map: map,
+          label: '<%= marker.label %>'
+        });
+        <% end %>
+      }
+    </script>
+    <script src="https://maps.googleapis.com/maps/api/js?key=<%= api_key %>&callback=initMap" async defer></script>
+  </body>
+</html>

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: gps2map
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- John Topley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+description: 'Creates a Google Map from an input file containing GPS co-ordinates
+  (GPX, KML or TCX format).
+
+'
+email: john@johntopley.com
+executables:
+- gps2map
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/gps2map
+- lib/core_ext/integer.rb
+- lib/gps2map.rb
+- lib/gps2map/version.rb
+- lib/map.erb
+homepage: https://github.com/johntopley/gps2map
+licenses:
+- MIT
+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.7.5
+signing_key: 
+specification_version: 4
+summary: Creates a Google Map from an input file
+test_files: []