squib 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d352d3f397797d5323516d286625b34e36854b5
-  data.tar.gz: ec3b155d2e22a1d286322ac7d780d08a10fd7ac7
+  metadata.gz: dc3e963811aff757de4bb9fdbe27a512e108ea3f
+  data.tar.gz: 94098850ead4d37cae33a5040aa47f6fdf284c24
 SHA512:
-  metadata.gz: a5159194a72709ebe44fb510b63834384c0a10b6201404b0d3b04af2f27b37ed4b6ebcc3b9a9c8bcb13e80f5928e7db4b4f2208cb4c75614fc8535ccf9650cc9
-  data.tar.gz: 14453ebabd751dc7c2a8f2fcaae46fcdeb07bc496c784cb0165b46da466722256ce6f35db23a9a25b97241910683e5772369ec9eda59c0f1e900b5c806a145d3
+  metadata.gz: 768da6ac1f30e27a6f50de8acc7e38ab82b466ed78b4fab69375c62de5deaae03bf3387bea76d6a0a778c2f76736335794bd7e4f28c37224a2e78d0ba4241e65
+  data.tar.gz: 153722e40cc1a4c3fe04ce30672d6489133d9ef5b692deac675b0705f92a6f04f90358c93a196120bb4a5e8d2e73c244cd77cfea88c10e4d986e6fb9aef77d24

data/.travis.yml

@@ -2,6 +2,12 @@ dist: trusty
 language: ruby
 sudo: false # taking advantage of container-based infrastructure
 cache: bundler # cache bundled gems from build to build
+
+addons:
+  apt:
+    packages:
+      - libgirepository1.0-dev # for gobject-introspection
+
 rvm:
   - 2.2
   - 2.3.0

data/CHANGELOG.md

@@ -1,15 +1,36 @@
 # Squib CHANGELOG
 Squib follows [semantic versioning](http://semver.org).
 
-## v0.10.0 / Unreleased
+## v0.11.0 / Unreleased
 
 Features:
-* Build groups! Simplify the process of building your deck different ways (e.g. one for color, one for PNP). Can be enabled explicitly or via command line. [See our shiny new docs for how these work](http://squib.readthedocs.org/en/latest/build_groups.html).
+* Unit conversion supports mm (#161)
+* `rect` and `ellipse` support the `angle` option (#162)
+
+Docs:
+* Provide previews of each built-in template on the docs (#163)
+* Documented lack of `:scale` behavior on text embedding. (#160)
+
+Bugs:
+* Fresh installs of Squib were broken due to two hidden dependencies, gio2 and gobject-introspection. (#172)
+* Embedding icons in text show unicode placeholders on some OSs. Actually, all of icon embedding was one giant bug waiting to be squashed. I finally implemented this functionality using the proper API calls. See #177 for the feature, and then the bugs were #170, #171, #158, and #176. For that matter, see #103, #153, and #30 if you really want the whole story.
+* With #177, the `:native` option for image width and height text embedding should work ().
+* Unit conversion is supported when using `extends` in layouts, as promised in the docs (#173)
+
+Compatibility:
+* I reworked the way icons are embedded, and that was a big change internally (#177). We're now using Pango's API in the expected way and not dealing with "undefined behavior" situations with zero-sized fonts and obscure UTF-8 characters as we were before. But, as a result, Pango handles custom shapes a little differently than before. Wrapping doesn't render exactly the same way as before, although it's acceptable in most cases. If you still find problems, please file a bug.
+
+Special thanks to everyone who tested, reported, suggested, and helped for this release! bcompter, rhyok, temetherian, rpond-pa, Nibodhika,  briant-spindance, lcarlsen, spilth
+
+## v0.10.0 / 2016-05-06
+
+Features:
+* Build groups! Simplify the process of building your deck different ways (e.g. one for color, one for PNP). Can be enabled explicitly or via command line. [See our shiny new docs for how these work](http://squib.readthedocs.io/en/latest/build_groups.html).
 * New `use_layout` method will allow you to load a layout file as a DSL method instead of in the constructor. Useful in conjunction with build groups! (#141)
 * The `csv` method now supports a `data` option to read CSV data directly. When set, it overrides the `file` option.
 * The `csv` method now supports all of the Ruby CSV options (e.g. `col_sep`, `quote_char`). These options simply get passed through to Ruby, so as they change in Ruby, so the support changes in Squib (#149). Special thanks to Qgel's initial pull request (#146).
 * The `csv` method now supports a block that it yields to for each element for pre-processing data (#145). Oh and `xlsx` has had that functionality for a while now, and now it's actually documented (#151).
-* Rewrote the entire API doc and placed it on [squib.readthedocs.org](http://squib.readthedocs.org). :tada:
+* Rewrote the entire API doc and placed it on [squib.readthedocs.io](http://squib.readthedocs.io). :tada:
 
 Bugs:
 * The `save_pdf` method will flush to file upon exit so that the PDF is available immediately. (#150, thanks for the bug report Qgel!)

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) [![Vey][vey]][vey_url] [![Dependency Status](https://gemnasium.com/andymeneely/squib.svg)](https://gemnasium.com/andymeneely/squib) [![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.org) [![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) [![Vey][vey]][vey_url] [![Dependency Status](https://gemnasium.com/andymeneely/squib.svg)](https://gemnasium.com/andymeneely/squib) [![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:
 
 [vey]: https://ci.appveyor.com/api/projects/status/github/andymeneely/squib?svg=true
@@ -87,8 +87,9 @@ 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.
-* [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.
-* [Project Spider Monkey](https://github.com/andymeneely/project-spider-monkey) is another of my own creations. This one was started from scratch with Squib.
+* [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

data/RELEASE TODO.md

@@ -5,11 +5,13 @@ Be sure to remember to do the following for releases. (Copy into a GitHub issue)
  - [ ] Samples are updated
  - [ ] 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
- - [ ] Push 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

data/docs/_static/css/squibdocs.css

@@ -16,3 +16,8 @@ code.code_img{
 code.code_img_small{
   width: 33%;
 }
+
+.figure{
+  border: 1pt solid black;
+  box-shadow: 5px 5px 8px #333;
+}

data/docs/conf.py

@@ -55,9 +55,9 @@ author = u'Andy Meneely'
 # built documents.
 #
 # The short X.Y version.
-version = u'0.9.0'
+version = u'v0.11'
 # The full version, including alpha/beta/rc tags.
-release = u'0.9.0'
+release = u'v0.11.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

data/docs/config.rst

@@ -45,6 +45,11 @@ prefix
 
   When using an SVG backend, cards are auto-saved with this prefix and ``'%02d'`` numbering format.
 
+img_dir
+  default: ``'.'``
+  
+  For reading image file command (e.g. png and svg), read from this directory instead
+
 warn_ellipsize
   default: true
 

data/docs/dsl/ellipse.rst

@@ -10,6 +10,12 @@ Options
 .. include:: /args/xy.rst
 .. include:: /args/wh.rst
 .. include:: /args/draw.rst
+
+angle
+  default: 0
+
+  the angle at which to rotate the ellipse about it's upper-left corner
+
 .. include:: /args/range.rst
 .. include:: /args/layout.rst
 

data/docs/dsl/mm.rst

@@ -0,0 +1,19 @@
+mm
+------
+
+Given millimeters, returns the number of pixels according to the deck's DPI.
+
+Parameters
+^^^^^^^^^^
+
+n
+  the number of mm
+
+
+Examples
+^^^^^^^^
+
+.. code-block:: ruby
+
+  mm(1)         # 11.811px (for default Deck::dpi of 300)
+  mm(2) + mm(1) # 35.433ox (for default Deck::dpi of 300)

data/docs/dsl/rect.rst

@@ -13,6 +13,10 @@ Options
 .. include:: /args/range.rst
 .. include:: /args/layout.rst
 
+angle
+  default: 0
+
+  the angle at which to rotate the rectangle about it's upper-left corner
 
 Examples
 ^^^^^^^^

data/docs/dsl/text.rst

@@ -175,12 +175,12 @@ layout
 width
   default: ``:native``
 
-  the width of the image rendered.
+  the width of the image rendered. Does not support ``:scale`` (`yet <https://github.com/andymeneely/squib/issues/160>`_)
 
 height
   default: ``:native``
 
-  the height the height of the image rendered.
+  the height the height of the image rendered. Does not support ``:scale`` (`yet <https://github.com/andymeneely/squib/issues/160>`_)
 
 dx
   default: ``0``

data/docs/dsl/triangle.rst

@@ -8,27 +8,39 @@ Options
 .. include:: /args/expansion.rst
 
 x1
-  default: ``0``
+  default: ``100``
 
-  the x-coordinate to place. Supports :doc:`/units/`
+  the first x-coordinate to place. Supports :doc:`/units/`
 
 
 y1
-  default: ``0``
+  default: ``100``
 
-  the y-coordinate to place. Supports :doc:`/units/`
+  the first y-coordinate to place. Supports :doc:`/units/`
 
 
 x2
-  default: ``50``
+  default: ``150``
 
-  the x-coordinate to place. Supports :doc:`/units/`
+  the second x-coordinate to place. Supports :doc:`/units/`
 
 
 y2
-  default: ``50``
+  default: ``150``
+
+  the second y-coordinate to place. Supports :doc:`/units/`
+
+x3
+  default: ``100``
+
+  the third x-coordinate to place. Supports :doc:`/units/`
+
+
+y3
+  default: ``150``
+
+  the third y-coordinate to place. Supports :doc:`/units/`
 
-  the y-coordinate to place. Supports :doc:`/units/`
 
 .. include:: /args/draw.rst
 .. include:: /args/range.rst

data/docs/guides/game_icons.rst

@@ -1,2 +1,6 @@
 Using GameIcons.net
 ===================
+
+.. note::
+
+  To be written

data/docs/layouts.rst

@@ -227,6 +227,61 @@ If your layout file is not found in the current directory, Squib will search for
 
 Contributions in this area are particularly welcome!!
 
+The following depictions of the layouts are generated with `this script <https://github.com/andymeneely/squib/tree/master/samples/layouts/builtin_layouts.rb>`_
+
+fantasy.yml
+~~~~~~~~~~~
+
+.. raw:: html
+
+  <img src="layouts/expected_layouts_builtin_fantasy_00.png"
+    class="figure" width=350>
+
+https://github.com/andymeneely/squib/tree/master/lib/squib/layouts/fantasy.yml
+
+economy.yml
+~~~~~~~~~~~
+
+.. raw:: html
+
+  <img src="layouts/expected_layouts_builtin_economy_00.png"
+    class="figure" width=350>
+
+https://github.com/andymeneely/squib/tree/master/lib/squib/layouts/economy.yml
+
+tuck_box.yml
+~~~~~~~~~~~
+
+Based on TheGameCrafter's template.
+
+.. raw:: html
+
+  <img src="layouts/expected_layouts_builtin_tuck_box_00.png"
+    class="figure" width=450>
+
+https://github.com/andymeneely/squib/tree/master/lib/squib/layouts/tuck_box.yml
+
+
+hand.yml
+~~~~~~~~~~~
+
+.. raw:: html
+
+  <img src="layouts/expected_layouts_builtin_hand_00.png"
+    class="figure" width=350>
+
+https://github.com/andymeneely/squib/tree/master/lib/squib/layouts/hand.yml
+
+playing_card.yml
+~~~~~~~~~~~
+
+.. raw:: html
+
+  <img src="layouts/expected_layouts_builtin_playing_card_00.png"
+    class="figure" width=350>
+
+https://github.com/andymeneely/squib/tree/master/lib/squib/layouts/playing_card.yml
+
 See Layouts in Action
 ---------------------
 

data/docs/units.rst

@@ -1,6 +1,6 @@
 Unit Conversion
 ===============
 
-By default, Squib thinks in pixels. This decision was made so that we can have pixel-perfect layouts without automatically scaling everything, even though working in units is sometimes easier. We provide some conversion methods, including looking for strings that end in "in" and "cm" and computing based on the current DPI. The dpi is set on `Squib::Deck.new` (not `config.yml`).
+By default, Squib thinks in pixels. This decision was made so that we can have pixel-perfect layouts without automatically scaling everything, even though working in units is sometimes easier. We provide some conversion methods, including looking for strings that end in "in", "cm", or "mm" and computing based on the current DPI. The dpi is set on `Squib::Deck.new` (not `config.yml`).
 
 Example is in `samples/units.rb` found [here](https://github.com/andymeneely/squib/tree/master/samples/units.rb)

data/lib/squib/api/background.rb

@@ -4,7 +4,7 @@ require_relative '../args/draw'
 module Squib
   class Deck
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def background(opts = {})
       range = Args::CardRange.new(opts[:range], deck_size: size)
       draw  = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)

data/lib/squib/api/data.rb

@@ -6,7 +6,7 @@ require_relative '../args/csv_opts'
 
 module Squib
 
-  # DSL method. See http://squib.readthedocs.org
+  # DSL method. See http://squib.readthedocs.io
   def xlsx(opts = {})
     input = Args::InputFile.new(file: 'deck.xlsx').load!(opts)
     import = Args::Import.new.load!(opts)
@@ -30,7 +30,7 @@ module Squib
   end# xlsx
   module_function :xlsx
 
-  # DSL method. See http://squib.readthedocs.org
+  # DSL method. See http://squib.readthedocs.io
   def csv(opts = {})
     # TODO refactor all this out to separate methods, and its own class
     import = Args::Import.new.load!(opts)
@@ -93,12 +93,12 @@ module Squib
 
   class Deck
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def xlsx(opts = {})
       Squib.xlsx(opts)
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def csv(opts = {})
       Squib.csv(opts)
     end

data/lib/squib/api/groups.rb

@@ -12,25 +12,25 @@ module Squib
 
   class Deck
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def build grp = :all, &block
       raise 'Please provide a block' unless block_given?
       block.yield if build_groups.include? grp
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def enable_build grp
       build_groups # make sure it's initialized
       @build_groups << grp
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def disable_build grp
       build_groups # make sure it's initialized
       @build_groups.delete grp
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def build_groups
       @build_groups ||= Set.new.add(:all)
     end

data/lib/squib/api/image.rb

@@ -8,7 +8,7 @@ require_relative '../args/svg_special'
 module Squib
   class Deck
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def png(opts = {})
       Dir.chdir(img_dir) do
         range = Args::CardRange.new(opts[:range], deck_size: size)
@@ -25,7 +25,7 @@ module Squib
       end
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def svg(opts = {})
       Dir.chdir(img_dir) do
         range = Args::CardRange.new(opts[:range], deck_size: size)

data/lib/squib/api/save.rb

@@ -7,21 +7,21 @@ require_relative '../args/showcase_special'
 module Squib
   class Deck
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def save(opts = {})
       save_png(opts) if Array(opts[:format]).include? :png
       save_pdf(opts) if Array(opts[:format]).include? :pdf
       self
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def save_pdf(opts = {})
       range = Args::CardRange.new(opts[:range], deck_size: size)
       sheet = Args::Sheet.new(custom_colors, { file: 'output.pdf' }).load!(opts, expand_by: size, layout: layout, dpi: dpi)
       render_pdf(range, sheet)
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def save_png(opts = {})
       range = Args::CardRange.new(opts[:range], deck_size: size)
       batch = Args::SaveBatch.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
@@ -33,7 +33,7 @@ module Squib
       end
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def save_sheet(opts = {})
       range = Args::CardRange.new(opts[:range], deck_size: size)
       batch = Args::SaveBatch.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
@@ -41,7 +41,7 @@ module Squib
       render_sheet(range, batch, sheet)
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def showcase(opts = {})
       range    = Args::CardRange.new(opts[:range], deck_size: size)
       showcase = Args::ShowcaseSpecial.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
@@ -49,7 +49,7 @@ module Squib
       render_showcase(range, sheet, showcase)
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def hand(opts = {})
       range = Args::CardRange.new(opts[:range], deck_size: size)
       hand  = Args::HandSpecial.new(height).load!(opts, expand_by: size, layout: layout, dpi: dpi)