squib 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f92ed35ef9dd4ecc229f5608a621af891c3e31f
-  data.tar.gz: d45847e33458b00f6642558892abeb4f7682e0f0
+  metadata.gz: 54d41c6aefc288c69ad7d481ffa6e5b7b26e2658
+  data.tar.gz: fd8a41e64858c0b9b9a6e924dd64ee5ab52b46fc
 SHA512:
-  metadata.gz: d0fe30d4bfcf1f528140cbda4cd3662b88a06b605093390d2bf0ad28243b83b54ca97a294a3882f161db92d51ee13654519285df0c555c1e7aa5848a14de3520
-  data.tar.gz: 0acfc9a5e09394528b0eb3a6ed5df1ae528b18324ffe336e1f01d981ef839808283ab1b66468d66568869a376e99fde087bd2dfb9381069d353be29d15ba8a75
+  metadata.gz: 30dcd2caaa2ec623d456184a81729aea87765f81d40c726524e2117942bf316165a0df920479faa425462501296a1b984d64ab9b03b10a04bebad4815e0dbc43
+  data.tar.gz: 77d4d1950264389af9396aa895863fc1ba0a4ba1617d4889e0aa1ce982e05d16cd7951ab6488dcf86e05ea7997edd9ab6cc6b2b80ca27be728c848a1a94f6791

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
+cache: bundler
 rvm:
   - 2.0.0
-  - 2.1.2
-before_install: gem install bundler --version '~> 1.6' 
-
+  - 2.1.5
+  - 2.2.0

data/CHANGELOG.md

@@ -1,14 +1,21 @@
 # Squib CHANGELOG
 
+## v0.1.0
+* Added `save_sheet` command that saves a range into PNG sheets, complete with trim, gap, margin, columns, and sometimes automagically computed rows. See samples/saves.rb.
+* Unit conversion! Now you can write "2in" and it will convert based on the current dpi. `save_pdf` not supported (yet).
+* `png` now supports resizing, but warns you about it since it's non-ideal. Documented in yard, tested.
+* Added sample `unicode.rb` to show lots of game-related unicode characters
+* More obsessive automated testing and continuous integration work.
+
 ## v0.0.6
-# Added a `csv` command that works just like `xslx`. Uses Ruby's CSV inside, with some extra checking and warnings. 
-# Custom layouts now support loading & merging multiple Yaml files! Updated README, docs, and sample to document it.
-# Built-in layouts! Currently we support `hand.yml` and `playing-card.yml`. Documented in the `layouts.rb` sample.
-# `text` now returns the ink extent rectangle of the rendered text. Updated docs and sample to document it.
-# Samples now show that you can use text instead of symbols for things like `center`
-# Improved logging, and documentation on increasing logger verboseness
-# Better regression testing technique that tracks when a sample has changed.
-# Bumped version of Cairo to ~> 1.14
+* Added a `csv` command that works just like `xslx`. Uses Ruby's CSV inside, with some extra checking and warnings.
+* Custom layouts now support loading & merging multiple Yaml files! Updated README, docs, and sample to document it.
+* Built-in layouts! Currently we support `hand.yml` and `playing-card.yml`. Documented in the `layouts.rb` sample.
+* `text` now returns the ink extent rectangle of the rendered text. Updated docs and sample to document it.
+* Samples now show that you can use text instead of symbols for things like `center`
+* Improved logging, and documentation on increasing logger verboseness
+* Better regression testing technique that tracks when a sample has changed.
+* Bumped version of Cairo to ~> 1.14
 
 ## v0.0.5
 * Image rotation for png and svg via `angle`

data/README.md

@@ -1,15 +1,15 @@
 # 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) [![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) [![Inline docs](http://inch-ci.org/github/andymeneely/squib.png?branch=master)](http://inch-ci.org/github/andymeneely/squib)
-Squib is a Ruby [DSL](http://en.wikipedia.org/wiki/Domain-specific_language) for prototyping card and board games. With Squib, you just write a little bit of Ruby and you can compile your game's data and images into a series of images ready for print-and-play or even print-on-demand. Squib is very data-driven - think of it like [nanDeck](http://www.nand.it/nandeck/) done "the Ruby way". Squib supports:
+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, and you can 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 using [Cairo](http://cairographics.org/)
 * Complex text rendering using [Pango](http://www.pango.org/)
 * Reading `xlsx` and `csv` files
+* Rendering to individual PNGs or PDF sheets
+* Flexible, data-driven layouts in Yaml
 * Basic shape drawing
-* Rendering decks to PNGs and PDFs
-* Data-driven layouts
 * Unit conversion
-* Plus the full power of Ruby!
+* The full power of Ruby!
 
 Check this out.
 
@@ -38,7 +38,7 @@ And then execute:
 
     $ bundle
 
-Note: Squib has some native dependencies, such as [Cairo](https://github.com/rcairo/rcairo), [Pango](http://ruby-gnome2.sourceforge.jp/hiki.cgi?Pango%3A%3ALayout), and [Nokogiri](http://nokogiri.org/), which all require DevKit to compile C code. This is usually not painful, but can cause headaches on some setups. For Windows users, I *strongly* recommend using the *non-64 bit* RubyInstaller at http://rubyinstaller.org along with installing DevKit. For Mac, I recommend using [rvm](https://rvm.io).
+Note: Squib has some native dependencies, such as [Cairo](https://github.com/rcairo/rcairo), [Pango](http://ruby-gnome2.sourceforge.jp/hiki.cgi?Pango%3A%3ALayout), and [Nokogiri](http://nokogiri.org/), which may require compiling C code to install. This is usually not painful at all, but can cause headaches on some setups. For Windows users, I *strongly* recommend using the *non-64 bit* RubyInstaller at http://rubyinstaller.org along with installing DevKit. For Mac, I recommend using [rvm](https://rvm.io).
 
 Note: Squib requires Ruby 2.0 or later.
 
@@ -55,8 +55,7 @@ $ ruby deck.rb
 The `squib new` command will generate files and folders like this:
 
 ```
-_output
-  gitkeep.txt
+_output/gitkeep.txt
 .gitignore
 ABOUT.md
 config.yml
@@ -70,12 +69,20 @@ The central file here is `deck.rb`. Here's a [basic example](https://github.com/
 
 {include:file:samples/basic.rb basic.rb}
 
+About the other files:
+  * `Gemfile` is for adding in other gems if you are using `bundler`
+  * `config.yml` is a skeleton config file with various options commented out. See {file:README.md#Configuration_File Configuration File}.
+  * `layout.yml` is a skeleton layout file if you want to use it. See {file:README.md#Custom_Layouts Custom Layouts}.
+  * `_output` is the directory where your built files will go. Can easily be changed, of course.
+  * `.gitignore` and `gitkeep.txt` are for if you are using Git. See {file:README.md#Source_control Source control}. (Feel free to remove these if you are not using Git.)
+  * `ABOUT.md` and `PHP NOTES.md` are Markdown files for posting. Not used by Squib, but there by convention.
+
 # Learning Squib
 
 After going over this README, here are some other places to go learn Squib:
 
 * The YARD-generated API documentation [for the latest Squib gem](http://rubydoc.info/gems/squib/) is a method-by-method reference. The `Deck` class is the main class to look at. If you are following Squib master, see [the latest version](http://rubydoc.info/github/andymeneely/squib)
-* The `samples` directory in the [source repository](https://github.com/andymeneely/squib) has lots of examples. To run them, you will need to clone the repository and run them with Squib installed.
+* 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 both black-and-white print-and-play and full color.
 
 ## Viewing this README
@@ -137,12 +144,14 @@ Most public `Deck` methods allow a `range` to be specified as a first parameter.
 
 {include:file:samples/ranges.rb}
 
-## Pixels and Other Units
+## Units
 
-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. To convert, we provide the `Deck#inch` method, as shown in `samples/units.rb` found [here](https://github.com/andymeneely/squib/tree/master/samples/units.rb)
+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. Example is in `samples/units.rb` found [here](https://github.com/andymeneely/squib/tree/master/samples/units.rb)
 
 {include:file:samples/units.rb}
 
+Note: we do not support unit conversion on `save_pdf` and `Squib::Deck.new()`, [yet](https://github.com/andymeneely/squib/issues/21)
+
 ## Specifying Colors
 
 Colors can be specified in a wide variety of ways, mostly in a hex-string. Take a look at the examples from `samples/colors.rb`, found [here](https://github.com/andymeneely/squib/tree/master/samples/colors.rb)
@@ -286,7 +295,7 @@ Squib tries to keep you DRY (Don't Repeat Yourself) with the following features:
 
 You are using source control, right??
 
-By default, Squib assumes Git. But it's not dogmatic about it. Tracking your progress, backing up, sharing data, topic branches, release management, and reverting into history are just some of the many, many useful things you can do with source control. For me, I tend to ignore any auto-generated files in my output folder, but version control everything else. I also try to keep my graphics vector files, so the files stay small. Version control is intended for source code, so large binary files don't usually get checked in unless absolutely necessary. For big binaries with graphics I tend to keep those
+By default, Squib assumes Git. But it's not dogmatic about it. Tracking your progress, backing up, sharing data, topic branches, release management, and reverting into history are just some of the many, many useful things you can do with source control. For me, I tend to ignore any auto-generated files in my output folder, but version control everything else. I also try to keep my graphics vector files, so the files stay small. Version control is intended for source code, so large binary files that change often probably should not get checked in unless absolutely necessary. I tend to keep big raster graphics files (e.g. from Gimp) in cloud storage or elsewhere.
 
 ## SublimeText
 

data/RELEASE TODO.md

@@ -0,0 +1,13 @@
+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
+ - [ ] Check that sample regression tests are all enabled
+ - [ ] Bump version.rb
+ - [ ] Do a full rake locally
+ - [ ] Travis is passing on dev branch
+ - [ ] `gem push pkg/squib-x.y.z.gem`
+ - [ ] `rake doc`
+ - [ ] Push `rake doc` to website
+ - [ ] Bump version.rb to the next alpha

data/lib/squib/api/data.rb

@@ -54,11 +54,11 @@ module Squib
   #   data = csv file: 'data.csv'
   #   => {'h1' => [1,3], 'h2' => [2,4]}
   #
-  # Parsing uses Ruby's CSV, options: {headers: true, converters: :numeric}
+  # Parsing uses Ruby's CSV, with options `{headers: true, converters: :numeric}`
   # http://www.ruby-doc.org/stdlib-2.0/libdoc/csv/rdoc/CSV.html
   #
   # @option opts file [String]  the CSV-formatted file to open. Opens relative to the current directory.
-  # @return [Hash] a hash of arrays based on columns in the spreadsheet
+  # @return [Hash] a hash of arrays based on columns in the table
   # @api public
   def csv(opts = {})
     opts = Squib::SYSTEM_DEFAULTS.merge(opts)
@@ -90,6 +90,7 @@ module Squib
       Squib.xlsx(opts)
     end
 
+    # Convenience call on deck goes to the module function
     def csv(opts = {})
       Squib.csv(opts)
     end

data/lib/squib/api/image.rb

@@ -4,14 +4,15 @@ module Squib
     # Renders a png file at the given location.
     #
     # See {file:samples/image.rb samples/image.rb} and {file:samples/tgc-overlay.rb samples/tgc-overlay.rb} as examples.
-    # Note: scaling not currently supported for PNGs.
     # @example
     #   png file: 'img.png', x: 50, y: 50
     #
     # @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
     # @option opts file [String] ((empty)) file(s) to read in. If it's a single file, then it's use for every card in range. If the parameter is an Array of files, then each file is looked up for each card. If any of them are nil or '', nothing is done. See {file:README.md#Specifying_Files Specifying Files}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts x [Integer] (0) the x-coordinate to place. Supports Arrays, see {file:README#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts y [Integer] (0) the y-coordinate to place. Supports Arrays, see {file:README#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
+    # @option opts x [Integer] (0) the x-coordinate to place. Supports Arrays, see {file:README#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts y [Integer] (0) the y-coordinate to place. Supports Arrays, see {file:README#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts width [Integer] (:native) the pixel width that the image should scale to. Scaling PNGs is not recommended for professional-looking cards. When set to `:native`, uses the DPI and units of the loaded SVG document. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts height [Integer] (:native) the pixel width that the image should scale to. Scaling PNGs is not recommended for professional-looking cards. When set to `:native`, uses the DPI and units of the loaded SVG document. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @option opts alpha [Decimal] (1.0) the alpha-transparency percentage used to blend this image. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @option opts blend [:none, :multiply, :screen, :overlay, :darken, :lighten, :color_dodge, :color_burn, :hard_light, :soft_light, :difference, :exclusion, :hsl_hue, :hsl_saturation, :hsl_color, :hsl_luminosity] (:none) the composite blend operator used when applying this image. See Blend Modes at http://cairographics.org/operators. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
@@ -19,11 +20,12 @@ module Squib
     # @return [nil] Returns nil
     # @api public
     def png(opts = {})
-      opts = needs(opts, [:range, :files, :x, :y, :alpha, :layout, :blend, :angle])
+      opts = needs(opts, [:range, :files, :x, :y, :width, :height, :alpha, :layout, :blend, :angle])
       Dir.chdir(@img_dir) do
         @progress_bar.start('Loading PNG(s)', opts[:range].size) do |bar|
           opts[:range].each do |i|
-            @cards[i].png(opts[:file][i], opts[:x][i], opts[:y][i],
+            @cards[i].png(opts[:file][i],
+                          opts[:x][i], opts[:y][i], opts[:width][i], opts[:height][i],
                           opts[:alpha][i], opts[:blend][i], opts[:angle][i])
             bar.increment
           end
@@ -41,10 +43,10 @@ module Squib
     # @option opts file [String] ('') file(s) to read in. If it's a single file, then it's use for every card in range. If the parameter is an Array of files, then each file is looked up for each card. If any of them are nil or '', nothing is done. See {file:README.md#Specifying_Files Specifying Files}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @option opts id [String] (nil) if set, then only render the SVG element with the given id. Prefix '#' is optional. Note: the x-y coordinates are still relative to the SVG document's page. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @option opts force_id [Boolean] (false) if set, then this svg will not be rendered at all if the id is empty or nil. If not set, the entire SVG is rendered. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts x [Integer] (0) the x-coordinate to place. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts y [Integer] (0) the y-coordinate to place. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts width [Integer] (:native) the pixel width that the image should scale to. SVG scaling is done with vectors, so the scaling should be smooth. When set to `:native`, uses the DPI and units of the loaded SVG document. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts height [Integer] (:native) the pixel width that the image should scale to. SVG scaling is done with vectors, so the scaling should be smooth. When set to `:native`, uses the DPI and units of the loaded SVG document. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
+    # @option opts x [Integer] (0) the x-coordinate to place. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts y [Integer] (0) the y-coordinate to place. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts width [Integer] (:native) the pixel width that the image should scale to. SVG scaling is done with vectors, so the scaling should be smooth. When set to `:native`, uses the DPI and units of the loaded SVG document. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts height [Integer] (:native) the pixel width that the image should scale to. SVG scaling is done with vectors, so the scaling should be smooth. When set to `:native`, uses the DPI and units of the loaded SVG document. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @option opts alpha [Decimal] (1.0) the alpha-transparency percentage used to blend this image. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @option opts blend [:none, :multiply, :screen, :overlay, :darken, :lighten, :color_dodge, :color_burn, :hard_light, :soft_light, :difference, :exclusion, :hsl_hue, :hsl_saturation, :hsl_color, :hsl_luminosity] (:none) the composite blend operator used when applying this image. See Blend Modes at http://cairographics.org/operators. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}

data/lib/squib/api/shapes.rb

@@ -9,16 +9,16 @@ module Squib
     # Options support Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     #
     # @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
-    # @option opts x [Integer] (0) the x-coordinate to place
-    # @option opts y [Integer] (0) the y-coordinate to place
-    # @option opts width [Integer] the width of the rectangle.
-    # @option opts height [Integer] the height of the rectangle.
-    # @option opts x_radius [Integer] (0) the radius of the rounded corner horiztonally. Zero is a non-rounded corner.
-    # @option opts y_radius [Integer] (0) the radius of the rounded corner vertically. Zero is a non-rounded corner.
-    # @option opts radius [Integer] (nil) when set, overrides both x_radius and y_radius
+    # @option opts x [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts y [Integer] (0) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts width [Integer] the width of the rectangle. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts height [Integer] the height of the rectangle. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts x_radius [Integer] (0) the radius of the rounded corner horiztonally. Zero is a non-rounded corner. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts y_radius [Integer] (0) the radius of the rounded corner vertically. Zero is a non-rounded corner. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts radius [Integer] (nil) when set, overrides both x_radius and y_radius. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts fill_color [String] ('#0000') the color with which to fill the rectangle
     # @option opts stroke_color [String] (:black) the color with which to stroke the outside of the rectangle
-    # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke
+    # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}
     # @return [nil] intended to be void
     # @api public
@@ -41,16 +41,16 @@ module Squib
     # Options support Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     #
     # @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
-    # @option opts x [Integer] (0) the x-coordinate to place
-    # @option opts y [Integer] (0) the y-coordinate to place
-    # @option opts radius [Integer] (100) radius of the circle
+    # @option opts x [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts y [Integer] (0) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts radius [Integer] (100) radius of the circle. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts fill_color [String] ('#0000') the color with which to fill the rectangle
     # @option opts stroke_color [String] (:black) the color with which to stroke the outside of the rectangle
-    # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke
+    # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @return [nil] intended to be void
     # @api public
     def circle(opts = {})
-      opts = {radius: 100}.merge(opts)
+      opts = {radius: 100}.merge(opts) # overriding the non-system default
       opts = needs(opts, [:range, :x, :y, :circle_radius, :layout,
                           :fill_color, :stroke_color, :stroke_width])
       opts[:range].each do |i|
@@ -67,15 +67,15 @@ module Squib
     # Options support Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     #
     # @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
-    # @option opts x1 [Integer] (0) the x-coordinate to place
-    # @option opts y1 [Integer] (0) the y-coordinate to place
-    # @option opts x2 [Integer] (50) the x-coordinate to place
-    # @option opts y2 [Integer] (50) the y-coordinate to place
-    # @option opts x3 [Integer] (0) the x-coordinate to place
-    # @option opts y3 [Integer] (50) the y-coordinate to place
+    # @option opts x1 [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts y1 [Integer] (0) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts x2 [Integer] (50) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts y2 [Integer] (50) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts x3 [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts y3 [Integer] (50) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts fill_color [String] ('#0000') the color with which to fill the triangle
     # @option opts stroke_color [String] (:black) the color with which to stroke the outside of the triangle
-    # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke
+    # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @return [nil] intended to be void
     # @api public
     def triangle(opts = {})
@@ -96,12 +96,12 @@ module Squib
     #   triangle :x1 => 0, :y1 => 0, :x2 => 50, :y2 => 50
     #
     # @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
-    # @option opts x1 [Integer] (0) the x-coordinate to place
-    # @option opts y1 [Integer] (0) the y-coordinate to place
-    # @option opts x2 [Integer] (50) the x-coordinate to place
-    # @option opts y2 [Integer] (50) the y-coordinate to place
+    # @option opts x1 [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts y1 [Integer] (0) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts x2 [Integer] (50) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts y2 [Integer] (50) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts stroke_color [String] (:black) the color with which to stroke the line
-    # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke
+    # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @return [nil] intended to be void
     # @api public
     def line(opts = {})

data/lib/squib/api/text.rb

@@ -20,12 +20,12 @@ module Squib
     #   This [description](http://www.pygtk.org/pygtk2reference/class-pangofontdescription.html) is also quite good.
     #   See the {file:samples/text-options.rb samples/text.rb} as well.
     # @option opts font_size [Integer] (nil) an override of font string description, for scaling the font according to the size of the string
-    # @option opts x [Integer] (0) the x-coordinate to place
-    # @option opts y [Integer] (0) the y-coordinate to place
+    # @option opts x [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts y [Integer] (0) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts color [String] (:black) the color the font will render to. See {file:README.md#Specifying_Colors Specifying Colors}
     # @option opts markup: [Boolean] (false) Enable markup parsing of `str` using the HTML-like Pango Markup syntax, defined [here](http://ruby-gnome2.sourceforge.jp/hiki.cgi?pango-markup) and [here](https://developer.gnome.org/pango/stable/PangoMarkupFormat.html).
-    # @option opts width [Integer, :native] (:native) the width of the box the string will be placed in. Stretches to the content by default.
-    # @option opts height [Integer, :native] the height of the box the string will be placed in. Stretches to the content by default.
+    # @option opts width [Integer, :native] (:native) the width of the box the string will be placed in. Stretches to the content by default.. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts height [Integer, :native] the height of the box the string will be placed in. Stretches to the content by default. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}
     # @option opts wrap [:none, :word, :char, :word_char, true, false] (:word_char) When height is set, determines the behavior of how the string wraps. The `:word_char` option will break at words, but then fall back to characters when the word cannot fit.    #
     #   Options are `:none, :word, :char, :word_char`. Also: `true` is the same as `:word_char`, `false` is the same as `:none`. Default `:word_char`

data/lib/squib/api/units.rb

@@ -1,3 +1,5 @@
+require 'squib/constants'
+
 module Squib
   class Deck
 
@@ -10,7 +12,19 @@ module Squib
     # @return [Decimal] the number of pixels, according to the deck's DPI
     # @api public
     def inches(n)
-      @dpi * n
+      @dpi * n.to_f
+    end
+
+    # Given cm, returns the number of pixels according to the deck's DPI.
+    #
+    # @example
+    #   cm(1) # 750 (for default Deck::dpi of 300)
+    #
+    # @param n [Decimal], the number of centimeters
+    # @return [Decimal] the number of pixels, according to the deck's DPI
+    # @api public
+    def cm(n)
+      @dpi * Squib::INCHES_IN_CM * n.to_f
     end
 
   end

data/lib/squib/card.rb

@@ -22,6 +22,9 @@ module Squib
     @cairo_context = Cairo::Context.new(@cairo_surface)
   end
 
+  # A save/restore wrapper for using Cairo
+  # :nodoc:
+  # @api private
   def use_cairo(&block)
     @cairo_context.save
     block.yield(@cairo_context)

data/lib/squib/constants.rb

@@ -8,6 +8,7 @@ module Squib
       :angle => 0,
       :blend => :none,
       :color => :black,
+      :columns => 1,
       :default_font => 'Arial 36',
       :dir => '_output',
       :ellipsize => :end,
@@ -27,6 +28,7 @@ module Squib
       :progress_bar => false,
       :range => :all,
       :rotate => false,
+      :rows => :infinite,
       :sheet => 0,
       :spacing => 0,
       :str => '',
@@ -62,7 +64,7 @@ module Squib
     # These are parameters that are intended to be "expanded" across
     # range if they are singletons.
     #
-    # For example, using a different font for each card, using one `text`
+    # For example: using a different font for each card, using one `text` command
     #
     # key: the internal name of the param (e.g. :files)
     # value: the user-facing API key (e.g. file: 'abc.png')
@@ -106,4 +108,35 @@ module Squib
           :y3 => :y3,
           :y_radius => :y_radius,
       }
+
+    # These parameters are considered for unit conversion
+    #
+    # For example
+    #    text str: 'Hello, World', x: '1in'
+    #
+    # key: the internal name of the param (e.g. :circle_radius)
+    # value: the user-facing API key (e.g. radius: '1in')
+    UNIT_CONVERSION_PARAMS = {
+      :circle_radius => :radius,
+      :height => :height,
+      :rect_radius => :radius,
+      :spacing => :spacing,
+      :stroke_width => :stroke_width,
+      :width => :width,
+      :x => :x,
+      :x1 => :x1,
+      :x2 => :x2,
+      :x3 => :x3,
+      :x_radius => :x_radius,
+      :y => :y,
+      :y1 => :y1,
+      :y2 => :y2,
+      :y3 => :y3,
+      :y_radius => :y_radius,
+    }
+
+    # Used for inch-cm conversion
+    # :nodoc:
+    # @api private
+    INCHES_IN_CM = 0.393700787
 end

data/lib/squib/deck.rb

@@ -115,7 +115,7 @@ module Squib
         thefile = file
         thefile = "#{File.dirname(__FILE__)}/layouts/#{file}" unless File.exists?(file)
         if File.exists? thefile
-          yml = @layout.merge(YAML.load_file(thefile))
+          yml = @layout.merge(YAML.load_file(thefile) || {}) #load_file returns false on empty file
           yml.each do |key, value|
             @layout[key] = recurse_extends(yml, key, {})
           end
@@ -157,7 +157,7 @@ module Squib
     # :nodoc:
     # @api private
     def has_extends?(yml, key)
-      yml[key].key?('extends')
+      !!yml[key] && yml[key].key?('extends')
     end
 
     # Safeguard against malformed circular extends
@@ -169,6 +169,9 @@ module Squib
       end
     end
 
+    # Use Logger to show more detail on the run
+    # :nodoc:
+    # @api private
     def show_info(config, layout)
       Squib::logger.info "Squib v#{Squib::VERSION}"
       Squib::logger.info "  building #{@cards.size} #{@width}x#{@height} cards"