squib 0.12.0 → 0.13.0

data/docs/dsl/data_frame.rst

@@ -1,85 +0,0 @@
-Squib::DataFrame
-================
-
-As described in :doc:`/data`, the ``Squib::DataFrame`` is what is returned by Squib's data import methods (:doc:`/dsl/csv` and :doc:`/dsl/xlsx`).
-
-It behaves like a ``Hash`` of ``Arrays``, so acessing an individual column can be done via the square brackets, e.g. ``data['title']``.
-
-Here are some other convenience methods in ``Squib::DataFrame``
-
-columns become methods
-----------------------
-
-Through magic of Ruby metaprogramming, every column also becomes a method on the data frame. So these two are equivalent:
-
-.. code-block:: irb
-
-  irb(main):002:0> data = Squib.csv file: 'basic.csv'
-  => #<Squib::DataFrame:0x00000003764550 @hash={"h1"=>[1, 3], "h2"=>[2, 4]}>
-  irb(main):003:0> data.h1
-  => [1, 3]
-  irb(main):004:0> data['h1']
-  => [1, 3]
-
-#columns
---------
-
-Returns an array of the column names in the data frame
-
-#ncolumns
----------
-
-Returns the number of columns in the data frame
-
-#col?(name)
------------
-
-Returns ``true`` if there is column ``name``.
-
-#row(i)
--------
-
-Returns a hash of values across all columns in the ``i``th row of the dataframe. Represents a single card.
-
-#nrows
-------
-
-Returns the number of rows the data frame has, computed by the maximum length of any column array.
-
-#to_json
---------
-
-Returns a ``json`` representation of the entire data frame.
-
-#to_pretty_json
----------------
-
-Returns a ``json`` representation of the entire data frame, formatted with indentation for human viewing.
-
-#to_pretty_text
----------------
-
-Returns a textual representation of the dataframe that emulates what the information looks like on an individual card. Here's an example:
-
-.. code-block:: text
-
-              ╭------------------------------------╮
-         Name | Mage                               |
-         Cost | 1                                  |
-  Description | You may cast 1 spell per turn      |
-        Snark | Magic, dude.                       |
-              ╰------------------------------------╯
-              ╭------------------------------------╮
-         Name | Rogue                              |
-         Cost | 2                                  |
-  Description | You always take the first turn.    |
-        Snark | I like to be sneaky                |
-              ╰------------------------------------╯
-              ╭------------------------------------╮
-         Name | Warrior                            |
-         Cost | 3                                  |
-  Description |
-        Snark | I have a long story to tell to tes |
-              | t the word-wrapping ability of pre |
-              | tty text formatting.               |
-              ╰------------------------------------╯

data/docs/dsl/deck.rst

@@ -1,45 +0,0 @@
-Squib::Deck.new
-===============
-
-The main interface to Squib. Yields to a block that is used for most of Squib's operations. The majority of the :doc:`DSL methods </dsl/index>` are instance methods of ``Squib::Deck``.
-
-Options
--------
-These options set immutable properties for the life of the deck. They are not intended to be changed in the middle of Squib's operation.
-
-width
-  default: ``825``
-
-  the width of each card in pixels, :doc:`including bleed </bleed>`. Supports :doc:`/units` (e.g. ``'2.5in'``).
-
-height
-  default: ``1125``
-
-  the height of each card in pixels, :doc:`including bleed </bleed>`. Supports :doc:`/units` (e.g. '3.5in').
-
-cards
-  default: ``1``
-
-  the number of cards in the deck
-
-dpi
-  default: ``300``
-
-  the pixels per inch when rendering out to PDF, doing :doc:`/units`, or other operations that require measurement.
-
-config
-  default: ``'config.yml'``
-
-  the file used for global settings of this deck, see :doc:`/config`. If the file is not found, Squib does not complain.
-
-  .. note ::
-
-    Since this option has ``config.yml`` as a default, then Squib automatically looks up a ``config.yml`` in the current working directory.
-
-layout
-  default: ``nil``
-
-  load a YML file of :doc:`custom layouts </layouts>`. Multiple files in an array are merged sequentially, redefining collisons in the merge process. If no layouts are found relative to the current working directory, then Squib checks for a `built-in layout <https://github.com/andymeneely/squib/tree/master/lib/squib/layouts>`_.
-
-Examples
---------

data/docs/dsl/disable_build.rst

@@ -1,25 +0,0 @@
-disable_build
-=============
-
-Disable the given build group for the rest of the build. Thus, code within the corresponding :doc:`/dsl/build` block will not be executed. See :doc:`/build_groups` for ways to use this effectively.
-
-
-Required Arguments
-------------------
-
-build_group_name
-  default: ``:all``
-  the name of the group to disable. Convention is to use a Ruby symbol.
-
-
-Examples
---------
-
-Can be used to disable a group (even if it's enabled via command line)::
-
-  Squib::Deck.new do
-    disable_build :pnp
-    build :pnp do
-      save_pdf
-    end
-  end

data/docs/dsl/disable_build_globally.rst

@@ -1,46 +0,0 @@
-disable_build_globally
-======================
-
-Disable the given build group for all future ``Squib::Deck`` runs.
-
-Essentially a convenience method for setting the ``SQUIB_BUILD`` environment variable. See :doc:`/build_groups` for ways to use this effectively.
-
-This is a member of the ``Squib`` module, so you must run it like this::
-
-  Squib.disable_build_globally :pdf
-
-The intended purpose of this method is to be able to alter the environment from other build scripts, such as a Rakefile.
-
-Required Arguments
-------------------
-
-build_group_name
-
-  the name of the build group to disable. Convention is to use a Ruby symbol.
-
-
-Examples
---------
-
-Can be used to disable a group, overriding setting the environment variable at the command line::
-
-  Squib.enable_build_globally :pdf
-  Squib.disable_build_globally :pdf
-
-  Squib::Deck.new do
-    build :pdf do
-      save_pdf #does not get run regardless of incoming environment
-    end
-  end
-
-But gets overridden by an individual ``Squib::Deck`` programmatically enabling a build via :doc:`/dsl/enable_build`::
-
-  Squib.enable_build_globally :pdf
-  Squib.disable_build_globally :pdf
-
-  Squib::Deck.new do
-    enable_build :pdf
-    build :pdf do
-      save_pdf # this will be run no matter what
-    end
-  end

data/docs/dsl/ellipse.rst

@@ -1,23 +0,0 @@
-ellipse
--------
-
-Draw an ellipse at the given coordinates. An ellipse is an oval that is defined by a bounding rectangle. To draw a circle, see :doc:`circle`.
-
-Options
-^^^^^^^
-.. include:: /args/expansion.rst
-
-.. include:: /args/xy.rst
-.. include:: /args/wh.rst
-.. include:: /args/draw.rst
-
-angle
-  default: 0
-
-  the angle at which to rotate the ellipse about it's upper-left corner
-
-.. include:: /args/range.rst
-.. include:: /args/layout.rst
-
-Examples
-^^^^^^^^

data/docs/dsl/enable_build.rst

@@ -1,25 +0,0 @@
-enable_build
-============
-
-Enable the given build group for the rest of the build. Thus, code within the corresponding :doc:`/dsl/build` block will be executed. See :doc:`/build_groups` for ways to use this effectively.
-
-
-Required Arguments
-------------------
-
-build_group_name
-  the name of the group to enable. Convention is to use a Ruby symbol.
-
-
-
-Examples
---------
-
-Can be used to disable a group (even if it's enabled via command line)::
-
-  Squib::Deck.new do
-    disable_build :pnp
-    build :pnp do
-      save_pdf
-    end
-  end

data/docs/dsl/enable_build_globally.rst

@@ -1,44 +0,0 @@
-disable_build_globally
-======================
-
-Enagle the given build group for all future ``Squib::Deck`` runs.
-
-Essentially a convenience method for setting the ``SQUIB_BUILD`` environment variable. See :doc:`/build_groups` for ways to use this effectively.
-
-This is a member of the ``Squib`` module, so you must run it like this::
-
-  Squib.enable_build_globally :pdf
-
-The intended purpose of this method is to be able to alter the environment from other build scripts, such as a Rakefile.
-
-Required Arguments
-------------------
-
-build_group_name
-
-  the name of the build group to enable. Convention is to use a Ruby symbol.
-
-
-Examples
---------
-
-Can be used to enable a group, overriding setting the environment variable at the command line::
-
-  Squib.enable_build_globally :pdf
-
-  Squib::Deck.new do
-    build :pdf do
-      save_pdf # this runs regardless of incoming environment
-    end
-  end
-
-But gets overridden by an individual ``Squib::Deck`` programmatically enabling a build via :doc:`/dsl/enable_build`::
-
-  Squib.enable_build_globally :pdf
-
-  Squib::Deck.new do
-    disable_build :pdf
-    build :pdf do
-      save_pdf # this will NOT be run no matter what
-    end
-  end

data/docs/dsl/grid.rst

@@ -1,31 +0,0 @@
-grid
-----
-
-Draw an unlimited square grid of lines on the deck, starting with x,y and extending off the end of the deck.
-
-
-Options
-^^^^^^^
-.. include:: /args/expansion.rst
-
-.. include:: /args/xy.rst
-
-
-width
-  default: ``:deck`` (the width of the deck)
-
-  the spacing between vertical gridlines. Supports :doc:`/units`.
-
-
-height
-  default: ``:deck`` (the height of the deck)
-
-  the spacing between horizontal gridlines. Supports :doc:`/units`.
-
-
-.. include:: /args/draw.rst
-.. include:: /args/range.rst
-.. include:: /args/layout.rst
-
-Examples
-^^^^^^^^

data/docs/dsl/hand.rst

@@ -1,40 +0,0 @@
-hand
-====
-
-Renders a range of cards fanned out as if in a hand. Saves as PNG regardless of back end.
-
-Options
--------
-
-radius
-  default: ``:auto``
-
-  The distance from the bottom of each card to the center of the fan. If set to ``:auto``, then it is computed as 30% of the card's height. Why 30%? Because it looks good that way. Reasons.
-
-angle_range
-  default: ``((Math::PI / -4.0)..(Math::PI / 2))``
-
-  The overall width of the fan, in radians. Angle of zero is a vertical card. Further negative angles widen the fan counter-clockwise and positive angles widen the fan clockwise.
-
-margin
-  default: ``75``
-
-  the margin around the entire image. Supports :doc:`/units`.
-
-fill_color
-  default: ``:white``
-
-  Backdrop color. See :doc:`/colors`.
-
-.. include:: /args/trim.rst
-
-file
-  default: ``'hand.png'``
-
-  The file to save relative to the current directory. Will overwrite without warning.
-
-.. include:: /args/output_dir.rst
-.. include:: /args/range.rst
-
-Examples
---------

data/docs/dsl/hint.rst

@@ -1,15 +0,0 @@
-hint
-====
-
-Toggle text hints globally. A text hint is a 1-pixel line drawn around the extents of a text box. They are intended to be temporary guides.
-
-Options
--------
-
-text
-  default: ``:off``
-
-  The color of the text hint. See :doc:`/colors` To turn off use ``:off`` or ``nil``.
-
-Examples
---------

data/docs/dsl/inches.rst

@@ -1,19 +0,0 @@
-inches
-------
-
-Given inches, returns the number of pixels according to the deck's DPI.
-
-Parameters
-^^^^^^^^^^
-
-n
-  the number of inches
-
-
-Examples
-^^^^^^^^
-
-.. code-block:: ruby
-
-  inches(2.5)                # 750 (for default Deck::dpi of 300)
-  inches(2.5) + inches(0.5)  # 900 (for default Deck::dpi of 300)

data/docs/dsl/index.rst

@@ -1,9 +0,0 @@
-DSL Reference
-=============
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   /dsl/deck
-   /dsl/*

data/docs/dsl/line.rst

@@ -1,52 +0,0 @@
-line
-----
-
-Draw a line from x1,y1 to x2,y2.
-
-Options
-^^^^^^^
-.. include:: /args/expansion.rst
-
-x1
-  default: ``0``
-
-  the x-coordinate to place. Supports :doc:`/units/`
-
-
-y1
-  default: ``0``
-
-  the y-coordinate to place. Supports :doc:`/units/`
-
-
-x2
-  default: ``50``
-
-  the x-coordinate to place. Supports :doc:`/units/`
-
-
-y2
-  default: ``50``
-
-  the y-coordinate to place. Supports :doc:`/units/`
-
-
-x3
-  default: ``0``
-
-  the x-coordinate to place. Supports :doc:`/units/`
-
-
-y3
-  default: ``50``
-
-  the y-coordinate to place. Supports :doc:`/units/`
-
-
-
-.. include:: /args/draw.rst
-.. include:: /args/range.rst
-.. include:: /args/layout.rst
-
-Examples
-^^^^^^^^