squib 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c3a21f564c6f39f4cdd9ac84826e2dd76df1c9e
-  data.tar.gz: dd923de21db270d9e71b5a06752a0a55390feffd
+  metadata.gz: b78f6ac8982e7aec43208726ad1e5160a9417a39
+  data.tar.gz: a22fe5b8bb4347867c89f2d675c410166f104633
 SHA512:
-  metadata.gz: 0eab4d96556c539261b0ca346d56af96331d968a3a828826d1172315821ffe3364a5070cf868a4b837775b70ca902e51fd2f9bc194069f10bb99d1675a005549
-  data.tar.gz: c654ed7a07aa5958861b4033066fd64b1cf2e3a114a1e372fca0b58c8b8b40ec6a454fc461e5ba7d5eb60a871e677564bed71466f31f59245e5fec5062aaeca9
+  metadata.gz: 86637107259a7b2051c8d85624070859e7084b0830979acc8a537f32f0a9ba38d9c2ed2718b4b5b8b20a5b41e71ee864ec39beea28b4eeb21f785054c1a224cb
+  data.tar.gz: 77f4a6dbc532038583ad321f47795fc0452af6e310b327d5302493fb5d567fe30b469e42984b3a34e1b8c7883592508b998ad5df1ec238c3e13ffacb61d13822

data/.gitignore

@@ -27,4 +27,6 @@ samples/_img
 samples/_output/*.png
 samples/_output/*.pdf
 samples/_output/foo
-rubocop.txt
+rubocop.txt
+benchmarks/_output/*.png
+benchmarks/_output/*.pdf

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Squib CHANGELOG
 
+## v0.3.0a
+* Masks! The `png` and `svg` commands can be used as if they are a mask, so you can color the icon with any color you like. Can be handy for switching to black-and-white, or for reusing the same image but different colors across cards.
+* Gradients! Can now specify linear or radial gradients anywhere you specify colors. See README and `samples/gradients.rb` for more details.
+* Number padding! `save_png` will now pad zeros on the filenames for friendlier sorting. You can also specify your own with `count_format` using the classical format string from Ruby's `Kernel::sprintf` (mostly just C-style format strings). Default: `'%02d'. The `prefix:` option is still there too.
+* Added unit conversion to `Squib::New` and `save_pdf`
+* Added arbitrary paper sizes to `save_pdf`
+* Added new sample table for color viewing constants in `samples/colors.rb`
+
+Special thanks to [Shalom Craimer](https://github.com/scraimer) for the idea and proof-of-concept on gradient and mask features!
+
 ## v0.2.0
 * Added `showcase` feature to create a fancy-looking 3D reflection to showcase your cards. Documented, tested, and added a sample for it.
 * Added a basic Rakefile, documented in README.

data/README.md

@@ -151,15 +151,35 @@ By default, Squib thinks in pixels. This decision was made so that we can have p
 
 {include:file:samples/units.rb}
 
-Note: we do not support unit conversion on `save_pdf` and `Squib::Deck.new()`, [yet](https://github.com/andymeneely/squib/issues/21)
+Note: we do not support unit conversion on `save_pdf` and `Squib::Deck.new()`, [yet](https://github.com/andymeneely/squib/issues/21). We are also working on support for unit conversion within layout parsing, so using it as a part of `extends` is not yet supported.
 
-## Specifying Colors
+## Specifying Colors & Gradients
 
 Colors can be specified in a wide variety of ways, mostly in a hex-string. Take a look at the examples from `samples/colors.rb`, found [here](https://github.com/andymeneely/squib/tree/master/samples/colors.rb)
 
 {include:file:samples/colors.rb}
 
-Under the hood, Squib uses the `rcairo` [color parser](https://github.com/rcairo/rcairo/blob/master/lib/cairo/color.rb) to accept a variety of color specifications, along with over [300 pre-defined constants](https://github.com/rcairo/rcairo/blob/master/lib/cairo/colors.rb).
+Under the hood, Squib uses the `rcairo` [color parser](https://github.com/rcairo/rcairo/blob/master/lib/cairo/color.rb) to accept a variety of color specifications, along with over [300 pre-defined constants](https://github.com/rcairo/rcairo/blob/master/lib/cairo/colors.rb). The above sample will generate a table of such constants.
+
+Additionally, in most places where colors are allowed, you may also supply a string that defines a gradient. Squib supports two flavors of gradients: linear and radial. Gradients are specified by supplying some xy coordinates, which are relative to the card (not the command). Each stop must be between 0.0 and 1.0, and you can supply as many as you like. Colors can be specified as above (in any of the hex notations or built-in constant). If you add two (or more) colors at the same stop, then the gradient keeps the colors in the in order specified and treats it like sharp transition.
+
+The format for gradient strings look like this:
+
+Linear:
+```
+(x1,y1)(x2,y2) color1@stop1 color2@stop2
+```
+The xy coordinates define the angle of the gradient.
+
+Radial:
+```
+(x1,y1,radius1)(x2,y2,radius2) color1@stop1 color2@stop2
+```
+The coordinates specify an inner circle first, then an outer circle.
+
+Check out the following sample from `samples/gradients.rb`, found [here](https://github.com/andymeneely/squib/tree/master/samples/colors.rb)
+
+{include:file:samples/gradients.rb}
 
 ## Specifying Files
 
@@ -183,30 +203,19 @@ Layouts also allow merging, extending, and combining layouts. The sample demonst
 
 {include:file:samples/layouts.rb}
 
-### Merge Keys and `extends`
-
-Since Layouts are in Yaml, we have the full power of that data format. One particular feature you should look into are ["merge keys"](http://www.yaml.org/YAML_for_ruby.html#merge_key). With merge keys, you can define base styles in one entry, then include those keys elsewhere. For example:
-
-```yaml
-icon: &icon
-  width: 50
-  height: 50
-icon_left
-  <<: *icon
-  x: 100
-# The layout for icon_left will have the width/height from icon!
-```
+### Special key: `extends`
 
-Also!! Squib provides a more feature-rich way of merging: the `extends` key in layouts. When defining an extends key, we can merge in another key and modify data coming in if we want to. This allows us to do things like set an inner object that changes its location based on its parent.
+Squib provides a way of reusing layouts with the special `extends` key. When defining an `extends` key, we can merge in another key and modify data coming in if we want to. This allows us to do things like set an inner object that changes its location based on its parent.
 
 ```yaml
-yin:
+attack:
   x: 100
   y: 100
   radius: 100
-yang:
-  extends: yin
+defend:
+  extends: attack
   x: += 50
+  #defend now is {:x => 150, :y => 100}
 ```
 
 Furthermore, if you want to extend multiple parents, it looks like this:
@@ -214,7 +223,7 @@ Furthermore, if you want to extend multiple parents, it looks like this:
 ```yaml
 socrates:
   x: 100
-aristotle:
+plato:
   y: 200
 aristotle:
   extends:
@@ -223,6 +232,20 @@ aristotle:
   x: += 50
 ```
 
+Note that extends keys are similar to Yaml's ["merge keys"](http://www.yaml.org/YAML_for_ruby.html#merge_key). With merge keys, you can define base styles in one entry, then include those keys elsewhere. For example:
+
+```yaml
+icon: &icon
+  width: 50
+  height: 50
+icon_left
+  <<: *icon
+  x: 100
+# The layout for icon_left will have the width/height from icon!
+```
+
+If you use both `extends` and Yaml merge keys, the Yaml merge keys are processed first, then extends. For clarity, however, you're probably just better off using `extends` instead.
+
 ### Multiple layout files
 
 Squib also supports the combination of multiple layout files. As shown in the above example, if you provide an `Array` of files then Squib will merge them sequentially. Colliding keys will be completely re-defined by the later file. Extends is processed after _each file_. YAML merge keys are NOT supported across multiple files - use extends instead. Here's a demonstrative example:

data/Rakefile

@@ -1,12 +1,85 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'yard'
+require 'benchmark'
 
 task default: [:install, :spec]
 
+# Useful for hooking up with SublimeText.
+# e.g. rake sample[basic.rb]
+task :run,[:file] => :install do |t, args|
+  args.with_defaults(file: 'basic.rb')
+  Dir.chdir('samples') do
+    puts "Running samples/#{args[:file]}"
+    load args[:file]
+  end
+end
+
+
 RSpec::Core::RakeTask.new(:spec)
 
-YARD::Rake::YardocTask.new(:doc) do |t|
+task doc: [:yarddoc, :apply_google_analytics]
+
+YARD::Rake::YardocTask.new(:yarddoc) do |t|
   t.files   = ['lib/**/*.rb', 'samples/**/*.rb']   # optional
   #t.options = ['--any', '--extra', '--opts'] # optional
 end
+
+task benchmark: [:install] do
+  Squib::logger.level = Logger::ERROR #silence warnings
+  Dir.chdir('benchmarks') do
+    Benchmark.bm(15) do |bm|
+      Dir['*.rb'].each do | script |
+        GC.start
+        bm.report(script) { load script }
+      end
+    end
+  end
+end
+
+task :apply_google_analytics do
+  # The string to replace in the html document. This is chosen to be the end
+  # body </body> tag. So the script can be injected as the last thing in the
+  # document body.
+  string_to_replace = "</body>"
+  # This is the string to replace with. It include the google analytics script
+  # as well as the end </body> tag.
+  string_to_replace_with = <<-EOF
+    <script>
+      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+      })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+      ga('create', 'UA-54811605-1', 'auto');
+      ga('send', 'pageview');
+
+   </script>
+  </body>
+  EOF
+
+  files = Dir.glob("doc/**/*.html")
+
+  files.each do |html_file|
+    puts "Processing file: #{html_file}"
+    contents = ""
+    # Read the file contents
+    file =  File.open(html_file)
+    file.each { |line| contents << line }
+    file.close
+
+    # If the file already has google analytics tracking info, skip it.
+    if contents.include?(string_to_replace_with)
+      puts "Skipped..."
+      next
+    end
+
+    # Apply google analytics tracking info to the html file
+    contents.gsub!(string_to_replace, string_to_replace_with)
+
+    # Write the contents with the google analytics info to the file
+    file =  File.open(html_file, "w")
+    file.write(contents)
+    file.close
+  end
+end

data/benchmarks/spanner.svg

@@ -0,0 +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>

data/benchmarks/tons_of_png.rb

@@ -0,0 +1,6 @@
+require 'squib'
+
+Squib::Deck.new(cards: 200) do
+  png file: 'shiny-purse.png'
+  save_png prefix: 'tons_of_png_'
+end

data/benchmarks/tons_of_svg.rb

@@ -0,0 +1,7 @@
+require 'squib'
+
+Squib::Deck.new(cards: 200) do
+  svg file: 'spanner.svg',
+      width: 400, height: 400
+  save_png prefix: 'tons_of_svg_'
+end

data/benchmarks/tons_of_text.rb

@@ -0,0 +1,8 @@
+require 'squib'
+
+Squib::Deck.new(cards: 200) do
+  text str: 'tweedle beetle battle ' * 250,
+       font: 'Sans bold 12', width: 825,
+       ellipsize: false
+  save_png prefix: 'tons_of_text_'
+end

data/lib/squib/api/background.rb

@@ -7,7 +7,7 @@ module Squib
     # Options support Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     #
     # @option opts range [Enumerable] (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
-    # @option opts color [String] (:black) the color the font will render to. See {file:README.md#Specifying_Colors Specifying Colors}.
+    # @option opts color [String] (:black) the color the font will render to. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
     # @return [nil] nothing
     # @api public
     def background(opts = {})

data/lib/squib/api/image.rb

@@ -17,16 +17,17 @@ module Squib
     # @option opts alpha [Decimal] (1.0) the alpha-transparency percentage used to blend this image. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @option opts blend [:none, :multiply, :screen, :overlay, :darken, :lighten, :color_dodge, :color_burn, :hard_light, :soft_light, :difference, :exclusion, :hsl_hue, :hsl_saturation, :hsl_color, :hsl_luminosity] (:none) the composite blend operator used when applying this image. See Blend Modes at http://cairographics.org/operators. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @option opts angle [FixNum] (0) Rotation of the in radians. Note that this rotates around the upper-left corner, making the placement of x-y coordinates slightly tricky. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
+    # @option opts mask [String] (nil) If specified, the image will be used as a mask for the given color/gradient. Transparent pixels are ignored, opaque pixels are the given color.
     # @return [nil] Returns nil
     # @api public
     def png(opts = {})
-      opts = needs(opts, [:range, :files, :x, :y, :width, :height, :alpha, :layout, :blend, :angle])
+      opts = needs(opts, [:range, :files, :x, :y, :width, :height, :alpha, :layout, :blend, :angle, :mask])
       Dir.chdir(@img_dir) do
         @progress_bar.start('Loading PNG(s)', opts[:range].size) do |bar|
           opts[:range].each do |i|
             @cards[i].png(opts[:file][i],
                           opts[:x][i], opts[:y][i], opts[:width][i], opts[:height][i],
-                          opts[:alpha][i], opts[:blend][i], opts[:angle][i])
+                          opts[:alpha][i], opts[:blend][i], opts[:angle][i], opts[:mask][i])
             bar.increment
           end
         end
@@ -51,16 +52,17 @@ module Squib
     # @option opts alpha [Decimal] (1.0) the alpha-transparency percentage used to blend this image. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @option opts blend [:none, :multiply, :screen, :overlay, :darken, :lighten, :color_dodge, :color_burn, :hard_light, :soft_light, :difference, :exclusion, :hsl_hue, :hsl_saturation, :hsl_color, :hsl_luminosity] (:none) the composite blend operator used when applying this image. See Blend Modes at http://cairographics.org/operators. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
     # @option opts angle [FixNum] (0) Rotation of the in radians. Note that this rotates around the upper-left corner, making the placement of x-y coordinates slightly tricky. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
+    # @option opts mask [String] (nil) If specified, the image will be used as a mask for the given color/gradient. Transparent pixels are ignored, opaque pixels are the given color.
     # @return [nil] Returns nil
     # @api public
     def svg(opts = {})
-      p = needs(opts,[:range, :files, :svgid, :force_svgid, :x, :y, :width, :height, :layout, :alpha, :blend, :angle])
+      p = needs(opts,[:range, :files, :svgid, :force_svgid, :x, :y, :width, :height, :layout, :alpha, :blend, :angle, :mask])
       Dir.chdir(@img_dir) do
         @progress_bar.start('Loading SVG(s)', p[:range].size) do |bar|
           p[:range].each do |i|
             unless p[:force_id][i] && p[:id][i].to_s.empty?
               @cards[i].svg(p[:file][i], p[:id][i], p[:x][i], p[:y][i],
-                            p[:width][i], p[:height][i], p[:alpha][i], p[:blend][i], p[:angle][i])
+                            p[:width][i], p[:height][i], p[:alpha][i], p[:blend][i], p[:angle][i],p[:mask][i])
             end
             bar.increment
           end

data/lib/squib/api/save.rb

@@ -25,14 +25,15 @@ module Squib
     # @option opts [Enumerable] range (:all) the range of cards over which this will be rendered. See {file:README.md#Specifying_Ranges Specifying Ranges}
     # @option opts [String] dir (_output) the directory for the output to be sent to. Will be created if it doesn't exist.
     # @option opts [String] prefix (card_) the prefix of the file name to be printed.
+    # @option opts [String] count_format (%02d) the format string used for formatting the card count (e.g. padding zeros). Uses a Ruby format string (see the Ruby doc for Kernel::sprintf for specifics)
     # @option opts [Boolean, :clockwise, :counterclockwise] rotate (false) if true, the saved cards will be rotated 90 degrees clockwise. Or, rotate by the number of radians. Intended to rendering landscape instead of portrait.
     # @return [nil] Returns nothing
     # @api public
     def save_png(opts = {})
-      opts = needs(opts,[:range, :creatable_dir, :prefix, :rotate])
+      opts = needs(opts,[:range, :creatable_dir, :prefix, :count_format, :rotate])
       @progress_bar.start("Saving PNGs to #{opts[:dir]}/#{opts[:prefix]}*", @cards.size) do |bar|
         opts[:range].each do |i|
-          @cards[i].save_png(i, opts[:dir], opts[:prefix], opts[:rotate], opts[:angle])
+          @cards[i].save_png(i, opts[:dir], opts[:prefix], opts[:count_format], opts[:rotate], opts[:angle])
           bar.increment
         end
       end
@@ -61,7 +62,7 @@ module Squib
     # @api public
     def showcase(opts = {})
       opts = {file: 'showcase.png', fill_color: :white}.merge(opts)
-      opts = needs(opts,[:range, :trim, :trim_radius, :creatable_dir, :file_to_save, :face])
+      opts = needs(opts,[:range, :margin, :trim, :trim_radius, :creatable_dir, :file_to_save, :face])
       render_showcase(opts[:range], opts[:trim], opts[:trim_radius],
                       opts[:scale], opts[:offset], opts[:fill_color],
                       opts[:reflect_offset], opts[:reflect_percent], opts[:reflect_strength],

data/lib/squib/api/shapes.rb

@@ -16,8 +16,8 @@ module Squib
     # @option opts x_radius [Integer] (0) the radius of the rounded corner horiztonally. Zero is a non-rounded corner. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts y_radius [Integer] (0) the radius of the rounded corner vertically. Zero is a non-rounded corner. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts radius [Integer] (nil) when set, overrides both x_radius and y_radius. Supports Unit Conversion, see {file:README.md#Units Units}.
-    # @option opts fill_color [String] ('#0000') the color with which to fill the rectangle
-    # @option opts stroke_color [String] (:black) the color with which to stroke the outside of the rectangle
+    # @option opts fill_color [String] ('#0000') the color with which to fill the rectangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
+    # @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_width [Decimal] (2.0) the width of the outside stroke. 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}
     # @return [nil] intended to be void
@@ -44,8 +44,8 @@ module Squib
     # @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 radius [Integer] (100) radius of the circle. Supports Unit Conversion, see {file:README.md#Units Units}.
-    # @option opts fill_color [String] ('#0000') the color with which to fill the rectangle
-    # @option opts stroke_color [String] (:black) the color with which to stroke the outside of the rectangle
+    # @option opts fill_color [String] ('#0000') the color with which to fill the rectangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
+    # @option opts stroke_color [String] (:black) the color with which to stroke the outside of the rectangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
     # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @return [nil] intended to be void
     # @api public
@@ -73,8 +73,8 @@ module Squib
     # @option opts y2 [Integer] (50) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts x3 [Integer] (0) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts y3 [Integer] (50) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
-    # @option opts fill_color [String] ('#0000') the color with which to fill the triangle
-    # @option opts stroke_color [String] (:black) the color with which to stroke the outside of the triangle
+    # @option opts fill_color [String] ('#0000') the color with which to fill the triangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
+    # @option opts stroke_color [String] (:black) the color with which to stroke the outside of the triangle. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}
     # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @return [nil] intended to be void
     # @api public
@@ -100,7 +100,7 @@ module Squib
     # @option opts y1 [Integer] (0) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts x2 [Integer] (50) the x-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @option opts y2 [Integer] (50) the y-coordinate to place. Supports Unit Conversion, see {file:README.md#Units Units}.
-    # @option opts stroke_color [String] (:black) the color with which to stroke the line
+    # @option opts stroke_color [String] (:black) the color with which to stroke the line. See {file:README.md#Specifying_Colors___Gradients Specifying Colors & Gradients}.
     # @option opts stroke_width [Decimal] (2.0) the width of the outside stroke. Supports Unit Conversion, see {file:README.md#Units Units}.
     # @return [nil] intended to be void
     # @api public