amanzi-sld 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Craig Taverner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,131 @@
+= Amanzi::SLD
+
+A Ruby DSL for simpler SLD creation for styling maps
+
+Map styles are often defined using SLD, or Style Layer Descriptor documents.
+These XML documents are very long, verbose and complex to maintain. 
+Amanzi:SLD is a simpler DSL designed to generate SLD documents, but using a
+very much simpler syntax.  Many common cases might be a single line only,
+while the simplest SLD is usually a dozen lines or more.
+
+=== What is SLD?
+
+There are great tutorials on the GeoServer wiki for SLD styling. Please take
+a look at {GeoServer Styling}[http://docs.geoserver.org/stable/en/user/styling/index.html]
+
+In brief, SLD is an XML syntax for specifying map layer styling. That is how
+to draw map layers.  This includes simple things like what color and
+thickness a line should be as well as more complex topics like applying the
+style only to geometries matching certain filters and combining styles to
+create interesting effects.  In principle it should be possible to create
+maps as good looking as one normally sees on sites like maps.google.com and
+openstreetmap.org.
+
+=== Why use Amanzi::SLD?
+
+Well, The very simplest document in Amanzi::SLD is three lines long, while the
+same one in normal XML is almost 30 lines long. Consider:
+
+  require 'amanzi/sld'
+  sld = Amanzi::SLD::Document.new('Test')
+  sld.add_line_symbolizer :stroke => '#3050e0'
+
+This will become the SLD document:
+
+  <?xml version="1.0" encoding="ISO-8859-1"?>
+  <StyledLayerDescriptor xmlns:xlink="http://www.w3.org/1999/xlink"
+  xsi:schemaLocation="http://www.opengis.net/sld
+  http://schemas.opengis.net/sld/1.0.0/StyledLayerDescriptor.xsd"
+  xmlns:ogc="http://www.opengis.net/ogc" version="1.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xmlns="http://www.opengis.net/sld">
+      <NamedLayer>
+          <Name>Test</Name>
+          <UserStyle>
+              <Name>Test</Name>
+              <FeatureTypeStyle>
+                  <Rule>
+                      <LineSymbolizer>
+                          <Stroke>
+                              <CssParameter name="stroke">#000000</CssParameter>
+                              <CssParameter name="stroke-width">1</CssParameter>
+                          </Stroke>
+                      </LineSymbolizer>
+                  </Rule>
+              </FeatureTypeStyle>
+              <FeatureTypeStyle>
+                  <Rule>
+                      <LineSymbolizer>
+                          <Stroke>
+                              <CssParameter name="stroke">#000000</CssParameter>
+                              <CssParameter name="stroke-width">1</CssParameter>
+                          </Stroke>
+                      </LineSymbolizer>
+                  </Rule>
+              </FeatureTypeStyle>
+          </UserStyle>
+      </NamedLayer>
+  </StyledLayerDescriptor>
+
+=== How to get started?
+
+The easiest way to get started would be to install the ruby gem using:
+
+  sudo gem install amanzi-sld
+
+There is a chance that the gem is not yet available, in which case your next
+option is to download from source using:
+
+  git clone git://github.com/craigtaverner/amanzi-sld.git
+  cd amanzi-sld
+  rake install
+
+Then you can create your ruby script with an appropriate content, for
+example:
+
+  require 'rubygems'
+  require 'amanzi/sld'
+
+  sld = Amanzi::SLD::Document.new 'My SLD Document'
+
+  sld.add_line_symbolizer
+    :stroke => '#004400',
+    :stroke_width => 2,
+    :geometry => 'LineString'
+
+  sld.add_polygon_symbolizer
+    :stroke => '#004400',
+    :stroke_width => 2,
+    :geometry => 'Polygon'
+
+=== Advanced options
+
+I will write this up when I get a chance. In the meantime I recommend
+looking at the more complex examples in the examples/ directory. Better yet,
+run them and see what the output looks like.
+* test.rb
+  * This actually uses several redundant combinations of syntax to test the SLD as well as the underlying XML DSL on which it is based
+  * This is also run by the normal rake tests, called from test/test_file.rb
+  * The file test.sld is the expected output which the test will compare with
+* osm.rb
+  * This advanced example works with the OpenStreetMap model imported into Neo4j Spatial, and then exposed as one or more layers to GeoServer or uDig
+  * I know the colors are ugly, but it is just a demonstration of some of the options available, including labeling
+  * Have a look at {Neo4j Spatial}[http://github.com/neo4j/neo4j-spatial] for more on the data being styled. That project actually uses Amanzi:SLD for some of the default styles being built into the OSM DataStore.
+* osm_highway_shp.rb
+  * This example works with the highway Shapefile generated from OSM data by CloudMade. See the {CloudMade downloads}[http://downloads.cloudmade.com]
+
+You can also read the test code in the test/ directory for information on some of the syntax options being tested.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Craig Taverner. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "amanzi-sld"
+    gem.summary = "A Ruby DSL for simpler SLD creation for styling maps"
+    gem.description = "Map styles are often defined using SLD, or Style Layer Descriptor documents. These XML documents are very long, verbose and complex to maintain. Amanzi:SLD is a simpler DSL designed to generate SLD documents, but using a very much simpler syntax. Many common cases might be a single line only, while the simplest SLD is usually a dozen lines or more."
+    gem.email = "craig@amanzi.com"
+    gem.homepage = "http://github.com/craigtaverner/amanzi-sld"
+    gem.authors = ["Craig Taverner"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "differ", ">= 0.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "amanzi-sld #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/amanzi-sld.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{amanzi-sld}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Craig Taverner"]
+  s.date = %q{2010-11-02}
+  s.description = %q{Map styles are often defined using SLD, or Style Layer Descriptor documents. These XML documents are very long, verbose and complex to maintain. Amanzi:SLD is a simpler DSL designed to generate SLD documents, but using a very much simpler syntax. Many common cases might be a single line only, while the simplest SLD is usually a dozen lines or more.}
+  s.email = %q{craig@amanzi.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "amanzi-sld.gemspec",
+     "examples/osm.rb",
+     "examples/osm_highway_shp.rb",
+     "examples/test.rb",
+     "examples/test.sld",
+     "lib/amanzi-sld.rb",
+     "lib/amanzi/sld.rb",
+     "lib/amanzi/xml.rb",
+     "test/helper.rb",
+     "test/test_file.rb",
+     "test/test_sld.rb",
+     "test/test_xml.rb"
+  ]
+  s.homepage = %q{http://github.com/craigtaverner/amanzi-sld}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Ruby DSL for simpler SLD creation for styling maps}
+  s.test_files = [
+    "test/test_file.rb",
+     "test/test_xml.rb",
+     "test/test_sld.rb",
+     "test/helper.rb",
+     "examples/osm.rb",
+     "examples/test.rb",
+     "examples/osm_highway_shp.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<differ>, [">= 0.1"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<differ>, [">= 0.1"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<differ>, [">= 0.1"])
+  end
+end
+

data/examples/osm.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+# This script uses the amanzi-sld DSL to create a sample SLD file
+# for styling a number of layers in a typical OSM data model.
+# This example should work with a layer containing all geometries.
+
+require 'amanzi/sld'
+
+Amanzi::SLD::Config.config[:geometry_property] = 'the_geom'
+Amanzi::SLD::Config.config[:verbose] = true
+
+sld = Amanzi::SLD::Document.new "Example Neo4j Spatial OSM Style"
+
+sld.comment "A catch-all style for all ways, drawn first so it only shows if anyther style does not apply"
+sld.add_line_symbolizer(:stroke => '#dddddd')
+
+sld.comment "A catch-all style for all Polygons"
+sld.add_polygon_symbolizer(
+  :fill => '#aaaaaa',
+  :fill_opacity => '0.4',
+  :stroke => '#ffe0e0',
+  :geometry => 'Polygon'
+)
+
+sld.comment "Color areas of land-use"
+sld.add_polygon_symbolizer(
+  :fill => '#d0d0d0',
+  :fill_opacity => '0.6',
+  :stroke => '#e0e0e0',
+  :geometry => 'Polygon'
+) do |f|
+  f.property.exists? 'landuse'
+end
+
+# Old code below, copied from test.rb
+
+sld.comment "A catch-all style for all ways, drawn first so it only shows if anyther style does not apply"
+sld.
+  add_line_symbolizer(:stroke_width => 7, :stroke => '#303030').
+  add_line_symbolizer(:stroke_width => 5, :stroke => '#e0e0ff') do |f|
+  puts "Setting up AND filters: #{f.inspect}"
+  f.op(:and) do |f|
+    puts "Setting up property filters: #{f.inspect}"
+    f.property.exists? :highway
+    f.op(:or) do |f|
+      f.property[:highway] = 'secondary'
+      f.property[:highway] = 'tertiary'
+    end
+  end
+end
+
+puts sld.to_xml(:tab => '    ')
+
+#HTML::Document.test
+

data/examples/osm_highway_shp.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/env ruby
+
+# This SLD should work with OSM standard export to SHP format, as provided by CloudMade
+# on their downloads pages. In those files the properties are all provided as values
+# of the TYPE parameter. I tested this on an extract from Berlin and it handles a range
+# of zoom levels.
+
+# In case you are running this from source
+$:<< 'lib'
+$:<< '../lib'
+
+# In case you have amanzi/sld as a ruby gem
+require 'rubygems'
+require 'amanzi/sld'
+
+# Define some common filtering rules
+major_highways = Proc.new do |f|
+  f.op(:or) do |f|
+    f.property[:TYPE] = 'primary'
+    f.property[:TYPE] = 'motorway'
+  end
+end
+
+highways = Proc.new do |f|
+  f.op(:or) do |f|
+    f.property[:TYPE] = 'primary'
+    f.property[:TYPE] = 'secondary'
+    f.property[:TYPE] = 'motorway'
+  end
+end
+
+main_roads = Proc.new do |f|
+  f.op(:or) do |f|
+    f.property[:TYPE] = 'primary'
+    f.property[:TYPE] = 'secondary'
+    f.property[:TYPE] = 'tertiary'
+    f.property[:TYPE] = 'motorway'
+    f.property[:TYPE] = 'residential'
+  end
+end
+
+sld = Amanzi::SLD::Document.new "OSM Highways"
+
+# when zoomed out, draw only main highways
+sld.add_line_symbolizer :stroke => '#b0b0b0', :stroke_width => 1, :min_scale => 70000 do |f|
+  highways.call f
+end
+sld.add_line_symbolizer :stroke => '#b0b0b0', :stroke_width => 3, :min_scale => 70000 do |f|
+  major_highways.call f
+end
+sld.add_line_symbolizer :stroke => '#f0f0a0', :stroke_width => 2, :min_scale => 70000 do |f|
+  major_highways.call f
+end
+
+# moderate zoom, show main roads only
+sld.add_line_symbolizer :stroke => '#b0b0b0', :stroke_width => 1, :max_scale => 70000, :min_scale => 35000 do |f|
+  main_roads.call f
+end
+sld.add_line_symbolizer :stroke => '#b0b0b0', :stroke_width => 3, :max_scale => 70000, :min_scale => 35000 do |f|
+  highways.call f
+end
+sld.add_line_symbolizer :stroke => '#f0f0a0', :stroke_width => 2, :max_scale => 70000, :min_scale => 35000 do |f|
+  highways.call f
+end
+
+# zoomed in more, show all roads with some width and draw main and highways over that
+sld.add_line_symbolizer :stroke => '#d0d0d0', :stroke_width => 2, :max_scale => 35000, :min_scale => 15000
+sld.add_line_symbolizer :stroke => '#909090', :stroke_width => 3, :max_scale => 35000, :min_scale => 15000 do |f|
+  highways.call f
+end
+sld.add_line_symbolizer :stroke => '#b0b0b0', :stroke_width => 1, :max_scale => 35000, :min_scale => 15000
+sld.add_line_symbolizer :stroke => '#b0f0f0', :stroke_width => 1, :max_scale => 35000, :min_scale => 15000 do |f|
+  main_roads.call f
+end
+sld.add_line_symbolizer :stroke => '#f0f0a0', :stroke_width => 2, :max_scale => 35000, :min_scale => 15000 do |f|
+  highways.call f
+end
+
+# zoomed in the most, show all roads, and highlight main roads and highways
+sld.add_line_symbolizer :stroke => '#909090', :stroke_width => 3, :max_scale => 15000
+sld.add_line_symbolizer :stroke => '#f0f0f0', :stroke_width => 2, :max_scale => 15000
+sld.add_line_symbolizer :stroke => '#909090', :stroke_width => 5, :max_scale => 15000 do |f|
+  main_roads.call f
+end
+
+sld.add_line_symbolizer :stroke => '#909090', :stroke_width => 7, :max_scale => 15000 do |f|
+  highways.call f
+end
+
+sld.add_line_symbolizer :stroke => '#e0e0e0', :stroke_width => 3, :max_scale => 15000 do |f|
+  main_roads.call f
+end
+
+sld.add_line_symbolizer :stroke => '#f0f0a0', :stroke_width => 5, :max_scale => 15000 do |f|
+  highways.call f
+end
+
+#sld.add_text_symbolizer :property => 'name', :font_size => 18, :halo => 2, :max_scale => 15000 do |f|
+#  highways.call f
+#end
+
+puts sld.to_xml :tab => '  '
+