crucigrama 0.1.0

data/lib/crucigrama/crossword/word_query.rb

@@ -0,0 +1,107 @@
+# This module provides methods to query word existence, placement and search on a crossword
+module Crucigrama::Crossword::WordQuery
+  
+  
+  # @return [String, nil] the word in the crossword at the given coordinates and direction, if there is one, or nil otherwise
+  # @param [Hash<Symbol,Integer>] coordinates the coordinates for the crossword cell being queried
+  # @option coordinates [Integer] :horizontal a number between 0 and the horizontal dimension of the
+  #   crossword minus one specifying the row of the cell being queried
+  # @option coordinates [Integer] :vertical a number between 0 and the vertical dimension of the 
+  #   crossword minus one specifying the column of the cell being queried
+  # @param [:horizontal,:vertical] direction the direction of the word being queried
+  def word_at(coordinates, direction)
+    other_direction = direction_other_than(direction)
+    words.detect do |word|
+      (word_positions[word][direction]||=[]).detect do |position|
+        position[other_direction] == coordinates[other_direction] and position[direction] <= coordinates[direction] and position[direction] + word.length > coordinates[direction]
+      end
+    end
+  end
+  
+  # @return [Boolean] if the word at the given coordinates and direction on the crossword is the given word
+  # @param [Hash<Symbol,Integer>] coordinates the coordinates for the crossword cell being queried
+  # @option coordinates [Integer] :horizontal a number between 0 and the horizontal dimension of the
+  #   crossword minus one specifying the row of the cell being queried
+  # @option coordinates [Integer] :vertical a number between 0 and the vertical dimension of the 
+  #   crossword minus one specifying the column of the cell being queried
+  # @param [:horizontal,:vertical] direction the direction of the word being queried
+  # @param [String] word the word that is or is not the word at the crossword
+  def word_at?(coordinates, direction, word)
+    word_at(coordinates, direction) == word
+  end
+  
+  # @return [Array<Hash<Symbol,Integer>>] the list of black positions (or empty cells) in the crossword
+  def black_positions
+    @black_positions ||= lines(:horizontal).collect.with_index do |row, vertical_index|
+      row.chars.collect.with_index do |cell, horizontal_index|
+        cell == self.class::BLACK ? {:horizontal => horizontal_index, :vertical => vertical_index} : nil
+      end.compact
+    end.flatten
+  end
+  
+  # @return [Array<String>] the list of words present in the crossword
+  def words
+    word_positions.keys
+  end
+  
+  # @return [Hash<String,Hash<Symbol, Array<Hash<Symbol, Integer>>>>] a relation of the
+  #   words in the crosswords and their starting positions in both directions. Words are
+  #   the primary key in the returned tree, followed by the direction (:horizontal or
+  #   :vertical). The list of positions is given as an Array of hashes with values for
+  #   the :horizontal and :vertical coordinates 
+  # @todo reimplement using lines(direction)
+  def word_positions
+    @word_positions ||= begin
+      result = {}
+      [:horizontal, :vertical].each do |direction|
+        other_direction = direction_other_than(direction)
+        lines(direction).each.with_index do |row, row_index|
+          position = 0
+          row.split(self.class::BLACK).each do |word|
+            unless word.empty?
+              result[word]||= {}
+              result[word][direction]||= []
+              result[word][direction] << {direction => position, other_direction=> row_index}
+            end
+            position+= word.length + 1
+          end
+        end
+      end
+      result
+    end
+  end
+  
+  # @return [Boolean] if the given word can be set on the crossword on the given coordinates and the given direction.
+  #   The word can be set if it is not out of bounds on the crossword (that is, the cells it would occupy are defined)
+  #   and if every crossword cell it would occupy either contains the corresponding word character or is a black
+  #   position or empty cell.
+  def can_set_word?(word, coordinates, direction)
+    return false if out_of_bounds(word, coordinates, direction)
+    return true if word.empty?
+    other_direction = direction_other_than(direction)
+    line = line(coordinates[other_direction], direction)
+    regexp_str = line[coordinates[direction]..line.length][0..word.length-1].gsub(self.class::BLACK, '.')
+    Regexp.new(regexp_str).match(word)
+  end
+  
+  private
+  
+  # @return [Boolean] whether the given word would be out of bounds on the
+  #   crossword on the given coordinates and direction
+  # @param [Hash<Symbol,Integer>] coordinates the coordinates for the crossword cell where the queried word would start
+  # @option coordinates [Integer] :horizontal a number between 0 and the horizontal dimension of the
+  #   crossword minus one specifying the row of the cell where the queried word would start
+  # @option coordinates [Integer] :vertical a number between 0 and the vertical dimension of the 
+  #   crossword minus one specifying the column of the cell where the queried word would start
+  def out_of_bounds(word, coordinates, direction)
+    other_direction = direction_other_than(direction)
+    coordinates[:horizontal] < 0 or coordinates[:vertical] < 0 or dimensions[other_direction] <= coordinates[other_direction] or dimensions[direction] <= coordinates[direction] + word.length - 1
+  end
+  
+  def grid_modified!
+    @word_positions = nil
+    @black_positions = nil
+    super
+  end
+
+end

data/lib/crucigrama/crossword.rb

@@ -0,0 +1,38 @@
+require 'active_support/hash_with_indifferent_access'
+
+# This class represents a crossword
+# @todo Refactor methods to modules Crucigrama::Crossword::Grid, 
+#   Crucigrama::Crossword::WordQuery and Crucigrama::Crossword::Definitions
+# @todo Define public API and make everything else private
+class Crucigrama::Crossword
+  
+  # The symbol used to represent empty cells on the crossword, that is, cells occupied by no word characters
+  BLACK = '#'
+  
+  require 'crucigrama/crossword/grid'
+  require 'crucigrama/crossword/line_query'
+  require 'crucigrama/crossword/word_query'
+  require 'crucigrama/crossword/definitions'
+  
+  include Grid
+  include LineQuery
+  include WordQuery
+  include Definitions
+  
+  begin
+    require 'crucigrama/crossword/pdf_printable'
+    include PdfPrintable
+  rescue LoadError
+  end
+  
+  require 'crucigrama/crossword/serializable'
+  include Serializable
+  
+  include Crucigrama::Positionable
+   
+  
+  def to_s
+    "\n#{grid}"
+  end
+  
+end

data/lib/crucigrama/crossword_builder.rb

@@ -0,0 +1,110 @@
+# @todo document everything!
+class Crucigrama::CrosswordBuilder
+  
+  NOT_REPEATABLE_WORD_MINIMUM_LENGTH = 3
+  
+  include Crucigrama::Positionable
+  
+  attr_reader :valid_words, :crossword_class, :crossword
+  def initialize(opts = {})
+    @valid_words = opts[:valid_words] || []
+    @crossword_class = opts[:crossword_class] || Crucigrama::Crossword
+    @crossword = @crossword_class.new(opts[:dimensions]||{})
+  end
+  
+  
+  def self.build_crossword(opts = {})
+    self.new(opts).build
+  end
+  
+  def build
+    crossword.black_positions.each do |position|
+      set_longest_word_at(position,:horizontal) unless crossword.word_at(position, :horizontal).to_s.length > 1
+      set_longest_word_at(position,:vertical) unless crossword.word_at(position, :vertical).to_s.length > 1
+    end
+    crossword
+  end
+  
+  def valid_word?(word)
+    word == crossword_class::BLACK || word.length == 1 || valid_words.include?(word)
+  end
+  
+  # @todo remove method ?
+  def validate
+    crossword.words.collect{|word| valid_word?(word)}.include?(false) ? false : true
+  end
+  
+  # @todo return both the word and the position it was placed at ?
+  def set_longest_word_at(word_position, direction)
+    transversal_conditions = transversal_conditions_for(word_position, direction)
+    not_word_destructive_condition = not_word_destructive_condition(word_position, direction)
+    can_be_set_condition = can_be_set_condition(word_position, direction)
+    already_used_words = used_words
+    (2..crossword.dimensions[direction]-word_position[direction]).to_a.reverse.each do |length|
+      restricting_word_conditions = [can_be_set_condition, *transversal_conditions[0..length-1], not_word_destructive_condition]
+      eligible_words = restricting_word_conditions.inject(valid_words_by_length(length) - already_used_words) do |word_list, restricting_condition|
+        word_list.select(&restricting_condition)
+      end
+      if word = eligible_words.sample
+        raise "Could not add selected #{word} to crossword:\n#{crossword}" unless crossword.add(word, word_position, direction)
+        return word
+      end
+    end
+    nil
+  end
+  
+  def adyacent_words_to_position(position, direction)
+    return nil if crossword.word_at(position, direction)
+    [crossword.word_at(position.merge(direction => position[direction]-1), direction), crossword.word_at(position.merge(direction => position[direction]+1), direction)]
+  end
+  
+  def transversal_conditions_for(position, direction)
+    (crossword.dimensions[direction] - position[direction]).times.collect do |word_index|
+      adyacent_words = adyacent_words_to_position(position.merge(direction => position[direction]+word_index), direction_other_than(direction))
+      lambda do |word|
+        adyacent_words.nil? || valid_word?("#{adyacent_words[0]}#{word[word_index]}#{adyacent_words[1]}")
+      end
+    end
+  end
+  
+  # @todo Remove ?
+  #def word_length_condition(length)
+  #  lambda do |word|
+  #    word.length == length
+  #  end
+  #end
+  
+  def valid_words_by_length(length)
+    @valid_words_by_length ||={}
+    @valid_words_by_length[length] ||= valid_words.select{|word| word.length == length}
+  end
+  
+  # @todo rename to not_word_invalidating_condition ?
+  def not_word_destructive_condition(coordinates, direction)
+    other_direction = direction_other_than(direction)
+    line = crossword.line(coordinates[other_direction], direction)
+    lambda do |word|
+      words_at_line = line.dup.tap{|line| line[coordinates[direction]..coordinates[direction]+word.length-1]=word}.split(crossword_class::BLACK)
+      words_at_line.detect{|word| valid_word?(word)==false}.nil?
+    end
+  end
+  
+  def can_be_set_condition(position, direction)
+    other_direction = direction_other_than(direction)
+    line = crossword.line(position[other_direction], direction)
+    regexp_str = line[position[direction]..line.length].gsub(crossword_class::BLACK, '.')
+    length_regexps = regexp_str.length.times.collect {|t| Regexp.new(regexp_str[0..t])}
+    lambda do |word|
+      if word.length > length_regexps.length
+        false
+      else
+        word.empty? ? true : length_regexps[word.length - 1].match(word)
+      end
+    end
+  end
+  
+  def used_words
+    crossword.words.reject{|word| word.length < NOT_REPEATABLE_WORD_MINIMUM_LENGTH}
+  end
+  
+end

data/lib/crucigrama/grill_builder.rb

@@ -0,0 +1,51 @@
+class Crucigrama::GrillBuilder < Crucigrama::CrosswordBuilder
+  
+  attr_reader :grill_spacing
+  
+  def initialize(opts = {})
+    @grill_spacing = opts.delete(:grill_spacing) || 2
+    super(opts)
+  end
+  
+  def build
+    grill_spacing.times do |i|
+      (i..crossword.dimensions.values.max-1).step(grill_spacing).each do |coordinate|
+        fill_line(coordinate,:horizontal) if crossword.dimensions[:horizontal] > coordinate
+        fill_line(coordinate,:vertical) if crossword.dimensions[:vertical] > coordinate
+      end
+    end
+    crossword
+  end
+  
+  private
+  
+  def fill_line(index, direction)
+    result = []
+    other_direction = direction_other_than(direction)
+    positions_to_try = crossword.black_positions.select{|position| position[other_direction]==index}
+    tried_positions = []
+    until positions_to_try.empty? do
+      position = positions_to_try.first
+      word_position = position_to_start_word(position, direction)
+      result << set_longest_word_at(word_position, direction)
+      tried_positions << position
+      positions_to_try = crossword.black_positions.select{|position| position[other_direction]==index} - tried_positions
+    end
+    result.compact
+  end
+  
+  # @todo Remove first previous_position declaration?
+  def position_to_start_word(position, direction)
+    return position if position[direction] == 0
+    if (position_word = crossword.word_at(position, direction)).nil?
+      previous_position = position.merge(direction => position[direction]-1) 
+      unless position_word = crossword.word_at(previous_position, direction)
+        return position
+      end
+    end
+    other_direction = direction_other_than(direction)
+    crossword.word_positions[position_word][direction].select do |word_position| 
+      position[other_direction] == word_position[other_direction] and word_position[direction] <= position[direction] 
+    end.last
+  end
+end

data/lib/crucigrama/positionable.rb

@@ -0,0 +1,19 @@
+# This module defines some methods of use to interact with {Crucigrama::Crossword}s
+module Crucigrama::Positionable
+  
+  # @return [Hash<Symbol,Integer>] a hash with the horizontal and vertical coordinates
+  # @param [Integer] x the horizontal coordinate
+  # @param [Integer] y the vertical coordinate
+  def position(x,y)
+    {:horizontal => x, :vertical => y}
+  end
+  
+  # @return [Symbol, nil] the direction opposite to the one given,
+  #   that is, :horizontal for :vertical and :vertical for :horizontal;
+  #   or nil if neither :horizontal nor :vertical is provided as direction
+  # @param [:horizontal, :vertical, nil] direction the direction whose
+  #   opposite is queried
+  def direction_other_than(direction)
+    { :horizontal => :vertical, :vertical => :horizontal}[direction]
+  end
+end

data/lib/crucigrama/version.rb

@@ -0,0 +1,15 @@
+
+# The namespace for the crucigrama library, a ruby library for the generation of crosswords
+module Crucigrama
+
+  # The version for the Crucigrama library, according to RubyGems Rational Versioning Policy
+  VERSION = File.read(File.join(File.dirname(__FILE__), '../../VERSION'))
+  
+  # The major version number for the Crucigrama library, according to RubyGems Rational Versioning Policy
+  MAJOR, 
+  # The minor version number for the Crucigrama library, according to RubyGems Rational Versioning Policy
+  MINOR, 
+  # The patch version number for the Crucigrama library, according to RubyGems Rational Versioning Policy
+  PATCH = * VERSION.split('.')
+
+end

data/lib/crucigrama.rb

@@ -0,0 +1,5 @@
+require 'crucigrama/version'
+require 'crucigrama/positionable'
+require 'crucigrama/crossword'
+require 'crucigrama/crossword_builder'
+require 'crucigrama/grill_builder'

data/spec/crucigrama_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Crucigrama" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+if ENV["COVERAGE"]
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+    add_filter '/config/'
+    add_filter '/lib/'
+    add_filter '/vendor/'
+
+    add_group 'Controllers', 'app/controllers'
+    add_group 'Models', 'app/models'
+    add_group 'Helpers', 'app/helpers'
+    add_group 'Mailers', 'app/mailers'
+    add_group 'Views', 'app/views'
+  end 
+end
+
+require 'rspec'
+require 'crucigrama'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification 
+name: crucigrama
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Pablo Ba\xC3\xB1os L\xC3\xB3pez"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-21 00:00:00 +02:00
+default_executable: crucigrama
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+description: "= crucigrama\n\n\
+  Crucigrama is a library for the generation of crosswords. The gem includes as well a simple command line tool that, making use of the\n\
+  library, can generate and print crosswords.\n\n\
+  == Contributing to crucigrama\n \n\
+  * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet\n\
+  * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it\n\
+  * Fork the project\n\
+  * Start a feature/bugfix branch\n\
+  * Commit and push until you are happy with your contribution\n\
+  * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.\n\
+  * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.\n\n\
+  == Copyright\n\n\
+  Copyright (c) 2011-2012 Pablo Ba\xC3\xB1os L\xC3\xB3pez\n\n\
+  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \xE2\x80\x9CSoftware\xE2\x80\x9D), 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:\n\n\
+  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\n\
+  THE SOFTWARE IS PROVIDED \xE2\x80\x9CAS IS\xE2\x80\x9D, 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.\n\n"
+email: pbl1986@gmail.com
+executables: 
+- crucigrama
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/crucigrama
+- examples/crosswords/01.json
+- examples/crosswords/02.json
+- examples/crosswords/03.json
+- examples/lemaries/es-1.txt
+- features/crucigrama.feature
+- features/step_definitions/crucigrama_steps.rb
+- features/support/env.rb
+- lib/crucigrama.rb
+- lib/crucigrama/cli.rb
+- lib/crucigrama/cli/generate.rb
+- lib/crucigrama/cli/print.rb
+- lib/crucigrama/crossword.rb
+- lib/crucigrama/crossword/definitions.rb
+- lib/crucigrama/crossword/grid.rb
+- lib/crucigrama/crossword/line_query.rb
+- lib/crucigrama/crossword/pdf_printable.rb
+- lib/crucigrama/crossword/serializable.rb
+- lib/crucigrama/crossword/word_query.rb
+- lib/crucigrama/crossword_builder.rb
+- lib/crucigrama/grill_builder.rb
+- lib/crucigrama/positionable.rb
+- lib/crucigrama/version.rb
+- spec/crucigrama_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/pbanos/crucigrama
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -2989028535230256657
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby library for the generation of crosswords
+test_files: []
+