gpx 0.9.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 77fe925f54ad3eb792f09dc5ac6eba67e39052c9
-  data.tar.gz: f7a763dd97b5f38921254ae6d3ffaae2ce3d3fe8
+SHA256:
+  metadata.gz: f206f4729605d96cdaf65fe3fe52237c14f61eb1ae69558eb826c6f831e4076b
+  data.tar.gz: b05a8fd9d66446f57640474b3dad428b5eab24617b2e0cb3b19e655d079ea0d6
 SHA512:
-  metadata.gz: 442bb28b647d15cbb22fc9fe79aabb9ebcf37c2ae30b9dc510573b88f8d8867f693484d00ab2495820c74d892abc3be062e6bc5bd1b548504fb72b1ad36635ea
-  data.tar.gz: b9f1a61107b41768feee72c1aeb89b2cac7758a112576095f62f2cfe70947e680796a46b75999e61e33c69876b03c508d785a700649dca3b9cf71e85b127b469
+  metadata.gz: 28c8c86253452eb56383790c43189de24929482781b5d94ac9416ab93be596fbbe5259e0226a18bbb7e44070503d6b721671bff2b239a5512a935fcb21dbc19f
+  data.tar.gz: be64658d5bf4cf3d7653b2457f286401971d3a7a272766002d78296341eedd2c4ad237dc5ac38d38debe7dd7288275185b6ac27bef99460d250c2e62bd3d9c5b

data/.github/workflows/ruby.yml

@@ -0,0 +1,36 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@f0971f0dd45a5cbb3f119f7db77cc58057c53530
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -1,3 +1,7 @@
 tests/output/*
 .*.swp
 Gemfile.lock
+pkg
+
+# RubyMine files
+/.idea

data/.rubocop.yml

@@ -0,0 +1,162 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylealias
+
+Style/AsciiComments:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleasciicomments
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleblockdelimiters
+
+Style/CommentAnnotation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylecommentannotation
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledocumentation
+
+Layout/DotPosition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#layoutdotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedwhile
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelinemethods
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#layoutspacebeforeblockbraces
+
+Layout/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#layoutspaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylestringliterals
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Style/WordArray:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewordarray
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Style/DateTime:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3.3
-  - 2.4.0
-script: "bundle exec rake ci:build"
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
+#  - 3.1 # Not supported by Travis yet as of 2021-12-29
+script: "bundle exec rake"

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [1.1.0] - 202
+  * Specify UTF-8 encoding for XML encoding (#35 via @sh1nduu)
+  * Added GeoJSON conversion (#38 via @tyrauber and @niborg)
+  * Support Ruby 3 (#43 via @LocoDelAssembly)
+  * Fix nil-to-Time comparison (#46 via @frodrigo)
+  * Fix bug when <rte> GPX file does not specify <name> tag (#41 via @niborg)
+  * Drop Ruby 2.5 and 2.6 from CI (#50 via @niborg)
+## [1.0.0] - 2018-03-06
+
+  * Fix duplication of points on appending segment to track (#20 via @niborg)
+  * Remove pythagorean distance (#28 fixing #27, via @moveson)
+  * Ignore empty segments (#29 via @nathanvda)
+  * Introduce Rubocop (#31)
+  * Explicit test support for Ruby 2.5 (#30)
+
 ## [0.9.0] - 2017-01-05
 
   * Upgrade Nokogiri deps to be more explicit, then explicitly bump the Ruby

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in seryz.gemspec

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) [year] [fullname]
+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 "Software"), to deal

data/README.md

@@ -10,15 +10,19 @@ 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).
+Magellan NMEA files to GPX, converting GeoJSON data 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).
 
 ## Requirements
 
-As of `0.9.0`, `gpx` requires at least Ruby 2.1 to run.
+As of `1.0.0`, `gpx` requires at least Ruby 2.2 to run.
 
+## Installation
+Add to your gemfile:
+```
+gem 'gpx'
+```
 ## Examples
 
 Reading a GPX file, and cropping its contents to a given area:
@@ -37,6 +41,17 @@ if GPX::MagellanTrackLog::is_magellan_file?(filename)
 end
 ```
 
+Converting GeoJSON data to GPX can be achieved by providing a
+file path, file, or the data in string format:
+```ruby
+# Converting from a file name
+gpx_file = GPX::GeoJSON.convert_to_gpx(geojson_file: 'mygeojsonfile.json')
+
+# Converting from a string
+data = JSON.generate(my_geojson_hash)
+gpx_file = GPX::GeoJSON.convert_to_gpx(geojson_data: data)
+```
+
 Exporting an ActiveRecord to GPXFile (as Waypoints)
 ```ruby
 #

data/Rakefile

@@ -1,31 +1,41 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rdoc/task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
 
-desc "Default Task"
-task :default => [ :test ]
+desc 'Default Task'
+task default: %i[test rubocop]
 
 namespace :ci do
   task :build do
-    puts "Creating tests/output directory..."
-    FileUtils.mkdir_p "tests/output"
+    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|
-  t.libs << "lib"
+desc 'Run all unit tests'
+Rake::TestTask.new('test') do |t|
+  t.libs << 'lib'
   t.pattern = 'tests/*_test.rb'
   t.verbose = true
-}
+end
 
 # Genereate the RDoc documentation
-desc "Create documentation"
-Rake::RDocTask.new("doc") { |rdoc|
-  rdoc.title = "Ruby GPX API"
+desc 'Create documentation'
+Rake::RDocTask.new('doc') do |rdoc|
+  rdoc.title = 'Ruby GPX API'
   rdoc.rdoc_dir = 'html'
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
-}
+end
+
+desc 'open an irb session preloaded with this gem'
+task :console do
+  sh 'irb -r pp -r ./lib/gpx.rb'
+end

data/bin/gpx_distance

@@ -1,10 +1,9 @@
 #!/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}"
 
+# frozen_string_literal: true
 
+require File.expand_path('../lib/gpx', __dir__)
 
+filename = ARGV[0]
+gpx = GPX::GPXFile.new(gpx_file: filename)
+puts "read track with distance #{gpx.distance}"

data/bin/gpx_smooth

@@ -1,63 +1,62 @@
 #!/usr/bin/env ruby
- 
-require File.expand_path('../../lib/gpx', __FILE__)
-require 'optparse'
 
+# frozen_string_literal: true
+
+require File.expand_path('../lib/gpx', __dir__)
+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
+  case str
+  when /\A\d{10}\Z/
+    Time.at(str.to_i)
+  when /\A\d+\Z/
+    str.to_i
   else
-    return DateTime.strptime(str, '%Y%m%d-%H:%M:%S').to_time
+    DateTime.strptime(str, '%Y%m%d-%H:%M:%S').to_time
   end
 end
 
-
 options = {}
 OptionParser.new do |opts|
-  opts.banner = "Usage: smooth [options]"
+  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|
+  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|
+  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|
+  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|
+  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
+input = if options[:infile]
+          File.open(options[:infile])
+        else
+          $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}"
+gpx = GPX::GPXFile.new(gpx_data: input)
+warn "read track with distance #{gpx.distance}"
 
-#1419062980
+# 1419062980
 gpx.tracks.each do |track|
   track.segments.each do |segment|
-    segment.smooth_location_by_average({:end => options[:end], :start => options[:start]})
+    segment.smooth_location_by_average(end: options[:end], start: options[:start])
   end
 end
 gpx.recalculate_distance
-$stderr.puts "smoothed distance #{gpx.distance}"
+warn "smoothed distance #{gpx.distance}"
 
 if options[:outfile]
   gpx.write(options[:outfile], false)
 else
   puts gpx.to_s(false)
 end
-

data/gpx.gemspec

@@ -1,26 +1,27 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $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.authors = ['Guillaume Dott', 'Doug Fales', 'Andrew Hao']
+  s.email = ['guillaume+github@dott.fr', 'doug.fales@gmail.com', 'andrewhao@gmail.com']
+  s.summary = 'A basic API for reading and writing GPX files.'
+  s.description = 'A basic API for reading and writing GPX files.'
 
-  s.required_ruby_version = '~>2.1'
+  s.required_ruby_version = '>= 2.5', '< 4'
 
-  s.files = `git ls-files`.split($/)
+  s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ["lib"]
-  s.has_rdoc = true
+  s.require_paths = ['lib']
 
-  s.homepage = "http://www.github.com/dougfales/gpx"
-  s.add_dependency 'rake'
+  s.homepage = 'http://www.github.com/dougfales/gpx'
   s.add_dependency 'nokogiri', '~>1.7'
+  s.add_dependency 'rake'
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rubocop'
 end

data/lib/gpx/bounds.rb

@@ -1,58 +1,41 @@
-#--
-# 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
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
+# frozen_string_literal: true
+
 module GPX
   class Bounds < Base
-    attr_accessor :min_lat, :max_lat, :max_lon, :min_lon, :center_lat, :center_lon
+    attr_accessor :min_lat, :max_lat, :max_lon, :min_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
+    def initialize(opts = { min_lat: 90.0, max_lat: -90.0, min_lon: 180.0, max_lon: -180.0 })
+      super()
+      @min_lat = opts[:min_lat].to_f
+      @max_lat = opts[:max_lat].to_f
+      @min_lon = opts[:min_lon].to_f
+      @max_lon = opts[:max_lon].to_f
     end
 
     # Returns the middle latitude.
     def center_lat
-      distance = (max_lat - min_lat)/2.0
+      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
+      distance = (max_lon - min_lon) / 2.0
       (min_lon + distance)
     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)
+      ((pt.lat >= min_lat) && (pt.lat <= max_lat) && (pt.lon >= min_lon) && (pt.lon <= max_lon))
     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))
+      if item.respond_to?(:lat) && 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
@@ -69,6 +52,5 @@ module GPX
     def to_s
       "min_lat: #{min_lat} min_lon: #{min_lon} max_lat: #{max_lat} max_lon: #{max_lon}"
     end
-
   end
 end