squib 0.9.0 → 0.10.0

data/RELEASE TODO.md

@@ -3,16 +3,16 @@ Be sure to remember to do the following for releases. (Copy into a GitHub issue)
  - [ ] CHANGELOG is written for all new changes
  - [ ] README is updated
  - [ ] Samples are updated
- - [ ] `rake doc`
  - [ ] Check `sample_regression_spec.rb` regression tests are all enabled (i.e. `overwrite_sample` is commented out)
  - [ ] Bump version.rb
  - [ ] Do a full rake locally
  - [ ] `rake sanity`, and check visually
  - [ ] Travis is passing on dev branch
  - [ ] Merge master branch
+ - [ ] Push master branch
  - [ ] Create GitHub release tag
  - [ ] `gem push pkg/squib-x.y.z.gem`
  - [ ] Github milestone closed
- - [ ] Push `rake doc` to website
+ - [ ] Activate version on squib.readthedocs.org
  - [ ] Bump version.rb to the next alpha
  - [ ] Publish on BoardGameGeek thread

data/Rakefile

@@ -1,6 +1,5 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'yard'
 require 'benchmark'
 # require 'byebug'
 
@@ -10,34 +9,25 @@ task default: [:install, :spec]
 # Useful for hooking up with SublimeText.
 # e.g. rake sample[basic.rb]
 desc 'Run a specific sample'
-task :run,[:file] => :install do |t, args|
+task :run, [:file] => :install do |t, args|
   args.with_defaults(file: 'basic.rb')
   Dir.chdir('samples') do
-    args[:file]  << ".rb" unless args[:file].end_with? '.rb'
+    args[:file] << '.rb' unless args[:file].end_with? '.rb'
     puts "Running samples/#{args[:file]}"
     load args[:file]
   end
 end
 
-
 RSpec::Core::RakeTask.new(:spec)
 
 RSpec::Core::RakeTask.new(:spec_fastonly) do |t|
-  t.rspec_opts = "--tag ~slow"
-end
-
-desc 'Build API docs'
-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
+  t.rspec_opts = '--tag ~slow'
 end
 
 desc 'Run some performance benchmarks'
 task benchmark: [:install] do
   require 'squib'
-  Squib::logger.level = Logger::ERROR #silence warnings
+  Squib::logger.level = Logger::ERROR # silence warnings
   Dir.chdir('benchmarks') do
     Benchmark.bm(15) do |bm|
       Dir['*.rb'].each do | script |
@@ -50,57 +40,9 @@ end
 
 desc 'Run sanity tests without a full rebuild'
 task :sanity_only do
-  require_relative 'spec/samples/sanity.rb'
-  Sanity.new.run
+  require_relative 'spec/sanity/sanity_test.rb'
+  SanityTest.new.run
 end
 
 desc 'Run full rebuild with sanity tests'
 task sanity: [:install, :spec, :sanity_only]
-
-desc 'Insert Google Analytics into documentation build'
-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/appveyor.yml

@@ -4,10 +4,6 @@ skip_tags: true
 
 environment:
   matrix:
-    - ruby_version: "200"
-    - ruby_version: "200-x64"
-    - ruby_version: "21"
-    - ruby_version: "21-x64"
     - ruby_version: "22"
     - ruby_version: "22-x64"
 

data/benchmarks/antialias_best.rb

@@ -9,5 +9,5 @@ Squib::Deck.new(cards: 200, config: 'antialias_best.yml') do
            x: (i % 17) * 50,
            y: (i / 17) * 50
   end
-  save_png   prefix: 'antialias_best_'
-end
+  save_png prefix: 'antialias_best_'
+end

data/benchmarks/antialias_fast.rb

@@ -9,5 +9,5 @@ Squib::Deck.new(cards: 200, config: 'antialias_fast.yml') do
            x: (i % 17) * 50,
            y: (i / 17) * 50
   end
-  save_png   prefix: 'antialias_fast_'
-end
+  save_png prefix: 'antialias_fast_'
+end

data/benchmarks/{backend-memory.rb → backend_memory.rb}

@@ -2,7 +2,7 @@ require 'squib'
 
 Squib::Deck.new(cards: 200) do
   background color: :white
-  text       str: "Hello, world!", y: 500, width: 825, font: 'Sans bold 72', align: :center
+  text       str: 'Hello, world!', y: 500, width: 825, font: 'Sans bold 72', align: :center
   rect       x: 10, y: 10, width: 20, height: 20
   circle     x: 40, y: 40, radius: 25
   triangle   x1: 50, y1: 15, x2: 60, y2: 25, x3: 75, y3: 25
@@ -11,4 +11,4 @@ Squib::Deck.new(cards: 200) do
   png        file: 'shiny-purse.png', x: 250, y: 20
   save_png   prefix: 'rasterized_'
   save_pdf   file: 'backend.pdf'
-end
+end

data/benchmarks/{backend-svg.rb → backend_svg.rb}

@@ -2,7 +2,7 @@ require 'squib'
 
 Squib::Deck.new(cards: 200, config: 'backend-svg.yml') do
   background color: :white
-  text       str: "Hello, world!", y: 500, width: 825, font: 'Sans bold 72', align: :center
+  text       str: 'Hello, world!', y: 500, width: 825, font: 'Sans bold 72', align: :center
   rect       x: 10, y: 10, width: 20, height: 20
   circle     x: 40, y: 40, radius: 25
   triangle   x1: 50, y1: 15, x2: 60, y2: 25, x3: 75, y3: 25
@@ -11,4 +11,4 @@ Squib::Deck.new(cards: 200, config: 'backend-svg.yml') do
   png        file: 'shiny-purse.png', x: 250, y: 20
   save_png   prefix: 'rasterized_'
   save_pdf   file: 'backend.pdf'
-end
+end

data/benchmarks/tons_of_png.rb

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

data/benchmarks/tons_of_svg.rb

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

data/benchmarks/tons_of_text.rb

@@ -5,4 +5,4 @@ Squib::Deck.new(cards: 200) do
        font: 'Sans bold 12', width: 825,
        ellipsize: false
   save_png prefix: 'tons_of_text_'
-end
+end

data/docs/Makefile

@@ -0,0 +1,216 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+
+.PHONY: clean
+clean:
+	rm -rf $(BUILDDIR)/*
+
+.PHONY: html
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: dirhtml
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: singlehtml
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+.PHONY: pickle
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+.PHONY: json
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+.PHONY: htmlhelp
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+.PHONY: qthelp
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Squib.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Squib.qhc"
+
+.PHONY: applehelp
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+.PHONY: devhelp
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Squib"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Squib"
+	@echo "# devhelp"
+
+.PHONY: epub
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+.PHONY: latex
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+.PHONY: latexpdf
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: latexpdfja
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: text
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+.PHONY: man
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+.PHONY: texinfo
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+.PHONY: info
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+.PHONY: gettext
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+.PHONY: changes
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+.PHONY: linkcheck
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+.PHONY: doctest
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+.PHONY: coverage
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+.PHONY: xml
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+.PHONY: pseudoxml
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

data/docs/_static/css/squibdocs.css

@@ -0,0 +1,18 @@
+@import url("theme.css");
+
+/* Can add custom styling here */
+.attribution{
+  text-align: right;
+}
+
+code.literal span.pre{
+  color: black;
+}
+
+code.code_img{
+  width: 50%;
+}
+
+code.code_img_small{
+  width: 33%;
+}

data/docs/args/draw.rst

@@ -0,0 +1,36 @@
+.. :orphan:
+
+fill_color
+  default: ``'#0000'`` (fully transparent)
+
+  the color or gradient to fill with. See :doc:`/colors`.
+
+
+stroke_color
+  default: ``:black``
+
+  the color with which to stroke the outside of the shape. See :doc:`/colors`.
+
+
+stroke_width
+  default: ``2``
+
+  the width of the outside stroke. Supports :doc:`/units`.
+
+
+stroke_strategy
+  default:  ``:fill_first``
+
+  Specify whether the stroke is done before (thinner) or after (thicker) filling the shape.
+
+  Must be either ``:fill_first`` or ``:stroke_first`` (or their string equivalents).
+
+dash
+  default: ``''`` (no dash pattern set)
+
+  Define a dash pattern for the stroke. This is a special string with space-separated numbers that define the pattern of on-and-off alternating strokes, measured in pixels or units. For example, ``'0.02in 0.02in'`` will be an equal on-and-off dash pattern. Supports :doc:`/units`.
+
+cap
+  default: ``:butt``
+
+  Define how the end of the stroke is drawn. Options are ``:square``, ``:butt``, and ``:round`` (or string equivalents of those).