gecoder-with-gecode 0.7.1-mswin32

data/specs/set_var.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Gecode::FreeSetVar, '(not assigned)' do
+  before do
+    model = Gecode::Model.new
+    @var = model.set_var(1..3, 0..4)
+  end
+  
+  it 'should not be assigned' do
+    @var.should_not be_assigned
+  end
+  
+  it 'should give glb and lub ranges when inspecting' do
+    @var.inspect.should include('lub-range')
+    @var.inspect.should include('glb-range')
+  end
+  
+  it 'should report the correct bounds' do
+    @var.lower_bound.sort.to_a.should == (1..3).to_a
+    @var.upper_bound.sort.to_a.should == (0..4).to_a
+  end
+  
+  it 'should report correct bounds on upper bound' do
+    @var.upper_bound.min.should == 0
+    @var.upper_bound.max.should == 4
+  end
+  
+  it 'should report correct bounds on lower bound' do
+    @var.lower_bound.min.should == 1
+    @var.lower_bound.max.should == 3
+  end
+  
+  it 'should raise error when trying to access assigned value' do
+    lambda{ @var.value }.should raise_error(RuntimeError)
+  end
+  
+  it 'should not raise error when enumerating over bound multiple times' do
+    # For C0 coverage.
+    lower_bound = @var.lower_bound
+    lambda do
+      lower_bound.each{}
+      lower_bound.each{}
+    end.should_not raise_error
+  end
+end
+
+describe Gecode::FreeSetVar, '(assigned)' do
+  before do
+    model = Gecode::Model.new
+    @var = model.set_var([1], [1])
+    model.solve!
+  end
+  
+  it 'should be assigned' do
+    @var.should be_assigned
+  end
+  
+  it "should give it's value when inspecting" do
+    @var.inspect.should include('[1]')
+    @var.inspect.should_not include('lub-range')
+  end
+  
+  it 'should report the correct bounds' do
+    @var.upper_bound.to_a.should == [1]
+    @var.lower_bound.to_a.should == [1]
+    @var.value.to_a.should == [1]
+  end
+end

data/specs/spec_helper.rb

@@ -0,0 +1,93 @@
+require 'rubygems'
+require 'spec'
+require File.dirname(__FILE__) + '/../lib/gecoder'
+
+module CustomVarMatchers
+  class HaveDomain
+    def initialize(expected)
+      @expected = expected.to_a
+    end
+    
+    def matches?(target)
+      @target = target
+      return false unless @target.size == @expected.size
+      @expected.each do |element|
+        return false unless @target.include? element
+      end
+      return true
+    end
+    
+    def failure_message
+      "expected #{@target.inspect} to have domain #{@expected.inspect}"
+    end
+    
+    def negative_failure_message
+      "expected #{@target.inspect} not to have domain #{@expected.inspect}"
+    end
+  end
+
+  # Tests whether a variable has the expected domain.
+  def have_domain(expected)
+    HaveDomain.new(expected)
+  end
+  
+  class HaveBounds
+    def initialize(expected_glb, expected_lub)
+      @expected_glb = expected_glb.to_a
+      @expected_lub = expected_lub.to_a
+    end
+    
+    def matches?(target)
+      @target = target
+      return @target.lower_bound.to_a == @expected_glb &&
+        @target.upper_bound.to_a == @expected_lub
+    end
+    
+    def failure_message
+      "expected #{@target.inspect} to have greatest lower bound " + 
+        "#{@expected_glb.inspect} and least upper bound #{@expected_lub.inspect}"
+    end
+    
+    def negative_failure_message
+      "expected #{@target.inspect} to not have greatest lower bound " + 
+        "#{@expected_glb.inspect} and least upper bound #{@expected_lub.inspect}"
+    end
+  end
+
+  # Tests whether a set variable has the expected bounds.
+  def have_bounds(expected_glb, expected_lub)
+    HaveBounds.new(expected_glb, expected_lub)
+  end
+  
+  class IsAlias
+    def initialize(expected)
+      @expected = expected.to_a
+    end
+    
+    def matches?(target)
+      @target = target
+      return false unless @target.size == @expected.size
+      @expected.each do |element|
+        return false unless @target.in(element)
+      end
+      return true
+    end
+    
+    def failure_message
+      "expected #{@target.inspect} to be an alias of #{@expected.inspect}"
+    end
+    
+    def negative_failure_message
+      "expected #{@target.inspect} not to be an alias of #{@expected.inspect}"
+    end
+  end
+
+  # Tests whether a method with a specified name is the alias of another.
+  def is_alias_of(expected)
+    HaveDomain.new(expected)
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include(CustomVarMatchers)
+end

data/tasks/all_tasks.rb

@@ -0,0 +1 @@
+Dir["#{File.dirname(__FILE__)}/*.rake"].each { |ext| load ext }

data/tasks/building.howto

@@ -0,0 +1,65 @@
+Doing the full "release" task requires a number of gems:
+
+# To run the Rake scripts.
+rake
+
+# To generate the website.
+webgen
+coderay
+
+# To run the specs and produce a report for the website.
+rspec
+
+# To release files to RubyForge.
+meta_project
+rubyforge
+
+Crosscompiling the win32 binaries under Linux requires the following.
+
+http://www.libsdl.org/extras/win32/cross/README.txt
+http://www.mingw.org/
+http://www.profv.de/mingw_cross_env/
+http://www.mingw.org/MinGWiki/index.php/build%20a%20Win32%20x-compiler%20for%20Linux
+http://www.mingw.org/MinGWiki/index.php/BuildMingwCross
+
+Used the patch in the end of
+http://www.mingw.org/MinGWiki/index.php/build%20a%20Win32%20x-compiler%20for%20Linux
+but with
+BINUTILS_ARCHIVE="binutils-2.18.50-20071123-src.tar.gz"
+
+Generate rbconfig.rb by following:
+http://eigenclass.org/hiki.rb?cross+compiling+rcovrt
+
+In ext do:
+ruby -I win32 extconf.rb 
+make
+
+# ruby -Iwin32 -Iwin32/gecode-1.3.1/include/ -Iwin32/gecode-1.3.1/lib/ -I~/cross-compile/ruby-mingw32/lib/ruby/1.8/i386-mingw32/ extconf-win32.rb
+
+
+get mingw32 via modified install script (need at least gcc4.2 due to http://gcc.gnu.org/bugzilla/show_bug.cgi?id=27650)
+add bin to bath, make i386-* symbolic links: ruby -e "Dir['*'].each{ |x| %x{ln -s -T #{x} i386-#{x}} }"
+compile Ruby with cross-compile script
+comment out the read, write and select macros in ruby-mingw32/lib/ruby/1.8/i386-mingw32/win32/win32.h
+edit rbconfig.rb to use mingw32-g++ instead of mingw32-gcc in "LDSHARED".
+copy the produced rbconfig.rb file to ext/win32
+compile Gecode with the cross-compile script 
+move dlls to ext/, move includes to ext/win32 
+install pexports (included in mingw-utils)
+create definitions from MSVC dlls: ruby -e "Dir['*.dll'].each{ |x| %x{pexports #{x} > #{x.sub('dll', 'def')}} }"
+ruby -e "Dir['*.def'].each{ |x| %x{mingw32-dlltool -U -d #{x} > lib#{x.downcase.chomp('def')}a} }"
+ruby -Iwin32 extconf-win32.rb
+make
+
+# Building Gecode and Gecode/R dlls using mingw:
+get mingw32 via modified install script (need at least gcc4.2 due to http://gcc.gnu.org/bugzilla/show_bug.cgi?id=27650)
+add bin to bath, make i386-* symbolic links: ruby -e "Dir['*'].each{ |x| %x{ln -s -T #{x} i386-#{x}} }"
+compile Ruby with cross-compile script
+comment out the read, write and select macros in ruby-mingw32/lib/ruby/1.8/i386-mingw32/win32/win32.h
+edit rbconfig.rb to use mingw32-g++ instead of mingw32-gcc in "LDSHARED".
+copy the produced rbconfig.rb file to ext/win32
+compile Gecode with the cross-compile script 
+move dlls to ext/, move includes to ext/win32 
+ruby -Iwin32 extconf-win32.rb
+make
+move gecode.dll to lib/, put the Gecode dlls somewhere in the path

data/tasks/distribution.rake

@@ -0,0 +1,156 @@
+require 'lib/gecoder/version'
+
+PROJECT_NAME = PKG_NAME = 'gecoder'
+PKG_NAME_WITH_GECODE = 'gecoder-with-gecode'
+PKG_VERSION = GecodeR::VERSION
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_FILE_NAME_WITH_GECODE = "#{PKG_NAME_WITH_GECODE}-#{PKG_VERSION}"
+
+desc 'Generate RDoc'
+rd = Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc/output/rdoc'
+  rdoc.options << '--title' << 'Gecode/R' << '--line-numbers' << 
+    '--inline-source' << '--accessor' << 'delegate' << '--main' << 'README'
+  rdoc.rdoc_files.include('README', 'CHANGES', 'LGPL-LICENSE', 'lib/**/*.rb')
+end
+
+desc 'Generate RDoc, ignoring nodoc'
+Rake::RDocTask.new(:rdoc_dev) do |rdoc|
+  rdoc.rdoc_dir = 'doc/output/rdoc_dev'
+  rdoc.options << '--title' << 'Gecode/R Developers RDoc' << '--line-numbers' << 
+    '--inline-source' << '--accessor' << 'delegate'
+    
+  # Copy the rdoc and remove all #:nodoc: .
+  TMP_DIR = 'doc/tmp/rdoc_dev'
+  Dir['lib/**/*.rb'].each do |source_name|
+    destination_name = source_name.sub('lib', TMP_DIR)
+    File.makedirs File.dirname(destination_name)
+    destination = File.open(destination_name, 'w')
+    File.open(source_name) do |source|
+      source.each{ |line| destination << line.gsub('#:nodoc:', '' ) }
+    end
+    destination.close
+  end
+  
+  rdoc.rdoc_files.include("#{TMP_DIR}/**/*.rb")
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME
+  s.version = GecodeR::VERSION
+  s.summary = 'Ruby interface to Gecode, an environment for constraint programming.'
+  s.description = <<-end_description
+    Gecode/R is a Ruby interface to the Gecode constraint programming library. 
+    Gecode/R is intended for people with no previous experience of constraint 
+    programming, aiming to be easy to pick up and use.
+  end_description
+
+  s.files = FileList[
+    '[A-Z]*',
+    'lib/**/*.rb', 
+    'example/**/*',
+    'src/**/*',
+    'vendor/rust/**/*',
+    'tasks/**/*',
+    'specs/**/*',
+    'ext/*.cpp',
+    'ext/*.h',
+    'ext/extconf.rb'
+  ].to_a
+  s.require_path = 'lib'
+  s.extensions << 'ext/extconf.rb'
+  s.requirements << 'Gecode 1.3.1'
+
+  s.has_rdoc = true
+  s.rdoc_options = rd.options
+  s.extra_rdoc_files = rd.rdoc_files
+  s.test_files = FileList['specs/**/*.rb']
+
+  s.autorequire = 'gecoder'
+  s.author = ["Gecode/R Development Team"]
+  s.email = "gecoder-users@rubyforge.org"
+  s.homepage = "http://gecoder.rubyforge.org"
+  s.rubyforge_project = "gecoder"
+end
+
+# Create a clone of the gem spec with the precompiled binaries for Windows.
+spec_windows_binary_with_gecode = spec.dup
+spec_windows_binary_with_gecode.name = PKG_NAME_WITH_GECODE
+spec_windows_binary_with_gecode.extensions = []
+spec_windows_binary_with_gecode.requirements = []
+# Add the precompiled Gecode DLLs and precompiled bindings.
+spec_windows_binary_with_gecode.files = spec.files.dup -
+  FileList['ext/**/*'].to_a + 
+  FileList['vendor/gecode/win32/lib/*'].to_a << 'lib/gecode.dll'
+spec_windows_binary_with_gecode.platform = Gem::Platform::WIN32
+
+# Create a clone of the gem spec that includes Gecode.
+spec_with_gecode = spec.dup
+spec_with_gecode.name = PKG_NAME_WITH_GECODE
+spec_with_gecode.extensions = spec.extensions.dup << 'ext/gecode-1.3.1/extconf.rb'
+spec_with_gecode.requirements = []
+spec_with_gecode.files = spec.files.dup + FileList['ext/gecode-*/**/*'].to_a 
+
+desc 'Generate Gecode/R Gem'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+desc 'Generate Gecode/R + Gecode Gem'
+Rake::GemPackageTask.new(spec_with_gecode) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+desc 'Generate Gecode/R + Gecode Gem (windows binary)'
+Rake::GemPackageTask.new(spec_windows_binary_with_gecode) do |pkg|
+end
+
+desc 'Precompiles the Gecode/R bindings for Windows platforms'
+file 'lib/gecode.dll' do
+  cd 'ext' do
+    sh 'ruby -Iwin32 extconf-win32.rb'
+    sh 'make'
+    mv 'gecode.so', '../lib/gecode.dll'
+  end
+end
+
+desc 'Publish packages on RubyForge'
+task :publish_packages => [:publist_gecoder_packages, 
+  :publish_gecoder_with_gecode_packages]
+
+desc 'Publish Gecode/R packages on RubyForge'
+task :publish_gecoder_packages => [:verify_user, :package] do
+  release_files = FileList[
+    "pkg/#{PKG_FILE_NAME}.gem",
+    "pkg/#{PKG_FILE_NAME}.tgz",
+    "pkg/#{PKG_FILE_NAME}.zip"
+  ]
+  require 'meta_project'
+  require 'rake/contrib/xforge'
+
+  Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new(PROJECT_NAME)) do |xf|
+    xf.user_name = ENV['RUBYFORGE_USER']
+    xf.files = release_files.to_a
+    xf.release_name = "Gecode/R #{PKG_VERSION}"
+  end
+end
+
+desc 'Publish Gecode/R with Gecode packages on RubyForge'
+task :publish_gecoder_with_gecode_packages => [:verify_user, :package] do
+  release_files = FileList[
+    "pkg/#{PKG_FILE_NAME_WITH_GECODE}*.gem",
+    "pkg/#{PKG_FILE_NAME_WITH_GECODE}*.tgz",
+    "pkg/#{PKG_FILE_NAME_WITH_GECODE}*.zip"
+  ]
+  
+  require 'meta_project'
+  require 'rake/contrib/xforge'
+
+  Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new(PROJECT_NAME)) do |xf|
+    xf.user_name = ENV['RUBYFORGE_USER']
+    xf.files = release_files.to_a
+    xf.release_name = "Gecode/R with Gecode #{PKG_VERSION}"
+  end
+end

data/tasks/rcov.rake

@@ -0,0 +1,17 @@
+require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
+
+RCOV_DIR = "#{File.dirname(__FILE__)}/../doc/output/coverage"
+
+desc "Run all specs with rcov"
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_files = FileList['specs/**/*.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude examples', '--exclude specs']
+  t.rcov_dir = RCOV_DIR
+end
+
+RCov::VerifyTask.new(:verify_rcov => :rcov) do |t|
+  t.threshold = 100.0
+  t.index_html = "#{RCOV_DIR}/index.html"
+end

data/tasks/specs.rake

@@ -0,0 +1,15 @@
+require 'spec/rake/spectask'
+
+spec_files = FileList['specs/**/*.rb']
+
+desc 'Run all specs'
+Spec::Rake::SpecTask.new('specs') do |t|
+  t.libs = ['lib']
+  t.spec_files = spec_files
+end
+
+desc 'Generate an rspec html report'
+Spec::Rake::SpecTask.new('spec_html') do |t|
+  t.spec_files = spec_files
+  t.spec_opts = ['--format html:doc/output/rspec.html','--backtrace']
+end

data/tasks/svn.rake

@@ -0,0 +1,11 @@
+require 'lib/gecoder/version'
+
+desc "Tag the release in svn"
+task :tag do
+  from = `svn info`.match(/Repository Root: (.*)/n)[1] + '/trunk'
+  to = from.gsub(/trunk/, "tags/gecoder-#{GecodeR::VERSION}")
+
+  puts "Creating tag in SVN"
+  tag_cmd = "svn cp #{from} #{to} -m \"Tag release Gecode/R #{GecodeR::VERSION}\""
+  `#{tag_cmd}` ; raise "ERROR: #{tag_cmd}" unless $? == 0
+end

data/tasks/website.rake

@@ -0,0 +1,51 @@
+require 'rake/contrib/rubyforgepublisher'
+
+desc 'Regenerates the contents of the website'
+task :website do
+  mkpath 'doc/output'
+  Rake::Task[:spec_html].invoke
+  Rake::Task[:rdoc].invoke
+  Rake::Task[:rdoc_dev].invoke
+  Rake::Task[:rcov].invoke
+  WebsiteRakeHelpers.webgen
+end
+
+desc 'Removes generated documentation'
+task :clobber do
+  WebsiteRakeHelpers.clobber
+end
+
+task :verify_user do
+  raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
+end
+
+desc "Uploads the website to RubyForge"
+task :publish_website => [:verify_user, :website] do
+  publisher = Rake::SshDirPublisher.new(
+    "#{ENV['RUBYFORGE_USER']}@rubyforge.org",
+    "/var/www/gforge-projects/gecoder",
+    "doc/output"
+  )
+  publisher.upload
+end
+
+module WebsiteRakeHelpers
+  module_function
+  
+  # Remove generated documentation.
+  def clobber
+    rm_rf 'doc/output'
+    rm_rf 'doc/tmp'
+  end
+  
+  # Generates the website with webgen.
+  def webgen
+    Dir.chdir 'doc' do
+      output = nil
+      IO.popen('webgen 2>&1') do |io|
+        output = io.read
+      end
+      raise "ERROR while running webgen: #{output}" if output =~ /ERROR/n || $? != 0
+    end
+  end
+end