cooklang 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa4eed0618449146de288cbfa4b51b05d7ac994fca5e3aca0161c6cfe90d2551
-  data.tar.gz: 45c683a6a2daea2da5d48116cf91181532370df0b1b2e5de0d1b72a749f2e245
+  metadata.gz: 31ab63d47990eb2eaa6eb3dd09af9ba81d760cfbcfde937467f7060282195409
+  data.tar.gz: 2fb316c77fcfaabdc679943997cfa68607d0dbf61599def411743ff53be8f0a6
 SHA512:
-  metadata.gz: b4cfc4bad69e170f6fff3b5aef1d35b31ba72232b1c9579129f1b3ec1e5f1174af9501a3455be440da077a7138c3af1b822a6f11f232cc6c420621cea8d06552
-  data.tar.gz: 6d84e7c23687b56076c2b9aef18e1f801dbf471ce2fd3e5f216f62016c33656152c7634d3d6d0fa95c9b15181d6f1b05196c225301da0c5ec184a1e136375e73
+  metadata.gz: 7665a15f2b3ce79f5b7314068d58e1534e2dea35ee6268bbb2921a804972f8e366abe9d867e33fc4fd281d295f60ade7fac4903af263b5ab57fa88eba1fe29cf
+  data.tar.gz: 0cfaa9510dd5a81d68ba8205cdf497eb62f7983f2b03a645a0d1ebacd6eb4d4c30d13e5af09ea0f2b81e2d6a2687bd23d368b4e4d9b841d3633aff9a305cb991

data/README.md

@@ -281,7 +281,7 @@ timer.unit            # "minutes"
 
 ## Supported Cooklang Features
 
-- **Ingredients** (`@`): Single/multi-word names, quantities, units, preparation notes
+- **Ingredients** (`@`): Single/multi-word names, quantities, units, preparation notes, fixed quantities
 - **Cookware** (`#`): Single/multi-word names, quantities
 - **Timers** (`~`): Anonymous and named timers
 - **Comments**: Line (`--`) and block (`[- -]`) comments
@@ -289,6 +289,7 @@ timer.unit            # "minutes"
 - **Steps**: Paragraph-based with blank line separation
 - **Notes** (`>`): Standalone notes
 - **Sections** (`=`): Recipe sections with optional names
+- **Canonical Tests** Passes all [Cooklang canonical tests](https://github.com/cooklang/spec/blob/main/tests/canonical.yaml) as of version 7
 
 ### Not Yet Implemented
 

data/lib/cooklang/formatters/hash.rb

@@ -231,7 +231,9 @@ module Cooklang
 
       def format_ingredient_data
         recipe.ingredients.map do |ingredient|
-          if ingredient.quantity && ingredient.quantity != "some"
+          if ingredient.fixed?
+            "fixed"
+          elsif ingredient.quantity && ingredient.quantity != "some"
             "scaled"
           else
             "noQuantity"

data/lib/cooklang/ingredient.rb

@@ -2,13 +2,14 @@
 
 module Cooklang
   class Ingredient
-    attr_reader :name, :quantity, :unit, :notes
+    attr_reader :name, :quantity, :unit, :notes, :fixed
 
-    def initialize(name:, quantity: nil, unit: nil, notes: nil)
+    def initialize(name:, quantity: nil, unit: nil, notes: nil, fixed: false)
       @name = name.to_s.freeze
       @quantity = quantity
       @unit = unit&.to_s&.freeze
       @notes = notes&.to_s&.freeze
+      @fixed = fixed
     end
 
     def to_s
@@ -24,7 +25,8 @@ module Cooklang
         name: @name,
         quantity: @quantity,
         unit: @unit,
-        notes: @notes
+        notes: @notes,
+        fixed: @fixed
       }.compact
     end
 
@@ -34,7 +36,8 @@ module Cooklang
       name == other.name &&
         quantity == other.quantity &&
         unit == other.unit &&
-        notes == other.notes
+        notes == other.notes &&
+        fixed == other.fixed
     end
 
     def eql?(other)
@@ -42,7 +45,7 @@ module Cooklang
     end
 
     def hash
-      [name, quantity, unit, notes].hash
+      [name, quantity, unit, notes, fixed].hash
     end
 
     def has_quantity?
@@ -56,5 +59,9 @@ module Cooklang
     def has_notes?
       !@notes.nil?
     end
+
+    def fixed?
+      @fixed
+    end
   end
 end

data/lib/cooklang/lexer.rb

@@ -23,7 +23,7 @@ module Cooklang
       comment_block_start: "[-",
       comment_block_end: "-]",
       metadata_marker: ">>",
-      section_marker: "=",
+      equals: "=",
       note_marker: ">",
       newline: "\n",
       yaml_delimiter: "---"
@@ -50,7 +50,7 @@ module Cooklang
         elsif match_comment_block
         elsif match_comment_line
         elsif match_metadata_marker
-        elsif match_section_marker
+        elsif match_equals
         elsif match_note_marker
         elsif match_special_chars
         elsif match_newline
@@ -228,13 +228,13 @@ module Cooklang
         end
       end
 
-      def match_section_marker
+      def match_equals
         if @scanner.check(/=+/)
           position = current_position
           line = current_line
           column = current_column
           value = @scanner.scan(/=+/)
-          @tokens << Token.new(:section_marker, value, position, line, column)
+          @tokens << Token.new(:equals, value, position, line, column)
           advance_position(value)
           true
         else

data/lib/cooklang/parsers/ingredient_parser.rb

@@ -35,7 +35,7 @@ module Cooklang
           name = extract_name_until_brace(brace_index)
           @stream.consume(:open_brace) # Skip open brace
 
-          quantity, unit = extract_quantity_and_unit
+          quantity, unit, fixed = extract_quantity_and_unit
           @stream.consume(:close_brace) # Skip close brace
 
           notes = extract_notes
@@ -44,7 +44,7 @@ module Cooklang
           quantity = "some" if (quantity.nil? || quantity == "") && (unit.nil? || unit == "")
           unit = nil if unit == ""
 
-          Ingredient.new(name: name, quantity: quantity, unit: unit, notes: notes)
+          Ingredient.new(name: name, quantity: quantity, unit: unit, notes: notes, fixed: fixed)
         end
 
         def parse_simple_ingredient
@@ -85,8 +85,14 @@ module Cooklang
         def extract_quantity_and_unit
           quantity = nil
           unit = nil
+          fixed = false
           text_parts = []
 
+          if @stream.current&.type == :equals
+            fixed = true
+            @stream.consume
+          end
+
           while !@stream.eof? && @stream.current.type != :close_brace
             case @stream.current.type
             when :percent
@@ -106,6 +112,7 @@ module Cooklang
 
           if !text_parts.empty?
             combined_text = text_parts.join.strip
+
             if quantity.nil?
               # Try to parse as numeric quantity first, fallback to string if not purely numeric
               if combined_text.match?(/^\d+$/)
@@ -124,7 +131,7 @@ module Cooklang
             end
           end
 
-          [quantity, unit]
+          [quantity, unit, fixed]
         end
 
         def parse_quantity_value(text)

data/lib/cooklang/processors/step_processor.rb

@@ -96,7 +96,7 @@ module Cooklang
             when :open_brace, :close_brace, :open_paren, :close_paren, :percent
               builder.add_text(token.value)
               stream.consume
-            when :section_marker
+            when :equals # section marker (= or ==)
               process_section_with_stream(stream, builder)
             else
               stream.consume

data/lib/cooklang/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cooklang
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

data/spec/formatters/hash_spec.rb

@@ -60,4 +60,16 @@ RSpec.describe Cooklang::Formatters::Hash do
       expect(step_numbers).to eq((1..step_numbers.size).to_a)
     end
   end
+
+  describe "fixed quantities" do
+    let(:recipe) { Cooklang.parse("Add @salt{=1%tsp} and @flour{500%g} and @pepper.") }
+    let(:result) { described_class.new(recipe).generate }
+
+    it "marks fixed ingredients as 'fixed' in data section" do
+      ingredient_data = result[:data][:ingredients]
+
+      # salt is fixed, flour is scaled, pepper has no quantity
+      expect(ingredient_data).to eq(%w[fixed scaled noQuantity])
+    end
+  end
 end

data/spec/lexer_spec.rb

@@ -146,12 +146,12 @@ RSpec.describe Cooklang::Lexer do
       end
     end
 
-    context "with section markers" do
+    context "with equals (section markers)" do
       it "tokenizes single equals" do
         lexer = described_class.new("= Dough")
         tokens = lexer.tokenize
 
-        expect(tokens.map(&:type)).to eq(%i[section_marker text])
+        expect(tokens.map(&:type)).to eq(%i[equals text])
         expect(tokens.map(&:value)).to eq(["=", " Dough"])
       end
 
@@ -159,7 +159,7 @@ RSpec.describe Cooklang::Lexer do
         lexer = described_class.new("== Filling ==")
         tokens = lexer.tokenize
 
-        expect(tokens.map(&:type)).to eq(%i[section_marker text section_marker])
+        expect(tokens.map(&:type)).to eq(%i[equals text equals])
         expect(tokens.map(&:value)).to eq(["==", " Filling ", "=="])
       end
 
@@ -167,7 +167,7 @@ RSpec.describe Cooklang::Lexer do
         lexer = described_class.new("=== Section ===")
         tokens = lexer.tokenize
 
-        expect(tokens.map(&:type)).to eq(%i[section_marker text section_marker])
+        expect(tokens.map(&:type)).to eq(%i[equals text equals])
         expect(tokens.map(&:value)).to eq(["===", " Section ", "==="])
       end
     end

data/spec/models/ingredient_spec.rb

@@ -47,6 +47,20 @@ RSpec.describe Cooklang::Ingredient do
       expect(ingredient.notes).to eq("sifted")
       expect(ingredient.notes).to be_frozen
     end
+
+    it "defaults fixed to false" do
+      ingredient = described_class.new(name: "salt")
+
+      expect(ingredient.fixed).to be false
+      expect(ingredient.fixed?).to be false
+    end
+
+    it "accepts fixed parameter" do
+      ingredient = described_class.new(name: "salt", quantity: 1, unit: "tsp", fixed: true)
+
+      expect(ingredient.fixed).to be true
+      expect(ingredient.fixed?).to be true
+    end
   end
 
   describe "#to_s" do
@@ -94,16 +108,34 @@ RSpec.describe Cooklang::Ingredient do
         name: "flour",
         quantity: 125,
         unit: "g",
-        notes: "sifted"
+        notes: "sifted",
+        fixed: false
       }
 
       expect(ingredient.to_h).to eq(expected)
     end
 
-    it "omits nil attributes" do
+    it "omits nil attributes but includes fixed" do
       ingredient = described_class.new(name: "salt")
 
-      expect(ingredient.to_h).to eq({ name: "salt" })
+      expect(ingredient.to_h).to eq({ name: "salt", fixed: false })
+    end
+
+    it "includes fixed when true" do
+      ingredient = described_class.new(name: "salt", quantity: 1, unit: "tsp", fixed: true)
+
+      expect(ingredient.to_h).to eq({
+        name: "salt",
+        quantity: 1,
+        unit: "tsp",
+        fixed: true
+      })
+    end
+
+    it "includes fixed as false when not fixed" do
+      ingredient = described_class.new(name: "salt", quantity: 1, unit: "tsp", fixed: false)
+
+      expect(ingredient.to_h[:fixed]).to be false
     end
   end
 
@@ -129,6 +161,13 @@ RSpec.describe Cooklang::Ingredient do
       expect(ingredient1).not_to eq(ingredient2)
     end
 
+    it "returns false for ingredients with different fixed values" do
+      ingredient1 = described_class.new(name: "salt", quantity: 1, fixed: true)
+      ingredient2 = described_class.new(name: "salt", quantity: 1, fixed: false)
+
+      expect(ingredient1).not_to eq(ingredient2)
+    end
+
     it "returns false for non-Ingredient objects" do
       ingredient = described_class.new(name: "flour")
 
@@ -172,6 +211,23 @@ RSpec.describe Cooklang::Ingredient do
         expect(ingredient).not_to have_notes
       end
     end
+
+    describe "#fixed?" do
+      it "returns true when fixed is true" do
+        ingredient = described_class.new(name: "salt", quantity: 1, fixed: true)
+        expect(ingredient).to be_fixed
+      end
+
+      it "returns false when fixed is false" do
+        ingredient = described_class.new(name: "salt", quantity: 1, fixed: false)
+        expect(ingredient).not_to be_fixed
+      end
+
+      it "returns false by default" do
+        ingredient = described_class.new(name: "salt")
+        expect(ingredient).not_to be_fixed
+      end
+    end
   end
 
   describe "#hash" do

data/spec/parser_spec.rb

@@ -96,6 +96,73 @@ RSpec.describe Cooklang::Parser do
       end
     end
 
+    context "with fixed quantities" do
+      it "parses fixed quantity with unit" do
+        recipe = parser.parse("Season with @salt{=1%tsp}.")
+
+        expect(recipe.ingredients.size).to eq(1)
+        ingredient = recipe.ingredients.first
+        expect(ingredient.name).to eq("salt")
+        expect(ingredient.quantity).to eq(1)
+        expect(ingredient.unit).to eq("tsp")
+        expect(ingredient).to be_fixed
+      end
+
+      it "parses fixed quantity without unit" do
+        recipe = parser.parse("Add @eggs{=3} exactly.")
+
+        expect(recipe.ingredients.size).to eq(1)
+        ingredient = recipe.ingredients.first
+        expect(ingredient.name).to eq("eggs")
+        expect(ingredient.quantity).to eq(3)
+        expect(ingredient).to be_fixed
+      end
+
+      it "parses fixed quantity with space after equals" do
+        recipe = parser.parse("Add @salt{= 2%tsp}.")
+
+        ingredient = recipe.ingredients.first
+        expect(ingredient.quantity).to eq(2)
+        expect(ingredient.unit).to eq("tsp")
+        expect(ingredient).to be_fixed
+      end
+
+      it "parses fixed quantity with text value" do
+        recipe = parser.parse("Add @salt{=some%pinch}.")
+
+        ingredient = recipe.ingredients.first
+        expect(ingredient.quantity).to eq("some")
+        expect(ingredient.unit).to eq("pinch")
+        expect(ingredient).to be_fixed
+      end
+
+      it "parses fixed with no quantity as fixed with 'some'" do
+        recipe = parser.parse("Add @salt{=}.")
+
+        ingredient = recipe.ingredients.first
+        expect(ingredient.quantity).to eq("some")
+        expect(ingredient).to be_fixed
+      end
+
+      it "parses regular quantity as not fixed" do
+        recipe = parser.parse("Use @flour{500%g}.")
+
+        ingredient = recipe.ingredients.first
+        expect(ingredient).not_to be_fixed
+      end
+
+      it "parses mixed fixed and regular ingredients" do
+        recipe = parser.parse("Add @salt{=1%tsp} and @flour{500%g}.")
+
+        expect(recipe.ingredients.size).to eq(2)
+        salt = recipe.ingredients.find { |i| i.name == "salt" }
+        flour = recipe.ingredients.find { |i| i.name == "flour" }
+
+        expect(salt).to be_fixed
+        expect(flour).not_to be_fixed
+      end
+    end
+
     context "with cookware" do
       it "parses simple cookware" do
         recipe = parser.parse("Heat the #pan over medium heat.")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cooklang
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - James Brooks
@@ -197,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A Ruby parser for the Cooklang recipe markup language.
 test_files: