fiber_pattern 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1385f6b59804f75b05ecea1e994ef99dbdf9466f5d19c464d7761c2b7ca7080a
+  data.tar.gz: f8487b4aac630f1cabf7c05c0b957e05178959590a2001f7c4a546adcf81dcde
+SHA512:
+  metadata.gz: 3707e9546ce3fe0b29aba10ef1b90b13e40a7ee53ac2585aef670942b6e32d0f76bab53886178f2d59ed9add2af2777695e1a641926f8ce38181cbf6b0d667f2
+  data.tar.gz: 952066f10ac1083b16724a73db119e647b768dca933a9851d5c54bae6dad7f1c5fe1988b22ad6f858e5470f075fbd9ce08d04bcc4762551c6cdd4778d00ad321

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [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

@@ -0,0 +1,10 @@
+# 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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Meagan Waller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,178 @@
+# fiber_pattern
+
+Tools for **pattern sizing, stitch repeats, and gauge-based calculations** for knitting and crochet.
+
+`fiber_pattern` builds on the primitives provided by:
+
+* [**fiber_units**](https://github.com/meaganewaller/fiber_units) — typed units for stitches, rows, and measurements
+* [**fiber_gauge**](https://github.com/meaganewaller/fiber_gauge) — gauge swatch math
+
+Together they enable **reliable pattern sizing and repeat calculations**.
+
+---
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "fiber_pattern"
+```
+
+Then run:
+
+```
+bundle install
+```
+
+Or install directly:
+
+```
+gem install fiber_pattern
+```
+
+# Dependencies
+
+`fiber_pattern` is designed to work with:
+
+```
+fiber_units
+fiber_gauge
+```
+
+These libraries provide the domain primitives used throughout the API.
+
+# Basic Usage
+
+Patterns often require calculating stitch counts from gauge and measurements.
+
+Example gauge:
+
+```
+18 stitches over 4 inches
+24 rows over 4 inches
+```
+
+Create a gauge object:
+
+```ruby
+gauge = FiberGauge::Gauge.new(
+  stitches: 18.stitches,
+  rows: 24.rows,
+  width: 4.inches
+)
+```
+
+# Calculate Cast-On Stitches
+
+You can determine how many stitches are needed for a target width.
+
+```ruby
+sizing = FiberPattern::Sizing.new(gauge: gauge)
+
+sizing.cast_on_for(20.inches)
+# => 90 stitches
+```
+
+Because:
+
+```
+18 stitches / 4 inches = 4.5 stitches per inch
+20 inches × 4.5 = 90 stitches
+```
+
+# Pattern Stitch Repeats
+
+Many patterns require stitch counts to be a **multiple of a repeat**.
+
+Example: *multiple of 8 stitches*
+
+```ruby
+sizing = FiberPattern::Sizing.new(
+  gauge: gauge,
+  stitch_repeat: 8.stitches
+)
+
+sizing.cast_on_for(38.inches)
+# => 176 stitches
+```
+
+Calculation:
+
+```
+38 inches × 4.5 spi = 171 stitches
+rounded to nearest multiple of 8 → 176
+```
+
+# Repeats With Offsets
+
+Some stitch patterns require **multiples plus an offset**.
+
+Example:
+
+```
+multiple of 8 + 2
+```
+
+```ruby
+sizing = FiberPattern::Sizing.new(
+  gauge: gauge,
+  stitch_repeat: 8.stitches,
+  repeat_offset: 2.stitches
+)
+
+sizing.cast_on_for(38.inches)
+# => 178 stitches
+```
+
+Calculation:
+
+```
+171 stitches
+→ adjusted to (multiple of 8 + 2)
+→ 178 stitches
+```
+
+# Example: Sweater Sizing
+
+```ruby
+gauge = FiberGauge::Gauge.new(
+  stitches: 20.stitches,
+  rows: 28.rows,
+  width: 4.inches
+)
+
+sizing = FiberPattern::Sizing.new(
+  gauge: gauge,
+  stitch_repeat: 8.stitches
+)
+
+chest = 40.inches
+
+cast_on = sizing.cast_on_for(chest)
+# => 200 stitches
+```
+
+# Design Goals
+
+`fiber_pattern` is designed to:
+
+* make **pattern math predictable**
+* integrate with **typed fiber measurement units**
+* support **repeat-based stitch patterns**
+* stay **small and composable**
+
+It forms part of a broader fiber tooling ecosystem:
+
+- [fiber_units](https://github.com/meaganewaller/fiber_units)
+- [yarn_skein](https://github.com/meaganewaller/yarn_skein)
+- [fiber_gauge](https://github.com/meaganewaller/fiber_gauge)
+- [fiber_pattern](https://github.com/meaganewaller/fiber_pattern)
+
+# Contributing
+
+Bug reports and pull requests are welcome.
+
+# License
+
+MIT License

data/Rakefile

@@ -0,0 +1,58 @@
+# 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/lib/fiber_pattern/sizing.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module FiberPattern
+  # Calculates pattern sizing values from a provided gauge object.
+  class Sizing
+    # @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
+
+    # @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)
+      @gauge = gauge
+      @stitch_repeat = stitch_repeat
+      @repeat_offset = repeat_offset
+    end
+
+    # Computes the cast-on stitch count needed for a target width.
+    #
+    # @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
+
+      adjust_to_repeat(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
+    end
+  end
+end

data/lib/fiber_pattern/version.rb

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

data/lib/fiber_pattern.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "fiber_units"
+require "fiber_gauge"
+require_relative "fiber_pattern/version"
+require_relative "fiber_pattern/sizing"
+
+# Utilities for generating fiber pattern measurements from gauge data.
+module FiberPattern
+  # Base error type for gem-specific failures.
+  class Error < StandardError; end
+end

data/mise.toml

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

data/sig/fiber_pattern.rbs

@@ -0,0 +1,4 @@
+module FiberPattern
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: fiber_pattern
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Meagan Waller
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fiber_units
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: fiber_gauge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby gem for calculating pattern sizes and stitch counts for knitting
+  and crochet projects.
+email:
+- meagan@meaganwaller.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/fiber_pattern.rb
+- lib/fiber_pattern/sizing.rb
+- lib/fiber_pattern/version.rb
+- mise.toml
+- sig/fiber_pattern.rbs
+homepage: https://github.com/meaganewaller/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
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Pattern sizing and stitch math for knitting and crochet.
+test_files: []