simple-trail 0.2.6 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d608b96acfb85c52f3fc307cd4e192323409b9751b0a9cc63a0186aba7e3e000
-  data.tar.gz: 4e93f997eb2729fc3bcb39e0d554febb6414e794fd7c8f5ebdfc4f53769687cc
+  metadata.gz: 80b11153dae6617beaa321a66212e18b3d2f10aa986cbaccc07904faa15be4dd
+  data.tar.gz: a40a3b05bb2538c74f53185b5f2f5addc6932f14708e92d256be68ce26f21f7c
 SHA512:
-  metadata.gz: 1f6d82618ceff0384f5b8238ab571831ba77ef69732a8761ad81e53050c02195349a400259bec1a86f6491a26e0d9ef33b01af5c991193e0956a56cdd10b9bc0
-  data.tar.gz: 98789cedfb83d67f74c11646d021bc2087480ad26a9047f32b45aad271491ca8142cab1540a771ca1540f8905041d91fd722bb75e8dcb4c00f433dfee765dfdd
+  metadata.gz: 138f814cd98017dcd61aef761afc5c4a6ea1c21f426052ca56ed987928ce028e0d6da82e2aa13c2cdc03d41f93b9685fbfb0aa1dafc828b23357a758c8167bd0
+  data.tar.gz: c81fb032d0e916da5624407741055741e50bc955d146b69599ac7a5270787bb41f02c4b7642d966a4e6c1fde8a56defb6134283593b9dedfdfee7410df61e72e

data/lib/simple_trail/parser/base.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Parser
+  class Base
+    
+    private
+
+    def extract_points
+      points_reader = ExtractPoints.new(@parsed_file)
+      points_reader.read_points
+      @points = points_reader.points
+      @simplified_points = points_reader.simplified_points
+    end
+
+    def extract_pois
+      @points_of_interests = @parsed_file[:wpt]
+    end
+
+    def extract_data
+      metadata = @parsed_file[:metadata]
+      {
+        name: metadata[:name],
+        author: metadata[:author][:name]
+      }
+    end
+  end
+end

data/lib/simple_trail/parser/extract_points.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Parser
+  class ExtractPoints
+    attr_reader :simplified_points, :points
+
+    def initialize(parsed_file)
+      @parsed_file = parsed_file
+    end
+
+    def read_points
+      segments = @parsed_file.dig(:trk, :trkseg)
+      @points = segments.is_a?(Array) ? segments.map { |seg| seg[:trkpt] }.flatten : segments[:trkpt]
+      @simplified_points = @points.map { |point| point.select { |key, _| [:lon, :lat].include? key } }
+    end
+  end
+end
+

data/lib/simple_trail/parser/gpx.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Parser
-  class Gpx
+  class Gpx < Base
     attr_reader :simplified_points, :points, :points_of_interests, :parsed_file
 
     def initialize(filename)
@@ -19,25 +19,5 @@ module Parser
     def meta
       @meta ||= extract_data
     end
-
-    private
-
-    def extract_points
-      segments = @parsed_file.dig(:trk, :trkseg)
-      @points = segments.is_a?(Array) ? segments.map { |seg| seg[:trkpt] }.flatten : segments[:trkpt]
-      @simplified_points = @points.map { |point| point.select { |key, _| [:lon, :lat].include? key } }
-    end
-
-    def extract_pois
-      @points_of_interests = @parsed_file[:wpt]
-    end
-
-    def extract_data
-      metadata = @parsed_file[:metadata]
-      {
-        name: metadata[:name],
-        author: metadata[:author][:name]
-      }
-    end
   end
 end

data/lib/simple_trail/parser/gpx_string.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Parser
+  class GpxString < Base
+    attr_reader :simplified_points, :points, :points_of_interests, :parsed_file
+
+    def initialize(file_content)
+      @file_content = file_content
+    end
+
+    def read
+      @parsed_file = XmlHasher.parse(@file_content)[:gpx]
+      fail unless @parsed_file
+      extract_points
+      extract_pois
+    end
+
+    def meta
+      @meta ||= extract_data
+    end
+  end
+end

data/lib/simple_trail/parser/validate_gpx.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Parser
+  class ValidateGpx < Base
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def validate_basics?
+      file = File.new(@filename)
+      @parsed_file = XmlHasher.parse(file)[:gpx]
+
+      !@parsed_file.nil?
+    end
+  end
+end

data/lib/simple_trail/parser/validate_gpx_string.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Parser
+  class ValidateGpxString < Base
+    def initialize(file_content)
+      @file_content = file_content
+    end
+
+    def validate_basics?
+      @parsed_file = XmlHasher.parse(@file_content)[:gpx]
+
+      !@parsed_file.nil?
+    end
+  end
+end

data/lib/simple_trail.rb

@@ -3,7 +3,12 @@
 require 'geokit'
 require 'xmlhasher'
 
+require File.expand_path('simple_trail/parser/base', __dir__)
 require File.expand_path('simple_trail/parser/gpx', __dir__)
+require File.expand_path('simple_trail/parser/gpx_string', __dir__)
+require File.expand_path('simple_trail/parser/extract_points', __dir__)
+require File.expand_path('simple_trail/parser/validate_gpx', __dir__)
+require File.expand_path('simple_trail/parser/validate_gpx_string', __dir__)
 require File.expand_path('simple_trail/manipulation/statistics', __dir__)
 require File.expand_path('simple_trail/manipulation/straightener', __dir__)
 require File.expand_path('simple_trail/manipulation/unifier', __dir__)

data/simple-trail.gemspec

@@ -5,12 +5,13 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = 'simple-trail'
-  s.version     = '0.2.6'
+  s.version     = '0.3.1'
   s.date        = '2020-08-03'
   s.summary     = 'Readind and manipulating GPX and other trail representation file'
   s.description = 'Optimazing and manipulating GPX file data. For my private purposes mostly'
   s.authors     = ['Staszek Zawadzki']
   s.email       = 'st.zawadzki@gmail.com'
+  s.homepage    = 'https://github.com/PadawanBreslau/simple-trail'
 
   s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})

data/spec/examples/not_a_gpx.gpx

@@ -0,0 +1,121 @@
+<?xml version="1.0"?>
+<catalog>
+   <book id="bk101">
+      <author>Gambardella, Matthew</author>
+      <title>XML Developer's Guide</title>
+      <genre>Computer</genre>
+      <price>44.95</price>
+      <publish_date>2000-10-01</publish_date>
+      <description>An in-depth look at creating applications 
+      with XML.</description>
+   </book>
+   <book id="bk102">
+      <author>Ralls, Kim</author>
+      <title>Midnight Rain</title>
+      <genre>Fantasy</genre>
+      <price>5.95</price>
+      <publish_date>2000-12-16</publish_date>
+      <description>A former architect battles corporate zombies, 
+      an evil sorceress, and her own childhood to become queen 
+      of the world.</description>
+   </book>
+   <book id="bk103">
+      <author>Corets, Eva</author>
+      <title>Maeve Ascendant</title>
+      <genre>Fantasy</genre>
+      <price>5.95</price>
+      <publish_date>2000-11-17</publish_date>
+      <description>After the collapse of a nanotechnology 
+      society in England, the young survivors lay the 
+      foundation for a new society.</description>
+   </book>
+   <book id="bk104">
+      <author>Corets, Eva</author>
+      <title>Oberon's Legacy</title>
+      <genre>Fantasy</genre>
+      <price>5.95</price>
+      <publish_date>2001-03-10</publish_date>
+      <description>In post-apocalypse England, the mysterious 
+      agent known only as Oberon helps to create a new life 
+      for the inhabitants of London. Sequel to Maeve 
+      Ascendant.</description>
+   </book>
+   <book id="bk105">
+      <author>Corets, Eva</author>
+      <title>The Sundered Grail</title>
+      <genre>Fantasy</genre>
+      <price>5.95</price>
+      <publish_date>2001-09-10</publish_date>
+      <description>The two daughters of Maeve, half-sisters, 
+      battle one another for control of England. Sequel to 
+      Oberon's Legacy.</description>
+   </book>
+   <book id="bk106">
+      <author>Randall, Cynthia</author>
+      <title>Lover Birds</title>
+      <genre>Romance</genre>
+      <price>4.95</price>
+      <publish_date>2000-09-02</publish_date>
+      <description>When Carla meets Paul at an ornithology 
+      conference, tempers fly as feathers get ruffled.</description>
+   </book>
+   <book id="bk107">
+      <author>Thurman, Paula</author>
+      <title>Splish Splash</title>
+      <genre>Romance</genre>
+      <price>4.95</price>
+      <publish_date>2000-11-02</publish_date>
+      <description>A deep sea diver finds true love twenty 
+      thousand leagues beneath the sea.</description>
+   </book>
+   <book id="bk108">
+      <author>Knorr, Stefan</author>
+      <title>Creepy Crawlies</title>
+      <genre>Horror</genre>
+      <price>4.95</price>
+      <publish_date>2000-12-06</publish_date>
+      <description>An anthology of horror stories about roaches,
+      centipedes, scorpions  and other insects.</description>
+   </book>
+   <book id="bk109">
+      <author>Kress, Peter</author>
+      <title>Paradox Lost</title>
+      <genre>Science Fiction</genre>
+      <price>6.95</price>
+      <publish_date>2000-11-02</publish_date>
+      <description>After an inadvertant trip through a Heisenberg
+      Uncertainty Device, James Salway discovers the problems 
+      of being quantum.</description>
+   </book>
+   <book id="bk110">
+      <author>O'Brien, Tim</author>
+      <title>Microsoft .NET: The Programming Bible</title>
+      <genre>Computer</genre>
+      <price>36.95</price>
+      <publish_date>2000-12-09</publish_date>
+      <description>Microsoft's .NET initiative is explored in 
+      detail in this deep programmer's reference.</description>
+   </book>
+   <book id="bk111">
+      <author>O'Brien, Tim</author>
+      <title>MSXML3: A Comprehensive Guide</title>
+      <genre>Computer</genre>
+      <price>36.95</price>
+      <publish_date>2000-12-01</publish_date>
+      <description>The Microsoft MSXML3 parser is covered in 
+      detail, with attention to XML DOM interfaces, XSLT processing, 
+      SAX and more.</description>
+   </book>
+   <book id="bk112">
+      <author>Galos, Mike</author>
+      <title>Visual Studio 7: A Comprehensive Guide</title>
+      <genre>Computer</genre>
+      <price>49.95</price>
+      <publish_date>2001-04-16</publish_date>
+      <description>Microsoft Visual Studio 7 is explored in depth,
+      looking at how Visual Basic, Visual C++, C#, and ASP+ are 
+      integrated into a comprehensive development 
+      environment.</description>
+   </book>
+</catalog>
+

data/spec/parser/gpx_string_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Parser::GpxString do
+  it 'reads the file' do
+    gpx_parser = described_class.new(File.new('./spec/examples/test_1.gpx').read)
+    expect { gpx_parser.read }.not_to raise_error
+    expect(gpx_parser.parsed_file).not_to be_nil
+  end
+
+  it 'reads metadata' do
+    gpx_parser = described_class.new(File.new('./spec/examples/test_1.gpx').read)
+    gpx_parser.read
+
+    expect(gpx_parser.meta[:author]).to eq 'choosen'
+    expect(gpx_parser.meta[:name]).to eq '06.06.2020 18:56'
+  end
+
+  it 'reads points simplified/all' do
+    gpx_parser = described_class.new(File.new('./spec/examples/test_1.gpx').read)
+    gpx_parser.read
+    expect(gpx_parser.points.size).to eq 190
+    expect(gpx_parser.points.size).to eq gpx_parser.simplified_points.size
+
+    random_index = rand(gpx_parser.points.size)
+    expect(gpx_parser.points[random_index][:lat]).to eq gpx_parser.simplified_points[random_index][:lat]
+    expect(gpx_parser.points[random_index][:lon]).to eq gpx_parser.simplified_points[random_index][:lon]
+  end
+
+  it 'reads file with segments' do
+    gpx_parser = described_class.new(File.new('./spec/examples/test_with_segments.gpx').read)
+    expect { gpx_parser.read }.not_to raise_error
+
+    expect(gpx_parser.points.size).to eq 355
+  end
+end

data/spec/parser/validate_gpx_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Parser::ValidateGpx do
+  it 'validates a proper file' do
+    gpx_validator = described_class.new('./spec/examples/test_1.gpx')
+    expect(gpx_validator.validate_basics?).to be(true)
+  end
+
+  it 'returns false if improper file' do
+    gpx_validator = described_class.new('./spec/examples/not_a_gpx.gpx')
+    expect(gpx_validator.validate_basics?).to be(false)
+  end
+end

data/spec/parser/validate_gpx_string_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Parser::ValidateGpxString do
+  it 'validates the string' do
+    gpx_validator = described_class.new(File.new('./spec/examples/test_1.gpx').read)
+    expect(gpx_validator.validate_basics?).to be(true)
+  end
+
+  it 'returns false if improper file' do
+    gpx_validator = described_class.new(File.new('./spec/examples/not_a_gpx.gpx').read)
+    expect(gpx_validator.validate_basics?).to be(false)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-trail
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.1
 platform: ruby
 authors:
 - Staszek Zawadzki
@@ -96,10 +96,16 @@ files:
 - lib/simple_trail/manipulation/statistics.rb
 - lib/simple_trail/manipulation/straightener.rb
 - lib/simple_trail/manipulation/unifier.rb
+- lib/simple_trail/parser/base.rb
+- lib/simple_trail/parser/extract_points.rb
 - lib/simple_trail/parser/gpx.rb
+- lib/simple_trail/parser/gpx_string.rb
+- lib/simple_trail/parser/validate_gpx.rb
+- lib/simple_trail/parser/validate_gpx_string.rb
 - simple-trail.gemspec
 - spec/examples/gss20-full-official.gpx
 - spec/examples/kbl.gpx
+- spec/examples/not_a_gpx.gpx
 - spec/examples/pois.gpx
 - spec/examples/test-xxl.gpx
 - spec/examples/test_1.gpx
@@ -124,8 +130,11 @@ files:
 - spec/manipulation/unifier_spec.rb
 - spec/parser/gpx_poi_spec.rb
 - spec/parser/gpx_spec.rb
+- spec/parser/gpx_string_spec.rb
+- spec/parser/validate_gpx_spec.rb
+- spec/parser/validate_gpx_string_spec.rb
 - spec/spec_helper.rb
-homepage: 
+homepage: https://github.com/PadawanBreslau/simple-trail
 licenses:
 - MIT
 metadata: {}
@@ -151,6 +160,7 @@ summary: Readind and manipulating GPX and other trail representation file
 test_files:
 - spec/examples/gss20-full-official.gpx
 - spec/examples/kbl.gpx
+- spec/examples/not_a_gpx.gpx
 - spec/examples/pois.gpx
 - spec/examples/test-xxl.gpx
 - spec/examples/test_1.gpx
@@ -175,4 +185,7 @@ test_files:
 - spec/manipulation/unifier_spec.rb
 - spec/parser/gpx_poi_spec.rb
 - spec/parser/gpx_spec.rb
+- spec/parser/gpx_string_spec.rb
+- spec/parser/validate_gpx_spec.rb
+- spec/parser/validate_gpx_string_spec.rb
 - spec/spec_helper.rb