squib 0.15.0 → 0.16.0.pre.preview2

data/lib/squib/args/unit_conversion.rb

@@ -1,15 +1,10 @@
 require_relative '../constants'
 
+
 module Squib
   module Args
-    # :nodoc:
-    # @api private
     module UnitConversion
-
-      # :nodoc:
-      # @api private
-      module_function
-      def parse(arg, dpi=300)
+      module_function def parse(arg, dpi=300, cell_px=37.5)
         case arg.to_s.rstrip
         when /in$/ # ends with "in"
           arg.rstrip[0..-2].to_f * dpi
@@ -19,11 +14,14 @@ module Squib
           arg.rstrip[0..-2].to_f * dpi * INCHES_IN_CM
         when /mm$/ # ends with "mm"
           arg.rstrip[0..-2].to_f * dpi * INCHES_IN_CM / 10.0
+        when /deg$/ # ends with "deg"
+          arg.rstrip[0..-3].to_f * (Math::PI / 180.0)
+        when /c(ell)?[s]?$/ # ends with 'c', 'cell', or 'cells'
+          arg.sub(/c(ell)?[s]?$/, '').to_f * cell_px
         else
           arg
         end
       end
-
     end
   end
 end

data/lib/squib/args/xywh_shorthands.rb

@@ -0,0 +1,51 @@
+require_relative 'unit_conversion'
+
+module Squib
+  module Args
+    module XYWHShorthands
+
+      MIDDLE_ONLY = /^(middle|center)\s*$/
+      DECK_ONLY = /^deck\s*$/
+      MIDDLE_MINUS_REGEX = /^(middle|center)\s*\-\s*/
+      MIDDLE_PLUS_REGEX = /^(middle|center)\s*\+\s*/
+      DECK_MINUS_REGEX = /^deck\s*\-\s*/
+      DECK_PLUS_REGEX = /^deck\s*\+\s*/
+      DECK_DIV_REGEX = /^deck\s*\/\s*/
+
+      # dimension is usually either deck_width or deck_height
+      def apply_shorthands(arg, deck, axis: :x)
+        dimension = (axis == :x) ? deck.width : deck.height
+        arg_s = arg.to_s
+        case arg_s
+        when MIDDLE_ONLY
+          dimension / 2.0
+        when DECK_ONLY
+          dimension
+        when MIDDLE_MINUS_REGEX # e.g. width: middle - 3
+          n = arg_s.sub MIDDLE_MINUS_REGEX, ''
+          n = UnitConversion.parse(n, deck.dpi, deck.cell_px).to_f
+          dimension / 2.0 - n
+        when MIDDLE_PLUS_REGEX # e.g. middle + 1.5in
+          n = arg_s.sub MIDDLE_PLUS_REGEX, ''
+          n = UnitConversion.parse(n, deck.dpi, deck.cell_px).to_f
+          dimension / 2.0 + n
+        when DECK_MINUS_REGEX # e.g. width: deck - 1.5in
+          n = arg_s.sub DECK_MINUS_REGEX, ''
+          n = UnitConversion.parse(n, deck.dpi, deck.cell_px).to_f
+          dimension - n
+        when DECK_PLUS_REGEX # e.g. deck + 1.5in (which is weird but ok)
+          n = arg_s.sub DECK_PLUS_REGEX, ''
+          n = UnitConversion.parse(n, deck.dpi, deck.cell_px).to_f
+          dimension + n
+        when DECK_DIV_REGEX # e.g. width: deck/3
+          n = arg_s.sub DECK_DIV_REGEX, ''
+          n = UnitConversion.parse(n, deck.dpi, deck.cell_px).to_f
+          dimension / n
+        else
+          arg
+        end
+      end
+
+    end
+  end
+end

data/lib/squib/builtin/projects/advanced/config.yml

@@ -1,8 +1,6 @@
 # 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
+# Looking for DPI? It needs to be a parameter to Squib::Deck.new. See https://squib.readthedocs.io/en/latest/dsl/deck.html
 
 #antialias: best #recommended. Only about 10% slower than fast
 #antialias: default # set the anti-aliasing algorithm. default defers to the underlying graphics device. See http://www.cairographics.org/manual/cairo-cairo-t.html#cairo-antialias-t
@@ -47,3 +45,6 @@ warn_ellipsize: true # default
 # By default, Squib will warn if a PNG is being up-scaled.
 warn_png_scale: true # default
 # warn_png_scale: false # turn off entirely
+
+# How many pixels are in a "cell"?
+# cell_px: 37.5 # default

data/lib/squib/builtin/projects/basic/config.yml

@@ -1,8 +1,6 @@
 # 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
+# Looking for DPI? It needs to be a parameter to Squib::Deck.new
 
 #antialias: best #recommended. Only about 10% slower than fast
 #antialias: default # set the anti-aliasing algorithm. default defers to the underlying graphics device. See http://www.cairographics.org/manual/cairo-cairo-t.html#cairo-antialias-t
@@ -47,3 +45,6 @@
 # By default, Squib will warn if a PNG is being up-scaled.
 # warn_png_scale: true # default
 # warn_png_scale: false # turn off entirely
+
+# How many pixels are in a "cell"?
+# cell_px: 37.5 # default

data/lib/squib/conf.rb

@@ -17,6 +17,7 @@ module Squib
     DEFAULTS = {
       'antialias'     => 'best',
       'backend'       => 'memory',
+      'cell_px'       => 37.5,
       'count_format'  => '%02d',
       'custom_colors' => {},
       'dir'           => '_output',
@@ -89,6 +90,10 @@ module Squib
       @typographer
     end
 
+    def cell_px
+      @config_hash['cell_px'].to_f
+    end
+
     def dir
       @config_hash['dir']
     end

data/lib/squib/deck.rb

@@ -33,7 +33,7 @@ module Squib
                           :img_dir, :prefix, :text_hint, :typographer
     # :nodoc:
     # @api private
-    attr_reader :layout, :conf, :dpi, :font
+    attr_reader :layout, :conf, :dpi, :font, :cell_px
 
     #
     # deck.size is really just @cards.size
@@ -63,12 +63,13 @@ module Squib
       @font          = DEFAULT_FONT
       @cards         = []
       @conf          = Conf.load(config)
+      @cell_px       = @conf.cell_px
       @progress_bar  = Progress.new(@conf.progress_bars) # FIXME this is evil. Using something different with @ and non-@
       show_info(config, layout)
-      @width         = Args::UnitConversion.parse width, dpi
-      @height        = Args::UnitConversion.parse height, dpi
+      @width         = Args::UnitConversion.parse width, dpi, @cell_px
+      @height        = Args::UnitConversion.parse height, dpi, @cell_px
       cards.times{ |i| @cards << Squib::Card.new(self, @width, @height, i) }
-      @layout = LayoutParser.new(dpi).load_layout(layout)
+      @layout = LayoutParser.new(dpi, @cell_px).load_layout(layout)
       enable_groups_from_env!
       if block_given?
         instance_eval(&block) # here we go. wheeeee!
@@ -102,15 +103,36 @@ module Squib
     ##################
     ### PUBLIC API ###
     ##################
-    require_relative 'api/background'
-    require_relative 'api/data'
-    require_relative 'api/groups'
-    require_relative 'api/image'
-    require_relative 'api/save'
     require_relative 'api/settings'
-    require_relative 'api/shapes'
-    require_relative 'api/text'
-    require_relative 'api/units'
 
+    ###################
+    ### DSL METHODS ###
+    ###################
+    require_relative 'dsl/background'
+    require_relative 'dsl/circle'
+    require_relative 'dsl/csv'
+    require_relative 'dsl/curve'
+    require_relative 'dsl/cut_zone'
+    require_relative 'dsl/ellipse'
+    require_relative 'dsl/grid'
+    require_relative 'dsl/groups'
+    require_relative 'dsl/hand'
+    require_relative 'dsl/line'
+    require_relative 'dsl/png'
+    require_relative 'dsl/polygon'
+    require_relative 'dsl/rect'
+    require_relative 'dsl/safe_zone'
+    require_relative 'dsl/save_pdf'
+    require_relative 'dsl/save_png'
+    require_relative 'dsl/save_sheet'
+    require_relative 'dsl/save'
+    require_relative 'dsl/showcase'
+    require_relative 'dsl/star'
+    require_relative 'dsl/svg'
+    require_relative 'dsl/text'
+    require_relative 'dsl/triangle'
+    require_relative 'dsl/units'
+    require_relative 'dsl/xlsx'
+    require_relative 'dsl/yaml'
   end
 end

data/lib/squib/dsl/background.rb

@@ -0,0 +1,35 @@
+require_relative '../errors_warnings/warn_unexpected_params'
+
+module Squib
+  class Deck
+    def background(opts = {})
+      DSL::Background.new(self, __callee__).run(opts)
+    end
+  end
+
+  module DSL
+    class Background
+      include WarnUnexpectedParams
+      attr_reader :dsl_method, :deck
+
+      def initialize(deck, dsl_method)
+        @deck = deck
+        @dsl_method = dsl_method
+      end
+
+      def self.accepted_params
+        %i{
+          range
+          color
+        }
+      end
+
+      def run(opts)
+        warn_if_unexpected opts
+        range = Args.extract_range opts, deck
+        draw  = Args.extract_draw opts, deck
+        range.each { |i| @deck.cards[i].background(draw.color[i]) }
+      end
+    end
+  end
+end

data/lib/squib/dsl/circle.rb

@@ -0,0 +1,39 @@
+require_relative '../errors_warnings/warn_unexpected_params'
+require_relative '../args/card_range'
+require_relative '../args/coords'
+require_relative '../args/draw'
+
+module Squib
+  class Deck
+    def circle(opts = {})
+      DSL::Circle.new(self, __callee__).run(opts)
+    end
+  end
+
+  module DSL
+    class Circle
+      include WarnUnexpectedParams
+      attr_reader :dsl_method, :deck
+
+      def initialize(deck, dsl_method)
+        @deck = deck
+        @dsl_method = dsl_method
+      end
+
+      def self.accepted_params
+        %i(x y
+           radius arc_start arc_end arc_direction arc_close
+           fill_color stroke_color stroke_width stroke_strategy join dash cap
+           range layout)
+      end
+
+      def run(opts)
+        warn_if_unexpected opts
+        range = Args.extract_range opts, deck
+        coords = Args.extract_coords opts, deck
+        draw  = Args.extract_draw opts, deck
+        range.each { |i| deck.cards[i].circle(coords[i], draw[i]) }
+      end
+    end
+  end
+end

data/lib/squib/dsl/csv.rb

@@ -0,0 +1,42 @@
+require_relative '../args/import'
+require_relative '../args/csv_opts'
+require_relative '../import/csv_importer'
+require_relative '../errors_warnings/warn_unexpected_params'
+
+module Squib
+  # DSL method. See http://squib.readthedocs.io
+  def csv(opts = {}, &block)
+    DSL::Csv.new(__callee__).run(opts, &block)
+  end
+  module_function :csv
+
+  class Deck
+    # DSL method. See http://squib.readthedocs.io
+    def csv(opts = {}, &block)
+      DSL::Csv.new(__callee__).run(opts, &block)
+    end
+  end
+
+  module DSL
+    class Csv
+      include WarnUnexpectedParams
+      attr_reader :dsl_method, :block
+
+      def initialize(dsl_method)
+        @dsl_method = dsl_method
+      end
+
+      def self.accepted_params
+        %i( file data strip explode col_sep quote_char)
+      end
+
+      def run(opts,&block)
+        warn_if_unexpected opts
+        import_args = Args.extract_import opts
+        importer = Squib::Import::CsvImporter.new
+        csv_opts = Args::CSV_Opts.new(opts)
+        importer.import_to_dataframe(import_args, csv_opts, &block)
+      end
+    end
+  end
+end

data/lib/squib/dsl/curve.rb

@@ -0,0 +1,35 @@
+require_relative '../errors_warnings/warn_unexpected_params'
+
+module Squib
+  class Deck
+    def curve(opts = {})
+      DSL::Curve.new(self, __callee__).run(opts)
+    end
+  end
+
+  module DSL
+    class Curve
+      include WarnUnexpectedParams
+      attr_reader :dsl_method, :deck
+
+      def initialize(deck, dsl_method)
+        @deck = deck
+        @dsl_method = dsl_method
+      end
+
+      def self.accepted_params
+        %i(x1 y1 x2 y2 cx1 cy1 cx2 cy2
+           fill_color stroke_color stroke_width stroke_strategy join dash cap
+           range layout)
+      end
+
+      def run(opts)
+        warn_if_unexpected opts
+        range = Args.extract_range opts, deck
+        draw  = Args.extract_draw opts, deck
+        coords   = Args.extract_coords opts, deck
+        range.each { |i| deck.cards[i].curve(coords[i], draw[i]) }
+      end
+    end
+  end
+end

data/lib/squib/dsl/cut_zone.rb

@@ -0,0 +1,47 @@
+require_relative '../errors_warnings/warn_unexpected_params'
+
+module Squib
+  class Deck
+    def cut_zone(opts = {})
+      DSL::CutZone.new(self, __callee__).run(opts)
+    end
+  end
+
+  module DSL
+    class CutZone
+      include WarnUnexpectedParams
+      attr_reader :dsl_method, :deck
+
+      def initialize(deck, dsl_method)
+        @deck = deck
+        @dsl_method = dsl_method
+      end
+
+      def self.accepted_params
+        %i(x y width height margin angle
+           x_radius y_radius radius
+           fill_color stroke_color stroke_width stroke_strategy join dash cap
+           range layout)
+      end
+
+      def run(opts)
+        warn_if_unexpected opts
+        cut_defaults = {
+          margin: '0.125in',
+          radius: '0.125in',
+          stroke_color: :red,
+          fill_color: '#0000',
+          stroke_width: 2.0,
+        }
+        new_opts = cut_defaults.merge(opts)
+        margin = Args::UnitConversion.parse new_opts[:margin], @deck.dpi, @deck.cell_px
+        new_opts[:x] = margin
+        new_opts[:y] = margin
+        new_opts[:width] = deck.width - (2 * margin)
+        new_opts[:height] = deck.height - (2 * margin)
+        new_opts.delete :margin
+        deck.rect new_opts
+      end
+    end
+  end
+end

data/lib/squib/dsl/ellipse.rb

@@ -0,0 +1,37 @@
+require_relative '../errors_warnings/warn_unexpected_params'
+
+module Squib
+  class Deck
+    def ellipse(opts = {})
+      DSL::Ellipse.new(self, __callee__).run(opts)
+    end
+  end
+
+  module DSL
+    class Ellipse
+      include WarnUnexpectedParams
+      attr_reader :dsl_method, :deck
+
+      def initialize(deck, dsl_method)
+        @deck = deck
+        @dsl_method = dsl_method
+      end
+
+      def self.accepted_params
+        %i(x y width height
+           fill_color stroke_color stroke_width stroke_strategy join dash cap
+           angle
+           range layout)
+      end
+
+      def run(opts)
+        warn_if_unexpected opts
+        range = Args.extract_range opts, deck
+        draw  = Args.extract_draw opts, deck
+        box   = Args.extract_box opts, deck
+        trans = Args.extract_transform opts, deck
+        range.each { |i| deck.cards[i].ellipse(box[i], draw[i], trans[i]) }
+      end
+    end
+  end
+end