squib 0.15.1 → 0.16.0

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

@@ -1,27 +1,37 @@
-require_relative '../constants'
-
-module Squib
-  class Deck
-
-    # DSL method. See http://squib.readthedocs.io
-    def inches(n)
-      @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
-    end
-
-    # DSL method. See http://squib.readthedocs.io
-    def mm(n)
-      @dpi * Squib::INCHES_IN_CM * n.to_f / 10.0
-    end
-
-  end
-end
+require_relative '../constants'
+
+module Squib
+  class Deck
+
+    # DSL method. See http://squib.readthedocs.io
+    def inches(n)
+      @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
+    end
+
+    # DSL method. See http://squib.readthedocs.io
+    def mm(n)
+      @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/background.rb

@@ -1,14 +1,14 @@
-module Squib
-  class Card
-
-    # :nodoc:
-    # @api private
-    def background(color)
-      use_cairo do |cc|
-        cc.set_source_squibcolor(color)
-        cc.paint
-      end
-    end
-
-  end
-end
+module Squib
+  class Card
+
+    # :nodoc:
+    # @api private
+    def background(color)
+      use_cairo do |cc|
+        cc.set_source_squibcolor(color)
+        cc.paint
+      end
+    end
+
+  end
+end

data/lib/squib/graphics/cairo_context_wrapper.rb

@@ -1,113 +1,113 @@
-require 'forwardable'
-require_relative 'gradient_regex'
-
-module Squib
-  module Graphics
-    # Wrapper class for the Cairo context. Private.
-    # @api private
-    class CairoContextWrapper
-      extend Forwardable
-
-      # :nodoc:
-      # @api private
-      attr_accessor :cairo_cxt
-
-      # :nodoc:
-      # @api private
-      def initialize(cairo_cxt)
-        @cairo_cxt = cairo_cxt
-      end
-
-      def_delegators :cairo_cxt, :save, :set_source_color, :paint, :restore,
-        :translate, :rotate, :move_to, :update_pango_layout, :width, :height,
-        :show_pango_layout, :rectangle, :rounded_rectangle, :set_line_width, :stroke, :fill,
-        :set_source, :scale, :render_rsvg_handle, :circle, :triangle, :line_to,
-        :operator=, :show_page, :clip, :transform, :mask, :create_pango_layout,
-        :antialias=, :curve_to, :matrix, :matrix=, :identity_matrix, :pango_layout_path,
-        :stroke_preserve, :target, :new_path, :new_sub_path, :reset_clip, :fill_preserve, :close_path,
-        :set_line_join, :set_line_cap, :set_dash, :arc, :arc_negative
-
-      # :nodoc:
-      # @api private
-      def set_source_squibcolor(arg)
-        raise 'nil is not a valid color' if arg.nil?
-        if match = arg.match(LINEAR_GRADIENT)
-          x1, y1, x2, y2 = match.captures
-          linear = Cairo::LinearPattern.new(x1.to_f, y1.to_f, x2.to_f, y2.to_f)
-          arg.scan(STOPS).each do |color, offset|
-            linear.add_color_stop(offset.to_f, color)
-          end
-          linear.matrix = matrix # match the coordinate systems - see bug 127
-          @cairo_cxt.set_source(linear)
-        elsif match = arg.match(RADIAL_GRADIENT)
-          x1, y1, r1, x2, y2, r2 = match.captures
-          radial = Cairo::RadialPattern.new(x1.to_f, y1.to_f, r1.to_f,
-                                            x2.to_f, y2.to_f, r2.to_f)
-          radial.matrix = matrix # match the coordinate systems - see bug 127
-          arg.scan(STOPS).each do |color, offset|
-            radial.add_color_stop(offset.to_f, color)
-          end
-          @cairo_cxt.set_source(radial)
-        else
-          @cairo_cxt.set_source_color(arg)
-        end
-      end
-
-      # Convenience method for a common task
-      # @api private
-      def fill_n_stroke(draw)
-        return stroke_n_fill(draw) if draw.stroke_strategy == :stroke_first
-        set_source_squibcolor draw.fill_color
-        fill_preserve
-        set_source_squibcolor draw.stroke_color
-        set_line_width draw.stroke_width
-        set_line_join draw.join
-        set_line_cap draw.cap
-        set_dash draw.dash
-        stroke
-      end
-
-      def stroke_n_fill(draw)
-        return fill_n_stroke(draw) if draw.stroke_strategy == :fill_first
-        set_source_squibcolor draw.stroke_color
-        set_line_width draw.stroke_width
-        set_line_join draw.join
-        set_line_cap draw.cap
-        set_dash draw.dash
-        stroke_preserve
-        set_source_squibcolor draw.fill_color
-        fill
-      end
-
-      # Convenience method for a common task
-      # @api private
-      def fancy_stroke(draw)
-        set_source_squibcolor draw.stroke_color
-        set_line_width draw.stroke_width
-        set_line_join draw.join
-        set_line_cap draw.cap
-        set_dash draw.dash
-        stroke
-      end
-
-      def rotate_about(x, y, angle)
-        translate(x, y)
-        rotate(angle)
-        translate(-x, -y)
-      end
-
-      # Flip either vertical or horizontal depending
-      # From the cairo website: http://cairographics.org/matrix_transform/
-      # cairo.Matrix(fx, 0,         0,
-      #              fy, cx*(1-fx), cy*(fy-1))
-      # fx/fy = 1 means 'no flip', fx/fy = -1 are used for horizontal/vertical flip
-      def flip(vertical, horizontal, x, y)
-        v = vertical   ? -1.0 : 1.0
-        h = horizontal ? -1.0 : 1.0
-        transform Cairo::Matrix.new(v, 0.0,     0.0,
-                                    h, x * (1 - v), y * (1 - h))
-      end
-
-    end
-  end
-end
+require 'forwardable'
+require_relative 'gradient_regex'
+
+module Squib
+  module Graphics
+    # Wrapper class for the Cairo context. Private.
+    # @api private
+    class CairoContextWrapper
+      extend Forwardable
+
+      # :nodoc:
+      # @api private
+      attr_accessor :cairo_cxt
+
+      # :nodoc:
+      # @api private
+      def initialize(cairo_cxt)
+        @cairo_cxt = cairo_cxt
+      end
+
+      def_delegators :cairo_cxt, :save, :set_source_color, :paint, :restore,
+        :translate, :rotate, :move_to, :update_pango_layout, :width, :height,
+        :show_pango_layout, :rectangle, :rounded_rectangle, :set_line_width, :stroke, :fill,
+        :set_source, :scale, :render_rsvg_handle, :circle, :triangle, :line_to,
+        :operator=, :show_page, :clip, :transform, :mask, :create_pango_layout,
+        :antialias=, :curve_to, :matrix, :matrix=, :identity_matrix, :pango_layout_path,
+        :stroke_preserve, :target, :new_path, :new_sub_path, :reset_clip, :fill_preserve, :close_path,
+        :set_line_join, :set_line_cap, :set_dash, :arc, :arc_negative
+
+      # :nodoc:
+      # @api private
+      def set_source_squibcolor(arg)
+        raise 'nil is not a valid color' if arg.nil?
+        if match = arg.match(LINEAR_GRADIENT)
+          x1, y1, x2, y2 = match.captures
+          linear = Cairo::LinearPattern.new(x1.to_f, y1.to_f, x2.to_f, y2.to_f)
+          arg.scan(STOPS).each do |color, offset|
+            linear.add_color_stop(offset.to_f, color)
+          end
+          linear.matrix = matrix # match the coordinate systems - see bug 127
+          @cairo_cxt.set_source(linear)
+        elsif match = arg.match(RADIAL_GRADIENT)
+          x1, y1, r1, x2, y2, r2 = match.captures
+          radial = Cairo::RadialPattern.new(x1.to_f, y1.to_f, r1.to_f,
+                                            x2.to_f, y2.to_f, r2.to_f)
+          radial.matrix = matrix # match the coordinate systems - see bug 127
+          arg.scan(STOPS).each do |color, offset|
+            radial.add_color_stop(offset.to_f, color)
+          end
+          @cairo_cxt.set_source(radial)
+        else
+          @cairo_cxt.set_source_color(arg)
+        end
+      end
+
+      # Convenience method for a common task
+      # @api private
+      def fill_n_stroke(draw)
+        return stroke_n_fill(draw) if draw.stroke_strategy == :stroke_first
+        set_source_squibcolor draw.fill_color
+        fill_preserve
+        set_source_squibcolor draw.stroke_color
+        set_line_width draw.stroke_width
+        set_line_join draw.join
+        set_line_cap draw.cap
+        set_dash draw.dash
+        stroke
+      end
+
+      def stroke_n_fill(draw)
+        return fill_n_stroke(draw) if draw.stroke_strategy == :fill_first
+        set_source_squibcolor draw.stroke_color
+        set_line_width draw.stroke_width
+        set_line_join draw.join
+        set_line_cap draw.cap
+        set_dash draw.dash
+        stroke_preserve
+        set_source_squibcolor draw.fill_color
+        fill
+      end
+
+      # Convenience method for a common task
+      # @api private
+      def fancy_stroke(draw)
+        set_source_squibcolor draw.stroke_color
+        set_line_width draw.stroke_width
+        set_line_join draw.join
+        set_line_cap draw.cap
+        set_dash draw.dash
+        stroke
+      end
+
+      def rotate_about(x, y, angle)
+        translate(x, y)
+        rotate(angle)
+        translate(-x, -y)
+      end
+
+      # Flip either vertical or horizontal depending
+      # From the cairo website: http://cairographics.org/matrix_transform/
+      # cairo.Matrix(fx, 0,         0,
+      #              fy, cx*(1-fx), cy*(fy-1))
+      # fx/fy = 1 means 'no flip', fx/fy = -1 are used for horizontal/vertical flip
+      def flip(vertical, horizontal, x, y)
+        v = vertical   ? -1.0 : 1.0
+        h = horizontal ? -1.0 : 1.0
+        transform Cairo::Matrix.new(v, 0.0,     0.0,
+                                    h, x * (1 - v), y * (1 - h))
+      end
+
+    end
+  end
+end

data/lib/squib/graphics/embedding_utils.rb

@@ -1,28 +1,28 @@
-module Squib
-  class EmbeddingUtils
-
-    # Given a string and a bunch of keys, give us back a mapping of those keys
-    # to where those keys start, and where they end (in ranges)
-    #
-    # See the spec for expected outputs
-    def self.indices(str, keys)
-      map = {}
-      keys.each do |key|
-        map[key] ||= []
-        start = 0
-        while true
-          idx = str.index(key, start)
-          if idx.nil?
-            break; # done searching
-          else
-            idx_bytes = str[0..idx].bytesize - 1
-            map[key] << (idx_bytes..(idx_bytes + key.size))
-            start = idx + 1
-          end
-        end
-      end
-      return map
-    end
-
-  end
-end
+module Squib
+  class EmbeddingUtils
+
+    # Given a string and a bunch of keys, give us back a mapping of those keys
+    # to where those keys start, and where they end (in ranges)
+    #
+    # See the spec for expected outputs
+    def self.indices(str, keys)
+      map = {}
+      keys.each do |key|
+        map[key] ||= []
+        start = 0
+        while true
+          idx = str.index(key, start)
+          if idx.nil?
+            break; # done searching
+          else
+            idx_bytes = str[0..idx].bytesize - 1
+            map[key] << (idx_bytes..(idx_bytes + key.size))
+            start = idx + 1
+          end
+        end
+      end
+      return map
+    end
+
+  end
+end