squib 0.15.1 → 0.16.0

data/lib/squib/deck.rb

@@ -1,116 +1,138 @@
-require 'forwardable'
-require 'pp'
-require_relative '../squib'
-require_relative 'args/unit_conversion'
-require_relative 'card'
-require_relative 'conf'
-require_relative 'constants'
-require_relative 'graphics/hand'
-require_relative 'graphics/showcase'
-require_relative 'layout_parser'
-require_relative 'progress'
-
-
-# The project module
-#
-# @api public
-module Squib
-
-  # The main interface to Squib. Provides a front-end porcelain whereas the Card class interacts with the graphics plumbing.
-  #
-  # @api public
-  class Deck
-    include Enumerable
-    extend Forwardable
-
-    # Attributes for the width, height (in pixels) and number of cards
-    # These are expected to be immuatble for the life of Deck
-    # @api private
-    attr_reader :width, :height, :cards, :progress_bar
-
-    # Delegate these configuration options to the Squib::Conf object
-    def_delegators :conf, :antialias, :backend, :count_format, :custom_colors, :dir,
-                          :img_dir, :prefix, :text_hint, :typographer
-    # :nodoc:
-    # @api private
-    attr_reader :layout, :conf, :dpi, :font
-
-    #
-    # deck.size is really just @cards.size
-    def_delegators :cards, :size
-
-    # Squib's constructor that sets the immutable properties.
-    #
-    # This is the starting point for Squib. In providing a block to the constructor, you have access to all of Deck's instance methods.
-    # The documented methods in Deck are the ones intended for use by most users.
-    # If your game requires multiple different sizes or orientations, I recommend using multiple `Squib::Deck`s in your `deck.rb`. You can modify the internals of `Squib::Deck` (e.g. `@cards`), but that's not recommended.
-    # @example
-    #   require 'squib'
-    #   Squib::Deck.new do
-    #     text str: 'Hello, World!"
-    #   end
-    #
-    # @param width [Integer] the width of each card in pixels. Supports unit conversion (e.g. '2.5in').
-    # @param height [Integer] the height of each card in pixels. Supports unit conversion (e.g. '3.5in').
-    # @param cards [Integer] the number of cards in the deck
-    # @param dpi [Integer] the pixels per inch when rendering out to PDF or calculating using inches.
-    # @param config [String] the file used for global settings of this deck
-    # @param layout [String, Array] load a YML file of custom layouts. Multiple files are merged sequentially, redefining collisons. See README and sample for details.
-    # @param block [Block] the main body of the script.
-    # @api public
-    def initialize(width: 825, height: 1125, cards: 1, dpi: 300, config: 'config.yml', layout: nil, &block)
-      @dpi           = dpi
-      @font          = DEFAULT_FONT
-      @cards         = []
-      @conf          = Conf.load(config)
-      @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
-      cards.times{ |i| @cards << Squib::Card.new(self, @width, @height, i) }
-      @layout = LayoutParser.new(dpi).load_layout(layout)
-      enable_groups_from_env!
-      if block_given?
-        instance_eval(&block) # here we go. wheeeee!
-      end
-      @cards.each { |c| c.finish! }
-    end
-
-    # Directly accesses the array of cards in the deck
-    #
-    # @api private
-    def [](key)
-      @cards[key]
-    end
-
-    # Iterates over each card in the deck
-    #
-    # @api private
-    def each(&block)
-      @cards.each { |card| block.call(card) }
-    end
-
-    # Use Logger to show more detail on the run
-    # :nodoc:
-    # @api private
-    def show_info(config, layout)
-      Squib::logger.info "Squib v#{Squib::VERSION}"
-      Squib::logger.info "  building #{@cards.size} #{@width}x#{@height} cards"
-      Squib::logger.info "  using #{@backend}"
-    end
-
-    ##################
-    ### 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'
-
-  end
-end
+require 'forwardable'
+require 'pp'
+require_relative '../squib'
+require_relative 'args/unit_conversion'
+require_relative 'card'
+require_relative 'conf'
+require_relative 'constants'
+require_relative 'graphics/hand'
+require_relative 'graphics/showcase'
+require_relative 'layout_parser'
+require_relative 'progress'
+
+
+# The project module
+#
+# @api public
+module Squib
+
+  # The main interface to Squib. Provides a front-end porcelain whereas the Card class interacts with the graphics plumbing.
+  #
+  # @api public
+  class Deck
+    include Enumerable
+    extend Forwardable
+
+    # Attributes for the width, height (in pixels) and number of cards
+    # These are expected to be immuatble for the life of Deck
+    # @api private
+    attr_reader :width, :height, :cards, :progress_bar
+
+    # Delegate these configuration options to the Squib::Conf object
+    def_delegators :conf, :antialias, :backend, :count_format, :custom_colors, :dir,
+                          :img_dir, :prefix, :text_hint, :typographer
+    # :nodoc:
+    # @api private
+    attr_reader :layout, :conf, :dpi, :font, :cell_px
+
+    #
+    # deck.size is really just @cards.size
+    def_delegators :cards, :size
+
+    # Squib's constructor that sets the immutable properties.
+    #
+    # This is the starting point for Squib. In providing a block to the constructor, you have access to all of Deck's instance methods.
+    # The documented methods in Deck are the ones intended for use by most users.
+    # If your game requires multiple different sizes or orientations, I recommend using multiple `Squib::Deck`s in your `deck.rb`. You can modify the internals of `Squib::Deck` (e.g. `@cards`), but that's not recommended.
+    # @example
+    #   require 'squib'
+    #   Squib::Deck.new do
+    #     text str: 'Hello, World!"
+    #   end
+    #
+    # @param width [Integer] the width of each card in pixels. Supports unit conversion (e.g. '2.5in').
+    # @param height [Integer] the height of each card in pixels. Supports unit conversion (e.g. '3.5in').
+    # @param cards [Integer] the number of cards in the deck
+    # @param dpi [Integer] the pixels per inch when rendering out to PDF or calculating using inches.
+    # @param config [String] the file used for global settings of this deck
+    # @param layout [String, Array] load a YML file of custom layouts. Multiple files are merged sequentially, redefining collisons. See README and sample for details.
+    # @param block [Block] the main body of the script.
+    # @api public
+    def initialize(width: 825, height: 1125, cards: 1, dpi: 300, config: 'config.yml', layout: nil, &block)
+      @dpi           = dpi
+      @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, @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, @cell_px).load_layout(layout)
+      enable_groups_from_env!
+      if block_given?
+        instance_eval(&block) # here we go. wheeeee!
+      end
+      @cards.each { |c| c.finish! }
+    end
+
+    # Directly accesses the array of cards in the deck
+    #
+    # @api private
+    def [](key)
+      @cards[key]
+    end
+
+    # Iterates over each card in the deck
+    #
+    # @api private
+    def each(&block)
+      @cards.each { |card| block.call(card) }
+    end
+
+    # Use Logger to show more detail on the run
+    # :nodoc:
+    # @api private
+    def show_info(config, layout)
+      Squib::logger.info "Squib v#{Squib::VERSION}"
+      Squib::logger.info "  building #{@cards.size} #{@width}x#{@height} cards"
+      Squib::logger.info "  using #{@backend}"
+    end
+
+    ##################
+    ### PUBLIC API ###
+    ##################
+    require_relative 'api/settings'
+
+    ###################
+    ### 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