squib 0.0.3 → 0.0.4

data/lib/squib/api/settings.rb

@@ -1,38 +1,37 @@
-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, progress_bar: true
-    #
-    # @param [String] text the color of the text hint. To turn off use :off. @see README.md 
-    # @param [Boolean] progress_bar enable progress bars on long-running operations
-    # @return [nil] Returns nothing
-    # @api public
-    def hint(text: :off)
-      @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)
+      @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

data/lib/squib/api/shapes.rb

@@ -1,117 +1,117 @@
-module Squib
-  class Deck
-    
-    # Draw a rounded rectangle
-    # 
-    # @example 
-    #   rect x: 0, y: 0, width: 825, height: 1125, radius: 25
-    # 
-    # 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 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 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 rect(opts = {})
-      opts = needs(opts, [:range, :x, :y, :width, :height, :rect_radius, :x_radius, :y_radius,
-                          :fill_color, :stroke_color, :stroke_width, :layout])
-      opts[:range].each do |i|
-        @cards[i].rect(opts[:x][i], opts[:y][i], opts[:width][i], opts[:height][i], 
-                       opts[:x_radius][i], opts[:y_radius][i], 
-                       opts[:fill_color][i], opts[:stroke_color][i], 
-                       opts[:stroke_width][i])
-      end
-    end
-
-    # Draw a circle centered at the given coordinates
-    # 
-    # @example 
-    #   circle x: 0, y: 0, radius: 100
-    #
-    # 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 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
-    # @return [nil] intended to be void
-    # @api public
-    def circle(opts = {})
-      opts = {radius: 100}.merge(opts)
-      opts = needs(opts, [:range, :x, :y, :circle_radius, :layout,
-                          :fill_color, :stroke_color, :stroke_width])
-      opts[:range].each do |i|
-        @cards[i].circle(opts[:x][i], opts[:y][i], opts[:radius][i], 
-          opts[:fill_color][i], opts[:stroke_color][i], opts[:stroke_width][i])
-      end
-    end
-
-    # Draw a triangle using the given coordinates
-    # 
-    # @example 
-    #   triangle :x1 => 0, :y1 => 0, :x2 => 50, :y2 => 50, :x3 => 0, :y3 => 50
-    #
-    # 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 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
-    # @return [nil] intended to be void
-    # @api public
-    def triangle(opts = {})
-      opts = needs(opts, [:range, :x1, :y1, :x2, :y2, :x3, :y3, :layout,
-                          :fill_color, :stroke_color, :stroke_width])
-      opts[:range].each do |i|
-        @cards[i].triangle(opts[:x1][i], opts[:y1][i], 
-                           opts[:x2][i], opts[:y2][i], 
-                           opts[:x3][i], opts[:y3][i], 
-                           opts[:fill_color][i], opts[:stroke_color][i], 
-                           opts[:stroke_width][i])
-      end
-    end
-
-    # Draw a line using the given coordinates
-    # 
-    # @example 
-    #   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 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
-    # @return [nil] intended to be void
-    # @api public
-    def line(opts = {})
-      opts = needs(opts, [:range, :x1, :y1, :x2, :y2, :layout,
-                          :stroke_color, :stroke_width])
-      opts[:range].each do |i|
-        @cards[i].line(opts[:x1][i], opts[:y1][i], opts[:x2][i], opts[:y2][i],
-                       opts[:stroke_color][i], opts[:stroke_width][i])
-      end
-    end
-    
-  end
+module Squib
+  class Deck
+    
+    # Draw a rounded rectangle
+    # 
+    # @example 
+    #   rect x: 0, y: 0, width: 825, height: 1125, radius: 25
+    # 
+    # 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 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 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 rect(opts = {})
+      opts = needs(opts, [:range, :x, :y, :width, :height, :rect_radius, :x_radius, :y_radius,
+                          :fill_color, :stroke_color, :stroke_width, :layout])
+      opts[:range].each do |i|
+        @cards[i].rect(opts[:x][i], opts[:y][i], opts[:width][i], opts[:height][i], 
+                       opts[:x_radius][i], opts[:y_radius][i], 
+                       opts[:fill_color][i], opts[:stroke_color][i], 
+                       opts[:stroke_width][i])
+      end
+    end
+
+    # Draw a circle centered at the given coordinates
+    # 
+    # @example 
+    #   circle x: 0, y: 0, radius: 100
+    #
+    # 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 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
+    # @return [nil] intended to be void
+    # @api public
+    def circle(opts = {})
+      opts = {radius: 100}.merge(opts)
+      opts = needs(opts, [:range, :x, :y, :circle_radius, :layout,
+                          :fill_color, :stroke_color, :stroke_width])
+      opts[:range].each do |i|
+        @cards[i].circle(opts[:x][i], opts[:y][i], opts[:radius][i], 
+          opts[:fill_color][i], opts[:stroke_color][i], opts[:stroke_width][i])
+      end
+    end
+
+    # Draw a triangle using the given coordinates
+    # 
+    # @example 
+    #   triangle :x1 => 0, :y1 => 0, :x2 => 50, :y2 => 50, :x3 => 0, :y3 => 50
+    #
+    # 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 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
+    # @return [nil] intended to be void
+    # @api public
+    def triangle(opts = {})
+      opts = needs(opts, [:range, :x1, :y1, :x2, :y2, :x3, :y3, :layout,
+                          :fill_color, :stroke_color, :stroke_width])
+      opts[:range].each do |i|
+        @cards[i].triangle(opts[:x1][i], opts[:y1][i], 
+                           opts[:x2][i], opts[:y2][i], 
+                           opts[:x3][i], opts[:y3][i], 
+                           opts[:fill_color][i], opts[:stroke_color][i], 
+                           opts[:stroke_width][i])
+      end
+    end
+
+    # Draw a line using the given coordinates
+    # 
+    # @example 
+    #   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 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
+    # @return [nil] intended to be void
+    # @api public
+    def line(opts = {})
+      opts = needs(opts, [:range, :x1, :y1, :x2, :y2, :layout,
+                          :stroke_color, :stroke_width])
+      opts[:range].each do |i|
+        @cards[i].line(opts[:x1][i], opts[:y1][i], opts[:x2][i], opts[:y2][i],
+                       opts[:stroke_color][i], opts[:stroke_width][i])
+      end
+    end
+    
+  end
 end

data/lib/squib/api/text.rb

@@ -1,51 +1,54 @@
-module Squib
-  class Deck
-
-    # Renders a string at a given location, width, alignment, font, etc.
-    #
-    #   Unix-like newlines are interpreted even on Windows. 
-    #   See the {file:samples/text-options.rb samples/text.rb} for a lengthy example.
-    #
-    # @example 
-    #   text str: 'hello'
-    #   text str: 'hello', x: 50, y:50, align: center
-    # 
-    # 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 str [String, Array] ('')  the string to be rendered. Must support `#to_s`. If the card responds to `#each`, it's mapped out one at a time across the cards.
-    # @option opts font [String] (Arial 36 or whatever was set with `set`) the Font description string, including family, styles, and size.
-    #   (e.g. `'Arial bold italic 12'`)
-    #   For the official documentation, see the [Pango docs](http://ruby-gnome2.sourceforge.jp/hiki.cgi?Pango%3A%3AFontDescription#style). 
-    #   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 x [Integer] (0) the x-coordinate to place
-    # @option opts y [Integer] (0) the y-coordinate to place
-    # @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 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`
-    # @option opts align [:left, right, :center] (:left) The alignment of the text
-    # @option opts justify [Boolean] (false) toggles whether or not the text is justified or not. 
-    # @option opts valign [:top, :middle, :bottom] (:top) When width and height are set, align text vertically according to the logical extents of the text.
-    # @option opts ellipsize [:none, :start, :middle, :end, true, false] (:end) When width and height are set, determines the behavior of overflowing text. Also: `true` maps to `:end` and `false` maps to `:none`. Default `:end`
-    # @option opts hint [String] (:nil) draw a rectangle around the text with the given color. Overrides global hints (see {Deck#hint}). 
-    # @return [nil] Returns nothing
-    # @api public
-    def text(opts = {})
-      opts = needs(opts, [:range, :str, :font, :x, :y, :width, :height, :color, :wrap,
-                          :align, :justify, :spacing, :valign, :markup, :ellipsize, :hint, :layout])
-      opts[:range].each do |i|
-        @cards[i].text(opts[:str][i], opts[:font][i], opts[:color][i],
-                       opts[:x][i], opts[:y][i], opts[:width][i], opts[:height][i],
-                       opts[:markup][i], opts[:justify][i], opts[:wrap][i], 
-                       opts[:ellipsize][i], opts[:spacing][i], opts[:align][i], 
-                       opts[:valign][i], opts[:hint][i])
-      end
-    end
-
-  end
+module Squib
+  class Deck
+
+    # Renders a string at a given location, width, alignment, font, etc.
+    #
+    #   Unix-like newlines are interpreted even on Windows. 
+    #   See the {file:samples/text-options.rb samples/text.rb} for a lengthy example.
+    #
+    # @example 
+    #   text str: 'hello'
+    #   text str: 'hello', x: 50, y:50, align: center
+    # 
+    # 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 str [String, Array] ('')  the string to be rendered. Must support `#to_s`. If the card responds to `#each`, it's mapped out one at a time across the cards.
+    # @option opts font [String] (Arial 36 or whatever was set with `set`) the Font description string, including family, styles, and size.
+    #   (e.g. `'Arial bold italic 12'`)
+    #   For the official documentation, see the [Pango docs](http://ruby-gnome2.sourceforge.jp/hiki.cgi?Pango%3A%3AFontDescription#style). 
+    #   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 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 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`
+    # @option opts spacing [Integer] (0) Adjust the spacing when the text is multiple lines. No effect when the text does not wrap.
+    # @option opts align [:left, right, :center] (:left) The alignment of the text
+    # @option opts justify [Boolean] (false) toggles whether or not the text is justified or not. 
+    # @option opts valign [:top, :middle, :bottom] (:top) When width and height are set, align text vertically according to the ink extents of the text.
+    # @option opts ellipsize [:none, :start, :middle, :end, true, false] (:end) When width and height are set, determines the behavior of overflowing text. Also: `true` maps to `:end` and `false` maps to `:none`. Default `:end`
+    # @option opts angle [FixNum] (0) Rotation of the text in radians. 
+    # @option opts hint [String] (:nil) draw a rectangle around the text with the given color. Overrides global hints (see {Deck#hint}). 
+    # @return [nil] Returns nothing
+    # @api public
+    def text(opts = {})
+      opts = needs(opts, [:range, :str, :font, :font_size, :x, :y, :width, :height, :color, :wrap,
+                          :align, :justify, :spacing, :valign, :markup, :ellipsize, :hint, :layout, :angle])
+      opts[:range].each do |i|
+        @cards[i].text(opts[:str][i], opts[:font][i], opts[:font_size][i], opts[:color][i],
+                       opts[:x][i], opts[:y][i], opts[:width][i], opts[:height][i],
+                       opts[:markup][i], opts[:justify][i], opts[:wrap][i], 
+                       opts[:ellipsize][i], opts[:spacing][i], opts[:align][i], 
+                       opts[:valign][i], opts[:hint][i], opts[:angle][i])
+      end
+    end
+
+  end
 end

data/lib/squib/api/units.rb

@@ -1,17 +1,17 @@
-module Squib
-  class Deck
-
-    # Given inches, returns the number of pixels according to the deck's DPI.
-    # 
-    # @example 
-    #   inches(2.5) # 750 (for default Deck::dpi of 300)
-    #
-    # @param [Decimal] n, the number of inches
-    # @return [Decimal] the number of pixels, according to the deck's DPI
-    # @api public
-    def inches(n)
-      @dpi * n
-    end
-
-  end
+module Squib
+  class Deck
+
+    # Given inches, returns the number of pixels according to the deck's DPI.
+    # 
+    # @example 
+    #   inches(2.5) # 750 (for default Deck::dpi of 300)
+    #
+    # @param [Decimal] n, the number of inches
+    # @return [Decimal] the number of pixels, according to the deck's DPI
+    # @api public
+    def inches(n)
+      @dpi * n
+    end
+
+  end
 end

data/lib/squib/card.rb

@@ -1,42 +1,42 @@
-require 'cairo'
-require 'squib/input_helpers'
-
-module Squib
-  # Back end graphics. Private.
-  class Card
-  include Squib::InputHelpers
-
-  # :nodoc:
-  # @api private 
-  attr_reader :width, :height
-
-  # :nodoc:
-  # @api private 
-  attr_accessor :cairo_surface, :cairo_context
-
-  # :nodoc:
-  # @api private 
-  def initialize(deck, width, height)
-    @deck=deck; @width=width; @height=height
-    @cairo_surface = Cairo::ImageSurface.new(width,height)
-    @cairo_context = Cairo::Context.new(@cairo_surface)
-  end
-
-  def use_cairo(&block)
-    @cairo_context.save
-    block.yield(@cairo_context)
-    @cairo_context.restore
-  end
-
-  ########################
-  ### BACKEND GRAPHICS ###
-  ########################
-  require 'squib/graphics/background'
-  require 'squib/graphics/image'
-  require 'squib/graphics/save_doc'
-  require 'squib/graphics/save_images'
-  require 'squib/graphics/shapes'
-  require 'squib/graphics/text'
-      
-  end
+require 'cairo'
+require 'squib/input_helpers'
+
+module Squib
+  # Back end graphics. Private.
+  class Card
+  include Squib::InputHelpers
+
+  # :nodoc:
+  # @api private 
+  attr_reader :width, :height
+
+  # :nodoc:
+  # @api private 
+  attr_accessor :cairo_surface, :cairo_context
+
+  # :nodoc:
+  # @api private 
+  def initialize(deck, width, height)
+    @deck=deck; @width=width; @height=height
+    @cairo_surface = Cairo::ImageSurface.new(width,height)
+    @cairo_context = Cairo::Context.new(@cairo_surface)
+  end
+
+  def use_cairo(&block)
+    @cairo_context.save
+    block.yield(@cairo_context)
+    @cairo_context.restore
+  end
+
+  ########################
+  ### BACKEND GRAPHICS ###
+  ########################
+  require 'squib/graphics/background'
+  require 'squib/graphics/image'
+  require 'squib/graphics/save_doc'
+  require 'squib/graphics/save_images'
+  require 'squib/graphics/shapes'
+  require 'squib/graphics/text'
+      
+  end
 end