squib 0.15.3 → 0.16.0.pre.preview1

data/lib/squib/dsl/showcase.rb

@@ -0,0 +1,43 @@
+require_relative '../errors_warnings/warn_unexpected_params'
+require_relative '../args/card_range'
+require_relative '../args/showcase_special'
+require_relative '../args/sheet'
+
+module Squib
+  class Deck
+    def showcase(opts = {})
+      DSL::Showcase.new(self, __callee__).run(opts)
+    end
+  end
+
+  module DSL
+    class Showcase
+      include WarnUnexpectedParams
+      attr_reader :dsl_method, :deck
+
+      def initialize(deck, dsl_method)
+        @deck = deck
+        @dsl_method = dsl_method
+      end
+
+      def self.accepted_params
+        %i(
+          file dir
+          trim trim_radius
+          scale offset fill_color
+          reflect_offset reflect_strength reflect_percent
+          face margin
+          range
+         )
+      end
+
+      def run(opts)
+        warn_if_unexpected opts
+        range = Args.extract_range opts, deck
+        showcase = Args.extract_showcase_special opts, deck
+        sheet = Args.extract_sheet opts, deck, { file: 'showcase.png' }
+        deck.render_showcase(range, sheet, showcase)
+      end
+    end
+  end
+end

data/lib/squib/dsl/star.rb

@@ -0,0 +1,37 @@
+require_relative '../errors_warnings/warn_unexpected_params'
+
+module Squib
+  class Deck
+    def star(opts = {})
+      DSL::Star.new(self, __callee__).run(opts)
+    end
+  end
+
+  module DSL
+    class Star
+      include WarnUnexpectedParams
+      attr_reader :dsl_method, :deck
+
+      def initialize(deck, dsl_method)
+        @deck = deck
+        @dsl_method = dsl_method
+      end
+
+      def self.accepted_params
+        %i(n x y
+           inner_radius outer_radius angle
+           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
+        trans  = Args.extract_transform opts, deck
+        range.each { |i| deck.cards[i].star(coords[i], trans[i], draw[i]) }
+      end
+    end
+  end
+end

data/lib/squib/dsl/svg.rb

@@ -0,0 +1,62 @@
+require_relative '../errors_warnings/warn_unexpected_params'
+require_relative '../args/card_range'
+require_relative '../args/paint'
+require_relative '../args/scale_box'
+require_relative '../args/transform'
+require_relative '../args/input_file'
+require_relative '../args/svg_special'
+
+module Squib
+  class Deck
+    def svg(opts = {})
+      DSL::SVG.new(self, __callee__).run(opts)
+    end
+  end
+
+  module DSL
+    class SVG
+      include WarnUnexpectedParams
+      attr_reader :dsl_method, :deck
+
+      def initialize(deck, dsl_method)
+        @deck = deck
+        @dsl_method = dsl_method
+      end
+
+      def self.accepted_params
+        %i(
+          file
+          x y width height
+          blend mask
+          crop_x crop_y crop_width crop_height
+          crop_corner_radius crop_corner_x_radius crop_corner_y_radius
+          flip_horizontal flip_vertical angle
+          id force_id data
+          range layout
+         )
+      end
+
+      def run(opts)
+        warn_if_unexpected opts
+        Dir.chdir(deck.img_dir) do
+          range = Args.extract_range opts, deck
+          paint = Args.extract_paint opts, deck
+          box   = Args.extract_scale_box opts, deck
+          trans = Args.extract_transform opts, deck
+          ifile = Args.extract_input_file opts, deck
+          svg_args = Args.extract_svg_special opts, deck
+          deck.progress_bar.start('Loading PNG(s)', range.size) do |bar|
+            range.each do |i|
+              if svg_args.render?(i)
+                deck.cards[i].svg(ifile[i].file, svg_args[i], box[i], paint[i],
+                                  trans[i])
+              end
+              bar.increment
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/squib/dsl/text.rb

@@ -0,0 +1,54 @@
+require_relative '../args/box'
+require_relative '../args/card_range'
+require_relative '../args/draw'
+require_relative '../args/paragraph'
+require_relative '../args/transform'
+require_relative '../dsl/text_embed'
+require_relative '../errors_warnings/warn_unexpected_params'
+
+module Squib
+  class Deck
+    def text(opts = {})
+      embed = TextEmbed.new self, __callee__
+      yield(embed) if block_given? # store the opts for later use
+      DSL::Text.new(self, __callee__, embed).run(opts)
+    end
+  end
+
+  module DSL
+    class Text
+      include WarnUnexpectedParams
+      attr_reader :dsl_method, :deck, :embed
+
+      def initialize(deck, dsl_method, embed)
+        @deck = deck
+        @dsl_method = dsl_method
+        @embed = embed
+      end
+
+      def self.accepted_params
+        %i(
+          str font font_size x y markup width height
+          wrap spacing align justify valign ellipsize angle dash cap join
+          hint color fill_color
+          stroke_color stroke_width stroke_width stroke_color stroke_strategy
+          range layout
+        )
+      end
+
+      def run(opts)
+        warn_if_unexpected opts
+        range = Args.extract_range opts, deck
+        para  = Args.extract_para opts, deck
+        box   = Args.extract_box opts, deck, { width: :auto, height: :auto }
+        trans = Args.extract_transform opts, deck
+        draw  = Args.extract_draw opts, deck, { stroke_width: 0.0 }
+        extents = Array.new(deck.size)
+        range.each do |i|
+          extents[i] = deck.cards[i].text(embed, para[i], box[i], trans[i], draw[i], deck.dpi)
+        end
+        return extents
+      end
+    end
+  end
+end

data/lib/squib/dsl/text_embed.rb

@@ -0,0 +1,78 @@
+require_relative '../args/box'
+require_relative '../args/card_range'
+require_relative '../args/embed_adjust'
+require_relative '../args/embed_key'
+require_relative '../args/input_file'
+require_relative '../args/paint'
+require_relative '../args/transform'
+require_relative '../errors_warnings/warn_unexpected_params'
+
+module Squib
+  class TextEmbed
+    include WarnUnexpectedParams
+    attr_reader :rules, :deck, :dsl_method
+
+    def initialize(deck, dsl_method)
+      @deck = deck
+      @rules = {} # store an array of options for later usage
+    end
+
+    def self.accepted_params
+      %i(
+        key file id force_id layout width height dx dy
+        id force_id data
+        flip_horizontal flip_vertical
+        alpha angle blend mask
+      )
+    end
+
+    def svg(opts = {})
+      warn_if_unexpected opts
+      key   = Args::EmbedKey.new.validate_key(opts[:key])
+      range = Args.extract_range opts, deck
+      paint = Args.extract_paint opts, deck
+      box   = Args.extract_box opts, deck, { width: :native, height: :native }
+      adjust = Args::EmbedAdjust.new.load!(opts, expand_by: deck.size, layout: deck.layout, dpi: deck.dpi)
+      trans = Args.extract_transform opts, deck
+      ifile = Args.extract_input_file opts, deck
+      svg_args = Args.extract_svg_special opts, deck
+      rule = { type: :svg, file: ifile, box: box, paint: paint, trans: trans,
+               adjust: adjust, svg_args: svg_args }
+      rule[:draw] = Proc.new do |card, x, y, scale|
+        i = card.index
+        b = box[i]
+        b.x, b.y = x, y
+        b.width = b.width * scale if b.width.is_a? Numeric
+        b.height = b.height * scale if b.height.is_a? Numeric
+        Dir.chdir(deck.img_dir) do
+          card.svg(ifile[i].file, svg_args[i], b, paint[i], trans[i])
+        end
+      end
+      @rules[key] = rule
+    end
+
+    def png(opts = {})
+      warn_if_unexpected opts
+      key   = Args::EmbedKey.new.validate_key(opts[:key])
+      range = Args.extract_range opts, deck
+      paint = Args.extract_paint opts, deck
+      box   = Args.extract_box opts, deck, { width: :native, height: :native }
+      adjust = Args::EmbedAdjust.new.load!(opts, expand_by: deck.size, layout: deck.layout, dpi: deck.dpi)
+      trans = Args.extract_transform opts, deck
+      ifile = Args.extract_input_file opts, deck
+      rule  = { type: :png, file: ifile, box: box, paint: paint, trans: trans, adjust: adjust }
+      rule[:draw] = Proc.new do |card, x, y, scale|
+        i = card.index
+        b = box[i]
+        b.x, b.y = x, y
+        b.width = b.width * scale if b.width.is_a? Numeric
+        b.height = b.height * scale if b.height.is_a? Numeric
+        Dir.chdir(deck.img_dir) do
+          card.png(ifile[i].file, b, paint[i], trans[i])
+        end
+      end
+      @rules[key] = rule
+    end
+
+  end
+end

data/lib/squib/dsl/triangle.rb

@@ -0,0 +1,35 @@
+require_relative '../errors_warnings/warn_unexpected_params'
+
+module Squib
+  class Deck
+    def triangle(opts = {})
+      DSL::Triangle.new(self, __callee__).run(opts)
+    end
+  end
+
+  module DSL
+    class Triangle
+      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 x3 y3
+           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].triangle(coords[i], draw[i]) }
+      end
+    end
+  end
+end

data/lib/squib/{api → dsl}/units.rb

@@ -23,5 +23,15 @@ module Squib
       @dpi * Squib::INCHES_IN_CM * n.to_f / 10.0
     end
 
+    # DSL method. See http://squib.readthedocs.io
+    def deg(n)
+      n.to_f * (Math::PI / 180.0)
+    end
+
+    # DSL method. See http://squib.readthedocs.io
+    def cells(n)
+      n.to_f * @cell_px
+    end
+
   end
 end

data/lib/squib/dsl/xlsx.rb

@@ -0,0 +1,40 @@
+require_relative '../args/import'
+require_relative '../import/xlsx_importer'
+require_relative '../errors_warnings/warn_unexpected_params'
+
+module Squib
+  # DSL method. See http://squib.readthedocs.io
+  def xlsx(opts = {}, &block)
+    DSL::Xlsx.new(__callee__).run(opts, &block)
+  end
+  module_function :xlsx
+
+  class Deck
+    # DSL method. See http://squib.readthedocs.io
+    def xlsx(opts = {}, &block)
+      DSL::Xlsx.new(__callee__).run(opts, &block)
+    end
+  end
+
+  module DSL
+    class Xlsx
+      include WarnUnexpectedParams
+      attr_reader :dsl_method, :block
+
+      def initialize(dsl_method)
+        @dsl_method = dsl_method
+      end
+
+      def self.accepted_params
+        %i( file sheet strip explode )
+      end
+
+      def run(opts,&block)
+        warn_if_unexpected opts
+        import_args = Args.extract_import opts
+        importer = Squib::Import::XlsxImporter.new
+        importer.import_to_dataframe(import_args, &block)
+      end
+    end
+  end
+end

data/lib/squib/dsl/yaml.rb

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

data/lib/squib/errors_warnings/warn_unexpected_params.rb

@@ -0,0 +1,14 @@
+require 'rainbow/refinement'
+
+module Squib::WarnUnexpectedParams
+  using Rainbow # we can colorize strings now!
+
+  def warn_if_unexpected(opts, uplevel: 5)
+    accepted_params = self.class.accepted_params
+    unexpected = opts.keys - accepted_params
+    unexpected.each do |key|
+      warn "Unexpected parameter '#{key.to_s.yellow}:' to #{dsl_method.to_s.cyan}(). Accepted parameters: #{accepted_params}",
+           uplevel: uplevel
+    end
+  end
+end

data/lib/squib/graphics/save_images.rb

@@ -10,7 +10,7 @@ module Squib
                 else
                   @cairo_surface
                 end
-      write_png(surface, index, batch.dir, batch.prefix, batch.count_format)
+      write_png(surface, index, batch)
     end
 
     # :nodoc:
@@ -44,8 +44,8 @@ module Squib
       return new_cc.target
     end
 
-    def write_png(surface, i, dir, prefix, count_format)
-      surface.write_to_png("#{dir}/#{prefix}#{count_format % i}.png")
+    def write_png(surface, i, b)
+      surface.write_to_png("#{b.dir}/#{b.prefix}#{b.count_format % i}#{b.suffix}.png")
     end
 
   end