xrvg 0.0.1 → 0.0.2

data/CHANGES

@@ -0,0 +1,34 @@
+= CHANGES
+== => v 0.0.2
+=== Content
+==== New features
+- bezier curve !!
+==== Refactoring
+- replace Vector extension (which was incoherent as some methods were specific 2D) by new 2D class V2D
+- Color no longer inherits from Vector
+- optimize bezier point computation
+- optimize sampling by using result "containers" (must be consolidated)
+- simplify Bezier builders, by defining new builders and removing previous builder versatility
+- refactor Style to be less SVG-mapped
+==== Bug fixing
+- range examples correction, and added to unitary tests
+- Range .complement correction
+- Range split correction
+=== TODO
+- unitary tests to be completed (generate them from doc ?)
+- Shape Line and Circle interfaces must be completed to fill Curve abstract interface.
+- mabe bezier tutorial
+
+
+== => 0.0.1
+=== Content
+- First delivery. Contains utilitary classes (utils, samplable, interpolation, attributable), render, color, style, shape.
+- But no bezier yet.
+- Rakefile nearly ready.
+- Some unitary tests
+=== TODO for 0.0.2
+- unitary tests to be completed (generate them from doc ?)
+- Shape Line and Circle interfaces must be completed to fill Curve abstract interface.
+- add bezier services, and make bezier documentation (both rdoc and tutorials)
+
+

data/README

@@ -1,6 +1,6 @@
 = XRVG -- X Ruby Vector Graphics
 
-Supporting XRVG version: 0.0.1
+Supporting XRVG version: 0.0.2
 
 This package contains XRVG, a Ruby vector graphic programming library.
 
@@ -35,7 +35,7 @@ XRVG comes with a Rakefile. To launch XRVG tests, simply go into XRVG install di
 
 === Road Map
 
-TO BE DEFINED
+See CHANGES
 
 == Simple Example
 

data/Rakefile

@@ -25,6 +25,7 @@ RUBYFORGE_USER = ENV["RUBYFORGE_USER"] || "jblondinet"
 
 # Directory on RubyForge where your website's files should be uploaded.
 WEBSITE_DIR = "www"
+WEBSITE_DIR_IMAGES = "#{WEBSITE_DIR}/images"
 
 # Output directory for the rdoc html files.
 # If you don't have a custom homepage, and want to use the RDoc
@@ -45,13 +46,7 @@ $LOAD_PATH.concat(REQUIRE_PATHS)
 # This library file defines the RAKEVERSION constant.
 require "#{UNIX_NAME}"
 PROJECT_VERSION = eval("\"#{XRVG_VERSION}\"") # e.g. "1.0.2"
-#---
-# Clobber object files and Makefiles generated by extconf.rb.
-CLOBBER.include("#{EXT_DIR}/**/*.{so,dll,o}", "#{EXT_DIR}/**/Makefile")
-# Clobber .config generated by setup.rb.
-CLOBBER.include(".config")
 
-CLEAN.include("test/**/*.svg", "examples/**/*.svg")
 #---
 # Options common to RDocTask AND Gem::Specification.
 #   The --main argument specifies which file appears on the index.html page
@@ -61,27 +56,33 @@ GENERAL_RDOC_OPTS = {
 }
 
 # Additional RDoc formatted files, besides the Ruby source files.
-RDOC_FILES = FileList["README"]
+RDOC_FILES = FileList["README", "CHANGES"]
 # Remove the following line if you don't want to extract RDoc from
 # the extension C sources.
 # RDOC_FILES.include(EXT_SOURCES)
 
 # Ruby library code.
 LIB_DIR = "lib"
-PRE_LIB_FILES = FileList["assertion.rb", "attributable.rb", "color.rb", "frame.rb", "geometry2D.rb", "interpolation.rb", "render.rb", "samplation.rb", "shape.rb", "style.rb", "trace.rb", "utils.rb", "xrvg.rb"]
+PRE_LIB_FILES = FileList["assertion.rb", "attributable.rb", "color.rb", "frame.rb", "geometry2D.rb", "interpolation.rb", "render.rb", "samplation.rb", "shape.rb", "style.rb", "trace.rb", "utils.rb", "bezier.rb", "bezierspline.rb", "xrvg.rb"]
 LIB_FILES = FileList["#{LIB_DIR}/*.rb"]
 
+# Example code.
+EXAMPLE_DIR = "examples"
+EXAMPLE_FILES = FileList["#{EXAMPLE_DIR}/*.rb"]
+
 # Filelist with Test::Unit test cases.
-TEST_FILES = FileList["test/test_*.rb"]
+TEST_DIR = "test"
+PRE_TEST_FILES = FileList["test_bezier.rb", "test_attributable.rb", "test_color.rb", "test_frame.rb", "test_geometry2D.rb", "test_render.rb", "test_style.rb", "test_utils.rb", "test_shape.rb"]
+TEST_FILES = FileList["test/*.rb"]
 
 # Executable scripts, all non-garbage files under bin/.
 BIN_FILES = FileList["bin/*"]
 
 # This filelist is used to create source packages.
 # Include all Ruby and RDoc files.
-DIST_FILES = FileList["./examples/*.rb"]
+DIST_FILES = FileList["Rakefile", "LICENCE"]
 DIST_FILES.include(LIB_FILES)
-DIST_FILES.include("Rakefile", "LICENCE")
+DIST_FILES.include(EXAMPLE_FILES)
 DIST_FILES.include(BIN_FILES)
 # DIST_FILES.include("data/**/*", "test/data/**/*")
 # DIST_FILES.include("#{WEBSITE_DIR}/**/*.{html,css}", "man/*.[0-9]")
@@ -97,11 +98,19 @@ DIST_FILES.exclude(/^(\.\/)?pkg(\/|$)/)
 # Run the tests if rake is invoked without arguments.
 task "default" => ["test"]
 
-test_task_name = HAVE_EXT ? "run-tests" : "test"
-Rake::TestTask.new(test_task_name) do |t|
+Rake::TestTask.new("run-tests") do |t|
   t.test_files = TEST_FILES
   t.libs = REQUIRE_PATHS
 end
+
+task "test" => ["lib"] do
+  remove_dir TEST_DIR
+  mkdir TEST_DIR
+  PRE_TEST_FILES.to_a.each {|fn| cp( fn, TEST_DIR ) }
+  Rake::Task["run-tests"].invoke
+end
+
+
 #---
 # Set an environment variable with any configuration options you want to
 # be passed through to "setup.rb config".
@@ -124,6 +133,16 @@ if HAVE_EXT
     Rake::Task["run-tests"].invoke
   end
 end
+
+#---
+# Clobber object files and Makefiles generated by extconf.rb.
+CLOBBER.include("#{EXT_DIR}/**/*.{so,dll,o}", "#{EXT_DIR}/**/Makefile")
+# Clobber .config generated by setup.rb.
+CLOBBER.include(".config")
+CLOBBER.include("#{WEBSITE_DIR}/*.html", "#{WEBSITE_DIR}/images/*.png", "#{WEBSITE_DIR}/images", "#{WEBSITE_DIR}/example_list.rb")
+
+CLEAN.include("test/**/*.svg", "#{WEBSITE_DIR}/*~", "#{WEBSITE_DIR}/example_list.rb", "#{EXAMPLE_DIR}/**/*.svg")
+
 #---
 # The "rdoc" task generates API documentation.
 Rake::RDocTask.new("rdoc") do |t|
@@ -155,17 +174,35 @@ end
 
 # Now we can generate the package-related tasks.
 Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
-  # pkg.need_zip = true
-  # pkg.need_tar = true
+  pkg.need_zip = false
+  pkg.need_tar = false
 end
+
 #---
-desc "Upload website to RubyForge. " +
-  "scp will prompt for your RubyForge password."
-task "publish-website" => ["rdoc"] do
-  rubyforge_path = "/var/www/gforge-projects/#{UNIX_NAME}/"
-  sh "scp -r #{WEBSITE_DIR}/* " +
-    "#{RUBYFORGE_USER}@rubyforge.org:#{rubyforge_path}",
-    :verbose => true
+desc "Upload website to RubyForge with WinSCP"
+task "upload-website" do
+   sh "winscp.exe /console /script=winscp_script.txt"
+end
+
+#---
+desc "Regenerate website"
+task "gen-website" do
+  Rake::Task["clobber"].invoke
+  Rake::Task["muse"].invoke
+  Rake::Task["examples"].invoke
+  Rake::Task["rdoc"].invoke
+  Rake::Task["finish"].invoke
+end
+
+#---
+desc "Regenerate website  and upload it to RubyForge"
+task "publish-website" do
+  # rubyforge_path = "/var/www/gforge-projects/#{UNIX_NAME}/"
+  # sh "scp -r #{WEBSITE_DIR}/* " +
+  #  "#{RUBYFORGE_USER}@rubyforge.org:#{rubyforge_path}",
+  #  :verbose => true
+  Rake::Task["gen-website"].invoke
+  Rake::Task["upload-website"].invoke
 end
 #---
 task "rubyforge-setup" do
@@ -175,7 +212,7 @@ task "rubyforge-setup" do
     puts "to your RubyForge username and RubyForge password!"
     puts "Press ENTER to continue."
     $stdin.gets
-    sh "rubyforge setup", :verbose => true
+    sh "ruby rubyforge setup", :verbose => true
   end
 end
 
@@ -198,10 +235,11 @@ task "publish-packages" => ["package", "rubyforge-login"] do
         "#{PROJECT_VERSION} #{UNIX_NAME}-#{PROJECT_VERSION}"
   cd "pkg" do
   sh(cmd + ".gem", :verbose => true)
-    sh(cmd + ".tgz", :verbose => true)
-    sh(cmd + ".zip", :verbose => true)
+  # sh(cmd + ".tgz", :verbose => true)
+  # sh(cmd + ".zip", :verbose => true)
   end
 end
+
 #---
 # The "lib" task copy selected files in PRE_LIB_FILES into LIB_DIR directory
 desc "Copy source files to create ./lib directory"
@@ -211,16 +249,62 @@ task "lib" do
   PRE_LIB_FILES.to_a.each {|fn| cp( fn, LIB_DIR ) }
 end
 
+#---
+# The "muse" task generates html documentation by using emacs
+# It also generates a "example_list.txt" file, that must list every XRVG example used in the doc
+# This list is used in "examples" task, to generate and copy example sources
+desc "Copy example source files to create ./examples directory"
+task "muse" do
+  sh "emacs -u \"\" g:/emacs/emacs/plans/xrvgwebsite.muse -l g:/emacs/emacs/perso/xrvg-publish-exe.el -kill", :verbose => true
+end
+
+#---
+# The "finish" task removes some generated files
+task "finish" do
+  FINISH_FILES = FileList["#{WEBSITE_DIR}/example_list.rb", "#{EXAMPLE_DIR}/**/*.svg" ]
+  FINISH_FILES.include( "#{WEBSITE_DIR}/*o" )
+  FINISH_FILES.each do |fn|
+    puts "try to remove #{fn}"
+    if File.exists? fn   
+       rm_r fn
+    end
+  end
+end
+
+#---
+# The "example" task copy selected example files into EXAMPLE_DIR directory
+desc "Copy example source files to create ./examples directory"
+task "examples" => ["muse"] do
+  remove_dir EXAMPLE_DIR
+  mkdir EXAMPLE_DIR
+  mkdir "#{WEBSITE_DIR}/images"
+  require 'www/example_list'
+  example_list.each do |fn|
+    source = fn
+    svg = String.new(fn)
+    svg["\.rb"] = ".svg"
+    png = String.new(fn)
+    png["\.rb"] = ".png"
+    cp( fn, EXAMPLE_DIR )
+    sh "ruby #{fn}"
+    if File.exist?(svg)
+      sh "ruby svg2png.rb #{svg} 2.0"
+      cp( png, WEBSITE_DIR_IMAGES )
+    end
+  end
+end
+
 #---
 # The "prepare-release" task makes sure your tests run, and then generates
 # files for a new release.
 desc "Run tests, generate RDoc and create packages."
-task "prepare-release" => ["clobber"] do
+task "prepare-release" do
   puts "Preparing release of #{PROJECT} version #{VERSION}"
+  Rake::Task["clobber"].invoke
   Rake::Task["lib"].invoke
   Rake::Task["test"].invoke
-  Rake::Task["rdoc"].invoke
   Rake::Task["package"].invoke
+  Rake::Task["gen-website"].invoke
 end
 
 # The "publish" task is the overarching task for the whole project. It
@@ -258,6 +342,4 @@ end
 #---
 
 # TODO
-# - add task example checking
 # - add effective upload with winscp
-# - add xrvg tutorial documentation publishing (emacs process ?)

data/examples/bezierbasic.rb

@@ -0,0 +1,7 @@
+require 'xrvg'
+
+render = SVGRender[ :filename, "bezierbasic.svg" ]
+bezier = Bezier.raw( V2D[0.0, 1.0], V2D[1.0, 1.0], V2D[0.0, 0.0], V2D[1.0, 0.0] )
+render.add( bezier, Style[ :stroke, "blue", :strokewidth, 0.1 ] )
+bezier.gdebug( render )
+render.end

data/examples/bezierbasicvector.rb

@@ -0,0 +1,7 @@
+require 'xrvg'
+
+render = SVGRender[ :filename, "bezierbasicvector.svg" ]
+bezier = Bezier.vector( V2D[0.0, 1.0], V2D[1.0, 0.0], V2D[1.0, 0.0], V2D[-1.0, 0.0] )
+render.add( bezier, Style[ :stroke, "blue", :strokewidth, 0.1 ] )
+bezier.gdebug( render )
+render.end

data/examples/foreach.rb

@@ -2,8 +2,8 @@ require 'xrvg'
 
 render = SVGRender[ :filename, "foreach.svg", :background, "white" ]
 Circle[].samples(10).foreach do |p1,p2|
+  render.add( Line[ :points, [p1,p2] ], Style[ :stroke, "black", :strokewidth, 0.1 ] )
   render.add( Circle[:center, p1, :radius, 0.1], Style[ :fill, Color.red ] )
   render.add( Circle[:center, p2, :radius, 0.2], Style[ :fill, Color.blue ] )
-  render.add( Line[ :exts, [p1,p2] ] )
 end
 render.end

data/examples/geodash.rb

@@ -0,0 +1,8 @@
+require 'xrvg'
+
+render = SVGRender[ :filename, "geodash.svg" ]
+bezier = Bezier.raw( V2D[0.0, 1.0], V2D[1.0, 1.0], V2D[0.0, 0.0], V2D[1.0, 0.0] )
+bezier.geo(2.0).splits( 30 ).foreach do |drawn,dum|
+    render.add( drawn, Style[ :stroke, "blue", :strokewidth, 0.1 ] )
+end
+render.end

data/examples/geodash2.rb

@@ -0,0 +1,8 @@
+require 'xrvg'
+
+render = SVGRender[ :filename, "geodash2.svg" ]
+bezier = Bezier.raw( V2D[0.0, 1.0], V2D[1.0, 1.0], V2D[0.0, 0.0], V2D[1.0, 0.0] )
+[bezier.geo(2.0).splits( 30 ), (0.1..0.0).samples(30)].forzip do |drawn,width,dum,dum|
+    render.add( drawn, Style[ :stroke, "blue", :strokewidth, width ] )
+end
+render.end

data/examples/hellocrown.rb

@@ -2,6 +2,6 @@ require 'xrvg'
 
 render = SVGRender[ :filename, "hellocrown.svg" ]
 Circle[].samples( 8 ) do |point|
-  render.add( Circle[:center, point, :radius, 0.2 ], Style[ :fill, Color.black ] )
+  render.add( Circle[:center, point, :radius, 0.2 ], Style[ :fill, Color.blue ] )
 end
 render.end

data/examples/hellocrown2.rb

@@ -2,6 +2,6 @@ require 'xrvg'
 
 render = SVGRender[ :filename, "hellocrown2.svg" ]
 [Circle[], (0.2..0.1)].samples( 10 ) do |point, radius|
-  render.add( Circle[:center, point, :radius, radius ], Style[ :fill, Color.black( 0.5 ) ] )
+  render.add( Circle[:center, point, :radius, radius ], Style[ :fill, Color.blue( 0.5 ) ] )
 end
 render.end

data/examples/hellocrownrecurse.rb

@@ -3,7 +3,7 @@ require 'xrvg'
 render = SVGRender[ :filename, "hellocrownrecurse.svg" ]
 Circle[].samples( 8 ) do |point|
   Circle[:center, point, :radius, 0.2 ].samples( 8 ) do |point|
-    render.add( Circle[:center, point, :radius, 0.05 ], Style[ :fill, Color.black ] )
+    render.add( Circle[:center, point, :radius, 0.05 ], Style[ :fill, Color.blue ] )
   end
 end
 render.end

data/examples/multibezierbasic.rb

@@ -0,0 +1,8 @@
+require 'xrvg'
+
+render = SVGRender[ :filename, "multibezierbasic.svg" ]
+bezier = Bezier.multi( [[:vector, V2D[0.0, 1.0], V2D[1.0, 0.0], V2D[1.0, 0.0], V2D[-1.0, 0.0]],
+		        [:vector, V2D[1.0, 0.0], V2D[1.0, 0.0], V2D[2.0, 1.0], V2D[-1.0, 0.0]]] )
+render.add( bezier, Style[ :stroke, "blue", :strokewidth, 0.1 ] )
+bezier.gdebug( render )
+render.end

data/examples/randomdash.rb

@@ -0,0 +1,8 @@
+require 'xrvg'
+
+render = SVGRender[ :filename, "randomdash.svg" ]
+bezier = Bezier.raw( V2D[0.0, 1.0], V2D[1.0, 1.0], V2D[0.0, 0.0], V2D[1.0, 0.0] )
+[bezier.ssort.random.splits( 30 ), (0.1..0.0).rand(30)].forzip do |drawn,width,dum,dum|
+    render.add( drawn, Style[ :stroke, "blue", :strokewidth, width ] )
+end
+render.end

data/examples/range_examples.rb

@@ -0,0 +1,16 @@
+require 'xrvg'
+
+# Samplable module
+(1.0..2.0).sample(0.5);      #=> 1.5
+(1.0..2.0).samples( 3 );     #=> [1.0, 1.5, 2.0]
+(1.0..2.0).mean;             #=> 1.5; equiv to sample(0.5)
+(1.0..2.0).middle;           #=> alias for previous
+(1.0..2.0).rand;             #=> random value in range
+(1.0..2.0).rand( 2 );        #=> [rand1, rand2] in range
+(1.0..2.0).complement(1.2);  #=> 1.8
+(1.0..2.0).abscissa(1.2);    #=> 0.2; inverse of sample
+
+# Splittable module
+(1.0..2.0).split(0.2,0.3);    #=> (1.2..1.3)
+(1.0..2.0).splits( 2 );       #=> [(1.0..1.5),(1.5..2.0)]
+

data/examples/range_examples2.rb

@@ -0,0 +1,10 @@
+require 'xrvg'
+
+Range.O;                   #=> (0.0..1.0)
+Range.Angle;               #=> (0.0..2*Math::PI)
+(1.0..2.0).reverse;        #=> (2.0..1.0)
+(1.0..2.0).sym;            #=> (0.0..2.0)
+(1.0..2.0).symend;         #=> (1.0..3.0)
+(1.0..2.0).size;           #=> 1.0
+(1.0..2.0).translate(0.3); #=> (1.3..2.3)
+

data/examples/sample.rb

@@ -1,8 +1,10 @@
 require 'xrvg'
 
-render = SVGRender[ :filename, "palette_circle.svg", :background, "white" ]
+render = SVGRender[ :filename, "sample.svg" ]
 
-palette  = Palette[ :colorlist, [ Color.black, 0.0, Color.blue, 1.0 ] ]
+palette  = Palette[ :colorlist, [ Color.blue, 0.0, Color.orange, 0.25, 
+                                  Color.yellow, 0.5, Color.green, 0.75, 
+                                  Color.blue, 1.0 ] ]
 [Circle[], palette, (0.1..0.02).random()].samples(25) do |point, color, radius|
   render.add( Circle[ :center, point, :radius, radius ], Style[ :fill, color ])
 end

data/examples/simpledash.rb

@@ -0,0 +1,8 @@
+require 'xrvg'
+
+render = SVGRender[ :filename, "simpledash.svg" ]
+bezier = Bezier.raw( V2D[0.0, 1.0], V2D[1.0, 1.0], V2D[0.0, 0.0], V2D[1.0, 0.0] )
+bezier.splits( 30 ).foreach do |drawn,dummy|
+    render.add( drawn, Style[ :stroke, "blue", :strokewidth, 0.1  ] )
+end
+render.end

data/examples/uplets.rb

@@ -2,8 +2,8 @@ require 'xrvg'
 
 render = SVGRender[ :filename, "uplets.svg", :background, "white" ]
 Circle[].samples(10).uplets do |p1,p2|
+  render.add( Line[ :points, [p1,p2]], Style[ :stroke, "black", :strokewidth, 0.1 ] )
   render.add( Circle[:center, p1, :radius, 0.1], Style[ :fill, Color.red ] )
   render.add( Circle[:center, p2, :radius, 0.2], Style[ :fill, Color.blue ] )
-  render.add( Line[ :exts, [p1,p2] ] )
 end
 render.end