fiber_gauge 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25d259fdeeefe459f749e0da135112ed0fe79abcc93e6be92f673db1a55b849c
+  data.tar.gz: 72b16c3b65885143b9be6d612b331239160517a095b756b7c8e41ec74ce78233
+SHA512:
+  metadata.gz: 10e93cae9df207be9262454c7bdc1f97f342a1d2e23828b3cbd471290b8f4f8c4345cda2adf9eb545e0cbcb77c4e9b543ae093f9ac97d808d9ade47494ce6a7f
+  data.tar.gz: bd4d73e5aacfef81e5b675f8da6c1e44dea1dde52439e943a27be05d5ef9de33aca1a6d0f9aa78931108b2ac6a4df20fc482cf019d1595298da01827cb9f410b

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 10

data/.github/stale.yml

@@ -0,0 +1,10 @@
+daysUntilStale: 120
+daysUntilClose: 7
+exemptLabels:
+  - security
+staleLabel: wontfix
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+only: pulls

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+    tags-ignore:
+      - 'v*'
+  pull_request:
+    branches:
+      - 'main'
+  schedule:
+    - cron: '5 12,15,18 * * 1-5'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_WITHOUT: ""
+    if: github.repository == 'meaganewaller/fiber_gauge'
+    strategy:
+      matrix:
+        ruby-version: ['3.4', '4.0']
+
+    steps:
+      - uses: actions/checkout@v6
+      - name: Use Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run Standard
+        run: bin/standardrb
+
+      - name: Run RSpec
+        run: bin/rspec --format documentation

data/.github/workflows/dependabot-automerge.yml

@@ -0,0 +1,25 @@
+name: Dependabot Auto-Merge
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: github.actor == 'dependabot[bot]'
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v2
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Enable auto-merge for Dependabot PRs
+        # auto merge only patch and minor updates, not major updates
+        if: steps.metadata.outputs.update_type != 'version-update:semver-major'
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Release new version of FiberGauge
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    name: Release gem to RubyGems.org
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - name: Release gem
+        uses: rubygems/release-gem@v1
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-03-14
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"fiber_gauge" 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

@@ -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,171 @@
+# fiber_gauge
+
+A Ruby library for **knitting and crochet gauge calculations**.
+
+`fiber_gauge` models gauge swatches and provides helpers for converting between:
+
+* stitches
+* rows
+* width
+* height
+
+This allows you to perform the core math required for **pattern sizing, swatch calculations, and garment scaling**.
+
+The gem integrates with **[`fiber_units`](https://github.com/meaganewaller/fiber_units)**, which provides typed units for measurements and counts.
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "fiber_gauge"
+```
+
+And then execute:
+
+```
+bundle install
+```
+
+Or install it directly:
+
+```
+gem install fiber_gauge
+```
+
+# Dependencies
+
+`fiber_gauge` expects `fiber_units` to be installed.
+
+`fiber_units` provides the domain primitives used throughout the API:
+
+```
+10.stitches
+24.rows
+4.inches
+10.centimeters
+```
+
+# Basic Usage
+
+A gauge swatch is defined by:
+
+* stitch count
+* row count
+* swatch width
+
+Example swatch:
+
+```
+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
+)
+```
+
+# Stitches Per Inch
+
+```ruby
+gauge.spi
+# => 4.5
+```
+
+# Rows Per Inch
+
+```ruby
+gauge.rpi
+# => 6
+```
+
+# Calculate Width From Stitch Count
+
+Determine how wide a piece will be given a stitch count.
+
+```ruby
+gauge.width_for_stitches(90.stitches)
+# => 20 inches
+```
+
+# Calculate Height From Row Count
+
+```ruby
+gauge.height_for_rows(60.rows)
+# => 10 inches
+```
+
+# Calculate Required Stitches
+
+Determine how many stitches are needed to reach a target width.
+
+```ruby
+gauge.required_stitches(20.inches)
+# => 90 stitches
+```
+
+# Calculate Required Rows
+
+```ruby
+gauge.required_rows(10.inches)
+# => 60 rows
+```
+
+# Unit Conversion
+
+Because the gem relies on `fiber_units`, you can mix units freely:
+
+```ruby
+gauge = FiberGauge::Gauge.new(
+  stitches: 20.stitches,
+  rows: 28.rows,
+  width: 10.centimeters
+)
+
+gauge.required_stitches(40.centimeters)
+```
+
+All calculations are normalized internally.
+
+# Example: Sweater Sizing
+
+```ruby
+gauge = FiberGauge::Gauge.new(
+  stitches: 18.stitches,
+  rows: 24.rows,
+  width: 4.inches
+)
+
+chest = 38.inches
+
+cast_on = gauge.required_stitches(chest)
+# => 171 stitches
+```
+
+# Design Goals
+
+`fiber_gauge` is designed to:
+
+* model gauge as a **first-class domain object**
+* work naturally with **typed measurement units**
+* enable **pattern math and garment sizing**
+* remain **small and composable**
+
+It is intended to integrate with other fiber tools such as:
+
+- [fiber_units](https://github.com/meaganewaller/fiber_units)
+- [yarn_skein](https://github.com/meaganewaller/yarn_skein)
+
+# Contributing
+
+Bug reports and pull requests are welcome.
+
+# License
+
+MIT License

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/fiber_gauge/gauge.rb

@@ -0,0 +1,33 @@
+module FiberGauge
+  class Gauge
+    attr_reader :stitches, :rows, :width
+
+    def initialize(stitches:, rows:, width:)
+      @stitches = stitches
+      @rows = rows
+      @width = width
+    end
+
+    def spi
+      stitches.value / width.to(:inches).value
+    end
+
+    def rpi
+      rows.value / width.to(:inches).value
+    end
+
+    def width_for_stitches(stitch_count)
+      stitches_per_inch = spi
+      inches = stitch_count.value / stitches_per_inch
+
+      inches.inches
+    end
+
+    def required_stitches(length)
+      inches = length.to(:inches).value
+      count = (inches * spi).round
+
+      count.stitches
+    end
+  end
+end

data/lib/fiber_gauge/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FiberGauge
+  VERSION = "0.1.0"
+end

data/lib/fiber_gauge.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "fiber_units"
+require_relative "fiber_gauge/version"
+require_relative "fiber_gauge/gauge"
+
+module FiberGauge
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/fiber_gauge.rbs

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: fiber_gauge
+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
+description: FiberGauge is a Ruby gem that provides tools to measure and analyze fiber
+  usage in Ruby applications.
+email:
+- meagan@meaganwaller.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/stale.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/dependabot-automerge.yml"
+- ".github/workflows/release.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/fiber_gauge.rb
+- lib/fiber_gauge/gauge.rb
+- lib/fiber_gauge/version.rb
+- sig/fiber_gauge.rbs
+homepage: https://github.com/meaganewaller/fiber_gauge
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/meaganewaller/fiber_gauge
+  source_code_uri: https://github.com/meaganewaller/fiber_gauge
+  changelog_uri: https://github.com/meaganewaller/fiber_gauge/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: A gem for measuring fiber usage in Ruby applications.
+test_files: []