squib 0.15.1 → 0.16.0

data/CONTRIBUTING.md

@@ -1,40 +1,40 @@
-# Contributing to Squib
-
-Please use GitHub issues for bugs and feature requests.
-
-## Need Help?
-
-There are lots of people using Squib already. If you've gone through the [samples](https://github.com/andymeneely/squib/tree/master/samples) and still have questions, here are some other places to get help.
-
-* [StackOverflow](http://stackoverflow.com/questions/ask?tags=ruby squib) with the tag "ruby" and "squib" will get you answers quickly and a great way to document questions for future Squibbers.
-* Our [thread on BoardGameGeek](http://boardgamegeek.com/thread/1293453) is quite active and informal (if a bit unstructured).
-
-If you email me directly I'll probably ask you to post your question publicly so we can document answers for future Googling Squibbers.
-
-## Pull Requests
-
-If you are contributing a new feature:
-* Keep your change small and atomic. Do significant refactoring in a separate pull request.
-* Please write a sample demonstrating your new feature. Place it in the samples/ directory
-* While your pull request is open, please keep it up to date with the `dev` branch so it can be easily integrated
-* We (sort of) follow [these Ruby style guidelines](https://github.com/bbatsov/ruby-style-guide)
-
-## Get Involved in the Community
-
-Let's help each other out! Even if you're relatively new, there's probably some question out there that you can help answer. Here's how to help:
-
-* Subscribe to our thread on BoardGameGeek (see above for link)
-* Subscribe to alerts from Stackoverflow for the tags "squib" and "ruby"
-* Post snippets of your code using GitHub gists
-* Write a how-to tutorial and post it on [our wiki](https://github.com/andymeneely/squib/wiki)
-
-## Testing Pre-Builds
-
-Testers needed!! If you want to test new features as I develop them, or make sure I didn't break your code, you can always point your Gemfile to the repository and follow what I'm doing there. Your Gemfile specification looks like this:
-
-```ruby
-gem 'squib', git: 'git://github.com/andymeneely/squib', branch: 'dev'
-```
-* The `dev` branch is where I am working on features in-process. I have not done much regression testing at this point, but would love testing feedback nonetheless.
-* The `master` branch is where I consider features and bug that are done and tested, but not released yet.
-* Use `bundle exec` to execute your code (e.g. `bundle exec rake` or `bundle exec ruby deck.rb`). See [Bundler](http://bundler.io) for more info.
+# Contributing to Squib
+
+Please use GitHub issues for bugs and feature requests.
+
+## Need Help?
+
+There are lots of people using Squib already. If you've gone through the [samples](https://github.com/andymeneely/squib/tree/master/samples) and still have questions, here are some other places to get help.
+
+* [StackOverflow](http://stackoverflow.com/questions/ask?tags=ruby squib) with the tag "ruby" and "squib" will get you answers quickly and a great way to document questions for future Squibbers.
+* Our [thread on BoardGameGeek](http://boardgamegeek.com/thread/1293453) is quite active and informal (if a bit unstructured).
+
+If you email me directly I'll probably ask you to post your question publicly so we can document answers for future Googling Squibbers.
+
+## Pull Requests
+
+If you are contributing a new feature:
+* Keep your change small and atomic. Do significant refactoring in a separate pull request.
+* Please write a sample demonstrating your new feature. Place it in the samples/ directory
+* While your pull request is open, please keep it up to date with the `dev` branch so it can be easily integrated
+* We (sort of) follow [these Ruby style guidelines](https://github.com/bbatsov/ruby-style-guide)
+
+## Get Involved in the Community
+
+Let's help each other out! Even if you're relatively new, there's probably some question out there that you can help answer. Here's how to help:
+
+* Subscribe to our thread on BoardGameGeek (see above for link)
+* Subscribe to alerts from Stackoverflow for the tags "squib" and "ruby"
+* Post snippets of your code using GitHub gists
+* Write a how-to tutorial and post it on [our wiki](https://github.com/andymeneely/squib/wiki)
+
+## Testing Pre-Builds
+
+Testers needed!! If you want to test new features as I develop them, or make sure I didn't break your code, you can always point your Gemfile to the repository and follow what I'm doing there. Your Gemfile specification looks like this:
+
+```ruby
+gem 'squib', git: 'git://github.com/andymeneely/squib', branch: 'dev'
+```
+* The `dev` branch is where I am working on features in-process. I have not done much regression testing at this point, but would love testing feedback nonetheless.
+* The `master` branch is where I consider features and bug that are done and tested, but not released yet.
+* Use `bundle exec` to execute your code (e.g. `bundle exec rake` or `bundle exec ruby deck.rb`). See [Bundler](http://bundler.io) for more info.

data/Dockerfile

@@ -1,25 +1,27 @@
-FROM ruby:2.5-alpine
-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 \
-    ruby-dev \
-    build-base \
-    libxml2-dev \
-    libxslt-dev \
-    pcre-dev \
-    libffi-dev \
-    cairo
-
-# Just for devving on
-COPY . /app
-
-CMD ["sh"]
-
-# RUN gem install \
-#     squib \
-#     -- --use-system-libraries
-
-# NOTE: STILL UNDER DEVELOPMENT! Don't use this just yet.
+# 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 apt-get update && \
+    apt-get install -y \
+    libgirepository1.0-dev \
+    build-essential \
+    ruby-dev \
+    ruby \
+    ruby-gdk-pixbuf2 \
+    git \
+    fonts-open-sans
+
+# 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
+
+# ENTRYPOINT [ "sh" ]
+

data/Gemfile

@@ -1,2 +1,2 @@
-source 'https://rubygems.org'
-gemspec
+source 'https://rubygems.org'
+gemspec

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/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2014 Andy Meneely
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2014 Andy Meneely
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,121 +1,139 @@
-# 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 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:
-
-* A concise set of rules for laying out your cards
-* Loading PNGs and SVGs
-* Complex text rendering using [Pango](http://www.pango.org/)
-* Reading `xlsx` and `csv` files
-* Rendering to PNGs, PDFs, and SVGs (sheets or individual files)
-* Flexible, data-driven layouts in Yaml
-* Basic shape drawing, blending operators, gradients, etc.
-* Unit conversion
-* The full power of Ruby!
-
-Squib is based on the [Cairo](http://cairographics.org/) graphics rendering engine, the library of choice for WebKit, Gecko, Inkscape and many, many others.
-
-Check this out.
-
-```ruby
-require 'squib'
-
-Squib::Deck.new(cards: 2) do
-  text str: %w(Hello World!)
-  save_png
-end
-```
-
-We just created a 2-card deck with "Hello" on the first card, and "World" on the second, and saved them out to PNGs.
-
-Wanna see more? Check out the website: http://andymeneely.github.io/squib/
-
-## Installation
-
-Squib requires Ruby 2.4 or later.
-
-Install it yourself with:
-
-    $ gem install squib
-
-If you're using Bundler, add this line to your application's Gemfile:
-
-    gem 'squib'
-
-And then execute:
-
-    $ bundle
-
-More info: http://squib.readthedocs.org/en/latest/install.html
-
-
-## Getting Started
-
-After installing Squib, you can create a project and run your first build like this:
-
-```sh
-$ squib new my-cool-game
-$ cd my-cool-game
-$ ruby deck.rb
-```
-
-The `squib new` command will generate files and folders like this:
-
-```
-├── .gitignore
-├── ABOUT.md
-├── Gemfile
-├── IDEAS.md
-├── PLAYTESTING.md
-├── PNP NOTES.md
-├── RULES.md
-├── Rakefile
-├── _output
-│   └── gitkeep.txt
-├── config.yml
-├── deck.rb
-└── layout.yml
-
-12 files
-```
-
-
-# Learning Squib
-
-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!
-* [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.
-
-
-## Staying DRY
-
-Squib tries to keep you DRY (Don't Repeat Yourself) with the following features:
-
-* Custom layouts allow you to specify various arguments in a separate file. This is great for x-y coordinates and alignment properties that would otherwise clutter up perfectly readable code. Squib goes even further and has a special "extends" that works especially well for grouped-together styles.
-* Flexible ranges and array handling: the `range` parameter in Squib is very flexible, meaning that one `text` command can specify different text in different fonts, styles, colors, etc. for each card. If you find yourself doing multiple `text` command for the same field across different ranges of cards, there's probably a better way to condense.
-* 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)
-
-
-
-# Get Help and Give Help
-
-See [this page](http://squib.readthedocs.org/en/latest/help.html)
-
-
-# What's up the with the name?
-
-Truthfully, I just thought it was a cool, simple word that was not used much in the Ruby community nor the board game community. But, now that I've committed to the name, I've realized that:
-
-* Squibs are small explosive devices, much like Squib "explodes" your rules into a playable game
-* Squibs are often used in heist movies, leading to a sudden plot twist that often resembles the twists of good tabletop game
-* Squibs are also part of the Harry Potter world - they are people who are non-magical but wizard-born. Squib is aware of wizarding magic and comes from that heritage, but it's not magical itself.
+# 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:
+
+* A concise set of rules for laying out your cards
+* Loading PNGs and SVGs
+* Complex text rendering using [Pango](http://www.pango.org/)
+* Reading `xlsx` and `csv` files
+* Rendering to PNGs, PDFs, and SVGs (sheets or individual files)
+* Flexible, data-driven layouts in Yaml
+* Basic shape drawing, blending operators, gradients, etc.
+* Unit conversion
+* The full power of Ruby!
+
+Squib is based on the [Cairo](http://cairographics.org/) graphics rendering engine, the library of choice for WebKit, Gecko, Inkscape and many, many others.
+
+Check this out.
+
+```ruby
+require 'squib'
+
+Squib::Deck.new(cards: 2) do
+  text str: %w(Hello World!)
+  save_png
+end
+```
+
+We just created a 2-card deck with "Hello" on the first card, and "World" on the second, and saved them out to PNGs.
+
+Wanna see more? Check out the website: http://andymeneely.github.io/squib/
+
+## Installation
+
+Squib requires Ruby 2.5 or later.
+
+Install it yourself with:
+
+    $ gem install squib
+
+If you're using Bundler, add this line to your application's Gemfile:
+
+    gem 'squib'
+
+And then execute:
+
+    $ bundle
+
+More info: http://squib.readthedocs.org/en/latest/install.html
+
+
+## Getting Started
+
+After installing Squib, you can create a project and run your first build like this:
+
+```sh
+$ squib new my-cool-game
+$ cd my-cool-game
+$ ruby deck.rb
+```
+
+The `squib new` command will generate files and folders like this:
+
+```
+├── .gitignore
+├── ABOUT.md
+├── Gemfile
+├── IDEAS.md
+├── PLAYTESTING.md
+├── PNP NOTES.md
+├── RULES.md
+├── Rakefile
+├── _output
+│   └── gitkeep.txt
+├── config.yml
+├── deck.rb
+└── layout.yml
+
+12 files
+```
+
+
+# Learning Squib
+
+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.
+* [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.
+
+
+## Staying DRY
+
+Squib tries to keep you DRY (Don't Repeat Yourself) with the following features:
+
+* Custom layouts allow you to specify various arguments in a separate file. This is great for x-y coordinates and alignment properties that would otherwise clutter up perfectly readable code. Squib goes even further and has a special "extends" that works especially well for grouped-together styles.
+* Flexible ranges and array handling: the `range` parameter in Squib is very flexible, meaning that one `text` command can specify different text in different fonts, styles, colors, etc. for each card. If you find yourself doing multiple `text` command for the same field across different ranges of cards, there's probably a better way to condense.
+* Custom colors keep you from hardcoding magic color strings everywhere. Custom colors go into `config.yml` file.
+* Plus, you know, Ruby.
+
+
+## Docker
+
+Want to run in a controlled environment? We've got a [Docker image on DockerHub](https://cloud.docker.com/u/andymeneely/repository/docker/andymeneely/squib)
+
+Here's one way to run it. On the command line, go to the root of your repository. With these commands, we'll map the current directory to the `/usr/src/app` directory in the Docker image. When squib-in-docker read & writes files from there, it'll write it back out to your current directory.
+
+Assuming you have a script called hello.rb:
+
+On Windows:
+
+```
+docker run --rm -v "%cd%":/usr/src/app andymeneely/squib ruby hello.rb
+```
+
+On Macs:
+
+```
+docker run --rm -v "$PWD":/usr/src/app andymeneely/squib ruby hello.rb
+```
+
+This will create a folder called `_output` in your current directory and write the output of the script there.
+
+We're still working on ways to customize your own Docker build (e.g. document building, custom fonts, etc.) with your own Dockerfile. Pull requests and ideas welcome!
+
+
+# Get Help and Give Help
+
+See [this page](http://squib.readthedocs.org/en/latest/help.html)
+
+
+# What's up the with the name?
+
+Truthfully, I just thought it was a cool, simple word that was not used much in the Ruby community nor the board game community. But, now that I've committed to the name, I've realized that:
+
+* Squibs are small explosive devices, much like Squib "explodes" your rules into a playable game
+* Squibs are often used in heist movies, leading to a sudden plot twist that often resembles the twists of good tabletop game
+* Squibs are also part of the Harry Potter world - they are people who are non-magical but wizard-born. Squib is aware of wizarding magic and comes from that heritage, but it's not magical itself.