squib 0.15.1 → 0.16.0

data/lib/squib/args/box.rb

@@ -1,55 +1,59 @@
-require_relative 'arg_loader'
-
-module Squib
-  # @api private
-  module Args
-
-    class Box
-      include ArgLoader
-
-      def initialize(deck = nil, dsl_method_defaults = {})
-        @deck = deck
-        @dsl_method_defaults = dsl_method_defaults
-      end
-
-      def self.parameters
-        { x: 0, y: 0,
-          width: :deck, height: :deck,
-          radius: nil, x_radius: 0, y_radius: 0
-        }
-      end
-
-      def self.expanding_parameters
-        parameters.keys # all of them
-      end
-
-      def self.params_with_units
-        parameters.keys # all of them
-      end
-
-      def validate_width(arg, _i)
-        return arg if @deck.nil?
-        return @deck.width if arg == :deck
-        arg
-      end
-
-      def validate_height(arg, _i)
-        return arg if @deck.nil?
-        return @deck.height if arg == :deck
-        arg
-      end
-
-      def validate_x_radius(arg, i)
-        return radius[i] unless radius[i].nil?
-        arg
-      end
-
-      def validate_y_radius(arg, i)
-        return radius[i] unless radius[i].nil?
-        arg
-      end
-
-    end
-
-  end
-end
+require_relative 'arg_loader'
+require_relative 'xywh_shorthands'
+
+module Squib::Args
+
+  module_function def extract_box(opts, deck, dsl_method_defaults = {})
+    Box.new(deck, dsl_method_defaults).extract!(opts, deck)
+  end
+
+  class Box
+    include ArgLoader
+    include XYWHShorthands
+
+    def initialize(deck = nil, dsl_method_defaults = {})
+      @deck = deck
+      @dsl_method_defaults = dsl_method_defaults
+    end
+
+    def self.parameters
+      { x: 0, y: 0,
+        width: :deck, height: :deck,
+        radius: nil, x_radius: 0, y_radius: 0
+      }
+    end
+
+    def self.expanding_parameters
+      parameters.keys # all of them
+    end
+
+    def self.params_with_units
+      parameters.keys # all of them
+    end
+
+    def validate_x(arg, i) apply_shorthands(arg, @deck, axis: :x) end
+    def validate_y(arg,_i) apply_shorthands(arg, @deck, axis: :y) end
+
+    def validate_width(arg, _i)
+      return arg if @deck.nil?
+      apply_shorthands(arg, @deck, axis: :x)
+    end
+
+    def validate_height(arg, _i)
+      return arg if @deck.nil?
+      apply_shorthands(arg, @deck, axis: :y)
+    end
+
+    def validate_x_radius(arg, i)
+      return radius[i] unless radius[i].nil?
+      arg
+    end
+
+    def validate_y_radius(arg, i)
+      return radius[i] unless radius[i].nil?
+      arg
+    end   
+
+  end
+
+end

data/lib/squib/args/card_range.rb

@@ -1,32 +1,34 @@
-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.nil?) && (input.max > (deck_size - 1))
-        input
-      end
-
-    end
-  end
-end
+module Squib::Args
+
+  module_function def extract_range(opts, deck)
+    CardRange.new(opts[:range], deck_size: deck.size)
+  end
+
+  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.nil?) && (input.max > (deck_size - 1))
+      input
+    end
+
+  end
+end

data/lib/squib/args/color_validator.rb

@@ -1,12 +1,7 @@
-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
+module Squib::Args::ColorValidator
+
+  def colorify(color, custom_colors = {})
+    custom_colors[color.to_s] || color.to_s
+  end
+
+end

data/lib/squib/args/coords.rb

@@ -1,35 +1,49 @@
-require_relative '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,
-          arc_start: 0, arc_end: 2 * Math::PI, arc_direction: :clockwise, arc_close: false,
-       }
-      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
+require_relative 'arg_loader'
+require_relative 'xywh_shorthands'
+
+module Squib::Args
+  module_function def extract_coords(opts, deck)
+    Coords.new.extract!(opts, deck)
+  end
+
+  class Coords
+    include ArgLoader
+    include XYWHShorthands
+
+    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,
+        arc_start: 0, arc_end: 2 * Math::PI, arc_direction: :clockwise, arc_close: false,
+     }
+    end
+
+    def self.expanding_parameters
+      parameters.keys # all of them
+    end
+
+    def self.params_with_units
+      parameters.keys # all of them
+    end
+
+    def validate_x(arg, i) apply_shorthands(arg, @deck, axis: :x) end
+    def validate_y(arg,_i) apply_shorthands(arg, @deck, axis: :y) end
+    def validate_x1(arg, i) apply_shorthands(arg, @deck, axis: :x) end
+    def validate_y1(arg,_i) apply_shorthands(arg, @deck, axis: :y) end
+    def validate_x2(arg, i) apply_shorthands(arg, @deck, axis: :x) end
+    def validate_y2(arg,_i) apply_shorthands(arg, @deck, axis: :y)end
+    def validate_x3(arg, i) apply_shorthands(arg, @deck, axis: :x) end
+    def validate_y3(arg,_i) apply_shorthands(arg, @deck, axis: :y) end
+    def validate_cx1(arg, i) apply_shorthands(arg, @deck, axis: :x) end
+    def validate_cy1(arg,_i) apply_shorthands(arg, @deck, axis: :y) end
+    def validate_cx2(arg, i) apply_shorthands(arg, @deck, axis: :x) end
+    def validate_cy2(arg,_i) apply_shorthands(arg, @deck, axis: :y) end
+  end
+
+end

data/lib/squib/args/csv_opts.rb

@@ -1,25 +1,22 @@
-require 'csv'
-
-module Squib
-  # @api private
-  module Args
-    class CSV_Opts
-
-      def initialize(opts)
-        opts = opts.keep_if { |k, _v| CSV::DEFAULT_OPTIONS.key? k}
-        @hash = CSV::DEFAULT_OPTIONS.merge(opts).merge(required)
-      end
-
-      def to_hash
-        @hash
-      end
-
-      private
-
-      def required
-        { headers: true, converters: :numeric }
-      end
-
-    end
-  end
-end
+require 'csv'
+
+module Squib::Args
+  class CSV_Opts
+
+    def initialize(opts)
+      opts = opts.keep_if { |k, _v| CSV::DEFAULT_OPTIONS.key? k}
+      @hash = CSV::DEFAULT_OPTIONS.merge(opts).merge(required)
+    end
+
+    def to_hash
+      @hash
+    end
+
+    private
+
+    def required
+      { headers: true, converters: :numeric }
+    end
+
+  end
+end

data/lib/squib/args/dir_validator.rb

@@ -1,16 +1,11 @@
-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."
-          FileUtils.mkdir_p dir
-        end
-        return dir
-      end
-
-    end
-  end
-end
+module Squib::Args::DirValidator
+
+  def ensure_dir_created(dir)
+    unless Dir.exists?(dir)
+      Squib.logger.warn "Dir '#{dir}' does not exist, creating it."
+      FileUtils.mkdir_p dir
+    end
+    return dir
+  end
+
+end

data/lib/squib/args/draw.rb

@@ -1,92 +1,93 @@
-require 'cairo'
-require_relative 'arg_loader'
-require_relative '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|
-          UnitConversion.parse(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
+require 'cairo'
+require_relative 'arg_loader'
+require_relative 'color_validator'
+
+module Squib::Args
+
+  module_function def extract_draw(opts, deck, dsl_method_defaults = {})
+    Draw.new(deck.custom_colors, dsl_method_defaults).extract!(opts, deck)
+  end
+
+  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|
+        UnitConversion.parse(x, @dpi, @cell_px).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