squib 0.0.2 → 0.0.3

data/lib/squib/input_helpers.rb

@@ -1,140 +1,194 @@
-require 'squib/constants'
-
-module Squib
-  # :nodoc:
-  # @api private
-  module InputHelpers
-
-    # :nodoc:
-    # @api private
-    def needs(opts, params)
-      opts = layoutify(opts) if params.include? :layout
-      opts = Squib::SYSTEM_DEFAULTS.merge(opts)
-      opts = rangeify(opts) if params.include? :range      
-      opts = fileify(opts) if params.include? :file
-      opts = fileify(opts, false, true) if params.include? :file_to_save
-      opts = fileify(opts, true) if params.include? :files
-      opts = colorify(opts) if params.include? :color
-      opts = colorify(opts, true) if params.include? :nillable_color
-      opts = dirify(opts) if params.include? :dir
-      opts = dirify(opts, true) if params.include? :creatable_dir
-      opts = fontify(opts) if params.include? :font
-      opts = radiusify(opts) if params.include? :radius
-      opts = svgidify(opts) if params.include? :svgid
-      opts = formatify(opts) if params.include? :formats
-      opts
-    end
-    module_function :needs
-
-    # :nodoc:
-    # @api private
-    def layoutify(opts)
-      unless opts[:layout].nil?
-        entry = @layout[opts[:layout].to_s]
-        unless entry.nil?
-          entry.each do |key, value|
-            opts[key.to_sym] ||= entry[key]
-          end
-        else 
-          logger.warn "Layout entry #{opts[:layout]} does not exist." 
-        end
-      end
-      opts
-    end
-    module_function :layoutify
-
-    # :nodoc:
-    # @api private
-    def formatify(opts)
-      opts[:format] = [opts[:format]].flatten
-      opts
-    end
-    module_function :formatify
-
-    # :nodoc:
-    # @api private
-    def rangeify (opts)
-      range = opts[:range]
-      raise 'Range cannot be nil' if range.nil?
-      range = 0..(@cards.size-1) if range == :all
-      range = range..range if range.is_a? Integer
-      if range.max > (@cards.size-1)
-        raise "#{range} is outside of deck range of 0..#{@cards.size-1}"
-      end
-      opts[:range] = range
-      opts
-    end
-    module_function :rangeify
-
-    # :nodoc:
-    # @api private
-    def fileify(opts, expand_singletons=false, allow_non_exist=false)
-      opts[:file] = [opts[:file]] * @cards.size if expand_singletons
-      files = [opts[:file]].flatten
-      files.each do |file|
-        unless File.exists?(file) || allow_non_exist
-          raise "File #{File.expand_path(file)} does not exist!"
-        end
-      end
-      opts
-    end
-    module_function :fileify
-
-    # :nodoc:
-    # @api private
-    def dirify(opts, allow_create=false)
-      return opts if Dir.exists?(opts[:dir])
-      if allow_create
-        Squib.logger.warn "Dir #{opts[:dir]} does not exist, creating it."
-        Dir.mkdir opts[:dir]
-        return opts 
-      else
-        raise "#{opts[:dir]} does not exist!"
-      end
-    end
-    module_function :dirify
-
-    # :nodoc:
-    # @api private
-    def colorify(opts, nillable=false)
-      if nillable # for optional color arguments like text hints
-        opts[:color] = Cairo::Color.parse(opts[:color]) unless opts[:color].nil?
-      else
-        opts[:color] = Cairo::Color.parse(opts[:color])
-      end
-      opts
-    end
-    module_function :colorify
-
-    # :nodoc:
-    # @api private
-    def fontify (opts)
-      opts[:font] = @font if opts[:font]==:use_set
-      opts[:font] = Squib::SYSTEM_DEFAULTS[:default_font] if opts[:font] == :default
-      opts 
-    end
-    module_function :fontify 
-
-    # :nodoc:
-    # @api private
-    def radiusify(opts)
-      unless opts[:radius].nil?
-        opts[:x_radius] = opts[:radius]
-        opts[:y_radius] = opts[:radius]
-      end
-      opts
-    end
-    module_function :radiusify
-
-    # :nodoc:
-    # @api private
-    def svgidify(opts)
-      unless opts[:id].nil?
-        opts[:id] = '#' << opts[:id] unless opts[:id].start_with? '#'
-      end
-      opts
-    end
-    module_function :svgidify
-
-  end
+require 'squib/constants'
+
+module Squib
+  # :nodoc:
+  # @api private
+  module InputHelpers
+
+    # :nodoc:
+    # @api private
+    def needs(opts, params)
+      Squib.logger.debug {"Given opts: #{opts}"}
+      opts = layoutify(opts) if params.include? :layout
+      opts = Squib::SYSTEM_DEFAULTS.merge(opts)
+      opts = expand_singletons(opts, params)
+      opts = rangeify(opts) if params.include? :range      
+      opts = fileify(opts) if params.include? :file
+      opts = fileify(opts, false) if params.include? :file_to_save
+      opts = colorify(opts, true) if params.include? :nillable_color
+      opts = dirify(opts, :dir, true) if params.include? :creatable_dir
+      opts = dirify(opts, :img_dir, false) if params.include? :img_dir
+      opts = fileify(opts, false) if params.include? :files
+      opts = colorify(opts) if params.include? :color
+      opts = colorify(opts, false, :fill_color) if params.include? :fill_color
+      opts = colorify(opts, false, :stroke_color) if params.include? :stroke_color
+      opts = fontify(opts) if params.include? :font
+      opts = radiusify(opts) if params.include? :rect_radius
+      opts = svgidify(opts) if params.include? :svgid
+      opts = formatify(opts) if params.include? :formats
+      opts = rotateify(opts) if params.include? :rotate
+      opts
+    end
+    module_function :needs
+
+    # :nodoc:
+    # @api private
+    def expand_singletons(opts, needed_params)
+      Squib::EXPANDING_PARAMS.each_pair do |param_name, api_param|
+        if needed_params.include? param_name
+          unless opts[api_param].respond_to?(:each)
+            opts[api_param] = [opts[api_param]] * @cards.size 
+          end
+        end
+      end
+      Squib.logger.debug {"After expand_singletons: #{opts}"}
+      opts
+    end
+    module_function :expand_singletons
+
+    # Layouts have to come before, so we repeat expand_singletons here
+    # :nodoc:
+    # @api private
+    def layoutify(opts)
+      unless opts[:layout].respond_to?(:each) 
+        opts[:layout] = [opts[:layout]] * @cards.size 
+      end
+      opts[:layout].each_with_index do |layout, i|
+        unless layout.nil?
+          entry = @layout[layout.to_s]
+          unless entry.nil?
+            entry.each do |key, value|
+              opts[key.to_sym] = [] if opts[key.to_sym].nil?
+              opts[key.to_sym][i] ||= entry[key] #don't override if it's already there
+            end
+          else 
+            Squib.logger.warn ("Layout entry '#{layout}' does not exist." )
+          end
+        end
+      end
+      Squib.logger.debug {"After layoutify: #{opts}"}
+      opts
+    end
+    module_function :layoutify
+
+    # :nodoc:
+    # @api private
+    def formatify(opts)
+      opts[:format] = [opts[:format]].flatten
+      opts
+    end
+    module_function :formatify
+
+    # :nodoc:
+    # @api private
+    def rangeify (opts)
+      range = opts[:range]
+      raise 'Range cannot be nil' if range.nil?
+      range = 0..(@cards.size-1) if range == :all
+      range = range..range if range.is_a? Integer
+      if range.max > (@cards.size-1)
+        raise ArgumentError.new("#{range} is outside of deck range of 0..#{@cards.size-1}")
+      end
+      opts[:range] = range
+      Squib.logger.debug {"After rangeify: #{opts}"}
+      opts
+    end
+    module_function :rangeify
+
+    # :nodoc:
+    # @api private
+    def fileify(opts, file_must_exist=true)
+      [opts[:file]].flatten.each do |file|
+        if file_must_exist and !File.exists?(file) 
+          raise "File #{File.expand_path(file)} does not exist!"
+        end
+      end
+      opts
+    end
+    module_function :fileify
+
+    # :nodoc:
+    # @api private
+    def dirify(opts, key, allow_create=false)
+      return opts if Dir.exists?(opts[key])
+      if allow_create
+        Squib.logger.warn {"Dir #{opts[key]} does not exist, creating it."}
+        Dir.mkdir opts[key]
+        return opts 
+      else
+        raise "'#{opts[key]}' does not exist!"
+      end
+    end
+    module_function :dirify
+
+    # :nodoc:
+    # @api private
+    def colorify(opts, nillable=false, key=:color)
+      opts[key].each_with_index do |color, i|
+        unless nillable && color.nil?
+          if @custom_colors.key? color.to_s
+            color = @custom_colors[color.to_s]
+          end
+          opts[key][i] = Cairo::Color.parse(color)
+        end
+      end
+      Squib.logger.debug {"After colorify: #{opts}"}
+      opts
+    end
+    module_function :colorify
+
+    # :nodoc:
+    # @api private
+    def fontify (opts)
+      opts[:font].each_with_index do |font, i|
+        opts[:font][i] = @font if font==:use_set
+        opts[:font][i] = Squib::SYSTEM_DEFAULTS[:default_font] if font == :default
+      end
+      Squib.logger.debug {"After fontify: #{opts}"}
+      opts 
+    end
+    module_function :fontify 
+
+    # :nodoc:
+    # @api private
+    def radiusify(opts)
+      opts[:radius].each_with_index do |radius, i| 
+        unless radius.nil?
+          opts[:x_radius][i] = radius
+          opts[:y_radius][i] = radius
+        end
+      end
+      Squib.logger.debug {"After radiusify: #{opts}"}
+      opts
+    end
+    module_function :radiusify
+
+    # :nodoc:
+    # @api private
+    def svgidify(opts)
+      opts[:id].each_with_index do |id, i|
+        unless id.nil?
+          opts[:id][i] = '#' << id unless id.start_with? '#'
+        end
+      end
+      Squib.logger.debug {"After svgidify: #{opts}"}
+      opts
+    end
+    module_function :svgidify
+
+    # :nodoc:
+    # @api private
+    def rotateify(opts)
+      case opts[:rotate]
+      when true, :clockwise
+        opts[:angle] = 0.5 * Math::PI
+      when :counterclockwise
+        opts[:angle] = 1.5 * Math::PI
+      end
+      Squib.logger.debug {"After rotateify: #{opts}"}
+      opts
+    end
+    module_function :svgidify
+
+  end
 end

data/lib/squib/progress.rb

@@ -0,0 +1,38 @@
+require 'ruby-progressbar'
+
+module Squib
+
+  # :nodoc:
+  # @api private
+  class DoNothing
+    def increment
+    end
+
+    def finish
+    end
+  end
+
+  # A facade that handles (or doesn't) the progress bar on the console
+  #
+  # :nodoc:
+  # @api private
+  class Progress
+    attr_accessor :enabled
+
+    def initialize(enabled)
+      @enabled = enabled
+    end
+
+    def start(title="", total=100, &block)
+      if @enabled
+        @bar = ProgressBar.create(title: title, total: total, format: '%t <%B> %p%% %a') 
+        yield(@bar)
+        @bar.finish
+      else 
+        yield(Squib::DoNothing.new)
+      end
+    end
+  end
+
+
+end

data/lib/squib/project_template/.gitignore

@@ -1,3 +1,4 @@
-_output/*.png
-_output/*.pdf
-
+_output/*.png
+_output/*.pdf
+~$*
+.DS_Store

data/lib/squib/project_template/ABOUT.md

@@ -1,19 +1,19 @@
-My Awesome Game
-===============
-
-Check out my awesome game! 
-
-
-Objective
----------
-
-
-
-Gameplay
---------
-
-
-
-Ending the Game
----------------
-
+My Awesome Game
+===============
+
+Check out my awesome game! 
+
+
+Objective
+---------
+
+
+
+Gameplay
+--------
+
+
+
+Ending the Game
+---------------
+

data/lib/squib/project_template/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
-
+source 'https://rubygems.org'
+
 gem 'squib'

data/lib/squib/project_template/PNP NOTES.md

@@ -1,4 +1,4 @@
-Print and Play Notes
-====================
-
+Print and Play Notes
+====================
+
 Fill this out to give tips on how to play this with print and play.

data/lib/squib/project_template/config.yml

@@ -1,2 +1,20 @@
-# Settings in the config.yml are overriding Squib's defaults. Anything in the main script will override this.
-#dpi: 72
+# Settings in the config.yml are overriding Squib's defaults. Anything in the main script will override this.
+
+# DPI is used in making PDFs and in unit conversions
+# Default: 300
+#dpi: 72
+
+# Text hints are used to show the boundaries of text boxes.
+# Can be enabled/disabled at the command-level, or set globally with `set`
+#text_hint: '#F00'
+
+# Show progress bars on the command line for potentially long-running operations
+#progress_bars: true
+
+#Enable some custom colors that can be used in any color
+#custom_colors:
+#  foo: '#abc'
+
+#For reading image file command (e.g. png and svg), read from this directory instead
+#img_dir: img-color
+#img_dir: img-bw