squib 0.15.3 → 0.16.0.pre.preview1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e9214c505f044e2a2c495c56f8561791a19cbbf92100f17b9b2c558e353b279
-  data.tar.gz: d85206902341999fd4c0f4cdcb2cb3f2f6e649a4d6031369af4f747302826d30
+  metadata.gz: 24cc3f2b97503042d0ad1a0db003e8cb585e4853389c78b49c54c036f45bf4e2
+  data.tar.gz: aa49287f4fa01039f4ea8737e862d24637ba47142d84849e54335b44b00f4424
 SHA512:
-  metadata.gz: aae369ed29a073c2469ea665e1ecd249d29b555a7c2c3d45c30a610d515779beea46c0438f9bca4541c0ab46c0745f1948c27995163be1cf40fa99f006cfa9b8
-  data.tar.gz: '0392fbf16c9078aa8f477fc521724a1c9f3b0903ae2317f2543e4cf05d3fa16d981e8ac789abe391952281c8483789dcc828c3a9627571ae6ec9a840720d89d9'
+  metadata.gz: 529665761713e33f8743356a90af15ab244e8e09ffbb4836d1aa3dd1e0398cba320ffb0e443aff355cc71604146f03865b413c3307a76d372860a07b35a8bb2b
+  data.tar.gz: 0fe62d7d34630c98c2750e5da46d4fd5633692f6f5cab22248b4650e6f8bfa2964ac0c107f5efd847c44342ad7b2ccf41634719b6c6cf84a55154ca1bcaba405

data/.github/workflows/tests.yml

@@ -0,0 +1,22 @@
+name: Squib Unit Tests
+
+on: [push]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos]
+        ruby: [2.5, 2.6, 2.7, head]
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        # bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: ruby --version # explicitly show the ruby version
+    - run: bundle install
+    - run: bundle exec rake

data/CHANGELOG.md

@@ -3,6 +3,28 @@ Squib follows [semantic versioning](http://semver.org).
 
 ## v0.16.0 / Unreleased
 
+Features:
+* Special custom unit: cells. A "cell" defaults to 37.5px, or 1/8in, e.g. `x: '1 cell'` means `x: 37.5`. See the docs for details.
+* Shorthands for `x`, `y`, `width`, and `height`! The words `x: 'middle'` and `x: 'middle + 1in'` will get interpreted. See the docs for details.
+* Autoscaling text! `ellipsize: :autoscale` will now downscale your `font_size` if the text ellipsized. Thanks @Qgel! (#288, #111).
+* Option checking!! Completely reworked the way we handle arguments in Squib internally (no external behavioral differences). Now, when you give an option to Squib that is not expected. Since every DSL method "knows" what options it takes, that also means we have EVERY option properly documented (missed a few...) AND we have an automated test that will tell us if we forget to document it.
+* `save_png` and `save_sheet` now have a `suffix` option which defaults to `''`. So now you can customize the filenames with `prefix`, `count_format`, and `suffix`.
+
+Compatibility:
+* When saving PNGs with sprues, outputs start counting at zero - which is more consistent with the rest of Squib.
+* Minimum Ruby is now 2.5. NOTE: Ruby 3.0 is coming Christmas 2020!! Check it out.
+
+Bugs:
+* Extra page/no page issue with sprues (#320)
+* Fix Ruby 2.7+ deprecations with CSV arguments (#303)
+
+Chores:
+* Reorganized the code internally. (#298) Every DSL method now has its own file.
+* Moved to Github Actions
+* Bump pango et al
+
+
+
 ## v0.15.3 / 2019-10-17
 
 Chores:

data/Dockerfile

@@ -1,25 +1,27 @@
-FROM ruby:2.5-alpine
+# This is the official Squib Docker image.
+#
+FROM ruby:2.7-slim
 WORKDIR /usr/src/app
 
 LABEL org.squib.url=http://squib.rocks \
       org.squib.github=https://github.com/andymeneely/squib
 
-RUN apk --no-cache add --update \
+RUN apt-get update && \
+    apt-get install -y \
+    libgirepository1.0-dev \
+    build-essential \
     ruby-dev \
-    build-base \
-    libxml2-dev \
-    libxslt-dev \
-    pcre-dev \
-    libffi-dev \
-    cairo
+    ruby \
+    ruby-gdk-pixbuf2 \
+    git \
+    fonts-open-sans
 
-# Just for devving on
-COPY . /app
+# Build the current directory of Squib
+COPY . /usr/src/app
+RUN rm -f /usr/src/app/Gemfile.lock
+RUN gem install bundler
+RUN bundle install
+RUN bundle exec rake install
 
-CMD ["sh"]
+# ENTRYPOINT [ "sh" ]
 
-# RUN gem install \
-#     squib \
-#     -- --use-system-libraries
-
-# NOTE: STILL UNDER DEVELOPMENT! Don't use this just yet.

data/Guardfile

@@ -0,0 +1,8 @@
+group :default do
+  guard 'rake', :task => 'spec' do
+    watch %r{.*\.xlsx$}
+    watch %r{.*\.rb$}
+    watch %r{.*\.yml$}
+    watch %r{.*\.rst$}
+  end
+end

data/README.md

@@ -1,4 +1,4 @@
-# Squib [![Gem Version](https://badge.fury.io/rb/squib.svg)](https://rubygems.org/gems/squib) [![Build Status](https://secure.travis-ci.org/andymeneely/squib.svg?branch=master)](https://travis-ci.org/andymeneely/squib) [![Build status](https://ci.appveyor.com/api/projects/status/ptjw6fvjh73anlau/branch/master?svg=true)](https://ci.appveyor.com/project/andymeneely/squib/branch/master) [![Coverage Status](https://img.shields.io/coveralls/andymeneely/squib.svg)](https://coveralls.io/r/andymeneely/squib) [![ReadTheDocs](https://readthedocs.org/projects/squib/badge/?version=latest)](http://squib.readthedocs.io/en/latest/?badge=latest) [![BoardGameGeek](https://cdn.rawgit.com/andymeneely/squib/gh-pages/images/microbadge.png)](https://boardgamegeek.com/guild/2601)
+# Squib [![Gem Version](https://badge.fury.io/rb/squib.svg)](https://rubygems.org/gems/squib) [![Build Status](https://secure.travis-ci.org/andymeneely/squib.svg?branch=master)](https://travis-ci.org/andymeneely/squib) [![Build status](https://ci.appveyor.com/api/projects/status/ptjw6fvjh73anlau/branch/master?svg=true)](https://ci.appveyor.com/project/andymeneely/squib/branch/master) [![Coverage Status](https://img.shields.io/coveralls/andymeneely/squib.svg)](https://coveralls.io/r/andymeneely/squib) [![ReadTheDocs](https://readthedocs.org/projects/squib/badge/?version=latest)](http://squib.readthedocs.io/en/latest/?badge=latest) [![BoardGameGeek](https://github.com/andymeneely/squib.rocks/raw/gh-pages/images/microbadge.png)](https://boardgamegeek.com/guild/2601)
 
 Squib is a Ruby [DSL](http://en.wikipedia.org/wiki/Domain-specific_language) for prototyping card and board games. Write a little bit of Ruby, define your deck's stats, then compile your game into a series of images ready for print-and-play or even print-on-demand. Squib is very data-driven and built on the principle of Don't Repeat Yourself. Think of it like [nanDeck](http://www.nand.it/nandeck/) done "the Ruby way". Squib supports:
 
@@ -31,7 +31,7 @@ Wanna see more? Check out the website: http://andymeneely.github.io/squib/
 
 ## Installation
 
-Squib requires Ruby 2.4 or later.
+Squib requires Ruby 2.5 or later.
 
 Install it yourself with:
 
@@ -85,7 +85,7 @@ Go [read the docs!](http://squib.readthedocs.org/)
 
 Also:
 * The `samples` directory in the [source repository](https://github.com/andymeneely/squib) has lots of examples.
-* [Your Last Heist](http://yourlastheist.com) is my own creation, and it was made with Squib. Go through the repository and watch how it evolved!
+* [Masters of the Heist](http://mastersoftheheist.com) is my own creation, and it was made with Squib. Go through the repository and watch how it evolved!
 * [Junk Land](https://github.com/andymeneely/junk-land) is my own creation that's uses Squib for full-color rendering, and makes use of Ruby in a lot of interesting ways. The port is still in process.
 * [Project Spider Monkey](https://github.com/andymeneely/project-spider-monkey) is another of my own creations. This one was started from scratch with Squib, but it's still in its early stages.
 
@@ -99,12 +99,6 @@ Squib tries to keep you DRY (Don't Repeat Yourself) with the following features:
 * Custom colors keep you from hardcoding magic color strings everywhere. Custom colors go into `config.yml` file.
 * Plus, you know, Ruby.
 
-## SublimeText
-
-Using SublimeText? I like you already. I've written up some Squib snippets to ease remembering Squib commands. It's called `Squib Snippets` on Package Control. Compatible with SublimeText 3. Source code is also [on Github](https://github.com/andymeneely/sublime-squib) (contributions welcome!). Check it out:
-
-![Sublime Squib Snippets](https://raw.githubusercontent.com/andymeneely/squib/screencasts/sublime-squib-snippets.gif)
-
 
 ## Docker
 

data/RELEASE TODO.md

@@ -15,6 +15,7 @@ Be sure to remember to do the following for releases. (Copy into a GitHub issue)
  - [ ] 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

data/Rakefile

@@ -6,6 +6,9 @@ require 'benchmark'
 desc 'install + spec'
 task default: ['install:local', :spec]
 
+desc 'test => spec'
+task test: [:spec]
+
 # Useful for hooking up with SublimeText.
 # e.g. rake sample[basic.rb]
 desc 'Run a specific sample'

data/lib/squib.rb

@@ -2,12 +2,14 @@ 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'
 
 module Squib
+  using Rainbow # we can colorize strings now!
 
   # Access the internal logger that Squib uses. By default, Squib configure the logger to the WARN level
   # Use this to suppress or increase output levels.
@@ -22,7 +24,7 @@ module Squib
       @logger = Logger.new($stdout)
       @logger.level = Logger::WARN
       @logger.formatter = proc do |severity, datetime, m_progname, msg|
-        "#{datetime} #{severity}: #{msg}\n"
+        "[#{datetime.strftime('%F %H:%M:%S')} #{severity.red}] #{msg}\n"
       end
     end
     @logger

data/lib/squib/args/arg_loader.rb

@@ -2,125 +2,128 @@ require_relative '../constants'
 require_relative '../conf'
 require 'ostruct'
 
-module Squib
-  # @api private
-  module Args
+# Intended to be used a a mix-in,
+# For example use see Box as an example
+module Squib::Args::ArgLoader
 
-    # Intended to be used a a mix-in,
-    # For example use see Box as an example
-    module ArgLoader
+  # wrapper for compatibility
+  def extract!(args, deck)
+    @deck = deck
+    load!(args,
+          expand_by: deck.size,
+          layout: deck.layout,
+          dpi: deck.dpi,
+          cell_px: deck.cell_px)
+  end
 
-      # Main class invoked by the client (i.e. api/ methods)
-      def load!(args, expand_by: 1, layout: {}, dpi: 300)
-        Squib.logger.debug { "ARG LOADER: load! for #{self.class}, args: #{args}" }
-        @dpi = dpi
-        args[:layout] = prep_layout_args(args[:layout], expand_by: expand_by)
-        expand_and_set_and_defaultify(args: args, by: expand_by, layout: layout)
-        validate
-        convert_units dpi: dpi
-        self
-      end
+  # Main class invoked by the client (i.e. dsl/ methods)
+  def load!(args, expand_by: 1, layout: {}, dpi: 300, cell_px: 37.5)
+    @dpi = dpi
+    @cell_px = cell_px
+    args[:layout] = prep_layout_args(args[:layout], expand_by: expand_by)
+    expand_and_set_and_defaultify(args: args, by: expand_by, layout: layout)
+    validate
+    convert_units dpi: dpi, cell_px: cell_px
+    self
+  end
 
-      def expand_and_set_and_defaultify(args: {}, by: 1, layout: {})
-        attributes = self.class.parameters.keys
-        attributes.each do |p|
-          args[p] = defaultify(p, args, layout)
-          val = if expandable_singleton?(p, args[p])
-                  [args[p]] * by
-                else
-                  args[p] # not an expanding parameter
-                end
-          instance_variable_set "@#{p}", val
-        end
-        self.class.class_eval { attr_reader *(attributes) }
-      end
+  def expand_and_set_and_defaultify(args: {}, by: 1, layout: {})
+    attributes = self.class.parameters.keys
+    attributes.each do |p|
+      args[p] = defaultify(p, args, layout)
+      val = if expandable_singleton?(p, args[p])
+              [args[p]] * by
+            else
+              args[p] # not an expanding parameter
+            end
+      instance_variable_set "@#{p}", val
+    end
+    self.class.class_eval { attr_reader *(attributes) }
+  end
 
-      # Must be:
-      #  (a) an expanding parameter, and
-      #  (b) a singleton already (i.e. doesn't respond to :each)
-      def expandable_singleton?(p, arg)
-        self.class.expanding_parameters.include?(p) && !arg.respond_to?(:each)
-      end
+  # Must be:
+  #  (a) an expanding parameter, and
+  #  (b) a singleton already (i.e. doesn't respond to :each)
+  def expandable_singleton?(p, arg)
+    self.class.expanding_parameters.include?(p) && !arg.respond_to?(:each)
+  end
 
-      # Incorporate defaults and layouts
-      #  (1) Use whatever is specified if it is
-      #  (2) Go over all layout specifications (if any) and look them up
-      #     - Use layout when it's specified for that card
-      #     - Use "default" if no layout was specified, or the layout itself did not specify
-      #           Defaut can be overriden for a given dsl method (@dsl_method_defaults)
-      #           (e.g stroke width is 0.0 for text, non-zero everywhere else)
-      #
-      def defaultify(p, args, layout)
-        return args[p] if args.key? p # arg was specified, no defaults used
-        defaults = self.class.parameters.merge(@dsl_method_defaults || {})
-        args[:layout].map do |layout_arg|
-          return defaults[p] if layout_arg.nil?  # no layout specified, use default
-          unless layout.key? layout_arg.to_s     # specified a layout, but it doesn't exist in layout. Oops!
-            Squib.logger.warn("Layout \"#{layout_arg.to_s}\" does not exist in layout file - using default instead")
-            return defaults[p]
-          end
-          if layout[layout_arg.to_s].key?(p.to_s)
-            layout[layout_arg.to_s][p.to_s]     # param specified in layout
-          else
-            defaults[p]                         # layout specified, but not this param
-          end
-        end
+  # Incorporate defaults and layouts
+  #  (1) Use whatever is specified if it is
+  #  (2) Go over all layout specifications (if any) and look them up
+  #     - Use layout when it's specified for that card
+  #     - Use "default" if no layout was specified, or the layout itself did not specify
+  #           Defaut can be overriden for a given dsl method (@dsl_method_defaults)
+  #           (e.g stroke width is 0.0 for text, non-zero everywhere else)
+  #
+  def defaultify(p, args, layout)
+    return args[p] if args.key? p # arg was specified, no defaults used
+    defaults = self.class.parameters.merge(@dsl_method_defaults || {})
+    args[:layout].map do |layout_arg|
+      return defaults[p] if layout_arg.nil?  # no layout specified, use default
+      unless layout.key? layout_arg.to_s     # specified a layout, but it doesn't exist in layout. Oops!
+        Squib.logger.warn("Layout \"#{layout_arg.to_s}\" does not exist in layout file - using default instead")
+        return defaults[p]
       end
-
-      # Do singleton expansion on the layout argument as well
-      # Treated differently since layout is not always specified
-      def prep_layout_args(layout_args, expand_by: 1)
-        unless layout_args.respond_to?(:each)
-          layout_args = [layout_args] * expand_by
-        end
-        layout_args || []
-      end
-
-      # For each parameter/attribute foo we try to invoke a validate_foo
-      def validate
-        self.class.parameters.each do |param, default|
-          method = "validate_#{param}"
-          if self.respond_to? method
-            attribute = "@#{param}"
-            val = instance_variable_get(attribute)
-            if val.respond_to? :each
-              new_val = val.map.with_index{ |v, i| send(method, v, i) }
-              instance_variable_set(attribute, new_val)
-            else
-              instance_variable_set(attribute, send(method, val))
-            end
-          end
-        end
+      if layout[layout_arg.to_s].key?(p.to_s)
+        layout[layout_arg.to_s][p.to_s]     # param specified in layout
+      else
+        defaults[p]                         # layout specified, but not this param
       end
+    end
+  end
 
-      # Access an individual arg for a given card
-      # @return an OpenStruct that looks just like the mixed-in class
-      # @api private
-      def [](i)
-        card_arg = OpenStruct.new
-        self.class.expanding_parameters.each do |p|
-          p_val = instance_variable_get("@#{p}")
-          card_arg[p] = p_val[i]
-        end
-        card_arg
-      end
+  # Do singleton expansion on the layout argument as well
+  # Treated differently since layout is not always specified
+  def prep_layout_args(layout_args, expand_by: 1)
+    unless layout_args.respond_to?(:each)
+      layout_args = [layout_args] * expand_by
+    end
+    layout_args || []
+  end
 
-      # Convert units
-      def convert_units(dpi: 300)
-        self.class.params_with_units.each do |p|
-          p_str = "@#{p}"
-          p_val = instance_variable_get(p_str)
-          if p_val.respond_to? :each
-            arr = p_val.map { |x| UnitConversion.parse(x, dpi) }
-            instance_variable_set p_str, arr
-          else
-            instance_variable_set p_str, UnitConversion.parse(p_val, dpi)
-          end
+  # For each parameter/attribute foo we try to invoke a validate_foo
+  def validate
+    self.class.parameters.each do |param, default|
+      method = "validate_#{param}"
+      if self.respond_to? method
+        attribute = "@#{param}"
+        val = instance_variable_get(attribute)
+        if val.respond_to? :each
+          new_val = val.map.with_index{ |v, i| send(method, v, i) }
+          instance_variable_set(attribute, new_val)
+        else
+          instance_variable_set(attribute, send(method, val))
         end
-        self
       end
+    end
+  end
 
+  # Access an individual arg for a given card
+  # @return an OpenStruct that looks just like the mixed-in class
+  # @api private
+  def [](i)
+    card_arg = OpenStruct.new
+    self.class.expanding_parameters.each do |p|
+      p_val = instance_variable_get("@#{p}")
+      card_arg[p] = p_val[i]
     end
+    card_arg
+  end
 
+  # Convert units
+  def convert_units(dpi: 300, cell_px: 37.5)
+    self.class.params_with_units.each do |p|
+      p_str = "@#{p}"
+      p_val = instance_variable_get(p_str)
+      if p_val.respond_to? :each
+        arr = p_val.map { |x| Squib::Args::UnitConversion.parse(x, dpi, cell_px) }
+        instance_variable_set p_str, arr
+      else
+        instance_variable_set p_str, Squib::Args::UnitConversion.parse(p_val, dpi, cell_px)
+      end
+    end
+    self
   end
+
 end

data/lib/squib/args/box.rb

@@ -1,55 +1,59 @@
 require_relative 'arg_loader'
+require_relative 'xywh_shorthands'
 
-module Squib
-  # @api private
-  module Args
-
-    class Box
-      include ArgLoader
-
-      def initialize(deck = nil, dsl_method_defaults = {})
-        @deck = deck
-        @dsl_method_defaults = dsl_method_defaults
-      end
-
-      def self.parameters
-        { x: 0, y: 0,
-          width: :deck, height: :deck,
-          radius: nil, x_radius: 0, y_radius: 0
-        }
-      end
-
-      def self.expanding_parameters
-        parameters.keys # all of them
-      end
-
-      def self.params_with_units
-        parameters.keys # all of them
-      end
-
-      def validate_width(arg, _i)
-        return arg if @deck.nil?
-        return @deck.width if arg == :deck
-        arg
-      end
-
-      def validate_height(arg, _i)
-        return arg if @deck.nil?
-        return @deck.height if arg == :deck
-        arg
-      end
-
-      def validate_x_radius(arg, i)
-        return radius[i] unless radius[i].nil?
-        arg
-      end
-
-      def validate_y_radius(arg, i)
-        return radius[i] unless radius[i].nil?
-        arg
-      end
+module Squib::Args
 
+  module_function def extract_box(opts, deck, dsl_method_defaults = {})
+    Box.new(deck, dsl_method_defaults).extract!(opts, deck)
+  end
+
+  class Box
+    include ArgLoader
+    include XYWHShorthands
+
+    def initialize(deck = nil, dsl_method_defaults = {})
+      @deck = deck
+      @dsl_method_defaults = dsl_method_defaults
+    end
+
+    def self.parameters
+      { x: 0, y: 0,
+        width: :deck, height: :deck,
+        radius: nil, x_radius: 0, y_radius: 0
+      }
+    end
+
+    def self.expanding_parameters
+      parameters.keys # all of them
+    end
+
+    def self.params_with_units
+      parameters.keys # all of them
     end
 
+    def validate_x(arg, i) apply_shorthands(arg, @deck, axis: :x) end
+    def validate_y(arg,_i) apply_shorthands(arg, @deck, axis: :y) end
+
+    def validate_width(arg, _i)
+      return arg if @deck.nil?
+      apply_shorthands(arg, @deck, axis: :x)
+    end
+
+    def validate_height(arg, _i)
+      return arg if @deck.nil?
+      apply_shorthands(arg, @deck, axis: :y)
+    end
+
+    def validate_x_radius(arg, i)
+      return radius[i] unless radius[i].nil?
+      arg
+    end
+
+    def validate_y_radius(arg, i)
+      return radius[i] unless radius[i].nil?
+      arg
+    end   
+
   end
+
 end