fiber_pattern 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1385f6b59804f75b05ecea1e994ef99dbdf9466f5d19c464d7761c2b7ca7080a
-  data.tar.gz: f8487b4aac630f1cabf7c05c0b957e05178959590a2001f7c4a546adcf81dcde
+  metadata.gz: 2975f472d7c4d0d21ffe8a6a6eb918d145b8cc37a7191e141c4aa167bd09e136
+  data.tar.gz: 723d930af45c9e963001a0c678e50db9da2fe75690c9297bbf524f898cb5bb32
 SHA512:
-  metadata.gz: 3707e9546ce3fe0b29aba10ef1b90b13e40a7ee53ac2585aef670942b6e32d0f76bab53886178f2d59ed9add2af2777695e1a641926f8ce38181cbf6b0d667f2
-  data.tar.gz: 952066f10ac1083b16724a73db119e647b768dca933a9851d5c54bae6dad7f1c5fe1988b22ad6f858e5470f075fbd9ce08d04bcc4762551c6cdd4778d00ad321
+  metadata.gz: 332c10d1d8a7cd0cf594ac22d597e0b6dc589155094157ecb7f7ca26552347ae1d8917ea63fcadce24158661ec668919a91b07cd2231e13f1f0a34532c2c2b42
+  data.tar.gz: de8c48b9c34681594201c7443e478bda797d432af8d2b3a1d66767cb94f4dfd84b44e30554c87b0b9d62743dd9cf236e04e11e26a7f90d4d5c87e858c9b243fd

data/README.md

@@ -83,6 +83,8 @@ Because:
 
 # Pattern Stitch Repeats
 
+Use `FiberPattern::Repeat` when a pattern requires stitch counts to align to a repeat.
+
 Many patterns require stitch counts to be a **multiple of a repeat**.
 
 Example: *multiple of 8 stitches*
@@ -90,7 +92,7 @@ Example: *multiple of 8 stitches*
 ```ruby
 sizing = FiberPattern::Sizing.new(
   gauge: gauge,
-  stitch_repeat: 8.stitches
+  repeat: FiberPattern::Repeat.new(multiple: 8.stitches)
 )
 
 sizing.cast_on_for(38.inches)
@@ -117,8 +119,10 @@ multiple of 8 + 2
 ```ruby
 sizing = FiberPattern::Sizing.new(
   gauge: gauge,
-  stitch_repeat: 8.stitches,
-  repeat_offset: 2.stitches
+  repeat: FiberPattern::Repeat.new(
+    multiple: 8.stitches,
+    offset: 2.stitches
+  )
 )
 
 sizing.cast_on_for(38.inches)
@@ -133,6 +137,38 @@ Calculation:
 → 178 stitches
 ```
 
+# Gauge Scaling
+
+You can also scale stitch and row counts from a pattern's gauge to a knitter's gauge.
+
+```ruby
+pattern_gauge = FiberGauge::Gauge.new(
+  stitches: 20.stitches,
+  rows: 28.rows,
+  width: 4.inches
+)
+
+knitter_gauge = FiberGauge::Gauge.new(
+  stitches: 18.stitches,
+  rows: 24.rows,
+  width: 4.inches
+)
+
+FiberPattern::Scaling.scale_stitches(
+  100.stitches,
+  pattern_gauge,
+  knitter_gauge
+)
+# => 90 stitches
+
+FiberPattern::Scaling.scale_rows(
+  56.rows,
+  pattern_gauge,
+  knitter_gauge
+)
+# => 48 rows
+```
+
 # Example: Sweater Sizing
 
 ```ruby
@@ -144,7 +180,7 @@ gauge = FiberGauge::Gauge.new(
 
 sizing = FiberPattern::Sizing.new(
   gauge: gauge,
-  stitch_repeat: 8.stitches
+  repeat: FiberPattern::Repeat.new(multiple: 8.stitches)
 )
 
 chest = 40.inches
@@ -160,6 +196,7 @@ cast_on = sizing.cast_on_for(chest)
 * make **pattern math predictable**
 * integrate with **typed fiber measurement units**
 * support **repeat-based stitch patterns**
+* help **scale instructions between gauges**
 * stay **small and composable**
 
 It forms part of a broader fiber tooling ecosystem:

data/lib/fiber_pattern/repeat.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module FiberPattern
+  # Adjusts stitch counts to satisfy a repeat multiple and optional offset.
+  class Repeat
+    # @return [FiberUnits::Stitches] repeat multiple used for rounding
+    # @return [FiberUnits::Stitches] fixed offset applied before rounding
+    attr_reader :multiple, :offset
+
+    # @param multiple [FiberUnits::Stitches] repeat size required by the pattern
+    # @param offset [FiberUnits::Stitches] offset preserved when aligning to the repeat
+    def initialize(multiple:, offset: 0.stitches)
+      @multiple = multiple
+      @offset = offset
+    end
+
+    # Rounds a stitch count up to the next valid repeat-compatible value.
+    #
+    # @param stitches [FiberUnits::Stitches] stitch count to adjust
+    # @return [FiberUnits::Stitches] smallest valid count meeting the repeat constraints
+    def adjust(stitches)
+      m = multiple.value
+      o = offset.value
+
+      adjusted =
+        ((stitches.value - o).to_f / m).ceil * m + o
+
+      adjusted.stitches
+    end
+  end
+end

data/lib/fiber_pattern/scaling.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module FiberPattern
+  # Converts stitch and row counts from a pattern gauge to a knitter's gauge.
+  class Scaling
+    # Scales a stitch count to preserve width at a different stitches-per-inch rate.
+    #
+    # @param stitches [FiberUnits::Stitches] stitch count written for the pattern gauge
+    # @param pattern_gauge [FiberGauge::Gauge] gauge used by the source pattern
+    # @param knitter_gauge [FiberGauge::Gauge] gauge achieved by the knitter
+    # @return [FiberUnits::Stitches] adjusted stitch count for the knitter's gauge
+    def self.scale_stitches(stitches, pattern_gauge, knitter_gauge)
+      pattern_spi = pattern_gauge.spi
+      knitter_spi = knitter_gauge.spi
+
+      scaled =
+        (stitches.value * knitter_spi / pattern_spi).round
+
+      scaled.stitches
+    end
+
+    # Scales a row count to preserve length at a different rows-per-inch rate.
+    #
+    # @param rows [FiberUnits::Rows] row count written for the pattern gauge
+    # @param pattern_gauge [FiberGauge::Gauge] gauge used by the source pattern
+    # @param knitter_gauge [FiberGauge::Gauge] gauge achieved by the knitter
+    # @return [FiberUnits::Rows] adjusted row count for the knitter's gauge
+    def self.scale_rows(rows, pattern_gauge, knitter_gauge)
+      pattern_rpi = pattern_gauge.rpi
+      knitter_rpi = knitter_gauge.rpi
+
+      scaled =
+        (rows.value * knitter_rpi / pattern_rpi).round
+
+      scaled.rows
+    end
+  end
+end

data/lib/fiber_pattern/sizing.rb

@@ -6,46 +6,33 @@ module FiberPattern
     # @return [Object] gauge object that responds to `required_stitches`
     attr_reader :gauge
 
-    # @return [Object, nil] optional stitch repeat to round stitch counts to
-    attr_reader :stitch_repeat
-
-    # @return [Object] optional offset to apply when rounding to stitch repeat
-    attr_reader :repeat_offset
+    # @return [FiberPattern::Repeat, nil] optional stitch repeat to round stitch counts to
+    attr_reader :repeat
 
     # @param gauge [Object] gauge object used to derive stitch counts
-    # @param stitch_repeat [Object, nil] optional stitch repeat to round stitch counts to
-    # @param repeat_offset [Object] optional offset to apply when rounding to stitch repeat
-    def initialize(gauge:, stitch_repeat: nil, repeat_offset: 0.stitches)
+    # @param repeat [FiberPattern::Repeat, nil] optional stitch repeat to round stitch counts to
+    def initialize(gauge:, repeat: nil)
       @gauge = gauge
-      @stitch_repeat = stitch_repeat
-      @repeat_offset = repeat_offset
+      @repeat = repeat
     end
 
-    # Computes the cast-on stitch count needed for a target width.
+    # Calculates the number of stitches required to reach a given width, based on the provided gauge.
     #
     # @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)
 
-      return stitches unless stitch_repeat
+      return stitches unless repeat
 
-      adjust_to_repeat(stitches)
+      repeat.adjust(stitches)
     end
 
-    private
-
-    # Adjusts a stitch count up to the nearest multiple of the stitch repeat.
-    # @param stitches [Object] stitch count to adjust
-    # @return [Integer] stitch count rounded up to the nearest multiple of the stitch repeat
-    def adjust_to_repeat(stitches)
-      repeat = stitch_repeat.value
-      offset = @repeat_offset.value
-
-      adjusted =
-        ((stitches.value - offset).to_f / repeat).ceil * repeat + offset
-
-      adjusted.stitches
+    # Calculates the width of a given stitch count, based on the provided gauge.
+    # @param stitches [FiberUnits::Stitches] stitch count to calculate width for
+    # @return [Object] width in units accepted by the gauge
+    def width_for(stitches)
+      gauge.width_for_stitches(stitches)
     end
   end
 end

data/lib/fiber_pattern/version.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+# :nocov:
 module FiberPattern
   # Current gem version.
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end
+# :nocov:

data/lib/fiber_pattern.rb

@@ -4,6 +4,8 @@ require "fiber_units"
 require "fiber_gauge"
 require_relative "fiber_pattern/version"
 require_relative "fiber_pattern/sizing"
+require_relative "fiber_pattern/repeat"
+require_relative "fiber_pattern/scaling"
 
 # Utilities for generating fiber pattern measurements from gauge data.
 module FiberPattern

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: fiber_pattern
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Meagan Waller
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -45,23 +45,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/fiber_pattern.rb
+- lib/fiber_pattern/repeat.rb
+- lib/fiber_pattern/scaling.rb
 - lib/fiber_pattern/sizing.rb
 - lib/fiber_pattern/version.rb
-- mise.toml
 - sig/fiber_pattern.rbs
-homepage: https://github.com/meaganewaller/fiber_pattern
+homepage: https://github.com/meaganewaller/craftos/tree/main/gems/fiber_pattern
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/meaganewaller/fiber_pattern
-  source_code_uri: https://github.com/meaganewaller/fiber_pattern
-  changelog_uri: https://github.com/meaganewaller/fiber_pattern/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/meaganewaller/craftos/tree/main/gems/fiber_pattern
+  bug_tracker_uri: https://github.com/meaganewaller/craftos/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -69,14 +67,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Pattern sizing and stitch math for knitting and crochet.
 test_files: []

data/CHANGELOG.md

@@ -1,8 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2026-03-14
-
-- Adding offset repeat behavior
-- Adding stitch repeat behavior
-- Adding initial pattern cast-on math with `Sizing` module
-- Initial release

data/CODE_OF_CONDUCT.md

@@ -1,10 +0,0 @@
-# Code of Conduct
-
-"fiber_pattern" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
-
-* Participants will be tolerant of opposing views.
-* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
-* When interpreting the words and actions of others, participants should always assume good intentions.
-* Behaviour which can be reasonably considered harassment will not be tolerated.
-
-If you have any concerns about behaviour within this project, please contact us at ["TODO: Write your email address"](mailto:"TODO: Write your email address").

data/Rakefile

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "yard"
-require "yard/rake/yardoc_task"
-require "standard/rake"
-
-# YARD Documentation tasks
-begin
-  namespace :doc do
-    desc "Generate YARD documentation"
-    YARD::Rake::YardocTask.new(:generate) do |t|
-      t.files = ["lib/**/*.rb", "-", "README.md"]
-      t.options = [
-        "--output-dir", "doc/yard",
-        "--markup", "markdown",
-        "--title", "YarnSkein - Yarn metadata and skein calculations",
-        "--readme", "README.md"
-      ]
-    end
-
-    desc "Regenerate documentation with cache reset"
-    task regenerate: ["doc:clean", "doc:generate"]
-
-    desc "Clean generated documentation"
-    task :clean do
-      rm_rf "doc/yard"
-      rm_rf ".yardoc"
-    end
-
-    desc "Start YARD server for local documentation viewing"
-    task :serve do
-      sh "bundle exec yard server --reload --port 8808"
-    end
-
-    desc "Validate YARD documentation coverage"
-    task :coverage do
-      sh "bundle exec yard stats --list-undoc"
-    end
-
-    desc "Generate complete documentation with coverage report"
-    task complete: [:generate, :coverage]
-  end
-
-  # Add shorthand aliases
-  task yard: "doc:generate"
-  task yard_server: "doc:serve"
-  task yard_clean: "doc:clean"
-rescue LoadError
-  # YARD is only available in development/test environments
-  # Silence this warning in production where it's not needed
-end
-
-task :default do
-  Rake::Task["standard"].invoke
-  Rake::Task["spec"].invoke
-end

data/mise.toml

@@ -1,2 +0,0 @@
-[tools]
-ruby = "latest"