squib 0.9.0 → 0.10.0

data/lib/squib/api/text.rb

@@ -1,61 +1,21 @@
-require 'squib/api/text_embed'
-require 'squib/args/box'
-require 'squib/args/card_range'
-require 'squib/args/draw'
-require 'squib/args/paragraph'
+require_relative 'text_embed'
+require_relative '../args/box'
+require_relative '../args/card_range'
+require_relative '../args/draw'
+require_relative '../args/paragraph'
 
 module Squib
   class Deck
 
-    # Renders a string at a given location, width, alignment, font, etc.
-    #
-    #   Unix-like newlines are interpreted even on Windows.
-    #   See the {file:samples/text-options.rb samples/text.rb} for a lengthy example.
-    #
-    # @example
-    #   text str: 'hello'
-    #   text str: 'hello', x: 50, y:50, align: center
-    #
-    # Options support Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    #
-    # @option opts range [Enumerable, :all] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
-    # @option opts str [String, Array] ('')  the string to be rendered. Must support `#to_s`. If the card responds to `#each`, it's mapped out one at a time across the cards.
-    # @option opts font [String] (Arial 36 or whatever was set with `set`) the Font description string, including family, styles, and size.
-    #   (e.g. `'Arial bold italic 12'`)
-    #   For the official documentation, see the [Pango docs](http://ruby-gnome2.sourceforge.jp/hiki.cgi?Pango%3A%3AFontDescription#style).
-    #   This [description](http://www.pygtk.org/pygtk2reference/class-pangofontdescription.html) is also quite good.
-    #   See the {file:samples/text-options.rb samples/text.rb} as well.
-    # @option opts font_size [Integer] (nil) an override of font string description, for scaling the font according to the size of the string
-    # @option opts x [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
-    # @option opts y [Integer] (0) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
-    # @option opts color [String] (:black) the color the font will render to. Gradients supported. See {file:README.md#Specifying_Colors___Gradients Specifying Colors}
-    # @option opts markup: [Boolean] (false) Enable markup parsing of `str` using the HTML-like Pango Markup syntax, defined [here](http://ruby-gnome2.sourceforge.jp/hiki.cgi?pango-markup) and [here](https://developer.gnome.org/pango/stable/PangoMarkupFormat.html). Also does other replacements, such as smart quotes, curly apostraphes, en- and em-dashes, and explict ellipses (not to be confused with ellipsize option). See README for full explanation.
-    # @option opts width [Integer, :auto] (:auto) the width of the box the string will be placed in. Stretches to the content by default.. Supports Unit Conversion, see {file:README.md#Units Units}.
-    # @option opts height [Integer, :auto] the height of the box the string will be placed in. Stretches to the content by default. Supports Unit Conversion, see {file:README.md#Units Units}.
-    # @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}
-    # @option opts wrap [:none, :word, :char, :word_char, true, false] (:word_char) When height is set, determines the behavior of how the string wraps. The `:word_char` option will break at words, but then fall back to characters when the word cannot fit.    #
-    #   Options are `:none, :word, :char, :word_char`. Also: `true` is the same as `:word_char`, `false` is the same as `:none`. Default `:word_char`
-    # @option opts spacing [Integer] (0) Adjust the spacing when the text is multiple lines. No effect when the text does not wrap.
-    # @option opts align [:left, right, :center] (:left) The alignment of the text
-    # @option opts justify [Boolean] (false) toggles whether or not the text is justified or not.
-    # @option opts valign [:top, :middle, :bottom] (:top) When width and height are set, align text vertically according to the ink extents of the text.
-    # @option opts ellipsize [:none, :start, :middle, :end, true, false] (:end) When width and height are set, determines the behavior of overflowing text. Also: `true` maps to `:end` and `false` maps to `:none`. Default `:end`
-    # @option opts angle [FixNum] (0) Rotation of the text in radians. Note that this rotates around the upper-left corner of the text box, making the placement of x-y coordinates slightly tricky.
-    # @option opts stroke_width [Decimal] (0.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
-    # @option opts stroke_color [String] (:black) the color with which to stroke the outside of the rectangle. {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
-    # @option opts stroke_strategy [:fill_first, :stroke_first] (:fill_first) specify whether the stroke is done before (thinner) or after (thicker) filling the shape. 
-    # @option opts dash [String] ('') define a dash pattern for the stroke. Provide a string with space-separated numbers that define the pattern of on-and-off alternating strokes, measured in pixels by defautl. Supports Unit Conversion, see {file:README.md#Units Units} (e.g. `'0.02in 0.02in'`).
-    # @option opts hint [String] (:nil) draw a rectangle around the text with the given color. Overrides global hints (see {Deck#hint}).
-    # @return [Array] Returns an Array of hashes keyed by :width and :height that mark the ink extents of the text rendered.
-    # @api public
+    # DSL method. See http://squib.readthedocs.org
     def text(opts = {})
       range = Args::CardRange.new(opts[:range], deck_size: size)
       para  = Args::Paragraph.new(font).load!(opts, expand_by: size, layout: layout)
-      box   = Args::Box.new(self, {width: :auto, height: :auto}).load!(opts, expand_by: size, layout: layout, dpi: dpi)
+      box   = Args::Box.new(self, { width: :auto, height: :auto }).load!(opts, expand_by: size, layout: layout, dpi: dpi)
       trans = Args::Transform.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
-      draw  = Args::Draw.new(custom_colors, {stroke_width: 0.0}).load!(opts, expand_by: size, layout: layout, dpi: dpi)
+      draw  = Args::Draw.new(custom_colors, { stroke_width: 0.0 }).load!(opts, expand_by: size, layout: layout, dpi: dpi)
       embed = TextEmbed.new(size, custom_colors, layout, dpi, img_dir)
-      yield(embed) if block_given? #store the opts for later use
+      yield(embed) if block_given? # store the opts for later use
       extents = Array.new(@cards.size)
       range.each { |i| extents[i] = @cards[i].text(embed, para[i], box[i], trans[i], draw[i]) }
       return extents

data/lib/squib/api/text_embed.rb

@@ -1,10 +1,10 @@
-require 'squib/args/box'
-require 'squib/args/card_range'
-require 'squib/args/embed_adjust'
-require 'squib/args/embed_key'
-require 'squib/args/input_file'
-require 'squib/args/paint'
-require 'squib/args/transform'
+require_relative '../args/box'
+require_relative '../args/card_range'
+require_relative '../args/embed_adjust'
+require_relative '../args/embed_key'
+require_relative '../args/input_file'
+require_relative '../args/paint'
+require_relative '../args/transform'
 
 module Squib
   class TextEmbed
@@ -42,12 +42,12 @@ module Squib
       key   = Args::EmbedKey.new.validate_key(opts[:key])
       range = Args::CardRange.new(opts[:range], deck_size: @deck_size)
       paint = Args::Paint.new(@custom_colors).load!(opts, expand_by: @deck_size, layout: @layout)
-      box   = Args::Box.new(self, {width: :native, height: :native}).load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
-      adjust= Args::EmbedAdjust.new.load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
+      box   = Args::Box.new(self, { width: :native, height: :native }).load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
+      adjust = Args::EmbedAdjust.new.load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
       trans = Args::Transform.new.load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
       ifile = Args::InputFile.new.load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
       svg_args = Args::SvgSpecial.new.load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
-      rule  = { type: :png, file: ifile, box: box, paint: paint, trans: trans, adjust: adjust }
+      rule = { type: :png, file: ifile, box: box, paint: paint, trans: trans, adjust: adjust }
       rule[:draw] = Proc.new do |card, x, y|
         i = card.index
         b = box[i]
@@ -76,8 +76,8 @@ module Squib
       key   = Args::EmbedKey.new.validate_key(opts[:key])
       range = Args::CardRange.new(opts[:range], deck_size: @deck_size)
       paint = Args::Paint.new(@custom_colors).load!(opts, expand_by: @deck_size, layout: @layout)
-      box   = Args::Box.new(self, {width: :native, height: :native}).load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
-      adjust= Args::EmbedAdjust.new.load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
+      box   = Args::Box.new(self, { width: :native, height: :native }).load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
+      adjust = Args::EmbedAdjust.new.load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
       trans = Args::Transform.new.load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
       ifile = Args::InputFile.new.load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
       rule  = { type: :png, file: ifile, box: box, paint: paint, trans: trans, adjust: adjust }

data/lib/squib/api/units.rb

@@ -1,28 +1,14 @@
-require 'squib/constants'
+require_relative '../constants'
 
 module Squib
   class Deck
 
-    # Given inches, returns the number of pixels according to the deck's DPI.
-    #
-    # @example
-    #   inches(2.5) # 750 (for default Deck::dpi of 300)
-    #
-    # @param n [Decimal], the number of inches
-    # @return [Decimal] the number of pixels, according to the deck's DPI
-    # @api public
+    # DSL method. See http://squib.readthedocs.org
     def inches(n)
       @dpi * n.to_f
     end
 
-    # Given cm, returns the number of pixels according to the deck's DPI.
-    #
-    # @example
-    #   cm(1) # 750 (for default Deck::dpi of 300)
-    #
-    # @param n [Decimal], the number of centimeters
-    # @return [Decimal] the number of pixels, according to the deck's DPI
-    # @api public
+    # DSL method. See http://squib.readthedocs.org
     def cm(n)
       @dpi * Squib::INCHES_IN_CM * n.to_f
     end

data/lib/squib/args/arg_loader.rb

@@ -1,5 +1,5 @@
-require 'squib/constants'
-require 'squib/conf'
+require_relative '../constants'
+require_relative '../conf'
 require 'ostruct'
 
 module Squib
@@ -84,10 +84,10 @@ module Squib
             attribute = "@#{param}"
             val = instance_variable_get(attribute)
             if val.respond_to? :each
-              new_val =  val.map.with_index{ |v, i| send(method, v, i) }
+              new_val = val.map.with_index{ |v, i| send(method, v, i) }
               instance_variable_set(attribute, new_val)
             else
-              instance_variable_set(attribute,send(method, val))
+              instance_variable_set(attribute, send(method, val))
             end
           end
         end
@@ -122,9 +122,9 @@ module Squib
 
       def convert_unit(arg, dpi)
         case arg.to_s.rstrip
-        when /in$/ #ends with "in"
+        when /in$/ # ends with "in"
           arg.rstrip[0..-2].to_f * dpi
-        when /cm$/ #ends with "cm"
+        when /cm$/ # ends with "cm"
           arg.rstrip[0..-2].to_f * dpi * INCHES_IN_CM
         else
           arg

data/lib/squib/args/box.rb

@@ -1,4 +1,4 @@
-require 'squib/args/arg_loader'
+require_relative 'arg_loader'
 
 module Squib
   # @api private
@@ -52,4 +52,4 @@ module Squib
     end
 
   end
-end
+end

data/lib/squib/args/card_range.rb

@@ -23,7 +23,7 @@ module Squib
         input = 0..(deck_size - 1) if input == :all
         input = (input.to_i)..(input.to_i) if input.respond_to? :to_i
         raise ArgumentError.new("#{input} must be Enumerable (i.e. respond_to :each).") unless input.respond_to? :each
-        raise ArgumentError.new("#{input} is outside of deck range of 0..#{deck_size-1}") if (!input.max.nil?) && (input.max > (deck_size - 1))
+        raise ArgumentError.new("#{input} is outside of deck range of 0..#{deck_size - 1}") if (!input.max.nil?) && (input.max > (deck_size - 1))
         input
       end
 

data/lib/squib/args/color_validator.rb

@@ -1,5 +1,5 @@
 module Squib
-  #@api private
+  # @api private
   module Args
     module ColorValidator
 
@@ -9,4 +9,4 @@ module Squib
 
     end
   end
-end
+end

data/lib/squib/args/coords.rb

@@ -1,4 +1,4 @@
-require 'squib/args/arg_loader'
+require_relative 'arg_loader'
 
 module Squib
   # @api private
@@ -30,4 +30,4 @@ module Squib
     end
 
   end
-end
+end

data/lib/squib/args/csv_opts.rb

@@ -0,0 +1,25 @@
+require 'csv'
+
+module Squib
+  # @api private
+  module Args
+    class CSV_Opts
+
+      def initialize(opts)
+        opts = opts.keep_if { |k, _v| CSV::DEFAULT_OPTIONS.key? k}
+        @hash = CSV::DEFAULT_OPTIONS.merge(opts).merge(required)
+      end
+
+      def to_hash
+        @hash
+      end
+
+      private
+
+      def required
+        { headers: true, converters: :numeric }
+      end
+
+    end
+  end
+end

data/lib/squib/args/dir_validator.rb

@@ -1,5 +1,5 @@
 module Squib
-  #@api private
+  # @api private
   module Args
     module DirValidator
 

data/lib/squib/args/draw.rb

@@ -1,6 +1,6 @@
 require 'cairo'
-require 'squib/args/arg_loader'
-require 'squib/args/color_validator'
+require_relative 'arg_loader'
+require_relative 'color_validator'
 
 module Squib
   # @api private

data/lib/squib/args/embed_adjust.rb

@@ -1,4 +1,4 @@
-require 'squib/args/arg_loader'
+require_relative 'arg_loader'
 
 module Squib
   # @api private

data/lib/squib/args/embed_key.rb

@@ -1,4 +1,4 @@
-require 'squib/args/arg_loader'
+require_relative 'arg_loader'
 
 module Squib
   # @api private

data/lib/squib/args/hand_special.rb

@@ -1,37 +1,37 @@
-require 'cairo'
-
-module Squib
-  # @api private
-  module Args
-
-    class HandSpecial
-      include ArgLoader
-
-      def initialize(card_height)
-        @card_height = card_height
-      end
-
-      def self.parameters
-        {
-          angle_range: (Math::PI / -4.0)..(Math::PI / 4),
-          radius: :auto
-        }
-      end
-
-      def self.expanding_parameters
-        [] # none of them
-      end
-
-      def self.params_with_units
-        [ :radius ]
-      end
-
-      def validate_radius(arg)
-        return 0.3 * @card_height if arg.to_s.downcase.strip == 'auto'
-        arg
-      end
-
-    end
-
-  end
-end
+require 'cairo'
+
+module Squib
+  # @api private
+  module Args
+
+    class HandSpecial
+      include ArgLoader
+
+      def initialize(card_height)
+        @card_height = card_height
+      end
+
+      def self.parameters
+        {
+          angle_range: (Math::PI / -4.0)..(Math::PI / 4),
+          radius: :auto
+        }
+      end
+
+      def self.expanding_parameters
+        [] # none of them
+      end
+
+      def self.params_with_units
+        [ :radius ]
+      end
+
+      def validate_radius(arg)
+        return 0.3 * @card_height if arg.to_s.downcase.strip == 'auto'
+        arg
+      end
+
+    end
+
+  end
+end

data/lib/squib/args/import.rb

@@ -1,4 +1,4 @@
-require 'squib/args/arg_loader'
+require_relative 'arg_loader'
 
 module Squib
   # @api private
@@ -37,4 +37,4 @@ module Squib
     end
 
   end
-end
+end

data/lib/squib/args/input_file.rb

@@ -1,4 +1,4 @@
-require 'squib/args/arg_loader'
+require_relative 'arg_loader'
 
 module Squib
   # @api private

data/lib/squib/args/paint.rb

@@ -1,6 +1,6 @@
 require 'cairo'
-require 'squib/args/arg_loader'
-require 'squib/args/color_validator'
+require_relative 'arg_loader'
+require_relative 'color_validator'
 
 module Squib
   # @api private
@@ -41,4 +41,4 @@ module Squib
 
     end
   end
-end
+end

data/lib/squib/args/paragraph.rb

@@ -1,5 +1,5 @@
-require 'squib/args/arg_loader'
-require 'squib/constants'
+require_relative '../constants'
+require_relative 'arg_loader'
 
 module Squib
   # @api private

data/lib/squib/args/save_batch.rb

@@ -1,5 +1,5 @@
-require 'squib/args/arg_loader'
-require 'squib/args/dir_validator'
+require_relative 'arg_loader'
+require_relative 'dir_validator'
 
 module Squib
   # @api private

data/lib/squib/args/scale_box.rb

@@ -1,4 +1,4 @@
-require 'squib/args/arg_loader'
+require_relative 'arg_loader'
 
 module Squib
   # @api private

data/lib/squib/args/sheet.rb

@@ -1,7 +1,7 @@
 require 'cairo'
-require 'squib/args/arg_loader'
-require 'squib/args/color_validator'
-require 'squib/args/dir_validator'
+require_relative 'arg_loader'
+require_relative 'color_validator'
+require_relative 'dir_validator'
 
 module Squib
   # @api private

data/lib/squib/args/showcase_special.rb

@@ -1,6 +1,6 @@
 require 'cairo'
-require 'squib/args/arg_loader'
-require 'squib/args/dir_validator'
+require_relative 'arg_loader'
+require_relative 'dir_validator'
 
 module Squib
   # @api private