sketch 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.irbrc
+

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in sketch.gemspec
+gemspec
+
+group :test do
+  gem 'test-unit'
+  gem 'mocha'
+end
+

data/README.markdown

@@ -0,0 +1,12 @@
+Introducing Sketch
+====================
+
+
+Examples
+-------
+
+_basic syntax_
+
+      class Smile < Sketch::Base
+        
+

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/testtask'
+
+desc "Run unit tests"
+Rake::TestTask.new("test") { |t|
+  t.libs << 'test'
+  t.pattern = 'test/*.rb'
+  t.verbose = true
+  t.warning = true
+}
+
+desc 'Generate HTML readme file'
+task :readme do
+  `markdown README.markdown > README.html`
+end
+
+desc 'clean temporary files, rdoc, and gem package'
+task :clean => [:clobber_package, :clobber_rdoc] do
+  temp_filenames = File.join('**', '*.*~')
+  temp_files = Dir.glob(temp_filenames)
+  
+  File.delete(*temp_files) 
+end
+

data/TODO.txt

@@ -0,0 +1,4 @@
+1. Add all SVG elements
+2. Add all attributes to the canvas
+3. Add Element#to_raphael http://raphaeljs.com/
+

data/examples/smile.rb

@@ -0,0 +1,24 @@
+class Smile < Sketch
+
+#  def draw( canvas )
+#    circle.new(:id => 'face', :cx => 200, :cy => 200, :r => 195, :fill => "yellow")
+#    ellipse(:id => 'left-eye', :center => [120, 150], :radius => [p18, 33], :fill => 'black')
+#    ellipse(:id => 'right-eye', :center => [280, 150], :radius => [18, 33], :fill => 'black')
+#    path(:id => 'mount', :stoke_width => '10', :stroke => 'black', :stroke_linecap => 'round') do |instructions|
+#      instructions.move_to 120, 280
+#      instructions.q 200, 330 280,280
+#    end
+#  end
+
+  def draw( canvas )
+    Circle.new(:id => 'face', :cx => 200, :cy => 200, :r => 195, :fill => "yellow").draw(canvas)
+    Sketch::Ellipse.new(:id => 'left-eye', :cx => 120, :cy => 150, :rx => 18, :ry => 33, :fill => 'black').draw(canvas)
+    Sketch::Ellipse.new(:id => 'right-eye', :cx => 280, :cy => 150, :rx => 18, :ry => 33, :fill => 'black').draw(canvas)
+    Sketch::Path.new(:id => 'mouth', :stroke_width => 10, :stroke => 'black', :fill => 'none', :stroke_linecap => 'round', :d => ['M120,280 Q200,330 280,280']).draw(canvas)
+  end
+
+end
+
+
+
+

data/lib/sketch.rb

@@ -0,0 +1,49 @@
+class Sketch < Valuable
+
+  has_value :id
+  has_value :klass
+  has_value :height
+  has_value :width
+  has_value :baseProfile, :alias => :base_profile
+  has_value :doctype
+
+  def draw(canvas)
+    raise NotImplementedError
+  end
+
+  def to_svg( )
+    svg_builder do |canvas|
+      self.draw( canvas )
+    end.to_xml
+  end
+
+  def to_html
+    svg_builder do |canvas|
+      self.draw( canvas )
+    end.doc.root.to_s
+  end
+
+  def svg_attributes
+    out = {}
+    out[:height]  = self.height if self.height
+    out[:width]   = self.width if self.width
+    out[:doctype] = self.doctype if self.doctype
+    out
+  end
+
+  def svg_builder
+    Canvas.new( svg_attributes ).builder {|canvas| yield canvas}
+  end
+
+end
+
+require 'sketch/base'
+require 'sketch/element'
+require 'sketch/canvas'
+
+require 'sketch/circle'
+require 'sketch/ellipse'
+require 'sketch/rect'
+require 'sketch/rectangle'
+require 'sketch/path'
+

data/lib/sketch/base.rb

@@ -0,0 +1,15 @@
+module Sketch::Base
+  def svg_attributes
+    out = {}
+
+    #svg is heavy in dashes. Ruby symbols can't handle them.
+    attributes.each do |name, value|
+      out[name.to_s.gsub('_', '-')] = value
+    end
+
+    out[:class] = out.delete(:klass) if out.has_key?(:klass)
+
+    out
+  end
+end
+

data/lib/sketch/canvas.rb

@@ -0,0 +1,43 @@
+class Sketch::Canvas < Valuable
+  include Sketch::Base
+
+  has_value :version, :default => '1.1'
+  has_value :height
+  has_value :width
+  has_value :doctype, :default => false
+  
+  def namespace_bindings
+    {
+      'xmlns' => 'http://www.w3.org/2000/svg',
+      'xmlns:ev' => 'http://www.w3.org/2001/xml-events',
+      'xmlns:xlink' => 'http://www.w3.org/1999/xlink'
+    }
+  end
+
+  def builder
+    Nokogiri::XML::Builder.new do |document|
+      render_doctype( document ) 
+      document.svg( svg_attributes ) {|svg| yield svg if block_given?}
+    end
+  end
+
+  def default_doctype
+    ['svg', "-//W3C//DTD SVG 1.0//EN", "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd"]
+  end
+
+  def render_doctype( document )
+    self.doctype &&= self.default_doctype
+
+    if( self.doctype )
+      document.doc.create_internal_subset(*self.doctype)
+    end
+  end
+
+  def svg_attributes
+    atts = super
+    atts.delete('doctype')
+    atts.merge(namespace_bindings)
+  end
+
+end
+

data/lib/sketch/circle.rb

@@ -0,0 +1,14 @@
+class Sketch::Circle < Sketch::Element
+
+  has_value :cx
+  has_value :cy
+  has_value :r, :alias => :radius
+  has_value :fill
+  has_value :stroke 
+  has_value :stroke_width
+
+  def draw(canvas)
+    canvas.circle(:cx => self.cx, :cy => self.cy, :r => self.radius, :fill => self.fill, :stroke => self.stroke, 'stroke_width' => self.stroke_width)
+  end
+end
+

data/lib/sketch/element.rb

@@ -0,0 +1,16 @@
+class Sketch::Element < Valuable
+  include Sketch::Base
+
+  has_value :id
+  has_value :klass
+  has_value :style
+
+  def draw(canvas)
+    canvas.send( self.svg_node, svg_attributes )
+  end
+
+  def svg_node
+    self.class.name.split('::').last.downcase
+  end
+end
+

data/lib/sketch/ellipse.rb

@@ -0,0 +1,13 @@
+class Sketch::Ellipse < Sketch::Element
+  
+  has_value :cx
+  has_value :cy
+  has_value :rx
+  has_value :ry
+  has_value :radius
+  has_value :fill
+  has_value :stroke 
+  has_value :stroke_width
+
+end
+

data/lib/sketch/path.rb

@@ -0,0 +1,17 @@
+class Sketch::Path < Sketch::Element
+
+  has_value :fill
+  has_value :stroke
+  has_value :stroke_width
+  has_value :stroke_linecap
+  has_value :d, :alias => 'commands', :default => [] 
+
+  def draw(canvas)
+    canvas.path(svg_attributes)
+  end
+
+  def svg_attributes
+    super.merge(:d => self.commands.join(' '))
+  end
+end
+

data/lib/sketch/rect.rb

@@ -0,0 +1,14 @@
+class Sketch::Rect < Sketch::Element
+
+  has_value :x
+  has_value :y
+  has_value :width
+  has_value :height
+  has_value :rx
+  has_value :ry
+  has_value :fill
+  has_value :stroke
+  has_value :stroke_width
+
+end
+

data/lib/sketch/rectangle.rb

@@ -0,0 +1 @@
+Sketch::Rectangle = Sketch::Rect

data/sketch.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)  
+version = File.read(File.expand_path("../sketch.version",__FILE__)).strip
+
+spec = Gem::Specification.new do |s|
+  s.name = 'sketch'
+  s.version = version 
+  s.summary = "build SVG images"
+  s.description = "build SVG images"
+  s.license = 'MIT'
+
+  s.require_path = 'lib'
+
+  s.add_dependency('valuable', '> 0.8')
+  s.add_dependency('nokogiri', '>= 1.4')
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+
+  s.authors = ["Johnathon Wright"]
+  s.email = "jw@mustmodify.com"
+  s.homepage = "http://sketch.mustmodify.com/"
+end
+

data/sketch.version

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

data/test/base_test.rb

@@ -0,0 +1,16 @@
+require 'test/helper.rb'
+
+class Squigly < Sketch::Element
+  has_value :reflective_coating
+end
+
+class SketchTest < Test::Unit::TestCase
+
+  def test_that_node_is_based_on_name
+    canvas = stub
+    canvas.expects(:squigly)
+    Squigly.new.draw(canvas)
+  end
+
+end
+

data/test/canvas_test.rb

@@ -0,0 +1,16 @@
+require 'helper'
+
+class CanvasTest < Test::Unit::TestCase
+
+  def test_that_width_is_configurable
+    art = Sketch::Canvas.new(:width => 350).builder.to_xml
+    assert_equal 1, Nokogiri::XML(art).css('svg[width="350"]').size
+  end
+
+  def test_that_height_is_configurable
+    art = Sketch::Canvas.new(:height => 450).builder.to_xml
+    assert_equal 1, Nokogiri::XML(art).css('svg[height="450"]').size
+  end
+
+end
+

data/test/doctype_test.rb

@@ -0,0 +1,26 @@
+require 'helper'
+
+class Minimalist < Sketch
+  def draw( canvas )
+  end
+end
+
+class DoctypeTest < Test::Unit::TestCase
+
+  def test_that_doctype_is_off_by_default
+    assert_equal false, Sketch::Canvas.new.doctype
+  end
+
+  def test_that_it_does_not_include_doctype_by_default
+    # https://jwatt.org/svg/authoring/#doctype-declaration
+    artwork = Minimalist.new.to_svg
+    assert_no_match(/doctype/i, artwork)
+  end
+
+  def test_that_it_includes_doctype_when_configured
+    artwork = Minimalist.new(:doctype => true).to_svg
+    assert_match(/doctype/i, artwork)
+  end
+
+end
+

data/test/helper.rb

@@ -0,0 +1,15 @@
+#prerequisites
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+require 'nokogiri'
+require 'valuable'
+
+$:.push File.expand_path("./../../lib", __FILE__)
+$:.push File.expand_path("./../../lib/sketch", __FILE__)
+
+require 'sketch'
+require 'sketch/canvas'
+require 'sketch/base'
+require 'sketch/element'
+

data/test/svg_namespace_test.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+class Minimalist < Sketch
+  def draw( canvas )
+  end
+end
+
+class DoctypeTest < Test::Unit::TestCase
+
+  def test_that_it_adds_namespace_binds_by_default
+    # https://jwatt.org/svg/authoring/#doctype-declaration
+    artwork = Minimalist.new.to_svg
+    svgns = %r(xmlns="http://www.w3.org/2000/svg")
+    xmlns = %r(xmlns:xlink="http://www.w3.org/1999/xlink")
+    xlinkns = %r(xmlns:ev="http://www.w3.org/2001/xml-events")
+
+    assert_match svgns, artwork
+    assert_match xmlns, artwork
+    assert_match xlinkns, artwork
+  end
+
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: sketch
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Johnathon Wright
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: valuable
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id002
+description: build SVG images
+email: jw@mustmodify.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- TODO.txt
+- examples/smile.rb
+- lib/sketch.rb
+- lib/sketch/base.rb
+- lib/sketch/canvas.rb
+- lib/sketch/circle.rb
+- lib/sketch/element.rb
+- lib/sketch/ellipse.rb
+- lib/sketch/path.rb
+- lib/sketch/rect.rb
+- lib/sketch/rectangle.rb
+- sketch.gemspec
+- sketch.version
+- test/.canvas_test.rb.swp
+- test/base_test.rb
+- test/canvas_test.rb
+- test/doctype_test.rb
+- test/helper.rb
+- test/svg_namespace_test.rb
+homepage: http://sketch.mustmodify.com/
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: build SVG images
+test_files: []
+