fiber_pattern 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97a576e2a84dd27f7a1690c4bddbe30adfa4eea6bd323aa19dd3389a1e10e5cb
-  data.tar.gz: fa3d3634bab8fa1cdd9f64b2c2f9027d4afc1361a67a26284ed71df6ec8b353e
+  metadata.gz: 86098b154ca5d374ea82112b74c4bcfde885d6da22aa071c4c0f8b87fc2c89bd
+  data.tar.gz: 6744cff995e936ff00774ffa69e1829c1992cfe5901d491ba233fcd5e734d5fe
 SHA512:
-  metadata.gz: bfc2843e21944d714cfee9270802e629ab1d08e340f1bfb7a7b59f2e5f8bd30469369b6108ad61f3429cfc306150f7af463d53dd43665d572ed6025a33df7c3d
-  data.tar.gz: 6f065951604cbcf7612ea115b2aceeff0978f71b0620d61ddafe4e0013dfa2f400f9baa084e45d0da432c5ed999913f240e9c53f1c3a79c013537667f743f83a
+  metadata.gz: c9daa9034c4a2a6b5d46c3e09a999a78c11245424163ac792194d8e9d575c95f7146d4e447de386c642ea51cc17b9a8b7477533a04ba7080fc0c09b4b5df3c49
+  data.tar.gz: a7595ab55c4c0fa5861a39af96d373958cc6f39359f1bb2feddfa3b94187e4de7cf81c403cb3b17ac92c0fcdf395a04526507c22a25c91d04c832b182f828c3d

data/lib/fiber_pattern/body_measurements.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module FiberPattern
+  # Value object representing key body dimensions.
+  #
+  # Accepts any set of named measurements as keyword arguments.
+  # Each value should be a FiberUnits::Length.
+  #
+  # @example
+  #   body = FiberPattern::BodyMeasurements.new(
+  #     bust: 36.inches,
+  #     waist: 30.inches,
+  #     hip: 38.inches,
+  #     arm_length: 24.inches
+  #   )
+  #   body.bust       # => 36.inches
+  #   body[:waist]    # => 30.inches
+  #   body.measurements # => [:bust, :waist, :hip, :arm_length]
+  class BodyMeasurements
+    # @return [Hash<Symbol, FiberUnits::Length>] all measurements
+    attr_reader :data
+
+    # @param measurements [Hash<Symbol, FiberUnits::Length>] named body measurements
+    def initialize(**measurements)
+      raise ArgumentError, "at least one measurement is required" if measurements.empty?
+
+      @data = measurements.freeze
+      define_accessors!
+    end
+
+    # Returns the measurement names.
+    #
+    # @return [Array<Symbol>]
+    def measurements
+      data.keys
+    end
+
+    # Hash-style access to a measurement.
+    #
+    # @param name [Symbol]
+    # @return [FiberUnits::Length, nil]
+    def [](name)
+      data[name]
+    end
+
+    # Returns measurements as a plain hash.
+    #
+    # @return [Hash<Symbol, FiberUnits::Length>]
+    def to_h
+      data.dup
+    end
+
+    private
+
+    def define_accessors!
+      data.each_key do |name|
+        define_singleton_method(name) { data[name] }
+      end
+    end
+  end
+end

data/lib/fiber_pattern/ease.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module FiberPattern
+  # Value object representing ease preferences per measurement.
+  #
+  # Ease is the difference between body measurements and finished garment
+  # measurements. Positive ease creates a looser fit; negative ease creates
+  # a tighter fit.
+  #
+  # @example
+  #   ease = FiberPattern::Ease.new(
+  #     bust: 4.inches,
+  #     waist: 2.inches,
+  #     hip: 2.inches
+  #   )
+  #   ease.bust        # => 4.inches
+  #   ease[:waist]     # => 2.inches
+  #   ease.for(:bust)  # => 4.inches
+  class Ease
+    # @return [Hash<Symbol, FiberUnits::Length>] all ease values
+    attr_reader :data
+
+    # @param ease_values [Hash<Symbol, FiberUnits::Length>] named ease values
+    def initialize(**ease_values)
+      raise ArgumentError, "at least one ease value is required" if ease_values.empty?
+
+      @data = ease_values.freeze
+      define_accessors!
+    end
+
+    # Returns the ease value for a given measurement.
+    #
+    # @param name [Symbol]
+    # @return [FiberUnits::Length]
+    # @raise [ArgumentError] if no ease is defined for the measurement
+    def for(name)
+      raise ArgumentError, "no ease defined for #{name.inspect}" unless data.key?(name)
+
+      data[name]
+    end
+
+    # Hash-style access to an ease value.
+    #
+    # @param name [Symbol]
+    # @return [FiberUnits::Length, nil]
+    def [](name)
+      data[name]
+    end
+
+    # Returns all measurement names that have ease defined.
+    #
+    # @return [Array<Symbol>]
+    def measurements
+      data.keys
+    end
+
+    # Returns ease values as a plain hash.
+    #
+    # @return [Hash<Symbol, FiberUnits::Length>]
+    def to_h
+      data.dup
+    end
+
+    private
+
+    def define_accessors!
+      data.each_key do |name|
+        next if name == :for # avoid overriding #for
+
+        define_singleton_method(name) { data[name] }
+      end
+    end
+  end
+end

data/lib/fiber_pattern/garment_sizing.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module FiberPattern
+  # Combines body measurements with ease to produce finished garment dimensions.
+  #
+  # @example
+  #   body = FiberPattern::BodyMeasurements.new(bust: 36.inches, waist: 30.inches)
+  #   ease = FiberPattern::Ease.new(bust: 4.inches, waist: 2.inches)
+  #   garment = FiberPattern::GarmentSizing.new(body: body, ease: ease)
+  #   garment.bust   # => 40.inches
+  #   garment.waist  # => 32.inches
+  class GarmentSizing
+    # @return [FiberPattern::BodyMeasurements]
+    attr_reader :body
+
+    # @return [FiberPattern::Ease]
+    attr_reader :ease
+
+    # @param body [FiberPattern::BodyMeasurements] body measurements
+    # @param ease [FiberPattern::Ease] ease preferences
+    def initialize(body:, ease:)
+      validate!(body, ease)
+      @body = body
+      @ease = ease
+      define_accessors!
+    end
+
+    # Returns the finished garment dimension for a given measurement.
+    #
+    # @param name [Symbol]
+    # @return [FiberUnits::Length] body measurement + ease
+    # @raise [ArgumentError] if the measurement is not defined
+    def dimension(name)
+      raise ArgumentError, "unknown measurement #{name.inspect}" unless body.data.key?(name)
+
+      body[name] + (ease[name] || zero_length(body[name]))
+    end
+
+    # Hash-style access to finished dimensions.
+    #
+    # @param name [Symbol]
+    # @return [FiberUnits::Length]
+    def [](name)
+      dimension(name)
+    end
+
+    # Returns all finished garment dimensions.
+    #
+    # @return [Hash<Symbol, FiberUnits::Length>]
+    def dimensions
+      body.measurements.each_with_object({}) do |name, result|
+        result[name] = dimension(name)
+      end
+    end
+
+    private
+
+    def validate!(body, ease)
+      ease.measurements.each do |name|
+        unless body.measurements.include?(name)
+          raise ArgumentError, "ease defines #{name.inspect} but body measurements does not"
+        end
+      end
+    end
+
+    def define_accessors!
+      body.measurements.each do |name|
+        define_singleton_method(name) { dimension(name) }
+      end
+    end
+
+    def zero_length(reference)
+      reference * 0
+    end
+  end
+end

data/lib/fiber_pattern/size_chart.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module FiberPattern
+  # Standard size chart based on Craft Yarn Council (CYC) guidelines.
+  #
+  # Provides lookup of standard body measurements by size, and a closest-size
+  # finder that matches body measurements to the nearest standard size.
+  #
+  # @example
+  #   chart = FiberPattern::SizeChart.new
+  #   chart.size(:m)          # => { bust: 36.inches, waist: 28.inches, hip: 38.inches }
+  #   chart.closest_size(bust: 37.inches, waist: 29.inches, hip: 39.inches) # => :m
+  class SizeChart
+    # CYC standard women's body measurements (inches).
+    # Source: Craft Yarn Council Standards & Guidelines
+    CYC_WOMEN = {
+      xs: {bust: 28, waist: 20, hip: 30},
+      s: {bust: 32, waist: 24, hip: 34},
+      m: {bust: 36, waist: 28, hip: 38},
+      l: {bust: 40, waist: 32, hip: 42},
+      xl: {bust: 44, waist: 36, hip: 46},
+      xxl: {bust: 48, waist: 40, hip: 50},
+      xxxl: {bust: 52, waist: 44, hip: 54},
+      xxxxl: {bust: 56, waist: 48, hip: 58},
+      xxxxxl: {bust: 60, waist: 52, hip: 62}
+    }.freeze
+
+    # @return [Hash<Symbol, Hash<Symbol, FiberUnits::Length>>] size chart data
+    attr_reader :chart
+
+    # @return [Array<Symbol>] ordered size names
+    attr_reader :sizes
+
+    # Creates a new size chart.
+    #
+    # @param chart [Hash<Symbol, Hash<Symbol, Numeric>>] raw chart data mapping size names
+    #   to measurement hashes. Values are converted to inches. Defaults to CYC_WOMEN.
+    def initialize(chart: CYC_WOMEN)
+      @chart = chart.each_with_object({}) do |(size_name, measurements), result|
+        result[size_name] = measurements.transform_values { |v| v.is_a?(Numeric) ? v.inches : v }
+      end.freeze
+      @sizes = @chart.keys.freeze
+    end
+
+    # Returns body measurements for a standard size.
+    #
+    # @param name [Symbol] size name
+    # @return [Hash<Symbol, FiberUnits::Length>]
+    # @raise [ArgumentError] if the size is not in the chart
+    def size(name)
+      raise ArgumentError, "unknown size #{name.inspect}" unless chart.key?(name)
+
+      chart[name]
+    end
+
+    # Finds the closest standard size to the given body measurements.
+    #
+    # Compares using the sum of squared differences across all provided
+    # measurements. Only measurements present in both the query and the
+    # chart are compared.
+    #
+    # @param measurements [Hash<Symbol, FiberUnits::Length>] body measurements to match
+    # @return [Symbol] the closest size name
+    # @raise [ArgumentError] if no measurements overlap with the chart
+    def closest_size(**measurements)
+      comparable_keys = measurements.keys & chart.values.first.keys
+      raise ArgumentError, "no comparable measurements provided" if comparable_keys.empty?
+
+      sizes.min_by do |size_name|
+        size_data = chart[size_name]
+        comparable_keys.sum do |key|
+          diff = measurements[key].value - size_data[key].value
+          diff * diff
+        end
+      end
+    end
+
+    # Returns a BodyMeasurements object for a standard size.
+    #
+    # @param name [Symbol] size name
+    # @return [FiberPattern::BodyMeasurements]
+    def body_measurements_for(name)
+      BodyMeasurements.new(**size(name))
+    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/version.rb

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

data/lib/fiber_pattern.rb

@@ -5,10 +5,15 @@ 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"
 require_relative "fiber_pattern/grader"
+require_relative "fiber_pattern/body_measurements"
+require_relative "fiber_pattern/ease"
+require_relative "fiber_pattern/garment_sizing"
+require_relative "fiber_pattern/size_chart"
 
 # Utilities for generating fiber pattern measurements from gauge data.
 module FiberPattern

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fiber_pattern
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Meagan Waller
@@ -76,12 +76,17 @@ files:
 - LICENSE.txt
 - README.md
 - lib/fiber_pattern.rb
+- lib/fiber_pattern/body_measurements.rb
+- lib/fiber_pattern/ease.rb
+- lib/fiber_pattern/garment_sizing.rb
 - lib/fiber_pattern/grade_rules.rb
 - lib/fiber_pattern/grader.rb
 - lib/fiber_pattern/repeat.rb
 - lib/fiber_pattern/scaling.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/version.rb
 - sig/fiber_pattern.rbs
 homepage: https://github.com/meaganewaller/craftos/tree/main/gems/fiber_pattern