xaviershay-kamel 0.1

data/README.textile

@@ -0,0 +1,29 @@
+h1. Kamel
+
+Create KML files for tasty overlays on google earth and google maps
+
+<pre><code>gem install kamel --source http://gems.github.com/</code></pre>
+
+h2. Usage
+
+<pre><code>require 'rubygems'
+require 'kamel'
+
+overlay = Kamel::Overlay.new
+overlay.name = 'Melbourne Train Stations'
+[
+  ["Flinders St",    -37.818078, 144.966811],
+  ["Southern Cross", -37.818358, 144.952417],
+].each do |name, lat, lng|
+  overlay.placemark!(
+    :name        => name,
+    :description => "This is a train station",
+    :location    => {:lng => lng, :lat => lat},
+    :icon        => "http://www.uksa.org/images/about/train-icon.gif"
+  )
+end
+puts overlay.to_kml</code></pre>
+
+h2. Author
+
+Xavier Shay ("http://rhnh.net":http://rhnh.net)

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new do |t|
+  t.warning = false
+  t.rcov = false
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :test    => :spec
+task :default => :spec

data/lib/kamel.rb

@@ -0,0 +1 @@
+require 'kamel/overlay'

data/lib/kamel/overlay.rb

@@ -0,0 +1,55 @@
+begin
+  require 'kml'
+rescue LoadError
+  puts "You must have ruby_kml either installed to use Kamel - either as a gem or available in your path"
+  puts "gem install xaviershay-ruby_kml --source http://gems.github.com"
+  exit
+end
+
+module Kamel  
+  class Overlay
+    attr_accessor :prefix
+    attr_accessor :name
+    attr_accessor :placemarks
+
+    def initialize(prefix = '')
+      self.prefix = prefix.to_s
+      self.placemarks = []
+    end
+
+    def placemark!(attributes)
+      self.placemarks << attributes
+    end
+
+    def to_kml
+      doc = KML::Document.new
+      doc.name = self.name unless self.name.to_s.length == 0
+      self.icons.each_with_index {|icon, index|
+        doc.styles << KML::Style.new(
+          :id => [prefix, 'style', index].join('-'),
+          :icon_style => KML::IconStyle.new(
+            :icon => KML::Icon.new(:href => icon)
+          )
+        )  
+      }
+      self.placemarks.each do |placemark|
+        attrs = {}
+        attrs[:name] = placemark[:name].to_s unless placemark[:name].nil?
+        attrs[:description] = placemark[:description].to_s unless placemark[:description].nil?
+        attrs[:geometry] = KML::Point.new(:coordinates => placemark[:location]) unless placemark[:location].nil?
+        attrs[:style_url] = '#' + [prefix, 'style', self.icons.index(placemark[:icon])].join('-') unless placemark[:icon].nil?
+        doc.features << KML::Placemark.new(attrs)
+      end
+      
+      kml = KMLFile.new
+      kml.objects << doc
+      kml.render
+    end
+
+    protected
+
+    def icons
+      self.placemarks.collect {|x| x[:icon]}.compact.uniq.sort 
+    end
+  end
+end

data/spec/kamel/overlay_spec.rb

@@ -0,0 +1,56 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'rubygems'
+require 'spec'
+require 'kamel'
+require File.dirname(__FILE__) + '/../xpath_matchers'
+
+
+require 'rexml/document'
+require 'rexml/element'
+
+describe Kamel::Overlay, '#to_kml' do
+  setup do
+    @overlay = Kamel::Overlay.new('test')
+    @overlay.placemark!(:name => 'placemark-1', :location => {:lat => 1, :lng => 2}, :description => 'Place 1', :icon => 'icon-1.png')
+    @overlay.placemark!(:name => 'placemark-2', :location => "3,4", :description => 'Place 2', :icon => 'icon-1.png')
+    @overlay.placemark!(:name => 'placemark-3', :location => [5,6,7], :icon => 'icon-2.png')
+    @doc = @overlay.to_kml
+  end
+
+  it 'outputs one style block for each unique icon' do
+    @doc.should have_nodes("/kml/Document/Style", 2)
+  end
+
+  it 'outputs one placemark block for each placemark' do
+    @doc.should have_nodes("/kml/Document/Placemark", 3)
+  end
+
+  it 'records the name of each placemark' do
+    @doc.should match_xpath("/kml/Document/Placemark[1]/name", "placemark-1")
+    @doc.should match_xpath("/kml/Document/Placemark[2]/name", "placemark-2")
+    @doc.should match_xpath("/kml/Document/Placemark[3]/name", "placemark-3")
+  end
+  
+  it 'records the description of each placemark if it is provided' do
+    #TODO Figure out how to check for CDATA
+    @doc.should have_xpath("/kml/Document/Placemark[1]/description")
+    @doc.should have_xpath("/kml/Document/Placemark[2]/description")
+    @doc.should_not have_xpath("/kml/Document/Placemark[3]/description")
+  end
+
+  it 'records the location of each placemark' do
+    @doc.should match_xpath("/kml/Document/Placemark[1]/Point/coordinates", "2,1")
+    @doc.should match_xpath("/kml/Document/Placemark[2]/Point/coordinates", "3,4")
+    @doc.should match_xpath("/kml/Document/Placemark[3]/Point/coordinates", "5,6,7")
+  end
+
+  it 'records a styleUrl that matches up to the style block for the given icon' do
+    doc = REXML::Document.new(@doc)
+    style_ids = REXML::XPath.match(doc, "/kml/Document/Style/IconStyle/Icon/href").inject({}) {|a,v|
+      a.update(v.text => '#' + v.parent.parent.parent.attribute('id').value)
+    }
+    @doc.should match_xpath("/kml/Document/Placemark[1]/styleUrl", style_ids['icon-1.png'])
+    @doc.should match_xpath("/kml/Document/Placemark[2]/styleUrl", style_ids['icon-1.png'])
+    @doc.should match_xpath("/kml/Document/Placemark[3]/styleUrl", style_ids['icon-2.png'])
+  end
+end

data/spec/xpath_matchers.rb

@@ -0,0 +1,105 @@
+# http://blog.wolfman.com/articles/2008/01/02/xpath-matchers-for-rspec
+
+module Spec
+  module Matchers
+
+    # check if the xpath exists one or more times
+    class HaveXpath
+      def initialize(xpath)
+        @xpath = xpath
+      end
+
+      def matches?(response)
+        @response = response
+        doc = response.is_a?(REXML::Document) ? response : REXML::Document.new(@response)
+        match = REXML::XPath.match(doc, @xpath)
+        not match.empty?
+      end
+
+      def failure_message
+        "Did not find expected xpath #{@xpath}"
+      end
+
+      def negative_failure_message
+        "Did find unexpected xpath #{@xpath}"
+      end
+
+      def description
+        "match the xpath expression #{@xpath}"
+      end
+    end
+
+    def have_xpath(xpath)
+      HaveXpath.new(xpath)
+    end
+
+    # check if the xpath has the specified value
+    # value is a string and there must be a single result to match its
+    # equality against
+    class MatchXpath
+      def initialize(xpath, val)
+        @xpath = xpath
+        @val= val
+      end
+
+      def matches?(response)
+        @response = response
+        doc = response.is_a?(REXML::Document) ? response : REXML::Document.new(@response)
+        ok= true
+        REXML::XPath.each(doc, @xpath) do |e|
+          @actual_val= case e
+          when REXML::Attribute
+            e.to_s
+          when REXML::Element
+            e.text
+          else
+            e.to_s
+          end
+          return false unless @val == @actual_val
+        end
+        return ok
+      end
+
+      def failure_message
+        "The xpath #{@xpath} did not have the value '#{@val}'\nIt was '#{@actual_val}'"
+      end
+
+      def description
+        "match the xpath expression #{@xpath} with #{@val}"
+      end
+    end
+
+    def match_xpath(xpath, val)
+      MatchXpath.new(xpath, val)
+    end
+
+    # checks if the given xpath occurs num times
+    class HaveNodes  #:nodoc:
+      def initialize(xpath, num)
+        @xpath= xpath
+        @num = num
+      end
+
+      def matches?(response)
+        @response = response
+        doc = response.is_a?(REXML::Document) ? response : REXML::Document.new(@response)
+        match = REXML::XPath.match(doc, @xpath)
+        @num_found= match.size
+        @num_found == @num
+      end
+
+      def failure_message
+        "Did not find expected number of nodes #{@num} in xpath #{@xpath}\nFound #{@num_found}"
+      end
+
+      def description
+        "match the number of nodes #{@num}"
+      end
+    end
+
+    def have_nodes(xpath, num)
+      HaveNodes.new(xpath, num)
+    end
+
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: xaviershay-kamel
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Xavier Shay
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-08 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: xaviershay-ruby_kml
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: Create KML files for tasty overlays on google earth and google maps
+email: xavier@rhnh.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- Rakefile
+- README.textile
+- lib/kamel/overlay.rb
+- lib/kamel.rb
+- spec/xpath_matchers.rb
+- spec/kamel/overlay_spec.rb
+has_rdoc: false
+homepage: http://github.com/xaviershay/kamel
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Create KML files for tasty overlays on google earth and google maps
+test_files: 
+- spec/kamel/overlay_spec.rb