squib 0.6.0 → 0.7.0

data/lib/squib/deck.rb

@@ -1,111 +1,113 @@
-require 'yaml'
-require 'pp'
-require 'forwardable'
-require 'squib'
-require 'squib/card'
-require 'squib/progress'
-require 'squib/input_helpers'
-require 'squib/constants'
-require 'squib/layout_parser'
-require 'squib/args/unit_conversion'
-require 'squib/conf'
-require 'squib/graphics/showcase'
-require 'squib/graphics/hand'
-
-# The project module
-#
-# @api public
-module Squib
-
-  # The main interface to Squib. Provides a front-end porcelain whereas the Card class interacts with the graphics plumbing.
-  #
-  # @api public
-  class Deck
-    include Enumerable
-    include Squib::InputHelpers
-    extend Forwardable
-
-    # Attributes for the width, height (in pixels) and number of cards
-    # These are expected to be immuatble for the life of Deck
-    # @api private
-    attr_reader :width, :height, :cards
-
-    # Delegate these configuration options to the Squib::Conf object
-    def_delegators :conf, :antialias, :backend, :count_format, :custom_colors, :dir,
-                          :img_dir, :prefix, :text_hint, :typographer
-    # :nodoc:
-    # @api private
-    attr_reader :layout, :conf
-
-    # Squib's constructor that sets the immutable properties.
-    #
-    # This is the starting point for Squib. In providing a block to the constructor, you have access to all of Deck's instance methods.
-    # The documented methods in Deck are the ones intended for use by most users.
-    # If your game requires multiple different sizes or orientations, I recommend using multiple `Squib::Deck`s in your `deck.rb`. You can modify the internals of `Squib::Deck` (e.g. `@cards`), but that's not recommended.
-    # @example
-    #   require 'squib'
-    #   Squib::Deck.new do
-    #     text str: 'Hello, World!"
-    #   end
-    #
-    # @param width [Integer] the width of each card in pixels. Supports unit conversion (e.g. '2.5in').
-    # @param height [Integer] the height of each card in pixels. Supports unit conversion (e.g. '3.5in').
-    # @param cards [Integer] the number of cards in the deck
-    # @param dpi [Integer] the pixels per inch when rendering out to PDF or calculating using inches.
-    # @param config [String] the file used for global settings of this deck
-    # @param layout [String, Array] load a YML file of custom layouts. Multiple files are merged sequentially, redefining collisons. See README and sample for details.
-    # @param block [Block] the main body of the script.
-    # @api public
-    def initialize(width: 825, height: 1125, cards: 1, dpi: 300, config: 'config.yml', layout: nil, &block)
-      @dpi           = dpi
-      @font          = SYSTEM_DEFAULTS[:default_font]
-      @cards         = []
-      @conf          = Conf.load(config)
-      @progress_bar  = Progress.new(@conf.progress_bars) # FIXME this is evil. Using something different with @ and non-@
-      show_info(config, layout)
-      @width         = Args::UnitConversion.parse width, dpi
-      @height        = Args::UnitConversion.parse height, dpi
-      cards.times{ |i| @cards << Squib::Card.new(self, @width, @height, i) }
-      @layout        = LayoutParser.load_layout(layout)
-      if block_given?
-        instance_eval(&block) # here we go. wheeeee!
-      end
-    end
-
-    # Directly accesses the array of cards in the deck
-    #
-    # @api private
-    def [](key)
-      @cards[key]
-    end
-
-    # Iterates over each card in the deck
-    #
-    # @api private
-    def each(&block)
-      @cards.each { |card| block.call(card) }
-    end
-
-    # Use Logger to show more detail on the run
-    # :nodoc:
-    # @api private
-    def show_info(config, layout)
-      Squib::logger.info "Squib v#{Squib::VERSION}"
-      Squib::logger.info "  building #{@cards.size} #{@width}x#{@height} cards"
-      Squib::logger.info "  using #{@backend}"
-    end
-
-    ##################
-    ### PUBLIC API ###
-    ##################
-    require 'squib/api/background'
-    require 'squib/api/data'
-    require 'squib/api/image'
-    require 'squib/api/save'
-    require 'squib/api/settings'
-    require 'squib/api/shapes'
-    require 'squib/api/text'
-    require 'squib/api/units'
-
-  end
-end
+require 'forwardable'
+require 'pp'
+require 'squib'
+require 'squib/args/unit_conversion'
+require 'squib/card'
+require 'squib/conf'
+require 'squib/constants'
+require 'squib/graphics/hand'
+require 'squib/graphics/showcase'
+require 'squib/layout_parser'
+require 'squib/progress'
+
+
+# The project module
+#
+# @api public
+module Squib
+
+  # The main interface to Squib. Provides a front-end porcelain whereas the Card class interacts with the graphics plumbing.
+  #
+  # @api public
+  class Deck
+    include Enumerable
+    extend Forwardable
+
+    # Attributes for the width, height (in pixels) and number of cards
+    # These are expected to be immuatble for the life of Deck
+    # @api private
+    attr_reader :width, :height, :cards
+
+    # Delegate these configuration options to the Squib::Conf object
+    def_delegators :conf, :antialias, :backend, :count_format, :custom_colors, :dir,
+                          :img_dir, :prefix, :text_hint, :typographer
+    # :nodoc:
+    # @api private
+    attr_reader :layout, :conf, :dpi, :font
+
+    #
+    # deck.size is really just @cards.size
+    def_delegators :cards, :size
+
+    # Squib's constructor that sets the immutable properties.
+    #
+    # This is the starting point for Squib. In providing a block to the constructor, you have access to all of Deck's instance methods.
+    # The documented methods in Deck are the ones intended for use by most users.
+    # If your game requires multiple different sizes or orientations, I recommend using multiple `Squib::Deck`s in your `deck.rb`. You can modify the internals of `Squib::Deck` (e.g. `@cards`), but that's not recommended.
+    # @example
+    #   require 'squib'
+    #   Squib::Deck.new do
+    #     text str: 'Hello, World!"
+    #   end
+    #
+    # @param width [Integer] the width of each card in pixels. Supports unit conversion (e.g. '2.5in').
+    # @param height [Integer] the height of each card in pixels. Supports unit conversion (e.g. '3.5in').
+    # @param cards [Integer] the number of cards in the deck
+    # @param dpi [Integer] the pixels per inch when rendering out to PDF or calculating using inches.
+    # @param config [String] the file used for global settings of this deck
+    # @param layout [String, Array] load a YML file of custom layouts. Multiple files are merged sequentially, redefining collisons. See README and sample for details.
+    # @param block [Block] the main body of the script.
+    # @api public
+    def initialize(width: 825, height: 1125, cards: 1, dpi: 300, config: 'config.yml', layout: nil, &block)
+      @dpi           = dpi
+      @font          = SYSTEM_DEFAULTS[:default_font]
+      @cards         = []
+      @conf          = Conf.load(config)
+      @progress_bar  = Progress.new(@conf.progress_bars) # FIXME this is evil. Using something different with @ and non-@
+      show_info(config, layout)
+      @width         = Args::UnitConversion.parse width, dpi
+      @height        = Args::UnitConversion.parse height, dpi
+      cards.times{ |i| @cards << Squib::Card.new(self, @width, @height, i) }
+      @layout        = LayoutParser.load_layout(layout)
+      if block_given?
+        instance_eval(&block) # here we go. wheeeee!
+      end
+    end
+
+    # Directly accesses the array of cards in the deck
+    #
+    # @api private
+    def [](key)
+      @cards[key]
+    end
+
+    # Iterates over each card in the deck
+    #
+    # @api private
+    def each(&block)
+      @cards.each { |card| block.call(card) }
+    end
+
+    # Use Logger to show more detail on the run
+    # :nodoc:
+    # @api private
+    def show_info(config, layout)
+      Squib::logger.info "Squib v#{Squib::VERSION}"
+      Squib::logger.info "  building #{@cards.size} #{@width}x#{@height} cards"
+      Squib::logger.info "  using #{@backend}"
+    end
+
+    ##################
+    ### PUBLIC API ###
+    ##################
+    require 'squib/api/background'
+    require 'squib/api/data'
+    require 'squib/api/image'
+    require 'squib/api/save'
+    require 'squib/api/settings'
+    require 'squib/api/shapes'
+    require 'squib/api/text'
+    require 'squib/api/units'
+
+  end
+end

data/lib/squib/graphics/cairo_context_wrapper.rb

@@ -1,53 +1,99 @@
-require 'forwardable'
-require 'squib/graphics/gradient_regex'
-
-module Squib
-  module Graphics
-    # Wrapper class for the Cairo context. Private.
-    # @api private
-    class CairoContextWrapper
-      extend Forwardable
-
-      # :nodoc:
-      # @api private
-      attr_accessor :cairo_cxt
-
-      # :nodoc:
-      # @api private
-      def initialize(cairo_cxt)
-        @cairo_cxt = cairo_cxt
-      end
-
-      def_delegators :cairo_cxt, :save, :set_source_color, :paint, :restore,
-        :translate, :rotate, :move_to, :update_pango_layout, :width, :height,
-        :show_pango_layout, :rounded_rectangle, :set_line_width, :stroke, :fill,
-        :set_source, :scale, :render_rsvg_handle, :circle, :triangle, :line_to,
-        :operator=, :show_page, :clip, :transform, :mask, :create_pango_layout,
-        :antialias=, :curve_to, :matrix, :matrix=, :identity_matrix, :pango_layout_path,
-        :stroke_preserve, :target, :new_path, :fill_preserve, :close_path
-
-      # :nodoc:
-      # @api private
-      def set_source_squibcolor(arg)
-        if match = arg.match(LINEAR_GRADIENT)
-          x1, y1, x2, y2 = match.captures
-          linear = Cairo::LinearPattern.new(x1.to_f, y1.to_f, x2.to_f, y2.to_f)
-          arg.scan(STOPS).each do |color, offset|
-            linear.add_color_stop(offset.to_f, color)
-          end
-          @cairo_cxt.set_source(linear)
-        elsif match = arg.match(RADIAL_GRADIENT)
-          x1, y1, r1, x2, y2, r2  = match.captures
-          linear = Cairo::RadialPattern.new(x1.to_f, y1.to_f, r1.to_f,
-                                            x2.to_f, y2.to_f, r2.to_f)
-          arg.scan(STOPS).each do |color, offset|
-            linear.add_color_stop(offset.to_f, color)
-          end
-          @cairo_cxt.set_source(linear)
-        else
-          @cairo_cxt.set_source_color(arg)
-        end
-      end
-    end
-  end
-end
+require 'forwardable'
+require 'squib/graphics/gradient_regex'
+
+module Squib
+  module Graphics
+    # Wrapper class for the Cairo context. Private.
+    # @api private
+    class CairoContextWrapper
+      extend Forwardable
+
+      # :nodoc:
+      # @api private
+      attr_accessor :cairo_cxt
+
+      # :nodoc:
+      # @api private
+      def initialize(cairo_cxt)
+        @cairo_cxt = cairo_cxt
+      end
+
+      def_delegators :cairo_cxt, :save, :set_source_color, :paint, :restore,
+        :translate, :rotate, :move_to, :update_pango_layout, :width, :height,
+        :show_pango_layout, :rounded_rectangle, :set_line_width, :stroke, :fill,
+        :set_source, :scale, :render_rsvg_handle, :circle, :triangle, :line_to,
+        :operator=, :show_page, :clip, :transform, :mask, :create_pango_layout,
+        :antialias=, :curve_to, :matrix, :matrix=, :identity_matrix, :pango_layout_path,
+        :stroke_preserve, :target, :new_path, :fill_preserve, :close_path,
+        :set_line_join, :set_line_cap, :set_dash
+
+      # :nodoc:
+      # @api private
+      def set_source_squibcolor(arg)
+        raise 'nil is not a valid color' if arg.nil?
+        if match = arg.match(LINEAR_GRADIENT)
+          x1, y1, x2, y2 = match.captures
+          linear = Cairo::LinearPattern.new(x1.to_f, y1.to_f, x2.to_f, y2.to_f)
+          arg.scan(STOPS).each do |color, offset|
+            linear.add_color_stop(offset.to_f, color)
+          end
+          @cairo_cxt.set_source(linear)
+        elsif match = arg.match(RADIAL_GRADIENT)
+          x1, y1, r1, x2, y2, r2  = match.captures
+          linear = Cairo::RadialPattern.new(x1.to_f, y1.to_f, r1.to_f,
+                                            x2.to_f, y2.to_f, r2.to_f)
+          arg.scan(STOPS).each do |color, offset|
+            linear.add_color_stop(offset.to_f, color)
+          end
+          @cairo_cxt.set_source(linear)
+        else
+          @cairo_cxt.set_source_color(arg)
+        end
+      end
+
+      # Convenience method for a common task
+      # @api private
+      def fill_n_stroke(draw)
+        return stroke_n_fill(draw) if draw.stroke_strategy == :stroke_first
+        set_source_squibcolor draw.fill_color
+        fill_preserve
+        set_source_squibcolor draw.stroke_color
+        set_line_width draw.stroke_width
+        set_line_join draw.join
+        set_line_cap draw.cap
+        set_dash draw.dash
+        stroke
+      end
+
+      def stroke_n_fill(draw)
+        return fill_n_stroke(draw) if draw.stroke_strategy == :fill_first
+        set_source_squibcolor draw.stroke_color
+        set_line_width draw.stroke_width
+        set_line_join draw.join
+        set_line_cap draw.cap
+        set_dash draw.dash
+        stroke_preserve
+        set_source_squibcolor draw.fill_color
+        fill
+      end
+
+      # Convenience method for a common task
+      # @api private
+      def fancy_stroke(draw)
+        set_source_squibcolor draw.stroke_color
+        set_line_width draw.stroke_width
+        set_line_join draw.join
+        set_line_cap draw.cap
+        set_dash draw.dash
+        stroke
+      end
+
+      def rotate_about(x, y, angle)
+        translate(x, y)
+        rotate(angle)
+        translate(-x, -y)
+      end
+
+    end
+  end
+end

data/lib/squib/graphics/gradient_regex.rb

@@ -1,47 +1,47 @@
-module Squib
-  # @api private
-  module Graphics
-    STOPS = /   # used to capture the stops
-      \s*         # leading whitespace is ok
-      (\#?[\w]+)  # color
-      @           # no spaces here
-      (\d+\.?\d*) # offset number
-    /x
-
-    LINEAR_GRADIENT = /
-      \( \s*      # coordinate 1
-         (\d+\.?\d*) \s* # x1 number
-         ,\s*            # whitespace after comma is ok
-         (\d+\.?\d*) \s* # y1 number
-      \)
-      \s*        # space between coordinates is ok
-      \( \s*      # coordinate 2
-         (\d+\.?\d*) \s* # x2 number
-         ,\s*            # whitespace after comma is ok
-         (\d+\.?\d*) \s* # y2 number
-      \)
-      (#{STOPS})+ # stops
-      \s*         # trailing whitespace is ok
-    /x
-
-    RADIAL_GRADIENT = /
-      \( \s*      # coordinate 1
-        (\d+\.?\d*) \s* # x1 number
-        ,\s*            # whitespace after comma is ok
-        (\d+\.?\d*) \s* # y1 number
-        ,\s*            # whitespace after comma is ok
-        (\d+\.?\d*) \s* # r1 number
-      \)
-      \s*         # space between coordinates is ok
-      \( \s*      # coordinate 2
-        (\d+\.?\d*) \s* # x2 number
-        ,\s*            # whitespace after comma is ok
-        (\d+\.?\d*) \s* # y2 number
-        ,\s*            # whitespace after comma is ok
-        (\d+\.?\d*) \s* # r2 number
-      \)
-      (#{STOPS})+ # stops
-      \s*         # trailing whitespace is ok
-    /x
-  end
+module Squib
+  # @api private
+  module Graphics
+    STOPS = /   # used to capture the stops
+      \s*         # leading whitespace is ok
+      (\#?[\w]+)  # color
+      @           # no spaces here
+      (\d+\.?\d*) # offset number
+    /x
+
+    LINEAR_GRADIENT = /
+      \( \s*      # coordinate 1
+         (\d+\.?\d*) \s* # x1 number
+         ,\s*            # whitespace after comma is ok
+         (\d+\.?\d*) \s* # y1 number
+      \)
+      \s*        # space between coordinates is ok
+      \( \s*      # coordinate 2
+         (\d+\.?\d*) \s* # x2 number
+         ,\s*            # whitespace after comma is ok
+         (\d+\.?\d*) \s* # y2 number
+      \)
+      (#{STOPS})+ # stops
+      \s*         # trailing whitespace is ok
+    /x
+
+    RADIAL_GRADIENT = /
+      \( \s*      # coordinate 1
+        (\d+\.?\d*) \s* # x1 number
+        ,\s*            # whitespace after comma is ok
+        (\d+\.?\d*) \s* # y1 number
+        ,\s*            # whitespace after comma is ok
+        (\d+\.?\d*) \s* # r1 number
+      \)
+      \s*         # space between coordinates is ok
+      \( \s*      # coordinate 2
+        (\d+\.?\d*) \s* # x2 number
+        ,\s*            # whitespace after comma is ok
+        (\d+\.?\d*) \s* # y2 number
+        ,\s*            # whitespace after comma is ok
+        (\d+\.?\d*) \s* # r2 number
+      \)
+      (#{STOPS})+ # stops
+      \s*         # trailing whitespace is ok
+    /x
+  end
 end