cooklang 0.1.0 → 1.0.0

data/lib/cooklang/recipe.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Cooklang
+  class Recipe
+    attr_reader :ingredients, :cookware, :timers, :steps, :metadata, :sections, :notes
+
+    def initialize(ingredients:, cookware:, timers:, steps:, metadata:, sections: [], notes: [])
+      @ingredients = ingredients.freeze
+      @cookware = cookware.freeze
+      @timers = timers.freeze
+      @steps = steps.freeze
+      @metadata = metadata
+      @sections = sections.freeze
+      @notes = notes.freeze
+    end
+
+    def ingredients_hash
+      @ingredients.each_with_object({}) do |ingredient, hash|
+        hash[ingredient.name] = {
+          quantity: ingredient.quantity,
+          unit: ingredient.unit
+        }.compact
+      end
+    end
+
+    def steps_text
+      @steps.map(&:to_text)
+    end
+
+    def to_h
+      {
+        ingredients: @ingredients.map(&:to_h),
+        cookware: @cookware.map(&:to_h),
+        timers: @timers.map(&:to_h),
+        steps: @steps.map(&:to_h),
+        metadata: @metadata.to_h,
+        sections: @sections.map(&:to_h),
+        notes: @notes.map(&:to_h)
+      }
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Recipe)
+
+      ingredients == other.ingredients &&
+        cookware == other.cookware &&
+        timers == other.timers &&
+        steps == other.steps &&
+        metadata == other.metadata &&
+        sections == other.sections &&
+        notes == other.notes
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      [ingredients, cookware, timers, steps, metadata].hash
+    end
+  end
+end

data/lib/cooklang/section.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Cooklang
+  class Section
+    attr_reader :name, :steps
+
+    def initialize(name:, steps: [])
+      @name = name&.to_s&.freeze
+      @steps = steps.freeze
+    end
+
+    def to_s
+      name || "Section"
+    end
+
+    def to_h
+      {
+        name: name,
+        steps: steps.map(&:to_h)
+      }.compact
+    end
+
+    def ==(other)
+      other.is_a?(Section) &&
+        name == other.name &&
+        steps == other.steps
+    end
+
+    def hash
+      [name, steps].hash
+    end
+  end
+end

data/lib/cooklang/step.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Cooklang
+  class Step
+    attr_reader :segments
+
+    def initialize(segments:)
+      @segments = segments.freeze
+    end
+
+    def to_text
+      @segments.map do |segment|
+        case segment
+        when Hash
+          case segment[:type]
+          when :ingredient
+            segment[:name]
+          when :cookware
+            segment[:name]
+          when :timer
+            segment[:name] || "timer"
+          else
+            segment[:value] || ""
+          end
+        when String
+          segment
+        when Ingredient
+          segment.name
+        when Cookware
+          segment.name
+        when Timer
+          if segment.name
+            "#{segment.name} for #{segment.duration} #{segment.unit}"
+          elsif segment.duration && segment.unit
+            "for #{segment.duration} #{segment.unit}"
+          else
+            "timer"
+          end
+        else
+          segment.to_s
+        end
+      end.join.rstrip
+    end
+
+    def to_h
+      {
+        segments: @segments
+      }
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Step)
+
+      segments == other.segments
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      segments.hash
+    end
+
+    def ingredients_used
+      @segments.filter_map { |segment| segment[:name] if segment.is_a?(Hash) && segment[:type] == :ingredient }
+    end
+
+    def cookware_used
+      @segments.filter_map { |segment| segment[:name] if segment.is_a?(Hash) && segment[:type] == :cookware }
+    end
+
+    def timers_used
+      @segments.select { |segment| segment.is_a?(Hash) && segment[:type] == :timer }
+    end
+
+    def has_ingredients?
+      ingredients_used.any?
+    end
+
+    def has_cookware?
+      cookware_used.any?
+    end
+
+    def has_timers?
+      timers_used.any?
+    end
+  end
+end

data/lib/cooklang/timer.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Cooklang
+  class Timer
+    attr_reader :name, :duration, :unit
+
+    def initialize(duration:, unit:, name: nil)
+      @name = name&.to_s&.freeze
+      @duration = duration
+      @unit = unit.to_s.freeze
+    end
+
+    def to_s
+      result = ""
+      result += "#{@name}: " if @name
+      result += "#{@duration} #{@unit}"
+      result
+    end
+
+    def to_h
+      {
+        name: @name,
+        duration: @duration,
+        unit: @unit
+      }.compact
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Timer)
+
+      name == other.name &&
+        duration == other.duration &&
+        unit == other.unit
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      [name, duration, unit].hash
+    end
+
+    def total_seconds
+      case @unit.downcase
+      when "second", "seconds", "sec", "s"
+        @duration
+      when "minute", "minutes", "min", "m"
+        @duration * 60
+      when "hour", "hours", "hr", "h"
+        @duration * 3600
+      when "day", "days", "d"
+        @duration * 86_400
+      else
+        @duration
+      end
+    end
+
+    def has_name?
+      !@name.nil?
+    end
+  end
+end

data/lib/cooklang/version.rb

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

data/lib/cooklang.rb

@@ -1,8 +1,29 @@
 # frozen_string_literal: true
 
 require_relative "cooklang/version"
+require_relative "cooklang/lexer"
+require_relative "cooklang/parser"
+require_relative "cooklang/recipe"
+require_relative "cooklang/ingredient"
+require_relative "cooklang/cookware"
+require_relative "cooklang/timer"
+require_relative "cooklang/step"
+require_relative "cooklang/metadata"
+require_relative "cooklang/section"
+require_relative "cooklang/note"
+require_relative "cooklang/formatter"
+require_relative "cooklang/formatters/text"
 
 module Cooklang
   class Error < StandardError; end
-  # Your code goes here...
+  class ParseError < Error; end
+
+  def self.parse(input)
+    parser = Parser.new
+    parser.parse(input)
+  end
+
+  def self.parse_file(file_path)
+    parse(File.read(file_path))
+  end
 end

metadata

@@ -1,84 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: cooklang
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - James Brooks
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.23'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.23'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-description:
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+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.
 email:
 - james@jamesbrooks.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
-- ".ruby-version"
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
-- LICENSE
+- LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/cooklang.rb
+- lib/cooklang/cookware.rb
+- lib/cooklang/formatter.rb
+- lib/cooklang/formatters/text.rb
+- lib/cooklang/ingredient.rb
+- lib/cooklang/lexer.rb
+- lib/cooklang/metadata.rb
+- lib/cooklang/note.rb
+- lib/cooklang/parser.rb
+- lib/cooklang/recipe.rb
+- lib/cooklang/section.rb
+- lib/cooklang/step.rb
+- lib/cooklang/timer.rb
 - lib/cooklang/version.rb
-homepage: https://github.com/jamesbrooks/cooklang-rb
-licenses: []
+homepage: https://github.com/jamesbrooks/cooklang
+licenses:
+- MIT
 metadata:
-  homepage_uri: https://github.com/jamesbrooks/cooklang-rb
-  source_code_uri: https://github.com/jamesbrooks/cooklang-rb
-  changelog_uri: https://github.com/jamesbrooks/cooklang-rb/CHANGELOG.md
+  homepage_uri: https://github.com/jamesbrooks/cooklang
+  source_code_uri: https://github.com/jamesbrooks/cooklang
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,15 +48,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.5
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
-summary: Ruby library for working with Cooklang
+summary: A Ruby parser for the Cooklang recipe markup language.
 test_files: []

data/.rubocop.yml

@@ -1,126 +0,0 @@
-require:
-  - rubocop-performance
-  - rubocop-rspec
-
-AllCops:
-  TargetRubyVersion: 2.7.5
-  NewCops: enable
-
-Bundler/OrderedGems:
-  Enabled: false
-
-Layout/AccessModifierIndentation:
-  EnforcedStyle: outdent
-
-Layout/CaseIndentation:
-  EnforcedStyle: end
-
-Layout/EmptyLinesAroundAccessModifier:
-  EnforcedStyle: only_before
-
-Layout/EndAlignment:
-  EnforcedStyleAlignWith: variable
-
-Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/LineLength:
-  Max: 120
-
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-
-Layout/SpaceInsideArrayLiteralBrackets:
-  EnforcedStyle: space
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false # with constructing a lot of bulky hashes this cop becomes noisy
-
-Metrics/ParameterLists:
-  CountKeywordArgs: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Naming/AccessorMethodName:
-  Enabled: false
-
-Naming/InclusiveLanguage:
-  Enabled: false
-
-RSpec/EmptyLineAfterSubject:
-  Enabled: false
-
-RSpec/ExampleLength:
-  Max: 10
-
-RSpec/MultipleSubjects:
-  Enabled: false
-
-Style/AndOr:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/ConditionalAssignment:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/GuardClause:
-  Enabled: false
-
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: false
-
-Style/HashTransformValues:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Style/IfWithBooleanLiteralBranches:
-  Enabled: false
-
-Style/Lambda:
-  Enabled: false
-
-Style/QuotedSymbols:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/SymbolArray:
-  Enabled: false
-
-Style/WordArray:
-  Enabled: false

data/.ruby-version

@@ -1 +0,0 @@
-2.7.5

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2022-03-08
-
-- Initial release

data/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in cooklang.gemspec
-gemspec

data/Gemfile.lock

@@ -1,45 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cooklang (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    parallel (1.21.0)
-    parser (3.1.1.0)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    regexp_parser (2.2.1)
-    rexml (3.2.5)
-    rubocop (1.25.1)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 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)
-
-PLATFORMS
-  x86_64-darwin-21
-
-DEPENDENCIES
-  cooklang!
-  rubocop (~> 1.23)
-  rubocop-performance (~> 1.12)
-  rubocop-rspec (~> 2.6)
-
-BUNDLED WITH
-   2.2.33

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: :rubocop

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "cooklang"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here