squib 0.16.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d121338a0d8d7967443268aaf0e85f9bfcdfa64da4b3f78beafd13c5b6d31de
-  data.tar.gz: e7f94c3685bcad4537eb19065e31d2d277561562baf71485e3ce2ab041d316a7
+  metadata.gz: 8e5921a89334684b7770be1b6d85ef150fd02f5c1b305ae795c0b349ac3e8a6d
+  data.tar.gz: bd29c5c8b101957a1ade535d14a128137185c002195d832d349e51c0aff9fcf4
 SHA512:
-  metadata.gz: '06290d3f269f0b19349c9c66306682b9323f21da674d8e37515bb97b98b7cd51ef9d95cfcf591d8fcf6192449d6b5aa39fa7efc11aaed9078e626747b8a06121'
-  data.tar.gz: 86ffe77a0a120e18c0287a725e2ba4ef0e5dceb79359784e6ab0965559473e7c8533dd1dc9b99eb7d0e2d7d280d5c9b1ec3f8229b022ecc6dab18942f94f6544
+  metadata.gz: 021b8f98bab301f65e300523447fb4fc172cc12df0d7436da200e716e6dfd87d843b11ac3e07bd8496319eaa62803c59ad1a5ed88d9dc830e8858f99c4288366
+  data.tar.gz: 8c3d7a1b44ac551ce24716ab6da853e1bfcacac55c5ce8ba13a847990c863860cb5bc186832812d8b14aacc774ee96bf3d41057cd65ee966cbad1dda130681e7

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,39 @@
+---
+name: Bug report
+about: Report something that seems wrong
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. My code looks like this...
+2. When I run it like this...
+3. I see this error...
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+We love screenshots!
+  * Windows: `Print Screen` key and then `ctrl+v` directly into GitHub issues here.
+  * Shift + Command + 3, then `command+v` directly into GitHub issues here.
+
+**Environment**
+ - OS: (e.g. Windows 11)
+ - Ruby version (e.g. 2.7, 3.0)
+
+**Additional context**
+Add any other context about the problem here.
+
+**Check the following:**
+
+- [ ] I have updated Squib to the latest version.
+- [ ] I have checked the Squib issues backlog for something similar
+- [ ] I have attempted to make a minimal script demonstrating my problem
+- [ ] I have reviewed the [Squib Docs](https://squib.readthedocs.io/) and there's still a problem

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen. Make an example of what you want the syntax to look like.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
+
+ - [ ] I might be interested in implementing this myself

data/.github/ISSUE_TEMPLATE/help-wanted.md

@@ -0,0 +1,13 @@
+---
+name: Help Wanted - USE GITHUB DISCUSSIONS INSTEAD
+about: Need help doing something in Squib? We prefer you use the (new!) Discussions tab
+title: Help Wanted - USE GITHUB DISCUSSIONS INSTEAD
+labels: help wanted
+assignees: andymeneely
+---
+
+Need help doing something in Squib? We prefer you use the (new!) Discussions tab
+
+We prefer that GitHub issues be used for features or bugs.
+
+

data/.github/ISSUE_TEMPLATE/release-todo.md

@@ -0,0 +1,34 @@
+---
+name: Release TODO list
+about: Use this checklist when we release
+title: Release v0.XYZ
+labels: release
+assignees: andymeneely
+---
+
+Be sure to remember to do the following for releases.
+
+ - [ ] CHANGELOG is written for all new changes
+ - [ ] README is updated
+ - [ ] Samples are updated
+ - [ ] Are all the dependencies up to date?
+ - [ ] Check `sample_regression_spec.rb` regression tests are all enabled (i.e. `overwrite_sample` is commented out)
+ - [ ] Bump version.rb
+ - [ ] Bump docs/conf.py versions
+ - [ ] Do a full rake locally
+ - [ ] `rake sanity`, and check visually
+ - [ ] GitHub Actions is passing on dev branch
+ - [ ] Merge master branch
+ - [ ] Merge release branch
+ - [ ] Push master and release branches
+ - [ ] Create GitHub release tag
+ - [ ] `gem push pkg/squib-x.y.z.gem`
+ - [ ] Github milestone closed
+ - [ ] Activate version on squib.readthedocs.org (Versions)
+ - [ ] Set default version on squib.readthedocs.org (Advanced Settings)
+ - [ ] Bump version.rb to the next alpha
+ - [ ] Publish on BoardGameGeek thread
+ - [ ] Check Docker build on Dockerhub: https://hub.docker.com/repository/docker/andymeneely/squib
+ - [ ] Check Docker docker pull: docker pull andymeneely/squib:latest
+ - [ ] Check Docker build locally in samples: docker run --rm -v "%cd%":/usr/src/app andymeneely/squib:latest ruby basic
+ - [ ] Anything else to add to this checklist?

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+### Motivation
+
+*Replace this line with why you are making this change.*
+
+### Have you...
+
+  - [ ] Written a sample in `_samples`?
+  - [ ] Updated documentation in the `docs/` folder?
+  - [ ] Linked this PR to an issue?
+  - [ ] Written any automated tests?
+  - [ ] Refactored your code to be maintainable?
+
+The above things are not required, but appreciated.

data/.github/workflows/tests.yml

@@ -1,6 +1,6 @@
 name: Squib Unit Tests
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   test:
@@ -8,9 +8,9 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu, macos]
-        ruby: [2.5, 2.6, 2.7, head]
+        ruby: [2.7, 3.0, head]
     runs-on: ${{ matrix.os }}-latest
-    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || (matrix.ruby == '3.0' && matrix.os == 'macos')}}
     steps:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1

data/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "restructuredtext.confPath": "${workspaceFolder}\\docs",
+  "restructuredtext.linter.disabled": true
+}

data/CHANGELOG.md

@@ -1,6 +1,44 @@
 # Squib CHANGELOG
 Squib follows [semantic versioning](http://semver.org).
 
+## v0.18.0 / Unreleased
+
+Features:
+* Placeholders! Missing images to `svg` and `png` can be replaced by a `placeholder` (#339)
+* New config option: `img_missing`. When an image is missing, warn or error to the console (#339)
+* `save_sheet` learned how to `rotate` individual images! (#301)
+
+Compatibility:
+* Because of the features above, the new default behavior is to warn instead of errors on a missing file
+* Ruby 2.7 is officially our minimum Ruby, since Ruby 2.6 will EOL in about six months from now
+
+## v0.17.1 / 2021-09-07
+
+Bugs:
+* Fix frozen string error on `Squib.xlsx` import when stripping newlines is enabled
+* `save_sheet` works with `rtl` and `trim` altogether properly now.
+
+Chores:
+* Added autoloading for various slow-loading libraries, speeding up initial `require`
+
+## v0.17.1 / 2021-08-11
+
+Bugs:
+* Sprues now allow negative coordinates (#336)
+* Documentation typos (#337)
+
+## v0.17.0 / 2021-07-23
+Features:
+* Drop shadows! The `save_png` method now supports a bunch of `shadow_` arguments that will add a drop shadow just before rendering. This is intended for using in rulebooks or marketing. Try it out by adding `shadow_radius: 8` to your save_png (#306, #264)
+* Added debug methods for checking font access. `Squib.system_fonts` and `Squib.print_system_fonts` (#334)
+
+Bugs:
+* The `rows` argument is always respected in `save_sheet` (#332).
+
+Chores:
+* Bump cairo to ~1.17
+* Bump classy_hash to 1.0
+
 ## v0.16.0 / 2020-11-24
 
 Features:

data/README.md

@@ -31,7 +31,7 @@ Wanna see more? Check out the website: http://andymeneely.github.io/squib/
 
 ## Installation
 
-Squib requires Ruby 2.5 or later.
+Squib requires Ruby 2.7 or later.
 
 Install it yourself with:
 

data/bin/squib

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 require 'squib'
+require 'squib/commands/cli'
 
 Squib::CLI.new.run

data/lib/squib/args/arg_loader.rb

@@ -126,4 +126,13 @@ module Squib::Args::ArgLoader
     self
   end
 
+  # Return the deck's configuration
+  # This keeps the @deck local to this mixin instead of forcing args classes
+  # to "know" that @deck works.
+  #
+  # It also makes unit testing easier. Sue me.
+  def deck_conf
+    @deck.conf
+  end
+
 end

data/lib/squib/args/drop_shadow.rb

@@ -0,0 +1,39 @@
+require_relative 'color_validator'
+
+module Squib::Args
+  module_function def extract_drop_shadow(opts, deck)
+    DropShadow.new(deck.custom_colors).extract! opts, deck
+  end
+
+  class DropShadow
+    include ArgLoader
+    include ColorValidator
+
+    def initialize(custom_colors)
+      @custom_colors = custom_colors
+    end
+
+    def self.parameters
+      {
+        shadow_color: :black,
+        shadow_offset_x: 3,
+        shadow_offset_y: 3,
+        shadow_radius: nil,
+        shadow_trim: 0,
+      }
+    end
+
+    def self.expanding_parameters
+      self.parameters.keys # all of them
+    end
+
+    def self.params_with_units
+      [:shadow_offset_x, :shadow_offset_y, :shadow_radius, :shadow_trim]
+    end
+
+    def validate_shadow_color(arg, _i)
+      colorify(arg, @custom_colors)
+    end
+
+  end
+end

data/lib/squib/args/input_file.rb

@@ -13,7 +13,10 @@ module Squib::Args
     end
 
     def self.parameters
-      { file: nil }
+      {
+        file: nil,
+        placeholder: nil
+      }
     end
 
     def self.expanding_parameters
@@ -24,10 +27,29 @@ module Squib::Args
       [] # none of them
     end
 
-    def validate_file(arg, _i)
+    def validate_file(arg, i)
       return nil if arg.nil?
-      raise "File #{File.expand_path(arg)} does not exist!" unless File.exists?(arg)
-      File.expand_path(arg)
+      return File.expand_path(arg) if File.exists?(arg)
+      return File.expand_path(placeholder[i]) if File.exists?(placeholder[i].to_s)
+
+      case deck_conf.img_missing.to_sym
+      when :error
+        raise "File #{File.expand_path(arg)} does not exist!"
+      when :warn
+        Squib.logger.warn "File #{File.expand_path(arg)} does not exist!"
+      end
+      return nil # the silent option - as if nil in the first place
+    end
+
+    def validate_placeholder(arg, _i)
+      # What if they specify placeholder, but it doesn't exist?
+      # ...always warn... that's probably a mistake they made
+      unless arg.nil? || File.exists?(arg)
+        msg = "Image placeholder #{File.expand_path(arg)} does not exist!"
+        Squib.logger.warn msg
+        return nil
+      end
+      return arg
     end
   end
 end

data/lib/squib/args/sheet.rb

@@ -82,14 +82,9 @@ module Squib::Args
 
     def validate_rows(arg)
       raise 'columns must be an integer' unless columns.respond_to? :to_i
-      count = if range == :all
-                @deck.size
-              else
-                count = range.to_a.length
-              end
-      return 1 if count <= columns
-      return arg if arg.respond_to? :to_i
-      (count.to_f / columns.to_f).ceil
+      count = (range == :all) ? @deck.size : count = range.to_a.length
+      return arg.to_i if arg.respond_to? :to_i
+      (count.to_f / columns.to_f).ceil # e.g. :infinite
     end
 
     def full_filename(i=nil)

data/lib/squib/conf.rb

@@ -23,6 +23,7 @@ module Squib
       'dir'           => '_output',
       'hint'          => :none,
       'img_dir'       => '.',
+      'img_missing'   => :warn,
       'progress_bars' => false,
       'prefix'        => 'card_',
       'ldquote'       => "\u201C", # UTF8 chars
@@ -74,6 +75,10 @@ module Squib
       @config_hash['img_dir']
     end
 
+    def img_missing
+      @config_hash['img_missing'].to_sym
+    end
+
     def text_hint
       @config_hash['text_hint']
     end

data/lib/squib/dsl/png.rb

@@ -31,6 +31,7 @@ module Squib
           crop_corner_radius crop_corner_x_radius crop_corner_y_radius
           flip_horizontal flip_vertical
           range layout
+          placeholder
          )
       end
 

data/lib/squib/dsl/save_png.rb

@@ -1,5 +1,7 @@
 require_relative '../errors_warnings/warn_unexpected_params'
-
+require_relative '../args/card_range'
+require_relative '../args/save_batch'
+require_relative '../args/drop_shadow'
 
 module Squib
   class Deck
@@ -24,6 +26,7 @@ module Squib
           range
           dir prefix suffix count_format
           rotate trim trim_radius
+          shadow_offset_x shadow_offset_y shadow_radius shadow_color shadow_trim
          )
       end
 
@@ -31,9 +34,10 @@ module Squib
         warn_if_unexpected opts
         range = Args.extract_range opts, deck
         batch = Args.extract_save_batch opts, deck
+        shadow = Args.extract_drop_shadow opts, deck
         @bar.start("Saving PNGs to #{batch.summary}", deck.size) do |bar|
           range.map do |i|
-            deck.cards[i].save_png(batch[i])
+            deck.cards[i].save_png(batch[i], shadow[i])
             bar.increment
           end
         end

data/lib/squib/dsl/save_sheet.rb

@@ -30,7 +30,7 @@ module Squib
           range sprue
           columns rows rtl
           dir prefix count_format suffix
-          margin gap trim trim_radius
+          margin gap trim trim_radius rotate
          )
       end
 

data/lib/squib/dsl/svg.rb

@@ -33,6 +33,7 @@ module Squib
           flip_horizontal flip_vertical angle
           id force_id data
           range layout
+          placeholder
          )
       end
 

data/lib/squib/dsl/text_embed.rb

@@ -23,6 +23,7 @@ module Squib
         id force_id data
         flip_horizontal flip_vertical
         alpha angle blend mask
+        placeholder
       )
     end
 

data/lib/squib/graphics/cairo_context_wrapper.rb

@@ -20,12 +20,14 @@ module Squib
 
       def_delegators :cairo_cxt, :save, :set_source_color, :paint, :restore,
         :translate, :rotate, :move_to, :update_pango_layout, :width, :height,
-        :show_pango_layout, :rectangle, :rounded_rectangle, :set_line_width, :stroke, :fill,
-        :set_source, :scale, :render_rsvg_handle, :circle, :triangle, :line_to,
-        :operator=, :show_page, :clip, :transform, :mask, :create_pango_layout,
-        :antialias=, :curve_to, :matrix, :matrix=, :identity_matrix, :pango_layout_path,
-        :stroke_preserve, :target, :new_path, :new_sub_path, :reset_clip, :fill_preserve, :close_path,
-        :set_line_join, :set_line_cap, :set_dash, :arc, :arc_negative
+        :show_pango_layout, :rectangle, :rounded_rectangle, :set_line_width,
+        :stroke, :fill, :set_source, :scale, :render_rsvg_handle, :circle,
+        :triangle, :line_to, :operator=, :show_page, :clip, :transform, :mask,
+        :create_pango_layout, :antialias=, :curve_to, :matrix, :matrix=,
+        :identity_matrix, :pango_layout_path, :stroke_preserve, :target,
+        :new_path, :new_sub_path, :reset_clip, :fill_preserve, :close_path,
+        :set_line_join, :set_line_cap, :set_dash, :arc, :arc_negative,
+        :pseudo_blur
 
       # :nodoc:
       # @api private

data/lib/squib/graphics/save_doc.rb

@@ -4,13 +4,13 @@ module Squib
     # :nodoc:
     # @api private
     def render_sheet(range, batch, sheet)
-      sheet_width = (sheet.columns * (@width + 2 * sheet.gap - 2 * sheet.trim)) + (2 * sheet.margin)
-      sheet_height = (sheet.rows * (@height + 2 * sheet.gap - 2 * sheet.trim)) + (2 * sheet.margin)
+      rotate = batch.rotate.any? true # either rotate all or none
+      w,h,sheet_width,sheet_height = compute_dimensions(sheet, rotate)
       cc = Cairo::Context.new(Cairo::ImageSurface.new(sheet_width, sheet_height))
       num_this_sheet = 0
       sheet_num = 0
       y = sheet.margin
-      x = sheet.rtl ? (sheet_width - sheet.margin - sheet.gap - @width) : sheet.margin
+      x = sheet.rtl ? rtl_start_x(sheet_width, sheet, w) : sheet.margin
       @progress_bar.start("Saving PNG sheet to #{batch.summary}", @cards.size + 1) do |bar|
         range.each do |i|
           if num_this_sheet >= (sheet.columns * sheet.rows) # new sheet
@@ -20,17 +20,19 @@ module Squib
             num_this_sheet = 0
             sheet_num += 1
             y = sheet.margin
-            x = sheet.rtl ? (sheet_width - sheet.margin - sheet.gap - @width) : sheet.margin
+            x = sheet.rtl ? rtl_start_x(sheet_width, sheet, w) : sheet.margin
             cc = Cairo::Context.new(Cairo::ImageSurface.new(sheet_width, sheet_height))
           end
-          surface = trim(@cards[i].cairo_surface, sheet.trim, @width, @height)
+          surface = preprocess(@cards[i].cairo_surface,
+                                sheet.trim, w, h,
+                                rotate, batch.angle[i])
           cc.set_source(surface, x, y)
           cc.paint
           num_this_sheet += 1
-          x += (surface.width + sheet.gap) * (sheet.rtl ? -1 : 1)
+          x += (w + sheet.gap) * (sheet.rtl ? -1 : 1)
           if num_this_sheet % sheet.columns == 0 # new row
-            x = sheet.rtl ? (sheet_width - sheet.margin - sheet.gap - @width) : sheet.margin
-            y += surface.height + sheet.gap
+            x = sheet.rtl ? rtl_start_x(sheet_width, sheet, w) : sheet.margin
+            y += h + sheet.gap
           end
           bar.increment
         end
@@ -38,18 +40,32 @@ module Squib
       end
     end
 
-    # Return a new Cairo::ImageSurface that is trimmed from the original
-    #
-    # @param surface The surface to trim
-    # @param trim The number of pixels around the edge to trim
-    # @param width The width of the surface prior to the trim
-    # @param height The height of the surface prior to the trim
+    def compute_dimensions(sheet, rotate)
+      w,h = rotate ? [@height,@width] : [@width,@height]
+      w -= 2 * sheet.trim
+      h -= 2 * sheet.trim
+      sheet_width = (sheet.columns * (w + 2 * sheet.gap)) + (2 * sheet.margin)
+      sheet_height = (sheet.rows * (h + 2 * sheet.gap)) + (2 * sheet.margin)
+      return [w, h, sheet_width, sheet_height]
+    end
+
+    def rtl_start_x(sheet_width, sheet, w)
+      return sheet_width - sheet.margin - sheet.gap - w
+    end
+
+    # Return a new Cairo::ImageSurface that is trimmed and rotated
+    # from the original
     # :nodoc:
     # @api private
-    def trim(surface, trim, width, height)
-      if trim > 0
-        tmp = Cairo::ImageSurface.new(width - 2 * trim, height - 2 * trim)
+    def preprocess(surface, trim, w, h, rotate, angle)
+      if trim > 0 || rotate
+        tmp = Cairo::ImageSurface.new(w, h)
         cc = Cairo::Context.new(tmp)
+        if rotate
+          cc.translate w * 0.5, h * 0.5
+          cc.rotate angle
+          cc.translate h * -0.5, w * -0.5
+        end
         cc.set_source(surface, -1 * trim, -1 * trim)
         cc.paint
         surface = tmp

data/lib/squib/graphics/save_images.rb

@@ -1,12 +1,14 @@
+require_relative 'cairo_context_wrapper'
+
 module Squib
   class Card
 
     # :nodoc:
     # @api private
-    def save_png(batch)
-      surface = if preprocess_save?(batch)
+    def save_png(batch, shadow)
+      surface = if preprocess_save?(batch, shadow)
                   w, h = compute_dimensions(batch.rotate, batch.trim)
-                  preprocessed_save(w, h, batch)
+                  preprocessed_save(w, h, batch, shadow)
                 else
                   @cairo_surface
                 end
@@ -15,8 +17,8 @@ module Squib
 
     # :nodoc:
     # @api private
-    def preprocess_save?(batch)
-      batch.rotate != false || batch.trim > 0
+    def preprocess_save?(batch, shadow)
+      batch.rotate != false || batch.trim > 0 || !(shadow.shadow_radius.nil?)
     end
 
     def compute_dimensions(rotate, trim)
@@ -27,25 +29,62 @@ module Squib
       end
     end
 
-    def preprocessed_save(width, height, batch)
-      new_cc = Cairo::Context.new(Cairo::ImageSurface.new(width, height))
+    def preprocessed_save(w, h, batch, shadow)
+      new_cc = Cairo::Context.new(Cairo::ImageSurface.new(w, h))
       trim_radius = batch.trim_radius
       if batch.rotate != false
-        new_cc.translate(width * 0.5, height * 0.5)
-        new_cc.rotate(batch.angle)
-        new_cc.translate(height * -0.5, width * -0.5)
-        new_cc.rounded_rectangle(0, 0, height, width, trim_radius, trim_radius)
+        new_cc.translate w * 0.5, h * 0.5
+        new_cc.rotate batch.angle
+        new_cc.translate h * -0.5, w * -0.5
+        new_cc.rounded_rectangle(0, 0, h, w, trim_radius, trim_radius)
       else
-        new_cc.rounded_rectangle(0, 0, width, height, trim_radius, trim_radius)
+        new_cc.rounded_rectangle(0, 0, w, h, trim_radius, trim_radius)
       end
       new_cc.clip
       new_cc.set_source(@cairo_surface, -batch.trim, -batch.trim)
       new_cc.paint
+      new_cc.reset_clip
+      new_cc = drop_shadow(new_cc, shadow, batch) unless shadow.shadow_radius.nil?
       return new_cc.target
     end
 
+    # pseudo-blur behave weirdly with a radius of 0 - wrapping
+    def blur(cc, r, &block)
+      if r == 0
+        yield(block)
+      else
+        cc.pseudo_blur(r, &block)
+      end
+    end
+
+    def drop_shadow(cc, s, batch)
+      off_x = s.shadow_offset_x
+      off_y = s.shadow_offset_y
+      s_trim = s.shadow_trim
+      s_rad = s.shadow_radius
+      new_w = cc.target.width  + off_x + 3 * s_rad - (2 * s_trim)
+      new_h = cc.target.height + off_y + 3 * s_rad - (2 * s_trim)
+      new_cc = Squib::Graphics::CairoContextWrapper.new(
+        Cairo::Context.new(Cairo::ImageSurface.new(new_w, new_h)))
+      blur(new_cc, s_rad) do
+        # fill in with shadow color
+        new_cc.set_source_squibcolor s.shadow_color
+        new_cc.rectangle 0, 0, new_cc.target.width, new_cc.target.height
+        new_cc.fill
+        # then, paint but blend with :dest_in to get a shadow-shaped drawing
+        new_cc.set_source cc.target, s_rad + off_x, s_rad + off_y
+        new_cc.operator = :dest_in # see https://www.cairographics.org/operators/
+        new_cc.paint
+      end
+      new_cc.set_source cc.target, s_rad, s_rad
+      new_cc.operator = :over
+      new_cc.paint
+      return new_cc
+    end
+
     def write_png(surface, i, b)
-      surface.write_to_png("#{b.dir}/#{b.prefix}#{b.count_format % i}#{b.suffix}.png")
+      filename = "#{b.dir}/#{b.prefix}#{b.count_format % i}#{b.suffix}.png"
+      surface.write_to_png filename
     end
 
   end

data/lib/squib/import/xlsx_importer.rb

@@ -1,4 +1,4 @@
-require 'roo'
+autoload :Roo, 'roo'
 require_relative 'quantity_exploder'
 
 module Squib::Import
@@ -10,13 +10,13 @@ module Squib::Import
       data = Squib::DataFrame.new
       s.first_column.upto(s.last_column) do |col|
         header = s.cell(s.first_row, col).to_s
-        header.strip! if import.strip?
+        header = header.strip if import.strip?
         data[header] = []
         (s.first_row + 1).upto(s.last_row) do |row|
           cell = s.cell(row, col)
           # Roo hack for avoiding unnecessary .0's on whole integers (https://github.com/roo-rb/roo/issues/139)
           cell = s.excelx_value(row, col) if s.excelx_type(row, col) == [:numeric_or_formula, 'General']
-          cell.strip! if cell.respond_to?(:strip) && import.strip?
+          cell = cell.strip if cell.respond_to?(:strip) && import.strip?
           cell = block.yield(header, cell) unless block.nil?
           data[header] << cell
         end# row

data/lib/squib/sprues/sprue_schema.rb

@@ -1,7 +1,8 @@
 module Squib
   module Sprues
     UNIT_REGEX = /^(\d*[.])?\d+(in|cm|mm)$/
-    ROTATE_REGEX = /^(\d*[.])?\d+(deg|rad)?$/
+    COORD_REGEX = /^\-?(\d*[.])?\d+(in|cm|mm)$/
+    ROTATE_REGEX = /^\-?(\d*[.])?\d+(deg|rad)?$/
     SCHEMA = {
       'sheet_width' => UNIT_REGEX,
       'sheet_height' => UNIT_REGEX,
@@ -35,8 +36,8 @@ module Squib
         }]]
       },
       'cards' => [[{
-        'x' => UNIT_REGEX,
-        'y' => UNIT_REGEX,
+        'x' => COORD_REGEX,
+        'y' => COORD_REGEX,
         'rotate' => [
           :optional, Numeric,
           ClassyHash::G.enum(:clockwise, :counterclockwise, :turnaround),

data/lib/squib/system_fonts.rb

@@ -0,0 +1,17 @@
+require 'pango'
+module Squib
+
+  # List all system fonts that Cairo/Pango can see
+  # Wow this call was convoluted...
+  # Returns array of strings with the names of fonts
+  module_function def system_fonts
+    cc = Cairo::Context.new(Cairo::ImageSurface.new(0,0)) # empty image
+    cc.create_pango_layout.context.families.map {|f| f.name }
+  end
+
+  # Prints out the system fonts in sorted order
+  module_function def print_system_fonts
+    puts "== DEBUG: Squib knows about these fonts =="
+    puts system_fonts.sort
+  end
+end

data/lib/squib/version.rb

@@ -6,6 +6,6 @@ module Squib
   # Most of the time this is in the alpha of the next release.
   # e.g. v0.0.5a is on its way to becoming v0.0.5
   #
-  VERSION = '0.16.0'
+  VERSION = '0.18.0'
 end
 

data/lib/squib.rb

@@ -1,12 +1,13 @@
+autoload :Cairo, 'cairo'
+autoload :Pango, 'pango'
+autoload :Rsvg,  'rsvg2'
 require 'logger'
-require 'cairo'
-require 'pango'
-require 'rsvg2'
 require 'rainbow/refinement'
 require_relative 'squib/version'
 require_relative 'squib/commands/cli'
 require_relative 'squib/deck'
 require_relative 'squib/card'
+require_relative 'squib/system_fonts'
 
 module Squib
   using Rainbow # we can colorize strings now!

data/samples/images/_placeholders.rb

@@ -0,0 +1,49 @@
+# require 'squib'
+require_relative '../../lib/squib'
+
+# By default Squib will simply warn you if an image is missing
+# Instead, you can give it a `placeholder`
+Squib.configure img_missing: :silent  # no warnings, no errors, no placeholder
+# Squib.configure img_missing: :warn  # default
+# Squib.configure img_missing: :error # pre Squib v0.18 behavior... blech
+
+Squib::Deck.new(width: 100, height: 100, cards: 3) do
+  background color: :white
+
+  files = %w(angler-fish.png does-not-exist.png) # last one is nil
+  png file: files, placeholder: 'grit.png'
+  save_sheet columns: 1, prefix: 'placeholder_sheet_'
+end
+
+# Placeholders can be per-image too.
+# What if a placeholder is specified but doesn't exist? It'll always warn.
+Squib.configure img_missing: :warn # default
+Squib::Deck.new(width: 100, height: 100, cards: 4) do
+  background color: :white
+
+  files =        %w(angler-fish.png does-not-exist.png does-not-exist.png does-not-exist.png)
+  placeholders = %w(grit.png        does-not-exist.png grit.png                             )
+  png file: files, placeholder: placeholders
+
+  # text embeds can have placeholders too
+  text(str: 'A', color: :red) do |embed|
+    embed.png key: 'A', file: files, placeholder: placeholders, width: 30, height: 30
+  end
+
+  save_sheet columns: 1, prefix: 'multi_placeholder_sheet_'
+end
+
+# Do errors work?
+# If you REALLY want the old, pre-Squib v0.18 functionality
+# ...you can still have it
+# This is really more of a regression test than example.
+Squib.configure img_missing: :error
+Squib::Deck.new(width: 100, height: 100, cards: 1) do
+  begin
+    png file: 'does-not-exist.png' # no placeholder... should error!
+    raise Exception.new 'Runtime Error should have been thrown!'
+  rescue RuntimeError => e
+    # a runtime error should have happened here. So nothing happens. Good.
+    Squib.logger.error 'Yay! An error we expected was thrown.'
+  end
+end

data/samples/saves/_saves.rb

@@ -1,7 +1,7 @@
-require 'squib'
+# require 'squib'
+require_relative '../../lib/squib'
 
 # This sample demonstrates how to use the various save methods
-
 Squib::Deck.new(width: 825, height: 1125, cards: 16) do
   background color: :gray
   rect x: 38, y: 38, width: 750, height: 1050,
@@ -50,3 +50,26 @@ Squib::Deck.new(width: 825, height: 1125, cards: 16) do
              columns: 2, rows: 1,
              margin: 75, gap: 5, trim: 37
 end
+
+Squib::Deck.new(width: 100, height: 100, cards: 3) do
+  background color: :grey
+  text str: 'Hi', font: 'Arial 18'
+
+  # Test bug 332.
+  # When we only have 3 cards but want a 2x4 grid with lots of empty spaces.
+  # Buggy behavior was to revert to 1 row and not respect the rows arg.
+  save_sheet prefix: 'save_sheet_bug332_', rows: 2, columns: 4
+end
+
+# Allow rotating
+Squib::Deck.new(width: 100, height: 50, cards: 8) do
+  background color: :white
+  rect x: 10, y: 10, width: 80, height: 30
+  rect x: 5, y: 5, width: 90, height: 40, stroke_width: 5, stroke_color: :blue
+  text y: 2, str: 0..7, font: 'Open Sans Bold 8', align: :center, width: 100
+  save_sheet prefix: 'save_sheet_unrotated_', rows: 2, columns: 3
+  save_sheet prefix: 'save_sheet_custom_rotate_', rows: 2, columns: 3, rotate: [:clockwise, :counterclockwise] * 4
+  save_sheet prefix: 'save_sheet_rotated_', rows: 2, columns: 3, rotate: true
+  save_sheet prefix: 'save_sheet_rotated_trimmed_', rows: 2, columns: 3, rotate: true, trim: 5
+  save_sheet prefix: 'save_sheet_rotated_trimmed_rtl_', rows: 2, columns: 3, rotate: true, trim: 5, rtl: true
+end

data/samples/shadows/_shadow.rb

@@ -0,0 +1,72 @@
+require 'squib'
+# The save_png method supports drop shadows on the final save
+# This is useful for when you want to generate images for your rulebook
+
+Squib::Deck.new(width: 100, height: 150) do
+  background color: '#abc'
+  svg file: '../spanner.svg',
+      x: 'middle - 25', y: 'middle - 25',
+      width: 50, height: 50
+
+  # Shadows off by default, i.e. shadow_radius is nil
+  # So our final dimensions are 100 - 2*15 and 150-2*15
+  save_png prefix: 'no_shadow_', trim: 15, trim_radius: 15
+
+  # Here's a nice-looking drop shadow
+  # Defaults are designed to be generally good, so I recommend just
+  # trying out a shadow_radius of 3 to 10 and see how it looks first
+  save_png prefix: 'with_shadow_', trim: 15, trim_radius: 15,
+           shadow_radius: 8,
+           shadow_offset_x: 3, shadow_offset_y: 3,  # about r / 2.5 looks good
+           shadow_trim: 2.5, # about r/ 3 looks good
+           shadow_color: '#101010aa' #tip: start the shadow color kinda transparent
+
+  # Don't want a blur? Use a radius of 0
+  save_png prefix: 'no_blur_', trim: 15, trim_radius: 15,
+           shadow_radius: 0
+
+  # Ok this next stop is crazytown, but it does give you ultimate control
+  # Remember that all Squib colors can also be gradients.
+  # They can be clunky but they do work here.
+  #   - x,y's are centered in the card itself
+  #   - stops go from fully empty to fully black
+  #   - we need to still turn on radius to get the effect
+  #   - but, this makes the upper-left corner not have a glowing effect and
+  #     have a harder edge, which (to my eye at least) feels more realistic
+  #     since the card would obscure the upper-left shadow at that angle
+  #   - this also allows you have a larger, softer blur without making it look
+  #     like it's glowing
+  #
+  # Oh just because it's easier to write we can use a ruby heredoc
+  save_png prefix: 'gradient_blur_', trim: 15, trim_radius: 15,
+           shadow_radius: 10,
+           shadow_color: <<~EOS
+              (25,25)
+              (175,175)
+              #0000@0.0
+              #000f@1.0
+           EOS
+
+  # This one looks weird I know but it's for regression testing
+  save_png prefix: 'with_shadow_test_',
+           trim: 15, trim_radius: 15, rotate: :clockwise,
+           shadow_offset_x: 5, shadow_offset_y: 25, shadow_radius: 10,
+           shadow_trim: 10,
+           shadow_color: '#123'
+end
+
+Squib::Deck.new(width:50, height: 50) do
+
+  # What if we had a transparent card but just some shapes?
+  # Like chits or something
+
+  # background defaults to fully transparent here
+
+  png file: 'doodle.png'
+
+  save_png prefix: 'transparent_bg_shadow_',
+           shadow_radius: 2,
+           shadow_offset_x: 2, shadow_offset_y: 2,
+           shadow_color: :black
+
+end

data/samples/sprues/_negative_coords.rb

@@ -0,0 +1,7 @@
+require_relative '../../lib/squib'
+
+Squib::Deck.new(width: 100, height: 100, cards: 3) do 
+  background color: :grey
+  text str: 'Hello', font: 'Sans Bold 10'
+  save_sheet sprue: 'my_sprues/negatives.yml', prefix: 'sprue_negatives_'
+end

data/samples/system_font_debug/_list_fonts.rb

@@ -0,0 +1,14 @@
+# require 'squib'
+require_relative '../../lib/squib'
+
+# Per issue #334, sometimes Pango doesn't find the font file you want
+# Pango requires fonts to be installed on the system, but sometimes the
+# font name is not obvious. e.g. "Foo Regular" might be actually named "Foo"
+# Use these methods to debug this problem
+
+# Usually you would just run this method to see what fonts are installed
+# This is commented out to make our test cases
+# Squib.print_system_fonts
+
+Squib.system_fonts.include? 'Open Sans' # checks if we have Open Sans installed
+# Note: does nothing since it's just a check

data/samples/units/_cells.rb

@@ -19,7 +19,7 @@ Squib::Deck.new(width: '1.5in', height: '1.5in') do
   # Technically, the "cell" is actually a "unit", so you can even combine
   # with xywh shorhands!!
   rect fill_color: :red,
-       x: 'middle + 0.5c', y: 'height - 1.5c',
+       x: 'middle + 0.5c', y: 'deck - 1.5c',
        width: '1c', height: '1c'
 
   # And, unlike xywh shorthands, this applies basically everywhere we support

data/squib.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.specification_version = 2 if spec.respond_to? :specification_version=
   spec.required_rubygems_version = Gem::Requirement.new('>= 0') if spec.respond_to? :required_rubygems_version=
   spec.rubygems_version = '2.2.2'
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.name          = 'squib'
   spec.version       = Squib::VERSION
@@ -31,18 +31,18 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(spec|samples|docs|benchmarks)\//)
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'cairo',                 '~> 1.16'
-  spec.add_runtime_dependency 'classy_hash',           '0.2.1'
+  spec.add_runtime_dependency 'cairo',                 '~> 1.17'
+  spec.add_runtime_dependency 'classy_hash',           '1.0.0'
   spec.add_runtime_dependency 'gio2',                  '~> 3.4'
   spec.add_runtime_dependency 'gobject-introspection', '~> 3.4'
   spec.add_runtime_dependency 'highline',              '2.0.3'
   spec.add_runtime_dependency 'mercenary',             '0.4.0'
-  spec.add_runtime_dependency 'nokogiri',              '~> 1.10'
+  spec.add_runtime_dependency 'nokogiri',              '~> 1.11'
   spec.add_runtime_dependency 'pango',                 '~> 3.4'
   spec.add_runtime_dependency 'rainbow',               '~> 3.0'
   spec.add_runtime_dependency 'roo',                   '~> 2.8'
   spec.add_runtime_dependency 'rsvg2',                 '~> 3.4'
-  spec.add_runtime_dependency 'ruby-progressbar',      '~> 1.10'
+  spec.add_runtime_dependency 'ruby-progressbar',      '~> 1.11'
 
   spec.add_development_dependency 'activesupport'
   spec.add_development_dependency 'bundler'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: squib
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Andy Meneely
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cairo
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: classy_hash
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: gio2
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: pango
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -341,6 +341,7 @@ extra_rdoc_files:
 - samples/images/_cairo_access.rb
 - samples/images/_images.rb
 - samples/images/_more_load_images.rb
+- samples/images/_placeholders.rb
 - samples/intro/01_hello.rb
 - samples/intro/02_options.rb
 - samples/intro/03_layout.rb
@@ -354,10 +355,11 @@ extra_rdoc_files:
 - samples/ranges/_ranges.rb
 - samples/saves/_hand.rb
 - samples/saves/_portrait_landscape.rb
-- samples/saves/_saves.rb
 - samples/saves/_save_filenames.rb
 - samples/saves/_save_pdf.rb
+- samples/saves/_saves.rb
 - samples/saves/_showcase.rb
+- samples/shadows/_shadow.rb
 - samples/shapes/_draw_shapes.rb
 - samples/shapes/_proofs.rb
 - samples/sprues/_advanced_sprues.rb
@@ -365,17 +367,25 @@ extra_rdoc_files:
 - samples/sprues/_fold_sheet.rb
 - samples/sprues/_hex_tiles.rb
 - samples/sprues/_mints.rb
+- samples/sprues/_negative_coords.rb
 - samples/sprues/_sprue_example.rb
-- samples/text/bug134.rb
+- samples/system_font_debug/_list_fonts.rb
 - samples/text/_embed_text.rb
 - samples/text/_text.rb
 - samples/text/_text_options.rb
+- samples/text/bug134.rb
 - samples/units/_cells.rb
 - samples/units/_shorthands.rb
 - samples/units/_units.rb
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/ISSUE_TEMPLATE/help-wanted.md"
+- ".github/ISSUE_TEMPLATE/release-todo.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/tests.yml"
 - ".gitignore"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Dockerfile
@@ -383,7 +393,6 @@ files:
 - Guardfile
 - LICENSE.txt
 - README.md
-- RELEASE TODO.md
 - Rakefile
 - bin/squib
 - lib/squib.rb
@@ -396,6 +405,7 @@ files:
 - lib/squib/args/csv_opts.rb
 - lib/squib/args/dir_validator.rb
 - lib/squib/args/draw.rb
+- lib/squib/args/drop_shadow.rb
 - lib/squib/args/embed_adjust.rb
 - lib/squib/args/embed_key.rb
 - lib/squib/args/hand_special.rb
@@ -517,6 +527,7 @@ files:
 - lib/squib/sprues/invalid_sprue_definition.rb
 - lib/squib/sprues/sprue.rb
 - lib/squib/sprues/sprue_schema.rb
+- lib/squib/system_fonts.rb
 - lib/squib/version.rb
 - samples/autoscale_font/_autoscale_font.rb
 - samples/backend/_backend.rb
@@ -534,6 +545,7 @@ files:
 - samples/images/_cairo_access.rb
 - samples/images/_images.rb
 - samples/images/_more_load_images.rb
+- samples/images/_placeholders.rb
 - samples/intro/01_hello.rb
 - samples/intro/02_options.rb
 - samples/intro/03_layout.rb
@@ -551,6 +563,7 @@ files:
 - samples/saves/_save_pdf.rb
 - samples/saves/_saves.rb
 - samples/saves/_showcase.rb
+- samples/shadows/_shadow.rb
 - samples/shapes/_draw_shapes.rb
 - samples/shapes/_proofs.rb
 - samples/sprues/_advanced_sprues.rb
@@ -558,7 +571,9 @@ files:
 - samples/sprues/_fold_sheet.rb
 - samples/sprues/_hex_tiles.rb
 - samples/sprues/_mints.rb
+- samples/sprues/_negative_coords.rb
 - samples/sprues/_sprue_example.rb
+- samples/system_font_debug/_list_fonts.rb
 - samples/text/_embed_text.rb
 - samples/text/_text.rb
 - samples/text/_text_options.rb
@@ -580,7 +595,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -588,7 +603,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - On Windows, you need the Ruby+DevKit. See https://rubyinstaller.org/downloads
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 2
 summary: A Ruby DSL for prototyping card games
@@ -609,6 +624,7 @@ test_files:
 - samples/images/_cairo_access.rb
 - samples/images/_images.rb
 - samples/images/_more_load_images.rb
+- samples/images/_placeholders.rb
 - samples/intro/01_hello.rb
 - samples/intro/02_options.rb
 - samples/intro/03_layout.rb
@@ -626,6 +642,7 @@ test_files:
 - samples/saves/_save_pdf.rb
 - samples/saves/_saves.rb
 - samples/saves/_showcase.rb
+- samples/shadows/_shadow.rb
 - samples/shapes/_draw_shapes.rb
 - samples/shapes/_proofs.rb
 - samples/sprues/_advanced_sprues.rb
@@ -633,7 +650,9 @@ test_files:
 - samples/sprues/_fold_sheet.rb
 - samples/sprues/_hex_tiles.rb
 - samples/sprues/_mints.rb
+- samples/sprues/_negative_coords.rb
 - samples/sprues/_sprue_example.rb
+- samples/system_font_debug/_list_fonts.rb
 - samples/text/_embed_text.rb
 - samples/text/_text.rb
 - samples/text/_text_options.rb

data/RELEASE TODO.md

@@ -1,22 +0,0 @@
-Be sure to remember to do the following for releases. (Copy into a GitHub issue)
-
- - [ ] CHANGELOG is written for all new changes
- - [ ] README is updated
- - [ ] Samples are updated
- - [ ] Are all the dependencies up to date?
- - [ ] Check `sample_regression_spec.rb` regression tests are all enabled (i.e. `overwrite_sample` is commented out)
- - [ ] Bump version.rb
- - [ ] Bump docs/conf.py versions
- - [ ] Do a full rake locally
- - [ ] `rake sanity`, and check visually
- - [ ] Travis is passing on dev branch
- - [ ] Merge master branch
- - [ ] Merge release branch
- - [ ] Push master and release branches
- - [ ] Create GitHub release tag
- - [ ] `gem push pkg/squib-x.y.z.gem`
- - [ ] `gem push --key github --host https://rubygems.pkg.github.com/andymeneely pkg/squib-x.y.z.gem`
- - [ ] Github milestone closed
- - [ ] Activate version on squib.readthedocs.org
- - [ ] Bump version.rb to the next alpha
- - [ ] Publish on BoardGameGeek thread