cooklang 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6695e5e9c9b98ec1aa80cd6cda05909fd39008454e3667761516365874a28054
-  data.tar.gz: 70d755aeed7e1ef4810d1a797a471740adaeddd5382a031abdf0e972a8f5a827
+  metadata.gz: 6e7756c185b6f5a4e57a8a1b018e9815db1c459f195eb70a9673979cd0e83d09
+  data.tar.gz: 7584f41ee1d0dc2639752e416a2b0d3627c234d0841de82a90bbabe4890c81a5
 SHA512:
-  metadata.gz: 7799cc3b498d4ebb8f519af4c3dbf50ced4618afe29a724cbfb83702bf95f52360e1e390bbb186d101bdf0e2a05eca30fcf5915e6007ca0c29bfaeb0b7df0abd
-  data.tar.gz: 04bafd2e069bbd3192ef617b15d3a71f3c951232053bf4a9b656d94c74814f9a46d59393ae11bc9a8ead3fc2b2758db61cd4b7e77aa75598dede89e51e5939dd
+  metadata.gz: 3cd10e971a12ec43d64d771dc63ca79f9b28af10675071348bed5b1f9889c7c5c21e135287cb2041a0bd998a05700572b72bd137b038a353140ca03c669c7d1d
+  data.tar.gz: d0aa1105e1d42bb36aec6ca1f07102851603a0c7abbace24c721813a341cd2e03455a27118c401c42ce97fb9082bfb849eb8824beddeea79e4f91411a33a7fcc

data/{LICENSE → LICENSE.txt}

@@ -1,6 +1,6 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2022 James Brooks
+Copyright (c) 2025 James Brooks
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,35 +1,124 @@
 # Cooklang
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cooklang`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A Ruby parser for the [Cooklang](https://cooklang.org) recipe markup language.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add to your Gemfile:
 
 ```ruby
 gem 'cooklang'
 ```
 
-And then execute:
+Or install directly:
+
+```bash
+gem install cooklang
+```
 
-    $ bundle install
+## Usage
 
-Or install it yourself as:
+```ruby
+require 'cooklang'
+
+recipe_text = <<~RECIPE
+  >> title: Pancakes
+  >> servings: 4
+
+  Crack @eggs{3} into a bowl, add @flour{125%g} and @milk{250%ml}.
+  
+  Heat #frying pan over medium heat for ~{5%minutes}.
+  Pour batter and cook until golden.
+RECIPE
+
+recipe = Cooklang.parse(recipe_text)
+
+# Access metadata
+recipe.metadata['title']        # => "Pancakes"
+recipe.metadata['servings']     # => 4
+
+# Access ingredients
+recipe.ingredients.each do |ingredient|
+  puts "#{ingredient.name}: #{ingredient.quantity} #{ingredient.unit}"
+end
+# => eggs: 3 
+# => flour: 125 g
+# => milk: 250 ml
+
+# Parse from file
+recipe = Cooklang.parse_file('pancakes.cook')
+
+# Format as text
+formatter = Cooklang::Formatters::Text.new(recipe)
+puts formatter.to_s
+# Ingredients:
+#     eggs        3
+#     flour       125 g
+#     milk        250 ml
+#
+# Steps:
+#     1. Crack eggs into a bowl, add flour and milk.
+#     2. Heat frying pan over medium heat for 5 minutes.
+#     3. Pour batter and cook until golden.
+```
 
-    $ gem install cooklang
+## API
 
-## Usage
+```ruby
+# Recipe object
+recipe.metadata         # Hash of metadata
+recipe.ingredients      # Array of Ingredient objects
+recipe.cookware         # Array of Cookware objects  
+recipe.timers           # Array of Timer objects
+recipe.steps            # Array of Step objects
+recipe.steps_text       # Array of plain text steps
+
+# Ingredient
+ingredient.name         # "flour"
+ingredient.quantity     # 125
+ingredient.unit         # "g"
+ingredient.notes        # "sifted"
+
+# Cookware
+cookware.name          # "frying pan"
+cookware.quantity      # 1
+
+# Timer
+timer.name            # "pasta"
+timer.duration        # 10
+timer.unit            # "minutes"
+```
+
+## Cooklang Syntax
 
-TODO: Write usage instructions here
+- **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
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+# Install dependencies
+bundle install
+
+# Run tests  
+bundle exec rspec
+
+# Run linter
+bundle exec rubocop
+```
+
+## Resources
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- [Cooklang Website](https://cooklang.org)
+- [Language Specification](https://cooklang.org/docs/spec/)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cooklang.
+Bug reports and pull requests welcome on GitHub.
+
+## License
+
+MIT License

data/lib/cooklang/cookware.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Cooklang
+  class Cookware
+    attr_reader :name, :quantity
+
+    def initialize(name:, quantity: nil)
+      @name = name.to_s.freeze
+      @quantity = quantity
+    end
+
+    def to_s
+      result = @name
+      result += " (#{@quantity})" if @quantity
+      result
+    end
+
+    def to_h
+      {
+        name: @name,
+        quantity: @quantity
+      }.compact
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Cookware)
+
+      name == other.name && quantity == other.quantity
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      [name, quantity].hash
+    end
+
+    def has_quantity?
+      !@quantity.nil?
+    end
+  end
+end

data/lib/cooklang/formatter.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Cooklang
+  class Formatter
+    attr_reader :recipe
+
+    def initialize(recipe)
+      @recipe = recipe
+    end
+
+    def to_s
+      raise NotImplementedError, "Subclasses must implement #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/text.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "../formatter"
+
+module Cooklang
+  module Formatters
+    class Text < Formatter
+      def to_s
+        sections = []
+
+        sections << ingredients_section unless recipe.ingredients.empty?
+        sections << steps_section unless recipe.steps.empty?
+
+        sections.join("\n").strip
+      end
+    end
+  end
+end

data/lib/cooklang/ingredient.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Cooklang
+  class Ingredient
+    attr_reader :name, :quantity, :unit, :notes
+
+    def initialize(name:, quantity: nil, unit: nil, notes: nil)
+      @name = name.to_s.freeze
+      @quantity = quantity
+      @unit = unit&.to_s&.freeze
+      @notes = notes&.to_s&.freeze
+    end
+
+    def to_s
+      result = @name
+      result += " #{@quantity}" if @quantity
+      result += " #{@unit}" if @unit
+      result += " (#{@notes})" if @notes
+      result
+    end
+
+    def to_h
+      {
+        name: @name,
+        quantity: @quantity,
+        unit: @unit,
+        notes: @notes
+      }.compact
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Ingredient)
+
+      name == other.name &&
+        quantity == other.quantity &&
+        unit == other.unit &&
+        notes == other.notes
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      [name, quantity, unit, notes].hash
+    end
+
+    def has_quantity?
+      !@quantity.nil?
+    end
+
+    def has_unit?
+      !@unit.nil?
+    end
+
+    def has_notes?
+      !@notes.nil?
+    end
+  end
+end

data/lib/cooklang/lexer.rb

@@ -0,0 +1,291 @@
+# frozen_string_literal: true
+
+require "strscan"
+
+module Cooklang
+  Token = Struct.new(:type, :value, :position, :line, :column) do
+    def initialize(type, value, position = 0, line = 1, column = 1)
+      super
+    end
+  end
+
+  class Lexer
+    TOKENS = {
+      ingredient_marker: "@",
+      cookware_marker: "#",
+      timer_marker: "~",
+      open_brace: "{",
+      close_brace: "}",
+      open_paren: "(",
+      close_paren: ")",
+      percent: "%",
+      comment_line: "--",
+      comment_block_start: "[-",
+      comment_block_end: "-]",
+      metadata_marker: ">>",
+      section_marker: "=",
+      note_marker: ">",
+      newline: "\n",
+      yaml_delimiter: "---"
+    }.freeze
+
+    def initialize(input)
+      @input = input
+      @scanner = StringScanner.new(input)
+      @line = 1
+      @column = 1
+      @tokens = []
+    end
+
+    def tokenize
+      @tokens = []
+
+      until @scanner.eos?
+        if match_yaml_delimiter
+          # Handle YAML front matter
+        elsif match_comment_block
+          # Handle block comments
+        elsif match_comment_line
+          # Handle line comments
+        elsif match_metadata_marker
+          # Handle >> metadata
+        elsif match_section_marker
+          # Handle = section markers
+        elsif match_note_marker
+          # Handle > note markers (only if not part of >>)
+        elsif match_special_chars
+          # Handle single character tokens
+        elsif match_newline
+          # Handle newlines
+        elsif match_text
+          # Handle plain text
+        elsif match_hyphen
+          # Handle single hyphens that aren't part of comments
+        else
+          # Skip unrecognized characters
+          advance_position(@scanner.getch)
+        end
+      end
+
+      @tokens
+    end
+
+    private
+      def current_position
+        @scanner.pos
+      end
+
+      def current_line
+        @line
+      end
+
+      def current_column
+        @column
+      end
+
+      def advance_position(text)
+        text.each_char do |char|
+          if char == "\n"
+            @line += 1
+            @column = 1
+          else
+            @column += 1
+          end
+        end
+      end
+
+      def add_token(type, value)
+        position = current_position
+        line = current_line
+        column = current_column
+        @tokens << Token.new(type, value, position, line, column)
+        advance_position(value)
+      end
+
+      def capture_single_char_token(type)
+        position = current_position
+        line = current_line
+        column = current_column
+        value = @scanner.getch
+        @tokens << Token.new(type, value, position, line, column)
+        advance_position(value)
+        true
+      end
+
+      def match_yaml_delimiter
+        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)
+          true
+        else
+          false
+        end
+      end
+
+      def match_comment_block
+        if @scanner.check(/\[-/)
+          position = current_position
+          line = current_line
+          column = current_column
+          @scanner.scan("[-")
+          @tokens << Token.new(:comment_block_start, "[-", position, line, column)
+          advance_position("[-")
+
+          # Scan until block end or EOF
+          content = ""
+          content += @scanner.getch while !@scanner.eos? && !@scanner.check(/-\]/)
+
+          add_token(:text, content) unless content.empty?
+
+          if @scanner.check(/-\]/)
+            position = current_position
+            line = current_line
+            column = current_column
+            @scanner.scan("-]")
+            @tokens << Token.new(:comment_block_end, "-]", position, line, column)
+            advance_position("-]")
+          end
+
+          true
+        else
+          false
+        end
+      end
+
+      def match_comment_line
+        if @scanner.check(/--/)
+          position = current_position
+          line = current_line
+          column = current_column
+          value = @scanner.scan("--")
+          @tokens << Token.new(:comment_line, value, position, line, column)
+          advance_position(value)
+
+          # Scan rest of line
+          line_content = @scanner.scan(/[^\n]*/)
+          add_token(:text, line_content) if line_content && !line_content.empty?
+
+          true
+        else
+          false
+        end
+      end
+
+      def match_metadata_marker
+        if @scanner.check(/>>/)
+          position = current_position
+          line = current_line
+          column = current_column
+          value = @scanner.scan(">>")
+          @tokens << Token.new(:metadata_marker, value, position, line, column)
+          advance_position(value)
+          true
+        else
+          false
+        end
+      end
+
+      def match_section_marker
+        if @scanner.check(/=+/)
+          position = current_position
+          line = current_line
+          column = current_column
+          value = @scanner.scan(/=+/)
+          @tokens << Token.new(:section_marker, value, position, line, column)
+          advance_position(value)
+          true
+        else
+          false
+        end
+      end
+
+      def match_note_marker
+        # Only match > if it's not part of >>
+        if @scanner.check(/>/) && !@scanner.check(/>>/)
+          position = current_position
+          line = current_line
+          column = current_column
+          value = @scanner.scan(">")
+          @tokens << Token.new(:note_marker, value, position, line, column)
+          advance_position(value)
+          true
+        else
+          false
+        end
+      end
+
+      def match_special_chars
+        char = @scanner.check(/./)
+
+        case char
+        when "@"
+          capture_single_char_token(:ingredient_marker)
+        when "#"
+          capture_single_char_token(:cookware_marker)
+        when "~"
+          capture_single_char_token(:timer_marker)
+        when "{"
+          capture_single_char_token(:open_brace)
+        when "}"
+          capture_single_char_token(:close_brace)
+        when "("
+          capture_single_char_token(:open_paren)
+        when ")"
+          capture_single_char_token(:close_paren)
+        when "%"
+          capture_single_char_token(:percent)
+        else
+          false
+        end
+      end
+
+      def match_newline
+        if @scanner.check(/\n/)
+          position = current_position
+          line = current_line
+          column = current_column
+          value = @scanner.scan("\n")
+          @tokens << Token.new(:newline, value, position, line, column)
+          advance_position(value)
+          true
+        else
+          false
+        end
+      end
+
+      def match_text
+        # Match any text that's not a special character, including spaces and tabs
+        # Exclude [ and ] to allow block comment detection
+        # Exclude = and > to allow section and note markers
+        if @scanner.check(/[^@#~{}()%\n\-\[\]=>]+/)
+          position = current_position
+          line = current_line
+          column = current_column
+          text = @scanner.scan(/[^@#~{}()%\n\-\[\]=>]+/)
+          @tokens << Token.new(:text, text, position, line, column)
+          advance_position(text)
+          true
+        else
+          false
+        end
+      end
+
+      def match_hyphen
+        if @scanner.check(/-/) && !@scanner.check(/--/)
+          position = current_position
+          line = current_line
+          column = current_column
+          @scanner.scan("-")
+          @tokens << Token.new(:hyphen, "-", position, line, column)
+          advance_position("-")
+          true
+        else
+          false
+        end
+      end
+  end
+end