squib 0.8.0 → 0.9.0

data/lib/squib/conf.rb

@@ -1,117 +1,131 @@
-require 'forwardable'
-require 'squib'
-require 'squib/args/typographer'
-require 'yaml'
-
-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',
-      'warn_ellipsize'=> true,
-    }
-
-    #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
-
-    def warn_ellipsize?
-      @config_hash['warn_ellipsize']
-    end
-
-    private
-
-    def normalize_antialias
-      @config_hash['antialias'] = ANTIALIAS_OPTS[@config_hash['antialias'].downcase.strip]
-    end
-
-  end
-end
+require 'forwardable'
+require 'squib'
+require 'squib/args/typographer'
+require 'yaml'
+
+module Squib
+  # @api private
+  class Conf
+
+    DEFAULTS = {
+      'antialias'     => 'best',
+      'backend'       => 'memory',
+      'count_format'  => '%02d',
+      'custom_colors' => {},
+      'dir'           => '_output',
+      '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',
+      'warn_ellipsize'=> true,
+      'warn_png_scale'=> true,
+    }
+
+    #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
+      warn_unrecognized(yaml)
+      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
+
+    def warn_ellipsize?
+      @config_hash['warn_ellipsize']
+    end
+
+    def warn_png_scale?
+      @config_hash['warn_png_scale']
+    end
+
+    private
+
+    def normalize_antialias
+      @config_hash['antialias'] = ANTIALIAS_OPTS[@config_hash['antialias'].downcase.strip]
+    end
+
+    # Were there any unrecognized options in the config file?
+    def self.warn_unrecognized(yaml)
+      unrec = yaml.keys - DEFAULTS.keys
+      if unrec.any?
+        Squib::logger.warn "Unrecognized configuration option(s): #{unrec.join(',')}"
+      end
+    end
+
+  end
+end

data/lib/squib/constants.rb

@@ -1,178 +1,12 @@
-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
+module Squib
+
+    # System-wide default font
+    # :nodoc:
+    # @api public
+    DEFAULT_FONT = 'Arial 36'
+
+    # Used for inch-cm conversion
+    # :nodoc:
+    # @api private
+    INCHES_IN_CM = 0.393700787
+end

data/lib/squib/deck.rb

@@ -1,113 +1,113 @@
-require 'forwardable'
-require 'pp'
-require 'squib'
-require 'squib/args/unit_conversion'
-require 'squib/card'
-require 'squib/conf'
-require 'squib/constants'
-require 'squib/graphics/hand'
-require 'squib/graphics/showcase'
-require 'squib/layout_parser'
-require 'squib/progress'
-
-
-# The project module
-#
-# @api public
-module Squib
-
-  # The main interface to Squib. Provides a front-end porcelain whereas the Card class interacts with the graphics plumbing.
-  #
-  # @api public
-  class Deck
-    include Enumerable
-    extend Forwardable
-
-    # 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 :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, :conf, :dpi, :font
-
-    #
-    # deck.size is really just @cards.size
-    def_delegators :cards, :size
-
-    # Squib's constructor that sets the immutable properties.
-    #
-    # This is the starting point for Squib. In providing a block to the constructor, you have access to all of Deck's instance methods.
-    # The documented methods in Deck are the ones intended for use by most users.
-    # If your game requires multiple different sizes or orientations, I recommend using multiple `Squib::Deck`s in your `deck.rb`. You can modify the internals of `Squib::Deck` (e.g. `@cards`), but that's not recommended.
-    # @example
-    #   require 'squib'
-    #   Squib::Deck.new do
-    #     text str: 'Hello, World!"
-    #   end
-    #
-    # @param width [Integer] the width of each card in pixels. Supports unit conversion (e.g. '2.5in').
-    # @param height [Integer] the height of each card in pixels. Supports unit conversion (e.g. '3.5in').
-    # @param cards [Integer] the number of cards in the deck
-    # @param dpi [Integer] the pixels per inch when rendering out to PDF or calculating using inches.
-    # @param config [String] the file used for global settings of this deck
-    # @param layout [String, Array] load a YML file of custom layouts. Multiple files are merged sequentially, redefining collisons. See README and sample for details.
-    # @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)
-      @dpi           = dpi
-      @font          = SYSTEM_DEFAULTS[:default_font]
-      @cards         = []
-      @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)
-      @width         = Args::UnitConversion.parse width, dpi
-      @height        = Args::UnitConversion.parse height, dpi
-      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!
-      end
-    end
-
-    # Directly accesses the array of cards in the deck
-    #
-    # @api private
-    def [](key)
-      @cards[key]
-    end
-
-    # Iterates over each card in the deck
-    #
-    # @api private
-    def each(&block)
-      @cards.each { |card| block.call(card) }
-    end
-
-    # Use Logger to show more detail on the run
-    # :nodoc:
-    # @api private
-    def show_info(config, layout)
-      Squib::logger.info "Squib v#{Squib::VERSION}"
-      Squib::logger.info "  building #{@cards.size} #{@width}x#{@height} cards"
-      Squib::logger.info "  using #{@backend}"
-    end
-
-    ##################
-    ### PUBLIC API ###
-    ##################
-    require 'squib/api/background'
-    require 'squib/api/data'
-    require 'squib/api/image'
-    require 'squib/api/save'
-    require 'squib/api/settings'
-    require 'squib/api/shapes'
-    require 'squib/api/text'
-    require 'squib/api/units'
-
-  end
-end
+require 'forwardable'
+require 'pp'
+require 'squib'
+require 'squib/args/unit_conversion'
+require 'squib/card'
+require 'squib/conf'
+require 'squib/constants'
+require 'squib/graphics/hand'
+require 'squib/graphics/showcase'
+require 'squib/layout_parser'
+require 'squib/progress'
+
+
+# The project module
+#
+# @api public
+module Squib
+
+  # The main interface to Squib. Provides a front-end porcelain whereas the Card class interacts with the graphics plumbing.
+  #
+  # @api public
+  class Deck
+    include Enumerable
+    extend Forwardable
+
+    # 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 :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, :conf, :dpi, :font
+
+    #
+    # deck.size is really just @cards.size
+    def_delegators :cards, :size
+
+    # Squib's constructor that sets the immutable properties.
+    #
+    # This is the starting point for Squib. In providing a block to the constructor, you have access to all of Deck's instance methods.
+    # The documented methods in Deck are the ones intended for use by most users.
+    # If your game requires multiple different sizes or orientations, I recommend using multiple `Squib::Deck`s in your `deck.rb`. You can modify the internals of `Squib::Deck` (e.g. `@cards`), but that's not recommended.
+    # @example
+    #   require 'squib'
+    #   Squib::Deck.new do
+    #     text str: 'Hello, World!"
+    #   end
+    #
+    # @param width [Integer] the width of each card in pixels. Supports unit conversion (e.g. '2.5in').
+    # @param height [Integer] the height of each card in pixels. Supports unit conversion (e.g. '3.5in').
+    # @param cards [Integer] the number of cards in the deck
+    # @param dpi [Integer] the pixels per inch when rendering out to PDF or calculating using inches.
+    # @param config [String] the file used for global settings of this deck
+    # @param layout [String, Array] load a YML file of custom layouts. Multiple files are merged sequentially, redefining collisons. See README and sample for details.
+    # @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)
+      @dpi           = dpi
+      @font          = DEFAULT_FONT
+      @cards         = []
+      @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)
+      @width         = Args::UnitConversion.parse width, dpi
+      @height        = Args::UnitConversion.parse height, dpi
+      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!
+      end
+    end
+
+    # Directly accesses the array of cards in the deck
+    #
+    # @api private
+    def [](key)
+      @cards[key]
+    end
+
+    # Iterates over each card in the deck
+    #
+    # @api private
+    def each(&block)
+      @cards.each { |card| block.call(card) }
+    end
+
+    # Use Logger to show more detail on the run
+    # :nodoc:
+    # @api private
+    def show_info(config, layout)
+      Squib::logger.info "Squib v#{Squib::VERSION}"
+      Squib::logger.info "  building #{@cards.size} #{@width}x#{@height} cards"
+      Squib::logger.info "  using #{@backend}"
+    end
+
+    ##################
+    ### PUBLIC API ###
+    ##################
+    require 'squib/api/background'
+    require 'squib/api/data'
+    require 'squib/api/image'
+    require 'squib/api/save'
+    require 'squib/api/settings'
+    require 'squib/api/shapes'
+    require 'squib/api/text'
+    require 'squib/api/units'
+
+  end
+end