xrvg 0.0.1

data/LICENCE

@@ -0,0 +1,21 @@
+Copyright (c) 2008 Julien L�onard
+
+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

@@ -0,0 +1,88 @@
+= XRVG -- X Ruby Vector Graphics
+
+Supporting XRVG version: 0.0.1
+
+This package contains XRVG, a Ruby vector graphic programming library.
+
+== Download
+
+The latest version of XRVG can be found at
+
+* http://rubyforge.org/projects/xrvg/
+
+== Installation
+
+=== GEM Installation
+
+Download and install XRVG with the following.
+
+   gem install xrvg
+
+=== Running the XRVG Test Suite
+
+XRVG comes with a Rakefile. To launch XRVG tests, simply go into XRVG install directory, and executes
+  rake test
+
+== Online Resources
+
+=== XRVG Reference
+
+* XRVG API Documentation http://xrvg.rubyforge.org/rdoc/index.html
+
+=== Tutorials
+
+* http://xrvg.rubyforge.org/XRVGTutorials.html
+
+=== Road Map
+
+TO BE DEFINED
+
+== Simple Example
+
+To be put in a .rb file
+  
+  require 'xrvg'
+  
+  render = SVGRender[ :filename, "test.svg" ]
+  render.add( Circle[] )
+  render.end
+
+== License
+
+XRVG is available under an MIT-style license.
+
+:include: LICENCE
+
+== Support
+
+The XRVG homepage is http://xrvg.rubyforge.org.  You can find the XRVG
+RubyForge page at http://rubyforge.org/projects/xrvg.
+
+Feel free to submit commits or feature requests.  If you send a patch,
+remember to update the corresponding unit tests.  In fact, I prefer
+new feature to be submitted in the form of new unit tests.
+
+For other information, feel free to ask on the ruby-talk mailing list
+(which is mirrored to comp.lang.ruby) or contact
+mailto:jblondinet@nospam@yahoo.com.
+
+
+= Other stuff
+
+== Credits
+
+Thanks for Rake project, whose README file has been adapted to do this one.
+
+== Summary
+
+Author::   Julien L�onard <jblondinet@nospam@yahoo.com>
+Requires:: Ruby 1.8.0 or later (but not compatible with 1.9.0)
+License::  Copyright 2008 by Julien L�onard.
+           Released under an MIT-style license.
+
+== Warranty
+
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantibility and fitness for a particular
+purpose.

data/Rakefile

@@ -0,0 +1,263 @@
+# Rakefile
+require "rake/testtask"
+require "rake/clean"
+require "rake/rdoctask"
+require "rake/gempackagetask"
+#---
+# The name of your project
+PROJECT = "XRVG"
+
+# Your name, used in packaging.
+MY_NAME = "Julien L�onard"
+
+# Your email address, used in packaging.
+MY_EMAIL = "jblondinet@nospam@yahoo.com"
+
+# Short summary of your project, used in packaging.
+PROJECT_SUMMARY = "Ruby vector graphics library"
+
+# The project's package name (as opposed to its display name). Used for
+# RubyForge connectivity and packaging.
+UNIX_NAME = "xrvg"
+
+# Your RubyForge user name.
+RUBYFORGE_USER = ENV["RUBYFORGE_USER"] || "jblondinet"
+
+# Directory on RubyForge where your website's files should be uploaded.
+WEBSITE_DIR = "www"
+
+# Output directory for the rdoc html files.
+# If you don't have a custom homepage, and want to use the RDoc
+# index.html as homepage, just set it to WEBSITE_DIR.
+RDOC_HTML_DIR = "#{WEBSITE_DIR}/rdoc"
+#---
+# Variable settings for extension support.
+EXT_DIR = "ext"
+HAVE_EXT = File.directory?(EXT_DIR)
+EXTCONF_FILES = FileList["#{EXT_DIR}/**/extconf.rb"]
+EXT_SOURCES = FileList["#{EXT_DIR}/**/*.{c,h}"]
+# Eventually add other files from EXT_DIR, like "MANIFEST"
+EXT_DIST_FILES = EXT_SOURCES + EXTCONF_FILES
+#---
+REQUIRE_PATHS = ["lib"]
+REQUIRE_PATHS << EXT_DIR if HAVE_EXT
+$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
+GENERAL_RDOC_OPTS = {
+  "--title" => "#{PROJECT} API documentation",
+  "--main" => "README"
+}
+
+# Additional RDoc formatted files, besides the Ruby source files.
+RDOC_FILES = FileList["README"]
+# 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"]
+LIB_FILES = FileList["#{LIB_DIR}/*.rb"]
+
+# Filelist with Test::Unit test cases.
+TEST_FILES = FileList["test/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.include(LIB_FILES)
+DIST_FILES.include("Rakefile", "LICENCE")
+DIST_FILES.include(BIN_FILES)
+# DIST_FILES.include("data/**/*", "test/data/**/*")
+# DIST_FILES.include("#{WEBSITE_DIR}/**/*.{html,css}", "man/*.[0-9]")
+# Don't package files which are autogenerated by RDocTask
+DIST_FILES.exclude(/^(\.\/)?#{RDOC_HTML_DIR}(\/|$)/)
+# Include extension source files.
+DIST_FILES.include(EXT_DIST_FILES)
+# Don't package temporary files, perhaps created by tests.
+DIST_FILES.exclude("**/temp_*", "**/*.tmp", "**/*.svg" )
+# Don't get into recursion...
+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|
+  t.test_files = TEST_FILES
+  t.libs = REQUIRE_PATHS
+end
+#---
+# Set an environment variable with any configuration options you want to
+# be passed through to "setup.rb config".
+CONFIG_OPTS = ENV["CONFIG"]
+if HAVE_EXT
+  file_create ".config" do
+    ruby "setup.rb config #{CONFIG_OPTS}"
+  end
+  
+  desc "Configure and make extension. " +
+    "The CONFIG variable is passed to `setup.rb config'"
+  task "make-ext" => ".config" do
+    # The -q option suppresses messages from setup.rb.
+    ruby "setup.rb -q setup"
+  end
+  
+  desc "Run tests after making the extension."
+  task "test" do
+    Rake::Task["make-ext"].invoke
+    Rake::Task["run-tests"].invoke
+  end
+end
+#---
+# The "rdoc" task generates API documentation.
+Rake::RDocTask.new("rdoc") do |t|
+  t.rdoc_files = RDOC_FILES + LIB_FILES
+  t.title = GENERAL_RDOC_OPTS["--title"]
+  t.main = GENERAL_RDOC_OPTS["--main"]
+  t.rdoc_dir = RDOC_HTML_DIR
+end
+#---
+GEM_SPEC = Gem::Specification.new do |s|
+  s.name = UNIX_NAME
+  s.version = PROJECT_VERSION
+  s.summary = PROJECT_SUMMARY
+  s.rubyforge_project = UNIX_NAME
+  s.homepage = "http://#{UNIX_NAME}.rubyforge.org/"
+  s.author = MY_NAME
+  s.email = MY_EMAIL
+  s.files = DIST_FILES
+  s.test_files = TEST_FILES
+  s.executables = BIN_FILES.map { |fn| File.basename(fn) }
+  s.has_rdoc = true
+  s.extra_rdoc_files = RDOC_FILES
+  s.rdoc_options = GENERAL_RDOC_OPTS.to_a.flatten
+  if HAVE_EXT
+    s.extensions = EXTCONF_FILES
+    s.require_paths << EXT_DIR
+  end
+end
+
+# Now we can generate the package-related tasks.
+Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+  # pkg.need_zip = true
+  # pkg.need_tar = true
+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
+end
+#---
+task "rubyforge-setup" do
+  unless File.exist?(File.join(ENV["HOME"], ".rubyforge"))
+    puts "rubyforge will ask you to edit its config.yml now."
+    puts "Please set the `username' and `password' entries"
+    puts "to your RubyForge username and RubyForge password!"
+    puts "Press ENTER to continue."
+    $stdin.gets
+    sh "rubyforge setup", :verbose => true
+  end
+end
+
+task "rubyforge-login" => ["rubyforge-setup"] do
+  # Note: We assume that username and password were set in
+  # rubyforge's config.yml.
+  sh "rubyforge login", :verbose => true
+end
+
+task "publish-packages" => ["package", "rubyforge-login"] do
+  # Upload packages under pkg/ to RubyForge
+  # This task makes some assumptions:
+  # * You have already created a package on the "Files" tab on the
+  #   RubyForge project page. See pkg_name variable below.
+  # * You made entries under package_ids and group_ids for this
+  #   project in rubyforge's config.yml.  If not, eventually read
+  #   "rubyforge --help" and then run "rubyforge setup".
+  pkg_name = ENV["PKG_NAME"] || UNIX_NAME
+  cmd = "rubyforge add_release #{UNIX_NAME} #{pkg_name} " +
+        "#{PROJECT_VERSION} #{UNIX_NAME}-#{PROJECT_VERSION}"
+  cd "pkg" do
+  sh(cmd + ".gem", :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"
+task "lib" do
+  remove_dir LIB_DIR
+  mkdir LIB_DIR
+  PRE_LIB_FILES.to_a.each {|fn| cp( fn, LIB_DIR ) }
+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
+  puts "Preparing release of #{PROJECT} version #{VERSION}"
+  Rake::Task["lib"].invoke
+  Rake::Task["test"].invoke
+  Rake::Task["rdoc"].invoke
+  Rake::Task["package"].invoke
+end
+
+# The "publish" task is the overarching task for the whole project. It
+# builds a release and then publishes it to RubyForge.
+desc "Publish new release of #{PROJECT}"
+task "publish" => ["prepare-release"] do
+  puts "Uploading documentation..."
+  Rake::Task["publish-website"].invoke
+  puts "Checking for rubyforge command..."
+  `rubyforge --help`
+  if $? == 0
+    puts "Uploading packages..."
+    Rake::Task["publish-packages"].invoke
+    puts "Release done!"
+  else
+    puts "Can't invoke rubyforge command."
+    puts "Either install rubyforge with 'gem install rubyforge'"
+    puts "and retry or upload the package files manually!"
+  end
+end
+#---
+# $ rake -T
+# rake clean            # Remove any temporary products.
+# rake clobber          # Remove any generated file.
+# rake clobber_package  # Remove package products
+# rake clobber_rdoc     # Remove rdoc products
+# rake package          # Build all the packages
+# rake prepare-release  # Run tests, generate RDoc and create packages.
+# rake publish          # Publish new release of MyProject
+# rake publish-website  # Upload website to RubyForge. scp will prompt for your RubyForge password.
+# rake rdoc             # Build the rdoc HTML Files
+# rake repackage        # Force a rebuild of the package files
+# rake rerdoc           # Force a rebuild of the RDOC files
+# rake test             # Run tests for test
+#---
+
+# TODO
+# - add task example checking
+# - add effective upload with winscp
+# - add xrvg tutorial documentation publishing (emacs process ?)

data/examples/foreach.rb

@@ -0,0 +1,9 @@
+require 'xrvg'
+
+render = SVGRender[ :filename, "foreach.svg", :background, "white" ]
+Circle[].samples(10).foreach do |p1,p2|
+  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/hellocrown.rb

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

data/examples/hellocrown2.rb

@@ -0,0 +1,7 @@
+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 ) ] )
+end
+render.end

data/examples/hellocrownrecurse.rb

@@ -0,0 +1,9 @@
+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 ] )
+  end
+end
+render.end

data/examples/helloworld.rb

@@ -0,0 +1,5 @@
+require 'xrvg'
+
+SVGRender.[] do |render|
+  render.add( Circle[] )
+end

data/examples/helloworldcompact.rb

@@ -0,0 +1,5 @@
+require 'xrvg'
+
+SVGRender.[] do |render|
+  render.add( Circle[] )
+end

data/examples/helloworldexpanded.rb

@@ -0,0 +1,5 @@
+require 'xrvg'
+
+render = SVGRender.new( :filename, "helloworldexpanded.svg" )
+render.add( Circle.new )
+render.end

data/examples/palette_circle.rb

@@ -0,0 +1,10 @@
+require 'xrvg'
+
+render = SVGRender[ :filename, "palette_circle.svg", :background, "white" ]
+
+palette  = Palette[ :colorlist, [ Color.black, 0.0, 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
+
+render.end

data/examples/sample.rb

@@ -0,0 +1,10 @@
+require 'xrvg'
+
+render = SVGRender[ :filename, "palette_circle.svg", :background, "white" ]
+
+palette  = Palette[ :colorlist, [ Color.black, 0.0, 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
+
+render.end

data/examples/uplets.rb

@@ -0,0 +1,9 @@
+require 'xrvg'
+
+render = SVGRender[ :filename, "uplets.svg", :background, "white" ]
+Circle[].samples(10).uplets do |p1,p2|
+  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/lib/assertion.rb

@@ -0,0 +1,14 @@
+# assertion utility
+# must be used with care, as expensive
+#
+class AssertionError < StandardError
+end
+
+#
+# Assert method, to check for a block, and raise an error if check is not true
+#   Assert("1 is different from 0"){ 1 == 0}
+def Assert(message=nil, &block)
+   unless(block.call)
+     raise AssertionError, (message || "Assertion failed")
+   end
+end

data/lib/attributable.rb

@@ -0,0 +1,152 @@
+#
+# Module to be able to declare attribute, initializing them by default, with type checking
+# also define syntaxically simpler builder
+#
+# See :
+# - +Object+
+# - +Attributable+
+
+require 'utils'
+
+#
+# Object extension to provide the Class[] syntax for building objects, with +Attributable+ module.
+#
+# TODO : must be defined only for Class objects !!
+class Object
+
+  # operator [] definition for shorter and more recognizable object creation syntax. 
+  #
+  # Especially useful when creating Attributable dependant objects.
+  #   c = Circle[ :center, p, :radius, 0.1 ]
+  def Object.[](*args)
+    return self.new( *args )
+  end
+end
+
+
+# Attribute class used by Attributable module
+#
+# Attribute syntax : 
+#   attribute :attr1 default_value type
+# with :
+# - dvalue nil if no default_value (in that case, attribute is said to be required )
+# - if type is not specified, default_value must be, and type will be the type of this default_value
+# type can be an Array of types
+class Attribute
+  attr_accessor :symbol, :default_value, :type
+
+  def initialize( symbol, default_value, type )  #:nodoc:
+    @symbol = symbol
+    @default_value = default_value
+    @type = type
+  end
+
+end
+
+# Attributable module
+# 
+# Allows class attribute definition in a concise and effective way. Can be viewed as a :attr_accessor extension. See also +Attribute+
+#
+# Example :
+#   class A
+#      attribute :a 1.0; # type is then Float
+#      attribute :b      # attribute is required
+#   end
+#
+#   a = A[ :a, 10.0, :b, 2.0 ]
+#   a.a => 10.0
+module Attributable
+
+  module ClassMethods #:nodoc:
+    def init_attributes
+      if not @attributes
+	@attributes = {}
+	newattributes = (self.superclass.ancestors.include? Attributable) ? self.superclass.attributes : {}
+	@attributes = @attributes.merge( newattributes )
+      else
+	# Trace("Attributable::init_attributes self #{self} already initialized")
+      end
+      # Trace("Attributable::init_attributes self #{self} superclass#{self.superclass} superclass ancestors  #{self.superclass.ancestors.inspect} result #{@attributes}")
+    end
+
+    def add_attribute( attribute )
+      # Trace("Attributable::add_attribute self #{self} attribute #{attribute.inspect}")
+      init_attributes
+      @attributes[ attribute.symbol ] = attribute
+    end
+
+    def attributes()
+      init_attributes
+      # Trace("Attributable::attributes self #{self} attributes #{@attributes}")
+      return @attributes
+    end
+
+    def checkvaluetype( value, type )
+      typeOK = nil
+      types = type
+      types.each do |type|
+	if value.is_a? type
+	  typeOK = true
+	  break
+	end
+      end
+      if not typeOK
+	raise( "Attributable::checkvaluetype for class #{self} : default_value #{value.inspect} is not of type #{types.inspect}" )
+      end
+    end
+
+    def attribute( symbol, default_value=nil, type=nil )
+      if (not type and default_value)
+	type = [default_value.class]
+      elsif type
+	if not type.is_a? Array
+	  type = [type]
+	end
+	 if default_value
+	   checkvaluetype( default_value, type )
+	 end
+      end
+
+      self.add_attribute( Attribute.new( symbol, default_value, type ) )
+      attr_accessor symbol
+    end
+
+    def instance_variable_set( *args )
+      # Trace("Attributable::instance_variable_set self #{self} args #{args}")
+      super( *args )
+    end
+  end
+
+  def self.included( receiver )  #:nodoc:
+    # inherit_attributes; does not work because Module is not inherited by subclasses
+    receiver.extend( ClassMethods )
+  end
+
+  def initialize(*args)  #:nodoc:
+    # first check if every specified attribute is meaningfull for the class
+    args.foreach do |symbol, value|
+      if not self.class.attributes.key? symbol
+	raise( "Attributable::initialize for class #{self} does not have attribute #{symbol}" )
+      end
+    end
+
+    # then check specification coherence, and do initialization
+    spec = Hash[ *args ]
+    self.class.attributes.each_pair do |symbol, attr|
+      if spec.key? symbol
+	value = spec[ symbol ]
+	if attr.type
+	  self.class.checkvaluetype( value, attr.type )
+	end
+	# do init after checking
+	self.method("#{symbol.to_s}=").call(value)
+      else
+	if not attr.default_value
+	  raise( "Attributable::initialize for class #{self} : attribute #{symbol} is required : attributes #{self.class.attributes.inspect}" )
+	end
+	self.method("#{symbol.to_s}=").call(attr.default_value)
+      end
+    end
+  end
+
+end