squib 0.2.0 → 0.3.0

data/lib/squib/api/text.rb

@@ -22,7 +22,7 @@ module Squib
     # @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. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts y [Integer] (0) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
-    # @option opts color [String] (:black) the color the font will render to. See {file:README.md#Specifying_Colors Specifying Colors}
+    # @option opts color [String] (:black) the color the font will render to. Gradients supported. See {file:README.md#Specifying_Colors___Gradients 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.. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts height [Integer, :native] the height of the box the string will be placed in. Stretches to the content by default. Supports Unit Conversion, see {file:README.md#Units Units}.

data/lib/squib/args/unit_conversion.rb

@@ -0,0 +1,21 @@
+require 'squib/constants'
+
+module Squib
+  module Args
+    module UnitConversion
+
+      module_function
+      def parse(arg, dpi=300)
+        case arg.to_s.rstrip
+        when /in$/ #ends with "in"
+          arg.rstrip[0..-2].to_f * dpi
+        when /cm$/ #ends with "cm"
+          arg.rstrip[0..-2].to_f * dpi * INCHES_IN_CM
+        else
+          arg
+        end
+      end
+
+    end
+  end
+end

data/lib/squib/card.rb

@@ -1,5 +1,6 @@
 require 'cairo'
 require 'squib/input_helpers'
+require 'squib/graphics/cairo_context_wrapper'
 
 module Squib
   # Back end graphics. Private.
@@ -19,7 +20,7 @@ module Squib
     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)
+      @cairo_context = Squib::Graphics::CairoContextWrapper.new(Cairo::Context.new(@cairo_surface))
     end
 
   # A save/restore wrapper for using Cairo

data/lib/squib/constants.rb

@@ -9,6 +9,7 @@ module Squib
       :blend => :none,
       :color => :black,
       :columns => 1,
+      :count_format => '%02d',
       :default_font => 'Arial 36',
       :dir => '_output',
       :ellipsize => :end,
@@ -25,6 +26,7 @@ module Squib
       :justify => false,
       :margin => 75,
       :markup => false,
+      :mask => nil,
       :offset => 1.1,
       :prefix => 'card_',
       :progress_bar => false,
@@ -95,6 +97,7 @@ module Squib
           :justify => :justify,
           :layout => :layout,
           :markup => :markup,
+          :mask => :mask,
           :rect_radius => :radius,
           :spacing => :spacing,
           :str => :str,
@@ -125,10 +128,15 @@ module Squib
     # value: the user-facing API key (e.g. radius: '1in')
     UNIT_CONVERSION_PARAMS = {
       :circle_radius => :radius,
+      :gap => :gap,
       :height => :height,
+      :margin => :margin,
+      :paper_width => :width,
+      :paper_height => :height,
       :rect_radius => :radius,
       :spacing => :spacing,
       :stroke_width => :stroke_width,
+      :trim => :trim,
       :width => :width,
       :x => :x,
       :x1 => :x1,

data/lib/squib/deck.rb

@@ -6,6 +6,7 @@ require 'squib/progress'
 require 'squib/input_helpers'
 require 'squib/constants'
 require 'squib/layout_parser'
+require 'squib/args/unit_conversion'
 
 # The project module
 #
@@ -46,8 +47,8 @@ module Squib
     #     text str: 'Hello, World!"
     #   end
     #
-    # @param width [Integer] the width of each card in pixels
-    # @param height [Integer] the height of each card in pixels
+    # @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
@@ -55,20 +56,21 @@ module Squib
     # @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)
-      @width=width; @height=height
-      @dpi = dpi
-      @font = Squib::SYSTEM_DEFAULTS[:default_font]
-      @cards = []
+      @dpi           = dpi
+      @width         = Args::UnitConversion.parse width, dpi
+      @height        = Args::UnitConversion.parse height, dpi
+      @font          = Squib::SYSTEM_DEFAULTS[:default_font]
+      @cards         = []
       @custom_colors = {}
-      @img_dir = '.'
-      @progress_bar = Squib::Progress.new(false)
-      @text_hint = :off
-      cards.times{ @cards << Squib::Card.new(self, width, height) }
+      @img_dir       = '.'
+      @progress_bar  = Squib::Progress.new(false)
+      @text_hint     = :off
+      cards.times{ @cards << Squib::Card.new(self, @width, @height) }
       show_info(config, layout)
       load_config(config)
-      @layout = LayoutParser.load_layout(layout)
+      @layout        = LayoutParser.load_layout(layout)
       if block_given?
-        instance_eval(&block)
+        instance_eval(&block) # here we go. wheeeee!
       end
     end
 

data/lib/squib/graphics/background.rb

@@ -5,7 +5,7 @@ module Squib
     # @api private
     def background(color)
       use_cairo do |cc|
-        cc.set_source_color(color)
+        cc.set_source_squibcolor(color)
         cc.paint
       end
     end

data/lib/squib/graphics/cairo_context_wrapper.rb

@@ -0,0 +1,42 @@
+require 'forwardable'
+require 'squib/graphics/gradient_regex'
+
+module Squib
+  module Graphics
+    class CairoContextWrapper
+      extend Forwardable
+      attr_accessor :cairo_cxt
+
+      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
+
+      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

data/lib/squib/graphics/gradient_regex.rb

@@ -0,0 +1,46 @@
+module Squib
+  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

data/lib/squib/graphics/image.rb

@@ -14,8 +14,8 @@ module Squib
 
     # :nodoc:
     # @api private
-    def png(file, x, y, width, height, alpha, blend, angle)
-      Squib.logger.debug {"Rendering: #{file} @#{x},#{y} #{width}x#{height}, alpha: #{alpha}, blend: #{blend}, angle: #{angle}"}
+    def png(file, x, y, width, height, alpha, blend, angle, mask)
+      Squib.logger.debug {"Rendering: #{file} @#{x},#{y} #{width}x#{height}, alpha: #{alpha}, blend: #{blend}, angle: #{angle}, mask: #{mask}"}
       return if file.nil? or file.eql? ''
       png = Squib.cache_load_image(file)
       use_cairo do |cc|
@@ -30,14 +30,19 @@ module Squib
         cc.translate(-1 * x, -1 * y)
         cc.set_source(png, x, y)
         cc.operator = blend unless blend == :none
-        cc.paint(alpha)
+        if mask.nil?
+          cc.paint(alpha)
+        else
+          cc.set_source_squibcolor(mask)
+          cc.mask(png, x, y)
+        end
       end
     end
 
     # :nodoc:
     # @api private
-    def svg(file, id, x, y, width, height, alpha, blend, angle)
-      Squib.logger.debug {"Rendering: #{file}, id: #{id} @#{x},#{y} #{width}x#{height}, alpha: #{alpha}, blend: #{blend}, angle: #{angle}"}
+    def svg(file, id, x, y, width, height, alpha, blend, angle, mask)
+      Squib.logger.debug {"Rendering: #{file}, id: #{id} @#{x},#{y} #{width}x#{height}, alpha: #{alpha}, blend: #{blend}, angle: #{angle}, mask: #{mask}"}
       return if file.nil? or file.eql? ''
       svg = RSVG::Handle.new_from_file(file)
       width = svg.width if width == :native
@@ -50,9 +55,14 @@ module Squib
         cc.translate(x, y)
         cc.rotate(angle)
         cc.translate(-1 * x, -1 * y)
-        cc.set_source(tmp, x, y)
         cc.operator = blend unless blend == :none
-        cc.paint(alpha)
+        if mask.nil?
+          cc.set_source(tmp, x, y)
+          cc.paint(alpha)
+        else
+          cc.set_source_squibcolor(mask)
+          cc.mask(tmp, x, y)
+        end
       end
     end
 

data/lib/squib/graphics/save_doc.rb

@@ -8,16 +8,17 @@ module Squib
     #
     # @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 margin [Integer] (75) the margin around the outside of the page
-    # @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)
+    # @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 = {})
-      p = needs(opts, [:range, :file_to_save, :creatable_dir, :margin, :gap, :trim])
-      width  = 11  * @dpi
-      height = 8.5 * @dpi #TODO: allow this to be specified too
-      cc = Cairo::Context.new(Cairo::PDFSurface.new("#{p[:dir]}/#{p[:file]}", width, height))
+      opts = {width: 3300, height: 2550}.merge(opts)
+      p = needs(opts, [:range, :paper_width, :paper_height, :file_to_save, :creatable_dir, :margin, :gap, :trim])
+      cc = Cairo::Context.new(Cairo::PDFSurface.new("#{p[:dir]}/#{p[:file]}", p[:width], p[:height]))
       x = p[:margin]
       y = p[:margin]
       @progress_bar.start("Saving PDF to #{p[:dir]}/#{p[:file]}", p[:range].size) do |bar|
@@ -27,10 +28,10 @@ module Squib
           cc.paint
           bar.increment
           x += surface.width + p[:gap]
-          if x > (width - surface.width - p[:margin])
+          if x > (p[:width] - surface.width - p[:margin])
             x = p[:margin]
             y += surface.height + p[:gap]
-            if y > (height - surface.height - p[:margin])
+            if y > (p[:height] - surface.height - p[:margin])
               x = p[:margin]
               y = p[:margin]
               cc.show_page #next page
@@ -49,15 +50,16 @@ module Squib
     # @option opts colulmns [Integer] (1) the number of columns in the grid
     # @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 page
+    # @option opts margin [Integer] (0) the margin around the outside of the page.
     # @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 = {})
       opts = {margin: 0}.merge(opts) # overriding the non-system default
-      p = needs(opts, [:range, :prefix, :creatable_dir, :margin, :gap, :trim, :rows, :columns])
+      p = needs(opts, [:range, :prefix, :count_format, :creatable_dir, :margin, :gap, :trim, :rows, :columns])
       # EXTRACT METHOD HERE
       sheet_width = (p[:columns] * (@width + 2 * p[:gap] - 2 * p[:trim])) + (2 * p[:margin])
       sheet_height = (p[:rows] * (@height + 2 * p[:gap] - 2 * p[:trim])) + (2 * p[:margin])
@@ -68,7 +70,8 @@ module Squib
       @progress_bar.start("Saving PNG sheet to #{p[:dir]}/#{p[:prefix]}_*", @cards.size + 1) do |bar|
         p[:range].each do |i|
           if num_this_sheet >= (p[:columns] * p[:rows]) # new sheet
-            cc.target.write_to_png("#{p[:dir]}/#{p[:prefix]}#{sheet_num}.png")
+            filename = "#{p[:dir]}/#{p[:prefix]}#{p[:count_format] % sheet_num}.png"
+            cc.target.write_to_png(filename)
             new_sheet = false
             num_this_sheet = 0
             sheet_num += 1
@@ -87,7 +90,7 @@ module Squib
           end
           bar.increment
         end
-        cc.target.write_to_png("#{p[:dir]}/#{p[:prefix]}#{sheet_num}.png")
+        cc.target.write_to_png("#{p[:dir]}/#{p[:prefix]}#{p[:count_format] % sheet_num}.png")
       end
     end
 

data/lib/squib/graphics/save_images.rb

@@ -3,13 +3,13 @@ module Squib
 
     # :nodoc:
     # @api private
-    def save_png(i, dir, prefix, do_rotate, angle)
+    def save_png(i, dir, prefix, count_format, do_rotate, angle)
       if [true, :clockwise, :counterclockwise].include?(do_rotate)
         surface = rotated_image(angle)
       else
         surface = @cairo_surface
       end
-      write_png(surface, i, dir, prefix)
+      write_png(surface, i, dir, prefix, count_format)
     end
 
     # :nodoc:
@@ -25,8 +25,8 @@ module Squib
     end
     # :nodoc:
     # @api private
-    def write_png(surface, i, dir, prefix)
-      surface.write_to_png("#{dir}/#{prefix}#{i}.png")
+    def write_png(surface, i, dir, prefix, count_format)
+      surface.write_to_png("#{dir}/#{prefix}#{count_format % i}.png")
     end
 
   end

data/lib/squib/graphics/shapes.rb

@@ -8,11 +8,11 @@ module Squib
       height = @height  if height == :native
       use_cairo do |cc|
         cc.rounded_rectangle(x, y, width, height, x_radius, y_radius)
-        cc.set_source_color(stroke_color)
+        cc.set_source_squibcolor(stroke_color)
         cc.set_line_width(stroke_width)
         cc.stroke
         cc.rounded_rectangle(x, y, width, height, x_radius, y_radius)
-        cc.set_source_color(fill_color)
+        cc.set_source_squibcolor(fill_color)
         cc.fill
       end
     end
@@ -22,11 +22,11 @@ module Squib
     def circle(x, y, radius, fill_color, stroke_color, stroke_width)
       use_cairo do |cc|
         cc.circle(x, y, radius)
-        cc.set_source_color(stroke_color)
+        cc.set_source_squibcolor(stroke_color)
         cc.set_line_width(stroke_width)
         cc.stroke
         cc.circle(x, y, radius)
-        cc.set_source_color(fill_color)
+        cc.set_source_squibcolor(fill_color)
         cc.fill
       end
     end
@@ -36,11 +36,11 @@ module Squib
     def triangle(x1, y1, x2, y2, x3, y3, fill_color, stroke_color, stroke_width)
       use_cairo do |cc|
         cc.triangle(x1, y1, x2, y2, x3, y3)
-        cc.set_source_color(stroke_color)
+        cc.set_source_squibcolor(stroke_color)
         cc.set_line_width(stroke_width)
         cc.stroke
         cc.triangle(x1, y1, x2, y2, x3, y3)
-        cc.set_source_color(fill_color)
+        cc.set_source_squibcolor(fill_color)
         cc.fill
       end
     end
@@ -51,7 +51,7 @@ module Squib
       use_cairo do |cc|
         cc.move_to(x1, y1)
         cc.line_to(x2, y2)
-        cc.set_source_color(stroke_color)
+        cc.set_source_squibcolor(stroke_color)
         cc.set_line_width(stroke_width)
         cc.stroke
       end

data/lib/squib/graphics/text.rb

@@ -91,7 +91,7 @@ module Squib
       Squib.logger.debug {"Placing '#{str}'' with font '#{font}' @ #{x}, #{y}, color: #{color}, angle: #{angle} etc."}
       extents = nil
       use_cairo do |cc|
-        cc.set_source_color(color)
+        cc.set_source_squibcolor(color)
         cc.translate(x,y)
         cc.rotate(angle)
         cc.translate(-1*x,-1*y)