squib 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bea6b35bd0a52513549271342876629145edc365
-  data.tar.gz: 83fb26dfa8728b5c0256cb739e52cb50ba3b7635
+  metadata.gz: e26629b35f921713b8003d6ece20b788c5789645
+  data.tar.gz: 06b9837f88b86f6e4ddde9f9a2c603b6992a26e8
 SHA512:
-  metadata.gz: 07f89f00d8bdc62b8fe11f0a91523ba914272ac7ff721f0943ac814160a9fbe42da279463ca218aa11f9a32d126e1b7403c48dc591a357e806638d42849ff09a
-  data.tar.gz: 5db0aa2a77869cf5b0e5518399bfc9640944f969a09a1735a33c99b22f221a8d166aff9c309eea6a4a8fad57a857aa0a6edc4d81b3f940adad66388288f3646a
+  metadata.gz: c003650e034993f12f72a7a58dc781b8e64aea6989081d5cd09683cf49179adac35e7887bb4b3274c9829eb70f08c4912b615d5495fa18fd28cacf49cc319809
+  data.tar.gz: 4d308545d618bb3f2d56481eade0d27e60985c169444007d255079b74344e38d050facab2aa905c4786a2b9950171e6ef95b83b512c502c89dc3e144aa558347

data/.gitignore

@@ -33,3 +33,5 @@ benchmarks/_output/*.pdf
 benchmarks/_output/
 samples/_output/*.svg
 *.sublime-workspace
+spec/samples/sanity.html
+spec/samples/_diffs/*.png

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -1,31 +1,69 @@
 # Squib CHANGELOG
+Squib follows [semantic versioning](http://semver.org).
 
-## v0.5.1
-* [BUG] Fixed a PDF scaling issue, so now page width and height is properly calculated from DPI (#62)
+## v0.6.0 / Unreleased
+
+Features:
+* Added `data` field to `svg` to allow for manipulating SVG XML data directly. Works nicely with my new `game_icons` [gem](https://github.com/andymeneely/game_icons) (#65)
+* Added `stroke_width` and `stroke_color` to the `text` method to outlines text. (#51)
+* Added `hand` method that draws cards around a circle. See hand.rb samples (#64)
+* Added an `ellipse` method to (you guessed it) draw ellipses. See the draw_shapes.rb sample (#66)
+* Added a `star` method to (you guessed it) draw stars. See the draw_shapes.rb sample (#72)
+* Added a `polygon` method to (you guessed it) draw polygons. See the draw_shapes.rb sample (#67)
+* Upgraded roo (Excel parsing) to 2.0.0. Nothing major for Squib users, just keeping up with the times.
+
+Bugs:
+* Text embed svg and png commands default to integer so the README example works (#73).
+* Fixed global text hinting (#63)
+* Fixed a broken promise about fill_color in `showcase` (#71)
+
+Compatbility:
+* rsvg2 and pango updated to v2.2.5. Squib follows 2.2.x of both of those. If you run `bundle` you will automatically be upgraded. They appear to be mostly bugfix releases.
+* dpi is currently removed from `config.yml` and is ONLY available in `Squib::Deck.new`. This may change in the future, however.
+
+Chores:
+* Massive internal redesigning of the way configuration options are parsed, stored, handled. No real changes are visible to the user, but this code will be more maintainable and open up the door for more flexible configuration options in the future.
+* Added `rake sanity` as a visual regression test to ensure the samples don't break
+* Lots of automated test refactoring
+
+Thanks to [pickfifteen](https://github.com/pickfifteen), and [Brian Cronin](http://www.boardgamegeek.com/user/MurphyIdiot) for the bug reports!
+
+## v0.5.1 / 2015-04-13
+
+Bugs:
+* Fixed a PDF scaling issue, so now page width and height is properly calculated from DPI (#62)
 
 Thanks to [Brian Cronin](http://www.boardgamegeek.com/user/MurphyIdiot) for the bug report.
 
-## v0.5.0
+## v0.5.0 / 2015-04-13
+Features:
 * Embedding of SVGs and PNGs into text! See README, `text_options.rb`, and `embed_text.rb`, and API documentation. This was a finnicky feature, so feedback and bug reports are welcome. (#30)
 * Curves! We can now do Bezier curves. Documented, and added to the sample `draw_shapes.rb` (#37).
 * Smart Quotes! The `text` rule now has a `quotes: 'smart'` option where straight quotes get converted to curly quotes. Assumes UTF-8, or you can specify your own quote characters if you're not in UTF-8. (#50)
+* Font-level antialiasing is inherited from global antialiasing setting (workaround until we get a better solution for #59).
 
 Known issues
 * OSX Yosemite will show this warning: `<Error>: The function ‘CGFontGetGlyphPath’ is obsolete and will be removed in an upcoming update. Unfortunately, this application, or a library it uses, is using this obsolete function, and is thereby contributing to an overall degradation of system performance.` This warning will go away when the Ruby Cairo bindings upgrades from 1.14.1 to 1.14.2.
 
 Special thanks to [pickfifteen](https://github.com/pickfifteen) for testing, feedback, and pull requests!!
 
-## v0.4.0
+## v0.4.0 / 2015-04-28
+
+Features:
 * SVG backend support! You can now set the deck's back end to work with SVGs instead of images, making the resulting PDFs vectorized. (You can still save to PNGs too.) This was a big change for Squib, and it's got at least one known issue and probably a few more here and there. See discussion on the README for more details.
 * Added config option for antialiasing method. My benchmarks showed that 'best' is only 10% slower than 'fast' on extremely alias-intensive tasks, so 'best' is the Squib default now.
-* Bugfix: Stray stroke on circles after text (#35)
-* Bugfix: Progress bar increment error (#34)
+
+Bugs:
+* Stray stroke on circles after text (#35)
+* Progress bar increment error (#34)
 
 Known issues
 * Masking SVGs onto an SVG backend will rasterize as an intermediate step. (#43)
 * Compatibility change: gradient coordinates for the `mask` option in `svg` and `png` commands are relative to the given x,y - NOT to card as it was before.
 
-## v0.3.0
+## v0.3.0 / 2015-02-02
+
+Features:
 * Masks! The `png` and `svg` commands can be used as if they are a mask, so you can color the icon with any color you like. Can be handy for switching to black-and-white, or for reusing the same image but different colors across cards.
 * Gradients! Can now specify linear or radial gradients anywhere you specify colors. See README and `samples/gradients.rb` for more details.
 * Number padding! `save_png` will now pad zeros on the filenames for friendlier sorting. You can also specify your own with `count_format` using the classical format string from Ruby's `Kernel::sprintf` (mostly just C-style format strings). Default: `'%02d'. The `prefix:` option is still there too.
@@ -35,29 +73,39 @@ Known issues
 
 Special thanks to [Shalom Craimer](https://github.com/scraimer) for the idea and proof-of-concept on gradient and mask features!
 
-## v0.2.0
+## v0.2.0 / 2015-01-12
+
+Features:
 * Added `showcase` feature to create a fancy-looking 3D reflection to showcase your cards. Documented, tested, and added a sample for it.
 * Added a basic Rakefile, documented in README.
 * Some internal refactoring, better testing, and more documentation with layouts
 
-## v0.1.0
+## v0.1.0 / 2014-12-31
+
+Features:
 * 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
+
+Chores:
 * More obsessive automated testing and continuous integration work.
 
-## v0.0.6
+## v0.0.6 / 2014-12-08
+
+Features:
 * 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`
+
+Chores:
 * 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
+## v0.0.5 / 2014-11-03
 * Image rotation for png and svg via `angle`
 * New sample for demonstrating direct cairo access
 * README now includes a snazzy screencast of the Sublime snippets
@@ -66,7 +114,7 @@ Special thanks to [Shalom Craimer](https://github.com/scraimer) for the idea and
 * Better unit testing, now with mocking!
 * Various version bumps: rspec, yard
 
-## v0.0.4
+## v0.0.4 / 2014-10-17
 * Added a font size override so you can vary the font size with the same style across strings more easily
 * Added text autoscale sample
 * Added `extends` to custom layouts, allowing ways to modify parent data instead of just overriding it.
@@ -75,11 +123,11 @@ Special thanks to [Shalom Craimer](https://github.com/scraimer) for the idea and
 * Fixed a mapping problem with triangles (thanks novalis!)
 * Fixed global hint togglability
 
-## v0.0.3
+## v0.0.3 / 2014-08-30
 * Redesigned the dynamic options system to make adding new commands much easier
 * Singleton expansion
 * Better documentation in README and throughout
 * Implemented Junk Land in this version
 
-## v0.0.1-v0.0.2
+## v0.0.1-v0.0.2 / 2014-07-29
 * Primordial era - base functionality

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'yard', :git => 'git://github.com/lsegal/yard', :branch => "frameless"
+gem 'yard', :git => 'git://github.com/lsegal/yard', :branch => "master"

data/README.md

@@ -88,7 +88,8 @@ About the other files:
 In addition to this README, be sure to also check out the following resources for more details:
 
 * 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.
+* [Iconoclast](https://github.com/andymeneely/iconoclast) is a basic set collection game I'm developing from scratch with Squib. Be sure to read the [commit history](https://github.com/andymeneely/iconoclast/commits/master) to see how the game has developed from scratch.
+* [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.
 
 ## Viewing this README
 
@@ -151,12 +152,10 @@ Most public `Deck` methods allow a `range` to be specified as a first parameter.
 
 ## 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. 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)
+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`). 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). We are also working on support for unit conversion within layout parsing, so using it as a part of `extends` is not yet supported.
-
 ## Specifying Colors & Gradients
 
 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)
@@ -439,16 +438,21 @@ Fortunately, switching backends in Squib should be as trivial as changing the se
 Squib supports various configuration properties that can be specified in an external file. The `config:` option in `Deck.new` can specify an optional configuration file in YML format. The properties there are intended to be immutable for the life of the Deck. The options include:
 
 * `progress_bars` (Boolean, default: false).  When set to `true`, long-running operations will show a progress bar on the command line.
-* `dpi` (Integer, default: 300). Used in calculations when units are used (e.g. for PDF rendering and unit conversion).
 * `hint` (ColorString, default: off). Text hints are used to show the boundaries of text boxes. Can be enabled/disabled for individual commands, or set globally with the `set` command. This setting is overriden by `set` and individual commands.
 * `custom_colors` (Hash of Colors, default: {}). Defines globally-available colors available to the deck that can be specified in commands.
 * `antialias` (`fast, good, best, none, gray, subpixel`, default: best). Set the algorithm that Cairo will use for antialiasing. Using our benchmarks on large decks, `best` is only ~10% slower anyway. For more info see the [Cairo docs](http://www.cairographics.org/manual/cairo-cairo-t.html#cairo-antialias-t).
 * `backend` (`svg` or `memory`, default: `memory`). Defines how Cairo will store the operations. Memory is recommended for higher quality rendering.
 * `prefix` (default: `card_`). When using an SVG backend, cards are auto-saved with this prefix and `"%02d"` numbering format.
 
-The following sample demonstrates the config file.
+For debugging/sanity purposes, if you want to make sure your configuration options are parsed correclty, the above options are also available as methods within Squib::Deck, for example:
+
+```ruby
+Squib::Deck.new do
+  puts backend # prints 'memory' by default
+end
+```
 
-See the `custom_config` sample found [here](https://github.com/andymeneely/squib/tree/master/samples/)
+The following sample demonstrates the config file, found [here](https://github.com/andymeneely/squib/tree/master/samples/)
 
 {include:file:samples/custom_config.rb}
 
@@ -519,11 +523,11 @@ Feel free to [file a bug or feature request](https://github.com/andymeneely/squi
 
 If you want to test new features as I develop them, you can always point your Gemfile to the repository. Your Gemfile specification looks like this:
 
-```
-gem 'squib', :git => 'git://github.com/andymeneely/squib', :branch => "dev"
+```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 that are done and tested, but not released yet.
+* The `master` branch is where I consider features and bug that are done and tested, but not released yet.
 
 ## Contributing
 
@@ -535,6 +539,8 @@ If you want your code integrated:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+Be sure to run the unit tests and packaging with just `rake`. Also, you can check that the samples render properly with `rake sanity`.
+
 # 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:

data/RELEASE TODO.md

@@ -4,9 +4,10 @@ Be sure to remember to do the following for releases. (Copy into a GitHub issue)
  - [ ] README is updated
  - [ ] Samples are updated
  - [ ] `rake doc`
- - [ ] Check that sample regression tests are all enabled
+ - [ ] Check `sample_regression_spec.rb` regression tests are all enabled (i.e. `overwrite_sample` is commented out)
  - [ ] Bump version.rb
  - [ ] Do a full rake locally
+ - [ ] `rake sanity`, and check visually
  - [ ] Travis is passing on dev branch
  - [ ] Merge master branch
  - [ ] Create GitHub release tag

data/Rakefile

@@ -20,6 +20,10 @@ end
 
 RSpec::Core::RakeTask.new(:spec)
 
+RSpec::Core::RakeTask.new(:spec_fastonly) do |t|
+  t.rspec_opts = "--tag ~slow"
+end
+
 task doc: [:yarddoc, :apply_google_analytics]
 
 YARD::Rake::YardocTask.new(:yarddoc) do |t|
@@ -40,6 +44,13 @@ task benchmark: [:install] do
   end
 end
 
+task :sanity do
+  require_relative 'spec/samples/sanity.rb'
+  Sanity.new.run
+end
+
+task sanity_clean: [:install, :spec, :sanity]
+
 task :apply_google_analytics do
   # The string to replace in the html document. This is chosen to be the end
   # body </body> tag. So the script can be injected as the last thing in the

data/lib/squib/api/data.rb

@@ -24,15 +24,15 @@ module Squib
   def xlsx(opts = {})
     opts = Squib::SYSTEM_DEFAULTS.merge(opts)
     opts = Squib::InputHelpers.fileify(opts)
-    s = Roo::Excelx.new(opts[:file])
+    s    = Roo::Excelx.new(opts[:file])
     s.default_sheet = s.sheets[opts[:sheet]]
     data = {}
     s.first_column.upto(s.last_column) do |col|
       header = s.cell(s.first_row,col).to_s
       data[header] = []
-      (s.first_row+1).upto(s.last_row) do |row|
+      (s.first_row + 1).upto(s.last_row) do |row|
         cell = s.cell(row,col)
-        # Roo hack for avoiding unnecessary .0's on whole integers
+        # Roo hack for avoiding unnecessary .0's on whole integers (https://github.com/roo-rb/roo/issues/139)
         cell = s.excelx_value(row,col) if s.excelx_type(row,col) == [:numeric_or_formula, 'General']
         data[header] << cell
       end#row

data/lib/squib/api/image.rb

@@ -22,7 +22,7 @@ module Squib
     # @api public
     def png(opts = {})
       opts = needs(opts, [:range, :files, :x, :y, :width, :height, :alpha, :layout, :blend, :angle, :mask])
-      Dir.chdir(@img_dir) do
+      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],
@@ -34,7 +34,7 @@ module Squib
       end
     end
 
-    # Renders an entire svg file at the given location. Uses the SVG-specified units and DPI to determine the pixel width and height.
+    # Renders an entire svg file at the given location. Uses the SVG-specified units and DPI to determine the pixel width and height.  If neither data nor file are specified for a given card, this method does nothing.
     #
     # See {file:samples/load-images.rb samples/load-images.rb} and {file:samples/tgc-overlay.rb samples/tgc-overlay.rb} as examples.
     # @example
@@ -42,6 +42,7 @@ module Squib
     #
     # @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] ('') 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 data [String] (nil) render from an SVG XML string. Overrides file if both are specified (a warning is shown) . 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}. Supports Unit Conversion, see {file:README.md#Units Units}.
@@ -56,12 +57,13 @@ module Squib
     # @return [nil] Returns nil
     # @api public
     def svg(opts = {})
-      p = needs(opts,[:range, :files, :svgid, :force_svgid, :x, :y, :width, :height, :layout, :alpha, :blend, :angle, :mask])
-      Dir.chdir(@img_dir) do
+      p = needs(opts,[:range, :files, :svgdata, :svgid, :force_svgid, :x, :y, :width, :height, 
+                      :layout, :alpha, :blend, :angle, :mask])
+      Dir.chdir(img_dir) do
         @progress_bar.start('Loading SVG(s)', p[:range].size) do |bar|
           p[:range].each do |i|
             unless p[:force_id][i] && p[:id][i].to_s.empty?
-              @cards[i].svg(p[:file][i], p[:id][i], p[:x][i], p[:y][i],
+              @cards[i].svg(p[:file][i], p[:data][i], p[:id][i], p[:x][i], p[:y][i],
                             p[:width][i], p[:height][i], p[:alpha][i], p[:blend][i], p[:angle][i],p[:mask][i])
             end
             bar.increment

data/lib/squib/api/save.rb

@@ -39,7 +39,7 @@ module Squib
       end
     end
 
-    # Renders a range of files in a showcase as if they are sitting on a reflective surface
+    # Renders a range of cards in a showcase as if they are sitting in 3D on a reflective surface
     # See {file:samples/showcase.rb} for full example
     #
     # @example
@@ -51,7 +51,7 @@ module Squib
     # @option opts [Fixnum] margin (75) the margin around the entire showcase
     # @option opts [Fixnum] scale (0.8) percentage of original width of each (trimmed) card to scale to. Must be between 0.0 and 1.0, but starts looking bad around 0.6.
     # @option opts [Fixnum] offset (1.1) percentage of the scaled width of each card to shift each offset. e.g. 1.1 is a 10% shift, and 0.95 is overlapping by 5%
-    # @option opts [String, Color] fill_color (:white) backdrop color. Usually black or white.
+    # @option opts [String, Color] fill_color (:white) backdrop color. Usually black or white. Supports gradients.
     # @option opts [Fixnum] reflect_offset (15) the number of pixels between the bottom of the card and the reflection
     # @option opts [Fixnum] reflect_strength (0.2) the starting alpha transparency of the reflection (at the top of the card). Percentage between 0 and 1. Looks more realistic at low values since even shiny surfaces lose a lot of light.
     # @option opts [Fixnum] reflect_percent (0.25) the length of the reflection in percentage of the card. Larger values tend to make the reflection draw just as much attention as the card, which is not good.
@@ -70,5 +70,34 @@ module Squib
                       opts[:dir], opts[:file])
     end
 
+    # Renders a range of cards fanned out as if in a hand. Saves as PNG.
+    # See {file:samples/hand.rb} for full example
+    #
+    # @example
+    #   hand range: :all, radius: :auto, margin: 20, fill_color: :white,
+    #        angle_range: (Math::PI / -4.0)..(Math::PI / 2),
+    #        dir: '_output', file: 'hand1.png'
+    #
+    # @option opts [Enumerable, :all] range (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
+    # @option opts [Fixnum] radius (:auto) the distance from the bottom of each card to the center of the fan. If set to `:auto`, then it is computed as 30% of the card's height.
+    # @option opts [Range] angle_range: ((Math::PI / -4.0)..(Math::PI / 2)). The overall width of the fan, in radians. Angle of zero is a vertical card. Further negative angles widen the fan counter-clockwise and positive angles widen the fan clockwise.
+    # @option opts [Fixnum] trim (0) the margin around the card to trim before putting into the image
+    # @option opts [Fixnum] trim_radius (0) the rounded rectangle radius around the card to trim before putting into the showcase
+    # @option opts [Fixnum] margin (75) the margin around the entire image
+    # @option opts [String, Color] fill_color (:white) backdrop color. Usually black or white. Supports gradients.
+    # @option opts [String] dir (_output) the directory for the output to be sent to. Will be created if it doesn't exist.
+    # @option opts [String] file ('hand.png') the file to save in dir. Will be overwritten.
+    # @return [nil] Returns nothing.
+    # @api public
+    def hand(opts = {})
+      opts = {file: 'hand.png', fill_color: :white, radius: :auto, trim_radius: 0}
+             .merge(opts)
+      opts = needs(opts,[:range, :margin, :trim, :trim_radius, :creatable_dir, :file_to_save])
+      opts[:radius] = 0.3 * height if opts[:radius] == :auto
+      render_hand(opts[:range], opts[:radius], opts[:angle_range],
+                  opts[:trim], opts[:trim_radius], opts[:margin],
+                  opts[:fill_color], opts[:dir], opts[:file])
+    end
+
   end
 end

data/lib/squib/api/settings.rb

@@ -13,7 +13,7 @@ module Squib
     # @return [nil] Returns nothing
     # @api public
     def hint(text: :off)
-      @text_hint = text
+      conf.text_hint = text
     end
 
     # Sets various defaults for this deck. Defaults can be overriden by the commands themselves when that command supports it.

data/lib/squib/api/shapes.rb

@@ -47,6 +47,7 @@ module Squib
     # @option opts fill_color [String] ('#0000') the color with which to fill the rectangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
     # @option opts stroke_color [String] (:black) the color with which to stroke the outside of the rectangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
     # @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
     def circle(opts = {})
@@ -59,6 +60,34 @@ module Squib
       end
     end
 
+    # Draw an ellipse
+    #
+    # @example
+    #   ellipse x: 0, y: 0, width: 825, height: 1125
+    #
+    # 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. 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 fill_color [String] ('#0000') the color with which to fill the rectangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
+    # @option opts stroke_color [String] (:black) the color with which to stroke the outside of the rectangle. {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
+    # @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
+    def ellipse(opts = {})
+      opts = needs(opts, [:range, :x, :y, :width, :height,
+                          :fill_color, :stroke_color, :stroke_width, :layout])
+      opts[:range].each do |i|
+        @cards[i].ellipse(opts[:x][i], opts[:y][i], opts[:width][i], opts[:height][i],
+                          opts[:fill_color][i], opts[:stroke_color][i],
+                          opts[:stroke_width][i])
+      end
+    end
+
     # Draw a triangle using the given coordinates
     #
     # @example
@@ -76,6 +105,7 @@ module Squib
     # @option opts fill_color [String] ('#0000') the color with which to fill the triangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
     # @option opts stroke_color [String] (:black) the color with which to stroke the outside of the triangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
     # @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
     def triangle(opts = {})
@@ -102,6 +132,7 @@ module Squib
     # @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. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
     # @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
     def line(opts = {})
@@ -126,6 +157,8 @@ module Squib
     # @option opts cy2 [Integer] (50) the y-coordinate of the second control point. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts stroke_color [String] (:black) the color with which to stroke the line. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
     # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts fill_color [String] ('#0000') the color with which to fill the triangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
+    # @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
     def curve(opts = {})
@@ -138,5 +171,58 @@ module Squib
       end
     end
 
+    # Draw a star at the given x,y
+    # @example
+    #   star x: 10, y: 10, n: 5, angle: Math::PI / 4, inner_radius: 50, outer_radius: 100,
+    #        fill_color: :green, stroke_color: :burgundy, :stroke_width: 3
+    #
+    # @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 [Fixnum] (0) the x-coordinate of the center. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts y [Fixnum] (0) the y-coordinate of the center. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts n [Integer] (5) the number of points on the star
+    # @option opts angle [Fixnum] (0) the angle at which to rotate
+    # @option opts inner_radius [Fixnum] (0) the inner radius. Supports Unit conversion.
+    # @option opts stroke_color [String] (:black) the color with which to stroke the line. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
+    # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts fill_color [String] ('#0000') the color with which to fill the triangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
+    # @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
+    def star(opts = {})
+      opts = needs(opts, [:range, :x, :y, :n, :angle, :inner_radius, :outer_radius,
+                          :layout, :fill_color, :stroke_color, :stroke_width])
+      opts[:range].each do |i|
+        @cards[i].star(opts[:x][i], opts[:y][i], opts[:n][i], opts[:angle][i],
+                        opts[:inner_radius][i], opts[:outer_radius][i],
+                        opts[:fill_color][i], opts[:stroke_color][i],
+                        opts[:stroke_width][i])
+      end
+    end
+
+    # Draw a regular polygon at the given x,y
+    # @example
+    #   polygon x: 10, y: 10, n: 5, angle: Math::PI / 4, radius: 50,
+    #           fill_color: :green, stroke_color: :burgundy, :stroke_width: 3
+    #
+    # @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 [Fixnum] (0) the x-coordinate of the center. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts y [Fixnum] (0) the y-coordinate of the center. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts n [Integer] (5) the number of points on the star
+    # @option opts angle [Fixnum] (0) the angle at which to rotate
+    # @option opts stroke_color [String] (:black) the color with which to stroke the line. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
+    # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @option opts fill_color [String] ('#0000') the color with which to fill the triangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
+    # @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
+    def polygon(opts = {})
+      opts = needs(opts, [:range, :x, :y, :n, :circle_radius, :angle, :layout, :fill_color, :stroke_color, :stroke_width])
+      opts[:range].each do |i|
+        @cards[i].polygon(opts[:x][i], opts[:y][i], opts[:n][i], opts[:angle][i], opts[:radius][i],
+                        opts[:fill_color][i], opts[:stroke_color][i],
+                        opts[:stroke_width][i])
+      end
+    end
+
   end
 end