squib 0.0.1 → 0.0.2

data/lib/squib/graphics/save_doc.rb

@@ -1,22 +1,51 @@
-module Squib
-  class Deck
-
-    def save_pdf
-      #paper is 8.5x11
-      # PDF points are 1/72 of an inch
-      raise "Not implemented yet!"
-      width = 8.5 * 72
-      height = 11 * 72
-      cc = Cairo::Context.new(Cairo::PDFSurface.new('_img/deck.pdf', width, height))
-      x = 10
-      y = 10
-      @cards.each_with_index do |card, i|
-        cc.move_to(x,y)
-        x += 825*i
-        cc.set_source(card.cairo_surface, 0, 300)
-        cc.paint
-      end
-    end
-
-  end
+module Squib
+  class Deck
+
+    # 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. 
+    # @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)
+    # @return [nil]
+    # @api public
+    def save_pdf(opts = {})
+      p = needs(opts, [: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))
+      x = p[:margin] ; y = p[:margin]
+      @cards.each_with_index do |card, i|
+        surface = trim(card.cairo_surface, p[:trim], @width, @height)
+        cc.set_source(surface, x, y)
+        cc.paint
+        x += surface.width + p[:gap]
+        if x > (width - surface.width - p[:margin])
+          x = p[:margin]
+          y += surface.height + p[:gap]
+          if y > (height - surface.height - p[:margin])
+            x = p[:margin] ; y = p[:margin]
+            cc.show_page #next page
+          end
+        end
+      end
+    end
+
+    # :nodoc:
+    # @api private 
+    def trim(surface, trim, width, height)
+      if trim > 0
+        tmp = Cairo::ImageSurface.new(width-2*trim, height-2*trim)
+        cc = Cairo::Context.new(tmp)
+        cc.set_source(surface,-1*trim, -1*trim)
+        cc.paint
+        surface = tmp
+      end
+      surface
+    end
+
+  end
 end

data/lib/squib/graphics/save_images.rb

@@ -1,9 +1,11 @@
-module Squib
-  class Card
-
-    def save_png(i, dir, prefix)
-      cairo_context.target.write_to_png("#{dir}/#{prefix}#{i}.png")
-    end
-
-  end
+module Squib
+  class Card
+
+    # :nodoc:
+    # @api private 
+    def save_png(i, dir, prefix)
+      cairo_context.target.write_to_png("#{dir}/#{prefix}#{i}.png")
+    end
+
+  end
 end

data/lib/squib/graphics/shapes.rb

@@ -1,12 +1,56 @@
-module Squib
-  class Card
-      
-    def draw_rectangle(x, y, width, height, x_radius, y_radius)
-      cc = cairo_context
-      cc.set_source_rgb(0.0,0.0,0.0)
-      cc.rounded_rectangle(x, y, width, height, x_radius, y_radius)
-      cc.stroke
-    end
-      
-  end
+module Squib
+  class Card
+      
+    # :nodoc:
+    # @api private 
+    def rect(x, y, width, height, x_radius, y_radius, fill_color, stroke_color, stroke_width)
+      width=@width if width==:native; height=@height if height==:native
+      cc = cairo_context
+      cc.rounded_rectangle(x, y, width, height, x_radius, y_radius)
+      cc.set_source_color(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.fill
+    end
+
+    # :nodoc:
+    # @api private 
+    def circle(x, y, radius, fill_color, stroke_color, stroke_width)
+      cc = cairo_context
+      cc.circle(x, y, radius)
+      cc.set_source_color(stroke_color)
+      cc.set_line_width(stroke_width)
+      cc.stroke
+      cc.circle(x, y, radius)
+      cc.set_source_color(fill_color)
+      cc.fill
+    end
+
+    # :nodoc:
+    # @api private 
+    def triangle(x1, y1, x2, y2, x3, y3, fill_color, stroke_color, stroke_width)
+      cc = cairo_context
+      cc.triangle(x1, y1, x2, y2, x3, y3)
+      cc.set_source_color(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.fill
+    end
+
+    # :nodoc:
+    # @api private 
+    def line(x1, y1, x2, y2, stroke_color, stroke_width)
+      cc = cairo_context
+      cc.move_to(x1, y1)
+      cc.line_to(x2, y2)
+      cc.set_source_color(stroke_color)
+      cc.set_line_width(stroke_width)
+      cc.stroke
+    end
+      
+  end
 end

data/lib/squib/graphics/text.rb

@@ -1,28 +1,108 @@
-require 'pango'
-
-module Squib
-  class Card
-
-    def text(str, font, x, y, options)
-      cc = cairo_context
-      cc.set_source_color(:black) #black
-      cc.move_to(x,y)
-      layout = cc.create_pango_layout
-      layout.text = str.to_s
-      w = options[:width] ; h = options[:height] 
-      w ||= (@width - 2*x)  ; h ||= (@height - 2*y) # default centers to x,y 
-      w *= Pango::SCALE   ; h *= Pango::SCALE    
-      layout.width=w      ; layout.height=h
-      layout.wrap = Pango::WRAP_WORD
-      layout.justify = true
-      layout.alignment = Pango::ALIGN_LEFT
-      layout.font_description = Pango::FontDescription.new(font)
-      #Center it vertically?
-      #puts "Height: #{layout.extents[1].height / Pango::SCALE}"
-      #puts "Height: #{layout.pixel_size[1]*layout.line_count}"
-      cc.update_pango_layout(layout)
-      cc.show_pango_layout(layout)
-    end
-
-  end
+require 'pango'
+
+module Squib
+  class Card
+
+    # :nodoc:
+    # @api private 
+    def draw_text_hint(x,y,layout, color)
+      return if color.nil? && @deck.text_hint.nil? 
+      color ||= @deck.text_hint
+      # when w,h < 0, it was never set. extents[0] are ink extents
+      w = layout.width / Pango::SCALE
+      w = layout.extents[1].width / Pango::SCALE if w < 0
+      h = layout.height / Pango::SCALE
+      h = layout.extents[1].height / Pango::SCALE if h < 0
+      rect(x,y,w,h,0,0,'#0000',color, 2.0)
+    end
+
+    # :nodoc:
+    # @api private 
+    def ellipsize(layout, options)
+      unless options[:ellipsize].nil?
+        h = { :none   => Pango::Layout::ELLIPSIZE_NONE,
+              :start  => Pango::Layout::ELLIPSIZE_START,
+              :middle => Pango::Layout::ELLIPSIZE_MIDDLE,
+              :end    => Pango::Layout::ELLIPSIZE_END,
+              true    => Pango::Layout::ELLIPSIZE_END,
+              false   => Pango::Layout::ELLIPSIZE_NONE
+            }
+        layout.ellipsize = h[options[:ellipsize]]
+      end
+      layout
+    end
+
+    # :nodoc:
+    # @api private 
+    def wrap(layout, options)
+      unless options[:wrap].nil?
+        h = { :word  => Pango::Layout::WRAP_WORD,
+              :char => Pango::Layout::WRAP_CHAR,
+              :word_char    => Pango::Layout::WRAP_WORD_CHAR,
+              true    => Pango::Layout::WRAP_WORD_CHAR,
+              false => nil,
+              :none => nil
+            }
+        layout.wrap = h[options[:wrap]]
+      end
+      layout
+    end
+
+    # :nodoc:
+    # @api private 
+    def align(layout, options)
+      unless options[:align].nil?
+          h = { :left => Pango::ALIGN_LEFT,
+                :right => Pango::ALIGN_RIGHT,
+                :center => Pango::ALIGN_CENTER
+              }
+          layout.alignment = h[options[:align]]
+      end
+      layout
+    end
+
+    # :nodoc:
+    # @api private 
+    def valign(cc, layout, x, y, valign)
+      if layout.height > 0 
+        ink_extents = layout.extents[1]
+        case valign
+        when :middle
+          cc.move_to(x, y + (layout.height - ink_extents.height) / (2 * Pango::SCALE))
+        when :bottom
+          cc.move_to(x, y + (layout.height - ink_extents.height) / Pango::SCALE)
+        end
+      end
+    end
+
+    # :nodoc:
+    # @api private 
+    def setwh(layout, options)
+      layout.width = options[:width] * Pango::SCALE unless options[:width].nil? || options[:width] == :native
+      layout.height = options[:height] * Pango::SCALE unless options[:height].nil? || options[:height] == :native
+      layout
+    end
+
+    # :nodoc:
+    # @api private 
+    def text(str, font, x, y, color, options)
+      cc = cairo_context
+      cc.set_source_color(color)
+      cc.move_to(x,y)
+      layout = cc.create_pango_layout
+      layout.font_description = Pango::FontDescription.new(font)
+      layout.text = str.to_s
+      layout.markup = str.to_s if options[:markup]
+      layout = setwh(layout, options)
+      layout = wrap(layout, options)
+      layout = ellipsize(layout, options)
+      layout = align(layout, options)
+      layout.justify = options[:justify] unless options[:justify].nil?
+      cc.update_pango_layout(layout) 
+      valign(cc, layout, x,y, options[:valign])
+      cc.update_pango_layout(layout) ; cc.show_pango_layout(layout)
+      draw_text_hint(x,y,layout,options[:hint])
+    end
+
+  end
 end

data/lib/squib/input_helpers.rb

@@ -0,0 +1,140 @@
+require 'squib/constants'
+
+module Squib
+  # :nodoc:
+  # @api private
+  module InputHelpers
+
+    # :nodoc:
+    # @api private
+    def needs(opts, params)
+      opts = layoutify(opts) if params.include? :layout
+      opts = Squib::SYSTEM_DEFAULTS.merge(opts)
+      opts = rangeify(opts) if params.include? :range      
+      opts = fileify(opts) if params.include? :file
+      opts = fileify(opts, false, true) if params.include? :file_to_save
+      opts = fileify(opts, true) if params.include? :files
+      opts = colorify(opts) if params.include? :color
+      opts = colorify(opts, true) if params.include? :nillable_color
+      opts = dirify(opts) if params.include? :dir
+      opts = dirify(opts, true) if params.include? :creatable_dir
+      opts = fontify(opts) if params.include? :font
+      opts = radiusify(opts) if params.include? :radius
+      opts = svgidify(opts) if params.include? :svgid
+      opts = formatify(opts) if params.include? :formats
+      opts
+    end
+    module_function :needs
+
+    # :nodoc:
+    # @api private
+    def layoutify(opts)
+      unless opts[:layout].nil?
+        entry = @layout[opts[:layout].to_s]
+        unless entry.nil?
+          entry.each do |key, value|
+            opts[key.to_sym] ||= entry[key]
+          end
+        else 
+          logger.warn "Layout entry #{opts[:layout]} does not exist." 
+        end
+      end
+      opts
+    end
+    module_function :layoutify
+
+    # :nodoc:
+    # @api private
+    def formatify(opts)
+      opts[:format] = [opts[:format]].flatten
+      opts
+    end
+    module_function :formatify
+
+    # :nodoc:
+    # @api private
+    def rangeify (opts)
+      range = opts[:range]
+      raise 'Range cannot be nil' if range.nil?
+      range = 0..(@cards.size-1) if range == :all
+      range = range..range if range.is_a? Integer
+      if range.max > (@cards.size-1)
+        raise "#{range} is outside of deck range of 0..#{@cards.size-1}"
+      end
+      opts[:range] = range
+      opts
+    end
+    module_function :rangeify
+
+    # :nodoc:
+    # @api private
+    def fileify(opts, expand_singletons=false, allow_non_exist=false)
+      opts[:file] = [opts[:file]] * @cards.size if expand_singletons
+      files = [opts[:file]].flatten
+      files.each do |file|
+        unless File.exists?(file) || allow_non_exist
+          raise "File #{File.expand_path(file)} does not exist!"
+        end
+      end
+      opts
+    end
+    module_function :fileify
+
+    # :nodoc:
+    # @api private
+    def dirify(opts, allow_create=false)
+      return opts if Dir.exists?(opts[:dir])
+      if allow_create
+        Squib.logger.warn "Dir #{opts[:dir]} does not exist, creating it."
+        Dir.mkdir opts[:dir]
+        return opts 
+      else
+        raise "#{opts[:dir]} does not exist!"
+      end
+    end
+    module_function :dirify
+
+    # :nodoc:
+    # @api private
+    def colorify(opts, nillable=false)
+      if nillable # for optional color arguments like text hints
+        opts[:color] = Cairo::Color.parse(opts[:color]) unless opts[:color].nil?
+      else
+        opts[:color] = Cairo::Color.parse(opts[:color])
+      end
+      opts
+    end
+    module_function :colorify
+
+    # :nodoc:
+    # @api private
+    def fontify (opts)
+      opts[:font] = @font if opts[:font]==:use_set
+      opts[:font] = Squib::SYSTEM_DEFAULTS[:default_font] if opts[:font] == :default
+      opts 
+    end
+    module_function :fontify 
+
+    # :nodoc:
+    # @api private
+    def radiusify(opts)
+      unless opts[:radius].nil?
+        opts[:x_radius] = opts[:radius]
+        opts[:y_radius] = opts[:radius]
+      end
+      opts
+    end
+    module_function :radiusify
+
+    # :nodoc:
+    # @api private
+    def svgidify(opts)
+      unless opts[:id].nil?
+        opts[:id] = '#' << opts[:id] unless opts[:id].start_with? '#'
+      end
+      opts
+    end
+    module_function :svgidify
+
+  end
+end

data/lib/squib/project_template/.gitignore

@@ -0,0 +1,3 @@
+_output/*.png
+_output/*.pdf
+

data/lib/squib/project_template/ABOUT.md

@@ -0,0 +1,19 @@
+My Awesome Game
+===============
+
+Check out my awesome game! 
+
+
+Objective
+---------
+
+
+
+Gameplay
+--------
+
+
+
+Ending the Game
+---------------
+

data/lib/squib/project_template/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'squib'

data/lib/squib/project_template/PNP NOTES.md

@@ -0,0 +1,4 @@
+Print and Play Notes
+====================
+
+Fill this out to give tips on how to play this with print and play.

data/lib/squib/project_template/_output/gitkeep.txt

@@ -0,0 +1 @@
+Keep this here so that Git knows to keep the _output directory on a fresh clone

data/lib/squib/project_template/config.yml

@@ -0,0 +1,2 @@
+# Settings in the config.yml are overriding Squib's defaults. Anything in the main script will override this.
+#dpi: 72

data/lib/squib/project_template/deck.rb

@@ -0,0 +1,6 @@
+require 'squib'
+
+Squib::Deck.new(cards: 3) do 
+  text str: "Hello, World!"
+  save format: :png
+end

data/lib/squib/version.rb

@@ -1,3 +1,6 @@
-module Squib
-  VERSION = "0.0.1"
-end
+module Squib
+
+  # The next version to be released.
+  # Uses semantic versioning
+  VERSION = "0.0.2"
+end

data/lib/squib.rb

@@ -1,2 +1,19 @@
-require 'squib/deck'
-require 'squib/card'
+require 'logger'
+require 'cairo'
+require 'pango'
+require 'rsvg2'
+require 'squib/version'
+require 'squib/commands/new'
+require 'squib/deck'
+require 'squib/card'
+
+module Squib
+  
+  # :nodoc:
+  # @api private 
+  def logger
+    @logger ||= Logger.new(STDOUT)
+  end
+  module_function :logger
+  
+end

data/samples/basic.rb

@@ -1,22 +1,20 @@
-#!/usr/bin/env ruby
-require 'squib'
-
-data = {'name' => ['Thief', 'Grifter', 'Mastermind'], 
-        'level' => [1,2,3]}
-longtext = "Hello, World! What do you know about tweetle beetles? well... \nWhen tweetle beetles fight, it's called a tweetle beetle battle. And when they battle in a puddle, it's a tweetle beetle puddle battle. AND when tweetle beetles battle with paddles in a puddle, they call it a tweetle beetle puddle paddle battle. AND... When beetles battle beetles in a puddle paddle battle and the beetle battle puddle is a puddle in a bottle... ..they call this a tweetle beetle bottle puddle paddle battle muddle. AND... When beetles fight these battles in a bottle with their paddles and the bottle's on a poodle and the poodle's eating noodles... ...they call this a muddle puddle tweetle poodle beetle noodle bottle paddle battle."
-
-Squib::Deck.new(width: 825, height: 1125, cards: 3) do
-  background color: [1.0,1.0,1.0]
-  rect x: 15, y: 15, width: 795, height: 1095, x_radius: 50, y_radius: 50
-  rect x: 30, y: 30, width: 128, height: 128, x_radius: 25, y_radius: 25
-
-  text str: data['name'], x: 250, y: 55, font: 'Arial 54'
-  text str: data['level'], x: 65, y: 40, font: 'Arial 72'
-  text str: longtext, x: 100, y: 600, font: 'Arial 16'
-
-  png file: 'shiny-purse.png', x: 665, y: 30
-
-  save format: :png
-end
-
-puts "Done!"
+#!/usr/bin/env ruby
+require 'squib'
+
+data = {'name' => ['Thief', 'Grifter', 'Mastermind'], 
+        'level' => [1,2,3]}
+
+Squib::Deck.new(width: 825, height: 1125, cards: 3) do
+  background color: :white
+  rect x: 38, y: 38, width: 750, height: 1050, radius: 38
+  rect x: 75, y: 75, width: 128, height: 128, radius: 25
+
+  text str: data['name'], x: 220, y: 78, font: 'Arial 54'
+  text str: data['level'], x: 75, y: 85, width: 128, 
+       font: 'Arial 72', align: :center
+
+  png range: [0,2], file: 'shiny-purse.png', x: 620, y: 75
+  svg range: 1..2, file: 'spanner.svg', x: 620, y: 218
+
+  save prefix: 'basic_', format: :png
+end

data/samples/colors.rb

@@ -0,0 +1,17 @@
+require 'squib'
+
+Squib::Deck.new(width: 825, height: 1125, cards: 1) do
+  background color: :white
+
+  y = 0
+  text color: '#f00', str: '3-hex', x: 50, y: y+=50
+  text color: '#f00', str: '3-hex (alpha)', x: 50, y: y+=50
+  text color: '#ff0000', str: '6-hex', x: 50, y: y+=50
+  text color: '#ff000099', str: '8-hex(alpha) *', x: 50, y: y+=50
+  text color: '#ffff00000000', str: '12-hex', x: 50, y: y+=50
+  text color: '#ffff000000009999', str: '12-hex (alpha)', x: 50, y: y+=50
+  text color: :burnt_orange, str: 'Symbols of constants too', x: 50, y: y+=50
+  text color: [1.0, 0.0, 0.0], str: 'Array of percentages', x: 50, y: y+=50
+
+  save_png prefix: "colors_"
+end

data/samples/custom-config.yml

@@ -0,0 +1 @@
+dpi: 300

data/samples/custom-layout.yml

@@ -0,0 +1,34 @@
+frame: 
+  x: 38
+  y: 38
+  width: 750
+  height: 1050
+  radius: 25
+title:
+  x: 125
+  y: 50
+  width: 625
+  height: 100
+  align: !ruby/symbol center #see http://www.yaml.org/YAML_for_ruby.html#symbols
+  valign: !ruby/symbol middle  
+subtitle:
+  x: 150
+  y: 150
+  width: 575
+  height: 60
+  align: !ruby/symbol center
+  valign: !ruby/symbol middle
+icon:
+  width: 125
+  height: 125
+  y: 250
+icon_left:
+  extends: icon
+  x: 150
+icon_middle:
+  extends: icon
+  x: 350
+  y: 400  #overrides the y inherited from icon
+icon_right:
+  extends: icon
+  x: 550

data/samples/custom_config.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'squib'
+
+Squib::Deck.new(config: 'custom-config.yml') do
+	
+end

data/samples/draw_shapes.rb

@@ -0,0 +1,19 @@
+require 'squib'
+
+Squib::Deck.new do 
+  rect x: 300, y: 300, width: 400, height: 400, 
+       fill_color: :blue, stroke_color: :red, stroke_width: 50.0
+
+  circle x: 600, y: 600, radius: 75,
+         fill_color: :gray, stroke_color: :green, stroke_width: 8.0  
+
+  triangle x1: 50, y1: 50, 
+           x2: 150, y2: 150, 
+           x3: 75, y3: 250
+
+  line x1: 50, y1: 550, 
+       x2: 150, y2: 650,
+       stroke_width: 25.0        
+
+  save_png prefix: 'shape_'
+end