gpx 0.8.3 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 86ad86f9dc972c750fe2c628a6ce7632dcb7c524
-  data.tar.gz: 14a077ee15832b49966d8ce8e502b50ac57b9f15
+SHA256:
+  metadata.gz: b894a8f06a91646472aa6311602be3da1c0d4767a7bc44867ba954ecf93d1909
+  data.tar.gz: 73b5b4e73fb783f3e10a007e2101f49db0e57f48e3675fea7b8255d1a21b84ad
 SHA512:
-  metadata.gz: 2bdd32b6adbe34bb44e46950cbdf702ded02bbb511de2c8e10f2b4a9c43e9eaf0dae9ce1a90e8703e4eaf6a4dc9b541ed649ef77e8d18784ef18504042ce6454
-  data.tar.gz: 01378bd150ca0ada67590425282a50980e5966807c33c30af9f6acd2916154ce690ae515360fb57c6caf5e8624636596bc85926eea13ee6e713775394e2476a2
+  metadata.gz: 279dff5711fc5808537e5e69d9be696dc9439b899021f5ab3a7532a8c68d5c099a40b63fefd89d7ebba1c64c250e599211f4a157028d4f00663b41a77cbf4ae6
+  data.tar.gz: b0c69fe2fa5014edb2e3628fc73b949b1d9fdaad5e73ab7546e7fd74d47c295be5722451cb8cd7cec5ebeb7ba85cc32e9ac38682d9b72b6e223f0b3295e594a1

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+# 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:
+      fail-fast: true
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+
+    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@v1.149.0
+      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

@@ -0,0 +1 @@
+--server

data/.rubocop.yml

@@ -0,0 +1,162 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+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.2.2

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+## [1.1.1] - 2023-05-19
+
+  * updates CI, minimal Ruby version now 2.7, updates tooling like rubocop and GitHub actions
+  * adds support for Ruby 3.2
+  * adds UPGRADING.md to document changes between versions
+
+## [1.1.0] - 2023-05-18
+  * 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
+    dependency.
+
+## [0.8.3] - 2017-01-05
+
+  * Make Track comment and description fields be `attr_accessible` (#17 via
+    @wallclimber21)
+
 ## [0.8.2] - 2015-08-03
 
   * Enhance calculation of average speed (with usage of new

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

@@ -3,10 +3,6 @@
 [<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
@@ -14,14 +10,24 @@ 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 `1.1.1`, `gpx` requires at least Ruby 2.7 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:
+
 ```ruby
 gpx =  GPX::GPXFile.new(:gpx_file => filename)   # Read GPX file
 bounds = GPX::Bounds.new(params)                 # Create a rectangular area to crop
@@ -36,33 +42,44 @@ 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
 #
 # Our active record in this example is called stop
 #
- 
-# models/stop.rb 
+
+# 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 
+     end
      gpx.to_s
    end
  end # class
 
 
 # controllers/stops.rb
-def index 
+def index
    @stops = Stop.all
    respond_to do |format|
     format.html {render :index}
@@ -73,8 +90,8 @@ 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
 ```
@@ -88,13 +105,17 @@ 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.  
+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.  
+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.
+
+## License
+
+MIT

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/UPGRADING.md

@@ -0,0 +1,7 @@
+# Upgrading
+
+You will find all the information you need to upgrade from one version to another here.
+
+## Version 1.0.0 to 1.1.1
+
+Please make sure, that you need at least Ruby 2.7.0 to use this gem now. As support for Ruby versions below 2.7.0 has been dropped.

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,24 +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.7', '< 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.homepage = 'http://www.github.com/dougfales/gpx'
+  s.add_dependency 'nokogiri', '~>1.7'
   s.add_dependency 'rake'
-  s.add_dependency 'nokogiri'
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rubocop'
 end