ruby-mapsource 0.0.1 → 0.2

data/Gemfile

@@ -1,8 +1,3 @@
 source :rubygems
 
 gemspec
-
-group :development, :test do
-  gem 'guard-minitest', '~> 0.4'
-  gem 'rb-fsevent', '~> 0.4'
-end

data/README.md

@@ -2,15 +2,30 @@ ruby-mapsource is a library that allows ruby programs to read files created by G
 
 # Usage
 
-TODO
+    gdb = MapSource.read('/path/to/gdb_file.gdb')
+    # => #<MapSource::Reader:0x007fedfcb1b768>
 
-# Tools
+    # Read waypoints
+    gdb.waypoints.each { |wp|
+      puts "#{wp.shortname} - (#{wp.latitude}, #{wp.longitude})"
+    }
 
-TODO:
+    # Read tracks
+    gdb.tracks.each do |track|
+      puts "#{track.name} has #{track.size} points"
 
- - gdbtokml - makes a kml file from a gdb
- - gdbtocsv - creates a csv file from a gdb
+      track.waypoints.each { |wp|
+         puts "\t#{wp.shortname} - (#{wp.latitude}, #{wp.longitude})"
+      }
+    end
+
+# TODO
+
+ - read routes
+ - comprehensive testing of different versions
 
 # Thanks
 
-GPSBabel
+[GPSBabel][1] - gdb.c was vital in understanding the format
+
+[1]: http://www.gpsbabel.org/

data/Rakefile

@@ -1,4 +1,4 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|

data/lib/mapsource/reader.rb

@@ -27,27 +27,29 @@ module MapSource
 
     # Public: Read waypoints from file.
     #
-    # Returns a list of waypoints.
+    # Returns an Array of waypoints.
     def waypoints
       read_data
       @waypoints
     end
 
+    # Public: Reads tracks from file.
+    #
+    # Returns an Array of tracks.
     def tracks
       read_data
       @tracks
     end
 
     private
-    # Internal: Reads data from the GDB file.
+    # Reads data from the GDB file and sets Reader's internal state.
     #
-    # Returns list of waypoints, list of tracks, list of routes.
+    # Returns nothing.
     def read_data
       return if @parsed
 
       @waypoints = []
       @tracks = []
-      @routes = []
 
       while true
         len = @gdb.read(4).unpack('l').shift
@@ -67,7 +69,7 @@ module MapSource
       @parsed = true
     end
 
-    # Internal: Converts coordinates in semicircles to degrees.
+    # Converts coordinates in semicircles to degrees.
     #
     # v - coordinate as semicircle
     #
@@ -76,7 +78,7 @@ module MapSource
       (v.to_f / (1 << 31)) * 180.0
     end
 
-    # Internal: Reads a waypoint record from the GDB.
+    # Reads a waypoint record from the GDB.
     #
     # record - a binary string containing waypoint data.
     #
@@ -97,14 +99,14 @@ module MapSource
       wpt = Waypoint.new(lat, lon)
       wpt.shortname = shortname
 
-      if read_char(io) == 1
+      if read_boolean(io)
         alt = read_double(io)
 
         wpt.altitude = alt if alt < 1.0e24
       end
 
       wpt.notes = read_string(io)
-      wpt.proximity = read_double(io) if read_char(io) == 1
+      wpt.proximity = read_double(io) if read_boolean(io)
 
       read_int io # display
       read_int io # color, not implemented
@@ -114,7 +116,47 @@ module MapSource
       wpt.state = read_string(io)
       wpt.facility = read_string(io)
 
-      wpt.depth = read_double(io) if read_char(io) == 1
+      read_meaningless_chars io, 1
+
+      wpt.depth = read_double(io) if read_boolean(io)
+
+      if header.version <= 2
+        read_meaningless_chars 2
+        wptflag = read_boolean(io)
+
+        read_meaningless_chars (waypt_flag ? 2 : 3)
+        read_string io # undocumented and unused string
+
+        wpt.add_url read_string(io)
+        if wptclass != 0
+          # It's a description, not an URL. Remove from URL list and set it.
+          wpt.description = wpt.urls.shift
+        end
+      else
+        wptflag = 0
+
+        wpt.address = read_string(io)
+
+        read_meaningless_chars io, 5 # not sure if they are in fact meaningless
+        wpt.description = read_string(io)
+
+        url_count = read_int(io)
+        url_count.times do
+          url = read_string(io)
+          wpt.add_url(url) if url
+        end
+      end
+
+      wpt.category = ((i = read_int16(io)) && i != 0)
+      wpt.temperature = read_double(io) if read_boolean(io)
+
+      if header.version <= 2
+        if wptflag != 0
+          read_meaningless_chars io, 1
+        end
+      end
+
+      wpt.set_creation_time read_int(io) if read_boolean(io)
 
       wpt
     end
@@ -133,14 +175,14 @@ module MapSource
 
         wpt = Waypoint.new(lat, lon)
 
-        if read_char(io) == 1
+        if read_boolean(io)
           alt = read_double(io)
           wpt.altitude = alt if alt < 1.0e24
         end
 
-        wpt.creation_time = read_int(io) if read_char(io) == 1
-        wpt.depth = read_double(io) if read_char(io) == 1
-        wpt.temperature = read_double(io) if read_char(io) == 1
+        wpt.creation_time = read_int(io) if read_boolean(io)
+        wpt.depth = read_double(io) if read_boolean(io)
+        wpt.temperature = read_double(io) if read_boolean(io)
 
         track.add_waypoint wpt
       end
@@ -148,7 +190,7 @@ module MapSource
       track
     end
 
-    # Internal: Reads a string from an IO object.
+    # Reads a string from an IO object.
     #
     # io - an IO object
     # chars - number of chars to read. If not specified, read_string stops at
@@ -169,7 +211,7 @@ module MapSource
       end
     end
 
-    # Internal: Reads an Integer from an IO object, unpacking it appropriately.
+    # Reads an Integer from an IO object, unpacking it appropriately.
     #
     # io - an IO object.
     #
@@ -178,7 +220,15 @@ module MapSource
       io.read(4).unpack('l').shift
     end
 
-    # Internal: Reads a Double from an IO object, unpacking it appropriately.
+    def read_int16(io)
+      io.read(2).unpack('s').shift
+    end
+
+    def read_meaningless_chars(io, number_of_chars)
+      io.read number_of_chars
+    end
+
+    # Reads a Double from an IO object, unpacking it appropriately.
     #
     # io - an IO object.
     #
@@ -187,8 +237,8 @@ module MapSource
       io.read(8).unpack('E').shift
     end
 
-    # Internal: Reads a single character from an IO object, unpacking it
-    # appropriately.
+    # Reads a single character from an IO object, unpacking it
+    #   appropriately.
     #
     # io - an IO object.
     #
@@ -197,8 +247,17 @@ module MapSource
       io.read(1).unpack('c').shift
     end
 
-    # Internal: Reads a GDB's header to determine the version being parsed, its creator
-    # and signer.
+    # Reads a boolean from an IO object.
+    #
+    # io - an IO object.
+    #
+    # Returns a single character.
+    def read_boolean(io)
+      read_char(io) == 1
+    end
+
+    # Reads a GDB's header to determine the version being parsed, its creator
+    #   and signer.
     #
     # Returns a properly filled header.
     # Raises MapSource::InvalidFormatError if it's not a GDB file.

data/lib/mapsource/structure.rb

@@ -8,11 +8,21 @@ module MapSource
 
   # Public: A Waypoint.
   class Waypoint
-    attr_accessor :shortname, :latitude, :longitude, :altitude, :temperature, :depth, :notes, :creation_time, :proximity, :icon, :city, :state, :facility
+    attr_accessor :shortname, :latitude, :longitude, :altitude, :temperature, :depth, :notes, :creation_time, :proximity, :icon, :city, :state, :facility, :address, :description, :category
+    attr_reader :urls
 
     def initialize(latitude, longitude)
       @latitude = latitude
       @longitude = longitude
+      @urls = []
+    end
+
+    def add_url(url)
+      @urls << url
+    end
+
+    def set_creation_time(value)
+      puts value
     end
   end
 

data/lib/mapsource/version.rb

@@ -1,3 +1,3 @@
 module MapSource
-  VERSION = "0.0.1"
+  VERSION = "0.2"
 end

data/lib/mapsource.rb

@@ -28,3 +28,14 @@ require 'stringio'
 require 'mapsource/structure'
 require 'mapsource/defs'
 require 'mapsource/reader'
+
+module MapSource
+  # Public: Reads a GDB file and returns a Ruby-friendly representation.
+  #
+  # path - A String pointing to a GDB in the filesystem.
+  #
+  # Returns a MapSource::Reader.
+  def self.read(path)
+    MapSource::Reader.new open(path)
+  end
+end

data/ruby-mapsource.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = MapSource::VERSION
   s.authors     = ["Vitor Capela"]
   s.email       = ["dodecaphonic@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "http://github.com/dodecaphonic/ruby-mapsource"
   s.summary     = %q{A Ruby library for reading MapSource/BaseCamp-created GDB files}
   s.description = %q{A Ruby library for reading MapSource/BaseCamp-created GDB files}
 
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "minitest", "~> 2.10"
-  s.add_development_dependency "mocha", "~> 0.10"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "rake"
 end

data/spec/integration/reader_spec.rb

@@ -1,8 +1,10 @@
 require 'spec_helper'
 
 describe MapSource::Reader do
+  let(:filename) { File.dirname(__FILE__) + '/../assets/sample.gdb' }
+
   before :each do
-    @gdb_file = open(File.dirname(__FILE__) + '/../assets/sample.gdb')
+    @gdb_file = open(filename)
     @reader = MapSource::Reader.new(@gdb_file)
   end
 
@@ -30,4 +32,13 @@ describe MapSource::Reader do
     wpt.longitude.must_be_close_to -44.83632
     wpt.altitude.must_be_close_to 1471, 0.05
   end
+
+  describe 'can be started with a convenience method' do
+    it 'reads the file' do
+      gdb = MapSource.read(filename)
+
+      gdb.waypoints.size.must_equal 312
+      gdb.tracks.find { |t| t.name == 'ACTIVE LOG 009' }.size.must_equal 296
+    end
+  end
 end

data/spec/unit/reader_spec.rb

@@ -94,6 +94,7 @@ describe MapSource::Reader do
       wpt.longitude.must_be_close_to -44.836323726922274
       wpt.notes.must_equal "15-DEZ-11 12:06:43PM"
       wpt.altitude.floor.must_be_close_to 1494
+      wpt.depth.must_be_nil
     end
 
     it "parses tracks" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mapsource
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,30 +9,56 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-20 00:00:00.000000000 Z
+date: 2012-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70324053963740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70324053963740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70324053976040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70324053976040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby library for reading MapSource/BaseCamp-created GDB files
 email:
 - dodecaphonic@gmail.com
@@ -41,7 +67,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
 - Gemfile
 - Guardfile
 - LICENSE
@@ -58,7 +83,7 @@ files:
 - spec/integration/reader_spec.rb
 - spec/spec_helper.rb
 - spec/unit/reader_spec.rb
-homepage: ''
+homepage: http://github.com/dodecaphonic/ruby-mapsource
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -70,21 +95,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3373937689098540236
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3373937689098540236
 requirements: []
 rubyforge_project: ruby-mapsource
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A Ruby library for reading MapSource/BaseCamp-created GDB files
-test_files:
-- spec/assets/sample.gdb
-- spec/assets/track.bin
-- spec/integration/reader_spec.rb
-- spec/spec_helper.rb
-- spec/unit/reader_spec.rb
+test_files: []

data/.rvmrc

@@ -1,71 +0,0 @@
-#!/usr/bin/env bash
-
-# This is an RVM Project .rvmrc file, used to automatically load the ruby
-# development environment upon cd'ing into the directory
-
-# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
-environment_id="ruby-1.9.3-p0@mapsource_gdb"
-
-#
-# Uncomment following line if you want options to be set only for given project.
-#
-# PROJECT_JRUBY_OPTS=( --1.9 )
-#
-# The variable PROJECT_JRUBY_OPTS requires the following to be run in shell:
-#
-#    chmod +x ${rvm_path}/hooks/after_use_jruby_opts
-#
-
-#
-# First we attempt to load the desired environment directly from the environment
-# file. This is very fast and efficient compared to running through the entire
-# CLI and selector. If you want feedback on which environment was used then
-# insert the word 'use' after --create as this triggers verbose mode.
-#
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
-  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
-then
-  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-
-  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
-  then
-    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
-  fi
-else
-  # If the environment file has not yet been created, use the RVM CLI to select.
-  if ! rvm --create use  "$environment_id"
-  then
-    echo "Failed to create RVM environment '${environment_id}'."
-    return 1
-  fi
-fi
-
-#
-# If you use an RVM gemset file to install a list of gems (*.gems), you can have
-# it be automatically loaded. Uncomment the following and adjust the filename if
-# necessary.
-#
-# filename=".gems"
-# if [[ -s "$filename" ]]
-# then
-#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
-# fi
-
-# If you use bundler, this might be useful to you:
-# if [[ -s Gemfile ]] && ! command -v bundle >/dev/null
-# then
-#   printf "The rubygem 'bundler' is not installed. Installing it now.\n"
-#   gem install bundler
-# fi
-# if [[ -s Gemfile ]] && command -v bundle
-# then
-#   bundle install
-# fi
-
-if [[ $- == *i* ]] # check for interactive shells
-then
-    echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
-else 
-	echo "Using: $GEM_HOME" # don't use colors in interactive shells
-fi
-