fiber_pattern 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0ed0351785dcc4a977f481938aecf3b3d787b91752558bc307cf2b72ad962e8
-  data.tar.gz: c16dbb1de69fa26de99bc7dc12504db55c1707bf5a9e7388973fdf1954998e18
+  metadata.gz: 86098b154ca5d374ea82112b74c4bcfde885d6da22aa071c4c0f8b87fc2c89bd
+  data.tar.gz: 6744cff995e936ff00774ffa69e1829c1992cfe5901d491ba233fcd5e734d5fe
 SHA512:
-  metadata.gz: d9fc5ede7f7838208da2e8382414bebf621af83d557df70d5222531b8087b389dda3d213608149d4f478c146ef803b676c93925d4c0749e2cd889bd71132ba3e
-  data.tar.gz: '0090202feec59f5190da9296132831e0ffaa12389cf0fed5a66c4222662c5700aec07a42ef2b0b1fa0c748261a801eccf6bc63baf8130be985f7b98a4d882699'
+  metadata.gz: c9daa9034c4a2a6b5d46c3e09a999a78c11245424163ac792194d8e9d575c95f7146d4e447de386c642ea51cc17b9a8b7477533a04ba7080fc0c09b4b5df3c49
+  data.tar.gz: a7595ab55c4c0fa5861a39af96d373958cc6f39359f1bb2feddfa3b94187e4de7cf81c403cb3b17ac92c0fcdf395a04526507c22a25c91d04c832b182f828c3d

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/version.rb

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

data/lib/fiber_pattern.rb

@@ -5,6 +5,7 @@ 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/shaping"
 require_relative "fiber_pattern/grade_rules"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fiber_pattern
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Meagan Waller
@@ -86,6 +86,7 @@ files:
 - 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/version.rb
 - sig/fiber_pattern.rbs
 homepage: https://github.com/meaganewaller/craftos/tree/main/gems/fiber_pattern