gpx_track 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa9f853406843a0cde03333879fbf1af4572cbe5
-  data.tar.gz: a2015d8bafd5bb029f6af731657ad5274112c3f7
+  metadata.gz: d47aea20143f27cbd7ad88244d1c64a2d05316f7
+  data.tar.gz: de1a1003bbe17086ba9d82e5f14147ff48c7a962
 SHA512:
-  metadata.gz: 9d772909f9896f1ba4a24ba0df340d59c1816a3cb9bd42a00423f2cc5aa9f9665dc68b8cb9fffa5f79644365f35fbe1a0a0244c2b5f8578c060777f637e2d9a5
-  data.tar.gz: 0008564066046f99ee8f0e23f98e904cae286b76f0bb9d8088fb4c914eedc52cdad119680b24803e1cb99b2df25e075f21cb47fce82a84db42ae9552142681e4
+  metadata.gz: 6a2548e0c4444ac6d17804624647e84b4eef1e1f624894ef85493cbf544fcb6d1a76a6e1c0022e5a06fac3893a3d9865d4429b12505861a7b0ed9cb52c7cc7cd
+  data.tar.gz: 0c1454faffd3e4b08edb2dab88d7a623075435059ec26922542286a2ed9afbc85dbcaefa3bae29e7d740f932cee74545725af0a74a5ec95d7c73f8a3268acad5

data/.gitignore

@@ -16,6 +16,5 @@ test/tmp
 test/version_tmp
 tmp
 
-
 #OSX
 .DS_Store

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0-p247
+2.0.0-p247

data/.simplecov

@@ -1,4 +1,5 @@
 SimpleCov.minimum_coverage 90
 SimpleCov.start do
   add_filter "/spec/"
-end
+  add_filter ".bundle"
+end

data/README.md

@@ -26,11 +26,14 @@ Or install it yourself as:
     
     gpx.points_count    # get count of track points
     
-    gpx.times.last[:t]  # get track length
+    gpx.duration        # get track duration [s]
+    gpx.length          # get track length [km]
+    
+    gpx.times[n][:t]    # get time delta for n-th and n-1-th track point
     gpx.times[n][:dt]   # get time delta for n-th and n-1-th track point
     
-    gpx.distance[n][:s] # get distance between track start and n-th track point
-    gpx.distance[n][:ds] # get distance delta for track n-th and n-1-th track point
+    gpx.distances[n][:s]    # get distance between track start and n-th track point
+    gpx.distances[n][:ds]   # get distance delta for track n-th and n-1-th track point
     
     gpx.max_speed       # get max value from all partial speeds (ds/dt)
     gpx.average_speed   # get average speed for track
@@ -38,7 +41,7 @@ Or install it yourself as:
     gpx.speeds          # get partial speeds
     
     gpx.start_date      # date when track begins
-    gpx.end_date      # date when track ends
+    gpx.end_date        # date when track ends
 
 ## Contributing
 

data/gpx.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "nokogiri"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "simplecov"
-  
-  spec.add_dependency "nokogiri"
 end

data/lib/gpx/exceptions.rb

@@ -1,7 +1,8 @@
 module GPX
-	
-	# Exception occurs when file opened by GPX class is in other format or not exists
+
+	# Exception occurs when file opened by GPX class
+	# is in other format or not exists
 	class GPXInvalidFileException < Exception
 	end
-	
+
 end

data/lib/gpx/gpx.rb

@@ -2,8 +2,9 @@ require 'time'
 require 'nokogiri'
 
 module GPX
-	
-	# Class is responsible for parsing GPX files and calculate track statistics
+
+	# Class is responsible for parsing GPX files
+	# and calculate track statistics
 	class GPX
 		attr_reader :points_count,
 								:points,
@@ -14,25 +15,25 @@ module GPX
 								:max_speed,
 								:start_date,
 								:end_date
-		
+
 		def points_count
 		 	(@points) ? @points.count : 0
 		end
-		
+
 		def start_date
 			@dates.first
 		end
-		
+
 		def end_date
 			@dates.last
 		end
-		
+
 		def speeds
 			unless @speeds
 				@speeds = self.distances.zip(self.times).collect do |dist,time|
 					dt = time[:dt]
 					unless dt == 0
-						next dist[:ds]/dt*3600 
+						next dist[:ds]/dt*3600
 					else
 						next 0
 					end
@@ -40,14 +41,14 @@ module GPX
 			end
 			@speeds
 		end
-		
+
 		def max_speed
 			unless @max_speed
 				@max_speed = self.speeds.sort_by{|speed| speed}.last
 			end
 			@max_speed
 		end
-		
+
 		def average_speed
 			unless @average_speed
 				@average_speed = 0
@@ -56,33 +57,39 @@ module GPX
 			end
 			@average_speed
 		end
-		
+
 		def times
 			calculate_times unless @times
 			@times
 		end
-		
+
+		def duration
+			self.times.last[:t]
+		end
+
 		def distances
 			calculate_distances unless @distances
 			@distances
 		end
-		
+
+		def length
+			self.distances.last[:s]
+		end
+
 		def initialize(path)
 			@doc = nil
-	
+
 			begin
 				path = open(path)
 				doc = Nokogiri::XML(path)
 			rescue
 				raise GPXInvalidFileException
 			end
-	
-			# raise GPXInvalidFileException if doc.children.empty?
-			
+
 			@points = []
 			@dates = []
-			
-			doc.search('trkpt').map do |el| 
+
+			doc.search('trkpt').map do |el|
 				@dates.push Time.parse(el.at('time').text)
 				@points.push GeoPoint.new(
 					latitude: el['lat'].to_f,
@@ -91,9 +98,9 @@ module GPX
 				)
 			end
 		end
-		
+
 		private
-		
+
 			def calculate_times
 				@times = [ { dt: 0.0, t: 0.0 } ]
 				@dates.each_cons(2) do |date|
@@ -104,18 +111,18 @@ module GPX
 					@times.push time
 				end
 			end
-			
+
 			def calculate_distances
 				@distances = [ {ds: 0.0, s: 0.0} ]
 				@points.each_cons(2) do |point|
-					distance = { 
+					distance = {
 						ds: difference = Haversine.distance(point[0], point[1]),
 						s: difference + @distances.last[:s]
 					}
 					@distances.push distance
 				end
 			end
-		
+
 	end
-	
+
 end

data/lib/gpx/haversine.rb

@@ -1,31 +1,32 @@
 module GPX
-	
+
 	# Class is responsible for calculating distance between two geo points (it considers point height)
 	class Haversine
 		RADIAN_PER_DEGREE = Math::PI/180.0
 		EARTH_RADIUS = 6371.00079
-		
+
 		def self.distance(first_point, second_point)
 			first_latitude_rad = first_point.latitude.to_f * RADIAN_PER_DEGREE
 			second_latitude_rad = second_point.latitude.to_f * RADIAN_PER_DEGREE
-			
+
 			delta_longitude = (second_point.longitude.to_f - first_point.longitude.to_f) * RADIAN_PER_DEGREE
 			delta_latitude =  (second_point.latitude.to_f - first_point.latitude.to_f) * RADIAN_PER_DEGREE
-			
+
 			elevation = (first_point.elevation.to_f / 1000.0 - second_point.elevation.to_f / 1000.0).abs
-			
-			triangulate(EARTH_RADIUS * calculate_distance(first_latitude_rad, second_latitude_rad, delta_latitude, delta_longitude), elevation)
+
+			distance = calculate_distance(first_latitude_rad, second_latitude_rad, delta_latitude, delta_longitude)
+			triangulate(EARTH_RADIUS * distance, elevation)
 		end
-		
+
 		private
 			def self.calculate_distance(first_latitude_rad, second_latitude_rad, delta_latitude, delta_longitude)
 				coefficient = (Math::sin(delta_latitude/2.0)**2.0) +
 							Math::cos(first_latitude_rad) * Math::cos(second_latitude_rad) * (Math::sin(delta_longitude/2.0)**2.0)
-							
+
 				2.0 * Math::atan2(Math::sqrt(coefficient), Math::sqrt(1.0-coefficient))
 			end
-			
-			def self.triangulate (distance, height) 
+
+			def self.triangulate (distance, height)
 				Math::sqrt(distance**2 + height**2)
 			end
 	end

data/lib/gpx/version.rb

@@ -1,3 +1,3 @@
 module GPX
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/gpx_spec.rb

@@ -1,78 +1,84 @@
 require 'spec_helper'
 
 describe GPX do
-	
+
 	describe "file with one point" do
 		before do
 			@gpx = GPX::GPX.new 'spec/assets/one_point.gpx'
 		end
-		
+
 		subject { @gpx }
-		
+
 		it { should respond_to :points }
 		it { should_not respond_to :points= }
-		
+
 		it { should respond_to :points_count }
 		it { should_not respond_to :points_count= }
-		
+
 		it { should_not respond_to :elevations }
 		it { should_not respond_to :elevations= }
-		
+
 		it { should respond_to :times }
 		it { should_not respond_to :times= }
-		
+
+		it { should respond_to :duration }
+		it { should_not respond_to :duration= }
+
 		it { should respond_to :speeds }
 		it { should_not respond_to :speeds= }
-		
+
 		it { should respond_to :distances }
 		it { should_not respond_to :distances= }
-		
+
+		it { should respond_to :length }
+		it { should_not respond_to :length= }
+
 		it { should_not respond_to :times_cumulated }
 		it { should_not respond_to :times_cumulated= }
-		
+
 		it { should_not respond_to :distances_cumulated }
 		it { should_not respond_to :distances_cumulated= }
-		
+
 		it { should respond_to :average_speed }
 		it { should_not respond_to :average_speed= }
-		
+
 		it { should respond_to :max_speed }
 		it { should_not respond_to :max_speed= }
-		
+
 		it { should respond_to :start_date }
 		it { should_not respond_to :start_date= }
-		
+
 		it { should respond_to :end_date }
 		it { should_not respond_to :end_date= }
-		
+
 		it "should return one point" do
 			@gpx.points_count.should eq 1
 		end
-		
+
 		it "should return point time" do
 			@gpx.times.first[:dt].should eq 0
 		end
-		
+
 		it "should return point cumulated time" do
 			@gpx.times.first[:t].should eq 0
 		end
-		
+
 		it "average speed should be zero" do
 			@gpx.average_speed.should eq 0
 		end
-		
+
 		it "max speed should be zero" do
 			@gpx.max_speed.should eq 0
 		end
-		
+
 		it "start date should not be nil" do
 			@gpx.start_date.should_not eq nil
 		end
-		
+
 		it "start date should equals end date" do
 			@gpx.start_date.should eq @gpx.end_date
 		end
-		
+
 		describe "should return one zero distance (because of one point)" do
 			it "distances count should equals one" do
 				@gpx.distances.count.should eq 1
@@ -84,7 +90,7 @@ describe GPX do
 				@gpx.distances.first[:s].should eq 0
 			end
 		end
-		
+
 		describe "should return one zero speed (because of one point)" do
 			it "speeds count should equals one" do
 				@gpx.speeds.count.should eq 1
@@ -93,53 +99,53 @@ describe GPX do
 				@gpx.speeds[0].should eq 0
 			end
 		end
-		
+
 		it "should have proper latitude" do
 			@gpx.points.first.latitude.should eq 47.644548
 		end
 	end
-	
+
 	describe "file with more than one track point" do
 		POINTS_COUNT = 6
-		
+
 		before do
 			@gpx = GPX::GPX.new 'spec/assets/two_tracks.gpx'
 		end
-		
+
 		subject { @gpx }
-		
+
 		it "should return all points in one array" do
 			@gpx.points_count.should eq POINTS_COUNT
 		end
-		
+
 		it "last point should not be nil" do
 			@gpx.points.last.should_not eq nil
 		end
-		
+
 		it "should return same count of distances elements as points" do
 			@gpx.distances.count.should eq POINTS_COUNT
 		end
-		
+
 		it "should return same count of speeds elements as points" do
 			@gpx.speeds.count.should eq POINTS_COUNT
 		end
-		
+
 		it "last point speed should not be nil" do
 			@gpx.speeds.last.should_not eq nil
 		end
-		
+
 		it "should return same count of time elements as points" do
 			@gpx.times.count.should eq POINTS_COUNT
 		end
-		
+
 		it "last point time should not be nil" do
 			@gpx.times.last.should_not eq nil
 		end
-		
+
 		it "last point cumulated time should be positive" do
 			@gpx.times.last[:t].should > 0
 		end
-		
+
 		it "last point distance should not be zero" do
 			@gpx.distances.last[:ds].should_not eq 0
 		end
@@ -147,39 +153,47 @@ describe GPX do
 		it "last point cumulated distance should not be zero" do
 			@gpx.distances.last[:s].should_not eq 0
 		end
-		
+
+		it "cumulated time should equals duration" do
+			@gpx.times.last[:t].should eq @gpx.duration
+		end
+
+		it "cumulated distance should equals track length" do
+			@gpx.distances.last[:s].should eq @gpx.length
+		end
+
 		it "average speed should be positive" do
 			@gpx.average_speed.should > 0
 		end
-		
+
 		it "max speed should be positive" do
 			@gpx.max_speed.should > 0
 		end
-		
+
 		it "start date should not equals end date" do
 			@gpx.start_date.should_not eq @gpx.end_date
 		end
 	end
-	
+
 	it "return exeption for non-existing file" do
 		expect {
-			gpx = GPX::GPX.new 'spec/assets/some_filt_that_not_exists_25363.gpx'
+			GPX::GPX.new 'spec/assets/some_filt_that_not_exists_25363.gpx'
 		}.to raise_error( GPX::GPXInvalidFileException )
 	end
-	
+
 	let(:wrong_file_type_gpx) {GPX::GPX.new 'spec/assets/blank.gif'}
 	it "return no points for wrong file type" do
 		wrong_file_type_gpx.points_count.should eq 0
 	end
-	
+
 	let(:blank_file_gpx) {GPX::GPX.new 'spec/assets/blank.gpx'}
 	it "return no points for blank file" do
 		blank_file_gpx.points_count.should eq 0
 	end
-	
+
 	it "should return zero points for file with no track point" do
 		gpx = GPX::GPX.new 'spec/assets/empty.gpx'
 		gpx.points_count.should eq(0)
 	end
-	
+
 end

data/spec/lib/haversine_spec.rb

@@ -5,26 +5,26 @@ PRECISION = 0.002 # 0.01%
 describe GPX::Haversine do
 	def should_equals_distance_with_precision(checked_distance, real_distance)
     (checked_distance-real_distance).abs.should < real_distance * PRECISION
-  end
-	
+	end
+
 	let(:zabrze) { GPX::GeoPoint.new(latitude: 50.3167, longitude: 18.7833, elevation: 0)  }
 	let(:katowice) { GPX::GeoPoint.new(latitude: 50.2667, longitude: 19.0167, elevation: 0) }
 	let(:katowice_distance) { 17.47 }
-	
+
 	it "should return proper distance from Zabrze, PL to Katowice, PL" do
 		distance = GPX::Haversine.distance(zabrze, katowice)
 		should_equals_distance_with_precision(distance, katowice_distance)
 	end
-	
+
 	it "should return proper distance from Katowice, PL to Zabrze, PL" do
 		distance = GPX::Haversine.distance(katowice, zabrze)
 		should_equals_distance_with_precision(distance, katowice_distance)
 	end
-	
+
 	let(:tokyo) { GPX::GeoPoint.new(latitude: 35.6850, longitude: 139.7514, elevation: 0) }
 	let(:london) { GPX::GeoPoint.new(latitude: 51.5000, longitude: -0.1167, elevation: 0) }
 	let(:london_distance) { 9554.72 }
-  
+
   it "should return proper distance from Tokyo, JP to London, GB" do
   	distance = GPX::Haversine.distance(tokyo, london)
   	should_equals_distance_with_precision(distance, london_distance)
@@ -37,17 +37,17 @@ describe GPX::Haversine do
 		)
 		should_equals_distance_with_precision(distance, 20038)
 	end
-  
+
   let(:same_point) { GPX::GeoPoint.new(latitude: 44.654, longitude: 44.654, elevation: 0) }
   it "should return 0 for same lat/lon" do
   	distance = GPX::Haversine.distance(same_point,same_point)
   	distance.should eq 0
   end
-  
+
   let(:height) { GPX::GeoPoint.new(latitude: 44.654, longitude: 44.654, elevation: 1233.54) }
   it "should return proper height for same lat/lon" do
 		distance = GPX::Haversine.distance(same_point, height)
 		distance.should eq height.elevation/1000
   end
-  
+
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'simplecov'
+
 SimpleCov.start
 
-require 'gpx'
+require 'gpx'

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: gpx_track
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dawid Dziurdzia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-15 00:00:00.000000000 Z
+date: 2013-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Provide GPX file parsing
@@ -87,10 +87,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-gemset
-- .ruby-version
-- .simplecov
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".simplecov"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -121,17 +121,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Provide GPX file parsing