ruby_svg_light 0.0.2 → 0.0.3

data/HISTORY.md

@@ -0,0 +1,31 @@
+HISTORY/Changelog
+=================
+
+0.0.3
+-----
+
+ Text placemnet options
+ 1) Added :text_horizontal_centre=>true
+ 2) Added :text_vertical_centre=>true
+ 3) Added :text_centre
+
+ Added Specs for basic shapes and text allingment
+
+0.0.2
+-----
+
+ Added Rakefile
+ Added support for ellipse
+
+0.0.1
+-----
+
+ Initial build with:
+   circle
+   rectangle
+   line
+   text
+
+ Retrival of svg is via to_file or to_s
+
+

data/README.md

@@ -0,0 +1,71 @@
+RubySVGLight
+============
+
+Install
+-------
+
+    gem install ruby_svg_light
+
+Usage
+-----
+
+Create a new document (canvas) with RubySVGLight::Document.new then add the shapes you require to it. Finally use to_file to generate the file or call to_s to return the string of the SVG (useful for webapps).
+
+Shapes available (x and y starting coordinates and cx and cy center of circle and ellipse)
+
+    circle(cx, cy, radius)
+    rectangle(x, y, width, height)
+    line(x, y, width, height)
+    text(x, y, 'text')
+    ellipse(cx, cy, horizontal_radius, vertical_radius)
+
+All can take a options hash as a final option. Supported options are:
+
+    options[:stroke]       
+    options[:stroke_width] 
+    options[:fill]         
+    options[:font_size]    
+
+Global options can also be set by passing to new or options, as seen in second example.
+
+
+Examples
+--------
+
+    require 'ruby_svg_light'
+    a = RubySVGLight::Document.new()
+    a.circle(20,10,10)
+    a.to_file('test.svg')
+
+Second Example, From the Examples directory
+
+    require 'ruby_svg_light'
+    canvas = RubySVGLight::Document.new
+    canvas.circle(40,40,20)
+    canvas.rectangle(80,20,40,40)
+    canvas.line(20,80,100,0)
+    canvas.line(20,105,100,0)
+    
+    #Set Global Options
+    options = {:font_size=>'12px'}
+    canvas.options(options)
+    canvas.text(20,100, 'HelloWorld!')
+    
+    #Set Local Options
+    canvas.text(20,130, 'HelloWorld!', {:font_size=>'18px'})
+    
+    canvas.to_file('shapes.svg')
+
+Text placment options
+
+    canvas.text(0,20, 'HelloWorld!', {:text_horizontal_centre=>true})
+    canvas.text(0,0,  'HelloWorld!', {:text_vertical_centre=>true})
+    # Centre Horizontally and Vertically
+    canvas.text(0,40, 'HelloWorld!', {:text_centre=>true})
+    
+
+
+TODO
+----
+
+Add support for path

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rspec/core/rake_task'
+
+file_list = FileList['spec/*_spec.rb']
+
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = file_list
+  t.rspec_opts = ["--colour", "--format progress", "-p"]
+end
+
+desc 'Default: run specs.'
+task :default => 'spec'

data/examples/text_position.rb

@@ -0,0 +1,71 @@
+
+test = false #require 'ruby_svg_light'
+if not test
+  require '../lib/ruby_svg_light'
+end
+
+def drawbox_with_crosshairs(canvas, x, y, width, height)
+  hheight  = height/2
+  hwidth   = width/2
+  pointer  = 20
+  hpointer = pointer/2
+
+  canvas.rectangle(x,y,width,height)
+  canvas.line(x+hwidth-hpointer,y+hheight,pointer,0)
+  canvas.line(x+hwidth,y+hheight-hpointer,0,pointer)
+end
+
+canvas = RubySVGLight::Document.new
+width,height = 100,40
+x,y = 20,20 
+drawbox_with_crosshairs(canvas, x ,y, width, height)
+canvas.text( x+(100/2), y+(40/2), 'HelloWorld', {:font_size=>'12px'})
+# Demo of expected positioning
+canvas.rectangle(x+width+20,y,width,height, {:fill=>'white'})
+canvas.rectangle(x+width+20+(width/2),y,width/2,height/2, {:fill=>'green'})
+
+
+x,y = 20,4*20 
+drawbox_with_crosshairs(canvas, x ,y, 100, 40)
+canvas.text( x+(100/2), y+(40/2), 'HelloWorld', {:font_size=>'12px',:text_horizontal_top=>true})
+# Demo of expected positioning
+canvas.rectangle(x+width+20,y,width,height, {:fill=>'white'})
+canvas.rectangle(x+width+20+(width/2),y,width/2,height/2, {:fill=>'green'})
+
+
+x,y = 20,7*20 
+drawbox_with_crosshairs(canvas, x ,y, 100, 40)
+canvas.text( x+(100/2), y+(40/2), 'HelloWorld', {:font_size=>'12px',:text_horizontal_middle=>true})
+# Demo of expected positioning
+canvas.rectangle(x+width+20,y,width,height, {:fill=>'white'})
+canvas.rectangle(x+width+20+(width/4),y,width/2,height/2, {:fill=>'green'})
+
+
+x,y = 20,10*20 
+drawbox_with_crosshairs(canvas, x ,y, 100, 40)
+canvas.text( x+(100/2), y+(40/2), 'HelloWorld', {:font_size=>'12px',:text_horizontal_bottom=>true})
+# Demo of expected positioning
+canvas.rectangle(x+width+20,y,width,height, {:fill=>'white'})
+canvas.rectangle(x+width+20+(width/2),y,width/2,height/2, {:fill=>'green'})
+
+
+
+
+
+x,y = 20,13*20 
+drawbox_with_crosshairs(canvas, x ,y, 100, 40)
+canvas.text( x+(100/2), y+(40/2), 'HelloWorld', {:font_size=>'12px',:text_vertical_middle=>true})
+# Demo of expected positioning
+canvas.rectangle(x+width+20,y,width,height, {:fill=>'white'})
+canvas.rectangle(x+width+20+(width/2),y+(height/4),width/2,height/2, {:fill=>'green'})
+
+
+x,y = 20,16*20 
+drawbox_with_crosshairs(canvas, x ,y, 100, 40)
+canvas.text( x+(100/2), y+(40/2), 'HelloWorld', {:font_size=>'12px',:text_horizontal_middle=>true, :text_vertical_middle=>true})
+# Demo of expected positioning
+canvas.rectangle(x+width+20,y,width,height, {:fill=>'white'})
+canvas.rectangle(x+width+20+(width/4),y+(height/4),width/2,height/2, {:fill=>'green'})
+
+
+canvas.to_file('text_position.svg')

data/examples/text_position.svg

@@ -0,0 +1,285 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+
+<svg
+ width="100%"
+ height="100%"
+ version="1.1"
+ xmlns="http://www.w3.org/2000/svg">
+ 
+<rect
+       x="20"         y="20"
+       width="100" height="40"
+       fill="white"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<line
+       x1="60" y1="40"
+       x2="80" y2="40"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<line
+       x1="70" y1="30"
+       x2="70" y2="50"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<text
+       x="70" y="40" 
+       font-size="12px"
+       fill="#000000"
+       font-family="Sans"
+       >HelloWorld
+       </text>
+<rect
+       x="140"         y="20"
+       width="100" height="40"
+       fill="white"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<rect
+       x="190"         y="20"
+       width="50" height="20"
+       fill="green"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<rect
+       x="20"         y="80"
+       width="100" height="40"
+       fill="white"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<line
+       x1="60" y1="100"
+       x2="80" y2="100"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<line
+       x1="70" y1="90"
+       x2="70" y2="110"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<text
+       x="70" y="100" 
+       style="text-anchor: top; " 
+       font-size="12px"
+       fill="#000000"
+       font-family="Sans"
+       >HelloWorld
+       </text>
+<rect
+       x="140"         y="80"
+       width="100" height="40"
+       fill="white"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<rect
+       x="190"         y="80"
+       width="50" height="20"
+       fill="green"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<rect
+       x="20"         y="140"
+       width="100" height="40"
+       fill="white"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<line
+       x1="60" y1="160"
+       x2="80" y2="160"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<line
+       x1="70" y1="150"
+       x2="70" y2="170"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<text
+       x="70" y="160" 
+       style="text-anchor: middle; " 
+       font-size="12px"
+       fill="#000000"
+       font-family="Sans"
+       >HelloWorld
+       </text>
+<rect
+       x="140"         y="140"
+       width="100" height="40"
+       fill="white"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<rect
+       x="165"         y="140"
+       width="50" height="20"
+       fill="green"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<rect
+       x="20"         y="200"
+       width="100" height="40"
+       fill="white"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<line
+       x1="60" y1="220"
+       x2="80" y2="220"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<line
+       x1="70" y1="210"
+       x2="70" y2="230"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<text
+       x="70" y="220" 
+       style="text-anchor: bottom; " 
+       font-size="12px"
+       fill="#000000"
+       font-family="Sans"
+       >HelloWorld
+       </text>
+<rect
+       x="140"         y="200"
+       width="100" height="40"
+       fill="white"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<rect
+       x="190"         y="200"
+       width="50" height="20"
+       fill="green"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<rect
+       x="20"         y="260"
+       width="100" height="40"
+       fill="white"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<line
+       x1="60" y1="280"
+       x2="80" y2="280"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<line
+       x1="70" y1="270"
+       x2="70" y2="290"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<text
+       x="70" y="280" 
+       style="dominant-baseline: central; " 
+       font-size="12px"
+       fill="#000000"
+       font-family="Sans"
+       >HelloWorld
+       </text>
+<rect
+       x="140"         y="260"
+       width="100" height="40"
+       fill="white"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<rect
+       x="190"         y="270"
+       width="50" height="20"
+       fill="green"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<rect
+       x="20"         y="320"
+       width="100" height="40"
+       fill="white"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<line
+       x1="60" y1="340"
+       x2="80" y2="340"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<line
+       x1="70" y1="330"
+       x2="70" y2="350"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<text
+       x="70" y="340" 
+       style="dominant-baseline: central; text-anchor: middle; " 
+       font-size="12px"
+       fill="#000000"
+       font-family="Sans"
+       >HelloWorld
+       </text>
+<rect
+       x="140"         y="320"
+       width="100" height="40"
+       fill="white"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+<rect
+       x="165"         y="330"
+       width="50" height="20"
+       fill="green"
+       stroke="#000000"
+       stroke-width="1"
+       />
+       
+</svg>

data/lib/ruby_svg_light.rb

@@ -1,6 +1,6 @@
 
 module RubySVGLight
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 
   class Document
     attr_reader :body
@@ -51,7 +51,6 @@ module RubySVGLight
       fill="#{local_options[:fill]}"/>
       }
 
-      #The call below should be in method missing add_[circle|line|rectangle]
       update_size(x+radius, y+radius)
       @body << text
     end
@@ -103,22 +102,45 @@ module RubySVGLight
       centre_text = "text-anchor:middle; dominant-baseline:central;"
       local_options = calc_local_options(opts)
 
+      text_vertical_centre  =  local_options[:text_centre] ||
+                               local_options[:text_vertical_middle] ||
+                               local_options[:text_vertical_centre] ||
+                               local_options[:text_v_middle] ||
+                               local_options[:text_v_centre]
+
+      text_horizontal_centre = local_options[:text_centre] ||
+                               local_options[:text_horizontal_middle] ||
+                               local_options[:text_horizontal_centre] ||
+                               local_options[:text_h_middle] ||
+                               local_options[:text_h_centre]
+
+
+      style = ""
+      style << "dominant-baseline: central; " if text_vertical_centre 
+
+      style << "text-anchor: top; "    if local_options[:text_horizontal_top]
+      style << "text-anchor: middle; " if text_horizontal_centre
+      style << "text-anchor: bottom; " if local_options[:text_horizontal_bottom]
+
 
       #Stroke is outline
       #fill is normal font. ie for text fill gets stroke colour
       text = %{<text
-       x="#{x}" y="#{y}"
+       x="#{x}" y="#{y}" }
+      
+      text << %{
+       style="#{style}" } unless style == ""
+      
+      text << %{
        font-size="#{local_options[:font_size]}"
        fill="#{local_options[:stroke]}"
        font-family="Sans"
        >#{input_text}
        </text>
 }
-      #{centre_text}"
-      # xml:space="preserve"
-      #Do not know height or width of text only the anchor
-      update_size(x, y)
-      @body << text
+       #Do not know height or width of text only the anchor
+       update_size(x, y)
+       @body << text
     end
 
     def options(opts={})
@@ -172,12 +194,6 @@ module RubySVGLight
     end
 
 
-    #def finalise
-    #  #Maybe add the initial and closing things here so we are just noramlly dealing drawn components
-    #  @body.insert(0,  header)
-    #  @body.insert(-1, footer)
-    #end
-
     # to_file includes header and footers for a complete svg file
     def to_file( filename )
       File.open(filename, 'w') do |f|
@@ -213,7 +229,11 @@ end
 
 
 if $0 == __FILE__
+  filename = 'test.svg'
+
   a = RubySVGLight::Document.new()
   a.circle(20,10,10)
-  a.to_file('test.svg')
+  a.to_file( filename )
+
+  puts "Created #{filename}"
 end

data/spec/ruby_svg_light_shapes_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+def shape_contains( shape )
+  #This has been split over 2 lines to fix a bug in my syntax highlighter :(
+  regex = %{<svg[\\w\\W]*>[\\W]*<#{shape}[\\w\\W]*\/>[\\W]*<\/svg>}
+  return /#{regex}/
+end
+
+
+
+describe RubySVGLight do
+
+  #Hooks
+  before( :each ) do
+    @canvas = RubySVGLight::Document.new()
+  end
+
+
+
+  #Tests
+  it "Draw a circle x=10, y=20, r=30" do
+    @canvas.circle(10,20,30)
+
+    @canvas.to_s.should match shape_contains( 'circle' )
+    @canvas.to_s.should include %{cx="10"}
+    @canvas.to_s.should include %{cy="20"}
+    @canvas.to_s.should include %{r="30"}
+  end
+  
+
+
+  it "Draw a rectangle x=10, y=20, width=30, height=40" do
+    @canvas.rectangle(10,20,30,40)
+
+    @canvas.to_s.should match shape_contains( 'rect' )
+    @canvas.to_s.should include %{x="10"}
+    @canvas.to_s.should include %{y="20"}
+    @canvas.to_s.should include %{width="30"}
+    @canvas.to_s.should include %{height="40"}
+  end
+
+
+
+  it "Draw a line x=10, y=20, width=30, height=40" do
+    @canvas.line(10,20,30,40)
+
+    #SVG lines are drawn specifying start and end coordinates. 
+    #RubySVGLite uses start coordinates and height width to make it consitent with other shapes.
+    @canvas.to_s.should match shape_contains( 'line' )
+    @canvas.to_s.should include %{x1="10"}
+    @canvas.to_s.should include %{y1="20"}
+    @canvas.to_s.should include %{x2="#{10+30}"}
+    @canvas.to_s.should include %{y2="#{20+40}"}
+  end
+
+
+
+  it "Draw an ellipse x=10, y=20, width=30, height=40" do
+    @canvas.ellipse(10,20,30,40)
+
+    @canvas.to_s.should match shape_contains( 'ellipse' )
+    @canvas.to_s.should include %{cx="10"}
+    @canvas.to_s.should include %{cy="20"}
+    @canvas.to_s.should include %{rx="30"}
+    @canvas.to_s.should include %{ry="40"}
+  end
+
+end
+
+

data/spec/ruby_svg_light_text_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+def style_contains( format )
+  #This has been split over 2 lines to fix a bug in my syntax highlighter :(
+  regex = %{style=\"(.*;)* ?#{format};(.*;)* ? \"}
+  return /#{regex}/
+end
+    
+describe RubySVGLight do
+  
+  #Hooks
+  before( :each ) do
+    @canvas = RubySVGLight::Document.new()
+    # 10 Random characters for test string changes for each test
+    @text = (0...10).map{ (('A'..'Z').to_a + ('a'..'z').to_a)[rand(52)] }.join
+  end
+
+  after( :each ) do
+    #Verify that actual text was included regardless of options used
+    @canvas.to_s.should include ">#{@text}\n       </text>"
+  end
+
+  
+
+
+
+  #Tests
+  it "Text, default font size" do
+    @canvas.text( 0, 0, @text)
+
+    @canvas.to_s.should include %{font-size="24px"} 
+  end
+
+  it "Text, set fontsize with local option" do
+    @canvas.text( 0, 0, @text, {:font_size=>'100px'})
+
+    @canvas.to_s.should include %{font-size="100px"}
+  end
+
+  it "Text, set fontsize with global option" do
+    @canvas.options( {:font_size=>'100px'} )
+    @canvas.text( 0, 0, @text)
+
+    @canvas.to_s.should include %{font-size="100px"} 
+  end
+
+
+
+
+
+  # The 4 ways to vertically centre text
+  it "Text, Vertical centre with :text_vertical_centre" do
+    @canvas.text( 0, 0, @text, {:text_vertical_centre=>true})
+
+    @canvas.to_s.should match style_contains("dominant-baseline: central")
+  end
+
+  it "Text, Vertical centre with :text_vertical_middle" do
+    @canvas.text( 0, 0, @text, {:text_vertical_middle=>true})
+
+    @canvas.to_s.should match style_contains("dominant-baseline: central")
+  end
+
+  it "Text, Vertical centre with :text_v_centre" do
+    @canvas.text( 0, 0, @text, {:text_v_centre=>true})
+
+    @canvas.to_s.should match style_contains("dominant-baseline: central")
+  end
+
+  it "Text, Vertical centre with :text_v_middle" do
+    @canvas.text( 0, 0, @text, {:text_v_middle=>true})
+
+    @canvas.to_s.should match style_contains("dominant-baseline: central")
+  end
+
+
+
+
+
+  # The 4 ways to horizontally centre text
+  it "Text, Horizontal centre with :text_horizontal_centre" do
+    @canvas.text( 0, 0, @text, {:text_horizontal_centre=>true})
+
+    @canvas.to_s.should match style_contains("text-anchor: middle")
+  end
+
+  it "Text, Horizontal centre with :text_horizontal_middle" do
+    @canvas.text( 0, 0, @text, {:text_horizontal_middle=>true})
+
+    @canvas.to_s.should match style_contains("text-anchor: middle")
+  end
+  it "Text, Horizontal centre with :text_h_centre" do
+    @canvas.text( 0, 0, @text, {:text_h_centre=>true})
+
+    @canvas.to_s.should match style_contains("text-anchor: middle")
+  end
+
+  it "Text, Horizontal centre with :text_h_middle" do
+    @canvas.text( 0, 0, @text, {:text_h_middle=>true})
+
+    @canvas.to_s.should match style_contains("text-anchor: middle")
+  end
+
+
+
+
+
+  #Vertical and Horizontal centre text
+  it "Text, Horizintal and Vertical centre with :text_horizontal_centre and :text_vertical_centre" do
+    @canvas.text( 0, 0, @text, {:text_horizontal_centre=>true,:text_vertical_centre=>true})
+
+    @canvas.to_s.should match style_contains("dominant-baseline: central")
+    @canvas.to_s.should match style_contains("text-anchor: middle")
+  end
+
+  it "Text, Horizintal and Vertical centre with :text_centre" do
+    @canvas.text( 0, 0, @text, {:text_centre=>true})
+
+    @canvas.to_s.should match style_contains("dominant-baseline: central")
+    @canvas.to_s.should match style_contains("text-anchor: middle")
+  end
+
+
+end
+
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_svg_light
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Morgan Prior
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-11 00:00:00 +01:00
+date: 2011-06-04 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -29,11 +29,18 @@ extra_rdoc_files: []
 
 files: 
 - LICENSE.rtf
+- README.md
+- HISTORY.md
+- Rakefile
 - examples/shapes.rb
 - examples/shapes.svg
+- examples/text_position.rb
+- examples/text_position.svg
 - lib/ruby_svg.rb
 - lib/ruby_svg.rb.original
 - lib/ruby_svg_light.rb
+- spec/ruby_svg_light_shapes_spec.rb
+- spec/ruby_svg_light_text_spec.rb
 - spec/ruby_svg_light_width_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true