gpx_track_generator 0.0.2 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50267039e5b2ceb53bdfe1e52ffa1df2ae385ebc
-  data.tar.gz: 46e6f3efcae2a0e29354dea99d1a902c35ad09f5
+  metadata.gz: 309023d011ba9d800f4dcba6b64458504364733e
+  data.tar.gz: 19662c2f92a3d3808c75db32de8c3506923d0de7
 SHA512:
-  metadata.gz: 141492a7b81a1bb2c01b0ae16ece91097bca70e4a88e0c05b8efae32aa07182b24ddcfe26eb961736a8f0d583970334bc14c50cf44cea93a514ad8fa0238c5f3
-  data.tar.gz: 7aa28a6ff5ca795fb1624da4e6d11186704ceaaf7977ae0709fac1b416150dc9630c96acef469a7f1cf7f893ea8bb984ca13723807c7a6f8d36814c899da0b61
+  metadata.gz: aa441a132683f9182745f2f294d3e261bb6df16617343db75617dc89a4a1c4415fa9705c5e5b06dee7c1ddf38b9f1d977da8f9577141504a4ca93342916c283b
+  data.tar.gz: 0ba36bfc3b33f2f3aae5b4c3432a3e23afa7d523c0d81aac6e769e53183d3d80f37dd78a2fea1ccf274a89f16e00e423059cdfbc625afdbdb151e5537f39169b

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    gpx_track_generator (0.0.2)
+    gpx_track_generator (0.1.1)
       activesupport
       nokogiri
+      nokogiri-pretty
       thor
 
 GEM
@@ -142,6 +143,8 @@ GEM
     netrc (0.7.7)
     nokogiri (1.6.3.1)
       mini_portile (= 0.6.0)
+    nokogiri-pretty (0.1.0)
+      nokogiri
     parallel (1.2.4)
     parser (2.2.0.pre.4)
       ast (>= 1.1, < 3.0)

data/README.md

@@ -1,6 +1,9 @@
-# GpxTrackGenerator
+# Gpx Track Generator
 
-TODO: Write a gem description
+This gem creates a single gpx track from all given gpx-files. Those files can
+contain route- or track-points. This might be handy if you've got single
+gpx-files for each part of a long distance walk, but don't want to litter your
+gps-device.
 
 ## Installation
 
@@ -18,6 +21,36 @@ Or install it yourself as:
 
 ## Usage
 
+### Ruby
+
+Create your track file from ruby code. This can be helpful in your `Rakefile`.
+
+```ruby
+input_files = %w(track1.gpx route2.gpx)
+track_name  = 'Track ABC'
+output_file = 'my_track.gpx'
+
+GpxTrackGenerator::Api.generate(
+  input_files: input_files,
+  track_name: track_name,
+  output_file: output_file
+)
+```
+
+### CLI
+
+*Create track file*
+
+```
+gpx_track *.gpx
+```
+
+*Define track name*
+
+```
+gpx_track --name "Track Name" *.gpx
+```
+
 TODO: Write usage instructions here
 
 ## Contributing

data/features/create_gpx_track_file.feature

@@ -7,4 +7,34 @@ Feature: Create GPX Track File
     Given a gpx file named "route1.gpx"
     And a gpx file named "route2.gpx"
     When I successfully run `gpx_track g route1.gpx route2.gpx`
-    Then a gpx file named "track.gpx" should exist
+    Then a gpx file named "track.gpx" should exist with "4" track nodes
+
+  Scenario: Create from gpx track files
+    Given a gpx file named "track1.gpx"
+    And a gpx file named "track2.gpx"
+    When I successfully run `gpx_track g track1.gpx track2.gpx`
+    Then a gpx file named "track.gpx" should exist with "4" track nodes
+
+  Scenario: Change output file name
+    Given a gpx file named "track1.gpx"
+    And a gpx file named "track2.gpx"
+    When I successfully run `gpx_track g --file track123.gpx track1.gpx track2.gpx`
+    Then a gpx file named "track123.gpx" should exist
+
+  Scenario: Define name
+    Given a gpx file named "track1.gpx"
+    And a gpx file named "track2.gpx"
+    When I successfully run `gpx_track g --name "My Name" track1.gpx track2.gpx`
+    Then the gpx file "track.gpx" should contain:
+    """
+    <name>My Name</name>
+    """
+
+  Scenario: Default name
+    Given a gpx file named "track1.gpx"
+    And a gpx file named "track2.gpx"
+    When I successfully run `gpx_track g track1.gpx track2.gpx`
+    Then the gpx file "track.gpx" should contain:
+    """
+    <name>Track #1</name>
+    """

data/features/step_definitions.rb

@@ -22,6 +22,17 @@ Given(/^a gpx file named "(.*?)"$/) do |file|
   end
 end
 
-Then(/^a gpx file named "(.*?)" should exist$/) do |file|
+Then(/^the gpx file named "(.*?)" should have "(.*?)" track nodes$/) do |file, count|
+  in_current_dir do
+    expect(Nokogiri::XML(File.open(file)).css('trkpt').to_a.size).to eq count.to_i
+  end
+end
+
+Then(/^a gpx file named "(.*?)" should exist(?: with "(.*?)" track nodes)?$/) do |file, count|
   step %(a file named "#{file}" should exist)
+  step %(the gpx file named "#{file}" should have "#{count}" track nodes) if count
+end
+
+Then(/^the gpx file "(.*?)" should contain:$/) do |file, content|
+  step %(the file "#{file}" should contain:), content
 end

data/fixtures/track1.gpx

@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<gpx version="1.0" creator="Example.com"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xmlns="http://www.topografix.com/GPX/1/0"
+xsi:schemaLocation="http://www.topografix.com/GPX/1/0 http://www.topografix.com/GPX/1/0/gpx.xsd">
+<trk>
+  <name>Track 1</name>
+  <trkseg>
+  <trkpt lat="55.688634024660372" lon="-5.5744374090151107">
+    <name>WPT 1</name>
+    <ele>15.232316396783801</ele>
+  </trkpt>
+  <trkpt lat="57.688634024660372" lon="-5.5744374090151107">
+    <name>WPT 1</name>
+    <ele>15.232316396783801</ele>
+  </trkpt>
+  </trkseg>
+</trk>

data/fixtures/track2.gpx

@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<gpx version="1.0" creator="Example.com"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xmlns="http://www.topografix.com/GPX/1/0"
+xsi:schemaLocation="http://www.topografix.com/GPX/1/0 http://www.topografix.com/GPX/1/0/gpx.xsd">
+<trk>
+  <name>Track 2</name>
+  <trkseg>
+  <trkpt lat="56.688634024660372" lon="-6.5744374090151107">
+    <name>WPT 1</name>
+    <ele>16.232316396783801</ele>
+  </trkpt>
+  <trkpt lat="57.688634024660372" lon="-6.5744374090151107">
+    <name>WPT 1</name>
+    <ele>16.232316396783801</ele>
+  </trkpt>
+  </trkseg>
+</trk>

data/gpx_track_generator.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'nokogiri'
+  spec.add_runtime_dependency 'nokogiri-pretty'
   spec.add_runtime_dependency 'thor'
   spec.add_runtime_dependency 'activesupport'
 end

data/lib/gpx_track_generator/api.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+module GpxTrackGenerator
+  # Main api
+  module Api
+    def self.generate(input_files:, track_name:, output_file:)
+      files = input_files.map { |f| GpxFile.new(File.expand_path(f)) }
+      track = Track.new(files, name: track_name)
+
+      File.write(output_file, track.to_s)
+    end
+  end
+end

data/lib/gpx_track_generator/gpx_file.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+module GpxTrackGenerator
+  # A gpx file
+  class GpxFile
+    private
+
+    attr_reader :path
+
+    public
+
+    def initialize(path)
+      @path = path
+    end
+
+    # Return nodes
+    def nodes
+      document = Nokogiri::XML('')
+      node_set = Nokogiri::XML::NodeSet.new(document)
+
+      node_set += extract_route_nodes unless extract_route_nodes.empty?
+      node_set += extract_track_nodes unless extract_track_nodes.empty?
+
+      node_set.css('trkpt').each_with_index { |e, i| e.css('name').first.content = "WP #{i + 1}" }
+
+      node_set
+    end
+
+    # Return file name
+    def file_name
+      File.basename(path)
+    end
+
+    private
+
+    def extract_route_nodes
+      node_set = Nokogiri::XML(File.open(path)).remove_namespaces!.css('rtept')
+      node_set.each { |n| n.name = 'trkpt' }
+
+      node_set
+    end
+
+    def extract_track_nodes
+      node_set = Nokogiri::XML(File.open(path)).remove_namespaces!.css('trkpt')
+      node_set.each { |n| n.name = 'trkpt' }
+
+      node_set
+    end
+  end
+end

data/lib/gpx_track_generator/runner.rb

@@ -3,12 +3,12 @@ module GpxTrackGenerator
   # Runner
   class Runner < Thor
     option :file, default: 'track.gpx', desc: 'GPX track file name'
+    option :name, default: 'Track #1', required: true, desc: 'Name for track'
+    argument :input_files, type: :array, desc: 'GPX track or route files'
+
     desc 'generate', 'Generate gpx track'
-    argument :gpx_files, type: :array, desc: 'GPX track or route files'
     def generate
-      track = Track.new(gpx_files.map { |f| File.expand_path f })
-
-      File.write(options[:file], track.to_s)
+      Api.generate(input_files: input_files, track_name: options[:name], output_file: options[:file])
     end
 
     default_command :generate

data/lib/gpx_track_generator/track.rb

@@ -4,12 +4,13 @@ module GpxTrackGenerator
   class Track
     private
 
-    attr_reader :files
+    attr_reader :files, :name
 
     public
 
-    def initialize(files)
+    def initialize(files, name:)
       @files = files
+      @name = name
     end
 
     def to_s
@@ -18,25 +19,34 @@ module GpxTrackGenerator
 
     private
 
+    def creator
+      'gpx_track_generator'
+    end
+
+    def creator_url
+      'https://github.com/maxmeyer/gpx_track_generator'
+    end
+
     def build_document
       document.child << metadata
+
       document.child << document.create_element('trk')
+      document.css('trk').first << document.create_element('name')
+      document.css('name').first.content = name
 
       files.each_with_object(document.css('trk').first) do |e, a|
+        a << "<!-- #{e.file_name} -->"
         a << document.create_element('trkseg')
-        node_set = Nokogiri::XML(File.open(e)).remove_namespaces!.css('rtept')
-        node_set.each { |n| n.name = 'trkpt' }
-
-        a.css('trkseg').last << node_set
+        a.css('trkseg').last << e.nodes
       end
 
-      document.to_s
+      document.human
     end
 
     def document
       @document ||= Nokogiri::XML(
       <<-EOS.strip_heredoc
-    <gpx xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" version="1.1" creator="Nokogiri" xmlns="http://www.topografix.com/GPX/1/1"></gpx>
+    <gpx xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" version="1.1" creator="#{creator}" xmlns="http://www.topografix.com/GPX/1/1"></gpx>
       EOS
       )
     end
@@ -44,9 +54,9 @@ module GpxTrackGenerator
     def metadata
       @metadata ||= Nokogiri::XML::DocumentFragment.parse <<-EOS.strip_heredoc
       <metadata>
-        <desc>GPX file generated nokogiri</desc>
-        <link href="http://nokogiri.org/">
-          <text>Nokogiri</text>
+        <desc>GPX file generated by #{creator}</desc>
+        <link href="#{creator_url}">
+          <text>#{creator}</text>
         </link>
         <time>#{Time.now}</time>
       </metadata>

data/lib/gpx_track_generator/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 # GpxTrackGenerator
 module GpxTrackGenerator
-  VERSION = '0.0.2'
+  VERSION = '0.1.1'
 end

data/lib/gpx_track_generator.rb

@@ -2,10 +2,13 @@ require 'thor'
 require 'nokogiri'
 require 'thor/actions'
 require 'active_support/core_ext/string/strip'
+require 'nokogiri-pretty'
 
 require 'gpx_track_generator/version'
+require 'gpx_track_generator/gpx_file'
 require 'gpx_track_generator/runner'
 require 'gpx_track_generator/track'
+require 'gpx_track_generator/api'
 
 # Track generator
 module GpxTrackGenerator

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gpx_track_generator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.1
 platform: ruby
 authors:
 - Max Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-28 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri-pretty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -87,8 +101,12 @@ files:
 - features/support/reporting.rb
 - fixtures/route1.gpx
 - fixtures/route2.gpx
+- fixtures/track1.gpx
+- fixtures/track2.gpx
 - gpx_track_generator.gemspec
 - lib/gpx_track_generator.rb
+- lib/gpx_track_generator/api.rb
+- lib/gpx_track_generator/gpx_file.rb
 - lib/gpx_track_generator/runner.rb
 - lib/gpx_track_generator/track.rb
 - lib/gpx_track_generator/version.rb