squib 0.15.1 → 0.16.0

data/RELEASE TODO.md

@@ -1,21 +1,22 @@
-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
- - [ ] Are all the dependencies up to date?
- - [ ] Check `sample_regression_spec.rb` regression tests are all enabled (i.e. `overwrite_sample` is commented out)
- - [ ] Bump version.rb
- - [ ] Bump docs/conf.py versions
- - [ ] Do a full rake locally
- - [ ] `rake sanity`, and check visually
- - [ ] Travis is passing on dev branch
- - [ ] Merge master branch
- - [ ] Merge release branch
- - [ ] Push master and release branches
- - [ ] Create GitHub release tag
- - [ ] `gem push pkg/squib-x.y.z.gem`
- - [ ] Github milestone closed
- - [ ] Activate version on squib.readthedocs.org
- - [ ] Bump version.rb to the next alpha
- - [ ] Publish on BoardGameGeek thread
+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
+ - [ ] Are all the dependencies up to date?
+ - [ ] Check `sample_regression_spec.rb` regression tests are all enabled (i.e. `overwrite_sample` is commented out)
+ - [ ] Bump version.rb
+ - [ ] Bump docs/conf.py versions
+ - [ ] Do a full rake locally
+ - [ ] `rake sanity`, and check visually
+ - [ ] Travis is passing on dev branch
+ - [ ] Merge master branch
+ - [ ] Merge release branch
+ - [ ] Push master and release branches
+ - [ ] Create GitHub release tag
+ - [ ] `gem push pkg/squib-x.y.z.gem`
+ - [ ] `gem push --key github --host https://rubygems.pkg.github.com/andymeneely pkg/squib-x.y.z.gem`
+ - [ ] Github milestone closed
+ - [ ] Activate version on squib.readthedocs.org
+ - [ ] Bump version.rb to the next alpha
+ - [ ] Publish on BoardGameGeek thread

data/Rakefile

@@ -1,48 +1,51 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'benchmark'
-# require 'byebug'
-
-desc 'install + spec'
-task default: ['install:local', :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|
-  args.with_defaults(file: 'basic.rb')
-  Dir.chdir('samples') do
-    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 'Run some performance benchmarks'
-task benchmark: [:install] do
-  require 'squib'
-  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
-
-desc 'Run sanity tests without a full rebuild'
-task :sanity_only do
-  require_relative 'spec/sanity/sanity_test.rb'
-  SanityTest.new.run
-end
-
-desc 'Run full rebuild with sanity tests'
-task sanity: [:install, :spec, :sanity_only]
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'benchmark'
+# require 'byebug'
+
+desc 'install + spec'
+task default: ['install:local', :spec]
+
+desc 'test => spec'
+task test: [: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|
+  args.with_defaults(file: 'basic.rb')
+  Dir.chdir('samples') do
+    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 'Run some performance benchmarks'
+task benchmark: [:install] do
+  require 'squib'
+  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
+
+desc 'Run sanity tests without a full rebuild'
+task :sanity_only do
+  require_relative 'spec/sanity/sanity_test.rb'
+  SanityTest.new.run
+end
+
+desc 'Run full rebuild with sanity tests'
+task sanity: [:install, :spec, :sanity_only]

data/bin/squib

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
-require 'squib'
-
-Squib::CLI.new.run
+#!/usr/bin/env ruby
+require 'squib'
+
+Squib::CLI.new.run

data/lib/squib.rb

@@ -1,32 +1,34 @@
-require 'logger'
-require 'cairo'
-require 'pango'
-require 'rsvg2'
-require_relative 'squib/version'
-require_relative 'squib/commands/cli'
-require_relative 'squib/deck'
-require_relative 'squib/card'
-
-module Squib
-
-  # Access the internal logger that Squib uses. By default, Squib configure the logger to the WARN level
-  # Use this to suppress or increase output levels.
-  # @example
-  #   Squib.logger.level = Logger::DEBUG #show waaaay more information than you probably need, unless you're a dev
-  #   Squib.logger.level = Logger::ERROR #basically turns it off
-  #
-  # @return [Logger] the ruby logger
-  # @api public
-  def logger
-    if @logger.nil?
-      @logger = Logger.new($stdout)
-      @logger.level = Logger::WARN
-      @logger.formatter = proc do |severity, datetime, m_progname, msg|
-        "#{datetime} #{severity}: #{msg}\n"
-      end
-    end
-    @logger
-  end
-  module_function :logger
-
-end
+require 'logger'
+require 'cairo'
+require 'pango'
+require 'rsvg2'
+require 'rainbow/refinement'
+require_relative 'squib/version'
+require_relative 'squib/commands/cli'
+require_relative 'squib/deck'
+require_relative 'squib/card'
+
+module Squib
+  using Rainbow # we can colorize strings now!
+
+  # Access the internal logger that Squib uses. By default, Squib configure the logger to the WARN level
+  # Use this to suppress or increase output levels.
+  # @example
+  #   Squib.logger.level = Logger::DEBUG #show waaaay more information than you probably need, unless you're a dev
+  #   Squib.logger.level = Logger::ERROR #basically turns it off
+  #
+  # @return [Logger] the ruby logger
+  # @api public
+  def logger
+    if @logger.nil?
+      @logger = Logger.new($stdout)
+      @logger.level = Logger::WARN
+      @logger.formatter = proc do |severity, datetime, m_progname, msg|
+        "[#{datetime.strftime('%F %H:%M:%S')} #{severity.red}] #{msg}\n"
+      end
+    end
+    @logger
+  end
+  module_function :logger
+
+end

data/lib/squib/api/settings.rb

@@ -1,21 +1,21 @@
-module Squib
-  class Deck
-
-    # DSL method. See http://squib.readthedocs.io
-    def hint(text: :off)
-      conf.text_hint = text
-    end
-
-    # DSL method. See http://squib.readthedocs.io
-    def set(opts = {})
-      raise 'DEPRECATED: As of v0.7 img_dir is no longer supported in "set". Use config.yml instead.' if opts.key? :img_dir
-      @font = (opts[:font] == :default) ? Squib::DEFAULT_FONT : opts[:font]
-    end
-
-    # DSL method. See http://squib.readthedocs.io
-    def use_layout(file: 'layout.yml')
-      @layout = LayoutParser.new(@dpi).load_layout(file, @layout)
-    end
-
-  end
-end
+module Squib
+  class Deck
+
+    # DSL method. See http://squib.readthedocs.io
+    def hint(text: :off)
+      conf.text_hint = text
+    end
+
+    # DSL method. See http://squib.readthedocs.io
+    def set(opts = {})
+      raise 'DEPRECATED: As of v0.7 img_dir is no longer supported in "set". Use config.yml instead.' if opts.key? :img_dir
+      @font = (opts[:font] == :default) ? Squib::DEFAULT_FONT : opts[:font]
+    end
+
+    # DSL method. See http://squib.readthedocs.io
+    def use_layout(file: 'layout.yml')
+      @layout = LayoutParser.new(@dpi).load_layout(file, @layout)
+    end
+
+  end
+end

data/lib/squib/args/arg_loader.rb

@@ -1,126 +1,129 @@
-require_relative '../constants'
-require_relative '../conf'
-require 'ostruct'
-
-module Squib
-  # @api private
-  module Args
-
-    # Intended to be used a a mix-in,
-    # For example use see Box as an example
-    module ArgLoader
-
-      # Main class invoked by the client (i.e. api/ methods)
-      def load!(args, expand_by: 1, layout: {}, dpi: 300)
-        Squib.logger.debug { "ARG LOADER: load! for #{self.class}, args: #{args}" }
-        @dpi = dpi
-        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 dpi: dpi
-        self
-      end
-
-      def expand_and_set_and_defaultify(args: {}, by: 1, layout: {})
-        attributes = self.class.parameters.keys
-        attributes.each do |p|
-          args[p] = defaultify(p, args, layout)
-          val = if expandable_singleton?(p, args[p])
-                  [args[p]] * by
-                else
-                  args[p] # not an expanding parameter
-                end
-          instance_variable_set "@#{p}", val
-        end
-        self.class.class_eval { attr_reader *(attributes) }
-      end
-
-      # Must be:
-      #  (a) an expanding parameter, and
-      #  (b) a singleton already (i.e. doesn't respond to :each)
-      def expandable_singleton?(p, arg)
-        self.class.expanding_parameters.include?(p) && !arg.respond_to?(:each)
-      end
-
-      # Incorporate defaults and layouts
-      #  (1) Use whatever is specified if it is
-      #  (2) Go over all layout specifications (if any) and look them up
-      #     - Use layout when it's specified for that card
-      #     - Use "default" if no layout was specified, or the layout itself did not specify
-      #           Defaut can be overriden for a given dsl method (@dsl_method_defaults)
-      #           (e.g stroke width is 0.0 for text, non-zero everywhere else)
-      #
-      def defaultify(p, args, layout)
-        return args[p] if args.key? p # arg was specified, no defaults used
-        defaults = self.class.parameters.merge(@dsl_method_defaults || {})
-        args[:layout].map do |layout_arg|
-          return defaults[p] if layout_arg.nil?  # no layout specified, use default
-          unless layout.key? layout_arg.to_s     # specified a layout, but it doesn't exist in layout. Oops!
-            Squib.logger.warn("Layout \"#{layout_arg.to_s}\" does not exist in layout file - using default instead")
-            return defaults[p]
-          end
-          if layout[layout_arg.to_s].key?(p.to_s)
-            layout[layout_arg.to_s][p.to_s]     # param specified in layout
-          else
-            defaults[p]                         # layout specified, but not this param
-          end
-        end
-      end
-
-      # Do singleton expansion on the layout argument as well
-      # Treated differently since layout is not always specified
-      def prep_layout_args(layout_args, expand_by: 1)
-        unless layout_args.respond_to?(:each)
-          layout_args = [layout_args] * expand_by
-        end
-        layout_args || []
-      end
-
-      # For each parameter/attribute foo we try to invoke a validate_foo
-      def validate
-        self.class.parameters.each do |param, default|
-          method = "validate_#{param}"
-          if self.respond_to? method
-            attribute = "@#{param}"
-            val = instance_variable_get(attribute)
-            if val.respond_to? :each
-              new_val = val.map.with_index{ |v, i| send(method, v, i) }
-              instance_variable_set(attribute, new_val)
-            else
-              instance_variable_set(attribute, send(method, val))
-            end
-          end
-        end
-      end
-
-      # Access an individual arg for a given card
-      # @return an OpenStruct that looks just like the mixed-in class
-      # @api private
-      def [](i)
-        card_arg = OpenStruct.new
-        self.class.expanding_parameters.each do |p|
-          p_val = instance_variable_get("@#{p}")
-          card_arg[p] = p_val[i]
-        end
-        card_arg
-      end
-
-      # Convert units
-      def convert_units(dpi: 300)
-        self.class.params_with_units.each do |p|
-          p_str = "@#{p}"
-          p_val = instance_variable_get(p_str)
-          if p_val.respond_to? :each
-            arr = p_val.map { |x| UnitConversion.parse(x, dpi) }
-            instance_variable_set p_str, arr
-          else
-            instance_variable_set p_str, UnitConversion.parse(p_val, dpi)
-          end
-        end
-        self
-      end
-
-    end
-
-  end
-end
+require_relative '../constants'
+require_relative '../conf'
+require 'ostruct'
+
+# Intended to be used a a mix-in,
+# For example use see Box as an example
+module Squib::Args::ArgLoader
+
+  # wrapper for compatibility
+  def extract!(args, deck)
+    @deck = deck
+    load!(args,
+          expand_by: deck.size,
+          layout: deck.layout,
+          dpi: deck.dpi,
+          cell_px: deck.cell_px)
+  end
+
+  # Main class invoked by the client (i.e. dsl/ methods)
+  def load!(args, expand_by: 1, layout: {}, dpi: 300, cell_px: 37.5)
+    @dpi = dpi
+    @cell_px = cell_px
+    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 dpi: dpi, cell_px: cell_px
+    self
+  end
+
+  def expand_and_set_and_defaultify(args: {}, by: 1, layout: {})
+    attributes = self.class.parameters.keys
+    attributes.each do |p|
+      args[p] = defaultify(p, args, layout)
+      val = if expandable_singleton?(p, args[p])
+              [args[p]] * by
+            else
+              args[p] # not an expanding parameter
+            end
+      instance_variable_set "@#{p}", val
+    end
+    self.class.class_eval { attr_reader *(attributes) }
+  end
+
+  # Must be:
+  #  (a) an expanding parameter, and
+  #  (b) a singleton already (i.e. doesn't respond to :each)
+  def expandable_singleton?(p, arg)
+    self.class.expanding_parameters.include?(p) && !arg.respond_to?(:each)
+  end
+
+  # Incorporate defaults and layouts
+  #  (1) Use whatever is specified if it is
+  #  (2) Go over all layout specifications (if any) and look them up
+  #     - Use layout when it's specified for that card
+  #     - Use "default" if no layout was specified, or the layout itself did not specify
+  #           Defaut can be overriden for a given dsl method (@dsl_method_defaults)
+  #           (e.g stroke width is 0.0 for text, non-zero everywhere else)
+  #
+  def defaultify(p, args, layout)
+    return args[p] if args.key? p # arg was specified, no defaults used
+    defaults = self.class.parameters.merge(@dsl_method_defaults || {})
+    args[:layout].map do |layout_arg|
+      return defaults[p] if layout_arg.nil?  # no layout specified, use default
+      unless layout.key? layout_arg.to_s     # specified a layout, but it doesn't exist in layout. Oops!
+        Squib.logger.warn("Layout \"#{layout_arg.to_s}\" does not exist in layout file - using default instead")
+        return defaults[p]
+      end
+      if layout[layout_arg.to_s].key?(p.to_s)
+        layout[layout_arg.to_s][p.to_s]     # param specified in layout
+      else
+        defaults[p]                         # layout specified, but not this param
+      end
+    end
+  end
+
+  # Do singleton expansion on the layout argument as well
+  # Treated differently since layout is not always specified
+  def prep_layout_args(layout_args, expand_by: 1)
+    unless layout_args.respond_to?(:each)
+      layout_args = [layout_args] * expand_by
+    end
+    layout_args || []
+  end
+
+  # For each parameter/attribute foo we try to invoke a validate_foo
+  def validate
+    self.class.parameters.each do |param, default|
+      method = "validate_#{param}"
+      if self.respond_to? method
+        attribute = "@#{param}"
+        val = instance_variable_get(attribute)
+        if val.respond_to? :each
+          new_val = val.map.with_index{ |v, i| send(method, v, i) }
+          instance_variable_set(attribute, new_val)
+        else
+          instance_variable_set(attribute, send(method, val))
+        end
+      end
+    end
+  end
+
+  # Access an individual arg for a given card
+  # @return an OpenStruct that looks just like the mixed-in class
+  # @api private
+  def [](i)
+    card_arg = OpenStruct.new
+    self.class.expanding_parameters.each do |p|
+      p_val = instance_variable_get("@#{p}")
+      card_arg[p] = p_val[i]
+    end
+    card_arg
+  end
+
+  # Convert units
+  def convert_units(dpi: 300, cell_px: 37.5)
+    self.class.params_with_units.each do |p|
+      p_str = "@#{p}"
+      p_val = instance_variable_get(p_str)
+      if p_val.respond_to? :each
+        arr = p_val.map { |x| Squib::Args::UnitConversion.parse(x, dpi, cell_px) }
+        instance_variable_set p_str, arr
+      else
+        instance_variable_set p_str, Squib::Args::UnitConversion.parse(p_val, dpi, cell_px)
+      end
+    end
+    self
+  end
+
+end