squib 0.0.3 → 0.0.4

data/lib/squib/commands/new.rb

@@ -1,44 +1,44 @@
-require 'fileutils'
-
-module Squib
-  # Squib's command-line options
-  module Commands
-
-    # Generate a new Squib project into a fresh directory.
-    #
-    # Provides conventions for using Git (you are using version control, right??). 
-    # Also provides some basic layout and config files to start from, along with templates for instructions and other notes you don't want to forget.
-    # 
-    #
-    # @example
-    #   squib new foo-blasters
-    #   cd foo-blasters
-    #   ruby deck.rb
-    #   git init
-    #   git add .
-    #   git commit -m "Starting my cool new game using Squib!"
-    #
-    # @api public
-    class New
-
-      # :nodoc:
-      # @api private 
-      def process(args)
-        raise ArgumentError.new('Please specify a path.') if args.empty?
-
-        new_project_path = File.expand_path(args.join(" "), Dir.pwd)
-        template_path = File.expand_path('../project_template', File.dirname(__FILE__))
-
-        FileUtils.mkdir_p new_project_path
-        if !Dir["#{new_project_path}/**/*"].empty?
-          $stderr.puts "#{new_project_path} exists and is not empty. Doing nothing and quitting."
-        else
-          Dir.chdir(new_project_path) do
-            FileUtils.cp_r template_path + '/.', new_project_path
-          end
-        end
-      end
-
-    end
-  end
+require 'fileutils'
+
+module Squib
+  # Squib's command-line options
+  module Commands
+
+    # Generate a new Squib project into a fresh directory.
+    #
+    # Provides conventions for using Git (you are using version control, right??). 
+    # Also provides some basic layout and config files to start from, along with templates for instructions and other notes you don't want to forget.
+    # 
+    #
+    # @example
+    #   squib new foo-blasters
+    #   cd foo-blasters
+    #   ruby deck.rb
+    #   git init
+    #   git add .
+    #   git commit -m "Starting my cool new game using Squib!"
+    #
+    # @api public
+    class New
+
+      # :nodoc:
+      # @api private 
+      def process(args)
+        raise ArgumentError.new('Please specify a path.') if args.empty?
+
+        new_project_path = File.expand_path(args.join(" "), Dir.pwd)
+        template_path = File.expand_path('../project_template', File.dirname(__FILE__))
+
+        FileUtils.mkdir_p new_project_path
+        if !Dir["#{new_project_path}/**/*"].empty?
+          $stderr.puts "#{new_project_path} exists and is not empty. Doing nothing and quitting."
+        else
+          Dir.chdir(new_project_path) do
+            FileUtils.cp_r template_path + '/.', new_project_path
+          end
+        end
+      end
+
+    end
+  end
 end

data/lib/squib/constants.rb

@@ -1,105 +1,109 @@
-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,
-      :blend => :none,
-      :color => :black,
-      :default_font => 'Arial 36',
-      :dir => "_output",
-      :ellipsize => :end,
-      :fill_color => '#0000',
-      :force_id => false,
-      :font => :use_set,
-      :format => :png,
-      :gap => 0,
-      :height => :native,
-      :hint => :off,
-      :img_dir => '.',
-      :justify => false,
-      :margin => 75,
-      :markup => false,
-      :prefix => "card_",
-      :progress_bar => false,
-      :range => :all,
-      :rotate => false,
-      :sheet => 0,
-      :spacing => 0,
-      :str => '',
-      :stroke_color => :black,
-      :stroke_width => 2.0,
-      :trim => 0,
-      :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,
-    }
-
-    # Squib's configuration defaults
-    # 
-    # @api public
-    CONFIG_DEFAULTS = { 
-      'custom_colors' => {},
-      'dpi' => 300,
-      'hint' => :none,
-      'progress_bar' => false,
-      'img_dir' => '.',
-    }
-
-    # 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`
-    #
-    # 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,
-          :blend => :blend,
-          :circle_radius => :radius,
-          :color => :color,
-          :ellipsize => :ellipsize,
-          :files => :file,
-          :fill_color => :fill_color,
-          :force_svgid => :force_id,
-          :font => :font,
-          :height => :height,
-          :hint => :hint,
-          :justify => :justify,
-          :layout => :layout,
-          :markup => :markup,
-          :rect_radius => :radius,
-          :spacing => :spacing,
-          :str => :str,
-          :stroke_color => :stroke_color,
-          :stroke_width => :stroke_width,
-          :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,
-          :y2 => :y3,
-          :y_radius => :y_radius,
-      }
+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,
+      :blend => :none,
+      :color => :black,
+      :default_font => 'Arial 36',
+      :dir => "_output",
+      :ellipsize => :end,
+      :fill_color => '#0000',
+      :force_id => false,
+      :font => :use_set,
+      :font_size => nil,
+      :format => :png,
+      :gap => 0,
+      :height => :native,
+      :hint => :off,
+      :img_dir => '.',
+      :justify => false,
+      :margin => 75,
+      :markup => false,
+      :prefix => "card_",
+      :progress_bar => false,
+      :range => :all,
+      :rotate => false,
+      :sheet => 0,
+      :spacing => 0,
+      :str => '',
+      :stroke_color => :black,
+      :stroke_width => 2.0,
+      :trim => 0,
+      :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,
+    }
+
+    # Squib's configuration defaults
+    # 
+    # @api public
+    CONFIG_DEFAULTS = { 
+      'custom_colors' => {},
+      'dpi' => 300,
+      'hint' => :none,
+      'progress_bar' => false,
+      'img_dir' => '.',
+    }
+
+    # 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`
+    #
+    # 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,
+          :ellipsize => :ellipsize,
+          :files => :file,
+          :fill_color => :fill_color,
+          :force_svgid => :force_id,
+          :font => :font,
+          :font_size => :font_size,
+          :height => :height,
+          :hint => :hint,
+          :justify => :justify,
+          :layout => :layout,
+          :markup => :markup,
+          :rect_radius => :radius,
+          :spacing => :spacing,
+          :str => :str,
+          :stroke_color => :stroke_color,
+          :stroke_width => :stroke_width,
+          :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,
+      }
 end

data/lib/squib/deck.rb

@@ -1,117 +1,171 @@
-require 'yaml'
-require 'pp'
-require 'squib'
-require 'squib/card'
-require 'squib/progress'
-require 'squib/input_helpers'
-require 'squib/constants'
-
-# 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
-    include Squib::InputHelpers
-
-    # :nodoc:
-    # @api private 
-    attr_reader :width, :height
-    
-    # :nodoc:
-    # @api private 
-    attr_reader :cards
-    
-    # :nodoc:
-    # @api private 
-    attr_reader :text_hint
-
-    # :nodoc:
-    # @api private 
-    attr_reader :layout, :config
-
-    # 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
-    # @param height: [Integer] the height of each card in pixels
-    # @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 Yaml file used for global settings of this deck
-    # @param layout: [String] the Yaml file used for layouts.
-    # @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)
-      @width=width; @height=height
-      @dpi = dpi
-      @font = Squib::SYSTEM_DEFAULTS[:default_font]
-      @cards = []
-      @custom_colors = {}
-      @img_dir = '.'
-      @progress_bar = Squib::Progress.new(false)
-      cards.times{ @cards << Squib::Card.new(self, width, height) }
-      load_config(config)
-      @layout = YAML.load_file(layout) unless layout.nil?
-      if block_given?
-        instance_eval(&block)
-      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
-
-    # Shows a descriptive place of the location
-    def location(opts)
-      opts[:layout] || (" @ #{opts[:x]},#{opts[:y]}")
-    end
-
-    # Load the configuration file, if exists, overriding hardcoded defaults
-    # @api private
-    def load_config(file)
-      if File.exists?(file) && config = YAML.load_file(file)
-        config = Squib::CONFIG_DEFAULTS.merge(config)
-        @dpi = config['dpi'].to_i
-        @text_hint = config['text_hint']
-        @progress_bar.enabled = config['progress_bars']
-        @custom_colors = config['custom_colors']
-        @img_dir = config['img_dir']
-      end
-    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
+require 'yaml'
+require 'pp'
+require 'squib'
+require 'squib/card'
+require 'squib/progress'
+require 'squib/input_helpers'
+require 'squib/constants'
+
+# 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
+    include Squib::InputHelpers
+
+    # :nodoc:
+    # @api private 
+    attr_reader :width, :height
+    
+    # :nodoc:
+    # @api private 
+    attr_reader :cards
+    
+    # :nodoc:
+    # @api private 
+    attr_reader :text_hint
+
+    # :nodoc:
+    # @api private 
+    attr_reader :layout, :config
+
+    # 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
+    # @param height: [Integer] the height of each card in pixels
+    # @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 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)
+      @width=width; @height=height
+      @dpi = dpi
+      @font = Squib::SYSTEM_DEFAULTS[:default_font]
+      @cards = []
+      @custom_colors = {}
+      @img_dir = '.'
+      @progress_bar = Squib::Progress.new(false)
+      @text_hint = :off
+      cards.times{ @cards << Squib::Card.new(self, width, height) }
+      load_config(config)
+      load_layout(layout)
+      if block_given?
+        instance_eval(&block)
+      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
+
+    # Shows a descriptive place of the location
+    def location(opts)
+      opts[:layout] || (" @ #{opts[:x]},#{opts[:y]}")
+    end
+
+    # Load the configuration file, if exists, overriding hardcoded defaults
+    # @api private
+    def load_config(file)
+      if File.exists?(file) && config = YAML.load_file(file)
+        config = Squib::CONFIG_DEFAULTS.merge(config)
+        @dpi = config['dpi'].to_i
+        @text_hint = config['text_hint']
+        @progress_bar.enabled = config['progress_bars']
+        @custom_colors = config['custom_colors']
+        @img_dir = config['img_dir']
+      end
+    end
+
+    # Load the layout configuration file, if exists
+    # @api private
+    def load_layout(file)
+      return if file.nil?
+      @layout = {}
+      yml = YAML.load_file(file)
+      yml.each do |key, value|
+        @layout[key] = recurse_extends(yml, key, {})
+      end
+    end
+
+    # Process the extends recursively
+    # :nodoc:
+    # @api private
+    def recurse_extends(yml, key, visited )
+      assert_not_visited(key, visited)
+      return yml[key] unless has_extends?(yml, key)
+      visited[key] = key
+      parent_keys = [yml[key]['extends']].flatten
+      h = {}
+      parent_keys.each do |parent_key|
+        from_extends = yml[key].merge(recurse_extends(yml, parent_key, visited)) do |key, child_val, parent_val|
+          if child_val.to_s.strip.start_with?('+=')
+            parent_val + child_val.sub("+=",'').strip.to_f
+          elsif child_val.to_s.strip.start_with?('-=')
+            parent_val - child_val.sub("-=",'').strip.to_f
+          else 
+            child_val #child overrides parent when merging, no +=
+          end
+        end 
+        h = h.merge(from_extends) do |key, older_sibling, younger_sibling|
+          younger_sibling #when two siblings have the same entry, the "younger" (lower one) overrides
+        end
+      end
+      return h
+    end
+
+    # Does this layout entry have an extends field?
+    # i.e. is it a base-case or will it need recursion?
+    # :nodoc:
+    # @api private
+    def has_extends?(yml, key)
+      yml[key].key?('extends')
+    end
+
+    # Safeguard against malformed circular extends
+    # :nodoc:
+    # @api private
+    def assert_not_visited(key, visited)
+      if visited.key? key
+        raise "Invalid layout: circular extends with '#{key}'"
+      end
+    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