cooklang 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4a3402d1f6f0e5864c0e59c8f237f0d06ca9a469ef3783f51b49e48d2ab1adb
-  data.tar.gz: bba07497106184771d712868f8abaaca2538bff3b85278357ba8d62438e0d452
+  metadata.gz: 31ab63d47990eb2eaa6eb3dd09af9ba81d760cfbcfde937467f7060282195409
+  data.tar.gz: 2fb316c77fcfaabdc679943997cfa68607d0dbf61599def411743ff53be8f0a6
 SHA512:
-  metadata.gz: 9d89c0f9d7828567958e37b3b98f2318d5d69e6bb64b31ef2a1536a14e142c031143c798236e36da450dd5f1ac15370306fa2694ef8358cbe790358c621e642d
-  data.tar.gz: f1d1881eccc351da77bb473447e4b1eb8508d951ed71ad044e082bc8ed7ab92cbbbd8cb9904a996595db74b04ee91ef56896a9b3d75b1c12e51a39503d3615fc
+  metadata.gz: 7665a15f2b3ce79f5b7314068d58e1534e2dea35ee6268bbb2921a804972f8e366abe9d867e33fc4fd281d295f60ade7fac4903af263b5ab57fa88eba1fe29cf
+  data.tar.gz: 0cfaa9510dd5a81d68ba8205cdf497eb62f7983f2b03a645a0d1ebacd6eb4d4c30d13e5af09ea0f2b81e2d6a2687bd23d368b4e4d9b841d3633aff9a305cb991

data/README.md

@@ -60,7 +60,7 @@ recipe = Cooklang.parse_file('pancakes.cook')
 
 ## Formatters
 
-The gem provides three built-in formatters for different output needs. Here's an example using Uncle Roger's Fried Rice recipe:
+The gem provides three built-in formatters for different output needs. Here's an example using this fried rice recipe:
 
 ```ruby
 >> title: Uncle Roger's Fried Rice
@@ -257,6 +257,12 @@ recipe.timers           # Array of Timer objects
 recipe.steps            # Array of Step objects
 recipe.steps_text       # Array of plain text steps
 
+# Metadata (Hash with string keys)
+recipe.metadata["title"]           # "Recipe Name"
+recipe.metadata["servings"]        # 4
+recipe.metadata["tags"]            # ["pasta", "italian"]
+recipe.metadata["custom_field"]    # Any value you set
+
 # Ingredient
 ingredient.name         # "flour"
 ingredient.quantity     # 125
@@ -273,13 +279,23 @@ timer.duration        # 10
 timer.unit            # "minutes"
 ```
 
-## Cooklang Syntax
+## Supported Cooklang Features
+
+- **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
+- **Metadata**: YAML front matter and inline metadata (`>>`)
+- **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
 
-- **Ingredients**: `@salt`, `@flour{125%g}`, `@onion{1}(diced)`
-- **Cookware**: `#pan`, `#mixing bowl{}`
-- **Timers**: `~{5%minutes}`, `~pasta{10%minutes}`
-- **Comments**: `-- line comment`, `[- block comment -]`
-- **Metadata**: `>> key: value` or YAML front matter
+- **Recipe References**: `@./path/to/recipe{}`
+- **Shopping Lists**: `aisle.txt` configuration files
+- **Images**: Convention-based image loading
 
 ## Development
 

data/lib/cooklang/formatter.rb

@@ -15,51 +15,5 @@ module Cooklang
     def to_s(*args)
       generate(*args).to_s
     end
-
-    private
-      def ingredients_section
-        return "" if recipe.ingredients.empty?
-
-        ingredient_lines = recipe.ingredients.map do |ingredient|
-          format_ingredient(ingredient)
-        end
-
-        "Ingredients:\n#{ingredient_lines.join("\n")}\n"
-      end
-
-      def steps_section
-        return "" if recipe.steps.empty?
-
-        step_lines = recipe.steps.each_with_index.map do |step, index|
-          "    #{index + 1}. #{step.to_text}"
-        end
-
-        "Steps:\n#{step_lines.join("\n")}\n"
-      end
-
-      def format_ingredient(ingredient)
-        name = ingredient.name
-        quantity_unit = format_quantity_unit(ingredient)
-
-        # Add 4 spaces after the longest ingredient name for alignment
-        name_width = max_ingredient_name_length + 4
-        "    #{name.ljust(name_width)}#{quantity_unit}"
-      end
-
-      def format_quantity_unit(ingredient)
-        if ingredient.quantity && ingredient.unit
-          "#{ingredient.quantity} #{ingredient.unit}"
-        elsif ingredient.quantity
-          ingredient.quantity.to_s
-        elsif ingredient.unit
-          ingredient.unit
-        else
-          "some"
-        end
-      end
-
-      def max_ingredient_name_length
-        @max_ingredient_name_length ||= recipe.ingredients.map(&:name).map(&:length).max || 0
-      end
   end
 end

data/lib/cooklang/formatters/hash.rb

@@ -18,7 +18,7 @@ module Cooklang
     private
       def format_metadata
         {
-          map: recipe.metadata.to_h.transform_values(&:to_s)
+          map: recipe.metadata.to_h
         }
       end
 
@@ -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/formatters/text.rb

@@ -11,6 +11,52 @@ module Cooklang
 
         sections.join("\n").strip
       end
+
+    private
+      def ingredients_section
+        return "" if recipe.ingredients.empty?
+
+        ingredient_lines = recipe.ingredients.map do |ingredient|
+          format_ingredient(ingredient)
+        end
+
+        "Ingredients:\n#{ingredient_lines.join("\n")}\n"
+      end
+
+      def steps_section
+        return "" if recipe.steps.empty?
+
+        step_lines = recipe.steps.each_with_index.map do |step, index|
+          "    #{index + 1}. #{step.to_text}"
+        end
+
+        "Steps:\n#{step_lines.join("\n")}\n"
+      end
+
+      def format_ingredient(ingredient)
+        name = ingredient.name
+        quantity_unit = format_quantity_unit(ingredient)
+
+        # Add 4 spaces after the longest ingredient name for alignment
+        name_width = max_ingredient_name_length + 4
+        "    #{name.ljust(name_width)}#{quantity_unit}"
+      end
+
+      def format_quantity_unit(ingredient)
+        if ingredient.quantity && ingredient.unit
+          "#{ingredient.quantity} #{ingredient.unit}"
+        elsif ingredient.quantity
+          ingredient.quantity.to_s
+        elsif ingredient.unit
+          ingredient.unit
+        else
+          "some"
+        end
+      end
+
+      def max_ingredient_name_length
+        @max_ingredient_name_length ||= recipe.ingredients.map(&:name).map(&:length).max || 0
+      end
     end
   end
 end

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: "---"
@@ -40,12 +40,17 @@ module Cooklang
     def tokenize
       @tokens = []
 
+      # Check for YAML frontmatter at the beginning
+      if @scanner.check(/^---/)
+        handle_yaml_frontmatter
+      end
+
       until @scanner.eos?
         if match_yaml_delimiter
         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
@@ -61,6 +66,50 @@ module Cooklang
     end
 
     private
+      def handle_yaml_frontmatter
+        # Emit the opening ---
+        position = current_position
+        line = current_line
+        column = current_column
+        value = @scanner.scan("---")
+        @tokens << Token.new(:yaml_delimiter, value, position, line, column)
+        advance_position(value)
+
+        # Scan until we find the closing --- or EOF
+        yaml_content = ""
+        until @scanner.eos?
+          if @scanner.check(/\n---\s*(\n|$)/)
+            # Found closing delimiter
+            # Add the newline before it
+            if @scanner.check(/\n/)
+              char = @scanner.getch
+              yaml_content += char
+              advance_position(char)
+            end
+            break
+          else
+            char = @scanner.getch
+            yaml_content += char
+            advance_position(char)
+          end
+        end
+
+        # Emit the YAML content as a single token if we have any
+        if !yaml_content.empty?
+          @tokens << Token.new(:yaml_content, yaml_content.rstrip, current_position, current_line, current_column)
+        end
+
+        # Emit the closing --- if present
+        if @scanner.check(/---/)
+          position = current_position
+          line = current_line
+          column = current_column
+          value = @scanner.scan("---")
+          @tokens << Token.new(:yaml_delimiter, value, position, line, column)
+          advance_position(value)
+        end
+      end
+
       def current_position
         @scanner.pos
       end
@@ -179,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/metadata.rb

@@ -30,69 +30,5 @@ module Cooklang
     def to_h
       super
     end
-
-    def servings
-      self["servings"]&.to_i
-    end
-
-    def servings=(value)
-      self["servings"] = value
-    end
-
-    def prep_time
-      self["prep_time"] || self["prep-time"]
-    end
-
-    def prep_time=(value)
-      self["prep_time"] = value
-    end
-
-    def cook_time
-      self["cook_time"] || self["cook-time"]
-    end
-
-    def cook_time=(value)
-      self["cook_time"] = value
-    end
-
-    def total_time
-      self["total_time"] || self["total-time"]
-    end
-
-    def total_time=(value)
-      self["total_time"] = value
-    end
-
-    def title
-      self["title"]
-    end
-
-    def title=(value)
-      self["title"] = value
-    end
-
-    def source
-      self["source"]
-    end
-
-    def source=(value)
-      self["source"] = value
-    end
-
-    def tags
-      value = self["tags"]
-      case value
-      when Array
-        value
-      when String
-        value.split(",").map(&:strip)
-      else
-        []
-      end
-    end
-
-    def tags=(value)
-      self["tags"] = value
-    end
   end
 end

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/metadata_processor.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "yaml"
+
 module Cooklang
   module Processors
     class MetadataProcessor
@@ -7,7 +9,6 @@ module Cooklang
         def extract_metadata(tokens)
           metadata = Metadata.new
           content_tokens = []
-          0
 
           # Check for YAML front matter
           if tokens.first&.type == :yaml_delimiter
@@ -26,32 +27,17 @@ module Cooklang
           def extract_yaml_frontmatter(tokens)
             metadata = Metadata.new
             i = 1 # Skip the first ---
-            yaml_content = []
-
-            # Find the closing --- delimiter
-            while i < tokens.length
-              if tokens[i].type == :yaml_delimiter
-                # Found closing delimiter
-                break
-              elsif tokens[i].type == :text
-                yaml_content << tokens[i].value
-              elsif tokens[i].type == :newline
-                yaml_content << "\n"
-              elsif tokens[i].type == :metadata_marker
-                yaml_content << ">>"
-              end
+
+            # Look for yaml_content token
+            if i < tokens.length && tokens[i].type == :yaml_content
+              yaml_text = tokens[i].value
+              parse_yaml_content(yaml_text, metadata) unless yaml_text.empty?
               i += 1
             end
 
             # Skip the closing --- if we found it
             i += 1 if i < tokens.length && tokens[i].type == :yaml_delimiter
 
-            # Parse YAML content if we have any
-            if yaml_content.any?
-              yaml_text = yaml_content.join.strip
-              parse_yaml_content(yaml_text, metadata) unless yaml_text.empty?
-            end
-
             # Return remaining tokens
             remaining_tokens = tokens[i..]
 
@@ -59,21 +45,15 @@ module Cooklang
           end
 
           def parse_yaml_content(yaml_text, metadata)
-            # Simple YAML parsing - split by lines and parse key-value pairs
-            yaml_text.split("\n").each do |line|
-              line = line.strip
-              next if line.empty? || line.start_with?("#")
-
-              if line.match(/^([^:]+):\s*(.*)$/)
-                key = ::Regexp.last_match(1).strip
-                value = ::Regexp.last_match(2).strip
+            # Fix malformed YAML with spaces before colon (non-standard YAML but permits the canonical test testMetadataMultiwordKeyWithSpaces to pass)
+            fixed_yaml = yaml_text.gsub(/^(\s*)([^:\n]+?)\s+:(\S)/, '\1\2: \3')
 
-                # Remove quotes if present
-                value = value.gsub(/^["']|["']$/, "") if value.match?(/^["'].*["']$/)
+            parsed = YAML.safe_load(fixed_yaml, permitted_classes: [Date, Time, DateTime])
 
-                # Parse numeric values
-                parsed_value = parse_metadata_value(value)
-                metadata[key] = parsed_value unless value.empty?
+            # Merge parsed YAML into metadata if it's a Hash
+            if parsed.is_a?(Hash)
+              parsed.each do |key, value|
+                metadata[key.to_s] = value
               end
             end
           end
@@ -88,7 +68,7 @@ module Cooklang
               if index + 1 < tokens.length && tokens[index + 1].type == :text
                 text = tokens[index + 1].value.strip
 
-                if text.match(/^([^:]+):\s*(.+)$/)
+                if text.match(/^([^:]+):\s*(.+?)[\n\\n]*$/)
                   key = ::Regexp.last_match(1).strip
                   value = ::Regexp.last_match(2).strip
 

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.3"
+  VERSION = "1.1.0"
 end

data/spec/fixtures/comprehensive_recipe.cook

@@ -0,0 +1,51 @@
+---
+title: Uncle Roger's Ultimate Fried Rice & Dumplings
+servings: 4
+prep_time: 15 minutes
+cook_time: 12 minutes
+difficulty: intermediate
+cuisine: Chinese
+dietary_restrictions: 
+  - can be made vegetarian
+  - gluten-free option available
+---
+
+[- This is a comprehensive recipe that tests all Cooklang features including
+   complex ingredients, cookware, timers, metadata, and various edge cases -]
+
+= Prep Work
+
+First, prepare all ingredients. Dice @shallots{2}(finely chopped) and mince @garlic{4%cloves}(crushed). 
+
+Beat @eggs{3}(room temperature) in a #mixing bowl{large}.
+
+= Main Cooking
+
+Heat @peanut oil{2%tbsp} and @sesame oil{1%tsp} in #wok{} over high heat for ~{2%minutes} until smoking.
+
+Add the diced shallots and garlic, stir-fry for ~{30%seconds}. -- This is critical timing!
+
+Pour in the beaten eggs and scramble for ~quick scramble{45%seconds} until just set.
+
+Add @day-old rice{3%cups}(broken up by hand) and stir-fry, breaking up any clumps for ~{2.5%minutes}.
+
+Season with @soy sauce{2%tbsp}, @fish sauce{1%tsp}, @msg{0.5%tsp}, and @white pepper{some}(to taste).
+
+Add @frozen peas{0.5%cup} and @spring onions{3%stalks}(chopped), cook for ~final timer{1%minute}.
+
+= Dumplings (Optional Side)
+
+For dumplings, prepare @dumpling wrappers{20} and @ground pork{300%g}(seasoned).
+
+Mix pork with @ginger{1%tbsp}(minced), @soy sauce{1%tbsp}, and @cornstarch{1%tsp}.
+
+Steam in #bamboo steamer{} for ~{15%minutes}.
+
+= Final Assembly 
+
+Serve immediately while hot! Garnish with @crispy shallots{some} and @cilantro{handful}(chopped).
+
+[- Note: The "some" quantities and decimal timers test edge cases in parsing -]
+
+-- Cooking tips: Use day-old rice for best texture
+-- Serving suggestion: Pair with jasmine tea

data/spec/formatters/formatter_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Cooklang::Formatter do
+  describe "#generate" do
+    let(:recipe) do
+      recipe_text = File.read(File.join(__dir__, "..", "fixtures", "comprehensive_recipe.cook"))
+      Cooklang.parse(recipe_text)
+    end
+    let(:formatter) { described_class.new(recipe) }
+
+    it "raises NotImplementedError for base class" do
+      expect { formatter.generate }.to raise_error(NotImplementedError, "Subclasses must implement #generate")
+    end
+  end
+
+  describe "#to_s" do
+    let(:recipe) do
+      recipe_text = File.read(File.join(__dir__, "..", "fixtures", "comprehensive_recipe.cook"))
+      Cooklang.parse(recipe_text)
+    end
+    let(:formatter) { described_class.new(recipe) }
+
+    it "calls generate.to_s but fails because generate raises" do
+      expect { formatter.to_s }.to raise_error(NotImplementedError, "Subclasses must implement #generate")
+    end
+  end
+end