gps 0.0.1

data/spec/fix_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Gps::Fix do
+
+	class Fix
+		include Gps::Fix
+	end
+
+	it "initializes GPS fix values to nil or 0" do
+		fix = Fix.new
+		fix.last_tag.should == nil
+		fix.timestamp.should == nil
+		fix.timestamp_error_estimate.should == nil
+		fix.latitude.should == 0
+		fix.longitude.should == 0
+		fix.altitude.should == 0
+		fix.horizontal_error_estimate.should == nil
+		fix.vertical_error_estimate.should == nil
+		fix.course.should == 0
+		fix.speed.should == 0
+		fix.climb.should == nil
+		fix.course_error_estimate.should == nil
+		fix.speed_error_estimate.should == nil
+		fix.climb_error_estimate.should == nil
+		fix.satellites.should == 0
+	end
+end

data/spec/gpsd_spec.rb

@@ -0,0 +1,63 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Gps::Receivers::Gpsd do
+
+	it "initializes itself with a host of localhost and port 2947 by default" do
+		gps = Gps::Receiver.create("gpsd")
+		gps.host.should == "localhost"
+		gps.port.should == 2947
+	end
+
+	it "initializes itself with the specified host and port" do
+		gps = Gps::Receiver.create("gpsd", :host => "foo.com", :port => 123)
+		gps.host.should == "foo.com"
+		gps.port.should == 123
+	end
+
+	it "opens a socket to its host and port and activates watcher mode when started" do
+		gps = Gps::Receiver.create
+		socket = mock("socket")
+		TCPSocket.should_receive(:new).with(gps.host, gps.port).and_return(socket)
+		socket.should_receive(:puts).with("w+")
+		gps.start
+	end
+
+	it "correctly parses O sentences on update" do
+		line = "GPSD,O=MID2 1187698425.040 0.005 53.527158 -113.530148 704.05 2.00 1.73 0.0000 0.074 0.101 ? ? ? 3\r\n"
+		gps = Gps::Receiver.create
+		socket = mock("socket")
+		TCPSocket.should_receive(:new).with(gps.host, gps.port).and_return(socket)
+		socket.should_receive(:puts).with("w+")
+		socket.should_receive(:gets).any_number_of_times.and_return(line)
+		gps.start
+		params = line.chomp.split("=")[1].split
+		sleep(0.1)
+		gps.last_tag.should == params[0]
+		gps.timestamp.should == params[1].to_f
+		gps.timestamp_error_estimate.should == params[2].to_f
+		gps.latitude.should == params[3].to_f
+		gps.longitude.should == params[4].to_f
+		gps.altitude.should == params[5].to_f
+		gps.horizontal_error_estimate.should == params[6].to_f
+		gps.vertical_error_estimate.should == params[7].to_f
+		gps.course.should == params[8].to_f
+		gps.speed.should == params[9].to_f
+		gps.climb.should == params[10].to_f
+		gps.course_error_estimate.should == params[11].to_f
+		gps.speed_error_estimate.should == params[12].to_f
+		gps.climb_error_estimate.should == params[13].to_f
+		end
+
+	it "correctly parses Y sentences on update" do
+		line = "GPSD,Y=MID4 1187698430.040 9:9 31 58 41 1:14 62 198 45 1:1 26 214 41 1:19 32 264 42 1:3 16 232 38 1:11 14 310 38 1:22 75 85 47 1:18 35 90 42 1:138 28 171 38 0:\r\n"
+		gps = Gps::Receiver.create
+		socket = mock("socket")
+		TCPSocket.should_receive(:new).with(gps.host, gps.port).and_return(socket)
+		socket.should_receive(:puts).with("w+")
+		socket.should_receive(:gets).any_number_of_times.and_return(line)
+		gps.start
+		params = line.chomp.split("=")[1].split(":")
+		sleep(0.1)
+		gps.satellites.should == params[0].split[-1].to_i
+	end
+end

data/spec/receiver_spec.rb

@@ -0,0 +1,111 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Gps::Receiver do
+
+	it "creates an instance of the first receiver in Gps::Receivers with specified options when its create method is called" do
+		First = mock("first")
+		Second = mock("second")
+		Gps::Receivers.should_receive(:constants).and_return([First, Second])
+		Gps::Receivers.should_receive(:const_get).with(First).and_return(First)
+		options = {:foo => :bar}
+		First.should_receive(:new).with(options)
+		Gps::Receiver.create(options)
+	end
+
+	it "creates an instance of the specified receiver in Gps::Receivers with specified options when its create method is called" do
+		receiver = mock("receiver")
+		Gps::Receivers.should_receive(:const_get).with("Receiver").and_return(receiver)
+		options = {:foo => :bar}
+		receiver.should_receive(:new).with(options)
+		Gps::Receiver.create("receiver", options)
+	end
+
+	it "supports setting latitude and longitude via the position attribute" do
+		gps = Gps::Receiver.new
+		gps.position = [20, 30]
+		gps.latitude.should == 20
+		gps.longitude.should == 30
+	end
+
+	it "should call the on_position_change callback on position changes" do
+		gps = Gps::Receiver.new
+		called = false
+		gps.on_position_change { called = true }
+		gps.position = [20, 30]
+		called.should == true
+	end
+
+	it "should not call the on_position_change callback if the position change is below the specified threshold" do
+		gps = Gps::Receiver.new
+		called = false
+		gps.on_position_change(5) { called = true }
+		gps.position = [0, 1]
+		called.should == false
+	end
+
+	it "should call the on_position_change callback if the position change is above the specified threshold" do
+		gps = Gps::Receiver.new
+		called = false
+		gps.on_position_change(5) { called = true }
+		gps.position = [0, 6]
+		called.should == true
+	end
+
+	it "should cope with intermediate position changes, not calling on_position_change until the threshold is exceeded" do
+		gps = Gps::Receiver.new
+		called = false
+		gps.on_position_change(5) { called = true }
+		gps.position = [0, 4]
+		called.should == false
+		gps.position = [0, 6]
+		called.should == true
+	end
+
+	it "should call position, speed , satellite and course change callbacks when updated, if necessary" do
+		gps = Gps::Receiver.new
+		course_changed = speed_changed = position_changed = altitude_changed = satellites_changed = nil
+		degrees_changed = 0
+		gps.on_position_change { |degrees| position_changed = true; degrees_changed = degrees }
+		gps.on_speed_change { speed_changed = true }
+		gps.on_course_change { course_changed = true }
+		gps.on_altitude_change { altitude_changed = true }
+		gps.on_satellites_change { satellites_changed = true }
+		gps.instance_eval("@latitude = 5")
+		gps.instance_eval("@speed = 10")
+		gps.instance_eval("@course = 1")
+		gps.instance_eval("@altitude = 1000")
+		gps.instance_eval("@satellites = 15")
+		gps.update
+		course_changed.should == true
+		position_changed.should == true
+		degrees_changed.should == 5
+		speed_changed.should == true
+		altitude_changed.should == true
+		satellites_changed.should == true
+	end
+
+	it "should spawn a new, updating thread when started" do
+		gps = Gps::Receiver.new
+		gps.should_receive(:update).any_number_of_times
+		gps.start
+	end
+
+	it "should report that it is started" do
+		gps = Gps::Receiver.new
+		gps.start
+		gps.started?.should == true
+	end
+
+	it "should report that it is not started before start has been called" do
+		gps = Gps::Receiver.new
+		gps.started?.should == false
+	end
+
+	it "should kill its update thread when stopped" do
+		gps = Gps::Receiver.new
+		gps.start
+		gps.started?.should == true
+		gps.stop
+		gps.started?.should == false
+	end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+require File.dirname(__FILE__)+"/../lib/gps"

data/tasks/deployment.rake

@@ -0,0 +1,31 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb']
+end

data/tasks/website.rake

@@ -0,0 +1,9 @@
+# stubs for the website generation
+# To install the website framework:
+#   script/generate website
+
+task :website_generate
+
+task :website_upload
+
+task :website => :publish_docs

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: gps
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nolan Darilek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-11 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: An interface to GPS receivers
+email: nolan@thewordnerd.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- config/hoe.rb
+- config/requirements.rb
+- lib/gps.rb
+- lib/gps/fix.rb
+- lib/gps/receiver.rb
+- lib/gps/receivers/gpsd.rb
+- lib/gps/version.rb
+- script/destroy
+- script/generate
+- setup.rb
+- spec/fix_spec.rb
+- spec/gpsd_spec.rb
+- spec/receiver_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/deployment.rake
+- tasks/environment.rake
+- tasks/rspec.rake
+- tasks/website.rake
+has_rdoc: true
+homepage: http://hermes-gps.info/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: hermes
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: This library provides an elegant interface to data from GPS receivers. An extensible architecture simplifies adding new receiver types, with a GPSD receiver already written. Additionally, the API supports registering callbacks triggered on change of position, course, altitude and visible satellites.
+test_files: []
+