gpx 0.7 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9b34462ca830301f69200682dfcf151ab8ffb0b
-  data.tar.gz: 5be1f021827ad63d9374fa7aca82a33bbfb0738d
+  metadata.gz: 2d9422311878830d3e5f57b2a671379cc2c5d972
+  data.tar.gz: a08f7e74bb07c826d57fbaf8095c54d6057ab5cf
 SHA512:
-  metadata.gz: df4469f3dae0f31aa753637f6d77f8dc9a45e6f70f419cea351b7976f16297f12fd06fda990ef42025181b497c403aa4e0e3a9911fca64c8ae3401d0a9591383
-  data.tar.gz: 40433303bd14de58e1f9b6c9d5891429d90d71a65b60f8ba8cf00cc01e59c3b55bf50ac9fbff2b9d207603b6b0eb8e9ee65065d8154e45f4a56dc9b0bd79a4c7
+  metadata.gz: 904238365d5532474c876b710dd62a025e211f626e8a95585046d0473e9eb046c191de2c87418a3c59fbf9a047ce6fee67ed514f82f85b81d58ae944262d8436
+  data.tar.gz: e08bde0c7857f130ab3c6ad24a565c922377a5b965fe54b5be4d3af8ec609c1d77af8aeed39ebf7cd31a0d5f9e431b32f447fb11763c4e71e4dd9111658e4711

data/.gitignore

@@ -0,0 +1,3 @@
+tests/output/*
+.*.swp
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - jruby-19mode
+script: "bundle exec rake ci:build"

data/CHANGELOG.md

@@ -0,0 +1,82 @@
+## [0.8.1] - 2015-08-01
+
+  * Added support for a GPX `desc` tag. (@doc75)
+
+## [0.8] - 2015-05-14
+
+### Introduced changes from andrewhao/gpx fork:
+
+  * Fix Rakefiles and move to use Nokigiri (Guillaume Dott)
+  * Fix compatibility with 1.0 GPX schemas (Douglas Robertson)
+  * Added Ruby 2.2 compatibility and GPX track smoothing capabilities
+    (@kbb29)
+  * Adding time to waypoints, restore xmlns:nsi attribute (@merlos)
+  * Refactor distance calculation methods to the TrackPoint (Andrew Hao)
+  * Adding Travis, Code Climate badges.
+
+## [0.7] - 2015-05-09
+
+  * @rb2k: Make tests and code ruby 1.9 compatible (#3)
+    * Switch XML parsing library to hpricot from libxml
+  * @ustas-v: Fix bug #2160. Invalid elevation segment. (#4)
+  * Doug Fales explicitly released this library under MIT license.
+  * Updated changelog and fixing some indentation in waypoint.rb.
+
+## [0.6] - 2010-02-27
+
+	* Putting the gem building stuff into a gemspec.
+	* Fixing some tests since git does not believe in empty directories.
+	* Fixing README formatting.
+	* README edits.
+	* More rdoc tweaks.
+	* Changing README to rdoc ext for github.
+	* Adding the ability to write GPX to a string in addition to a file.  Thanks to Douglas Robertson for the patch.
+	* Adding a patch from Douglas Robertson that allows using version 1.0 of the schema for output.
+
+## [0.5] - 2009-07-07
+
+	* Adding changelog.
+	* Revving to version 0.5.
+	* Changing my contact email address.
+	* Patches from Tom Verbeure (mtbguru.com) to work with libxml-ruby 1.x.
+	* Patch from Kang-min Liu to support speed element.
+
+## [0.4] - 2008-02-19
+
+	* Revving to 0.4.
+	* Adding some new unit tests and fixing several file export bugs reported by Jochen Topf. New unit tests also uncovered a bug where the number of trackpoints reported in a file was twice the actual number.
+
+## [0.3] - 2008-02-11
+
+	* Going to version 0.3.
+	* Updating unit tests in light of recent fixes to routes and waypoints code.
+	* Thanks to Mike Gauland for discovering some route- and waypoint-related bugs.  I've fixed them and also added #to_s on Waypoint so it's easier to debug.
+	* Thanks to Christian Koerner for finding and fixing these bugs in the waypoint code.
+	* Another patch from Gaku Ueda.  This one allows you to pass in a string of GPX data using the :gpx_date => option.  Thanks Gaku!
+
+## [0.2] - 2007-11-30
+
+	* Updating the version #.
+	* Updates courtesy of Gaku Ueda:
+    * Adding support for GPX 1.0 as well as 1.1 (since libxml namespace parsing was hard-coded to 1.1. previously).
+    * Adding a GPX 1.0 unit test file.
+    * Miscellaneous updates to make it work with Ruby 1.8.6.
+	* First stab at using libxml-ruby instead of REXML.  I'm seeing the unit tests finish in under 14 seconds.  That is compared to 2 minutes using REXML. (Doug Fales <doug@falesafeconsulting.com>)
+	* Fixing more nil time exceptions. (Doug Fales <doug@falesafeconsulting.com>)
+	* Fixing an exception in contains_time?. (Doug Fales <doug@falesafeconsulting.com>)
+	* A couple of fixes to make the library comply with the different attribute names possible on the bounds element. (Doug Fales <doug@falesafeconsulting.com>)
+	* Fixing nil time bug. (Doug Fales <doug@falesafeconsulting.com>)
+
+## [0.1] - 2006-10-14
+
+* Initial import of gpx gem. (Doug Fales <doug@falesafeconsulting.com>)
+
+[unreleased]: https://github.com/dougfales/gpx/compare/v0.8...HEAD
+[0.8]: https://github.com/dougfales/gpx/compare/v0.7...v0.8
+[0.7]: https://github.com/dougfales/gpx/compare/v0.6...v0.7
+[0.6]: https://github.com/dougfales/gpx/compare/v0.5...v0.6
+[0.5]: https://github.com/dougfales/gpx/compare/v0.4...v0.5
+[0.4]: https://github.com/dougfales/gpx/compare/v0.3...v0.4
+[0.3]: https://github.com/dougfales/gpx/compare/v0.2...v0.3
+[0.2]: https://github.com/dougfales/gpx/compare/v0.1...v0.2
+[0.1]: https://github.com/dougfales/gpx/commit/371a3fa0b971c9a66c66f941eb4f5c3fa18e424f

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in seryz.gemspec
+gemspec

data/README.md

@@ -0,0 +1,100 @@
+# GPX Gem
+
+[<img src="https://travis-ci.org/dougfales/gpx.svg" alt="Build Status" />](https://travis-ci.org/dougfales/gpx)
+[![Code Climate](https://codeclimate.com/github/dougfales/gpx/badges/gpa.svg)](https://codeclimate.com/github/dougfales/gpx)
+
+Copyright (C) 2006 Doug Fales doug@falesafeconsulting.com 
+
+Released under the MIT License.
+
+## What It Does
+
+This library reads GPX files and provides an API for reading and manipulating
+the data as objects.  For more info on the GPX format, see
+http://www.topografix.com/gpx.asp.
+
+In addition to parsing GPX files, this library is capable of converting
+Magellan NMEA files to GPX, and writing new GPX files.  It can crop and delete
+rectangular areas within a file, and it also calculates some meta-data about
+the tracks and points in a file (such as distance, duration, average speed,
+etc).
+
+## Examples
+
+Reading a GPX file, and cropping its contents to a given area:
+```ruby
+gpx =  GPX::GPXFile.new(:gpx_file => filename)   # Read GPX file
+bounds = GPX::Bounds.new(params)                 # Create a rectangular area to crop
+gpx.crop(bounds)                                 # Crop it
+gpx.write(filename)                              # Save it
+```
+
+Converting a Magellan track log to GPX:
+```ruby
+if GPX::MagellanTrackLog::is_magellan_file?(filename)
+ GPX::MagellanTrackLog::convert_to_gpx(filename, "#{filename}.gpx")
+end
+```
+
+Exporting an ActiveRecord to GPXFile (as Waypoints)
+```ruby
+#
+# Our active record in this example is called stop
+#
+ 
+# models/stop.rb 
+class Stop < ActiveRecord::Base
+   # This model has the following attributes:
+   # name
+   # lat
+   # lon
+   # updated_at
+   
+   def self.to_gpx
+     require 'GPX'
+     gpx = GPX::GPXFile.new
+     all.each do |stop|
+       gpx.waypoints << GPX::Waypoint.new({name: stop.name, lat: stop.lat, lon: stop.lon, time: stop.updated_at})
+     end 
+     gpx.to_s
+   end
+ end # class
+
+
+# controllers/stops.rb
+def index 
+   @stops = Stop.all
+   respond_to do |format|
+    format.html {render :index}
+    format.gpx { send_data @stops.to_gpx, filename: controller_name + '.gpx' }
+   end
+end
+
+
+# Add this line to config/initializers/mime_types.rb
+Mime::Type.register "application/gpx+xml", :gpx
+  
+ 
+# To get the xml file:
+#   http://localhost:3000/stops.gpx
+```
+
+You have a complete example on how to create a gpx file from scratch on `tests/output_text.rb`.
+
+
+## Notes
+
+This library was written to bridge the gap between my Garmin Geko
+and my website, WalkingBoss.org (RIP).  For that reason, it has always been more of a
+work-in-progress than an attempt at full GPX compliance.  The track side of the
+library has seen much more use than the route/waypoint side, so if you're doing
+something with routes or waypoints, you may need to tweak some things.  
+
+Since this code uses XML to read an entire GPX file into memory, it is not
+the fastest possible solution for working with GPX data, especially if you are
+working with tracks from several days or weeks.  
+
+Finally, it should be noted that none of the distance/speed calculation or
+crop/delete code has been tested under International Date Line-crossing
+conditions.  That particular part of the code will likely be unreliable if
+you're zig-zagging across 180 degrees longitude routinely.

data/Rakefile

@@ -1,24 +1,18 @@
-require 'rubygems'
-require 'rake'
+require 'bundler/gem_tasks'
 require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/gempackagetask'
-require File.dirname(__FILE__) + '/lib/gpx'
-
-PKG_VERSION = GPX::VERSION
-PKG_NAME = "gpx"
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-RUBY_FORGE_PROJECT = "gpx"
-RUBY_FORGE_USER = ENV['RUBY_FORGE_USER'] || "dougfales"
-RELEASE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-
-PKG_FILES = FileList[
-    "lib/**/*", "bin/*", "tests/**/*", "[A-Z]*", "Rakefile", "doc/**/*"
-]
+require 'rdoc/task'
 
 desc "Default Task"
 task :default => [ :test ]
 
+namespace :ci do
+  task :build do
+    puts "Creating tests/output directory..."
+    FileUtils.mkdir_p "tests/output"
+    Rake::Task[:test].invoke
+  end
+end
+
 # Run the unit tests
 desc "Run all unit tests"
 Rake::TestTask.new("test") { |t|
@@ -27,12 +21,6 @@ Rake::TestTask.new("test") { |t|
   t.verbose = true
 }
 
-# Make a console, useful when working on tests
-desc "Generate a test console"
-task :console do
-   verbose( false ) { sh "irb -I lib/ -r 'gpx'" }
-end
-
 # Genereate the RDoc documentation
 desc "Create documentation"
 Rake::RDocTask.new("doc") { |rdoc|
@@ -41,12 +29,3 @@ Rake::RDocTask.new("doc") { |rdoc|
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
 }
-
-desc "Report code statistics (KLOCs, etc) from the application"
-task :stats do
-  require 'code_statistics'
-  CodeStatistics.new(
-    ["Library", "lib"],
-    ["Units", "tests"]
-  ).to_s
-end

data/bin/gpx_distance

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+ 
+require File.expand_path('../../lib/gpx', __FILE__)
+
+filename = ARGV[0]
+gpx =  GPX::GPXFile.new(:gpx_file => filename)
+puts "read track with distance #{gpx.distance}"
+
+
+

data/bin/gpx_smooth

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+ 
+require File.expand_path('../../lib/gpx', __FILE__)
+require 'optparse'
+
+
+def str_to_int_or_time(str)
+  if str =~ /\A\d{10}\Z/
+    return Time.at(str.to_i)
+  elsif str =~ /\A\d+\Z/
+    return str.to_i
+  else
+    return DateTime.strptime(str, '%Y%m%d-%H:%M:%S').to_time
+  end
+end
+
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: smooth [options]"
+
+  opts.on("-i", "--input-file FILE", "Input file to read gpx data from (if omitted, data will be read from stdin)") do |v|
+    options[:infile] = v
+  end
+  opts.on("-o", "--output-file FILE", "Output file to write smoothed gpx data to (if omitted, data will be written to stdout)") do |v|
+    options[:outfile] = v
+  end
+  opts.on("-s", "--start-time [YYYYMMDD-HH:MM:SS|EPOCH|OFFSET]", "Start smoothing from time or offset specified (if omitted start from the start of the file)") do |v|
+    options[:start] = v
+  end
+  opts.on("-e", "--end-time [YYYYMMDD-HH:MM:SS|EPOCH|OFFSET]", "Finish smoothing from time or offset specified (if omitted finish at the end of the file)") do |v|
+    options[:end] = v
+  end
+end.parse!
+
+
+if options[:infile]
+  input = File.open(options[:infile])
+else
+  input = $stdin
+end
+
+options[:start] = str_to_int_or_time(options[:start]) if options[:start]
+options[:end] = str_to_int_or_time(options[:end]) if options[:end]
+
+gpx =  GPX::GPXFile.new(:gpx_data => input)
+$stderr.puts "read track with distance #{gpx.distance}"
+
+#1419062980
+gpx.tracks.each do |track|
+  track.segments.each do |segment|
+    segment.smooth_location_by_average({:end => options[:end], :start => options[:start]})
+  end
+end
+gpx.recalculate_distance
+$stderr.puts "smoothed distance #{gpx.distance}"
+
+if options[:outfile]
+  gpx.write(options[:outfile], false)
+else
+  puts gpx.to_s(false)
+end
+

data/gpx.gemspec

@@ -1,16 +1,24 @@
-require './lib/gpx/gpx' # load this just to get GPX::VERSION
-require 'rake'        # For FileList
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gpx/version'
+
 Gem::Specification.new do |s|
   s.name = 'gpx'
   s.version = GPX::VERSION
+  s.authors = ["Guillaume Dott", "Doug Fales", "Andrew Hao"]
+  s.email = ["guillaume+github@dott.fr", "doug.fales@gmail.com", "andrewhao@gmail.com"]
   s.summary = %q{A basic API for reading and writing GPX files.}
   s.description = %q{A basic API for reading and writing GPX files.}
-  s.files = FileList[ "lib/**/*", "bin/*", "tests/**/*", "[A-Z]*", "Rakefile", "doc/**/*" ]
-  s.require_path = 'lib'
+
+  s.files = `git ls-files`.split($/)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
   s.has_rdoc = true
-  s.author = "Doug Fales"
-  s.email = "doug.fales@gmail.com"
-  s.homepage = "http://dougfales.github.com/gpx/"
-  s.rubyforge_project = "gpx"
-  s.add_dependency('hpricot')
+
+  s.homepage = "http://www.github.com/dougfales/gpx"
+  s.add_dependency 'rake'
+  s.add_dependency 'nokogiri'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'minitest'
 end

data/lib/gpx.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006  Doug Fales 
+# Copyright (c) 2006  Doug Fales
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -20,19 +20,19 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
-$:.unshift(File.dirname(__FILE__))
-require 'rubygems'
-require 'hpricot'
-require 'date'
+
 require 'time'
-require 'csv'
-require 'gpx/gpx'
-require 'gpx/gpx_file'
-require 'gpx/bounds'
-require 'gpx/track'
-require 'gpx/route'
-require 'gpx/segment'
-require 'gpx/point'
-require 'gpx/trackpoint'
-require 'gpx/waypoint'
-require 'gpx/magellan_track_log'
+require 'nokogiri'
+
+require File.expand_path('../gpx/version', __FILE__)
+
+require File.expand_path('../gpx/gpx', __FILE__)
+require File.expand_path('../gpx/gpx_file', __FILE__)
+require File.expand_path('../gpx/bounds', __FILE__)
+require File.expand_path('../gpx/track', __FILE__)
+require File.expand_path('../gpx/route', __FILE__)
+require File.expand_path('../gpx/segment', __FILE__)
+require File.expand_path('../gpx/point', __FILE__)
+require File.expand_path('../gpx/trackpoint', __FILE__)
+require File.expand_path('../gpx/waypoint', __FILE__)
+require File.expand_path('../gpx/magellan_track_log', __FILE__)

data/lib/gpx/bounds.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006  Doug Fales 
+# Copyright (c) 2006  Doug Fales
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -21,63 +21,54 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 module GPX
-   class Bounds < Base
-      attr_accessor :min_lat, :max_lat, :max_lon, :min_lon, :center_lat, :center_lon
+  class Bounds < Base
+    attr_accessor :min_lat, :max_lat, :max_lon, :min_lon, :center_lat, :center_lon
 
-      # Creates a new bounds object with the passed-in min and max longitudes
-      # and latitudes.
-      def initialize(opts = { :min_lat => 90.0, :max_lat => -90.0, :min_lon => 180.0, :max_lon => -180.0})
-         @min_lat, @max_lat  = opts[:min_lat].to_f, opts[:max_lat].to_f
-         @min_lon, @max_lon  = opts[:min_lon].to_f, opts[:max_lon].to_f
-      end
+    # Creates a new bounds object with the passed-in min and max longitudes
+    # and latitudes.
+    def initialize(opts = { :min_lat => 90.0, :max_lat => -90.0, :min_lon => 180.0, :max_lon => -180.0})
+      @min_lat, @max_lat  = opts[:min_lat].to_f, opts[:max_lat].to_f
+      @min_lon, @max_lon  = opts[:min_lon].to_f, opts[:max_lon].to_f
+    end
 
-      # Returns the middle latitude.
-      def center_lat
-         distance = (max_lat - min_lat)/2.0
-         (min_lat + distance)
-      end
+    # Returns the middle latitude.
+    def center_lat
+      distance = (max_lat - min_lat)/2.0
+      (min_lat + distance)
+    end
 
-      # Returns the middle longitude.
-      def center_lon
-         distance = (max_lon - min_lon)/2.0
-         (min_lon + distance)
-      end
+    # Returns the middle longitude.
+    def center_lon
+      distance = (max_lon - min_lon)/2.0
+      (min_lon + distance)
+    end
 
-      def to_xml
-         bnd = XML::Node.new('bounds')
-         bnd['minlat'] = min_lat.to_s
-         bnd['minlon'] = min_lon.to_s
-         bnd['maxlat'] = max_lat.to_s
-         bnd['maxlon'] = max_lon.to_s
-         bnd
-      end
+    # Returns true if the pt is within these bounds.
+    def contains?(pt)
+      (pt.lat >=  min_lat and pt.lat <= max_lat and pt.lon >= min_lon and pt.lon <= max_lon)
+    end
 
-      # Returns true if the pt is within these bounds.
-      def contains?(pt)
-         (pt.lat >=  min_lat and pt.lat <= max_lat and pt.lon >= min_lon and pt.lon <= max_lon)
+    # Adds an item to itself, expanding its min/max lat/lon as needed to
+    # contain the given item.  The item can be either another instance of
+    # Bounds or a Point.
+    def add(item)
+      if(item.respond_to?(:lat) and item.respond_to?(:lon))
+        @min_lat = item.lat if item.lat < @min_lat
+        @min_lon = item.lon if item.lon < @min_lon
+        @max_lat = item.lat if item.lat > @max_lat
+        @max_lon = item.lon if item.lon > @max_lon
+      else
+        @min_lat = item.min_lat if item.min_lat < @min_lat
+        @min_lon = item.min_lon if item.min_lon < @min_lon
+        @max_lat = item.max_lat if item.max_lat > @max_lat
+        @max_lon = item.max_lon if item.max_lon > @max_lon
       end
+    end
 
-      # Adds an item to itself, expanding its min/max lat/lon as needed to
-      # contain the given item.  The item can be either another instance of
-      # Bounds or a Point.
-      def add(item)
-         if(item.respond_to?(:lat) and item.respond_to?(:lon))
-            @min_lat = item.lat if item.lat < @min_lat
-            @min_lon = item.lon if item.lon < @min_lon
-            @max_lat = item.lat if item.lat > @max_lat
-            @max_lon = item.lon if item.lon > @max_lon
-         else
-            @min_lat = item.min_lat if item.min_lat < @min_lat
-            @min_lon = item.min_lon if item.min_lon < @min_lon
-            @max_lat = item.max_lat if item.max_lat > @max_lat
-            @max_lon = item.max_lon if item.max_lon > @max_lon
-         end
-      end
-
-      # Returns the min_lat, min_lon, max_lat, and max_lon in a labeled string.
-      def to_s
-         "min_lat: #{min_lat} min_lon: #{min_lon} max_lat: #{max_lat} max_lon: #{max_lon}"
-      end
+    # Returns the min_lat, min_lon, max_lat, and max_lon in a labeled string.
+    def to_s
+      "min_lat: #{min_lat} min_lon: #{min_lon} max_lat: #{max_lat} max_lon: #{max_lon}"
+    end
 
-   end
+  end
 end