squib 0.6.0 → 0.7.0

data/lib/squib/api/image.rb

@@ -1,76 +1,90 @@
-module Squib
-  class Deck
-
-    # 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.
-    # @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}. 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}
-    # @option opts angle [FixNum] (0) Rotation of the in radians. Note that this rotates around the upper-left corner, making the placement of x-y coordinates slightly tricky. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts mask [String] (nil) If specified, the image will be used as a mask for the given color/gradient. Transparent pixels are ignored, opaque pixels are the given color. Note: the origin for gradient coordinates is at the given x,y, not at 0,0 as it is most other places.
-    # @return [nil] Returns nil
-    # @api public
-    def png(opts = {})
-      opts = needs(opts, [:range, :files, :x, :y, :width, :height, :alpha, :layout, :blend, :angle, :mask])
-      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], opts[:width][i], opts[:height][i],
-                          opts[:alpha][i], opts[:blend][i], opts[:angle][i], opts[:mask][i])
-            bar.increment
-          end
-        end
-      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.  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
-    #   svg 1..2, 'icon.svg', '#stone', 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] ('') 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}.
-    # @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}
-    # @option opts angle [FixNum] (0) Rotation of the in radians. Note that this rotates around the upper-left corner, making the placement of x-y coordinates slightly tricky. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts mask [String] (nil) If specified, the image will be used as a mask for the given color/gradient. Transparent pixels are ignored, opaque pixels are the given color. Note: the origin for gradient coordinates is at the given x,y, not at 0,0 as it is most other places.
-    # @return [nil] Returns nil
-    # @api public
-    def svg(opts = {})
-      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[: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
-          end
-        end
-      end
-    end
-
-  end
-end
+require 'squib/args/card_range'
+require 'squib/args/paint'
+require 'squib/args/scale_box'
+require 'squib/args/transform'
+require 'squib/args/input_file'
+require 'squib/args/svg_special'
+
+module Squib
+  class Deck
+
+    # 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.
+    # @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}. 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, :scale, :deck] (:native) the pixel width that the image should scale to. :deck will scale to the deck width. :scale will use the height to scale and keep native the aspect ratio. 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, :scale, :deck] (:native) the pixel width that the image should scale to. :deck will scale to the deck height. :scale will use the width to scale and keep native the aspect ratio. 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}
+    # @option opts angle [FixNum] (0) Rotation of the in radians. Note that this rotates around the upper-left corner, making the placement of x-y coordinates slightly tricky. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
+    # @option opts mask [String] (nil) If specified, the image will be used as a mask for the given color/gradient. Transparent pixels are ignored, opaque pixels are the given color. Note: the origin for gradient coordinates is at the given x,y, not at 0,0 as it is most other places.
+    # @return [nil] Returns nil
+    # @api public
+    def png(opts = {})
+      Dir.chdir(img_dir) do
+        range = Args::CardRange.new(opts[:range], deck_size: size)
+        paint = Args::Paint.new(custom_colors).load!(opts, expand_by: size, layout: layout)
+        box   = Args::ScaleBox.new(self).load!(opts, expand_by: size, layout: layout, dpi: dpi)
+        trans = Args::Transform.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
+        ifile = Args::InputFile.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
+        @progress_bar.start('Loading PNG(s)', range.size) do |bar|
+          range.each do |i|
+            @cards[i].png(ifile[i].file, box[i], paint[i], trans[i])
+            bar.increment
+          end
+        end
+      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.  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.
+    #
+    # Note: if alpha transparency is desired, set that in the SVG.
+    #
+    # @example
+    #   svg range: 1..2, file: 'icon.svg', id: '#stone', 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] ('') 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}.
+    # @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. :deck will scale to the deck height. :scale will use the width to scale and keep native the aspect ratio. 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. :deck will scale to the deck height. :scale will use the width to scale and keep native the aspect ratio. 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 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}
+    # @option opts angle [FixNum] (0) Rotation of the in radians. Note that this rotates around the upper-left corner, making the placement of x-y coordinates slightly tricky. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
+    # @option opts mask [String] (nil) If specified, the image will be used as a mask for the given color/gradient. Transparent pixels are ignored, opaque pixels are the given color. Note: the origin for gradient coordinates is at the given x,y, not at 0,0 as it is most other places.
+    # @return [nil] Returns nil
+    # @api public
+    def svg(opts = {})
+      Dir.chdir(img_dir) do
+        range = Args::CardRange.new(opts[:range], deck_size: size)
+        paint = Args::Paint.new(custom_colors).load!(opts, expand_by: size, layout: layout)
+        box   = Args::ScaleBox.new(self).load!(opts, expand_by: size, layout: layout, dpi: dpi)
+        trans = Args::Transform.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
+        ifile = Args::InputFile.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
+        svg_args = Args::SvgSpecial.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
+        @progress_bar.start('Loading SVG(s)', range.size) do |bar|
+          range.each do |i|
+            if svg_args.render?(i)
+              @cards[i].svg(ifile[i].file, svg_args[i], box[i], paint[i], trans[i])
+            end
+            bar.increment
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/squib/api/save.rb

@@ -1,103 +1,149 @@
-module Squib
-  class Deck
-
-    # Saves the given range of cards to either PNG or PDF
-    #
-    # @option opts [Enumerable] range (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
-    # @option opts [String] dir (_output) the directory for the output to be sent to. Will be created if it doesn't exist.
-    # @option opts [Symbol] format (:png)  the format that this will be rendered too. Options `:pdf, :png`. Array of both is allowed: `[:pdf, :png]`
-    # @option opts [String] prefix (card_) the prefix of the file name to be printed
-    # @option opts [Boolean] rotate (false) PNG saving only. If true, the saved cards will be rotated 90 degrees clockwise. Intended to rendering landscape instead of portrait.
-    # @return self
-    # @api public
-    def save(opts = {})
-      # opts = needs(opts, [:range, :creatable_dir, :formats, :prefix, :rotate])
-      save_png(opts) if Array(opts[:format]).include? :png
-      save_pdf(opts) if Array(opts[:format]).include? :pdf
-      self
-    end
-
-    # Saves the given range of cards to a PNG
-    #
-    # @example
-    #   save range: 1..8, dir: '_pnp', prefix: 'bw_'
-    #
-    # @option opts [Enumerable] range (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
-    # @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] prefix (card_) the prefix of the file name to be printed.
-    # @option opts [String] count_format (%02d) the format string used for formatting the card count (e.g. padding zeros). Uses a Ruby format string (see the Ruby doc for Kernel::sprintf for specifics)
-    # @option opts [Boolean, :clockwise, :counterclockwise] rotate (false) if true, the saved cards will be rotated 90 degrees clockwise. Or, rotate by the number of radians. Intended to rendering landscape instead of portrait.
-    # @return [nil] Returns nothing
-    # @api public
-    def save_png(opts = {})
-      opts = needs(opts,[:range, :creatable_dir, :prefix, :count_format, :rotate])
-      @progress_bar.start("Saving PNGs to #{opts[:dir]}/#{opts[:prefix]}*", @cards.size) do |bar|
-        opts[:range].each do |i|
-          @cards[i].save_png(i, opts[:dir], opts[:prefix], opts[:count_format], opts[:rotate], opts[:angle])
-          bar.increment
-        end
-      end
-    end
-
-    # 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
-    #   showcase file: 'showcase_output.png', trim: 78, trim_radius: 32
-    #
-    # @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] trim (0) the margin around the card to trim before putting into the showcase
-    # @option opts [Fixnum] trim_radius (38) the rounded rectangle radius around the card to trim before putting into the showcase
-    # @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. 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.
-    # @option opts [:left, :right] face (:left) which direction the cards face. Anything but `:right` will face left
-    # @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 ('showcase.png') the file to save in dir. Will be overwritten.
-    # @return [nil] Returns nothing.
-    # @api public
-    def showcase(opts = {})
-      opts = {file: 'showcase.png', fill_color: :white}.merge(opts)
-      opts = needs(opts,[:range, :margin, :trim, :trim_radius, :creatable_dir, :file_to_save, :face])
-      render_showcase(opts[:range], opts[:trim], opts[:trim_radius],
-                      opts[:scale], opts[:offset], opts[:fill_color],
-                      opts[:reflect_offset], opts[:reflect_percent], opts[:reflect_strength],
-                      opts[:margin], opts[:face],
-                      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
+require 'squib/args/card_range'
+require 'squib/args/hand_special'
+require 'squib/args/save_batch'
+require 'squib/args/sheet'
+require 'squib/args/showcase_special'
+
+module Squib
+  class Deck
+
+    # Saves the given range of cards to either PNG or PDF
+    #
+    #
+    # @option opts [Enumerable] range (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
+    # @option opts [String] dir (_output) the directory for the output to be sent to. Will be created if it doesn't exist.
+    # @option opts [Symbol] format (:png)  the format that this will be rendered too. Options `:pdf, :png`. Array of both is allowed: `[:pdf, :png]`
+    # @option opts [String] prefix (card_) the prefix of the file name to be printed
+    # @option opts [Boolean] rotate (false) PNG saving only. If true, the saved cards will be rotated 90 degrees clockwise. Intended to rendering landscape instead of portrait.
+    # @return self
+    # @api public
+    def save(opts = {})
+      save_png(opts) if Array(opts[:format]).include? :png
+      save_pdf(opts) if Array(opts[:format]).include? :pdf
+      self
+    end
+
+    # Lays out the cards in range and renders a PDF
+    #
+    # @example
+    #   save_pdf file: 'deck.pdf', margin: 75, gap: 5, trim: 37
+    #
+    # @option opts file [String] the name of the PDF file to save. See {file:README.md#Specifying_Files Specifying Files}
+    # @option opts dir [String] (_output) the directory to save to. Created if it doesn't exist.
+    # @option opts width [Integer] (3300) the height of the page in pixels. Default is 11in * 300dpi. Supports unit conversion.
+    # @option opts height [Integer] (2550) the height of the page in pixels. Default is 8.5in * 300dpi. Supports unit conversion.
+    # @option opts margin [Integer] (75) the margin around the outside of the page. Supports unit conversion.
+    # @option opts gap [Integer] (0) the space in pixels between the cards. Supports unit conversion.
+    # @option opts trim [Integer] (0) the space around the edge of each card to trim (e.g. to cut off the bleed margin for print-and-play). Supports unit conversion.
+    # @return [nil]
+    # @api public
+    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
+
+    # Saves the given range of cards to a PNG
+    #
+    # @example
+    #   save range: 1..8, dir: '_pnp', prefix: 'bw_'
+    #
+    # Options support Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
+    #
+    # @option opts [Enumerable] range (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
+    # @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] prefix (card_) the prefix of the file name to be printed.
+    # @option opts [String] count_format (%02d) the format string used for formatting the card count (e.g. padding zeros). Uses a Ruby format string (see the Ruby doc for Kernel::sprintf for specifics)
+    # @option opts [Boolean, :clockwise, :counterclockwise] rotate (false) if true, the saved cards will be rotated 90 degrees clockwise. Or, rotate by the number of radians. Intended to rendering landscape instead of portrait.
+    # @return [nil] Returns nothing
+    # @api public
+    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)
+      @progress_bar.start("Saving PNGs to #{batch.summary}", size) do |bar|
+        range.each do |i|
+          @cards[i].save_png(batch[i])
+          bar.increment
+        end
+      end
+    end
+
+    # Lays out the cards in range and renders a stitched PNG sheet
+    #
+    # @example
+    #   save_sheet prefix: 'sheet_', margin: 75, gap: 5, trim: 37
+    #
+    # @option opts [Enumerable] range (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
+    # @option opts columns [Integer] (5) the number of columns in the grid. Must be an integer
+    # @option opts rows [Integer] (:infinite) the number of rows in the grid. When set to :infinite, the sheet scales to the rows needed. If there are more cards than rows*columns, new sheets are started.
+    # @option opts [String] prefix (card_) the prefix of the file name(s)
+    # @option opts [String] count_format (%02d) the format string used for formatting the card count (e.g. padding zeros). Uses a Ruby format string (see the Ruby doc for Kernel::sprintf for specifics)
+    # @option opts dir [String] (_output) the directory to save to. Created if it doesn't exist.
+    # @option opts margin [Integer] (0) the margin around the outside of the sheet.
+    # @option opts gap [Integer] (0) the space in pixels between the cards
+    # @option opts trim [Integer] (0) the space around the edge of each card to trim (e.g. to cut off the bleed margin for print-and-play)
+    # @return [nil]
+    # @api public
+    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)
+      sheet = Args::Sheet.new(custom_colors, {margin: 0}, size).load!(opts, expand_by: size, layout: layout, dpi: dpi)
+      render_sheet(range, batch, sheet)
+    end
+
+    # 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
+    #   showcase file: 'showcase_output.png', trim: 78, trim_radius: 32
+    #
+    # @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] trim (0) the margin around the card to trim before putting into the showcase
+    # @option opts [Fixnum] trim_radius (38) the rounded rectangle radius around the card to trim before putting into the showcase
+    # @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. Supports gradients.
+    # @option opts [Fixnum] reflect_offset (15) the number of pixels between the bottom of the card and the reflection. Supports Unit Conversion, see {file:README.md#Units Units}.
+    # @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.
+    # @option opts [:left, :right] face (:left) which direction the cards face. Anything but `:right` will face left
+    # @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 ('showcase.png') the file to save in dir. Will be overwritten.
+    # @return [nil] Returns nothing.
+    # @api public
+    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)
+      sheet    = Args::Sheet.new(custom_colors, {file: 'showcase.png'}).load!(opts, expand_by: size, layout: layout, dpi: dpi)
+      render_showcase(range, sheet, showcase)
+    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 = {})
+      range = Args::CardRange.new(opts[:range], deck_size: size)
+      hand  = Args::HandSpecial.new(height).load!(opts, expand_by: size, layout: layout, dpi: dpi)
+      sheet = Args::Sheet.new(custom_colors, {file: 'hand.png', trim_radius: 0}).load!(opts, expand_by: size, layout: layout, dpi: dpi)
+      render_hand(range, sheet, hand)
+    end
+
+  end
+end

data/lib/squib/api/settings.rb

@@ -1,37 +1,35 @@
-module Squib
-  class Deck
-
-    # Toggle hints globally.
-    #
-    # Text hints are rectangles around where the text will be laid out. They are intended to be temporary.
-    # Setting a hint to nil or to :off will disable hints. @see samples/text.rb
-    # @example
-    #   hint text: :cyan
-    #   hint text: :cyan
-    #
-    # @param [String] text the color of the text hint. To turn off use :off. @see README.md
-    # @return [nil] Returns nothing
-    # @api public
-    def hint(text: :off)
-      conf.text_hint = text
-    end
-
-    # Sets various defaults for this deck. Defaults can be overriden by the commands themselves when that command supports it.
-    # @example
-    #   set font: 'Arial 26'
-    #   text 'blah'                     # in Arial 26
-    #   text 'blah24', font: 'Arial 24' # in Arial 24
-    #   set font: :default              # Back to Squib-wide default
-    #
-    # @option opts font: the font string to set as default. Can also be set to `:default` to use the Squib-wide default.
-    # @option opts img_dir: the default directory to READ images from. Default is `.`. Useful for switching from bw to color images.
-    # @return [nil] Returns nothing
-    # @api public
-    def set(opts = {})
-      opts = needs(opts, [:font, :img_dir])
-      @font = opts[:font][0] #was expanded - just need the first
-      @img_dir = opts[:img_dir]
-    end
-
-  end
-end
+module Squib
+  class Deck
+
+    # Toggle hints globally.
+    #
+    # Text hints are rectangles around where the text will be laid out. They are intended to be temporary.
+    # Setting a hint to nil or to :off will disable hints. @see samples/text.rb
+    # @example
+    #   hint text: :cyan
+    #   hint text: :cyan
+    #
+    # @param [String] text the color of the text hint. To turn off use :off. @see README.md
+    # @return [nil] Returns nothing
+    # @api public
+    def hint(text: :off)
+      conf.text_hint = text
+    end
+
+    # Sets various defaults for this deck. Defaults can be overriden by the commands themselves when that command supports it.
+    # @example
+    #   set font: 'Arial 26'
+    #   text 'blah'                     # in Arial 26
+    #   text 'blah24', font: 'Arial 24' # in Arial 24
+    #   set font: :default              # Back to Squib-wide default
+    #
+    # @option opts font: the font string to set as default. Can also be set to `:default` to use the Squib-wide default.
+    # @return [nil] Returns nothing
+    # @api public
+    def set(opts = {})
+      raise 'DEPRECATED: As of v0.7 img_dir is no longer supported in "set". Use config.yml instead.' if opts.key? :img_dir
+      @font = (opts[:font] == :default) ? Squib::SYSTEM_DEFAULTS[:default_font] : opts[:font]
+    end
+
+  end
+end