ruby_kml 0.1.7

data/lib/kml/style.rb

@@ -0,0 +1,23 @@
+module KML
+  # A Style defines an addressable style group that can be referenced by StyleMaps and Features. Styles affect 
+  # how Geometry is presented in the 3D viewer and how Features appear in the Places panel of the List view. 
+  # Shared styles are collected in a Document and must have an id defined for them so that they can be referenced 
+  # by the individual Features that use them.
+  class Style < StyleSelector
+    attr_accessor :icon_style
+    attr_accessor :label_style
+    attr_accessor :line_style
+    attr_accessor :poly_style
+    attr_accessor :balloon_style
+    attr_accessor :list_style
+    
+    def render(xm=Builder::XmlMarkup.new(:indent => 2))
+      xm.Style(:id => id) {
+        %w(Icon Label Line Poly Balloon List).each do |name| 
+          field = "#{name.downcase}_style".to_sym
+          self.__send__(field).render(xm) unless self.__send__(field).nil?
+        end
+      }
+    end
+  end
+end

data/lib/kml/style_map.rb

@@ -0,0 +1,39 @@
+# Source file that defines a StyleMap element
+#
+# <StyleMap id="ID">
+#   <!-- extends StyleSelector -->
+#   <!-- elements specific to StyleMap -->
+#   <Pair id="ID">
+#     <key>normal</key>              <!-- kml:styleStateEnum:  normal or highlight
+#     <styleUrl>...</styleUrl>       <!-- anyURI -->
+#   </Pair>
+# </StyeMap>
+
+module KML #:nodoc:
+  # A StyleMap maps between two different icon styles. Typically a StyleMap element is used to provide 
+  # separate normal and highlighted styles for a placemark, so that the highlighted version appears when 
+  # the user mouses over the icon in Google Earth.
+  class StyleMap < StyleSelector
+    # Key/styleUrl pairs
+    attr_accessor :pairs
+    
+    # Get the pairs Hash. Each key/value pair  maps a mode (normal or highlight) to the predefined style URL. 
+    # Each pair contains a key and a value which references the style. For referenced style elements that 
+    # are local to the KML document, a simple # referencing is used. For styles that are contained in 
+    # external files, use a full URL along with # referencing.
+    def pairs
+      @pairs ||= {}
+    end
+    
+    def render(xm=Builder::XmlMarkup.new(:indent => 2))
+      xm.StyleMap(:id => id) {
+        pairs.each do |key, value|
+          xm.Pair {
+            xm.key(key)
+            xm.styleUrl(value)
+          }
+        end
+      }
+    end
+  end
+end

data/lib/kml/style_selector.rb

@@ -0,0 +1,7 @@
+module KML
+  class StyleSelector < KML::Object
+  end
+end
+
+require 'kml/style'
+require 'kml/style_map'

data/lib/kml/version.rb

@@ -0,0 +1,9 @@
+module KML#:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 7
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/kml_file.rb

@@ -0,0 +1,55 @@
+# The KMLFile class is the top level class for constructing KML files. To create a new KML file
+# create a KMLFile instance and add KML objects to its objects. For example:
+#
+#   f = KMLFile.new
+#   f.objects << Placemark.new(
+#     :name => 'Simple placemark',
+#     :description => 'Attached to the ground. Intelligently places itself at the height of the underlying terrain.',
+#     :geometry => Point.new(:coordinates=>'-122.0822035425683,37.42228990140251,0')
+#   )
+#   puts f.render
+class KMLFile
+  # The objects in the KML file
+  def objects
+    @objects ||= []
+  end
+  alias :features :objects
+
+  # Render the KML file
+  def render(xm=Builder::XmlMarkup.new(:indent => 2))
+    xm.instruct!
+    xm.kml(:xmlns => 'http://earth.google.com/kml/2.1'){
+      objects.each { |o| o.render(xm) }
+    }
+  end
+
+  def save filename
+    File.open(filename, 'w') { |f| f.write render }
+  end
+
+  # Parse the KML file using nokogiri
+  # <kml xmlns="http://www.opengis.net/kml/2.2">
+  #   <NetworkLinkControl> ... </NetworkLinkControl>
+  #   <!-- 0 or 1 Feature elements -->
+  # </kml>
+  def self.parse(io)
+    kml = self.new
+    doc = Nokogiri::XML::Document.parse(io)
+    doc.root.element_children.each do |cld|
+      case cld.name
+      when 'Document'
+        kml.features << KML::Document.parse(cld)
+      when 'Folder'
+      when 'NetworkLink'
+      when 'Placemark'
+      when 'GroundOverlay'
+      when 'PhotoOverlay'
+      when 'ScreenOverlay'
+      end
+    end
+    kml
+  end
+
+end
+
+require 'kml/object'

data/lib/ruby_kml.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'builder'
+require 'nokogiri'
+
+require 'kml_file'
+
+class InvalidKMLError < StandardError
+end

data/ruby_kml.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.version   = "0.1.7"
+  s.date      = "2012-05-07"
+  s.name      = "ruby_kml"
+  s.summary   = "Generate KML files with ruby"
+  s.email     = ""
+  s.homepage  = "http://github.com/schleyfox/ruby_kml"
+  s.description = "Generate KML files with ruby"
+  s.has_rdoc  = false
+  s.authors   = ["aeden, schleyfox, xaviershay, andykram, IanVaughan"]
+  s.files     = Dir['**/**']
+  s.add_dependency('nokogiri')
+  s.add_dependency('builder')
+end

data/test/cdata_and_snippet.kml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.1">
+  <Document>
+    <name>Document with CDATA example</name>
+    <Snippet>Document level snippet2</Snippet>
+    <Placemark>
+      <name>CDATA example</name>
+      <description>
+        <![CDATA[<h1>CDATA Tags are useful!</h1>
+<p><font color="red">Text is <i>more readable</i> and
+<b>easier to write</b> when you can avoid using entity
+references.</font></p>
+]]>
+      </description>
+      <Snippet>Example of a snippet2</Snippet>
+      <Point>
+        <coordinates>-122.0822035425683,37.4228,0</coordinates>
+      </Point>
+    </Placemark>
+  </Document>
+</kml>

data/test/ground_overlays.kml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.1">
+  <Folder>
+    <name>Ground Overlays</name>
+    <description>
+      <![CDATA[Examples of ground overlays]]>
+    </description>
+    <GroundOverlay>
+      <name>Large-scale overlay on terrain</name>
+      <description>
+        <![CDATA[Overlay shows Mount Etna erupting on July 13th, 2001.]]>
+      </description>
+      <Icon>
+        <href>http://code.google.com/apis/kml/documentation/etna.jpg</href>
+      </Icon>
+      <LatLonBox>
+        <north>37.91904192681665</north>
+        <south>37.46543388598137</south>
+        <east>15.35832653742206</east>
+        <west>14.60128369746704</west>
+        <rotation/>
+      </LatLonBox>
+    </GroundOverlay>
+  </Folder>
+</kml>

data/test/kml/point_test.rb

@@ -0,0 +1,10 @@
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+class KML::PointTest < Test::Unit::TestCase
+  include KML
+
+  def test_allows_coordinates_to_be_specified_with_a_hash
+    point = Point.new(:coordinates => {:lat => 10, :lng => 20, :alt => 30})
+    assert_equal [20, 10, 30], point.coordinates
+  end
+end

data/test/kml_file_test.rb

@@ -0,0 +1,255 @@
+require './test/test_helper'
+
+class KMLFileTest < Test::Unit::TestCase
+  include KML
+
+  # This also tests the stripping of coordinates
+  def test_placemark
+    kml = KMLFile.new
+    kml.objects << Placemark.new(
+      :name => 'Simple placemark',
+      :description => 'Attached to the ground. Intelligently places itself at the height of the underlying terrain.',
+      :geometry => Point.new(:coordinates=>'   -122.0822035425683,37.42228990140251,0  ')
+    )
+    assert_equal File.read('test/simple_placemark.kml'), kml.render
+  end
+
+  def test_cdata_description
+    description = <<-DESC
+<h1>CDATA Tags are useful!</h1>
+<p><font color="red">Text is <i>more readable</i> and
+<b>easier to write</b> when you can avoid using entity
+references.</font></p>
+DESC
+
+    kml = KMLFile.new
+    document = Document.new(
+      :name => 'Document with CDATA example',
+      :snippet => Snippet.new("Document level snippet")
+    )
+    document.features << Placemark.new(
+      :name => 'CDATA example',
+      :description => description,
+      :snippet => Snippet.new("Example of a snippet"),
+      :geometry => Point.new(:coordinates=>'-122.0822035425683,37.4228,0')
+    )
+    kml.objects << document
+    assert_equal File.read('test/cdata_and_snippet.kml'), kml.render
+  end
+
+  def test_ground_overlays
+    kml = KMLFile.new
+    folder = Folder.new(
+      :name => 'Ground Overlays',
+      :description => 'Examples of ground overlays'
+    )
+    folder.features << GroundOverlay.new(
+      :name => 'Large-scale overlay on terrain',
+      :description => 'Overlay shows Mount Etna erupting on July 13th, 2001.',
+      :icon => Icon.new(:href => 'http://code.google.com/apis/kml/documentation/etna.jpg'),
+      :lat_lon_box => LatLonBox.new(
+        :north => 37.91904192681665,
+        :south => 37.46543388598137,
+        :east => 15.35832653742206,
+        :west => 14.60128369746704,
+        :rotation => -0.1556640799496235
+      )
+    )
+    kml.objects << folder
+    assert_equal File.read('test/ground_overlays.kml'), kml.render
+  end
+
+  def test_paths
+    kml = KMLFile.new
+    kml.objects << Document.new(
+      :name => 'Paths',
+      :description => 'Examples of paths. Note that the tessellate tag is by default
+            set to 0. If you want to create tessellated lines, they must be authored
+            (or edited) directly in KML.',
+      :styles => [
+        Style.new(
+          :id => 'yellowLineGreenPoly',
+          :line_style => LineStyle.new(:color => '7f00ffff', :width => 4),
+          :poly_style => PolyStyle.new(:color => '7f00ff00')
+        )
+      ],
+      :features => [
+        Placemark.new(
+          :name => 'Absolute Extruded',
+          :description => 'Transparent green wall with yellow outlines',
+          :style_url => '#yellowLineGreenPoly',
+          :geometry => LineString.new(
+            :extrude => true,
+            :tessellate => true,
+            :altitude_mode => 'absolute',
+            :coordinates => '-112.2550785337791,36.07954952145647,2357
+                      -112.2549277039738,36.08117083492122,2357
+                      -112.2552505069063,36.08260761307279,2357
+                      -112.2564540158376,36.08395660588506,2357
+                      -112.2580238976449,36.08511401044813,2357
+                      -112.2595218489022,36.08584355239394,2357
+                      -112.2608216347552,36.08612634548589,2357
+                      -112.262073428656,36.08626019085147,2357
+                      -112.2633204928495,36.08621519860091,2357
+                      -112.2644963846444,36.08627897945274,2357
+                      -112.2656969554589,36.08649599090644,2357'
+          )
+        )
+      ]
+    )
+    assert_equal File.read('test/paths.kml'), kml.render
+  end
+
+  def test_polygon
+    kml = KMLFile.new
+    kml.objects << Placemark.new(
+      :name => 'The Pentagon',
+      :geometry => Polygon.new(
+        :extrude => true,
+        :altitude_mode => 'relativeToGround',
+        :outer_boundary_is => LinearRing.new(
+          :coordinates => '-77.05788457660967,38.87253259892824,100
+                      -77.05465973756702,38.87291016281703,100
+                      -77.05315536854791,38.87053267794386,100
+                      -77.05552622493516,38.868757801256,100
+                      -77.05844056290393,38.86996206506943,100
+                      -77.05788457660967,38.87253259892824,100'
+        ),
+        :inner_boundary_is => LinearRing.new(
+          :coordinates => '-77.05668055019126,38.87154239798456,100
+                      -77.05542625960818,38.87167890344077,100
+                      -77.05485125901024,38.87076535397792,100
+                      -77.05577677433152,38.87008686581446,100
+                      -77.05691162017543,38.87054446963351,100
+                      -77.05668055019126,38.87154239798456,100'
+        )
+      )
+    )
+    assert_equal File.read('test/polygon.kml'), kml.render
+  end
+
+  def test_polygon_with_multiple_inner_boundaries
+    kml = KMLFile.new
+    kml.objects << Placemark.new(
+      :name => 'The Pentagon',
+      :geometry => Polygon.new(
+        :extrude => true,
+        :altitude_mode => 'relativeToGround',
+        :outer_boundary_is => LinearRing.new(
+          :coordinates => '-77.05788457660967,38.87253259892824,100
+                      -77.05465973756702,38.87291016281703,100
+                      -77.05315536854791,38.87053267794386,100
+                      -77.05552622493516,38.868757801256,100
+                      -77.05844056290393,38.86996206506943,100
+                      -77.05788457660967,38.87253259892824,100'
+        ),
+        :inner_boundary_is => [
+          LinearRing.new(
+            :coordinates => '-77.05668055019126,38.87154239798456,100
+                      -77.05542625960818,38.87167890344077,100
+                      -77.05485125901024,38.87076535397792,100
+                      -77.05577677433152,38.87008686581446,100
+                      -77.05691162017543,38.87054446963351,100
+                      -77.05668055019126,38.87154239798456,100'
+          ),
+          LinearRing.new(
+            :coordinates => '-77.05668055019126,38.87154239798456,100
+                      -77.05542625960818,38.87167890344077,100
+                      -77.05485125901024,38.87076535397792,100
+                      -77.05577677433152,38.87008686581446,100
+                      -77.05691162017543,38.87054446963351,100
+                      -77.05668055019126,38.87154239798456,100'
+          )
+        ]
+      )
+    )
+    assert_equal File.read('test/polygon_inner.kml'), kml.render
+  end
+
+  def test_geometry_styles
+    kml = KMLFile.new
+    kml.objects << Style.new(
+      :id => "transBluePoly",
+      :line_style => LineStyle.new(
+        :width => 1.5
+      ),
+      :poly_style => PolyStyle.new(
+        :color => '7dff0000'
+      )
+    )
+    kml.objects << Placemark.new(
+      :name => 'Building 41',
+      :style_url => '#transBluePoly',
+      :geometry => Polygon.new(
+        :extrude => true,
+        :altitude_mode => 'relativeToGround',
+        :outer_boundary_is => LinearRing.new(
+          :coordinates => '-122.0857412771483,37.42227033155257,17
+                        -122.0858169768481,37.42231408832346,17
+                        -122.085852582875,37.42230337469744,17
+                        -122.0858799945639,37.42225686138789,17
+                        -122.0858860101409,37.4222311076138,17
+                        -122.0858069157288,37.42220250173855,17
+                        -122.0858379542653,37.42214027058678,17
+                        -122.0856732640519,37.42208690214408,17
+                        -122.0856022926407,37.42214885429042,17
+                        -122.0855902778436,37.422128290487,17
+                        -122.0855841672237,37.42208171967246,17
+                        -122.0854852065741,37.42210455874995,17
+                        -122.0855067264352,37.42214267949824,17
+                        -122.0854430712915,37.42212783846172,17
+                        -122.0850990714904,37.42251282407603,17
+                        -122.0856769818632,37.42281815323651,17
+                        -122.0860162273783,37.42244918858722,17
+                        -122.0857260327004,37.42229239604253,17
+                        -122.0857412771483,37.42227033155257,17'
+        )
+      )
+    )
+
+    assert_equal File.read('test/polygon_style.kml'), kml.render
+  end
+
+  def test_style_map
+    kml = KMLFile.new
+    kml.objects << Document.new(
+      :name => 'Highlighted Icon',
+      :description => 'Place your mouse over the icon to see it display the new icon',
+      :styles => [
+        Style.new(
+          :id => "highlightPlacemark",
+          :icon_style => IconStyle.new(
+            :icon => Icon.new(
+              :href => "http://maps.google.com/mapfiles/kml/paddle/red-stars.png"
+            )
+          )
+        ),
+        Style.new(
+          :id => "normalPlacemark",
+          :icon_style => IconStyle.new(
+            :icon => Icon.new(
+              :href => "http://maps.google.com/mapfiles/kml/paddle/wht-blank.png"
+            )
+          )
+        ),
+        StyleMap.new(
+          :id => 'exampleStyleMap',
+          :pairs => {
+            'normal' => '#normalPlacemark',
+            'highlight' => '#highlightPlacemark'
+          }
+        )
+      ],
+      :features => [
+        Placemark.new(
+          :name => 'Roll over this icon',
+          :style_url => '#exampleStyleMap',
+          :geometry => Point.new(
+            :coordinates => '-122.0856545755255,37.42243077405461,0'
+          )
+        )
+      ]
+    )
+    assert_equal File.read('test/style_map.kml'), kml.render
+  end
+end