cooklang 1.0.0 → 1.0.2

data/README.md

@@ -1,5 +1,10 @@
 # Cooklang
 
+![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)
+
 A Ruby parser for the [Cooklang](https://cooklang.org) recipe markup language.
 
 ## Installation
@@ -26,7 +31,7 @@ recipe_text = <<~RECIPE
   >> 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
@@ -41,25 +46,200 @@ recipe.metadata['servings']     # => 4
 recipe.ingredients.each do |ingredient|
   puts "#{ingredient.name}: #{ingredient.quantity} #{ingredient.unit}"
 end
-# => eggs: 3 
+# => eggs: 3
 # => flour: 125 g
 # => milk: 250 ml
 
 # Parse from file
 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:
+
+```ruby
+>> title: Uncle Roger's Fried Rice
+>> servings: 2
+>> prep_time: 10 minutes
+>> cook_time: 8 minutes
+
+Heat @peanut oil{1%tbsp} in #wok over high heat until smoking.
+
+Add @garlic{3%cloves}(minced) and @shallots{2}(diced), stir-fry for ~{30%seconds}.
+
+Add @eggs{3}(beaten) and scramble until almost set.
+
+Add @day-old rice{3%cups} and stir-fry, breaking up clumps for ~{2%minutes}.
+
+Season with @soy sauce{2%tbsp}, @sesame oil{1%tbsp}, @msg{1%tsp}, and @white pepper{0.5%tsp}.
+
+Add @spring onions{3%stalks}(chopped) and stir for ~{30%seconds} more.
+
+Serve immediately while hot!
+```
+
+### Text Formatter
+Human-readable format with ingredients list and numbered steps:
+
+Usage: `Cooklang::Formatters::Text.new(recipe).generate`
+
+```
+Ingredients:
+    peanut oil       1 tbsp
+    garlic           3 cloves
+    shallots         2
+    eggs             3
+    day-old rice     3 cups
+    soy sauce        2 tbsp
+    sesame oil       1 tbsp
+    msg              1 tsp
+    white pepper     0.5 tsp
+    spring onions    3 stalks
+
+Steps:
+    1. Heat peanut oil in wok over high heat until smoking.
+    2. Add garlic and shallots, stirfry for for 30 seconds.
+    3. Add eggs and scramble until almost set.
+    4. Add day-old rice and stirfry, breaking up clumps for for 2 minutes.
+    5. Season with soy sauce, sesame oil, msg, and white pepper.
+    6. Add spring onions and stir for for 30 seconds more.
+    7. Serve immediately while hot!
+```
+
+### Hash Formatter
+Structured Ruby hash format compatible with Cook CLI:
+
+Usage: `Cooklang::Formatters::Hash.new(recipe).generate`
+
+```ruby
+{:metadata=>
+  {:map=>
+    {"title"=>"Uncle Roger's Fried Rice",
+     "servings"=>"2",
+     "prep_time"=>"10 minutes",
+     "cook_time"=>"8 minutes"}},
+ :sections=>
+  [{:name=>nil,
+    :content=>
+     [{:type=>"step",
+       :value=>
+        {:items=>
+          [{:type=>"text", :value=>"Heat "},
+           {:type=>"ingredient", :index=>0},
+           {:type=>"text", :value=>" in "},
+           {:type=>"cookware", :index=>0},
+           {:type=>"text", :value=>" over high heat until smoking."}],
+         :number=>1}},
+      {:type=>"step",
+       :value=>
+        {:items=>
+          [{:type=>"text", :value=>"Add "},
+           {:type=>"ingredient", :index=>1},
+           {:type=>"text", :value=>" and "},
+           {:type=>"ingredient", :index=>2},
+           {:type=>"text", :value=>" and stir for "},
+           {:type=>"timer", :index=>0}],
+         :number=>2}}]}],
+ :ingredients=>
+  [{:name=>"peanut oil",
+    :quantity=>
+     {:value=>{:type=>"number", :value=>{:type=>"regular", :value=>1.0}},
+      :unit=>"tbsp"}},
+   {:name=>"garlic",
+    :quantity=>
+     {:value=>{:type=>"number", :value=>{:type=>"regular", :value=>3.0}},
+      :unit=>"cloves"},
+    :note=>"minced"},
+   {:name=>"spring onions",
+    :quantity=>
+     {:value=>{:type=>"number", :value=>{:type=>"regular", :value=>3.0}},
+      :unit=>"stalks"},
+    :note=>"chopped"}],
+ :cookware=>[{:name=>"wok"}],
+ :timers=>
+  [{:quantity=>
+     {:value=>{:type=>"number", :value=>{:type=>"regular", :value=>30.0}},
+      :unit=>"seconds"}},
+   {:quantity=>
+     {:value=>{:type=>"number", :value=>{:type=>"regular", :value=>2.0}},
+      :unit=>"minutes"}}]}
+```
 
-# 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.
+### JSON Formatter
+JSON string format for APIs and data interchange:
+
+Usage: `Cooklang::Formatters::Json.new(recipe).generate`
+
+```json
+{
+  "metadata": {
+    "map": {
+      "title": "Uncle Roger's Fried Rice",
+      "servings": "2",
+      "prep_time": "10 minutes",
+      "cook_time": "8 minutes"
+    }
+  },
+  "sections": [
+    {
+      "name": null,
+      "content": [
+        {
+          "type": "step",
+          "value": {
+            "items": [
+              {"type": "text", "value": "Heat "},
+              {"type": "ingredient", "index": 0},
+              {"type": "text", "value": " in "},
+              {"type": "cookware", "index": 0},
+              {"type": "text", "value": " over high heat until smoking."}
+            ],
+            "number": 1
+          }
+        },
+        {
+          "type": "step",
+          "value": {
+            "items": [
+              {"type": "text", "value": "Add "},
+              {"type": "ingredient", "index": 1},
+              {"type": "text", "value": " and stir for "},
+              {"type": "timer", "index": 0}
+            ],
+            "number": 2
+          }
+        }
+      ]
+    }
+  ],
+  "ingredients": [
+    {
+      "name": "peanut oil",
+      "quantity": {
+        "value": {"type": "number", "value": {"type": "regular", "value": 1.0}},
+        "unit": "tbsp"
+      }
+    },
+    {
+      "name": "garlic",
+      "quantity": {
+        "value": {"type": "number", "value": {"type": "regular", "value": 3.0}},
+        "unit": "cloves"
+      },
+      "note": "minced"
+    }
+  ],
+  "cookware": [{"name": "wok"}],
+  "timers": [
+    {
+      "quantity": {
+        "value": {"type": "number", "value": {"type": "regular", "value": 30.0}},
+        "unit": "seconds"
+      }
+    }
+  ]
+}
 ```
 
 ## API
@@ -68,7 +248,7 @@ puts formatter.to_s
 # Recipe object
 recipe.metadata         # Hash of metadata
 recipe.ingredients      # Array of Ingredient objects
-recipe.cookware         # Array of Cookware 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
@@ -103,7 +283,7 @@ timer.unit            # "minutes"
 # Install dependencies
 bundle install
 
-# Run tests  
+# Run tests
 bundle exec rspec
 
 # Run linter
@@ -121,4 +301,4 @@ Bug reports and pull requests welcome on GitHub.
 
 ## License
 
-MIT License
+MIT License

data/Rakefile

@@ -0,0 +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: %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,60 @@
+# frozen_string_literal: true
+
+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,74 @@
+# frozen_string_literal: true
+
+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/formatter.rb

@@ -8,8 +8,12 @@ module Cooklang
       @recipe = recipe
     end
 
-    def to_s
-      raise NotImplementedError, "Subclasses must implement #to_s"
+    def generate(*args)
+      raise NotImplementedError, "Subclasses must implement #generate"
+    end
+
+    def to_s(*args)
+      generate(*args).to_s
     end
 
     private