squib 0.5.1 → 0.6.0

data/lib/squib/api/text.rb

@@ -37,13 +37,16 @@ module Squib
     # @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. Note that this rotates around the upper-left corner of the text box, making the placement of x-y coordinates slightly tricky.
+    # @option opts stroke_color [String] (:black) the color with which to stroke the outside of the rectangle. {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
+    # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts hint [String] (:nil) draw a rectangle around the text with the given color. Overrides global hints (see {Deck#hint}).
     # @return [Array] Returns an Array of hashes keyed by :width and :height that mark the ink extents of the text rendered.
     # @api public
     def text(opts = {})
+      opts = { stroke_width: 0 }.merge(opts)
       opts = needs(opts, [:range, :str, :font, :font_size, :x, :y, :width, :height, :color, :wrap,
                           :align, :justify, :spacing, :valign, :markup, :ellipsize, :hint, :layout,
-                          :angle, :quotes])
+                          :angle, :quotes, :stroke_color, :stroke_width])
       embed = TextEmbed.new
       yield(embed) if block_given? #store the opts for later use
       extents = Array.new(@cards.size)
@@ -53,7 +56,8 @@ module Squib
                        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])
+                       opts[:valign][i], opts[:hint][i], opts[:angle][i],
+                       opts[:stroke_color][i], opts[:stroke_width][i] )
       end
       return extents
     end

data/lib/squib/api/text_embed.rb

@@ -17,8 +17,8 @@ module Squib
     # @option opts id [String] (nil) if set, then only render the SVG element with the given id. Prefix '#' is optional. Note: the x-y coordinates are still relative to the SVG document's page. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @option opts force_id [Boolean] (false) if set, then this svg will not be rendered at all if the id is empty or nil. If not set, the entire SVG is rendered. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @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}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts width [Integer, :native] (:native) the width of the image rendered.
-    # @option opts height [Integer, :native] the height the height of the image rendered.
+    # @option opts width [Integer] (32) the width of the image rendered.
+    # @option opts height [Integer] (32) the height the height of the image rendered.
     # @option opts dx [Integer] (0) "delta x", or adjust the icon horizontally by x pixels
     # @option opts dy [Integer] (0) "delta y", or adjust the icon vertically by y pixels
     # @option opts alpha [Decimal] (1.0) the alpha-transparency percentage used to blend this image. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
@@ -26,11 +26,12 @@ module Squib
     # @option opts angle [FixNum] (0) Rotation of the in radians. Note that this rotates around the upper-left corner, making the placement of x-y coordinates slightly tricky. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @api public
     def svg(opts)
+      opts = { width: 32, height: 32 }.merge(opts)
       opts = Squib::SYSTEM_DEFAULTS.merge(opts)
       # TODO: add input validation here. We need the key for example.
       rule = {type: :svg}.merge(opts)
       rule[:draw] = Proc.new do |card, x,y|
-        card.svg(rule[:file], rule[:id], x, y, rule[:width], rule[:height],
+        card.svg(rule[:file], rule[:data], rule[:id], x, y, rule[:width], rule[:height],
                  rule[:alpha], rule[:blend], rule[:angle], rule[:mask])
       end
       @rules[opts[:key]] = rule
@@ -41,8 +42,8 @@ module Squib
     # @option opts key [String] ('*') the string to replace with the graphic. Can be multiple letters, e.g. ':tool:'
     # @option opts file [String] ('') file(s) to read in. If it's a single file, then it's use for every card in range. If the parameter is an Array of files, then each file is looked up for each card. If any of them are nil or '', nothing is done. See {file:README.md#Specifying_Files Specifying Files}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @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}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts width [Integer, :native] (:native) the width of the image rendered
-    # @option opts height [Integer, :native] the height the height of the image rendered
+    # @option opts width [Fixnum] (32) the width of the image rendered
+    # @option opts height [Fixnum] (32) the height of the image rendered
     # @option opts dx [Integer] (0) "delta x", or adjust the icon horizontally by x pixels
     # @option opts dy [Integer] (0) "delta y", or adjust the icon vertically by y pixels
     # @option opts alpha [Decimal] (1.0) the alpha-transparency percentage used to blend this image. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
@@ -50,6 +51,7 @@ module Squib
     # @option opts angle [FixNum] (0) Rotation of the in radians. Note that this rotates around the upper-left corner, making the placement of x-y coordinates slightly tricky. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @api public
     def png(opts)
+      opts = { width: 32, height: 32 }.merge(opts)
       opts = Squib::SYSTEM_DEFAULTS.merge(opts)
       # TODO: add input validation here. We need the key for example.
       rule = {type: :png}.merge(opts)

data/lib/squib/args/typographer.rb

@@ -1,15 +1,21 @@
 require 'squib/constants'
 module Squib
+  #@api private
   module Args
+    # Internal class for handling arguments
+    #@api private
     class Typographer
 
-      def initialize(config = CONFIG_DEFAULTS)
-        @config = config
+      def initialize(config = Conf::DEFAULTS)
+      %w(lsquote ldquote rsquote rdquote smart_quotes
+         em_dash en_dash ellipsis).each do |var|
+          instance_variable_set("@#{var}", config[var])
+        end
       end
 
       def process(str)
-        str = explicit_replacements(str)
-        str = smart_quotes(str) if @config['smart_quotes']
+        str = explicit_replacements(str.to_s)
+        str = smart_quotes(str) if @smart_quotes
         str
       end
 
@@ -53,58 +59,58 @@ module Squib
 
       # Straightforward replace
       def left_curly(str)
-        str.gsub('``', @config['ldquote'])
+        str.gsub('``', @ldquote)
       end
 
       # Straightforward replace
       def right_curly(str)
-        str.gsub(%{''}, @config['rdquote'])
+        str.gsub(%{''}, @rdquote)
       end
 
       # A quote between two letters is an apostraphe
       def apostraphize(str)
-        str.gsub(/(\w)(\')(\w)/, '\1' + @config['rsquote'] + '\3')
+        str.gsub(/(\w)(\')(\w)/, '\1' + @rsquote + '\3')
       end
 
       # Straightforward replace
       def ellipsificate(str)
-        str.gsub('...', @config['ellipsis'])
+        str.gsub('...', @ellipsis)
       end
 
       # Straightforward replace
       def en_dash(str)
-        str.gsub('--', @config['en_dash'])
+        str.gsub('--', @en_dash)
       end
 
       # Straightforward replace
       def em_dash(str)
-        str.gsub('---', @config['em_dash'])
+        str.gsub('---', @em_dash)
       end
 
       # Quote next to non-whitespace curls
       def right_double_quote(str)
-        str.gsub(/(\S)(\")/, '\1' + @config['rdquote'])
+        str.gsub(/(\S)(\")/, '\1' + @rdquote)
       end
 
       # Quote next to non-whitespace curls
       def left_double_quote(str)
-        str.gsub(/(\")(\S)/, @config['ldquote'] + '\2')
+        str.gsub(/(\")(\S)/, @ldquote + '\2')
       end
 
       # Handle the cases where a double quote is next to a single quote
       def single_inside_double_quote(str)
-        str.gsub(/(\")(\')(\S)/, @config['ldquote'] + @config['lsquote'] + '\3')
-           .gsub(/(\")(\')(\S)/, '\1' + @config['rsquote'] + @config['rdquote'])
+        str.gsub(/(\")(\')(\S)/, @ldquote + @lsquote + '\3')
+           .gsub(/(\")(\')(\S)/, '\1' + @rsquote + @rdquote)
       end
 
       # Quote next to non-whitespace curls
       def right_single_quote(str)
-        str.gsub(/(\S)(\')/, '\1' + @config['rsquote'])
+        str.gsub(/(\S)(\')/, '\1' + @rsquote)
       end
 
       # Quote next to non-whitespace curls
       def left_single_quote(str)
-        str.gsub(/(\')(\S)/, @config['lsquote'] + '\2')
+        str.gsub(/(\')(\S)/, @lsquote + '\2')
       end
 
     end

data/lib/squib/card.rb

@@ -16,21 +16,21 @@ module Squib
 
     # :nodoc:
     # @api private
-    def initialize(deck, width, height, backend=:memory, index=-1)
+    def initialize(deck, width, height, index=-1)
       @deck          = deck
       @width         = width
       @height        = height
-      @backend       = backend
+      @backend       = deck.backend
       @svgfile       = "#{deck.dir}/#{deck.prefix}#{deck.count_format % index}.svg"
-      @cairo_surface = make_surface(@svgfile, backend)
+      @cairo_surface = make_surface(@svgfile, @backend)
       @cairo_context = Squib::Graphics::CairoContextWrapper.new(Cairo::Context.new(@cairo_surface))
-      @cairo_context.antialias = ANTIALIAS_OPTS[(@deck.antialias.downcase)] || 'subpixel'
+      @cairo_context.antialias = deck.antialias
     end
 
     # :nodoc:
     # @api private
     def make_surface(svgfile, backend)
-      case backend
+      case backend.downcase.to_sym
       when :memory
         Cairo::ImageSurface.new(@width, @height)
       when :svg

data/lib/squib/conf.rb

@@ -0,0 +1,111 @@
+require 'squib'
+require 'forwardable'
+require 'squib/args/typographer'
+
+module Squib
+  # @api private
+  class Conf
+
+    DEFAULTS = {
+      'antialias'     => 'best',
+      'backend'       => 'memory',
+      'count_format'  => SYSTEM_DEFAULTS[:count_format],
+      'custom_colors' => {},
+      'dir'           => SYSTEM_DEFAULTS[:dir],
+      'hint'          => :none,
+      'img_dir'       => '.',
+      'progress_bars' => false,
+      'ldquote'       => "\u201C", # UTF8 chars
+      'rdquote'       => "\u201D",
+      'lsquote'       => "\u2018",
+      'rsquote'       => "\u2019",
+      'em_dash'       => "\u2014",
+      'en_dash'       => "\u2013",
+      'ellipsis'      => "\u2026",
+      'smart_quotes'  => true,
+      'text_hint'     => 'off',
+    }
+
+    #Translate the hints to the methods.
+    ANTIALIAS_OPTS = {
+      nil        => 'subpixel',
+      'best'     => 'subpixel',
+      'good'     => 'gray',
+      'fast'     => 'gray',
+      'gray'     => 'gray',
+      'subpixel' => 'subpixel'
+    }
+
+    def initialize(config_hash = DEFAULTS)
+      @config_hash = config_hash
+      @typographer = Args::Typographer.new(config_hash)
+      normalize_antialias
+    end
+
+    # Load the configuration file, if exists, overriding hardcoded defaults
+    # @api private
+    def self.load(file)
+      yaml = {}
+      if File.exists? file
+        Squib::logger.info { "  using config: #{file}" }
+        yaml = YAML.load_file(file) || {}
+      end
+      Conf.new(DEFAULTS.merge(yaml))
+    end
+
+    def to_s
+      "Conf: #{@config_hash.to_s}"
+    end
+
+    def img_dir
+      @config_hash['img_dir']
+    end
+
+    def text_hint
+      @config_hash['text_hint']
+    end
+
+    def text_hint=(hint)
+      @config_hash['text_hint'] = hint
+    end
+
+    def progress_bars
+      @config_hash['progress_bars']
+    end
+
+    def typographer
+      @typographer
+    end
+
+    def dir
+      @config_hash['dir']
+    end
+
+    def prefix
+      @config_hash['prefix']
+    end
+
+    def count_format
+      @config_hash['count_format']
+    end
+
+    def antialias
+      @config_hash['antialias']
+    end
+
+    def backend
+      @config_hash['backend']
+    end
+
+    def custom_colors
+      @config_hash['custom_colors']
+    end
+
+    private
+
+    def normalize_antialias
+      @config_hash['antialias'] = ANTIALIAS_OPTS[@config_hash['antialias'].downcase.strip]
+    end
+
+  end
+end

data/lib/squib/constants.rb

@@ -6,6 +6,7 @@ module Squib
       :align => :left,
       :alpha => 1.0,
       :angle => 0,
+      :angle_range => (Math::PI / -4.0)..(Math::PI / 4),
       :blend => :none,
       :color => :black,
       :columns => 5,
@@ -14,6 +15,7 @@ module Squib
       :cx2 => 0,
       :cy1 => 0,
       :cy2 => 0,
+      :data => nil,
       :default_font => 'Arial 36',
       :dir => '_output',
       :dx => 0, # delta
@@ -28,13 +30,16 @@ module Squib
       :gap => 0,
       :height => :native,
       :hint => :off,
+      :inner_radius => 50,
       :img_dir => '.',
       :justify => false,
       :key => '*',
       :margin => 75,
       :markup => false,
       :mask => nil,
+      :n => 5,
       :offset => 1.1,
+      :outer_radius => 100,
       :prefix => 'card_',
       :progress_bar => false,
       :quotes => :dumb,
@@ -67,37 +72,6 @@ module Squib
       :y_radius => 0,
     }
 
-    # Squib's configuration defaults
-    #
-    # @api public
-    CONFIG_DEFAULTS = {
-      'antialias'     => 'best',
-      'backend'       => 'memory',
-      'count_format'  => SYSTEM_DEFAULTS[:count_format],
-      'custom_colors' => {},
-      'dir'           => SYSTEM_DEFAULTS[:dir],
-      'dpi'           => 300,
-      'hint'          => :none,
-      'img_dir'       => '.',
-      'progress_bar'  => false,
-      'ldquote'       => "\u201C", # UTF8 chars
-      'rdquote'       => "\u201D",
-      'lsquote'       => "\u2018",
-      'rsquote'       => "\u2019",
-      'em_dash'       => "\u2014",
-      'en_dash'       => "\u2013",
-      'ellipsis'      => "\u2026",
-      'smart_quotes'  => true,
-    }
-
-    #Translate the hints to the methods.
-    ANTIALIAS_OPTS = {
-      'best' => 'subpixel',
-      'good' => 'gray',
-      'fast' => 'gray',
-      'gray' => 'gray',
-      'subpixel' => 'subpixel'
-    }
     # These are parameters that are intended to be "expanded" across
     # range if they are singletons.
     #
@@ -128,16 +102,20 @@ module Squib
           :font_size => :font_size,
           :height => :height,
           :hint => :hint,
+          :inner_radius => :inner_radius,
           :justify => :justify,
           :layout => :layout,
           :markup => :markup,
           :mask => :mask,
+          :n => :n,
+          :outer_radius => :outer_radius,
           :quotes => :quotes,
           :rect_radius => :radius,
           :spacing => :spacing,
           :str => :str,
           :stroke_color => :stroke_color,
           :stroke_width => :stroke_width,
+          :svgdata => :data,
           :svgid => :id,
           :valign => :valign,
           :width => :width,
@@ -171,7 +149,9 @@ module Squib
       :dy => :dx, # delta
       :gap => :gap,
       :height => :height,
+      :inner_radius => :inner_radius,
       :margin => :margin,
+      :outer_radius => :outer_radius,
       :paper_width => :width,
       :paper_height => :height,
       :rect_radius => :radius,

data/lib/squib/deck.rb

@@ -1,5 +1,6 @@
 require 'yaml'
 require 'pp'
+require 'forwardable'
 require 'squib'
 require 'squib/card'
 require 'squib/progress'
@@ -7,6 +8,9 @@ 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
 #
@@ -19,24 +23,19 @@ module Squib
   class Deck
     include Enumerable
     include Squib::InputHelpers
+    extend Forwardable
 
-    # :nodoc:
-    # @api private
-    attr_reader :width, :height
-
-    # :nodoc:
-    # @api private
-    attr_reader :cards
-
-    # :nodoc:
+    # 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 :text_hint, :antialias
+    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, :config, :quote_chars
-
-    attr_reader :dir, :prefix, :count_format
+    attr_reader :layout, :conf
 
     # Squib's constructor that sets the immutable properties.
     #
@@ -58,24 +57,15 @@ 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)
-      @antialias     = CONFIG_DEFAULTS['antialias']
       @dpi           = dpi
       @font          = SYSTEM_DEFAULTS[:default_font]
       @cards         = []
-      @custom_colors = {}
-      @img_dir       = '.'
-      @progress_bar  = Progress.new(false)
-      @text_hint     = :off
-      @backend       = :memory
-      @dir           = SYSTEM_DEFAULTS[:dir]
-      @prefix        = SYSTEM_DEFAULTS[:prefix]
-      @count_format  = SYSTEM_DEFAULTS[:count_format]
-      @quote_chars   = CONFIG_DEFAULTS.select {|k,v| %w(lsquote rsquote ldquote rdquote em_dash en_dash ellipsis smart_quotes).include?(k) }
+      @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)
-      load_config(config)
       @width         = Args::UnitConversion.parse width, dpi
       @height        = Args::UnitConversion.parse height, dpi
-      cards.times{ |i| @cards << Squib::Card.new(self, @width, @height, @backend, i) }
+      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!
@@ -96,29 +86,6 @@ module Squib
       @cards.each { |card| block.call(card) }
     end
 
-    # Load the configuration file, if exists, overriding hardcoded defaults
-    # @api private
-    def load_config(file)
-      if File.exists?(file) && config = YAML.load_file(file)
-        Squib::logger.info { "  using config: #{file}" }
-        config                = CONFIG_DEFAULTS.merge(config)
-        @dpi                  = config['dpi'].to_i
-        @text_hint            = config['text_hint']
-        @progress_bar.enabled = config['progress_bars']
-        @custom_colors        = config['custom_colors']
-        @img_dir              = config['img_dir']
-        @backend              = (config['backend'].to_s.downcase.strip == 'svg') ? :svg : :memory
-        @dir                  = config['dir']
-        @prefix               = config['prefix']
-        @count_format         = config['count_format']
-        @antialias            = config['antialias']
-        @quote_chars ||= {}
-        %w(lsquote rsquote ldquote rdquote smart_quotes em_dash en_dash ellipsis).each do |key|
-          @quote_chars[key] = config[key]
-        end
-      end
-    end
-
     # Use Logger to show more detail on the run
     # :nodoc:
     # @api private