squib/lib/squib/constants.rb

module Squib
    # Squib's defaults for when arguments are not specified in the command nor layouts.
    #
    # @api public
    SYSTEM_DEFAULTS = {
      :align => :left,
      :alpha => 1.0,
      :angle => 0,
      :angle_range => (Math::PI / -4.0)..(Math::PI / 4),
      :blend => :none,
      :color => :black,
      :columns => 5,
      :count_format => '%02d',
      :cx1 => 0,
      :cx2 => 0,
      :cy1 => 0,
      :cy2 => 0,
      :data => nil,
      :default_font => 'Arial 36',
      :dir => '_output',
      :dx => 0, # delta
      :dy => 0, # delta
      :ellipsize => :end,
      :face => :left,
      :fill_color => '#0000',
      :force_id => false,
      :font => :use_set,
      :font_size => nil,
      :format => :png,
      :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,
      :reflect_offset => 15,
      :reflect_percent => 0.25,
      :reflect_strength => 0.2,
      :range => :all,
      :rotate => false,
      :rows => :infinite,
      :scale => 0.85,
      :sheet => 0,
      :spacing => 0,
      :str => '',
      :stroke_color => :black,
      :stroke_width => 2.0,
      :trim => 0,
      :trim_radius => 38,
      :valign => :top,
      :width => :native,
      :wrap => true,
      :x => 0,
      :x1 => 100,
      :x2 => 150,
      :x3 => 100,
      :x_radius => 0,
      :y => 0,
      :y1 => 100,
      :y2 => 150,
      :y3 => 150,
      :y_radius => 0,
    }

    # These are parameters that are intended to be "expanded" across
    # range if they are singletons.
    #
    # For example: using a different font for each card, using one `text` command
    #
    # key: the internal name of the param (e.g. :files)
    # value: the user-facing API key (e.g. file: 'abc.png')
    #
    # @api private
    EXPANDING_PARAMS = {
          :align => :align,
          :alpha => :alpha,
          :angle => :angle,
          :blend => :blend,
          :circle_radius => :radius,
          :color => :color,
          :cx1 => :cx1,
          :cx2 => :cx2,
          :cy1 => :cy1,
          :cy2 => :cy2,
          :dx => :dx,
          :dy => :dy,
          :ellipsize => :ellipsize,
          :files => :file,
          :fill_color => :fill_color,
          :force_svgid => :force_id,
          :font => :font,
          :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,
          :wrap => :wrap,
          :x => :x,
          :x1 => :x1,
          :x2 => :x2,
          :x3 => :x3,
          :x_radius => :x_radius,
          :y => :y,
          :y1 => :y1,
          :y2 => :y2,
          :y3 => :y3,
          :y_radius => :y_radius,
      }

    # These parameters are considered for unit conversion
    #
    # For example
    #    text str: 'Hello, World', x: '1in'
    #
    # key: the internal name of the param (e.g. :circle_radius)
    # value: the user-facing API key (e.g. radius: '1in')
    UNIT_CONVERSION_PARAMS = {
      :circle_radius => :radius,
      :cx1 => :cx1,
      :cx2 => :cx2,
      :cy1 => :cy1,
      :cy2 => :cy2,
      :dx => :dx, # delta
      :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,
      :spacing => :spacing,
      :stroke_width => :stroke_width,
      :trim => :trim,
      :width => :width,
      :x => :x,
      :x1 => :x1,
      :x2 => :x2,
      :x3 => :x3,
      :x_radius => :x_radius,
      :y => :y,
      :y1 => :y1,
      :y2 => :y2,
      :y3 => :y3,
      :y_radius => :y_radius,
    }

    # Used for inch-cm conversion
    # :nodoc:
    # @api private
    INCHES_IN_CM = 0.393700787
end