fiber_pattern 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0ed0351785dcc4a977f481938aecf3b3d787b91752558bc307cf2b72ad962e8
-  data.tar.gz: c16dbb1de69fa26de99bc7dc12504db55c1707bf5a9e7388973fdf1954998e18
+  metadata.gz: eb09b823e0e912ede8fcc93a8981b2321ef65494e5ffe74a49153e5b3c947337
+  data.tar.gz: 9f0057c277cc499d97c3b011c1b42c8de0dc5e76bfa04c64759911556e2b7057
 SHA512:
-  metadata.gz: d9fc5ede7f7838208da2e8382414bebf621af83d557df70d5222531b8087b389dda3d213608149d4f478c146ef803b676c93925d4c0749e2cd889bd71132ba3e
-  data.tar.gz: '0090202feec59f5190da9296132831e0ffaa12389cf0fed5a66c4222662c5700aec07a42ef2b0b1fa0c748261a801eccf6bc63baf8130be985f7b98a4d882699'
+  metadata.gz: 5b5b8772fcd851ceade728e70d3f404941fa857bf69b1c0a4cd0632d38864d1da9eef8e3186c2c24166ff40efe37ab3495e3e63b49c80f85e7eca715566465bd
+  data.tar.gz: e24b3c78870091cbc1e533e873725d8f5a671aecdf10cea1e26da83205b58ad2da27d3170f9231bfe6b0e8f8ea77a703904279577d884bf79d026879233b54b7

data/lib/fiber_pattern/piece.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module FiberPattern
+  # A value object representing a single garment piece with stitch/row counts
+  # and a gauge for deriving physical measurements.
+  #
+  # @example
+  #   piece = FiberPattern::Piece.new(
+  #     name: :front,
+  #     cast_on: 90.stitches,
+  #     bind_off: 70.stitches,
+  #     rows: 120.rows,
+  #     gauge: gauge
+  #   )
+  #   piece.bottom_width  # => FiberUnits::Length in inches
+  #   piece.shape          # => :trapezoid
+  class Piece
+    # @return [Symbol] piece name (e.g. :front, :back, :sleeve)
+    attr_reader :name
+
+    # @return [FiberUnits::StitchCount] cast-on stitch count (bottom edge)
+    attr_reader :cast_on
+
+    # @return [FiberUnits::StitchCount] bind-off stitch count (top edge)
+    attr_reader :bind_off
+
+    # @return [FiberUnits::RowCount] total rows
+    attr_reader :rows
+
+    # @return [FiberGauge::Gauge] gauge for measurement conversion
+    attr_reader :gauge
+
+    # @return [FiberPattern::Shaping, nil] optional shaping schedule
+    attr_reader :shaping
+
+    # @param name [Symbol] piece identifier
+    # @param cast_on [FiberUnits::StitchCount] cast-on stitch count
+    # @param bind_off [FiberUnits::StitchCount] bind-off stitch count
+    # @param rows [FiberUnits::RowCount] total row count
+    # @param gauge [FiberGauge::Gauge] gauge for converting stitches/rows to measurements
+    # @param shaping [FiberPattern::Shaping, nil] optional shaping data
+    def initialize(name:, cast_on:, bind_off:, rows:, gauge:, shaping: nil)
+      @name = name
+      @cast_on = cast_on
+      @bind_off = bind_off
+      @rows = rows
+      @gauge = gauge
+      @shaping = shaping
+    end
+
+    # Physical width at the bottom (cast-on) edge.
+    #
+    # @return [FiberUnits::Length]
+    def bottom_width
+      gauge.width_for_stitches(cast_on)
+    end
+
+    # Physical width at the top (bind-off) edge.
+    #
+    # @return [FiberUnits::Length]
+    def top_width
+      gauge.width_for_stitches(bind_off)
+    end
+
+    # Physical height of the piece.
+    #
+    # @return [FiberUnits::Length]
+    def height
+      (rows.value.to_f / gauge.rpi).inches
+    end
+
+    # Whether this piece is a rectangle or trapezoid based on edge widths.
+    #
+    # @return [Symbol] :rectangle or :trapezoid
+    def shape
+      (cast_on.value == bind_off.value) ? :rectangle : :trapezoid
+    end
+  end
+end

data/lib/fiber_pattern/schematic.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module FiberPattern
+  # Composes named garment pieces and renders them as a schematic.
+  #
+  # @example
+  #   schematic = FiberPattern::Schematic.new
+  #   schematic.add_piece(:front,
+  #     cast_on: 90.stitches, bind_off: 70.stitches,
+  #     rows: 120.rows, gauge: gauge
+  #   )
+  #   schematic.render(:svg)  # => SVG string
+  class Schematic
+    # @return [Hash{Symbol => FiberPattern::Piece}] named pieces
+    attr_reader :pieces
+
+    def initialize
+      @pieces = {}
+    end
+
+    # Adds a piece to the schematic.
+    #
+    # @param name [Symbol] piece identifier (e.g. :front, :back, :sleeve)
+    # @param cast_on [FiberUnits::StitchCount] cast-on stitch count
+    # @param bind_off [FiberUnits::StitchCount] bind-off stitch count
+    # @param rows [FiberUnits::RowCount] total row count
+    # @param gauge [FiberGauge::Gauge] gauge for measurement conversion
+    # @param shaping [FiberPattern::Shaping, nil] optional shaping data
+    # @return [FiberPattern::Piece]
+    def add_piece(name, cast_on:, bind_off:, rows:, gauge:, shaping: nil)
+      @pieces[name] = Piece.new(
+        name: name,
+        cast_on: cast_on,
+        bind_off: bind_off,
+        rows: rows,
+        gauge: gauge,
+        shaping: shaping
+      )
+    end
+
+    # Fetches a piece by name.
+    #
+    # @param name [Symbol] piece identifier
+    # @return [FiberPattern::Piece]
+    # @raise [KeyError] if the piece is not found
+    def piece(name)
+      @pieces.fetch(name)
+    end
+
+    # Renders the schematic in the given format.
+    #
+    # @param format [Symbol] output format (:svg)
+    # @return [String] rendered output
+    def render(format = :svg)
+      case format
+      when :svg
+        SvgRenderer.new(self).render
+      else
+        raise ArgumentError, "unsupported format: #{format.inspect}"
+      end
+    end
+  end
+end

data/lib/fiber_pattern/sizing.rb

@@ -9,11 +9,16 @@ module FiberPattern
     # @return [FiberPattern::Repeat, nil] optional stitch repeat to round stitch counts to
     attr_reader :repeat
 
+    # @return [FiberPattern::StitchPattern, nil] optional stitch pattern for width adjustment
+    attr_reader :stitch_pattern
+
     # @param gauge [Object] gauge object used to derive stitch counts
     # @param repeat [FiberPattern::Repeat, nil] optional stitch repeat to round stitch counts to
-    def initialize(gauge:, repeat: nil)
+    # @param stitch_pattern [FiberPattern::StitchPattern, nil] optional stitch pattern for width adjustment
+    def initialize(gauge:, repeat: nil, stitch_pattern: nil)
       @gauge = gauge
       @repeat = repeat
+      @stitch_pattern = stitch_pattern
     end
 
     # Calculates the number of stitches required to reach a given width, based on the provided gauge.
@@ -21,7 +26,8 @@ module FiberPattern
     # @param width [Object] desired finished width in units accepted by the gauge
     # @return [Integer] number of stitches required to reach the requested width
     def cast_on_for(width)
-      stitches = gauge.required_stitches(width)
+      adjusted_width = stitch_pattern ? stitch_pattern.adjust_width(width) : width
+      stitches = gauge.required_stitches(adjusted_width)
 
       return stitches unless repeat
 

data/lib/fiber_pattern/stitch_pattern.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module FiberPattern
+  # Models how a stitch pattern affects fabric dimensions and yarn consumption
+  # relative to stockinette. Cables compress width and consume more yarn;
+  # lace opens up fabric and uses less yarn per area.
+  class StitchPattern
+    # @return [String] human-readable name of the stitch pattern
+    attr_reader :name
+
+    # @return [FiberPattern::Repeat, nil] optional stitch repeat for this pattern
+    attr_reader :repeat
+
+    # @return [Float] multiplier vs stockinette for fabric width (< 1 = pulls in)
+    attr_reader :width_factor
+
+    # @return [Float] multiplier vs stockinette for yarn consumption (> 1 = uses more)
+    attr_reader :yarn_factor
+
+    # @param name [String] human-readable name of the stitch pattern
+    # @param repeat [FiberPattern::Repeat, nil] optional stitch repeat
+    # @param width_factor [Float] width multiplier vs stockinette (default: 1.0)
+    # @param yarn_factor [Float] yarn consumption multiplier vs stockinette (default: 1.0)
+    def initialize(name:, repeat: nil, width_factor: 1.0, yarn_factor: 1.0)
+      @name = name.freeze
+      @repeat = repeat
+      @width_factor = width_factor.to_f
+      @yarn_factor = yarn_factor.to_f
+      validate!
+    end
+
+    # Returns the stockinette-equivalent width needed to achieve the desired
+    # finished width in this stitch pattern.
+    #
+    # @param width [FiberUnits::Length] desired finished width
+    # @return [FiberUnits::Length] stockinette-equivalent width to knit
+    def adjust_width(width)
+      (width.value / width_factor).round(2).public_send(width.unit)
+    end
+
+    # Adjusts a base yardage estimate to account for this pattern's yarn consumption.
+    #
+    # @param yardage [FiberUnits::Length] base yardage assuming stockinette
+    # @return [FiberUnits::Length] adjusted yardage for this stitch pattern
+    def adjust_yardage(yardage)
+      (yardage.value * yarn_factor).round(2).public_send(yardage.unit)
+    end
+
+    # Preset definitions for common stitch patterns.
+
+    def self.stockinette
+      new(name: "Stockinette", width_factor: 1.0, yarn_factor: 1.0)
+    end
+
+    def self.garter
+      new(name: "Garter", width_factor: 1.0, yarn_factor: 1.05)
+    end
+
+    def self.rib_1x1
+      new(
+        name: "1x1 Rib",
+        repeat: Repeat.new(multiple: 2.stitches),
+        width_factor: 0.90,
+        yarn_factor: 1.10
+      )
+    end
+
+    def self.rib_2x2
+      new(
+        name: "2x2 Rib",
+        repeat: Repeat.new(multiple: 4.stitches),
+        width_factor: 0.85,
+        yarn_factor: 1.12
+      )
+    end
+
+    def self.seed
+      new(
+        name: "Seed Stitch",
+        repeat: Repeat.new(multiple: 2.stitches),
+        width_factor: 0.95,
+        yarn_factor: 1.05
+      )
+    end
+
+    # Crochet preset definitions.
+
+    def self.single_crochet
+      new(name: "Single Crochet", width_factor: 1.0, yarn_factor: 1.0)
+    end
+
+    def self.half_double_crochet
+      new(name: "Half Double Crochet", width_factor: 1.05, yarn_factor: 1.15)
+    end
+
+    def self.double_crochet
+      new(name: "Double Crochet", width_factor: 1.10, yarn_factor: 1.25)
+    end
+
+    def self.treble_crochet
+      new(name: "Treble Crochet", width_factor: 1.15, yarn_factor: 1.35)
+    end
+
+    def self.moss_stitch
+      new(
+        name: "Moss Stitch",
+        repeat: Repeat.new(multiple: 2.stitches),
+        width_factor: 1.05,
+        yarn_factor: 1.10
+      )
+    end
+
+    def self.shell_stitch
+      new(
+        name: "Shell Stitch",
+        repeat: Repeat.new(multiple: 6.stitches, offset: 1.stitches),
+        width_factor: 1.15,
+        yarn_factor: 1.30
+      )
+    end
+
+    def self.v_stitch
+      new(
+        name: "V-Stitch",
+        repeat: Repeat.new(multiple: 2.stitches),
+        width_factor: 1.10,
+        yarn_factor: 0.90
+      )
+    end
+
+    private
+
+    def validate!
+      raise ArgumentError, "name must be a non-empty string" if name.nil? || name.empty?
+      raise ArgumentError, "width_factor must be positive" unless width_factor.positive?
+      raise ArgumentError, "yarn_factor must be positive" unless yarn_factor.positive?
+    end
+  end
+end

data/lib/fiber_pattern/svg_renderer.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+module FiberPattern
+  # Renders a Schematic as an SVG string with piece outlines, dimension lines,
+  # measurement labels, and shaping markers.
+  class SvgRenderer
+    PADDING = 40
+    PIECE_SPACING = 60
+    DEFAULT_SCALE = 10
+    LABEL_OFFSET = 25
+    FONT_SIZE = 12
+    MARKER_RADIUS = 3
+
+    # @param schematic [FiberPattern::Schematic] schematic to render
+    # @param scale [Numeric] pixels per inch (default 10)
+    def initialize(schematic, scale: DEFAULT_SCALE)
+      @schematic = schematic
+      @scale = scale
+    end
+
+    # @return [String] complete SVG document
+    def render
+      pieces = @schematic.pieces.values
+      return empty_svg if pieces.empty?
+
+      layouts = compute_layouts(pieces)
+      total_width = layouts.last[:x] + layouts.last[:w] + PADDING + LABEL_OFFSET + FONT_SIZE * 3
+      total_height = layouts.map { |l| l[:h] }.max + (PADDING + LABEL_OFFSET + FONT_SIZE) * 2
+
+      parts = [svg_header(total_width, total_height)]
+      layouts.each do |layout|
+        parts << render_piece(layout[:piece], layout[:x], PADDING + LABEL_OFFSET + FONT_SIZE)
+      end
+      parts << svg_footer
+
+      parts.join("\n")
+    end
+
+    private
+
+    def compute_layouts(pieces)
+      layouts = []
+      x = PADDING
+
+      pieces.each do |piece|
+        w = (piece.bottom_width.to(:inches).value * @scale).round
+        top_w = (piece.top_width.to(:inches).value * @scale).round
+        w = [w, top_w].max
+        h = (piece.height.to(:inches).value * @scale).round
+
+        layouts << {piece: piece, x: x, w: w, h: h}
+        x += w + PIECE_SPACING
+      end
+
+      layouts
+    end
+
+    def render_piece(piece, x_offset, y_offset)
+      bottom_w = (piece.bottom_width.to(:inches).value * @scale).round
+      top_w = (piece.top_width.to(:inches).value * @scale).round
+      h = (piece.height.to(:inches).value * @scale).round
+      max_w = [bottom_w, top_w].max
+
+      parts = []
+      parts << %(<g data-piece="#{escape_xml(piece.name.to_s)}">)
+      parts << render_outline(piece, x_offset, y_offset, max_w, bottom_w, top_w, h)
+      parts << render_label(piece, x_offset, y_offset, max_w, h)
+      parts << render_dimension_lines(piece, x_offset, y_offset, max_w, bottom_w, top_w, h)
+      parts << render_shaping_markers(piece, x_offset, y_offset, max_w, bottom_w, top_w, h) if piece.shaping
+      parts << "</g>"
+
+      parts.join("\n")
+    end
+
+    def render_outline(piece, x, y, max_w, bottom_w, top_w, h)
+      if piece.shape == :rectangle
+        %(<rect x="#{x}" y="#{y}" width="#{bottom_w}" height="#{h}" ) +
+          %(fill="none" stroke="#333" stroke-width="2"/>)
+      else
+        bottom_offset = (max_w - bottom_w) / 2
+        top_offset = (max_w - top_w) / 2
+
+        x1 = x + bottom_offset
+        x2 = x + bottom_offset + bottom_w
+        x3 = x + top_offset + top_w
+        x4 = x + top_offset
+
+        %(<polygon points="#{x1},#{y + h} #{x2},#{y + h} #{x3},#{y} #{x4},#{y}" ) +
+          %(fill="none" stroke="#333" stroke-width="2"/>)
+      end
+    end
+
+    def render_label(piece, x, y, max_w, h)
+      cx = x + max_w / 2
+      cy = y + h / 2
+
+      %(<text x="#{cx}" y="#{cy}" text-anchor="middle" dominant-baseline="middle" ) +
+        %(font-family="sans-serif" font-size="#{FONT_SIZE + 2}" fill="#666">) +
+        %(#{escape_xml(piece.name.to_s)}</text>)
+    end
+
+    def render_dimension_lines(piece, x, y, max_w, bottom_w, top_w, h)
+      parts = []
+
+      # Bottom width dimension (below the piece)
+      bottom_offset = (max_w - bottom_w) / 2
+      dim_y = y + h + LABEL_OFFSET
+      bx1 = x + bottom_offset
+      bx2 = x + bottom_offset + bottom_w
+
+      parts << dimension_line(bx1, dim_y, bx2, dim_y,
+        format_measurement(piece.bottom_width))
+
+      # Top width dimension (above the piece)
+      if piece.shape == :trapezoid
+        top_offset = (max_w - top_w) / 2
+        dim_y_top = y - LABEL_OFFSET
+        tx1 = x + top_offset
+        tx2 = x + top_offset + top_w
+
+        parts << dimension_line(tx1, dim_y_top, tx2, dim_y_top,
+          format_measurement(piece.top_width))
+      end
+
+      # Height dimension (right side)
+      dim_x = x + max_w + LABEL_OFFSET
+      parts << dimension_line(dim_x, y, dim_x, y + h,
+        format_measurement(piece.height))
+
+      parts.join("\n")
+    end
+
+    def render_shaping_markers(piece, x, y, max_w, bottom_w, top_w, h)
+      return "" unless piece.shaping
+
+      total_rows = piece.rows.value
+      parts = []
+
+      piece.shaping.schedule.each do |event|
+        row = event[:row]
+        ratio = row.to_f / total_rows
+        marker_y = y + h - (ratio * h).round
+
+        # Width at this row (linear interpolation)
+        width_at_row = bottom_w + (top_w - bottom_w) * ratio
+        bottom_offset = (max_w - bottom_w) / 2
+        top_offset = (max_w - top_w) / 2
+        left_x = x + bottom_offset + (top_offset - bottom_offset) * ratio
+        right_x = left_x + width_at_row
+
+        parts << %(<circle cx="#{left_x.round}" cy="#{marker_y}" r="#{MARKER_RADIUS}" fill="#e74c3c"/>)
+        parts << %(<circle cx="#{right_x.round}" cy="#{marker_y}" r="#{MARKER_RADIUS}" fill="#e74c3c"/>)
+      end
+
+      parts.join("\n")
+    end
+
+    def dimension_line(x1, y1, x2, y2, label)
+      # Determine if horizontal or vertical
+      horizontal = y1 == y2
+      mid_x = (x1 + x2) / 2
+      mid_y = (y1 + y2) / 2
+
+      tick_size = 5
+      parts = []
+
+      # Main line
+      parts << %(<line x1="#{x1}" y1="#{y1}" x2="#{x2}" y2="#{y2}" stroke="#999" stroke-width="1"/>)
+
+      if horizontal
+        # End ticks (vertical)
+        parts << %(<line x1="#{x1}" y1="#{y1 - tick_size}" x2="#{x1}" y2="#{y1 + tick_size}" stroke="#999" stroke-width="1"/>)
+        parts << %(<line x1="#{x2}" y1="#{y2 - tick_size}" x2="#{x2}" y2="#{y2 + tick_size}" stroke="#999" stroke-width="1"/>)
+        # Label
+        parts << %(<text x="#{mid_x}" y="#{mid_y - 6}" text-anchor="middle" ) +
+          %(font-family="sans-serif" font-size="#{FONT_SIZE}" fill="#333">#{label}</text>)
+      else
+        # End ticks (horizontal)
+        parts << %(<line x1="#{x1 - tick_size}" y1="#{y1}" x2="#{x1 + tick_size}" y2="#{y1}" stroke="#999" stroke-width="1"/>)
+        parts << %(<line x1="#{x2 - tick_size}" y1="#{y2}" x2="#{x2 + tick_size}" y2="#{y2}" stroke="#999" stroke-width="1"/>)
+        # Label (rotated)
+        parts << %(<text x="#{mid_x + FONT_SIZE}" y="#{mid_y}" text-anchor="middle" ) +
+          %(font-family="sans-serif" font-size="#{FONT_SIZE}" fill="#333">#{label}</text>)
+      end
+
+      parts.join("\n")
+    end
+
+    def format_measurement(length)
+      value = length.to(:inches).value
+      "#{value.round(1)}&quot;"
+    end
+
+    def escape_xml(str)
+      str.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;").gsub('"', "&quot;")
+    end
+
+    def svg_header(width, height)
+      %(<svg xmlns="http://www.w3.org/2000/svg" width="#{width}" height="#{height}" ) +
+        %(viewBox="0 0 #{width} #{height}">)
+    end
+
+    def svg_footer
+      "</svg>"
+    end
+
+    def empty_svg
+      svg_header(0, 0) + "\n" + svg_footer
+    end
+  end
+end

data/lib/fiber_pattern/version.rb

@@ -3,6 +3,6 @@
 # :nocov:
 module FiberPattern
   # Current gem version.
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end
 # :nocov:

data/lib/fiber_pattern.rb

@@ -5,8 +5,12 @@ require "fiber_gauge"
 require_relative "fiber_pattern/version"
 require_relative "fiber_pattern/sizing"
 require_relative "fiber_pattern/repeat"
+require_relative "fiber_pattern/stitch_pattern"
 require_relative "fiber_pattern/scaling"
+require_relative "fiber_pattern/piece"
+require_relative "fiber_pattern/schematic"
 require_relative "fiber_pattern/shaping"
+require_relative "fiber_pattern/svg_renderer"
 require_relative "fiber_pattern/grade_rules"
 require_relative "fiber_pattern/grader"
 require_relative "fiber_pattern/body_measurements"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fiber_pattern
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Meagan Waller
@@ -81,11 +81,15 @@ files:
 - lib/fiber_pattern/garment_sizing.rb
 - lib/fiber_pattern/grade_rules.rb
 - lib/fiber_pattern/grader.rb
+- lib/fiber_pattern/piece.rb
 - lib/fiber_pattern/repeat.rb
 - lib/fiber_pattern/scaling.rb
+- lib/fiber_pattern/schematic.rb
 - lib/fiber_pattern/shaping.rb
 - lib/fiber_pattern/size_chart.rb
 - lib/fiber_pattern/sizing.rb
+- lib/fiber_pattern/stitch_pattern.rb
+- lib/fiber_pattern/svg_renderer.rb
 - lib/fiber_pattern/version.rb
 - sig/fiber_pattern.rbs
 homepage: https://github.com/meaganewaller/craftos/tree/main/gems/fiber_pattern