squib 0.6.0 → 0.7.0

data/lib/squib/args/card_range.rb

@@ -0,0 +1,32 @@
+module Squib
+  # @api private
+  module Args
+    class CardRange
+      include Enumerable
+
+      def initialize(input, deck_size: 1)
+        @range = validate(input, deck_size)
+      end
+
+      # Hook into enumerable by delegating to @range
+      def each(&block)
+        @range.each { |i| block.call(i) }
+      end
+
+      def size
+        @range.size
+      end
+
+      private
+      def validate(input, deck_size)
+        input ||= :all # default
+        input = 0..(deck_size - 1) if input == :all
+        input = (input.to_i)..(input.to_i) if input.respond_to? :to_i
+        raise ArgumentError.new("#{input} must be Enumerable (i.e. respond_to :each).") unless input.respond_to? :each
+        raise ArgumentError.new("#{input} is outside of deck range of 0..#{deck_size-1}") if input.max > (deck_size - 1)
+        input
+      end
+
+    end
+  end
+end

data/lib/squib/args/color_validator.rb

@@ -0,0 +1,12 @@
+module Squib
+  #@api private
+  module Args
+    module ColorValidator
+
+      def colorify(color, custom_colors = {})
+        custom_colors[color.to_s] || color.to_s
+      end
+
+    end
+  end
+end

data/lib/squib/args/coords.rb

@@ -0,0 +1,33 @@
+require 'squib/args/arg_loader'
+
+module Squib
+  # @api private
+  module Args
+
+    class Coords
+      include ArgLoader
+
+      def self.parameters
+        { x: 0,    y: 0,
+          x1: 100, y1: 100,
+          x2: 150, y2: 150,
+          x3: 100, y3: 150,
+          cx1: 0 , cy1: 0,
+          cx2: 0 , cy2: 0,
+          inner_radius: 50, outer_radius: 100,
+          radius: 100,
+          n: 5, }
+      end
+
+      def self.expanding_parameters
+        parameters.keys # all of them
+      end
+
+      def self.params_with_units
+        parameters.keys # all of them
+      end
+
+    end
+
+  end
+end

data/lib/squib/args/dir_validator.rb

@@ -0,0 +1,16 @@
+module Squib
+  #@api private
+  module Args
+    module DirValidator
+
+      def ensure_dir_created(dir)
+        unless Dir.exists?(dir)
+          Squib.logger.warn "Dir '#{dir}' does not exist, creating it."
+          Dir.mkdir dir
+        end
+        return dir
+      end
+
+    end
+  end
+end

data/lib/squib/args/draw.rb

@@ -0,0 +1,92 @@
+require 'cairo'
+require 'squib/args/arg_loader'
+require 'squib/args/color_validator'
+
+module Squib
+  # @api private
+  module Args
+
+    class Draw
+      include ArgLoader
+      include ColorValidator
+
+      def initialize(custom_colors, dsl_method_defaults = {})
+        @custom_colors = custom_colors
+        @dsl_method_defaults = dsl_method_defaults
+      end
+
+      def self.parameters
+        { color: :black,
+          fill_color: '#0000',
+          stroke_color: :black,
+          stroke_width: 2.0,
+          stroke_strategy: :fill_first,
+          join: :miter,
+          cap: 'butt',
+          dash: ''
+        }
+      end
+
+      def self.expanding_parameters
+        parameters.keys # all of them are expandable
+      end
+
+      def self.params_with_units
+        [:stroke_width]
+      end
+
+      def validate_join(arg, _i)
+        case arg.to_s.strip.downcase
+        when 'miter'
+          Cairo::LINE_JOIN_MITER
+        when 'round'
+          Cairo::LINE_JOIN_ROUND
+        when 'bevel'
+          Cairo::LINE_JOIN_BEVEL
+        end
+      end
+
+      def validate_cap(arg, _i)
+        case arg.to_s.strip.downcase
+        when 'butt'
+          Cairo::LINE_CAP_BUTT
+        when 'round'
+          Cairo::LINE_CAP_ROUND
+        when 'square'
+          Cairo::LINE_CAP_SQUARE
+        end
+      end
+
+      def validate_dash(arg, _i)
+        arg.to_s.split.collect do |x|
+          convert_unit(x, @dpi).to_f
+        end
+      end
+
+      def validate_fill_color(arg, _i)
+        colorify(arg, @custom_colors)
+      end
+
+      def validate_stroke_color(arg, _i)
+        colorify(arg, @custom_colors)
+      end
+
+      def validate_color(arg, _i)
+        colorify(arg, @custom_colors)
+      end
+
+      def validate_stroke_strategy(arg, _i)
+        case arg.to_s.downcase.strip
+        when 'fill_first'
+          :fill_first
+        when 'stroke_first'
+          :stroke_first
+        else
+          raise "Only 'stroke_first' or 'fill_first' allowed"
+        end
+      end
+
+    end
+
+  end
+end

data/lib/squib/args/embed_adjust.rb

@@ -0,0 +1,25 @@
+require 'squib/args/arg_loader'
+
+module Squib
+  # @api private
+  module Args
+
+    class EmbedAdjust
+      include ArgLoader
+
+      def self.parameters
+        { dx: 0, dy: 0 }
+      end
+
+      def self.expanding_parameters
+        parameters.keys # all of them
+      end
+
+      def self.params_with_units
+        parameters.keys # all of them
+      end
+
+    end
+
+  end
+end

data/lib/squib/args/embed_key.rb

@@ -0,0 +1,17 @@
+require 'squib/args/arg_loader'
+
+module Squib
+  # @api private
+  module Args
+
+    class EmbedKey
+
+      # Validate the embed lookup key
+      def validate_key(str)
+        str.to_s
+      end
+
+    end
+
+  end
+end

data/lib/squib/args/hand_special.rb

@@ -0,0 +1,37 @@
+require 'cairo'
+
+module Squib
+  # @api private
+  module Args
+
+    class HandSpecial
+      include ArgLoader
+
+      def initialize(card_height)
+        @card_height = card_height
+      end
+
+      def self.parameters
+        {
+          angle_range: (Math::PI / -4.0)..(Math::PI / 4),
+          radius: :auto
+        }
+      end
+
+      def self.expanding_parameters
+        [] # none of them
+      end
+
+      def self.params_with_units
+        [ :radius ]
+      end
+
+      def validate_radius(arg)
+        return 0.3 * @card_height if arg.to_s.downcase.strip == 'auto'
+        arg
+      end
+
+    end
+
+  end
+end

data/lib/squib/args/input_file.rb

@@ -0,0 +1,37 @@
+require 'squib/args/arg_loader'
+
+module Squib
+  # @api private
+  module Args
+
+    class InputFile
+      include ArgLoader
+
+      def initialize(dsl_method_default = {})
+        @dsl_method_default = dsl_method_default
+      end
+
+      def self.parameters
+        { file: nil,
+          sheet: 0,
+        }
+      end
+
+      def self.expanding_parameters
+        parameters.keys # all of them
+      end
+
+      def self.params_with_units
+        [] # none of them
+      end
+
+      def validate_file(arg, _i)
+        return nil if arg.nil?
+        raise "File #{File.expand_path(arg)} does not exist!" unless File.exists?(arg)
+        File.expand_path(arg)
+      end
+
+    end
+
+  end
+end

data/lib/squib/args/paint.rb

@@ -0,0 +1,44 @@
+require 'cairo'
+require 'squib/args/arg_loader'
+require 'squib/args/color_validator'
+
+module Squib
+  # @api private
+  module Args
+    class Paint
+      include ArgLoader
+      include ColorValidator
+
+      def self.parameters
+        { alpha: 1.0,
+          blend: :none,
+          mask:  nil,
+        }
+      end
+
+
+      def self.expanding_parameters
+        parameters.keys # all of them are expandable
+      end
+
+      def self.params_with_units
+        []
+      end
+
+      def initialize(custom_colors)
+        @custom_colors = custom_colors
+      end
+
+      def validate_alpha(arg, _i)
+        raise 'alpha must respond to to_f' unless arg.respond_to? :to_f
+        arg.to_f
+      end
+
+      def validate_mask(arg, _i)
+        colorify(arg, @custom_colors)
+      end
+
+
+    end
+  end
+end

data/lib/squib/args/paragraph.rb

@@ -0,0 +1,115 @@
+require 'squib/args/arg_loader'
+
+module Squib
+  # @api private
+  module Args
+
+    class Paragraph
+      include ArgLoader
+
+
+      def self.parameters
+        { align:     :left,
+          str:       'Hello, World!',
+          font:      :use_set,
+          font_size: nil,
+          markup:    false,
+          justify:   false,
+          wrap:      true,
+          ellipsize: :end,
+          spacing:   nil,
+          valign:    :top,
+          hint:      :off
+        }
+      end
+
+      def self.expanding_parameters
+        parameters.keys # all of them
+      end
+
+      def self.params_with_units
+        [] # none of them
+      end
+
+      def initialize(deck_font)
+        @deck_font = deck_font
+      end
+
+      def validate_str(arg, _i)
+        arg.to_s
+      end
+
+      def validate_font(arg, _i)
+        arg = @deck_font if arg == :use_set
+        arg = Squib::SYSTEM_DEFAULTS[:default_font] if arg == :default
+        arg
+      end
+
+      def validate_align(arg, _i)
+        case arg.to_s.downcase.strip
+        when 'left'
+          Pango::ALIGN_LEFT
+        when 'right'
+          Pango::ALIGN_RIGHT
+        when 'center'
+          Pango::ALIGN_CENTER
+        else
+          raise ArgumentError, 'align must be one of: center, left, right'
+        end
+      end
+
+      def validate_wrap(arg, _i)
+        case arg.to_s.downcase.strip
+        when 'word'
+          Pango::Layout::WRAP_WORD
+        when 'char', 'false'
+          Pango::Layout::WRAP_CHAR
+        when 'word_char', 'true'
+          Pango::Layout::WRAP_WORD_CHAR
+        else
+          raise ArgumentError, 'wrap must be one of: word, char, word_char, true, or false'
+        end
+      end
+
+      def validate_ellipsize(arg, _i)
+        case arg.to_s.downcase.strip
+        when 'none', 'false'
+          Pango::Layout::ELLIPSIZE_NONE
+        when 'start'
+          Pango::Layout::ELLIPSIZE_START
+        when 'middle'
+          Pango::Layout::ELLIPSIZE_MIDDLE
+        when 'end', 'true'
+          Pango::Layout::ELLIPSIZE_END
+        else
+          raise ArgumentError, 'ellipsize must be one of: none, start, middle, end, true, or false'
+        end
+      end
+
+      def validate_justify(arg, _i)
+        case arg
+        when nil, true, false
+          arg
+        else
+          raise ArgumentError, 'justify must be one of: nil, true, or false'
+        end
+      end
+
+      def validate_spacing(arg, _i)
+        return nil if arg.nil?
+        raise ArgumentError, 'spacing must be a number or nil' unless arg.respond_to? :to_f
+        arg.to_f * Pango::SCALE
+      end
+
+      def validate_valign(arg, _i)
+        if %w(top middle bottom).include? arg.to_s.downcase
+          arg.to_s.downcase
+        else
+          raise ArgumentError, 'valign must be one of: top, middle, bottom'
+        end
+      end
+
+    end
+
+  end
+end