cooklang 0.1.0 → 1.0.1

data/Gemfile.lock

@@ -1,45 +1,84 @@
 PATH
   remote: .
   specs:
-    cooklang (0.1.0)
+    cooklang (1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    parallel (1.21.0)
-    parser (3.1.1.0)
+    ast (2.4.3)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    json (2.13.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.9.0)
       ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    regexp_parser (2.2.1)
-    rexml (3.2.5)
-    rubocop (1.25.1)
+    rake (13.3.0)
+    regexp_parser (2.11.2)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.5)
+    rubocop (1.80.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.46.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.13.3)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.9.0)
-      rubocop (~> 1.19)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.46.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (3.1.5)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
 
 PLATFORMS
-  x86_64-darwin-21
+  arm64-darwin-24
+  ruby
 
 DEPENDENCIES
+  bundler (~> 2.7)
   cooklang!
-  rubocop (~> 1.23)
-  rubocop-performance (~> 1.12)
-  rubocop-rspec (~> 2.6)
+  rake (~> 13.0)
+  rspec (~> 3.13)
+  rubocop (~> 1.80)
+  rubocop-performance (~> 1.25)
+  rubocop-rspec (~> 3.6)
+  simplecov (~> 0.22.0)
 
 BUNDLED WITH
-   2.2.33
+   2.7.1

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,129 @@
 # 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.
+![Gem Version](https://img.shields.io/gem/v/cooklang)
+[![Test](https://github.com/jamesbrooks/cooklang/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/jamesbrooks/cooklang/actions/workflows/test.yml)
+[![Maintainability](https://qlty.sh/gh/jamesbrooks/projects/cooklang/maintainability.svg)](https://qlty.sh/gh/jamesbrooks/projects/cooklang)
+[![Code Coverage](https://qlty.sh/gh/jamesbrooks/projects/cooklang/coverage.svg)](https://qlty.sh/gh/jamesbrooks/projects/cooklang)
 
-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:
 
-    $ bundle install
+```bash
+gem install cooklang
+```
+
+## 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"
+```
 
-TODO: Write usage instructions here
+## Cooklang Syntax
+
+- **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
+```
 
-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).
+## Resources
+
+- [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/Rakefile

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
 require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: :rubocop
+task default: %i[spec rubocop]

data/cooklang.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cooklang/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "cooklang"
+  spec.version = Cooklang::VERSION
+  spec.authors = ["James Brooks"]
+  spec.email = ["james@jamesbrooks.net"]
+
+  spec.summary = "A Ruby parser for the Cooklang recipe markup language."
+  spec.description = "Cooklang is a markup language for recipes that allows you to define ingredients, cookware, timers, and metadata in a structured way. This gem provides a Ruby parser for Cooklang files."
+  spec.homepage = "https://github.com/jamesbrooks/cooklang"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jamesbrooks/cooklang"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.7"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.13"
+  spec.add_development_dependency "rubocop", "~> 1.80"
+  spec.add_development_dependency "rubocop-performance", "~> 1.25"
+  spec.add_development_dependency "rubocop-rspec", "~> 3.6"
+  spec.add_development_dependency "simplecov", "~> 0.22.0"
+end

data/lib/cooklang/builders/recipe_builder.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "../recipe"
+require_relative "../step"
+require_relative "../section"
+
+module Cooklang
+  module Builders
+    class RecipeBuilder
+      class << self
+        def build_recipe(parsed_steps, metadata)
+          # Aggregate all elements from steps
+          all_ingredients = []
+          all_cookware = []
+          all_timers = []
+          steps = []
+          sections = []
+
+          parsed_steps.each do |step_data|
+            all_ingredients.concat(step_data[:ingredients])
+            all_cookware.concat(step_data[:cookware])
+            all_timers.concat(step_data[:timers])
+
+            step = Step.new(segments: step_data[:segments])
+            steps << step
+
+            # Create section if this step has a section name
+            if step_data[:section_name]
+              sections << Section.new(name: step_data[:section_name], steps: [step])
+            end
+          end
+
+          # Deduplicate ingredients and cookware
+          unique_ingredients = deduplicate_ingredients(all_ingredients)
+          unique_cookware = deduplicate_cookware(all_cookware)
+
+          Recipe.new(
+            ingredients: unique_ingredients,
+            cookware: unique_cookware,
+            timers: all_timers,
+            steps: steps,
+            metadata: metadata,
+            sections: sections
+          )
+        end
+
+        private
+          def deduplicate_ingredients(ingredients)
+            # Group by name AND quantity to preserve different quantities of same ingredient
+            grouped = ingredients.group_by { |i| [i.name, i.quantity, i.unit] }
+            grouped.values.map(&:first)
+          end
+
+          def deduplicate_cookware(cookware_items)
+            # Group by name and prefer items with quantity over those without
+            cookware_items.group_by(&:name).map do |_name, items|
+              # Prefer items with quantity, then take the first one
+              items.find(&:quantity) || items.first
+            end
+          end
+      end
+    end
+  end
+end

data/lib/cooklang/builders/step_builder.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative "../step"
+
+module Cooklang
+  module Builders
+    class StepBuilder
+      def initialize
+        @segments = []
+        @ingredients = []
+        @cookware = []
+        @timers = []
+        @section_name = nil
+      end
+
+      def add_text(text)
+        @segments << text
+        self
+      end
+
+      def add_ingredient(ingredient)
+        @ingredients << ingredient
+        @segments << ingredient
+        self
+      end
+
+      def add_cookware(cookware)
+        @cookware << cookware
+        @segments << cookware
+        self
+      end
+
+      def add_timer(timer)
+        @timers << timer
+        @segments << timer
+        self
+      end
+
+      def add_remaining_text(text)
+        if text && !text.empty?
+          @segments << text
+        end
+        self
+      end
+
+      def set_section_name(name)
+        @section_name = name unless name&.empty?
+        self
+      end
+
+      def build
+        # Clean up segments - remove trailing newlines
+        cleaned_segments = remove_trailing_newlines(@segments.dup)
+
+        Step.new(segments: cleaned_segments)
+      end
+
+      # Check if the step has meaningful content
+      def has_content?
+        @segments.any? { |segment| segment != "\n" && !(segment.is_a?(String) && segment.strip.empty?) }
+      end
+
+      # Access internal collections for compatibility
+      attr_reader :segments, :ingredients, :cookware, :timers, :section_name
+
+      private
+        def remove_trailing_newlines(segments)
+          # Remove trailing newlines and whitespace-only text segments
+          segments.pop while !segments.empty? &&
+                            (segments.last == "\n" ||
+                             (segments.last.is_a?(String) && segments.last.strip.empty?))
+          segments
+        end
+    end
+  end
+end

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