squib 0.18.0 → 0.19.0a

data/lib/squib/layout_parser.rb

@@ -1,155 +1,155 @@
-require 'yaml'
-require_relative 'args/xywh_shorthands'
-
-module Squib
-  # Internal class for handling layouts
-  # @api private
-  class LayoutParser
-    include Args::XYWHShorthands
-
-    def initialize(dpi = 300, cell_px = 37.5)
-      @dpi = dpi
-      @cell_px = cell_px
-    end
-
-    # Load the layout file(s), if exists
-    # @api private
-    def load_layout(files, initial = {})
-      layout = initial
-      Squib::logger.info { "  using layout(s): #{files}" }
-      Array(files).each do |file|
-        thefile = file
-        thefile = builtin(file) unless File.exists?(file)
-        if File.exists? thefile
-          # note: YAML.load_file returns false on empty file
-          yml = layout.merge(YAML.load_file(thefile) || {})
-          yml.each do |key, value|
-            layout[key] = recurse_extends(yml, key, {})
-          end
-        else
-          Squib::logger.error { "Layout file not found: #{file}. Skipping..." }
-        end
-      end
-      return layout
-    end
-
-    private
-
-    # Determine the file path of the built-in layout file
-    def builtin(file)
-      "#{File.dirname(__FILE__)}/builtin/layouts/#{file}"
-    end
-
-    # Process the extends recursively
-    # :nodoc:
-    # @api private
-    def recurse_extends(yml, key, visited)
-      assert_not_visited(key, visited)
-      return yml[key] unless has_extends?(yml, key)
-      return yml[key] unless parents_exist?(yml, key)
-      visited[key] = key
-      parent_keys = [yml[key]['extends']].flatten
-      h = {}
-      parent_keys.each do |parent_key|
-        from_extends = yml[key].merge(recurse_extends(yml, parent_key, visited)) do |key, child_val, parent_val|
-          handle_relative_operators(parent_val, child_val)
-        end
-        h = h.merge(from_extends) do |key, older_sibling, younger_sibling|
-          # In general, go with the younger sibling.
-          # UNLESS that younger sibling had a relative operator, in which use the
-          # (already computed) relative operator applied, which lands in older_sibling
-          # See bug 244.
-          sibling = younger_sibling
-          %w(+= -= *= /=).each do |op|
-            sibling = older_sibling if younger_sibling.to_s.strip.start_with? op
-          end
-          sibling
-        end
-      end
-      return h
-    end
-
-    def handle_relative_operators(parent_val, child_val)
-      if uses_operator?(child_val) && !has_digits?(parent_val) && !has_digits?(child_val)
-        raise "Layout parse error: can't combine #{parent_val} and #{child_val}"
-      end
-      if child_val.to_s.strip.start_with?('+=')
-        add_parent_child(parent_val, child_val)
-      elsif child_val.to_s.strip.start_with?('-=')
-        sub_parent_child(parent_val, child_val)
-      elsif child_val.to_s.strip.start_with?('*=')
-        mul_parent_child(parent_val, child_val)
-      elsif child_val.to_s.strip.start_with?('/=')
-        div_parent_child(parent_val, child_val)
-      else
-        child_val # child overrides parent when merging, no +=
-      end
-    end
-
-    def add_parent_child(parent, child)
-      parent_pixels = Args::UnitConversion.parse(parent, @dpi, @cell_px).to_f
-      child_pixels = Args::UnitConversion.parse(child.sub('+=', ''), @dpi, @cell_px).to_f
-      parent_pixels + child_pixels
-    end
-
-    def sub_parent_child(parent, child)
-      parent_pixels = Args::UnitConversion.parse(parent, @dpi, @cell_px).to_f
-      child_pixels = Args::UnitConversion.parse(child.sub('-=', ''), @dpi, @cell_px).to_f
-      parent_pixels - child_pixels
-    end
-
-    def mul_parent_child(parent, child)
-      parent_pixels = Args::UnitConversion.parse(parent, @dpi, @cell_px).to_f
-      child_float = child.sub('*=', '').to_f
-      parent_pixels * child_float
-    end
-
-    def div_parent_child(parent, child)
-      parent_pixels = Args::UnitConversion.parse(parent, @dpi, @cell_px).to_f
-      child_float = child.sub('/=', '').to_f
-      parent_pixels / child_float
-    end
-
-    # For relative operators, it's difficult for us to handle
-    # some of the shorthands - so let's just freak out if you're trying to use
-    # relative operators with words, e.g. "middle += 0.5in"
-    def has_digits?(arg)
-      /.*\d.*/ === arg.to_s
-    end
-
-    def uses_operator?(arg)
-      /^[+=|\-=|\/=|*=].*/ === arg.to_s
-    end
-
-    # Does this layout entry have an extends field?
-    # i.e. is it a base-case or will it need recursion?
-    # :nodoc:
-    # @api private
-    def has_extends?(yml, key)
-      !!yml[key] && yml[key].key?('extends')
-    end
-
-    # Checks if we have any absentee parents
-    # @api private
-    def parents_exist?(yml, key)
-      exists = true
-      Array(yml[key]['extends']).each do |parent|
-        unless yml.key?(parent)
-          exists = false unless
-          Squib.logger.error "Processing layout: '#{key}' attempts to extend a missing '#{yml[key]['extends']}'"
-        end
-      end
-      return exists
-    end
-
-    # Safeguard against malformed circular extends
-    # :nodoc:
-    # @api private
-    def assert_not_visited(key, visited)
-      if visited.key? key
-        raise "Invalid layout: circular extends with '#{key}'"
-      end
-    end
-
-  end
-end
+require 'yaml'
+require_relative 'args/xywh_shorthands'
+
+module Squib
+  # Internal class for handling layouts
+  # @api private
+  class LayoutParser
+    include Args::XYWHShorthands
+
+    def initialize(dpi = 300, cell_px = 37.5)
+      @dpi = dpi
+      @cell_px = cell_px
+    end
+
+    # Load the layout file(s), if exists
+    # @api private
+    def load_layout(files, initial = {})
+      layout = initial
+      Squib::logger.info { "  using layout(s): #{files}" }
+      Array(files).each do |file|
+        thefile = file
+        thefile = builtin(file) unless File.exist?(file)
+        if File.exist? thefile
+          # note: YAML.load_file returns false on empty file
+          yml = layout.merge(YAML.load_file(thefile) || {})
+          yml.each do |key, value|
+            layout[key] = recurse_extends(yml, key, {})
+          end
+        else
+          Squib::logger.error { "Layout file not found: #{file}. Skipping..." }
+        end
+      end
+      return layout
+    end
+
+    private
+
+    # Determine the file path of the built-in layout file
+    def builtin(file)
+      "#{File.dirname(__FILE__)}/builtin/layouts/#{file}"
+    end
+
+    # Process the extends recursively
+    # :nodoc:
+    # @api private
+    def recurse_extends(yml, key, visited)
+      assert_not_visited(key, visited)
+      return yml[key] unless has_extends?(yml, key)
+      return yml[key] unless parents_exist?(yml, key)
+      visited[key] = key
+      parent_keys = [yml[key]['extends']].flatten
+      h = {}
+      parent_keys.each do |parent_key|
+        from_extends = yml[key].merge(recurse_extends(yml, parent_key, visited)) do |key, child_val, parent_val|
+          handle_relative_operators(parent_val, child_val)
+        end
+        h = h.merge(from_extends) do |key, older_sibling, younger_sibling|
+          # In general, go with the younger sibling.
+          # UNLESS that younger sibling had a relative operator, in which use the
+          # (already computed) relative operator applied, which lands in older_sibling
+          # See bug 244.
+          sibling = younger_sibling
+          %w(+= -= *= /=).each do |op|
+            sibling = older_sibling if younger_sibling.to_s.strip.start_with? op
+          end
+          sibling
+        end
+      end
+      return h
+    end
+
+    def handle_relative_operators(parent_val, child_val)
+      if uses_operator?(child_val) && !has_digits?(parent_val) && !has_digits?(child_val)
+        raise "Layout parse error: can't combine #{parent_val} and #{child_val}"
+      end
+      if child_val.to_s.strip.start_with?('+=')
+        add_parent_child(parent_val, child_val)
+      elsif child_val.to_s.strip.start_with?('-=')
+        sub_parent_child(parent_val, child_val)
+      elsif child_val.to_s.strip.start_with?('*=')
+        mul_parent_child(parent_val, child_val)
+      elsif child_val.to_s.strip.start_with?('/=')
+        div_parent_child(parent_val, child_val)
+      else
+        child_val # child overrides parent when merging, no +=
+      end
+    end
+
+    def add_parent_child(parent, child)
+      parent_pixels = Args::UnitConversion.parse(parent, @dpi, @cell_px).to_f
+      child_pixels = Args::UnitConversion.parse(child.sub('+=', ''), @dpi, @cell_px).to_f
+      parent_pixels + child_pixels
+    end
+
+    def sub_parent_child(parent, child)
+      parent_pixels = Args::UnitConversion.parse(parent, @dpi, @cell_px).to_f
+      child_pixels = Args::UnitConversion.parse(child.sub('-=', ''), @dpi, @cell_px).to_f
+      parent_pixels - child_pixels
+    end
+
+    def mul_parent_child(parent, child)
+      parent_pixels = Args::UnitConversion.parse(parent, @dpi, @cell_px).to_f
+      child_float = child.sub('*=', '').to_f
+      parent_pixels * child_float
+    end
+
+    def div_parent_child(parent, child)
+      parent_pixels = Args::UnitConversion.parse(parent, @dpi, @cell_px).to_f
+      child_float = child.sub('/=', '').to_f
+      parent_pixels / child_float
+    end
+
+    # For relative operators, it's difficult for us to handle
+    # some of the shorthands - so let's just freak out if you're trying to use
+    # relative operators with words, e.g. "middle += 0.5in"
+    def has_digits?(arg)
+      /.*\d.*/ === arg.to_s
+    end
+
+    def uses_operator?(arg)
+      /^[+=|\-=|\/=|*=].*/ === arg.to_s
+    end
+
+    # Does this layout entry have an extends field?
+    # i.e. is it a base-case or will it need recursion?
+    # :nodoc:
+    # @api private
+    def has_extends?(yml, key)
+      !!yml[key] && yml[key].key?('extends')
+    end
+
+    # Checks if we have any absentee parents
+    # @api private
+    def parents_exist?(yml, key)
+      exists = true
+      Array(yml[key]['extends']).each do |parent|
+        unless yml.key?(parent)
+          exists = false unless
+          Squib.logger.error "Processing layout: '#{key}' attempts to extend a missing '#{yml[key]['extends']}'"
+        end
+      end
+      return exists
+    end
+
+    # Safeguard against malformed circular extends
+    # :nodoc:
+    # @api private
+    def assert_not_visited(key, visited)
+      if visited.key? key
+        raise "Invalid layout: circular extends with '#{key}'"
+      end
+    end
+
+  end
+end

data/lib/squib/progress.rb

@@ -1,38 +1,38 @@
-require 'ruby-progressbar'
-
-module Squib
-
-  # :nodoc:
-  # @api private
-  class DoNothing
-    def increment
-    end
-
-    def finish
-    end
-  end
-
-  # A facade that handles (or doesn't) the progress bar on the console
-  #
-  # :nodoc:
-  # @api private
-  class Progress
-    attr_accessor :enabled
-
-    def initialize(enabled)
-      @enabled = enabled
-    end
-
-    def start(title='', total=100, &block)
-      if @enabled
-        @bar = ProgressBar.create(title: title, total: total, format: '%t <%B> %p%% %a')
-        yield(@bar)
-        @bar.finish
-      else
-        yield(Squib::DoNothing.new)
-      end
-    end
-  end
-
-
-end
+require 'ruby-progressbar'
+
+module Squib
+
+  # :nodoc:
+  # @api private
+  class DoNothing
+    def increment
+    end
+
+    def finish
+    end
+  end
+
+  # A facade that handles (or doesn't) the progress bar on the console
+  #
+  # :nodoc:
+  # @api private
+  class Progress
+    attr_accessor :enabled
+
+    def initialize(enabled)
+      @enabled = enabled
+    end
+
+    def start(title='', total=100, &block)
+      if @enabled
+        @bar = ProgressBar.create(title: title, total: total, format: '%t <%B> %p%% %a')
+        yield(@bar)
+        @bar.finish
+      else
+        yield(Squib::DoNothing.new)
+      end
+    end
+  end
+
+
+end

data/lib/squib/sample_helpers.rb

@@ -1,34 +1,34 @@
-module Squib
-
-  # Some helper methods specifically for samples
-  # @api private
-  #:nodoc:
-  class Deck
-
-    # Draw graph paper for samples
-    def draw_graph_paper(width, height)
-      background color: 'white'
-      grid width: 50,  height: 50,  stroke_color: '#659ae9', stroke_width: 1.5
-      grid width: 200, height: 200, stroke_color: '#659ae9', stroke_width: 3, x: 50, y: 50
-      (50..height).step(200) do |y|
-        text str: "y=#{y}", x: 3, y: y - 18, font: 'Open Sans, Sans 10'
-      end
-    end
-
-    # Define a set of samples on some graph paper
-    def sample(str)
-      @sample_x ||= 100
-      @sample_y ||= 100
-      rect x: 460, y: @sample_y - 40, width: 600,
-           height: 180, fill_color: '#FFD655', stroke_color: 'black', radius: 15
-      text str: str, x: 460, y: @sample_y - 40,
-           width: 540, height: 180,
-           valign: 'middle', align: 'center',
-           font: 'Times New Roman,Serif 8'
-      yield @sample_x, @sample_y
-      @sample_y += 200
-    end
-
-  end
-
-end
+module Squib
+
+  # Some helper methods specifically for samples
+  # @api private
+  #:nodoc:
+  class Deck
+
+    # Draw graph paper for samples
+    def draw_graph_paper(width, height)
+      background color: 'white'
+      grid width: 50,  height: 50,  stroke_color: '#659ae9', stroke_width: 1.5
+      grid width: 200, height: 200, stroke_color: '#659ae9', stroke_width: 3, x: 50, y: 50
+      (50..height).step(200) do |y|
+        text str: "y=#{y}", x: 3, y: y - 18, font: 'Open Sans, Sans 10'
+      end
+    end
+
+    # Define a set of samples on some graph paper
+    def sample(str)
+      @sample_x ||= 100
+      @sample_y ||= 100
+      rect x: 460, y: @sample_y - 40, width: 600,
+           height: 180, fill_color: '#FFD655', stroke_color: 'black', radius: 15
+      text str: str, x: 460, y: @sample_y - 40,
+           width: 540, height: 180,
+           valign: 'middle', align: 'center',
+           font: 'Times New Roman,Serif 8'
+      yield @sample_x, @sample_y
+      @sample_y += 200
+    end
+
+  end
+
+end

data/lib/squib/sprues/crop_line.rb

@@ -1,28 +1,28 @@
-module Squib
-  module Sprues
-    class CropLine
-      attr_reader :x1, :y1, :x2, :y2
-
-      def initialize(type, position, sheet_width, sheet_height, dpi, cell_px)
-        method = "parse_#{type}"
-        send method, position, sheet_width, sheet_height, dpi, cell_px
-      end
-
-      def parse_horizontal(position, sheet_width, _, dpi, cell_px)
-        position = Args::UnitConversion.parse(position, dpi, cell_px)
-        @x1 = 0
-        @y1 = position
-        @x2 = sheet_width
-        @y2 = position
-      end
-
-      def parse_vertical(position, _, sheet_height, dpi, cell_px)
-        position = Args::UnitConversion.parse(position, dpi, cell_px)
-        @x1 = position
-        @y1 = 0
-        @x2 = position
-        @y2 = sheet_height
-      end
-    end
-  end
-end
+module Squib
+  module Sprues
+    class CropLine
+      attr_reader :x1, :y1, :x2, :y2
+
+      def initialize(type, position, sheet_width, sheet_height, dpi, cell_px)
+        method = "parse_#{type}"
+        send method, position, sheet_width, sheet_height, dpi, cell_px
+      end
+
+      def parse_horizontal(position, sheet_width, _, dpi, cell_px)
+        position = Args::UnitConversion.parse(position, dpi, cell_px)
+        @x1 = 0
+        @y1 = position
+        @x2 = sheet_width
+        @y2 = position
+      end
+
+      def parse_vertical(position, _, sheet_height, dpi, cell_px)
+        position = Args::UnitConversion.parse(position, dpi, cell_px)
+        @x1 = position
+        @y1 = 0
+        @x2 = position
+        @y2 = sheet_height
+      end
+    end
+  end
+end

data/lib/squib/sprues/crop_line_dash.rb

@@ -1,35 +1,35 @@
-module Squib
-  module Sprues
-    class CropLineDash
-      VALIDATION_REGEX = /%r{
-        ^(\d*[.])?\d+(in|cm|mm)
-        \s+
-        (\d*[.])?\d+(in|cm|mm)$
-      }x/
-
-      attr_reader :pattern
-
-      def initialize(value, dpi, cell_px)
-        if value == :solid
-          @pattern = nil
-        elsif value == :dotted
-          @pattern = [
-            Args::UnitConversion.parse('0.2mm', dpi, cell_px),
-            Args::UnitConversion.parse('0.5mm', dpi, cell_px)
-          ]
-        elsif value == :dashed
-          @pattern = [
-            Args::UnitConversion.parse('2mm', dpi, cell_px),
-            Args::UnitConversion.parse('2mm', dpi, cell_px)
-          ]
-        elsif value.is_a? String
-          @pattern = value.split(' ').map do |val|
-            Args::UnitConversion.parse val, dpi, cell_px
-          end
-        else
-          raise ArgumentError, 'Unsupported dash style'
-        end
-      end
-    end
-  end
-end
+module Squib
+  module Sprues
+    class CropLineDash
+      VALIDATION_REGEX = /%r{
+        ^(\d*[.])?\d+(in|cm|mm)
+        \s+
+        (\d*[.])?\d+(in|cm|mm)$
+      }x/
+
+      attr_reader :pattern
+
+      def initialize(value, dpi, cell_px)
+        if value == :solid
+          @pattern = nil
+        elsif value == :dotted
+          @pattern = [
+            Args::UnitConversion.parse('0.2mm', dpi, cell_px),
+            Args::UnitConversion.parse('0.5mm', dpi, cell_px)
+          ]
+        elsif value == :dashed
+          @pattern = [
+            Args::UnitConversion.parse('2mm', dpi, cell_px),
+            Args::UnitConversion.parse('2mm', dpi, cell_px)
+          ]
+        elsif value.is_a? String
+          @pattern = value.split(' ').map do |val|
+            Args::UnitConversion.parse val, dpi, cell_px
+          end
+        else
+          raise ArgumentError, 'Unsupported dash style'
+        end
+      end
+    end
+  end
+end

data/lib/squib/sprues/invalid_sprue_definition.rb

@@ -1,9 +1,9 @@
-module Squib
-  module Sprues
-    class InvalidSprueDefinition < StandardError
-      def initialize(file, error)
-        super("Invalid sprue definition in file: #{file}. #{error.message}")
-      end
-    end
-  end
-end
+module Squib
+  module Sprues
+    class InvalidSprueDefinition < StandardError
+      def initialize(file, error)
+        super("Invalid sprue definition in file: #{file}. #{error.message}")
+      end
+    end
+  end
+end