squib 0.15.1 → 0.16.0

data/lib/squib/args/save_batch.rb

@@ -1,63 +1,65 @@
-require_relative 'arg_loader'
-require_relative 'dir_validator'
-
-module Squib
-  # @api private
-  module Args
-    class SaveBatch
-      include ArgLoader
-      include DirValidator
-
-      def initialize
-      end
-
-      def self.parameters
-        {
-          angle: 0,
-          count_format: '%02d',
-          dir: '_output',
-          prefix: 'card_',
-          rotate: false,
-          trim_radius: 0,
-          trim: 0,
-        }
-      end
-
-      def self.expanding_parameters
-        self.parameters.keys # all of them
-      end
-
-      def self.params_with_units
-        [:trim, :trim_radius]
-      end
-
-      def validate_dir(arg, _i)
-        ensure_dir_created(arg)
-      end
-
-      def validate_rotate(arg, i)
-        case arg
-        when true, :clockwise
-          angle[i] = 0.5 * Math::PI
-          return true
-        when :counterclockwise
-          angle[i] = 1.5 * Math::PI
-          return true
-        when false
-          false
-        else
-          raise 'invalid option to rotate: only [true, false, :clockwise, :counterclockwise]'
-        end
-      end
-
-      def full_filename(i)
-        "#{dir[i]}/#{prefix[i]}#{count_format[i] % i}.png"
-      end
-
-      def summary
-        "#{dir[0]}/#{prefix[0]}_*"
-      end
-
-    end
-  end
-end
+require_relative 'arg_loader'
+require_relative 'dir_validator'
+
+module Squib::Args
+  module_function def extract_save_batch(opts, deck)
+    SaveBatch.new.extract! opts, deck
+  end
+
+  class SaveBatch
+    include ArgLoader
+    include DirValidator
+
+    def initialize
+    end
+
+    def self.parameters
+      {
+        angle: 0,
+        count_format: '%02d',
+        dir: '_output',
+        prefix: 'card_',
+        rotate: false,
+        suffix: '',
+        trim_radius: 0,
+        trim: 0,
+      }
+    end
+
+    def self.expanding_parameters
+      self.parameters.keys # all of them
+    end
+
+    def self.params_with_units
+      [:trim, :trim_radius]
+    end
+
+    def validate_dir(arg, _i)
+      ensure_dir_created(arg)
+    end
+
+    def validate_rotate(arg, i)
+      case arg
+      when true, :clockwise
+        angle[i] = 0.5 * Math::PI
+        return true
+      when :counterclockwise
+        angle[i] = 1.5 * Math::PI
+        return true
+      when false
+        false
+      else
+        raise 'invalid option to rotate: only [true, false, :clockwise, :counterclockwise]'
+      end
+    end
+
+    def full_filename(i)
+      "#{dir[i]}/#{prefix[i]}#{count_format[i] % i}#{suffix[i]}.png"
+    end
+
+    def summary
+      "#{dir[0]}/#{prefix[0]}_*#{suffix[0]}"
+    end
+
+  end
+end

data/lib/squib/args/scale_box.rb

@@ -1,53 +1,57 @@
-require_relative 'arg_loader'
-
-module Squib
-  # @api private
-  module Args
-
-    class ScaleBox
-      include ArgLoader
-
-      def initialize(deck)
-        @deck = deck
-      end
-
-      def self.parameters
-        { x: 0, y: 0,
-          width: :native, height: :native
-        }
-      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 @deck.width if arg.to_s == 'deck'
-        return :native     if arg.to_s == 'native'
-        return arg         if arg.respond_to? :to_f
-        if arg.to_s == 'scale'
-          raise 'if width is :scale, height must be a number' unless height[i].respond_to? :to_f
-          return arg
-        end
-        raise 'width must be a number, :scale, :native, or :deck'
-      end
-
-      def validate_height(arg, i)
-        return @deck.height if arg.to_s == 'deck'
-        return :native      if arg.to_s == 'native'
-        return arg          if arg.respond_to? :to_f
-        if arg.to_s == 'scale'
-          raise 'if height is \'scale\', width must be a number' unless width[i].respond_to? :to_f
-          return arg
-        end
-        raise 'height must be a number, :scale, :native, or :deck'
-      end
-
-    end
-
-  end
-end
+require_relative 'arg_loader'
+require_relative 'xywh_shorthands'
+
+module Squib::Args
+  module_function def extract_scale_box(opts, deck)
+    ScaleBox.new.extract!(opts, deck)
+  end
+
+  class ScaleBox
+    include ArgLoader
+    include XYWHShorthands
+
+    def self.parameters
+      {
+        x: 0, y: 0,
+        width: :native, height: :native
+      }
+    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 @deck.width if arg.to_s == 'deck'
+      return :native     if arg.to_s == 'native'
+      arg = apply_shorthands(arg, @deck, axis: :x)
+      return arg         if arg.respond_to? :to_f
+      if arg.to_s == 'scale'
+        raise 'if width is :scale, height must be a number' unless height[i].respond_to? :to_f
+        return arg
+      end
+      raise 'width must be a number, :scale, :native, or :deck'
+    end
+
+    def validate_height(arg, i)
+      return @deck.height if arg.to_s == 'deck'
+      return :native      if arg.to_s == 'native'
+      arg = apply_shorthands(arg, @deck, axis: :y)
+      return arg          if arg.respond_to? :to_f
+      if arg.to_s == 'scale'
+        raise 'if height is \'scale\', width must be a number' unless width[i].respond_to? :to_f
+        return arg
+      end
+      raise 'height must be a number, :scale, :native, or :deck'
+    end
+
+  end
+
+end

data/lib/squib/args/sheet.rb

@@ -1,172 +1,170 @@
-require 'cairo'
-require_relative 'arg_loader'
-require_relative 'color_validator'
-require_relative 'dir_validator'
-
-module Squib
-  # @api private
-  module Args
-
-    class Sheet
-      include ArgLoader
-      include ColorValidator
-      include DirValidator
-
-      def initialize(custom_colors = {}, dsl_method_defaults = {}, deck_size = 1, dpi = 300)
-        @custom_colors = custom_colors
-        @dsl_method_defaults = dsl_method_defaults
-        @deck_size = deck_size
-        @dpi = dpi
-      end
-
-      def self.parameters
-        {
-          count_format: '%02d',
-          crop_margin_bottom: 0,
-          crop_margin_left: 0,
-          crop_margin_right: 0,
-          crop_margin_top: 0,
-          crop_marks: false,
-          crop_stroke_color: :black,
-          crop_stroke_dash: '',
-          crop_stroke_width: 1.5,
-          dir: '_output',
-          file: 'sheet.png',
-          fill_color: :white,
-          gap: 0,
-          height: 2550,
-          margin: 75,
-          prefix: 'sheet_',
-          rows: :infinite,
-          columns: 5,
-          trim_radius: 0,
-          trim: 0,
-          width: 3300,
-          range: :all,
-          rtl: false,
-        }
-      end
-
-      def self.expanding_parameters
-        [] # none of them
-      end
-
-      def self.params_with_units
-        [ :crop_margin_bottom, :crop_margin_left, :crop_margin_right,
-          :crop_margin_top, :gap, :height, :margin, :trim_radius, :trim,
-          :width
-        ]
-      end
-
-      def validate_crop_stroke_dash(arg)
-        arg.to_s.split.collect do |x|
-          UnitConversion.parse(x, @dpi).to_f
-        end
-      end
-
-      def validate_crop_marks(arg)
-        arg.to_s.downcase.to_sym unless arg == false
-      end
-
-      def validate_fill_color(arg)
-        colorify(arg, @custom_colors)
-      end
-
-      def validate_dir(arg)
-        ensure_dir_created(arg)
-      end
-
-      def validate_columns(arg)
-        raise 'columns must be an integer' unless arg.respond_to? :to_i
-        arg.to_i
-      end
-
-      def validate_rows(arg)
-        raise 'columns must be an integer' unless columns.respond_to? :to_i
-        count = if range == :all
-                  @deck_size
-                else
-                  count = range.to_a.length
-                end
-        return 1 if count <= columns
-        return arg if arg.respond_to? :to_i
-        (count.to_f / columns.to_f).ceil
-      end
-
-      def full_filename(i=nil)
-        if i.nil?
-          "#{dir}/#{file}"
-        else
-          "#{dir}/#{prefix}#{count_format % i}.png"
-        end
-      end
-
-      def crop_coords(x, y, deck_w, deck_h)
-        case crop_marks
-        when false
-          []
-        when :full
-          [
-            {
-              # Vertical, Left
-              x1: x + trim + crop_margin_left, y1: 0,
-              x2: x + trim + crop_margin_left, y2: height - margin + 1
-            },
-            {
-              # Vertical, Right
-              x1: x + deck_w - trim - crop_margin_right, y1: 0,
-              x2: x + deck_w - trim - crop_margin_right, y2: height - margin + 1
-            },
-            {
-              # Horizontal, Top
-              x1: 0                 , y1: y + trim + crop_margin_top,
-              x2: width - margin + 1, y2: y + trim + crop_margin_top
-            },
-            {
-              # Horizontal, Bottom
-              x1: 0         , y1: y + deck_h - trim - crop_margin_bottom,
-              x2: width - margin + 1, y2: y + deck_h - trim - crop_margin_bottom
-            },
-          ]
-        else # e.g. :margin
-          [
-            { # Vertical, Upper-left
-              x1: x + trim + crop_margin_left, y1: 0,
-              x2: x + trim + crop_margin_left, y2: margin - 1
-            },
-            { # Vertical , Upper-right
-              x1: x + deck_w - trim - crop_margin_right, y1: 0,
-              x2: x + deck_w - trim - crop_margin_right, y2: margin - 1
-            },
-            { # Vertical , Lower-left
-              x1: x + trim + crop_margin_left, y1: height,
-              x2: x + trim + crop_margin_left, y2: height - margin + 1
-            },
-            { # Vertical , Lower-right
-              x1: x + deck_w - trim - crop_margin_right, y1: height,
-              x2: x + deck_w - trim - crop_margin_right, y2: height - margin + 1
-            },
-            { # Horizontal, Upper-left
-              x1: 0         , y1: y + trim + crop_margin_top,
-              x2: margin - 1, y2: y + trim + crop_margin_top
-            },
-            { # Horizontal, Upper-Right
-              x1: width             , y1: y + trim + crop_margin_top,
-              x2: width - margin + 1, y2: y + trim + crop_margin_top
-            },
-            { # Horizontal, Lower-Left
-              x1: 0         , y1: y + deck_h - trim - crop_margin_bottom,
-              x2: margin - 1, y2: y + deck_h - trim - crop_margin_bottom
-            },
-            { # Horizontal, Lower-Right
-              x1: width,              y1: y + deck_h - trim - crop_margin_bottom,
-              x2: width - margin + 1, y2: y + deck_h - trim - crop_margin_bottom
-            },
-          ]
-        end
-      end
-
-    end
-
-  end
-end
+require 'cairo'
+require_relative 'arg_loader'
+require_relative 'color_validator'
+require_relative 'dir_validator'
+
+module Squib::Args
+  module_function def extract_sheet(opts, deck, dsl_method_defaults = {})
+    Sheet.new(dsl_method_defaults).extract! opts, deck
+  end
+
+  class Sheet
+    include ArgLoader
+    include ColorValidator
+    include DirValidator
+
+    def initialize(dsl_method_defaults = {})
+      @dsl_method_defaults = dsl_method_defaults
+    end
+
+    def self.parameters
+      {
+        count_format: '%02d',
+        crop_margin_bottom: 0,
+        crop_margin_left: 0,
+        crop_margin_right: 0,
+        crop_margin_top: 0,
+        crop_marks: false,
+        crop_stroke_color: :black,
+        crop_stroke_dash: '',
+        crop_stroke_width: 1.5,
+        dir: '_output',
+        file: 'sheet.png',
+        fill_color: :white,
+        gap: 0,
+        height: 2550,
+        margin: 75,
+        prefix: 'sheet_',
+        suffix: '',
+        rows: :infinite,
+        columns: 5,
+        trim_radius: 0,
+        trim: 0,
+        width: 3300,
+        range: :all,
+        rtl: false,
+      }
+    end
+
+    def self.expanding_parameters
+      [] # none of them
+    end
+
+    def self.params_with_units
+      [ :crop_margin_bottom, :crop_margin_left, :crop_margin_right,
+        :crop_margin_top, :gap, :height, :margin, :trim_radius, :trim,
+        :width
+      ]
+    end
+
+    def validate_crop_stroke_dash(arg)
+      arg.to_s.split.collect do |x|
+        UnitConversion.parse(x, @deck.dpi, @deck.cell_px).to_f
+      end
+    end
+
+    def validate_crop_marks(arg)
+      arg.to_s.downcase.to_sym unless arg == false
+    end
+
+    def validate_fill_color(arg)
+      colorify(arg, @deck.custom_colors)
+    end
+
+    def validate_dir(arg)
+      ensure_dir_created(arg)
+    end
+
+    def validate_columns(arg)
+      raise 'columns must be an integer' unless arg.respond_to? :to_i
+      arg.to_i
+    end
+
+    def validate_rows(arg)
+      raise 'columns must be an integer' unless columns.respond_to? :to_i
+      count = if range == :all
+                @deck.size
+              else
+                count = range.to_a.length
+              end
+      return 1 if count <= columns
+      return arg if arg.respond_to? :to_i
+      (count.to_f / columns.to_f).ceil
+    end
+
+    def full_filename(i=nil)
+      if i.nil?
+        "#{dir}/#{file}"
+      else
+        "#{dir}/#{prefix}#{count_format % i}#{suffix}.png"
+      end
+    end
+
+    def crop_coords(x, y, deck_w, deck_h)
+      case crop_marks
+      when false
+        []
+      when :full
+        [
+          {
+            # Vertical, Left
+            x1: x + trim + crop_margin_left, y1: 0,
+            x2: x + trim + crop_margin_left, y2: height - margin + 1
+          },
+          {
+            # Vertical, Right
+            x1: x + deck_w - trim - crop_margin_right, y1: 0,
+            x2: x + deck_w - trim - crop_margin_right, y2: height - margin + 1
+          },
+          {
+            # Horizontal, Top
+            x1: 0                 , y1: y + trim + crop_margin_top,
+            x2: width - margin + 1, y2: y + trim + crop_margin_top
+          },
+          {
+            # Horizontal, Bottom
+            x1: 0         , y1: y + deck_h - trim - crop_margin_bottom,
+            x2: width - margin + 1, y2: y + deck_h - trim - crop_margin_bottom
+          },
+        ]
+      else # e.g. :margin
+        [
+          { # Vertical, Upper-left
+            x1: x + trim + crop_margin_left, y1: 0,
+            x2: x + trim + crop_margin_left, y2: margin - 1
+          },
+          { # Vertical , Upper-right
+            x1: x + deck_w - trim - crop_margin_right, y1: 0,
+            x2: x + deck_w - trim - crop_margin_right, y2: margin - 1
+          },
+          { # Vertical , Lower-left
+            x1: x + trim + crop_margin_left, y1: height,
+            x2: x + trim + crop_margin_left, y2: height - margin + 1
+          },
+          { # Vertical , Lower-right
+            x1: x + deck_w - trim - crop_margin_right, y1: height,
+            x2: x + deck_w - trim - crop_margin_right, y2: height - margin + 1
+          },
+          { # Horizontal, Upper-left
+            x1: 0         , y1: y + trim + crop_margin_top,
+            x2: margin - 1, y2: y + trim + crop_margin_top
+          },
+          { # Horizontal, Upper-Right
+            x1: width             , y1: y + trim + crop_margin_top,
+            x2: width - margin + 1, y2: y + trim + crop_margin_top
+          },
+          { # Horizontal, Lower-Left
+            x1: 0         , y1: y + deck_h - trim - crop_margin_bottom,
+            x2: margin - 1, y2: y + deck_h - trim - crop_margin_bottom
+          },
+          { # Horizontal, Lower-Right
+            x1: width,              y1: y + deck_h - trim - crop_margin_bottom,
+            x2: width - margin + 1, y2: y + deck_h - trim - crop_margin_bottom
+          },
+        ]
+      end
+    end
+
+  end
+
+end