pangrid 0.5.3 → 0.6.0

data/lib/pangrid/xw.rb

@@ -1,5 +1,3 @@
-require 'ostruct'
-
 module Pangrid
 
 class PuzzleFormatError < StandardError
@@ -62,14 +60,7 @@ class Cell
     end
   end
 
-  def inspect
-    case solution
-    when :black; '#'
-    when :null; '.'
-    when Rebus; solution.inspect
-    else; solution
-    end
-  end
+  alias_method :inspect, :to_w
 end
 
 # solution = Cell[][]
@@ -77,7 +68,53 @@ end
 # across_clues = string[]
 # down_clues = string[]
 # rebus = { solution => [int, rebus_char] }
-class XWord < OpenStruct
+class XWord
+  # Metadata shared by all formats
+  COMMON = %i(width height solution across_clues down_clues
+              title author copyright notes preamble rebus)
+
+  # AcrossLite binary format fields
+  #   clues: across and down clues interleaved in numerical order
+  #   fill: the solver's progress
+  #   mark: AcrossLite text format rebus flag
+  ACROSSLITE = %i(clues n_clues fill version puzzle_type scrambled_state
+                  extensions mark time_elapsed)
+
+  ATTRIBUTES = COMMON + ACROSSLITE
+
+  attr_accessor(*ATTRIBUTES)
+
+  # Unknown attributes raise NoMethodError rather than being silently
+  # accepted, so that typos show up immediately.
+  def initialize(**args)
+    @across_clues = []
+    @down_clues = []
+    args.each {|k, v| self[k] = v}
+  end
+
+  # Writers can rely on the clue lists being arrays
+  def across_clues=(clues)
+    @across_clues = clues || []
+  end
+
+  def down_clues=(clues)
+    @down_clues = clues || []
+  end
+
+  def [](k)
+    check_attribute(k)
+    public_send(k)
+  end
+
+  def []=(k, v)
+    check_attribute(k)
+    public_send(:"#{k}=", v)
+  end
+
+  def to_h
+    ATTRIBUTES.to_h {|a| [a, public_send(a)]}.compact
+  end
+
   # Clue numbering
   def black?(x, y)
     solution[y][x].black?
@@ -112,6 +149,7 @@ class XWord < OpenStruct
   def number(words = false)
     n, across, down = 1, [], []
     words_a, words_d = [], []
+    each_cell {|c| c.number = nil}
     (0 ... height).each do |y|
       (0 ... width).each do |x|
         if across? x, y
@@ -156,9 +194,7 @@ class XWord < OpenStruct
         case s
         when :black, :null
           opts[s]
-        when String
-          block_given? ? (yield c) : c.to_char
-        when Rebus
+        when String, Rebus
           block_given? ? (yield c) : c.to_char
         else
           raise PuzzleFormatError, "Unrecognised cell #{c}"
@@ -174,8 +210,8 @@ class XWord < OpenStruct
     each_cell do |c|
       if c.rebus?
         r = c.solution
-        if self.rebus[s]
-          sym, _ = self.rebus[s]
+        if self.rebus[r.solution]
+          sym, _ = self.rebus[r.solution]
           r.symbol = sym.to_s
         else
           k += 1
@@ -186,28 +222,18 @@ class XWord < OpenStruct
     end
   end
 
+  def check_attribute(k)
+    unless ATTRIBUTES.include?(k.to_sym)
+      raise NoMethodError, "unknown XWord attribute #{k}"
+    end
+  end
+
   def inspect_grid
     number
-    solution.map {|row|
-      row.map {|c|
-        s = c.solution
-        o = case s
-        when :black
-          "#"
-        when :null
-          "."
-        when String
-          c.to_char
-        when Rebus
-          c.to_char
-        else
-          raise PuzzleFormatError, "Unrecognised cell #{c}"
-        end
-        if c.number && c.number > 0
-          o = "#{c.number} #{o}"
-        end
-        o = o.rjust(4)
-      }.join("|")
+    to_array(:black => '#', :null => '.') {|c|
+      c.number ? "#{c.number} #{c.to_char}" : c.to_char
+    }.map {|row|
+      row.map {|o| o.rjust(4)}.join("|")
     }.join("\n")
   end
 end

data/lib/pangrid.rb

@@ -1,41 +1,63 @@
-require_relative 'deps/trollop'
+require 'optparse'
 
 require_relative 'pangrid/version'
 require_relative 'pangrid/plugin'
-require_relative 'pangrid/frontend/webrick'
+require_relative 'pangrid/clues'
 
 module Pangrid
-  def self.run_command_line
-    # command line options
-    p = Trollop::Parser.new do
-      version "pangrid #{VERSION}"
-      opt :from, "Format to convert from", :type => :string
-      opt :to, "Format to convert to", :type => :string
-      opt :in, "Input file", :type => :string
-      opt :out, "Output file", :type => :string
-      opt :list, "List available format plugins"
-      opt :web, "Launch webserver"
+  def self.option_parser(opts)
+    OptionParser.new do |p|
+      p.banner = "Usage: pangrid -f FORMAT -t FORMAT -i INPUT -o OUTPUT [-c CLUES]\n" +
+                 "       pangrid -l"
+      p.version = VERSION
+      p.separator ""
+      p.separator "Options:"
+      p.on("-f", "--from=FORMAT", "Format to convert from") {|v| opts[:from] = v}
+      p.on("-t", "--to=FORMAT", "Format to convert to") {|v| opts[:to] = v}
+      p.on("-i", "--in=FILE", "Input file") {|v| opts[:in] = v}
+      p.on("-o", "--out=FILE", "Output file") {|v| opts[:out] = v}
+      p.on("-c", "--clues=FILE", "Add clues from a text file (see README)") {|v|
+        opts[:clues] = v
+      }
+      p.on("-l", "--list", "List available format plugins") { opts[:list] = true }
+      p.on("-v", "--version", "Print version and exit") {
+        puts "pangrid #{VERSION}"
+        exit
+      }
+      p.on("-h", "--help", "Show this message") {
+        puts p
+        exit
+      }
     end
+  end
 
-    Trollop::with_standard_exception_handling p do
-      opts = p.parse ARGV
+  def self.run_command_line(argv = ARGV)
+    opts = {}
+    parser = option_parser(opts)
+    begin
+      parser.parse!(argv.dup)
+    rescue OptionParser::ParseError => e
+      $stderr.puts "Error: #{e.message}"
+      $stderr.puts "Try --help for help."
+      exit 1
+    end
 
-      if opts[:web]
-        run_webserver 1234
-      elsif opts[:list] || [:from, :to, :in, :out].all? {|k| opts[k]}
-        run opts
-      else
-        p.educate
-      end
+    if opts[:list] || [:from, :to, :in, :out].all? {|k| opts[k]}
+      exit 1 unless run opts
+    else
+      $stderr.puts parser
+      exit 1
     end
   end
 
+  # Returns true on success. Errors are reported on stderr.
+
   def self.run(opts)
     Plugin.load_all
 
     if opts[:list]
       Plugin.list_all
-      return
+      return true
     end
 
     # run the converter
@@ -45,25 +67,50 @@ module Pangrid
 
     if !from or !from.method_defined? :read
       $stderr.puts "No reader for #{opts[:from]}"
-      return
+      return false
     end
 
     if !to or !to.method_defined? :write
       $stderr.puts "No writer for #{opts[:to]}"
-      return
+      return false
     end
 
-    if !File.exist? opts[:in]
-      $stderr.puts "Cannot find file #{opts[:in]}"
-      return
+    [opts[:in], opts[:clues]].compact.each do |f|
+      if !File.exist? f
+        $stderr.puts "Cannot find file #{f}"
+        return false
+      end
     end
 
     reader = from.new
     writer = to.new
-    input = IO.read(opts[:in])
-    output = writer.write(reader.read(input))
-    File.open(opts[:out], "w") do |f|
-      f.print output
+    # Read and write in binary mode so that binary formats (.puz, .png,
+    # .xlsx) aren't mangled by newline translation on Windows. Text readers
+    # expect UTF-8; the binary reader reinterprets the bytes itself.
+    input = File.binread(opts[:in]).force_encoding(Encoding::UTF_8)
+    begin
+      xw = reader.read(input)
+    rescue PuzzleFormatError => e
+      $stderr.puts "Could not convert #{opts[:in]}: #{e.message}"
+      return false
+    end
+
+    if opts[:clues]
+      begin
+        ClueList.read(File.read(opts[:clues], encoding: "UTF-8")).apply(xw)
+      rescue PuzzleFormatError => e
+        $stderr.puts "Could not add clues from #{opts[:clues]}: #{e.message}"
+        return false
+      end
+    end
+
+    begin
+      output = writer.write(xw)
+    rescue PuzzleFormatError => e
+      $stderr.puts "Could not convert #{opts[:in]}: #{e.message}"
+      return false
     end
+    File.binwrite(opts[:out], output)
+    true
   end
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: pangrid
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Martin DeMello
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2026-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: webrick
+  name: chunky_png
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description:
 email: martindemello@gmail.com
 executables:
@@ -35,10 +49,8 @@ files:
 - LICENSE
 - README
 - bin/pangrid
-- lib/deps/trollop.rb
 - lib/pangrid.rb
-- lib/pangrid/data/webform.html
-- lib/pangrid/frontend/webrick.rb
+- lib/pangrid/clues.rb
 - lib/pangrid/plugin.rb
 - lib/pangrid/plugins/acrosslite.rb
 - lib/pangrid/plugins/csv.rb