rcrossword 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-06-22
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,27 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/rcrossword.rb
+lib/rcrossword/version.rb
+lib/rcrossword/grid.rb
+lib/rcrossword/generator.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_rcrossword.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on rcrossword, see http://rcrossword.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.txt

@@ -0,0 +1,84 @@
+= rcrossword
+
+* FIX (url)
+
+== DESCRIPTION:
+
+Dieses Projekt besteht zur Zeit im Wesentlichen aus der Klasse Grid, welche
+grundlegende und allgemeine Methoden zum Arbeiten mit einer Kreuzwortraetsel-
+Matrix zur Verfuegung stellt, sowie der Klasse Generator, welche die Algorithmen
+zur Verfuegung stellt, mit denen ein Kreuzwortraetsel erstellt wird. 
+
+Aus den Test-Skripts ist ersichtlich, wie diese Klassen verwendet werden 
+koennen. 
+
+Die zentrale Methode zum Erzeugen eines Raetsel ist die Methode #generate.
+Diese bekommt eine Liste mit Worten und Hinweistexten, und weiteren Parametern
+uebergeben und versucht, daraus ein Raetsel zu generieren. 
+
+Momentan ist diese Methode noch nicht der Weisheit letzter Schluss. Sie funktioniert,
+ist aber weder effizient noch wirklich gut (d. h. die Positionierung von Worten
+muss noch besser werden).
+
+Einige Verbesserungen sind schon angedacht, aber noch nicht implemetiert:
+- Einfuegeposition nich rein zufaellig sondern nur an den Stellen, die noch
+  frei sind. D. h. man muesste irgendwie eine Liste von noch freien Positionen
+  verwalten
+- Zur Zeit werden Worte aus der Liste noch mehrfach eingesetzt. Dies ist ein
+  eher triviales Problem und hat auf den grundlegenden Algorithmus keine
+  Auswirkungen. Man muss einfach nur das einmal eingesetzt Wort aus der Liste
+  entfernen, so dass es nicht mehrfach verwendet wird.
+- Worte sollten nicht zufaellig plaziert werden, sondern nach einem intelligenteren 
+  Algorithmus, der versucht, moeglichst Kreuzungen mit anderen Worten zu nutzen
+
+Gff. wird es einen Mechanismus geben, um innerhalb des Programms mit 
+unterschiedlichen generate-Methoden zu arbeiten, bzw. zwischen ihnen umzuschalten.
+Das würde bedeuten, es gibt mehrere Generator#generate Methoden, z.B. von 
+verschiedenen Leuten implementiert, um daraus fuer die Zukunft die beste
+Strategie fuer das Programm auszuwaehlen.
+
+Beim erfolgreichen Generieren wird daraus eine HTML-Datei zum bequemeren 
+Anschauen im Browser erzeugt. Weitere Methoden
+ein Raetsel auszugeben sind geplant - beispielsweise waere eine LaTeX-Datei oder
+eine XML-Datei moeglich.
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIXME full name
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'rcrossword/version'
+
+AUTHOR = 'Thomas Preymesser'  # can also be an array of Authors
+EMAIL = "thopre@gmail.com"
+DESCRIPTION = "Generating crossword puzzles with ruby"
+GEM_NAME = 'rcrossword' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'rcrossword' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "thopre"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Rcrossword::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'rcrossword documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/rcrossword.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Rcrossword
+  
+end
+require 'rcrossword/grid'
+require 'rcrossword/generator'

data/lib/rcrossword/generator.rb

@@ -0,0 +1,137 @@
+class Generator
+  attr_reader :title
+  
+  def initialize(width,height,title)
+    @width = width
+    @height = height
+    @title = title
+    @matrix = Grid.new(width,height)
+    @hinweisliste = Hash.new
+  end
+  
+  def can_insert?(line,column,orientation,word)
+    @matrix.insert_possible?(line,column,orientation,word)
+  end
+  
+  # bekommt Worteliste (als Array) uebergeben und soll daraus ein Raetsel 
+  # mit maximal N unbelegten Feldern erzeugen
+  def generate(wordlist,max_empty,max_tries,max_cycles)
+    empty = empty_cells
+    tries = 0
+    for cycle in 1..max_cycles
+      @matrix = Grid.new(@width,@height)
+    success = true
+      while empty > max_empty
+        if tries > max_tries
+          success = false
+          break # raise "max tries reached"
+        end
+        #puts "noch zu viele freie Zellen (#{empty})"
+        r =   rand(wordlist.size)
+        random_word = wordlist[r][0]
+        random_hint = wordlist[r][1]
+        random_orientation = [:horizontal,:vertical][rand(2)]
+        while true
+          random_line = 1+rand(@height)
+          break if random_orientation == :horizontal
+          break if random_orientation == :vertical and random_line + random_word.length <= @height
+        end
+        while true
+          random_column = 1+rand(@width)
+          break if random_orientation == :vertical
+          break if random_orientation == :horizontal and random_column + random_word.length <= @width
+        end
+        #      p random_word
+        #      p random_line
+        #      p random_column
+        #      p random_orientation
+        tries += 1
+        if @matrix.insert(random_line,random_column,random_orientation,random_word)
+          puts @matrix.to_s
+        
+          puts "(#{cycle}/#{tries}) '#{random_word}' konnte eingefügt werden"
+          $stdout.flush
+          key = [random_line,random_column]
+          value = [random_hint,random_orientation]
+          @hinweisliste[key] = value
+        else 
+          #puts "konnte nicht eingefügt werden"
+        end
+        empty = empty_cells
+    
+      end # while
+      break if success == true
+    end # for    
+    unless success
+      raise "no success in #{max_cycles} cycles with #{max_tries} retries"
+    end 
+    blank_to_slash
+    puts @matrix.to_s
+    puts "in #{tries} tries"
+    to_html("lalala.html")
+    true
+  end
+  
+  private
+  
+  def empty_cells
+    total = 0
+    for y in 1..@height
+      for x in 1..@width
+        total += 1 if @matrix.cell(y,x) == '.'
+      end
+    end
+    total
+  end
+  
+  def blank_to_slash
+    for y in 1..@height
+      for x in 1..@width
+        @matrix.set(y,x,'/') if @matrix.cell(y,x) == '.'
+      end
+    end
+  end
+  
+  def to_html(filename)
+    File.open(filename,"w") {|file|
+      file.puts("<html>")
+      file.puts("  <head>")
+      file.puts("  </head>")
+      file.puts("  <body>")
+      file.puts("    <table border=\"1\"")
+      for y in 1..@height
+        file.puts("<tr>")
+        for x in 1..@width
+          #@matrix.set(y,x,'/') if @matrix.cell(y,x) == '.'
+          if @matrix.cell(y,x) == '#'
+            file.puts("<td>")
+            file.puts("<font size=\"-4\">")
+            file.puts(@hinweisliste[[y,x]][0])
+            if @hinweisliste[[y,x]][1] == :horizontal
+              file.puts("-->")
+            else
+              file.puts("V")  
+            end
+            file.puts("</font>")
+            file.puts("</td>")
+            #file.puts(@hinweisliste[[y,x]][1])
+          elsif @matrix.cell(y,x) == '/'
+            file.puts("<td bgcolor=\"black\">")
+            file.puts("&nbsp;")
+            file.puts("</td>")
+          else
+            file.puts("<td>")
+            file.puts(@matrix.cell(y,x))
+            file.puts("</td>")
+          end
+        end
+        file.puts("</tr>")
+      end
+      file.puts("  </table")
+      file.puts("  <body>")
+      file.puts("<html>")
+    }
+    
+  end
+  
+end # Generator

data/lib/rcrossword/grid.rb

@@ -0,0 +1,111 @@
+class Grid
+  def initialize(width,height)
+    @width = width
+    @height = height
+    @matrix = Array.new(height+1)
+    for i in 1..@height
+      @matrix[i] = "."*(@width+1)
+    end
+  end
+  
+  # returns the content of one line
+  def line(n)
+    @matrix[n][1..-1]
+  end
+
+  # returns the content of one cell
+  def cell(line,column)
+    if column >= 1 and column <= @width
+      self.line(line)[column-1..column-1]
+    else
+      nil
+    end
+  end
+  
+  # sets one cell with a character 
+  def set(line,column,character)
+    begin
+      @matrix[line][column] = character
+    rescue NoMethodError
+      puts "Fehler: line #{line}, column #{column}, character #{character}"
+      raise
+    end
+  end
+
+  def insert_possible?(line,column,orientation,word)
+    raise ArgumentError if orientation != :horizontal and orientation != :vertical
+    l = line
+    c = column
+    if cell(l,c) != '.'
+      return false
+    end
+    l += 1 if orientation == :vertical
+    c += 1 if orientation == :horizontal
+    for pos in 0...word.size
+      # Kollision?
+      if cell(l,c) != '.' and cell(l,c) != word[pos..pos].upcase
+        return false
+      end
+      #self.set(l,c,word[pos..pos].upcase)
+      l += 1 if orientation == :vertical
+      c += 1 if orientation == :horizontal
+    end
+    # danach entweder Erklaerungszelle oder Stopzelle oder schon letzte Position im Grid
+    if orientation == :horizontal and c > @width
+      #OK
+    elsif orientation == :vertical and l > @height
+      #OK
+    else
+      if cell(l,c) == '#' or cell(l,c) == '/' or cell(l,c) == '.'
+        #OK
+      else
+        return false
+      end
+    end
+    true
+  end
+
+  # inserts a word. orientation is either :horizontal or :vertical
+  def insert(line,column,orientation,word)
+    raise ArgumentError if orientation != :horizontal and orientation != :vertical
+    l = line
+    c = column
+    if ! insert_possible?(l,c,orientation,word)
+      #puts "cannot insert #{word}"
+      return false
+    end
+    self.set(l,c,'#') # explanation cell
+    l += 1 if orientation == :vertical
+    c += 1 if orientation == :horizontal
+    for pos in 0...word.size
+      # Kollision?
+      if cell(l,c) != '.' and cell(l,c) != word[pos..pos].upcase
+        return false
+      end
+      self.set(l,c,word[pos..pos].upcase)
+      l += 1 if orientation == :vertical
+      c += 1 if orientation == :horizontal
+    end
+    if orientation == :horizontal and c <= @width
+      if cell(l,c) != '#'
+        self.set(l,c,'/')
+      end
+    end
+    if orientation == :vertical and l <= @height
+      if cell(l,c) != '#'
+        self.set(l,c,'/')
+      end
+    end
+    true
+  end
+  
+  # returns an ASCII representation of the matrix
+  def to_s
+    result = ''
+    for line in 1..@height
+      result << self.line(line)+"\n"
+    end
+    result
+  end
+  
+end # class Matrix