cooklang_rb 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 369e119fc8519a25a662143c5101fa77a877c6621faae48829d1933522f2fdb9
-  data.tar.gz: 4223c5f8ac7cdfd7c350bcc243aa8c2d4daa2f2c7090d49395a64a852e58bbe6
+  metadata.gz: 2ac6cb408b8861e6c4fd4a2914fbf3f9963d73bec3709b8ba606f21b433b7718
+  data.tar.gz: 01ccce52c0abd3fedeb5475638ebf980eada4fa7fd16310a057b4d8f9f6a6587
 SHA512:
-  metadata.gz: d1f5b4a42b1e84b3aaaa535c51a134f618cf36c9dd65dbfced720775269330d0e3ac25815c35817f7d873d809ef4e0850397e49ff9862d88c0d523d83251c040
-  data.tar.gz: 857a2e1fc4681a8b844b596e0716ab0fc5eed0f66557428c4372d58ccfbd0b19f05d080642bd33cb5e2012bdae3aad32f39dc0b99c746e25dba452e3ea6a9823
+  metadata.gz: 4c475efce306341ed0d7bda2e5a58ba041d019ca6acd8a054804a9219e3718fea465416e2dba2014fa28afb061a6658cf9f380f17e5a9f88425031dd99c8915c
+  data.tar.gz: 9153d68be70eaf0fefd91621d0039565b05f171cb56ce9718a24cb0249e0a975d5c7815e8af85a4caf487dee7128c9d96d46e185846efdfd0fc1a79fd496cf6e

data/.github/workflows/main.yml

@@ -6,22 +6,22 @@ on:
       - '*'
   push:
     branches:
-      - master
+      - main
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ['2.5', '2.6', '2.7', '3.0']
+        ruby: ['3.3', '3.4', '4.0']
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
     - name: Run the default task
       run: |
-        gem install bundler -v 2.2.3
+        gem install bundler
         bundle install
         bundle exec rake

data/Gemfile.lock

@@ -1,21 +1,27 @@
 PATH
   remote: .
   specs:
-    cooklang_rb (0.2.0)
+    cooklang_rb (1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.15.0)
-    rake (13.0.6)
+    minitest (5.27.0)
+    rake (13.3.1)
 
 PLATFORMS
-  x86_64-darwin-20
+  arm64-darwin-25
+  ruby
 
 DEPENDENCIES
   cooklang_rb!
   minitest (~> 5.0)
   rake (~> 13.0)
 
+CHECKSUMS
+  cooklang_rb (1.0.0)
+  minitest (5.27.0) sha256=2d3b17f8a36fe7801c1adcffdbc38233b938eb0b4966e97a6739055a45fa77d5
+  rake (13.3.1) sha256=8c9e89d09f66a26a01264e7e3480ec0607f0c497a861ef16063604b1b08eb19c
+
 BUNDLED WITH
-   2.2.3
+  4.0.6

data/cooklang_rb.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "A cooklang parser for Ruby"
   spec.homepage      = "https://github.com/drbragg/cooklang_rb"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage

data/lib/cooklang_rb/buffer_utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BufferUtils
   def end_of_line?
     @buffer.peek(1) == "\n"

data/lib/cooklang_rb/cookware.rb

@@ -1,16 +1,22 @@
+# frozen_string_literal: true
+
 require_relative "tag"
+require_relative "with_units"
 
 module CooklangRb
   class Cookware < Tag
-    attr_reader :name, :quantity
+    include WithUnits
+
+    attr_reader :name, :quantity, :units
 
     def self.tag
       COOKWARE_TAG
     end
 
-    def initialize(name:, quantity:  1)
+    def initialize(name:, quantity: 1, units: "")
       @name = clean_name(name)
       @quantity = resolve_quantity(quantity, default: 1)
+      @units = clean_units(units)
     end
   end
 end

data/lib/cooklang_rb/ingredient.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "tag"
 require_relative "with_units"
 

data/lib/cooklang_rb/metadata.rb

@@ -1,29 +1,63 @@
+# frozen_string_literal: true
+
 module CooklangRb
   class Metadata
-    TAG = ">>".freeze
-    PATTERN = /^#{TAG}\s*(?<key>.+?):\s*(?<value>.+)\n/
+    DELIMITER = "---"
+    ENTRY_PATTERN = /^(?<key>.+?):\s*(?<value>.+)$/
 
-    def initialize(buffer)
-      @buffer = buffer
+    def initialize(source)
+      @source = source
       @metadata = {}
     end
 
     def parse
-      return @metadata unless @buffer.match? PATTERN
-
-      until @buffer.peek(2) != TAG
-        add_metadata
+      if valid_metadata_block?
+        extract_metadata
+        strip_metadata_block
+      else
+        collapse_invalid_delimiters
       end
 
-      @metadata
+      [@metadata, @source]
     end
 
     private
 
-    def add_metadata
-      @buffer.scan(PATTERN)
-      key, value = @buffer.captures.map(&:strip)
-      @metadata[key] = value
+    def valid_metadata_block?
+      @source.start_with?("#{DELIMITER}\n")
+    end
+
+    def extract_metadata
+      lines = metadata_lines
+      lines.each do |line|
+        match = line.match(ENTRY_PATTERN)
+        next unless match
+
+        @metadata[match[:key].strip] = match[:value].strip
+      end
+    end
+
+    def metadata_lines
+      closing = @source.index("\n#{DELIMITER}", DELIMITER.length)
+      return [] unless closing
+
+      block = @source[DELIMITER.length + 1...closing]
+      block.split("\n")
+    end
+
+    def strip_metadata_block
+      closing = @source.index("\n#{DELIMITER}", DELIMITER.length)
+      return unless closing
+
+      end_pos = closing + 1 + DELIMITER.length
+      end_pos += 1 if @source[end_pos] == "\n"
+      @source = @source[end_pos..]
+    end
+
+    def collapse_invalid_delimiters
+      @source = @source.gsub(/---\n(.*?\n)?---(?:\n|\z)/m) do |match|
+        match.tr("\n", " ").rstrip
+      end
     end
   end
 end

data/lib/cooklang_rb/quantity_resolver.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module QuantityResolver
   def resolve_quantity(quantity, default: "")
     return default if quantity.nil?
     return quantity if quantity.is_a? Numeric
 
-    quantity.strip! if quantity.respond_to?(:strip!)
+    quantity = quantity.strip if quantity.respond_to?(:strip)
 
     if quantity.include?(".")
       quantity.to_f

data/lib/cooklang_rb/recipe.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "strscan"
 
 require_relative "metadata"
@@ -15,7 +17,7 @@ module CooklangRb
     end
 
     def initialize(source)
-      @source = source
+      @source = source.dup
       @steps = []
       @metadata = {}
       parse
@@ -31,12 +33,11 @@ module CooklangRb
     private
 
     def parse
+      gather_metadata
       remove_comments
 
       @buffer = StringScanner.new(@source)
 
-      gather_metadata
-
       until end_of_buffer?
         parse_data
       end
@@ -44,7 +45,8 @@ module CooklangRb
 
     def remove_comments
       @source.gsub!(/\[-.*-\]/, "")
-      @source.gsub!(/--.*\n/, "\n")
+      @source.gsub!(/^[[:blank:]]*(?<!-)--(?!-).*\n/, "")
+      @source.gsub!(/(?<!-)--(?!-).*\n/, " ")
     end
 
     def parse_data
@@ -61,7 +63,7 @@ module CooklangRb
     end
 
     def gather_metadata
-      @metadata = Metadata.new(@buffer).parse
+      @metadata, @source = Metadata.new(@source).parse
     end
   end
 end

data/lib/cooklang_rb/step.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "ingredient"
 require_relative "cookware"
 require_relative "timer"

data/lib/cooklang_rb/steppable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Steppable
   def self.included(base)
     base.include InstanceMethods
@@ -6,7 +8,7 @@ module Steppable
 
   module InstanceMethods
     def to_step
-      data = { "type" => type }
+      data = {"type" => type}
       attributes.each do |key|
         data[key.to_s] = send key
       end
@@ -26,7 +28,7 @@ module Steppable
     def attr_reader(*vars)
       @attributes ||= []
       @attributes.concat vars
-      super(*vars)
+      super
     end
 
     def attributes

data/lib/cooklang_rb/tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "tag_parser"
 require_relative "steppable"
 require_relative "quantity_resolver"

data/lib/cooklang_rb/tag_parser.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module TagParser
-  NAME = "(?<name>[^\s]+)".freeze
-  MULTI_NAME = "(?<name>[^@#~{]+)".freeze
-  QUANTITY = "(?<quantity>[^%}]*)?".freeze
-  UNITS = "(?<units>[^}]+)?".freeze
-  TIMER_TAG = "~".freeze
-  INGREDIENT_TAG = "@".freeze
-  COOKWARE_TAG = "#".freeze
+  NAME = "(?<name>[^\\t\\n\\r\\f\\v\\p{Zs}\\p{P}]+)"
+  MULTI_NAME = "(?<name>[^@#~{]+)"
+  QUANTITY = "(?<quantity>[^%}]*)?"
+  UNITS = "(?<units>[^}]+)?"
+  TIMER_TAG = "~"
+  INGREDIENT_TAG = "@"
+  COOKWARE_TAG = "#"
 
   def self.included(base)
     base.include InstanceMethods

data/lib/cooklang_rb/text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "steppable"
 
 module CooklangRb
@@ -6,12 +8,19 @@ module CooklangRb
 
     attr_reader :value
 
-    TAGS = /[@#~]|\n/
+    TAG_BOUNDARY = /[@#~](?=[^\p{Zs}\s])|\n/
 
     def self.parse_from(buffer)
-      text = buffer.scan_until TAGS
-      text = text&.sub(TAGS, "") || buffer.rest
-      buffer.pos = buffer.pos - 1 unless buffer.eos?
+      text = buffer.scan_until TAG_BOUNDARY
+
+      if text
+        text = text.chop
+        buffer.pos -= 1 unless buffer.eos?
+      else
+        text = buffer.rest
+        buffer.terminate
+      end
+
       new text.chomp
     end
 

data/lib/cooklang_rb/timer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "tag"
 require_relative "with_units"
 

data/lib/cooklang_rb/version.rb

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

data/lib/cooklang_rb/with_units.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WithUnits
   def self.included(base)
     base.include InstanceMethods

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "4.0.1"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cooklang_rb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Drew Bragg
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: A cooklang parser for Ruby
 email:
@@ -43,6 +42,7 @@ files:
 - lib/cooklang_rb/timer.rb
 - lib/cooklang_rb/version.rb
 - lib/cooklang_rb/with_units.rb
+- mise.toml
 homepage: https://github.com/drbragg/cooklang_rb
 licenses:
 - MIT
@@ -50,7 +50,6 @@ metadata:
   homepage_uri: https://github.com/drbragg/cooklang_rb
   source_code_uri: https://github.com/drbragg/cooklang_rb
   changelog_uri: https://github.com/drbragg/cooklang_rb/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -58,15 +57,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A cooklang parser for Ruby
 test_files: []