pangrid 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ca64b939037c4c658be062373bc66156605c3833
-  data.tar.gz: 8792223200b3f4a5bfdcd212127c6724b4a087ae
+SHA256:
+  metadata.gz: 33b68bb3ffccf5e357c16637245e4488b3541070737f171e2773e035ccdfbcfd
+  data.tar.gz: 05b0853605cccef29232acb6f96e1a53e1356e830e85a7c158595c426c179fbf
 SHA512:
-  metadata.gz: a3361137ff447f19ae7f2db13ca66c259b10a1f13387382881c25d5f63e5b84a7516999bf19c27a4b984ee08553f8461e7db66389e8391fe2f867b8523bd3aa5
-  data.tar.gz: becb38b39f34b7e25876e5d1a7d148bb92a205fd59230fbb11ea465680099bf65bc46952391df8dafb8a6cf8f9aba7d073388d20504a92c2224058e0ccc689e7
+  metadata.gz: '00778b056954ae735461bc4782e5c9aae027ac6d0b2928a6253507afa8113abbc26ee908ba4e68b49c42d128a15b38406604eb6303e6214af88969824c2854b9'
+  data.tar.gz: de0cd413482c54b815ecf2eb97b41511b1a309858d61a2e3571cfff98fb1d6478fda2d5f4c332142253ae25969fa682dca97ddcb8d68d49f39b162f248614630

data/lib/pangrid/frontend/webrick.rb

@@ -26,11 +26,30 @@ class Servlet < WEBrick::HTTPServlet::AbstractServlet
     rescue Exception => e
       out = e.inspect
     end
-    
-    template = IO.read(TEMPLATE)
-    response.status = 200
-    response.content_type = "text/html"
-    response.body = template % out
+
+    response.header['Access-Control-Allow-Origin'] = '*'
+
+    case request.path
+    when "/"
+      template = IO.read(TEMPLATE)
+      response.status = 200
+      response.content_type = "text/html"
+      response.body = template % out
+    when "/blob"
+      response.status = 200
+      response.content_type = "application/octet-stream"
+      response.body = out
+    when "/json"
+      if request.query["to"] == "json"
+        response.status = 200
+        response.content_type = "text/json"
+        response.body = out
+      else
+        response.status = 200
+        response.content_type = "text/json"
+        response.body = '{ "error" : "non-json format requested" }'
+      end
+    end
   end
 end
 

data/lib/pangrid/plugin.rb

@@ -35,6 +35,8 @@ class Plugin
   FAILED = []
   MISSING_DEPS = {}
 
+  DESCRIPTION = ""
+
   def self.inherited(subclass)
     name = class_to_name(subclass.name)
     #puts "Registered #{subclass} as #{name}"
@@ -62,13 +64,13 @@ class Plugin
 
   def self.list_all
     puts "-------------------------------------------------------"
-    puts "Available plugins:"
+    puts "Available plugins (F = from, T = to):"
     puts "-------------------------------------------------------"
     REGISTRY.keys.sort.each do |name|
       plugin = REGISTRY[name]
       provides = [:read, :write].select {|m| plugin.method_defined? m}
-      provides = provides.map {|m| {read: 'from', write: 'to'}[m]}
-      puts "  " + name + " [" + provides.join(", ") + "]"
+      provides = provides.map {|m| {read: 'F', write: 'T'}[m]}.join
+      puts "  #{name} [#{provides}]".ljust(30) + plugin.const_get(:DESCRIPTION)
     end
     if !MISSING_DEPS.empty?
       puts

data/lib/pangrid/plugins/acrosslite.rb

@@ -75,6 +75,8 @@ class AcrossLiteBinary < Plugin
   # crossword, checksums
   attr_accessor :xw, :cs
 
+  DESCRIPTION = "AcrossLite binary format (.puz)"
+
   HEADER_FORMAT = "v A12 v V2 A4 v2 A12 c2 v3"
   HEADER_CHECKSUM_FORMAT = "c2 v3"
   EXT_HEADER_FORMAT = "A4 v2"
@@ -359,6 +361,8 @@ class AcrossLiteText < Plugin
 
   attr_accessor :xw, :rebus
 
+  DESCRIPTION = "AcrossLite text format"
+
   def initialize
     @xw = XWord.new
   end

data/lib/pangrid/plugins/csv.rb

@@ -26,6 +26,9 @@ require 'csv'
 module Pangrid
 
 class CSV < Plugin
+
+  DESCRIPTION = "CSV reader (see source comments for format)"
+
   def read(data)
     s = ::CSV.parse(data)
     s.reject! {|row| row.compact.empty?}

data/lib/pangrid/plugins/excel.rb

@@ -11,6 +11,9 @@ module Pangrid
 require_for_plugin 'excel', ['axlsx']
 
 class ExcelXSLX < Plugin
+
+  DESCRIPTION = "Excel writer. Useful to upload to google sheets."
+
   # styles
   STYLES = {
     :black => {:bg_color => "00"},

data/lib/pangrid/plugins/exolve.rb

@@ -0,0 +1,128 @@
+# Exolve (https://github.com/viresh-ratnakar/exolve) is a browser-based
+# crossword solver that allows you to embed the crossword and solving software
+# in a single HTML file.
+
+module Pangrid
+
+module ExolveWriter
+  def write(xw)
+    headers = format_headers(xw)
+    across, down = xw.number
+    grid = format_grid(xw)
+    ac = format_clues(across, xw.across_clues)
+    dn = format_clues(down, xw.down_clues)
+    across = ["exolve-across:"] + indent(ac)
+    down = ["exolve-down:"] + indent(dn)
+    grid = ["exolve-grid:"] + indent(grid)
+    body = headers + grid + across + down
+    out = ["exolve-begin"] + indent(body) + ["exolve-end"]
+    out.join("\n")
+  end
+
+  def format_headers(xw)
+    headers = [
+      'id', 'replace-with-unique-id',
+      'title', xw.title,
+      'setter', xw.author,
+      'width', xw.width,
+      'height', xw.height,
+      'copyright', xw.copyright,
+      'prelude', xw.preamble
+    ]
+    headers.each_slice(2).select {|k, v| v}.map {|k, v| "exolve-#{k}: #{v}"}
+  end
+
+  def format_clues(numbers, clues)
+    numbers.zip(clues).map {|n, c| "#{n.to_s.rjust(2)} #{c}"}
+  end
+
+  def indent(lines)
+    lines.map {|x| "  " + x}
+  end
+end
+
+module ExolveReader
+  def read(data)
+    s = data.each_line.map(&:rstrip)
+    first = s.index('exolve-begin')
+    check("exolve-begin missing") { first }
+    last = s.index('exolve-end')
+    check("exolve-end missing") { last }
+    lines = s[(first + 1)...last]
+    xw = XWord.new
+    s = sections(lines)
+    s.each do |_, field, data|
+      if %w(title setter copyright prelude).include? field
+        xw[field] = data
+      elsif %w(height width).include? field
+        xw[field] = data.to_i
+      elsif %(across down).include? field
+        xw["#{field}_clues"] = data
+      elsif field == "grid"
+        xw.solution = parse_grid(data)
+      end
+    end
+    xw
+  end
+
+  def sections(lines)
+    headers = lines.each.with_index.map do |l, i|
+      m = l.match(/^(\s+)exolve-(\w+):(.*)$/)
+      if m
+        _, indent, field, data = m.to_a
+        [i, field, data.strip]
+      else
+        nil
+      end
+    end
+    headers.compact!
+    headers.push([lines.length, "", ""])
+    headers.each_cons(2) do |i, j|
+      if i[2].empty?
+        i[2] = lines[(i[0] + 1)...j[0]].map(&:strip)
+      end
+    end
+    headers.pop
+    headers
+  end
+
+  def parse_grid_char(char)
+    case char
+    when '0'; :null
+    when '.'; :black
+    else; char
+    end
+  end
+
+  def parse_grid(lines)
+    grid = lines.map(&:strip).map {|x| x.split(//)}
+    grid.map do |col|
+      col.map do |c|
+        Cell.new(:solution => parse_grid_char(c))
+      end
+    end
+  end
+end
+
+class ExolveFilled < Plugin
+  include ExolveReader
+  include ExolveWriter
+
+  DESCRIPTION = "Exolve writer with solutions"
+
+  def format_grid(xw)
+    xw.to_array(:black => '.', :null => '0').map(&:join)
+  end
+end
+
+class ExolveBlank < Plugin
+  include ExolveWriter
+
+  DESCRIPTION = "Exolve writer without solutions"
+
+  def format_grid(xw)
+    xw.to_array(:black => '.', :null => '0') {|c| 0}.map(&:join)
+  end
+end
+
+end # module Pangrid

data/lib/pangrid/plugins/json.rb

@@ -0,0 +1,78 @@
+# Json
+#
+# cell = { x : int, y : int, contents : string }
+#
+# xword = { rows : int, 
+#           cols : int, 
+#           cells : [cell],
+#           across : [string]
+#           down : [string]
+#         }
+
+require 'json'
+
+module Pangrid
+
+class Json < Plugin
+
+  DESCRIPTION = "Simple JSON format"
+
+  def write(xw)
+    cells = []
+    (0 ... xw.height).each do |y|
+      (0 ... xw.width).each do |x|
+        cell = xw.solution[y][x]
+        s = case cell.solution
+            when :black; '#'
+            when :null; ''
+            when Rebus; cell.solution.inspect
+            else; cell.solution
+            end
+
+        cells.push({ x: x, y: y, contents: s })
+      end
+    end
+
+    h = {
+      rows: xw.height,
+      cols: xw.width,
+      cells: cells,
+      across: xw.across_clues,
+      down: xw.down_clues
+    }
+
+    ::JSON.generate(h)
+  end
+
+  def read(data)
+    json = ::JSON.parse(data)
+    xw = XWord.new
+
+    xw.height = json['rows']
+    xw.width = json['cols']
+    xw.solution = Array.new(xw.height) { Array.new(xw.width) }
+    json['cells'].each do |c|
+      cell = Cell.new
+      s = c['contents']
+      cell.solution =
+        case s
+        when ""; :null
+        when "#"; :black
+        else
+          if s.length == 1
+            s
+          else
+            Rebus.new s
+          end
+        end
+      x, y = c['x'], c['y']
+      xw.solution[y][x] = cell
+    end
+    xw.across_clues = json['across']
+    xw.down_clues = json['down']
+    xw
+  end
+
+end
+
+end

data/lib/pangrid/plugins/png.rb

@@ -0,0 +1,25 @@
+require 'chunky_png'
+
+module Pangrid
+  
+  class PNGThumbnail < Plugin
+
+    def write(xw)
+      black = ChunkyPNG::Color::BLACK
+      white = ChunkyPNG::Color::WHITE
+      red = ChunkyPNG::Color::rgb(255, 0, 0)
+      grey = ChunkyPNG::Color::rgb(128, 128, 128)
+      scale = 4
+      png = ChunkyPNG::Image.new(64, 64, ChunkyPNG::Color::TRANSPARENT)
+      xw.each_cell_with_coords do |x, y, cell|
+        c = cell.black? ? black : white
+        png.rect(
+          x * scale, y * scale, (x + 1) * scale, (y + 1) * scale,
+          stroke_color = grey, fill_color = c)
+      end
+      png.rect(0, 0, xw.width * scale, xw.height * scale, stroke_color = red)
+      png.to_blob  
+    end
+  end
+
+end # module Pangrid

data/lib/pangrid/plugins/qxw.rb

@@ -0,0 +1,49 @@
+# Qxw savefile for rectangular grids [http://www.quinapalus.com/qxw.html]
+
+module Pangrid
+
+QXW_GRID_ERROR = "Could not read grid from .qxw file"
+
+class Qxw < Plugin
+
+  DESCRIPTION = "QXW grid reader (rectangular grids only)"
+
+  def read(data)
+    xw = XWord.new
+    lines = data.lines.map(&:chomp)
+    gp = lines.find {|x| x =~ /^GP( \d+){6}$/}
+    check("Could not read grid size from .qxw file") { gp }
+    type, w, h, _ = gp.scan(/\d+/).map(&:to_i)
+    check("Only rectangular grids are supported") { type == 0 }
+    xw.width = w
+    xw.height = h
+    xw.solution = []
+    grid = lines.select {|x| x =~ /^SQ /}
+    grid.each do |line|
+      parts = line.scan(/\w+/)
+      check(QXW_GRID_ERROR) { parts.length == 6 || parts.length == 7 }
+      col, row, b, c = parts[1].to_i, parts[2].to_i, parts[5].to_i, parts[6]
+      cell = Cell.new
+      if b == 1
+        cell.solution = :black
+      elsif c == nil
+        cell.solution = :null
+      else
+        cell.solution = c
+      end
+      xw.solution[row] ||= []
+      xw.solution[row][col] = cell
+    end
+    check(QXW_GRID_ERROR) { xw.solution.length == xw.height }
+    check(QXW_GRID_ERROR) { xw.solution.all? {|i| i.compact.length == xw.width} }
+
+    # Placeholder clues
+    _, _, words_a, words_d = xw.number(true)
+    xw.across_clues = words_a.map {|i| "[#{i}]" }
+    xw.down_clues = words_d.map {|i| "[#{i}]" }
+
+    xw
+  end
+end
+
+end # module Pangrid

data/lib/pangrid/plugins/reddit.rb

@@ -34,6 +34,8 @@ end
 class RedditFilled < Plugin
   include RedditWriter
 
+  DESCRIPTION = "Reddit format (with filled squares)"
+
   def write(xw)
     write_xw(xw)
   end
@@ -48,6 +50,8 @@ end
 class RedditBlank < Plugin
   include RedditWriter
 
+  DESCRIPTION = "Reddit format (with blank squares)"
+
   def write(xw)
     write_xw(xw)
   end
@@ -88,6 +92,7 @@ class RedditBlank < Plugin
     #
     # we have to be careful about leading/trailing |s
     ix = lines.find_index {|row| row =~ /^[|\s-]+$/}
+    check("Could not find grid") { not ix.nil? }
     width = lines[ix].gsub(/\s/, '').split('|').reject(&:empty?).length
     lines = [lines[(ix - 1)]] + lines[(ix + 1) .. -1]
     grid = lines.take_while {|i| is_grid_row(i)}

data/lib/pangrid/plugins/text.rb

@@ -9,6 +9,9 @@
 module Pangrid
 
 class Text < Plugin
+
+  DESCRIPTION = "Basic text format (mostly for debugging)"
+
   def write(xw)
     across, down = xw.number
     rows = xw.to_array(:black => '#', :null => '.')
@@ -27,7 +30,7 @@ class Text < Plugin
   end
 
   def format_clues(numbers, clues, indent)
-    numbers.zip(clues).map {|n, c| " "*indent + "#{n}. #{c}"}.join("\n")
+    numbers.zip(clues).map {|n, c| " "*indent + "#{n.to_s.rjust(2)}. #{c}"}.join("\n")
   end
 end
 

data/lib/pangrid/version.rb

@@ -1,3 +1,3 @@
 module Pangrid
-  VERSION='0.3.0'
+  VERSION='0.5.0'
 end

data/lib/pangrid/xw.rb

@@ -53,6 +53,15 @@ class Cell
     rebus? ? solution.to_char : solution
   end
 
+  def to_w
+    case solution
+    when :black; '#'
+    when :null; '.'
+    when Rebus; solution.inspect
+    else; solution
+    end
+  end
+
   def inspect
     case solution
     when :black; '#'
@@ -86,19 +95,40 @@ class XWord < OpenStruct
     boundary?(x, y - 1) && !boundary?(x, y) && !boundary?(x, y + 1)
   end
 
-  def number
+  # Word starting from a square
+  def word_from(x, y, dir)
+    s = ""
+    while !boundary?(x, y) do
+      s += solution[y][x].to_w
+      if dir == :across
+        x += 1
+      else
+        y += 1
+      end
+    end
+    s
+  end
+
+  def number(words = false)
     n, across, down = 1, [], []
+    words_a, words_d = [], []
     (0 ... height).each do |y|
       (0 ... width).each do |x|
-        across << n if across? x, y
-        down << n if down? x, y
+        if across? x, y
+          across << n
+          words_a << word_from(x, y, :across)
+        end
+        if down? x, y
+          down << n
+          words_d << word_from(x, y, :down)
+        end
         if across.last == n || down.last == n
           solution[y][x].number = n
           n += 1
         end
       end
     end
-    [across, down]
+    words ? [across, down, words_a, words_d] : [across, down]
   end
 
   def each_cell
@@ -109,6 +139,14 @@ class XWord < OpenStruct
     end
   end
 
+  def each_cell_with_coords
+    (0 ... height).each do |y|
+      (0 ... width).each do |x|
+        yield [x, y, solution[y][x]]
+      end
+    end
+  end
+
   # {:black => char, :null => char} -> Any[][]
   def to_array(opts = {})
     opts = {:black => '#', :null => ' '}.merge(opts)
@@ -137,7 +175,7 @@ class XWord < OpenStruct
       if c.rebus?
         r = c.solution
         if self.rebus[s]
-          sym, char = self.rebus[s]
+          sym, _ = self.rebus[s]
           r.symbol = sym.to_s
         else
           k += 1

metadata

@@ -1,16 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: pangrid
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Martin DeMello
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-11 00:00:00.000000000 Z
-dependencies: []
-description: 
+date: 2021-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+description:
 email: martindemello@gmail.com
 executables:
 - pangrid
@@ -29,6 +43,10 @@ files:
 - lib/pangrid/plugins/acrosslite.rb
 - lib/pangrid/plugins/csv.rb
 - lib/pangrid/plugins/excel.rb
+- lib/pangrid/plugins/exolve.rb
+- lib/pangrid/plugins/json.rb
+- lib/pangrid/plugins/png.rb
+- lib/pangrid/plugins/qxw.rb
 - lib/pangrid/plugins/reddit.rb
 - lib/pangrid/plugins/text.rb
 - lib/pangrid/utils.rb
@@ -38,7 +56,7 @@ homepage: https://github.com/martindemello/pangrid
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README
@@ -55,9 +73,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: A crossword file format converter
 test_files: []