squib 0.5.1 → 0.6.0

data/lib/squib/graphics/cairo_context_wrapper.rb

@@ -4,6 +4,7 @@ require 'squib/graphics/gradient_regex'
 module Squib
   module Graphics
     # Wrapper class for the Cairo context. Private.
+    # @api private
     class CairoContextWrapper
       extend Forwardable
 
@@ -22,7 +23,8 @@ module Squib
         :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
+        :antialias=, :curve_to, :matrix, :matrix=, :identity_matrix, :pango_layout_path,
+        :stroke_preserve, :target, :new_path, :fill_preserve, :close_path
 
       # :nodoc:
       # @api private

data/lib/squib/graphics/gradient_regex.rb

@@ -1,4 +1,5 @@
 module Squib
+  # @api private
   module Graphics
     STOPS = /   # used to capture the stops
       \s*         # leading whitespace is ok

data/lib/squib/graphics/hand.rb

@@ -0,0 +1,43 @@
+require 'squib/graphics/cairo_context_wrapper'
+
+module Squib
+  class Deck
+
+    # Draw cards in a fan.
+    # @api private
+    def render_hand(range, radius, angle_range, trim, trim_radius, margin,
+                    fill_color, dir, file)
+      cards       = range.collect { |i| @cards[i] }
+      center_x    = width / 2.0
+      center_y    = radius + height
+      out_size    = 3.0 * center_y
+      angle_delta = (angle_range.last - angle_range.first) / cards.size
+      cxt = Cairo::Context.new(Cairo::RecordingSurface.new(0, 0, out_size, out_size))
+      cxt.translate(out_size / 2.0, out_size / 2.0)
+      cxt.rotate(angle_range.first)
+      cxt.translate(-width, -width)
+      cards.each_with_index do |card, i|
+        cxt.translate(center_x, center_y)
+        cxt.rotate(angle_delta)
+        cxt.translate(-center_x, -center_y)
+        card.use_cairo do |card_cxt|
+          cxt.rounded_rectangle(trim, trim,
+                                width - (2 * trim), height - (2 * trim),
+                                trim_radius, trim_radius)
+          cxt.clip
+          cxt.set_source(card_cxt.target)
+          cxt.paint
+          cxt.reset_clip
+        end
+      end
+      x, y, w, h = cxt.target.ink_extents # I love Ruby assignment ;)
+      png_cxt = Squib::Graphics::CairoContextWrapper.new(Cairo::Context.new(Cairo::ImageSurface.new(w + 2*margin, h + 2*margin)))
+      png_cxt.set_source_squibcolor(fill_color)
+      png_cxt.paint
+      png_cxt.translate(-x + margin, -y + margin)
+      png_cxt.set_source(cxt.target)
+      png_cxt.paint
+      png_cxt.target.write_to_png("#{dir}/#{file}")
+    end
+  end
+end

data/lib/squib/graphics/image.rb

@@ -41,10 +41,12 @@ module Squib
 
     # :nodoc:
     # @api private
-    def svg(file, id, x, y, width, height, alpha, blend, angle, mask)
+    def svg(file, data, 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)
+      Squib.logger.warn 'Both an SVG file and SVG data were specified' unless file.to_s.empty? or data.to_s.empty?
+      return if (file.nil? or file.eql? '') and data.nil? # nothing specified
+      data = File.read(file) if data.to_s.empty?
+      svg          = RSVG::Handle.new_from_data(data)
       width        = svg.width  if width == :native
       height       = svg.height if height == :native
       scale_width  = width.to_f / svg.width.to_f

data/lib/squib/graphics/save_doc.rb

@@ -33,7 +33,7 @@ module Squib
           cc.translate(x,y)
           cc.rectangle(p[:trim], p[:trim], card_width, card_height)
           cc.clip
-          case card.backend
+          case card.backend.downcase.to_sym
           when :memory
             cc.set_source(card.cairo_surface, 0, 0)
             cc.paint

data/lib/squib/graphics/shapes.rb

@@ -1,4 +1,5 @@
 module Squib
+  # @api private
   class Card
 
     # :nodoc:
@@ -32,6 +33,34 @@ module Squib
       end
     end
 
+    # Ellipse drawing taken from looking at the control points in Inkscape
+    # Think of it like a rectangle. Curves go from mid-points of the sides
+    # of the rectangle. Control points are at 1/4 and 3/4 of the side.
+    # :nodoc:
+    # @api private
+    def ellipse(x, y, w, h, fill_color, stroke_color, stroke_width)
+      use_cairo do |cc|
+        cc.move_to(x, y + 0.5*h)       # start west
+        cc.curve_to(x, y + 0.25*h,     # west to north
+                    x + 0.25*w, y,
+                    x +  0.5*w, y)
+        cc.curve_to(x + 0.75*w, y,     # north to east
+                    x + w, y + 0.25*h,
+                    x + w, y + 0.5*h)
+        cc.curve_to(x + w, y + 0.75*h, # east to south
+                    x + 0.75*w, y + h,
+                    x + 0.5*w, y + h)
+        cc.curve_to(x + 0.25*w, y + h, # south to west
+                    x, y + 0.75*h,
+                    x, y + 0.5*h)
+        cc.set_source_squibcolor(stroke_color)
+        cc.set_line_width(stroke_width)
+        cc.stroke_preserve
+        cc.set_source_squibcolor(fill_color)
+        cc.fill
+      end
+    end
+
     # :nodoc:
     # @api private
     def triangle(x1, y1, x2, y2, x3, y3, fill_color, stroke_color, stroke_width)
@@ -74,5 +103,50 @@ module Squib
       end
     end
 
+    # :nodoc:
+    # @api private
+    def star(x, y, n, angle, inner_radius, outer_radius, fill_color, stroke_color, stroke_width)
+      use_cairo do |cc|
+        cc.translate(x, y)
+        cc.rotate(angle)
+        cc.translate(-x, -y)
+        cc.move_to(x + outer_radius, y) #i = 0, so cos(0)=1 and sin(0)=0
+        theta = Math::PI / n.to_f # i.e. (2*pi) / (2*n)
+        0.upto(2 * n) do |i|
+            radius = i.even? ? outer_radius : inner_radius
+            cc.line_to(x + radius * Math::cos(i * theta),
+                       y + radius * Math::sin(i * theta))
+        end
+        cc.close_path
+        cc.set_source_squibcolor(stroke_color)
+        cc.set_line_width(stroke_width)
+        cc.fill_preserve
+        cc.set_source_squibcolor(fill_color)
+        cc.stroke
+      end
+    end
+
+    # :nodoc:
+    # @api private
+    def polygon(x, y, n, angle, radius, fill_color, stroke_color, stroke_width)
+      use_cairo do |cc|
+        cc.translate(x, y)
+        cc.rotate(angle)
+        cc.translate(-x, -y)
+        cc.move_to(x + radius, y) # i = 0, so cos(0)=1 and sin(0)=0
+        theta = (2 * Math::PI) / n.to_f
+        0.upto(n) do |i|
+            cc.line_to(x + radius * Math::cos(i * theta),
+                       y + radius * Math::sin(i * theta))
+        end
+        cc.close_path
+        cc.set_source_squibcolor(stroke_color)
+        cc.set_line_width(stroke_width)
+        cc.fill_preserve
+        cc.set_source_squibcolor(fill_color)
+        cc.stroke
+      end
+    end
+
   end
 end

data/lib/squib/graphics/showcase.rb

@@ -1,3 +1,5 @@
+require 'squib/graphics/cairo_context_wrapper'
+
 module Squib
   class Deck
 
@@ -16,8 +18,9 @@ module Squib
       out_width = range.size * ((@width - 2*trim) * scale * offset) + 2*margin
       out_height = reflect_offset + (1.0 + reflect_percent) * (@height - 2*trim) + 2*margin
       out_cc = Cairo::Context.new(Cairo::ImageSurface.new(out_width, out_height))
-      out_cc.set_source_color(fill_color)
-      out_cc.paint
+      wrapper = Squib::Graphics::CairoContextWrapper.new(out_cc)
+      wrapper.set_source_squibcolor(fill_color)
+      wrapper.paint
 
       cards = range.collect { |i| @cards[i] }
       cards.each_with_index do |card, i|

data/lib/squib/graphics/text.rb

@@ -6,8 +6,8 @@ module Squib
 
     # :nodoc:
     # @api private
-    def draw_text_hint(cc,x,y,layout, color,angle)
-      color = @deck.text_hint if color.eql? 'off' and not @deck.text_hint.to_s.eql? 'off'
+    def draw_text_hint(cc, x, y, layout, color)
+      color = @deck.text_hint if color.to_s.eql? 'off' and not @deck.text_hint.to_s.eql? 'off'
       return if color.to_s.eql? 'off' or color.nil?
       # when w,h < 0, it was never set. extents[1] are ink extents
       w = layout.width / Pango::SCALE
@@ -78,7 +78,7 @@ module Squib
 
     def set_font_rendering_opts!(layout)
       font_options                = Cairo::FontOptions.new
-      font_options.antialias      = ANTIALIAS_OPTS[(@deck.antialias.downcase)] || 'gray'
+      font_options.antialias      = Conf::ANTIALIAS_OPTS[(@deck.antialias || 'gray').downcase]
       font_options.hint_metrics   = 'on' # TODO make this configurable
       font_options.hint_style     = 'full' # TODO make this configurable
       layout.context.font_options = font_options
@@ -127,7 +127,7 @@ module Squib
       while (key = next_embed(embed.rules.keys, clean_str)) != nil
         rule          = embed.rules[key]
         spacing       = rule[:width] * Pango::SCALE
-        index         = clean_str.index(key) 
+        index         = clean_str.index(key)
         index         = clean_str[0..index].bytesize #convert to byte index (bug #57)
         str = str.sub(key, "<span size=\"#{ZERO_WIDTH_CHAR_SIZE}\">a<span letter_spacing=\"#{spacing.to_i}\">a</span>a</span>")
         layout.markup = str
@@ -143,12 +143,22 @@ module Squib
       return draw_calls
     end
 
+    def stroke_outline!(cc, layout, stroke_width, stroke_color)
+      if stroke_width > 0
+        cc.set_source_squibcolor(stroke_color)
+        cc.set_line_width(stroke_width)
+        cc.pango_layout_path(layout)
+        cc.stroke
+      end
+    end
+
     # :nodoc:
     # @api private
     def text(embed,str, font, font_size, color,
              x, y, width, height,
              markup, justify, wrap, ellipsize,
-             spacing, align, valign, hint, angle)
+             spacing, align, valign, hint, angle,
+             stroke_color, stroke_width)
       Squib.logger.debug {"Placing '#{str}'' with font '#{font}' @ #{x}, #{y}, color: #{color}, angle: #{angle} etc."}
       extents = nil
       str = str.to_s
@@ -164,7 +174,7 @@ module Squib
         layout.font_description = font_desc
         layout.text    = str
         if markup
-          str = Args::Typographer.new(@deck.quote_chars).process(layout.text)
+          str = @deck.typographer.process(layout.text)
           layout.markup = str
         end
 
@@ -185,6 +195,7 @@ module Squib
 
         cc.update_pango_layout(layout)
         cc.show_pango_layout(layout)
+        stroke_outline!(cc, layout, stroke_width, stroke_color)
         begin
           embed_draws.each { |ed| ed[:draw].call(self, ed[:x], ed[:y] + vertical_start) }
         rescue Exception => e
@@ -194,7 +205,7 @@ module Squib
           puts "=================="
           raise e
         end
-        draw_text_hint(cc, x, y, layout, hint, angle)
+        draw_text_hint(cc, x, y, layout, hint)
         extents = { width: layout.extents[1].width / Pango::SCALE,
                     height: layout.extents[1].height / Pango::SCALE }
       end

data/lib/squib/input_helpers.rb

@@ -130,8 +130,8 @@ module Squib
     def colorify(opts, nillable=false, key=:color)
       opts[key].each_with_index do |color, i|
         unless nillable && color.nil?
-          if @custom_colors.key? color.to_s
-            color = @custom_colors[color.to_s]
+          if custom_colors.key? color.to_s
+            color = custom_colors[color.to_s]
           end
           opts[key][i] = color
         end

data/lib/squib/version.rb

@@ -6,5 +6,5 @@ module Squib
   # Most of the time this is in the alpha of the next release.
   # e.g. v0.0.5a is on its way to becoming v0.0.5
   #
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/samples/csv_import.rb

@@ -5,15 +5,13 @@ Squib::Deck.new(cards: 2) do
 
   # Outputs a hash of arrays with the header names as keys
   data = csv file: 'sample.csv'
-
-  text str: data['Name'], x: 250, y: 55, font: 'Arial 54'
+  text str: data['Type'], x: 250, y: 55, font: 'Arial 54'
   text str: data['Level'], x: 65, y: 65, font: 'Arial 72'
-  text str: data['Description'], x: 65, y: 600, font: 'Arial 36'
+
+  save format: :png, prefix: 'sample_csv_'
 
   # You can also specify the sheet, starting at 0
   data = xlsx file: 'sample.xlsx', sheet: 2
-
-  save format: :png, prefix: 'sample_csv_'
 end
 
 # CSV is also a Squib-module-level function, so this also works:

data/samples/custom-config.yml

@@ -1,4 +1,3 @@
-dpi: 300
 progress_bars: true
 text_hint: '#FF0000'
 custom_colors:

data/samples/custom_config.rb

@@ -4,7 +4,7 @@ Squib::Deck.new(config: 'custom-config.yml') do
   # Custom color defined in our config
   background color: :foo
 
-  # Hints are turned on in the config file
+  # Hints can be turned on in the config file
   text str: 'The Title', x: 0, y: 78, width: 825,
        font: 'Arial 72', align: :center
 

data/samples/draw_shapes.rb

@@ -1,6 +1,7 @@
 require 'squib'
 
 Squib::Deck.new do
+  background color: :white
   rect x: 300, y: 300, width: 400, height: 400,
        fill_color: :blue, stroke_color: :red, stroke_width: 50.0
 
@@ -20,5 +21,15 @@ Squib::Deck.new do
         stroke_width: 12.0, stroke_color: :cyan,
         fill_color: :burgundy
 
+  ellipse x: 50, y: 925, width: 200, height: 100,
+          stroke_width: 5.0, stroke_color: :cyan,
+          fill_color: :burgundy
+
+  star x: 300, y: 1000, n: 5, inner_radius: 10, outer_radius: 25,
+       fill_color: :burgundy, stroke_color: :cyan, stroke_width: 3
+
+  polygon x: 500, y: 1000, n: 5, radius: 25, angle: Math::PI / 2,
+          fill_color: :burgundy, stroke_color: :cyan, stroke_width: 2
+
   save_png prefix: 'shape_'
 end

data/samples/embed_text.rb

@@ -61,7 +61,7 @@ Squib::Deck.new do
   text(str: embed_text, font: 'Sans 21',
        x: 400, y: 320, width: 180, height: 300,
        align: :center, ellipsize: false, justify: false, hint: :magenta) do |embed|
-    embed.svg key: ':tool:',   width: 28, height: 28, file: 'spanner.svg'
+    embed.svg key: ':tool:',   width: 28, height: 28, data: File.read('spanner.svg')
     embed.svg key: ':health:', width: 28, height: 28, file: 'glass-heart.svg'
     embed.png key: ':purse:',  width: 28, height: 28, file: 'shiny-purse.png'
   end

data/samples/hand.rb

@@ -0,0 +1,24 @@
+require 'squib'
+
+Squib::Deck.new(cards: 8, layout: 'playing-card.yml') do
+  background color: :cyan
+  rect x: 37, y: 37, width: 750, height: 1050, fill_color: :black, radius: 25
+  rect x: 75, y: 75, width: 675, height: 975, fill_color: :white, radius: 20
+  text str: ('A'..'Z').to_a, layout: :bonus_ul, font: 'Sans bold 100'
+
+  # Defaults are sensible
+  hand #saves to _output/hand.png
+
+  # Here's a prettier version:
+  #  - Each card is trimmed with rounded corners
+  #  - Zero radius means cards rotate about the bottom of the card
+  #  - Cards are shown in reverse order
+  hand trim: 37.5, trim_radius: 25,
+       radius: 0,
+       range: 7.downto(0),
+       file: 'hand_pretty.png'
+
+  # Tip: you can have the top card be on the left by reversing the range
+  #  angle_range: (Math::PI / 4)..(Math::PI / -4)
+end
+

data/samples/load_images.rb

@@ -17,6 +17,20 @@ Squib::Deck.new(width: 825, height: 1125, cards: 1) do
   # Squib prepends a #-sign if one is not specified
   svg file: 'spanner.svg', id: 'backdrop', x: 50, y: 450, width: 125, height: 125
 
+  # We can also load SVGs as a string of XML
+  svg data: File.read('spanner.svg'), x: 50, y: 600, width: 75, height: 75
+
+  # The svg data field works nicely with modifying the SVG XML on-the-fly.
+  # To run this one, do `gem install game_icons` and uncomment the following
+  #
+  # require 'game_icons'
+  # svg data: GameIcons.get('angler-fish').recolor(fg: '#ccc', bg: '#333').string,
+  #     x: 150, y: 600, width: 75, height: 75
+  #
+  # More examples at https://github.com/andymeneely/game_icons
+  # (or `gem install game_icons`) to get & manipulate art from game-icons.net
+  # Nokogiri (already included in Squib) is also great for XML manipulation.
+
   # WARNING! If you choose to use the SVG ID, the x-y coordinates are still
   # relative to the SVG page. See this example in an SVG editor
   svg file: 'offset.svg', id: 'thing',  x: 0, y: 0, width: 600, height: 600

data/samples/sample.csv

@@ -1,3 +1,3 @@
-Type,"Quantity"
-Thief,2
-Mastermind,1
+Type,"Level"
+Thief,1
+Mastermind,2

data/samples/text_options.rb

@@ -78,6 +78,10 @@ Squib::Deck.new(width: 825, height: 1125, cards: 3) do
     embed.svg key: ':health:', width: 28, height: 28, file: 'glass-heart.svg'
   end
 
+  text str: "Stroke n <span fgcolor=\"\#ff0000\">fill</span>",
+       color: :green, stroke_width: 2.0, stroke_color: :blue,
+       x: '1.8in', y: '3in', width: '0.85in', font: 'Sans Bold 26', markup: true
+
   text str: "<b>Markup</b> is <i>quite</i> <s>'easy'</s> <span fgcolor=\"\#ff0000\">awesome</span>. Can't beat those \"smart\" 'quotes', now with 10--20% more en-dashes --- and em-dashes --- with explicit ellipses too...",
        markup: true,
        x: 50, y: 1000,

data/spec/api/api_data_spec.rb

@@ -28,4 +28,23 @@ describe Squib::Deck do
         })
     end
   end
+
+  context '#xlsx' do
+    it 'loads basic xlsx data' do
+      expect(Squib.xlsx(file: xlsx_file('basic.xlsx'))).to eq({
+          'Name'           => %w(Larry Curly Mo),
+          'General Number' => %w(1 2 3), #general types always get loaded as strings with no conversion
+          'Actual Number'  =>  [4.0, 5.0, 6.0], #numbers get auto-converted to integers
+          })
+    end
+
+    it 'loads xlsx with formulas' do
+      expect(Squib.xlsx(file: xlsx_file('formulas.xlsx'))).to eq({
+        'A'   => %w(1 2),
+        'B'   => %w(3 4),
+        'Sum' => %w(4 6),
+        })
+    end
+
+  end
 end