fiber_units 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 18525eb39ab69336575ce1c0eb327ee299ed037cdf3bbf854b7e5f4af70520e3
+  data.tar.gz: 645a4ed7eb065fa3b2c704e3dc46cca2a8ef4f1bfaafb01495fc982c1afc9ccb
+SHA512:
+  metadata.gz: 85beb04dc7b1db098924f40820db8272cff73c72d08e8ec75f62a392efea3b35edb256bccf6797bfde682bfbc0096203ef5f90cba022356c2ea9fb00928c29e1
+  data.tar.gz: 267047384cc77ac732c5cf912d8db8cca2b9ca4e177cb84428e926d1639cca7bed95d8289b35fdac272fbe586b678001321c64bc6da392db5d4569eddac93e0a

data/CHANGELOG.md

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"fiber_units" 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,285 @@
+# fiber_units
+
+Typed measurement units for fiber arts and crafting systems.
+
+`fiber_units` provides a small, type-safe unit system for working with measurements common in knitting, crochet, and other crafts.
+
+It supports:
+
+* length units (`inches`, `centimeters`, `yards`, etc.)
+* weight units (`grams`, `ounces`, `pounds`, etc.)
+* stitch counts
+* row counts
+* safe arithmetic between compatible units
+* automatic unit conversion
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "fiber_units"
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install fiber_units
+```
+
+## Basic Usage
+
+```ruby
+require "fiber_units"
+
+4.inches
+10.centimeters
+210.yards
+100.grams
+```
+
+Each returns a typed measurement object.
+
+Example:
+
+```ruby
+length = 4.inches
+
+length.value
+# => 4
+
+length.unit
+# => :inches
+```
+
+## Unit Conversion
+
+Convert between compatible units:
+
+```ruby
+4.inches.to(:centimeters)
+# => 10.16 cm
+
+210.yards.to(:meters)
+# => 192.024 m
+
+100.grams.to(:ounces)
+# => 3.527 oz
+```
+
+## Arithmetic
+
+Compatible units can be combined safely.
+
+```ruby
+4.inches + 2.inches
+# => 6 inches
+
+10.inches - 4.inches
+# => 6 inches
+```
+
+Cross-unit arithmetic works automatically.
+
+```ruby
+2.yards + 36.inches
+# => 3 yards
+```
+
+Internally calculations happen in **base units** and then convert back.
+
+## Dimension Safety
+
+Invalid operations raise errors.
+
+```ruby
+4.inches + 100.grams
+# => FiberUnits::DimensionError
+```
+
+This prevents subtle math bugs.
+
+## Ratios
+
+Dividing measurements produces ratios.
+
+```ruby
+210.yards / 100.grams
+# => 2.1 yards/grams
+```
+
+This is useful for yarn metrics like **grist**.
+
+## Stitch and Row Counts
+
+Fiber-specific counts are supported.
+
+```ruby
+20.stitches
+32.rows
+```
+
+Arithmetic works as expected:
+
+```ruby
+20.stitches + 10.stitches
+# => 30 stitches
+```
+
+## Supported Length Units
+
+```
+millimeters
+centimeters
+meters
+inches
+feet
+yards
+```
+
+Example:
+
+```ruby
+5.centimeters
+2.yards
+12.inches
+```
+
+## Supported Weight Units
+
+```
+grams
+kilograms
+ounces
+pounds
+```
+
+Example:
+
+```ruby
+100.grams
+8.ounces
+1.pounds
+```
+
+## Internal Model
+
+All measurements inherit from a shared base class:
+
+```
+FiberUnits::Measurement
+```
+
+Each dimension defines its unit conversion table:
+
+```ruby
+class Length < Measurement
+  FACTORS = {
+    millimeters: 1.0,
+    centimeters: 10.0,
+    meters: 1000.0,
+    inches: 25.4,
+    feet: 304.8,
+    yards: 914.4
+  }
+end
+```
+
+Arithmetic works by:
+
+1. converting to base units
+2. performing the calculation
+3. converting back to the original unit
+
+## Example: Yarn Grist
+
+```ruby
+yardage = 210.yards
+weight  = 100.grams
+
+grist = yardage / weight
+# => 2.1 yards/gram
+```
+
+## Example: Gauge Math
+
+```ruby
+stitches = 18.stitches
+width = 4.inches
+
+spi = stitches / width
+# => 4.5 stitches per inch
+```
+
+## Extending the Library
+
+Adding a new measurement dimension is simple.
+
+Example:
+
+```ruby
+class Area < FiberUnits::Measurement
+  FACTORS = {
+    square_millimeters: 1.0,
+    square_centimeters: 100.0,
+    square_meters: 1_000_000.0
+  }
+end
+```
+
+Everything else (conversion, arithmetic) works automatically.
+
+## Philosophy
+
+Craft software often relies on raw integers or floats for measurements, which leads to subtle bugs.
+
+`fiber_units` aims to make craft math:
+
+* **explicit**
+* **type-safe**
+* **composable**
+* **pleasant to read**
+
+Example:
+
+```ruby
+2.yards + 36.inches
+```
+
+reads like real-world math.
+
+## Development
+
+Run tests:
+
+```bash
+bundle exec rspec
+```
+
+The library includes extensive tests covering:
+
+* conversions
+* arithmetic
+* ratios
+* DSL methods
+* dimension safety
+
+## License
+
+MIT License
+
+# Future Ideas
+
+Planned features include:
+
+* comparison operators (`4.inches > 10.cm`)
+* gauge utilities
+* yarn grist helpers
+* area and volume units
+* pattern math helpers

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_units/conversions/length_conversion.rb

@@ -0,0 +1,22 @@
+module FiberUnits
+  module Conversions
+    module LengthConversion
+      FACTORS = {
+        millimeters: 1.0,
+        centimeters: 10.0,
+        meters: 1000.0,
+        inches: 25.4,
+        feet: 304.8,
+        yards: 914.4
+      }.freeze
+
+      def self.convert(value, from, to)
+        raise FiberUnits::InvalidUnitError unless FACTORS.key?(from)
+        raise FiberUnits::InvalidUnitError unless FACTORS.key?(to)
+
+        base = value * FACTORS[from]
+        base / FACTORS[to]
+      end
+    end
+  end
+end

data/lib/fiber_units/conversions/weight_conversion.rb

@@ -0,0 +1,20 @@
+module FiberUnits
+  module Conversions
+    module WeightConversion
+      FACTORS = {
+        grams: 1.0,
+        kilograms: 1000.0,
+        ounces: 28.3495,
+        pounds: 453.592
+      }.freeze
+
+      def self.convert(value, from, to)
+        raise FiberUnits::InvalidUnitError unless FACTORS.key?(from)
+        raise FiberUnits::InvalidUnitError unless FACTORS.key?(to)
+
+        base = value * FACTORS[from]
+        base / FACTORS[to]
+      end
+    end
+  end
+end

data/lib/fiber_units/dimensions/length.rb

@@ -0,0 +1,14 @@
+module FiberUnits
+  class Length < Measurement
+    BASE_UNIT = :millimeters
+
+    FACTORS = {
+      millimeters: 1,
+      centimeters: 10,
+      meters: 1000,
+      inches: 25.4,
+      feet: 304.8,
+      yards: 914.4
+    }
+  end
+end

data/lib/fiber_units/dimensions/row_count.rb

@@ -0,0 +1,13 @@
+module FiberUnits
+  class RowCount
+    attr_reader :value
+
+    def initialize(value, _unit = nil)
+      @value = value
+    end
+
+    def +(other)
+      RowCount.new(value + other.value)
+    end
+  end
+end

data/lib/fiber_units/dimensions/stitch_count.rb

@@ -0,0 +1,13 @@
+module FiberUnits
+  class StitchCount
+    attr_reader :value
+
+    def initialize(value, _unit = nil)
+      @value = value
+    end
+
+    def +(other)
+      StitchCount.new(value + other.value)
+    end
+  end
+end

data/lib/fiber_units/dimensions/weight.rb

@@ -0,0 +1,10 @@
+module FiberUnits
+  class Weight < Measurement
+    FACTORS = {
+      grams: 1.0,
+      kilograms: 1000.0,
+      ounces: 28.3495,
+      pounds: 453.592
+    }.freeze
+  end
+end

data/lib/fiber_units/errors.rb

@@ -0,0 +1,4 @@
+module FiberUnits
+  class DimensionError < StandardError; end
+  class InvalidUnitError < StandardError; end
+end

data/lib/fiber_units/measurement.rb

@@ -0,0 +1,74 @@
+module FiberUnits
+  class Measurement
+    attr_reader :value, :unit
+
+    def initialize(value, unit)
+      @value = value
+      @unit = unit
+    end
+
+    def +(other)
+      ensure_same_dimension!(other)
+
+      base = to_base + other.to_base
+      new_value = base / self.class::FACTORS[unit]
+      new_value = new_value.round(12)
+
+      self.class.new(new_value, unit)
+    end
+
+    def -(other)
+      ensure_same_dimension!(other)
+
+      base = to_base - other.to_base
+      new_value = base / self.class::FACTORS[unit]
+      new_value = new_value.round(12)
+
+      self.class.new(new_value, unit)
+    end
+
+    def *(other)
+      self.class.new(value * other, unit)
+    end
+
+    def /(other)
+      if other.is_a?(Measurement)
+        Ratio.new(self, other)
+      else
+        self.class.new(value / other, unit)
+      end
+    end
+
+    def to(target_unit)
+      raise FiberUnits::InvalidUnitError unless self.class::FACTORS.key?(target_unit)
+
+      base = to_base
+      self.class.new(base / self.class::FACTORS[target_unit], target_unit)
+    end
+
+    def to_base
+      raise NotImplementedError unless self.class.const_defined?(:FACTORS)
+
+      value * self.class::FACTORS[unit]
+    end
+
+    def self.from_base(base_value)
+      factors = self::FACTORS
+
+      base_unit = factors.key(1.0)
+
+      raise FiberUnits::InvalidUnitError unless base_unit
+
+      new(base_value / factors[base_unit], base_unit)
+    end
+
+    private
+
+    def ensure_same_dimension!(other)
+      unless other.is_a?(self.class)
+        raise FiberUnits::DimensionError,
+          "Cannot combine #{self.class} with #{other.class}"
+      end
+    end
+  end
+end

data/lib/fiber_units/ratio.rb

@@ -0,0 +1,18 @@
+module FiberUnits
+  class Ratio
+    attr_reader :numerator, :denominator
+
+    def initialize(numerator, denominator)
+      @numerator = numerator
+      @denominator = denominator
+    end
+
+    def value
+      numerator.value.to_f / denominator.value
+    end
+
+    def to_s
+      "#{value.round(2)} #{numerator.unit}/#{denominator.unit}"
+    end
+  end
+end

data/lib/fiber_units/version.rb

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

data/lib/fiber_units.rb

@@ -0,0 +1,18 @@
+require_relative "fiber_units/version"
+require_relative "fiber_units/errors"
+require_relative "fiber_units/measurement"
+require_relative "fiber_units/ratio"
+
+require_relative "fiber_units/conversions/length_conversion"
+require_relative "fiber_units/conversions/weight_conversion"
+
+require_relative "fiber_units/dimensions/length"
+require_relative "fiber_units/dimensions/weight"
+require_relative "fiber_units/dimensions/stitch_count"
+require_relative "fiber_units/dimensions/row_count"
+
+require_relative "numeric_extensions"
+
+module FiberUnits
+  # Your code goes here...
+end

data/lib/numeric_extensions.rb

@@ -0,0 +1,37 @@
+module FiberUnits
+  module NumericExtensions
+    def self.install!
+      install_length_units
+      install_weight_units
+      install_fiber_counts
+    end
+
+    def self.install_length_units
+      FiberUnits::Conversions::LengthConversion::FACTORS.keys.each do |unit|
+        Numeric.define_method(unit) do
+          FiberUnits::Length.new(self, unit)
+        end
+      end
+    end
+
+    def self.install_weight_units
+      FiberUnits::Conversions::WeightConversion::FACTORS.keys.each do |unit|
+        Numeric.define_method(unit) do
+          FiberUnits::Weight.new(self, unit)
+        end
+      end
+    end
+
+    def self.install_fiber_counts
+      Numeric.define_method(:stitches) do
+        FiberUnits::StitchCount.new(self)
+      end
+
+      Numeric.define_method(:rows) do
+        FiberUnits::RowCount.new(self)
+      end
+    end
+  end
+end
+
+FiberUnits::NumericExtensions.install!

data/sig/fiber_units.rbs

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

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: fiber_units
+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: []
+description: A Ruby gem providing typed measurement units for various fiber arts,
+  allowing for easy conversion and manipulation of units like yards and meters.
+email:
+- meagan@meaganwaller.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/gauge_example.rb
+- examples/stash_calculations.rb
+- examples/yarn_grist_example.rb
+- lib/fiber_units.rb
+- lib/fiber_units/conversions/length_conversion.rb
+- lib/fiber_units/conversions/weight_conversion.rb
+- lib/fiber_units/dimensions/length.rb
+- lib/fiber_units/dimensions/row_count.rb
+- lib/fiber_units/dimensions/stitch_count.rb
+- lib/fiber_units/dimensions/weight.rb
+- lib/fiber_units/errors.rb
+- lib/fiber_units/formatting/formatter.rb
+- lib/fiber_units/measurement.rb
+- lib/fiber_units/ratio.rb
+- lib/fiber_units/version.rb
+- lib/numeric_extensions.rb
+- sig/fiber_units.rbs
+homepage: https://github.com/meaganewaller/fiber_units
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/meaganewaller/fiber_units
+  source_code_uri: https://github.com/meaganewaller/fiber_units
+  changelog_uri: https://github.com/meaganewaller/fiber_units/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: Typed measurement units for fiber arts.
+test_files: []