squib 0.13.4 → 0.14.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d90b173b48319dfe95e699bfc3635cf6e2d1458
-  data.tar.gz: b9f7685a03893bdbdec55708d27c109acb447337
+  metadata.gz: 101d4863fdad657cfe813322ce495cc3f0e10a26
+  data.tar.gz: 82d6ae835f5ad51d56829919653e9b0b50bea912
 SHA512:
-  metadata.gz: de27892ffa4b94a1b4fbee68f4a7a4ccc6ab803b70bd4abd3350a7643090ffda3bb19dce4eae4ad38456b78c44e21510686d307db9b6cbde2a974bb7ef3b8f7f
-  data.tar.gz: 7d8da751f4808d92fcae5073904bc6b932a6dae518ae5500ee5ce1307207fcb42b3c07cc1d24d961437a006a710b6fa025667726be4717a0a9872b67b417f0c6
+  metadata.gz: 9265cd7e35588ba4471e87773d909e03dd612accaa421353672db396ec3f3818fc5ef6858f6de419100258e5bcc30ddb3b994e7830c27edc0425ca2c85e91827
+  data.tar.gz: 4600e52c633a965d33f44b8754bb9e319fd247602e6d4c94515dd5844b2f18a9368f0563af9b5583693fe38f887e76e043691ec75a4720021e98a24ae0c34829

data/.travis.yml

@@ -2,18 +2,16 @@ dist: trusty
 language: ruby
 sudo: true # need this for libgirepository1.0-dev
 # sudo: false # taking advantage of container-based infrastructure
-cache: bundler # cache bundled gems from build to build
-
+# cache: bundler # cache bundled gems from build to build
 addons:
   apt:
     packages:
       - libgirepository1.0-dev # for gobject-introspection
-
 rvm:
   - 2.2
   - 2.3.2
   - 2.3.3
-  - 2.4.0
+  - 2.4.1
 matrix:
   allow_failures:
     - rvm: 2.3.3

data/CHANGELOG.md

@@ -4,15 +4,30 @@ Squib follows [semantic versioning](http://semver.org).
 ## v0.14.0 / Unreleased
 
 Features:
+* `save_pdf/save_sheet` method now supports `sprue`, which allows you to define templated layouts and position your cards freely (#217) by @felixleong. See docs for how to use this _very_ powerful feature!
 * `circle` method now supports various `arc` options, so you can draw partial circles (#211) by @sparr
 * `save_sheet` method now supports `rtl` or "right-to-left", for easier duplex printing of backs (#204, #208) by @sparr
 * `yaml` method for reading in data, much like `csv` and `xlsx` by @blinks
+* Layouts now support `*=` and `/=` operators in addition to `+=` and `-=` (#200).
+* `save_pdf` method also supports `rtl` by @vador
+* New DSL methods `safe_zone` and `cut_zone` will draw a rectangle inset from the margins for quick proof checking
+* New "advanced" option for creating new projects, if you do `squib new --advanced yourgame` (@andymeneely).
+* New built-in layout: `party.yml`. (@andymeneely)
 
-Chores:
-* Bumped dependencies for Cairo to 1.15.8,  Pango et al. to 3.1.4, and nokogiri to 1.7.2. Locked in Cairo and Pango deps so we don't have live release issues that we had recently.
+Compatibility:
+* DPI is correctly respected with font sizes now. To convert to Squib v0.14+, divide your old font sizes by 3 (precisely, 300/96=3.125). By @felixleong
+
+Docs:
+* Command-line is better documented now
+* Some more examples included in various places
 
 Bugs:
-* Fixed some deprecation warnings on `text`
+* fix save_sheet to calculate rows correctly based on range (#207) by @sparr
+
+Chores:
+* Going back to our policy of locking in our dependencies so that we don't have new gems breaking things.
+
+Special thanks to @sparr, @felixleong, @blinks, @vador for all of their work!!
 
 ## v0.13.4 / 2017-07-17
 
@@ -24,6 +39,7 @@ Bugs:
 Bugs:
 * Fix `undefined method [] for nil:NilClass` error on `svg` (was a regression error in librsvg that we worked around.)
 * Bump dependencies to latest stable versions. Pango et al. to 3.1.7 and Cairo to 1.15.9. This fixes some compatibility issues.
+* Fixed some deprecation warnings on `text`
 
 Compatibility known issue: if you are using Homebrew on Mac, you may need to set an environment variable for this version. This should be fixed in the upcoming 3.1.8 version of Pango that is forthcoming. See this: https://github.com/ruby-gnome2/ruby-gnome2/issues/1058
 

data/README.md

@@ -31,7 +31,7 @@ Wanna see more? Check out the website: http://andymeneely.github.io/squib/
 
 ## Installation
 
-Squib requires Ruby 2.0 or later.
+Squib requires Ruby 2.2 or later.
 
 Install it yourself with:
 

data/bin/squib

@@ -1,19 +1,4 @@
 #!/usr/bin/env ruby
 require 'squib'
-require 'mercenary'
 
-Mercenary.program(:squib) do |p|
-  p.version Squib::VERSION
-  p.description 'A Ruby DSL for prototyping card games'
-  p.syntax 'squib <subcommand> [options]'
-
-  p.command(:new) do |c|
-    c.syntax 'new PATH'
-    c.description 'Creates a new Squib project scaffolding in PATH. Must be a new directory or already empty.'
-
-    c.action do |args, options|
-      Squib::Commands::New.new.process(args)
-    end
-  end
-
-end
+Squib::CLI.new.run

data/lib/squib.rb

@@ -3,7 +3,7 @@ require 'cairo'
 require 'pango'
 require 'rsvg2'
 require_relative 'squib/version'
-require_relative 'squib/commands/new'
+require_relative 'squib/commands/cli'
 require_relative 'squib/deck'
 require_relative 'squib/card'
 

data/lib/squib/api/data.rb

@@ -1,5 +1,6 @@
 require 'roo'
 require 'csv'
+require 'yaml'
 require_relative '../args/input_file'
 require_relative '../args/import'
 require_relative '../args/csv_opts'
@@ -67,6 +68,30 @@ module Squib
   end
   module_function :csv
 
+  # DSL method. See http://squib.readthedocs.io
+  def yaml(opts = {})
+    input = Args::InputFile.new(file: 'deck.yml').load!(opts)
+    import = Args::Import.new.load!(opts)
+    yml = YAML.load_file(input.file[0])
+    data = Squib::DataFrame.new
+    # Get a universal list of keys to ensure everything is covered.
+    keys = yml.map { |c| c.keys}.flatten.uniq
+    keys.each { |k| data[k] = [] } #init arrays
+    yml.each do |card|
+      # nil value if key isn't set.
+      keys.each { |k| data[k] << card[k] }
+    end
+    if block_given?
+      data.each do |header, col|
+        col.map! do |val|
+          yield(header, val)
+        end
+      end
+    end
+    explode_quantities(data, import.explode)
+  end
+  module_function :yaml
+
   # Check if the given CSV table has duplicate columns, and throw a warning
   # @api private
   def check_duplicate_csv_headers(table)
@@ -104,5 +129,9 @@ module Squib
       Squib.csv(opts)
     end
 
+    # DSL method. See http://squib.readthedocs.io
+    def yaml(opts = {})
+      Squib.yaml(opts)
+    end
   end
 end

data/lib/squib/api/save.rb

@@ -3,7 +3,10 @@ require_relative '../args/hand_special'
 require_relative '../args/save_batch'
 require_relative '../args/sheet'
 require_relative '../args/showcase_special'
+require_relative '../args/sprue_file'
 require_relative '../graphics/save_pdf'
+require_relative '../graphics/save_sprue'
+require_relative '../sprues/sprue'
 
 module Squib
   class Deck
@@ -19,7 +22,16 @@ module Squib
     def save_pdf(opts = {})
       range = Args::CardRange.new(opts[:range], deck_size: size)
       sheet = Args::Sheet.new(custom_colors, { file: 'output.pdf' }).load!(opts, expand_by: size, layout: layout, dpi: dpi)
-      Graphics::SavePDF.new(self).render_pdf(range, sheet)
+      sprue_file = Args::SprueFile.new.load!(opts, expand_by: size)
+
+      if sprue_file.sprue.nil?
+        Graphics::SavePDF.new(self).render_pdf(range, sheet)
+      else
+        tmpl = Sprue.load sprue_file.sprue, dpi
+        Graphics::SaveSpruePDF.
+          new(self, tmpl, sheet).
+          render_sheet(range)
+      end
     end
 
     # DSL method. See http://squib.readthedocs.io
@@ -39,7 +51,16 @@ module Squib
       range = Args::CardRange.new(opts[:range], deck_size: size)
       batch = Args::SaveBatch.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
       sheet = Args::Sheet.new(custom_colors, { margin: 0 }, size).load!(opts, expand_by: size, layout: layout, dpi: dpi)
-      render_sheet(range, batch, sheet)
+      sprue_file = Args::SprueFile.new.load!(opts, expand_by: size)
+
+      if sprue_file.sprue.nil?
+        render_sheet(range, batch, sheet)
+      else
+        tmpl = Sprue.load sprue_file.sprue, dpi
+        Graphics::SaveSpruePNG.
+          new(self, tmpl, batch).
+          render_sheet(range)
+      end
     end
 
     # DSL method. See http://squib.readthedocs.io

data/lib/squib/api/shapes.rb

@@ -83,5 +83,42 @@ module Squib
       range.each { |i| @cards[i].polygon(coords[i], trans[i], draw[i]) }
     end
 
+    # DSL method. See http://squib.readthedocs.io
+    def safe_zone(opts = {})
+      safe_defaults = {
+        margin: '0.25in',
+        radius: '0.125in',
+        stroke_color: :blue,
+        fill_color: '#0000',
+        stroke_width: 1.0,
+        dash: '3 3',
+      }
+      new_opts = safe_defaults.merge(opts)
+      margin = Args::UnitConversion.parse new_opts[:margin]
+      new_opts[:x] = margin
+      new_opts[:y] = margin
+      new_opts[:width] = width - (2 * margin)
+      new_opts[:height] = height - (2 * margin)
+      rect new_opts
+    end
+
+    # DSL method. See http://squib.readthedocs.io
+    def cut_zone(opts = {})
+      safe_defaults = {
+        margin: '0.125in',
+        radius: '0.125in',
+        stroke_color: :red,
+        fill_color: '#0000',
+        stroke_width: 2.0,
+      }
+      new_opts = safe_defaults.merge(opts)
+      margin = Args::UnitConversion.parse new_opts[:margin]
+      new_opts[:x] = margin
+      new_opts[:y] = margin
+      new_opts[:width] = width - (2 * margin)
+      new_opts[:height] = height - (2 * margin)
+      rect new_opts
+    end
+
   end
 end

data/lib/squib/api/text.rb

@@ -17,7 +17,7 @@ module Squib
       embed = TextEmbed.new(size, custom_colors, layout, dpi, img_dir)
       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]) }
+      range.each { |i| extents[i] = @cards[i].text(embed, para[i], box[i], trans[i], draw[i], dpi) }
       return extents
     end
 

data/lib/squib/api/units.rb

@@ -8,6 +8,11 @@ module Squib
       @dpi * n.to_f
     end
 
+    # DSL method. See http://squib.readthedocs.io
+    def points(n)
+      @dpi / Squib::POINTS_PER_IN * n.to_f
+    end
+
     # DSL method. See http://squib.readthedocs.io
     def cm(n)
       @dpi * Squib::INCHES_IN_CM * n.to_f

data/lib/squib/args/arg_loader.rb

@@ -17,7 +17,7 @@ module Squib
         args[:layout] = prep_layout_args(args[:layout], expand_by: expand_by)
         expand_and_set_and_defaultify(args: args, by: expand_by, layout: layout)
         validate
-        convert_units
+        convert_units dpi: dpi
         self
       end
 

data/lib/squib/args/coords.rb

@@ -16,7 +16,9 @@ module Squib
           cx2: 0 , cy2: 0,
           inner_radius: 50, outer_radius: 100,
           radius: 100,
-          n: 5, }
+          n: 5,
+          arc_start: 0, arc_end: 2 * Math::PI, arc_direction: :clockwise, arc_close: false,
+       }
       end
 
       def self.expanding_parameters

data/lib/squib/args/dir_validator.rb

@@ -6,7 +6,7 @@ module Squib
       def ensure_dir_created(dir)
         unless Dir.exists?(dir)
           Squib.logger.warn "Dir '#{dir}' does not exist, creating it."
-          Dir.mkdir dir
+          FileUtils.mkdir_p dir
         end
         return dir
       end

data/lib/squib/args/sheet.rb

@@ -40,6 +40,8 @@ module Squib
           trim_radius: 38,
           trim: 0,
           width: 3300,
+          range: :all,
+          rtl: false,
         }
       end
 
@@ -79,9 +81,14 @@ module Squib
 
       def validate_rows(arg)
         raise 'columns must be an integer' unless columns.respond_to? :to_i
-        return 1 if @deck_size < columns
+        count = if range == :all
+                  @deck_size
+                else
+                  count = range.to_a.length
+                end
+        return 1 if count <= columns
         return arg if arg.respond_to? :to_i
-        (@deck_size.to_i / columns.to_i).ceil
+        (count.to_f / columns.to_f).ceil
       end
 
       def full_filename

data/lib/squib/args/sprue_file.rb

@@ -0,0 +1,44 @@
+require_relative 'arg_loader'
+
+module Squib
+  # @api private
+  module Args
+    class SprueFile
+      include ArgLoader
+
+      def initialize(dsl_method_default = {})
+        @dsl_method_default = dsl_method_default
+      end
+
+      def self.parameters
+        {
+          sprue: nil
+        }
+      end
+
+      def self.expanding_parameters
+        []
+      end
+
+      def self.params_with_units
+        [] # none of them
+      end
+
+      def validate_template_file(arg)
+        return nil if arg.nil?
+
+        thefile = File.exist?(arg) ? arg : builtin(arg)
+        raise "File #{File.expand_path(arg)} does not exist!" unless
+          File.exist? thefile
+
+        File.expand_path(thefile)
+      end
+
+      private
+
+      def builtin(file)
+        "#{File.dirname(__FILE__)}/../builtin/sprues/#{file}"
+      end
+    end
+  end
+end

data/lib/squib/args/unit_conversion.rb

@@ -13,6 +13,8 @@ module Squib
         case arg.to_s.rstrip
         when /in$/ # ends with "in"
           arg.rstrip[0..-2].to_f * dpi
+        when /pt$/ # ends with "in"
+          arg.rstrip[0..-2].to_f * dpi / POINTS_PER_IN
         when /cm$/ # ends with "cm"
           arg.rstrip[0..-2].to_f * dpi * INCHES_IN_CM
         when /mm$/ # ends with "mm"

data/lib/squib/{layouts → builtin/layouts}/economy.yml

@@ -1,4 +1,4 @@
-#This layout inspired by popular fantasy games
+#This layout inspired by popular economy games
 title:
   x: 90
   y: 90
@@ -19,7 +19,7 @@ description:
   height: 275
   valign: middle
   align: center
-  font_size: 18
+  font_size: 6
 desc: # alias
   extends: description
 
@@ -35,7 +35,7 @@ lower_right:
   y: 975
   width: 75
   height: 75
-  font_size: 18
+  font_size: 6
   valign: bottom
   align: right
 lr: #alias
@@ -46,7 +46,7 @@ lower_left:
   y: 975
   width: 75
   height: 75
-  font_size: 18
+  font_size: 6
   valign: bottom
   align: left
 ll: # alias
@@ -57,7 +57,7 @@ copyright:
   y: 1025
   width: 675
   height: 25
-  font_size: 16
+  font_size: 5
   align: center
   valign: bottom
 #aliases for copyright

data/lib/squib/{layouts → builtin/layouts}/fantasy.yml

@@ -42,7 +42,7 @@ description:
   height: 275
   valign: middle
   align: center
-  font_size: 18
+  font_size: 6
 desc: # alias
   extends: description
 
@@ -51,7 +51,7 @@ lower_right:
   y: 975
   width: 75
   height: 75
-  font_size: 18
+  font_size: 6
   valign: bottom
   align: right
 lr: #alias
@@ -62,7 +62,7 @@ lower_left:
   y: 975
   width: 75
   height: 75
-  font_size: 18
+  font_size: 6
   valign: bottom
   align: left
 ll: # alias
@@ -73,7 +73,7 @@ copyright:
   y: 1025
   width: 675
   height: 25
-  font_size: 16
+  font_size: 5
   align: center
   valign: bottom
 #aliases for copyright