pangrid 0.2.1

data/lib/pangrid/plugins/csv.rb

@@ -0,0 +1,83 @@
+# CSV representation
+#
+# Useful if you develop your grid in a spreadsheet, for example.
+#
+# Expected header format:
+#
+# Width: 15, Height: 15, Offset: 0, Black: ., Empty: -, Clues: 3
+#
+# detailing
+# - the width, height and starting column of the
+# grid
+# - the characters representing black and empty squares
+# - the column in which the clues are in after the
+# grid.
+#
+#
+# Blank rows are ignored, as are all rows before the
+# header, and rows after the grid with nothing in
+# the clue column.
+#
+# provides:
+#   CSV: read
+
+require 'csv'
+
+module Pangrid
+
+class CSV < Plugin
+  def read(data)
+    s = ::CSV.parse(data)
+    s.reject! {|row| row.compact.empty?}
+    while s[0] && s[0][0] !~ /^Width:/i do
+      s.shift
+    end
+    check("No header row found. Header needs a 'Width: ' cell in the first column.") { !s.empty? }
+    xw = XWord.new
+    h = s.shift.map {|c| c.split(/:\s*/)}
+    header = OpenStruct.new
+    h.each do |k, v|
+      header[k.downcase] = v
+    end
+
+    header.clues = header.clues.to_i
+    xw.width = header.width.to_i
+    xw.height = header.height.to_i
+    xw.solution = []
+    xw.height.times do
+      row = s.shift
+      check("Row does not have #{xw.width} cells: \n" +
+            row.join(',')) { row.length == xw.width }
+      xw.solution << row.map do |c|
+        cell = Cell.new
+        if c == header.black
+          cell.solution = :black
+        elsif c == header.empty or c == nil
+          cell.solution = :null
+        else
+          cell.solution = c.gsub /[^[:alpha:]]/, ''
+        end
+        cell
+      end
+    end
+
+    xw.clues = []
+    s.each do |row|
+      if row[header.clues]
+        xw.clues << row[header.clues]
+      end
+    end
+    unpack_clues(xw)
+    xw
+  end
+
+  private
+  def unpack_clues(xw)
+    across, down = xw.number
+    n_across = across.length
+    xw.across_clues = xw.clues[0 ... n_across]
+    xw.down_clues = xw.clues[n_across .. -1]
+  end
+end
+
+end # module Pangrid

data/lib/pangrid/plugins/excel.rb

@@ -0,0 +1,66 @@
+# Write puzzles out in Excel's .xslx format
+#
+# Useful primarily for importing a grid into a google spreadsheet for online,
+# collaborative solving
+#
+# provides:
+#   ExcelXSLX : write
+
+module Pangrid
+
+require_for_plugin 'excel', ['axlsx']
+
+class ExcelXSLX < Plugin
+  # styles
+  STYLES = {
+    :black => {:bg_color => "00"},
+    :white => {
+      :bg_color => "FF", :fg_color => "00",
+      :alignment => { :horizontal=> :right },
+      :border => Axlsx::STYLE_THIN_BORDER
+    }
+  }
+
+  # cobble a cell number together out of unicode superscript chars
+  SUPERSCRIPTS = %w(⁰ ¹ ² ³ ⁴ ⁵ ⁶ ⁷ ⁸ ⁹)
+
+  def format_number(n)
+    n.to_s.split(//).map {|c| SUPERSCRIPTS[c.to_i]}.join("").rjust(3)
+  end
+
+  def write(xw)
+    xw.number
+    rows = xw.to_array(:black => " ", :null => " ") {|c|
+      format_number(c.number) + " " +
+      # We can insert the entire word for rebuses
+      c.solution
+    }
+
+    styles = xw.to_array(:black => :black, :null => :white) {
+      :white
+    }
+
+    p = Axlsx::Package.new
+    wb = p.workbook
+
+    # styles
+    wb.styles do |s|
+      xstyles = {}
+      STYLES.map {|k, v| xstyles[k] = s.add_style v}
+      wb.add_worksheet(:name => "Crossword") do |sheet|
+        rowstyles = styles.map {|r|
+          r.map {|c| xstyles[c]}
+        }
+        rows.zip(rowstyles).each {|r, s|
+          sheet.add_row r, :style => s
+        }
+      end
+    end
+
+    out = p.to_stream(true)
+    check("Spreadsheet did not validate") { out }
+    out.read
+  end
+end
+
+end # module Pangrid

data/lib/pangrid/plugins/reddit.rb

@@ -0,0 +1,62 @@
+# Markup used by crosswords.reddit.com
+
+module Pangrid
+
+module RedditWriter
+  def write_line(row)
+    '|' + row.join('|') + '|'
+  end
+
+  def write_table(grid)
+    width = grid[0].length
+    out = grid.map {|row| write_line(row)}
+    sep = write_line(["--"] * width)
+    out = [out[0], sep] + out[1..-1]
+    out.join("\n") + "\n"
+  end
+
+  def format_clues(numbers, clues, indent)
+    numbers.zip(clues).map {|n, c| " "*indent + "#{n}\\. #{c}"}.join("\n\n")
+  end
+
+  def write_clues(xw, across, down)
+    ac = "**Across**\n\n" + format_clues(across, xw.across_clues, 2)
+    dn = "**Down**\n\n" + format_clues(down, xw.down_clues, 2)
+    ac + "\n\n" + dn
+  end
+
+  def write_xw(xw)
+    across, down = xw.number
+    write_table(grid(xw)) + "\n\n" + write_clues(xw, across, down) + "\n"
+  end
+end
+
+class RedditFilled < Plugin
+  include RedditWriter
+
+  def write(xw)
+    write_xw(xw)
+  end
+
+  def grid(xw)
+    xw.to_array({:black => '*.*', :null => ' '}) do |c|
+      c.to_char.upcase + (c.number ? "^#{c.number}" : '')
+    end
+  end
+end
+
+class RedditBlank < Plugin
+  include RedditWriter
+
+  def write(xw)
+    write_xw(xw)
+  end
+
+  def grid(xw)
+    xw.to_array({:black => '*.*', :null => ' '}) do |c|
+      c.number ? "^#{c.number}" : ''
+    end
+  end
+end
+
+end # module Pangrid

data/lib/pangrid/plugins/text.rb

@@ -0,0 +1,34 @@
+# Plain text representation
+#
+# Mostly used for debugging and quick printing of a grid right now, but it
+# would be useful to have a minimalist text representation of a grid and clues.
+#
+# provides:
+#   Text : write
+
+module Pangrid
+
+class Text < Plugin
+  def write(xw)
+    across, down = xw.number
+    rows = xw.to_array(:black => '#', :null => ' ')
+    grid = rows.map(&:join).join("\n") + "\n"
+    ac = "Across:\n\n" + format_clues(across, xw.across_clues, 2)
+    dn = "Down:\n\n" + format_clues(down, xw.down_clues, 2)
+    grid + "\n" + ac + "\n\n" + dn + "\n"
+  end
+
+  # rename to 'read' when this is complete
+  def read_grid(data)
+    s = data.each_line.map(&:strip)
+    m = s[0].match(/^Grid (\d+) (\d+)$/)
+    check("Grid line missing") { m }
+    xw.height, xw.width = m[1].to_i, m[2].to_i
+  end
+
+  def format_clues(numbers, clues, indent)
+    numbers.zip(clues).map {|n, c| " "*indent + "#{n}. #{c}"}.join("\n")
+  end
+end
+
+end # module Pangrid

data/lib/pangrid/utils.rb

@@ -0,0 +1,9 @@
+module Pangrid
+
+module PluginUtils
+  def check(msg = "")
+    raise PuzzleFormatError, msg unless yield
+  end
+end
+
+end # module Pangrid

data/lib/pangrid/version.rb

@@ -0,0 +1,3 @@
+module Pangrid
+  VERSION='0.2.1'
+end

data/lib/pangrid/xw.rb

@@ -0,0 +1,152 @@
+require 'ostruct'
+
+module Pangrid
+
+class PuzzleFormatError < StandardError
+end
+
+# symbol: the symbol representing the solution in the grid
+#         (populated by xword.encode_rebus!)
+# solution: the word the symbol represents
+# display_char: optional character representation of a rebus square
+class Rebus
+  attr_accessor :symbol, :solution, :display_char
+
+  def initialize(str, char = nil)
+    @symbol = nil
+    @solution = str
+    @display_char = char || str[0]
+  end
+
+  def to_char
+    symbol || display_char
+  end
+
+  def inspect
+    "[#{symbol}|#{solution}]"
+  end
+end
+
+# solution = :black | :null | char | Rebus
+# number = int
+# borders = [:left, :right, :top, :bottom]
+class Cell
+  attr_accessor :solution, :number, :borders
+
+  def initialize(**args)
+    args.each {|k,v| self.send :"#{k}=", v}
+  end
+
+  def black?
+    solution == :black
+  end
+
+  def has_bar?(s)
+    borders.include? s
+  end
+
+  def rebus?
+    solution.is_a?(Rebus)
+  end
+
+  def to_char
+    rebus? ? solution.to_char : solution
+  end
+
+  def inspect
+    case solution
+    when :black; '#'
+    when :null; '.'
+    when Rebus; solution.inspect
+    else; solution
+    end
+  end
+end
+
+# solution = Cell[][]
+# width, height = int
+# across_clues = string[]
+# down_clues = string[]
+# rebus = { solution => [int, rebus_char] }
+class XWord < OpenStruct
+  # Clue numbering
+  def black?(x, y)
+    solution[y][x].black?
+  end
+
+  def boundary?(x, y)
+    (x < 0) || (y < 0) || (x >= width) || (y >= height) || black?(x, y)
+  end
+
+  def across?(x, y)
+    boundary?(x - 1, y) && !boundary?(x, y) && !boundary?(x + 1, y)
+  end
+
+  def down?(x, y)
+    boundary?(x, y - 1) && !boundary?(x, y) && !boundary?(x, y + 1)
+  end
+
+  def number
+    n, across, down = 1, [], []
+    (0 ... height).each do |y|
+      (0 ... width).each do |x|
+        across << n if across? x, y
+        down << n if down? x, y
+        if across.last == n || down.last == n
+          solution[y][x].number = n
+          n += 1
+        end
+      end
+    end
+    [across, down]
+  end
+
+  def each_cell
+    (0 ... height).each do |y|
+      (0 ... width).each do |x|
+        yield solution[y][x]
+      end
+    end
+  end
+
+  # {:black => char, :null => char} -> Any[][]
+  def to_array(opts = {})
+    opts = {:black => '#', :null => ' '}.merge(opts)
+    solution.map {|row|
+      row.map {|c|
+        s = c.solution
+        case s
+        when :black, :null
+          opts[s]
+        when String
+          block_given? ? (yield c) : c.to_char
+        when Rebus
+          block_given? ? (yield c) : c.to_char
+        else
+          raise PuzzleFormatError, "Unrecognised cell #{c}"
+        end
+      }
+    }
+  end
+
+  # Collect a hash of rebus solutions, each mapped to an integer.
+  def encode_rebus!
+    k = 0
+    self.rebus = {}
+    each_cell do |c|
+      if c.rebus?
+        r = c.solution
+        if self.rebus[s]
+          sym, char = self.rebus[s]
+          r.symbol = sym.to_s
+        else
+          k += 1
+          self.rebus[r.solution] = [k, r.display_char]
+          r.symbol = k.to_s
+        end
+      end
+    end
+  end
+end
+
+end # module Pangrid

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: pangrid
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Martin DeMello
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-09 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: martindemello@gmail.com
+executables:
+- pangrid
+extensions: []
+extra_rdoc_files:
+- README
+files:
+- LICENSE
+- README
+- bin/pangrid
+- lib/deps/trollop.rb
+- lib/pangrid.rb
+- lib/pangrid/frontend/webrick.rb
+- lib/pangrid/plugin.rb
+- lib/pangrid/plugins/acrosslite.rb
+- lib/pangrid/plugins/csv.rb
+- lib/pangrid/plugins/excel.rb
+- lib/pangrid/plugins/reddit.rb
+- lib/pangrid/plugins/text.rb
+- lib/pangrid/utils.rb
+- lib/pangrid/version.rb
+- lib/pangrid/xw.rb
+homepage: https://github.com/martindemello/pangrid
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A crossword file format converter
+test_files: []