cooklang_rb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6a4fa9a28ae338fe05601537fee4f49e7b59564655320f16a0823ec0c21724a
-  data.tar.gz: 87580d9a9822dfb94c3dc227bc5383f403a7100a9197e407f8ccbc703f375dcb
+  metadata.gz: 369e119fc8519a25a662143c5101fa77a877c6621faae48829d1933522f2fdb9
+  data.tar.gz: 4223c5f8ac7cdfd7c350bcc243aa8c2d4daa2f2c7090d49395a64a852e58bbe6
 SHA512:
-  metadata.gz: 7210523498b4db675cf34f1a5afd6d6cb9b7e941e777f13252ebd21d2b62a1a8600ce9e35efcf1aae620047fd61209eb286cda4861a1f15738cd39d298a229e1
-  data.tar.gz: 73e361bb6bbfb1361697e2b81b176537361c8e4f86e6aedf684db397503d37dfeaee1c9a78a20fb81cb12ec02e2ac5a84d9ccebf492e54b9a5df65bf7ba39550
+  metadata.gz: d1f5b4a42b1e84b3aaaa535c51a134f618cf36c9dd65dbfced720775269330d0e3ac25815c35817f7d873d809ef4e0850397e49ff9862d88c0d523d83251c040
+  data.tar.gz: 857a2e1fc4681a8b844b596e0716ab0fc5eed0f66557428c4372d58ccfbd0b19f05d080642bd33cb5e2012bdae3aad32f39dc0b99c746e25dba452e3ea6a9823

data/.github/workflows/main.yml

@@ -1,16 +1,25 @@
-name: Ruby
+name: Test
 
-on: [push,pull_request]
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - master
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.5', '2.6', '2.7', '3.0']
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.0
+        ruby-version: ${{ matrix.ruby }}
     - name: Run the default task
       run: |
         gem install bundler -v 2.2.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cooklang_rb (0.1.0)
+    cooklang_rb (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,8 @@
 # CooklangRb
 
+[![Gem Version](https://badge.fury.io/rb/cooklang_rb.svg)](https://badge.fury.io/rb/cooklang_rb)
+[![Ruby](https://github.com/DRBragg/cooklang_rb/actions/workflows/main.yml/badge.svg)](https://github.com/DRBragg/cooklang_rb/actions/workflows/main.yml)
+
 A Ruby parser for [Cooklang](https://cooklang.org/).
 
 If you're unfamiliar with [Cooklang](https://cooklang.org/), please visit [https://cooklang.org/](https://cooklang.org/) to learn more about using Cooklang.

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.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage

data/lib/cooklang_rb/buffer_utils.rb

@@ -0,0 +1,9 @@
+module BufferUtils
+  def end_of_line?
+    @buffer.peek(1) == "\n"
+  end
+
+  def end_of_buffer?
+    @buffer.eos?
+  end
+end

data/lib/cooklang_rb/cookware.rb

@@ -1,42 +1,16 @@
-require_relative "tag_parser"
-require_relative "steppable"
+require_relative "tag"
 
 module CooklangRb
-  class Cookware
-    include TagParser
-    include Steppable
-
+  class Cookware < Tag
     attr_reader :name, :quantity
 
     def self.tag
       COOKWARE_TAG
     end
 
-    def self.multi_word_pattern
-      /#{tag}#{MULTI_NAME}{#{QUANTITY}}/
-    end
-
     def initialize(name:, quantity:  1)
-      @name = name.delete_prefix(tag).chomp
-      @quantity = normalize quantity
-    end
-
-    private
-
-    def normalize(value)
-      return value if value.is_a? Numeric
-
-      value.strip! if value.respond_to?(:strip!)
-
-      if value.include?(".")
-        value.to_f
-      elsif value.include?("/") && value[0] != "0"
-        value.gsub(/\s/, "").to_r.to_f
-      elsif value.match? /^[0-9]+$/
-        value.to_i
-      else
-        value.empty? ? 1 : value
-      end
+      @name = clean_name(name)
+      @quantity = resolve_quantity(quantity, default: 1)
     end
   end
 end

data/lib/cooklang_rb/ingredient.rb

@@ -1,10 +1,9 @@
-require_relative "tag_parser"
-require_relative "steppable"
+require_relative "tag"
+require_relative "with_units"
 
 module CooklangRb
-  class Ingredient
-    include TagParser
-    include Steppable
+  class Ingredient < Tag
+    include WithUnits
 
     attr_reader :name, :quantity, :units
 
@@ -13,27 +12,9 @@ module CooklangRb
     end
 
     def initialize(name:, quantity: "some", units: "")
-      @name = name.delete_prefix(tag).chomp
-      @quantity = normalize quantity
-      @units = units&.strip || ""
-    end
-
-    private
-
-    def normalize(value)
-      return "some" if value.nil? || value.strip.empty?
-
-      value.strip! if value.respond_to?(:strip!)
-
-      if value.include?(".")
-        value.to_f
-      elsif value.include?("/") && value[0] != "0"
-        value.gsub(/\s/, "").to_r.to_f
-      elsif value.match? /^[0-9]+$/
-        value.to_i
-      else
-        value
-      end
+      @name = clean_name(name)
+      @quantity = resolve_quantity(quantity, default: "some")
+      @units = clean_units(units)
     end
   end
 end

data/lib/cooklang_rb/metadata.rb

@@ -21,8 +21,9 @@ module CooklangRb
     private
 
     def add_metadata
-      data = PATTERN.match(@buffer.scan(PATTERN)).named_captures
-      @metadata[data["key"].strip] = data["value"]
+      @buffer.scan(PATTERN)
+      key, value = @buffer.captures.map(&:strip)
+      @metadata[key] = value
     end
   end
 end

data/lib/cooklang_rb/quantity_resolver.rb

@@ -0,0 +1,18 @@
+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!)
+
+    if quantity.include?(".")
+      quantity.to_f
+    elsif quantity.include?("/") && quantity[0] != "0"
+      quantity.gsub(/\s/, "").to_r.to_f
+    elsif quantity.match?(/^[0-9]+$/)
+      quantity.to_i
+    else
+      quantity.empty? ? default : quantity
+    end
+  end
+end

data/lib/cooklang_rb/recipe.rb

@@ -1,13 +1,13 @@
 require "strscan"
 
-require_relative "ingredient"
-require_relative "cookware"
-require_relative "timer"
-require_relative "text"
 require_relative "metadata"
+require_relative "step"
+require_relative "buffer_utils"
 
 module CooklangRb
   class Recipe
+    include BufferUtils
+
     attr_reader :metadata, :steps
 
     def self.from(source)
@@ -37,7 +37,7 @@ module CooklangRb
 
       gather_metadata
 
-      until @buffer.eos?
+      until end_of_buffer?
         parse_data
       end
     end
@@ -48,7 +48,7 @@ module CooklangRb
     end
 
     def parse_data
-      if @buffer.peek(1) == "\n"
+      if end_of_line?
         @buffer.getch
         return
       end
@@ -57,26 +57,7 @@ module CooklangRb
     end
 
     def build_step
-      step = []
-
-      until @buffer.peek(1) == "\n" || @buffer.eos?
-        step << take_step
-      end
-
-      step
-    end
-
-    def take_step
-      case @buffer.peek(1)
-      when "@"
-        Ingredient.parse_from(@buffer).to_step
-      when "#"
-        Cookware.parse_from(@buffer).to_step
-      when "~"
-        Timer.parse_from(@buffer).to_step
-      else
-        Text.parse_from(@buffer).to_step
-      end
+      Step.new(@buffer).build
     end
 
     def gather_metadata

data/lib/cooklang_rb/step.rb

@@ -0,0 +1,44 @@
+require_relative "ingredient"
+require_relative "cookware"
+require_relative "timer"
+require_relative "text"
+require_relative "buffer_utils"
+
+module CooklangRb
+  class Step
+    include BufferUtils
+
+    TAG_MAP = {
+      "@" => Ingredient,
+      "#" => Cookware,
+      "~" => Timer
+    }.freeze
+
+    def initialize(buffer)
+      @buffer = buffer
+      @content = []
+    end
+
+    def build
+      until end_of_step?
+        @content << take_step
+      end
+
+      @content
+    end
+
+    private
+
+    def take_step
+      next_step.parse_from(@buffer).to_step
+    end
+
+    def next_step
+      TAG_MAP[@buffer.peek(1)] || Text
+    end
+
+    def end_of_step?
+      end_of_line? || end_of_buffer?
+    end
+  end
+end

data/lib/cooklang_rb/tag.rb

@@ -0,0 +1,15 @@
+require_relative "tag_parser"
+require_relative "steppable"
+require_relative "quantity_resolver"
+
+module CooklangRb
+  class Tag
+    include TagParser
+    include Steppable
+    include QuantityResolver
+
+    def clean_name(name)
+      name.delete_prefix(tag).chomp
+    end
+  end
+end

data/lib/cooklang_rb/tag_parser.rb

@@ -21,14 +21,14 @@ module TagParser
   module ClassMethods
     def parse_from(buffer)
       if buffer.match? multi_word_pattern
-        new **multi_word_pattern.match(buffer.scan(multi_word_pattern)).named_captures.transform_keys(&:to_sym)
+        new(**multi_word_pattern.match(buffer.scan(multi_word_pattern)).named_captures.transform_keys(&:to_sym))
       else
-        new name: buffer.scan(single_word_pattern)
+        new(name: buffer.scan(single_word_pattern))
       end
     end
 
     def multi_word_pattern
-      /#{tag}#{MULTI_NAME}?{#{QUANTITY}%?#{UNITS}}/
+      /#{tag}#{MULTI_NAME}{#{QUANTITY}}/
     end
 
     def single_word_pattern

data/lib/cooklang_rb/timer.rb

@@ -1,10 +1,9 @@
-require_relative "tag_parser"
-require_relative "steppable"
+require_relative "tag"
+require_relative "with_units"
 
 module CooklangRb
-  class Timer
-    include TagParser
-    include Steppable
+  class Timer < Tag
+    include WithUnits
 
     attr_reader :name, :quantity, :units
 
@@ -12,26 +11,10 @@ module CooklangRb
       TIMER_TAG
     end
 
-    def initialize(name:, quantity: "some", units: "")
-      @name = name ? name.delete_prefix(tag).chomp : ""
-      @quantity = normalize quantity
-      @units = units&.strip || ""
-    end
-
-    private
-
-    def normalize(value)
-      return "" if value.nil?
-
-      if value.include?(".")
-        value.to_f
-      elsif value.include?("/") && value[0] != "0"
-        value.gsub(/\s/, "").to_r.to_f
-      elsif value.match? /^[0-9]+$/
-        value.to_i
-      else
-        value
-      end
+    def initialize(name:, quantity: "", units: "")
+      @name = name ? clean_name(name) : ""
+      @quantity = resolve_quantity(quantity)
+      @units = clean_units(units)
     end
   end
 end

data/lib/cooklang_rb/version.rb

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

data/lib/cooklang_rb/with_units.rb

@@ -0,0 +1,18 @@
+module WithUnits
+  def self.included(base)
+    base.include InstanceMethods
+    base.extend ClassMethods
+  end
+
+  module InstanceMethods
+    def clean_units(units)
+      units&.strip || ""
+    end
+  end
+
+  module ClassMethods
+    def multi_word_pattern
+      /#{tag}#{TagParser::MULTI_NAME}?{#{TagParser::QUANTITY}%?#{TagParser::UNITS}}/
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cooklang_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Drew Bragg
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies: []
 description: A cooklang parser for Ruby
 email:
@@ -29,15 +29,20 @@ files:
 - bin/setup
 - cooklang_rb.gemspec
 - lib/cooklang_rb.rb
+- lib/cooklang_rb/buffer_utils.rb
 - lib/cooklang_rb/cookware.rb
 - lib/cooklang_rb/ingredient.rb
 - lib/cooklang_rb/metadata.rb
+- lib/cooklang_rb/quantity_resolver.rb
 - lib/cooklang_rb/recipe.rb
+- lib/cooklang_rb/step.rb
 - lib/cooklang_rb/steppable.rb
+- lib/cooklang_rb/tag.rb
 - lib/cooklang_rb/tag_parser.rb
 - lib/cooklang_rb/text.rb
 - lib/cooklang_rb/timer.rb
 - lib/cooklang_rb/version.rb
+- lib/cooklang_rb/with_units.rb
 homepage: https://github.com/drbragg/cooklang_rb
 licenses:
 - MIT
@@ -53,7 +58,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="