squib 0.0.3 → 0.0.4

data/lib/squib/project_template/.gitignore

@@ -1,4 +1,4 @@
-_output/*.png
-_output/*.pdf
-~$*
-.DS_Store
+_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,20 +1,20 @@
-# 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
+# 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

data/lib/squib/project_template/deck.rb

@@ -1,6 +1,6 @@
-require 'squib'
-
-Squib::Deck.new(cards: 3, layout: 'layout.yml') do 
-  text str: "Hello, World!"
-  save format: :png
+require 'squib'
+
+Squib::Deck.new(cards: 3, layout: 'layout.yml') do 
+  text str: "Hello, World!"
+  save format: :png
 end

data/lib/squib/version.rb

@@ -1,6 +1,6 @@
-module Squib
-
-  # The next version to be released.
-  # Uses semantic versioning
-  VERSION = "0.0.3"
-end
+module Squib
+
+  # The next version to be released.
+  # Uses semantic versioning
+  VERSION = "0.0.4"
+end

data/samples/autoscale_font.rb

@@ -0,0 +1,27 @@
+require 'squib'
+
+# Here's an exmaple of being able to scale a font 
+# based on the length of individual string. 
+# Handy for making minor font scales to fill text boxes.
+def autoscale(str_array)
+  str_array.inject([]) do | memo, str |
+    case str.length
+    when 0..10
+      memo << 125
+    when 11..20
+      memo << 45
+    else
+      memo << 36
+    end
+  end
+end
+
+Squib::Deck.new(cards: 3) do
+  background color: :white
+
+  title = %w(ShortBig Medium_Length_Name Super_Duper_Long_Name)
+  text str: title, x: 65, y: 400, align: :center, width: 700,
+       font: 'Arial', font_size: autoscale(title), hint: :red 
+
+  save prefix: 'autoscale_', format: :png
+end

data/samples/basic.rb

@@ -1,20 +1,20 @@
-#!/usr/bin/env ruby
-require 'squib'
-
-data = {'name' => ['Thief', 'Grifter', 'Mastermind'], 
-        'level' => [1,2,3]}
-
-Squib::Deck.new(width: 825, height: 1125, cards: 3) do
-  background color: :white
-  rect x: 38, y: 38, width: 750, height: 1050, radius: 38
-  rect x: 75, y: 75, width: 128, height: 128, radius: 25
-
-  text str: data['name'], x: 220, y: 78, font: 'Arial 54'
-  text str: data['level'], x: 75, y: 85, width: 128, 
-       font: 'Arial 72', align: :center
-
-   png range: [0,2], file: 'shiny-purse.png', x: 620, y: 75
-   svg range: 1..2, file: 'spanner.svg', x: 620, y: 218
-
-  save prefix: 'basic_', format: :png#, progress_bar: true
+#!/usr/bin/env ruby
+require 'squib'
+
+data = {'name' => ['Thief', 'Grifter', 'Mastermind'], 
+        'level' => [1,2,3]}
+
+Squib::Deck.new(width: 825, height: 1125, cards: 3) do
+  background color: :white
+  rect x: 38, y: 38, width: 750, height: 1050, radius: 38
+  rect x: 75, y: 75, width: 128, height: 128, radius: 25
+
+  text str: data['name'], x: 220, y: 78, font: 'Arial 54'
+  text str: data['level'], x: 75, y: 85, width: 128, 
+       font: 'Arial 72', align: :center
+
+   png range: [0,2], file: 'shiny-purse.png', x: 620, y: 75
+   svg range: 1..2, file: 'spanner.svg', x: 620, y: 218
+
+  save prefix: 'basic_', format: :png#, progress_bar: true
 end

data/samples/colors.rb

@@ -1,16 +1,16 @@
-require 'squib'
-
-Squib::Deck.new(width: 825, height: 1125, cards: 1) do
-  background color: :white
-
-  y = 0
-  text color: '#f00', str: '3-hex', x: 50, y: y+=50
-  text color: '#f00', str: '3-hex (alpha)', x: 50, y: y+=50
-  text color: '#ff0000', str: '6-hex', x: 50, y: y+=50
-  text color: '#ff000099', str: '8-hex(alpha) *', x: 50, y: y+=50
-  text color: '#ffff00000000', str: '12-hex', x: 50, y: y+=50
-  text color: '#ffff000000009999', str: '12-hex (alpha)', x: 50, y: y+=50
-  text color: :burnt_orange, str: 'Symbols of constants too', x: 50, y: y+=50
-
-  save_png prefix: "colors_"
+require 'squib'
+
+Squib::Deck.new(width: 825, height: 1125, cards: 1) do
+  background color: :white
+
+  y = 0
+  text color: '#f00', str: '3-hex', x: 50, y: y+=50
+  text color: '#f00', str: '3-hex (alpha)', x: 50, y: y+=50
+  text color: '#ff0000', str: '6-hex', x: 50, y: y+=50
+  text color: '#ff000099', str: '8-hex(alpha) *', x: 50, y: y+=50
+  text color: '#ffff00000000', str: '12-hex', x: 50, y: y+=50
+  text color: '#ffff000000009999', str: '12-hex (alpha)', x: 50, y: y+=50
+  text color: :burnt_orange, str: 'Symbols of constants too', x: 50, y: y+=50
+
+  save_png prefix: "colors_"
 end

data/samples/custom-config.yml

@@ -1,6 +1,6 @@
-dpi: 300
-progress_bars: true
-text_hint: '#FF0000'
-custom_colors:
-  foo: '#ccc'
+dpi: 300
+progress_bars: true
+text_hint: '#FF0000'
+custom_colors:
+  foo: '#ccc'
 img_dir: customconfig-imgdir

data/samples/custom-layout.yml

@@ -1,39 +1,59 @@
-frame: 
-  x: 38
-  y: 38
-  width: 750
-  height: 1050
-  radius: 25
-title:
-  x: 125
-  y: 50
-  width: 625
-  height: 100
-  align: !ruby/symbol center #see http://www.yaml.org/YAML_for_ruby.html#symbols
-  valign: !ruby/symbol middle  
-subtitle:
-  x: 150
-  y: 150
-  width: 575
-  height: 60
-  align: !ruby/symbol center
-  valign: !ruby/symbol middle
-
-# Yaml has this beautfiul feature for us: merge keys
-# http://www.yaml.org/YAML_for_ruby.html#merge_key
-# Define an alias with &foo, then use <<: *foo to include it
-# Everything gets merged, with later merges overriding 
-icon: &icon
-  width: 125
-  height: 125
-  y: 250
-icon_left:
-  <<: *icon 
-  x: 150
-icon_middle:
-  <<: *icon
-  x: 350
-  y: 400  #overrides the y inherited from icon
-icon_right:
-  <<: *icon
-  x: 550
+frame: 
+  x: 38
+  y: 38
+  width: 750
+  height: 1050
+  radius: 25
+title:
+  x: 125
+  y: 50
+  width: 625
+  height: 100
+  align: !ruby/symbol center #see http://www.yaml.org/YAML_for_ruby.html#symbols
+  valign: !ruby/symbol middle  
+subtitle:
+  x: 150
+  y: 150
+  width: 575
+  height: 60
+  align: !ruby/symbol center
+  valign: !ruby/symbol middle
+icon:
+  width: 125
+  height: 125
+  y: 250
+icon_left:
+  extends: icon
+  x: 150
+icon_middle:
+  extends: icon
+  x: 350
+  y: 400  #overrides the y inherited from icon
+icon_right:
+  extends: icon
+  x: 550
+
+# Squib also supports its own merging-and-modify feature
+# Called "extends"
+# Any layout can extend another layout, so long as it's not a circle
+# Order doesn't matter since it's done after YAML procesing
+# And, if the entry overrides 
+bonus: #becomes our bonus rectangle
+  x: 250
+  y: 600
+  width:  300
+  height: 200
+  radius: 32
+bonus_inner: 
+  extends: bonus 
+  x: += 10 # i.e. 260
+  y: += 10 # i.e. 610
+  width: -= 20  # i.e. 180
+  height: -= 20 # i.e. 180
+  radius: -= 8
+bonus_text:
+  extends: bonus_inner
+  x: +=10
+  y: +=10
+  width: -= 20
+  height: -= 20

data/samples/custom_config.rb

@@ -1,19 +1,19 @@
-#!/usr/bin/env ruby
-require 'squib'
-
-Squib::Deck.new(config: 'custom-config.yml') do
-  # Custom color defined in our config
-  background color: :foo 
-
-  # Hints are turned on in the config file
-  text str: "The Title", x: 0, y: 78, width: 825,
-       font: 'Arial 72', align: :center
-
-  # Progress bars are shown for these commands
-  # And images are taken from config-imgdir
-  png file: 'shiny-purse2.png', x: 620, y: 75
-  svg file: 'spanner2.svg', x: 620, y: 218
-  save_png prefix: 'custom-config_'
-  save_pdf file: "custom-config-out.pdf"
-
+#!/usr/bin/env ruby
+require 'squib'
+
+Squib::Deck.new(config: 'custom-config.yml') do
+  # Custom color defined in our config
+  background color: :foo 
+
+  # Hints are turned on in the config file
+  text str: "The Title", x: 0, y: 78, width: 825,
+       font: 'Arial 72', align: :center
+
+  # Progress bars are shown for these commands
+  # And images are taken from config-imgdir
+  png file: 'shiny-purse2.png', x: 620, y: 75
+  svg file: 'spanner2.svg', x: 620, y: 218
+  save_png prefix: 'custom-config_'
+  save_pdf file: "custom-config-out.pdf"
+
 end

data/samples/customconfig-imgdir/spanner2.svg

@@ -1,91 +1,91 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg
-   xmlns:dc="http://purl.org/dc/elements/1.1/"
-   xmlns:cc="http://creativecommons.org/ns#"
-   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-   xmlns:svg="http://www.w3.org/2000/svg"
-   xmlns="http://www.w3.org/2000/svg"
-   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
-   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
-   viewBox="0 0 128 128"
-   id="svg2"
-   version="1.1"
-   inkscape:version="0.48.3.1 r9886"
-   width="100%"
-   height="100%"
-   sodipodi:docname="spanner.svg">
-  <metadata
-     id="metadata18">
-    <rdf:RDF>
-      <cc:Work
-         rdf:about="">
-        <dc:format>image/svg+xml</dc:format>
-        <dc:type
-           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-      </cc:Work>
-    </rdf:RDF>
-  </metadata>
-  <defs
-     id="defs16" />
-  <sodipodi:namedview
-     pagecolor="#ffffff"
-     bordercolor="#666666"
-     borderopacity="1"
-     objecttolerance="10"
-     gridtolerance="10"
-     guidetolerance="10"
-     inkscape:pageopacity="0"
-     inkscape:pageshadow="2"
-     inkscape:window-width="1280"
-     inkscape:window-height="1002"
-     id="namedview14"
-     showgrid="false"
-     inkscape:zoom="2.8284271"
-     inkscape:cx="98.928938"
-     inkscape:cy="62.194589"
-     inkscape:window-x="1912"
-     inkscape:window-y="-8"
-     inkscape:window-maximized="1"
-     inkscape:current-layer="g3767"
-     inkscape:document-units="in"
-     units="px"
-     showguides="true"
-     inkscape:guide-bbox="true" />
-  <g
-     id="g3767"
-     transform="matrix(0.24961486,0,0,0.24961486,0.197194,96.049335)">
-    <rect
-       ry="67.108368"
-       y="-378.68747"
-       x="5.3126979"
-       height="501.3746"
-       width="501.3746"
-       id="backdrop"
-       style="fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:10.62539577;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
-       inkscape:label="#rect3765" />
-    <path
-       style="fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
-       d="M 36.267098,-7.709219 C 16.393265,5.1318032 3.2161811,27.462365 3.2161811,52.884128 c 0,39.825874 32.2852369,72.111092 72.1110909,72.111092 23.870397,0 44.964938,-11.67699 58.089488,-29.545518 -11.26063,7.275808 -24.65607,11.517748 -39.060173,11.517748 -39.825853,0 -72.11109,-32.285221 -72.11109,-72.111095 0,-15.95546 5.248882,-30.6218942 14.021601,-42.565574 z"
-       id="path3790"
-       inkscape:connector-curvature="0" />
-    <g
-       id="g6"
-       transform="matrix(18.68858,0,0,18.68858,-3385.6437,-2608.3849)">
-      <path
-         style="fill:#ffffff"
-         inkscape:connector-curvature="0"
-         id="path8"
-         d="m 192.2325,129.3203 -10,10 v 5.5625 h 5.375 l 10.0938,-10.0938 -5.4688,-5.4688 z" />
-      <path
-         style="fill:#ffffff;stroke:#000000"
-         inkscape:connector-curvature="0"
-         id="path10"
-         d="m 181.7796,141.8591 15.6196,-15.6178 m 3.349,3.3486 -15.8051,15.8032" />
-      <path
-         style="fill:#ffffff"
-         inkscape:connector-curvature="0"
-         id="path12"
-         d="m 201.2023,119.7104 c -2.8283,-0.73 -5.9623,-0.004 -8.1759,2.2097 -3.3293,3.3292 -3.3293,8.7358 -2e-5,12.065 3.32928,3.3292 8.7358,3.3292 12.065,0 2.216,-2.216 2.9436,-5.3452 2.2097,-8.1759 l -5.6348,5.6348 -4.8172,-1.2816 -1.2816,-4.8171 5.6348,-5.6348 z" />
-    </g>
-  </g>
-</svg>
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   viewBox="0 0 128 128"
+   id="svg2"
+   version="1.1"
+   inkscape:version="0.48.3.1 r9886"
+   width="100%"
+   height="100%"
+   sodipodi:docname="spanner.svg">
+  <metadata
+     id="metadata18">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <defs
+     id="defs16" />
+  <sodipodi:namedview
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="1280"
+     inkscape:window-height="1002"
+     id="namedview14"
+     showgrid="false"
+     inkscape:zoom="2.8284271"
+     inkscape:cx="98.928938"
+     inkscape:cy="62.194589"
+     inkscape:window-x="1912"
+     inkscape:window-y="-8"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="g3767"
+     inkscape:document-units="in"
+     units="px"
+     showguides="true"
+     inkscape:guide-bbox="true" />
+  <g
+     id="g3767"
+     transform="matrix(0.24961486,0,0,0.24961486,0.197194,96.049335)">
+    <rect
+       ry="67.108368"
+       y="-378.68747"
+       x="5.3126979"
+       height="501.3746"
+       width="501.3746"
+       id="backdrop"
+       style="fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:10.62539577;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
+       inkscape:label="#rect3765" />
+    <path
+       style="fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none"
+       d="M 36.267098,-7.709219 C 16.393265,5.1318032 3.2161811,27.462365 3.2161811,52.884128 c 0,39.825874 32.2852369,72.111092 72.1110909,72.111092 23.870397,0 44.964938,-11.67699 58.089488,-29.545518 -11.26063,7.275808 -24.65607,11.517748 -39.060173,11.517748 -39.825853,0 -72.11109,-32.285221 -72.11109,-72.111095 0,-15.95546 5.248882,-30.6218942 14.021601,-42.565574 z"
+       id="path3790"
+       inkscape:connector-curvature="0" />
+    <g
+       id="g6"
+       transform="matrix(18.68858,0,0,18.68858,-3385.6437,-2608.3849)">
+      <path
+         style="fill:#ffffff"
+         inkscape:connector-curvature="0"
+         id="path8"
+         d="m 192.2325,129.3203 -10,10 v 5.5625 h 5.375 l 10.0938,-10.0938 -5.4688,-5.4688 z" />
+      <path
+         style="fill:#ffffff;stroke:#000000"
+         inkscape:connector-curvature="0"
+         id="path10"
+         d="m 181.7796,141.8591 15.6196,-15.6178 m 3.349,3.3486 -15.8051,15.8032" />
+      <path
+         style="fill:#ffffff"
+         inkscape:connector-curvature="0"
+         id="path12"
+         d="m 201.2023,119.7104 c -2.8283,-0.73 -5.9623,-0.004 -8.1759,2.2097 -3.3293,3.3292 -3.3293,8.7358 -2e-5,12.065 3.32928,3.3292 8.7358,3.3292 12.065,0 2.216,-2.216 2.9436,-5.3452 2.2097,-8.1759 l -5.6348,5.6348 -4.8172,-1.2816 -1.2816,-4.8171 5.6348,-5.6348 z" />
+    </g>
+  </g>
+</svg>