RubyGems - jekyll-cooklang-converter - Versions diffs - 0.2.0 - Mend

jekyll-cooklang-converter 0.2.0

Files changed (18) hide show

checksums.yaml +7 -0
data/.standard.yml +3 -0
data/README.md +39 -0
data/Rakefile +16 -0
data/clash/_clash.yml +5 -0
data/clash/test-site/_config.yml +12 -0
data/clash/test-site/_expected/index.html +10 -0
data/clash/test-site/_expected/recipes/baked-ziti.html +52 -0
data/clash/test-site/_layouts/default.html +9 -0
data/clash/test-site/_recipes/baked-ziti.cook +19 -0
data/clash/test-site/_site/index.html +10 -0
data/clash/test-site/_site/recipes/baked-ziti.html +52 -0
data/clash/test-site/index.html +5 -0
data/lib/jekyll/converters/cooklang.rb +128 -0
data/lib/jekyll-cooklang-converter/version.rb +5 -0
data/lib/jekyll-cooklang-converter.rb +10 -0
data/sig/jekyll/cooklang/converter.rbs +8 -0
metadata +150 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84eb0c0f3f9686e895d90daa24604cad91fc3f336ba5311c20010c8fe08a877b
+  data.tar.gz: a48f36af64fb5dcd32e86d38525634f3c27c5e8c767c79646128c85ea167c8c2
+SHA512:
+  metadata.gz: 796cd7fd7ebb8c7321f87cc82ca7c1708be46b657ea11fcbda63f4724a99fd739b034720aae0e1248ebdb715c32d9e271d5104c3f0493cdcdc0f633eedaffa6b
+  data.tar.gz: 26699a51dfc7a327fe0a0077ad3075ce8818dc22c84f492baec3efcae7d8eb310f9b725598056a427398c11f56870442c225f1461d4f9808823f63dfb03fbfd8

data/.standard.yml ADDED Viewed

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/README.md ADDED Viewed

@@ -0,0 +1,39 @@
+# Jekyll::Cooklang::Converter
+TODO: Delete this and the text below, and describe your gem
+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/jekyll/cooklang/converter`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Installation
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Install the gem and add to the application's Gemfile by executing:
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+## Usage
+TODO: Write usage instructions here
+## 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.
+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).
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-cooklang-converter.
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile ADDED Viewed

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+require "standard/rake"
+require "rspec/core/rake_task"
+task default: [:standard, :spec, :clash]
+task :clash do |t|
+  sh "bundle exec clash clash"
+end
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob("spec/**/*_spec.rb")
+  t.rspec_opts = "--format documentation"
+end

data/clash/_clash.yml ADDED Viewed

@@ -0,0 +1,5 @@
+-
+  title: "Test Build"
+  dir: test-site
+  build: true
+  compare: _expected _site

data/clash/test-site/_config.yml ADDED Viewed

@@ -0,0 +1,12 @@
+name: Test site
+timezone: UTC
+markdown: kramdown
+gems:
+  - jekyll-cooklang-converter
+plugins:
+  - jekyll-cooklang-converter
+whitelist:
+  - jekyll-cooklang-converter
+collections:
+  recipes:
+    output: true

data/clash/test-site/_expected/index.html ADDED Viewed

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+</head>
+<body>
+<div class='site'>Test content
+</div>
+</body>
+</html>

data/clash/test-site/_expected/recipes/baked-ziti.html ADDED Viewed

@@ -0,0 +1,52 @@
+<h2>Ingredients</h2>
+<ul>
+  <li><em>1 box</em> mushrooms</li>
+  <li><em>1 pound</em> ground sausage</li>
+  <li><em>some</em> garlic powder</li>
+  <li><em>some</em> italian seasoning</li>
+  <li><em>some</em> chili powder</li>
+  <li><em>1</em> large yellow onion</li>
+  <li><em>some</em> olive oil</li>
+  <li><em>some</em> salt</li>
+  <li><em>1</em> bell pepper</li>
+  <li><em>1 jar</em> pasta sauce</li>
+  <li><em>1 15oz package</em> ricotta</li>
+  <li><em>1 cup</em> shredded mozarella</li>
+  <li><em>1 package</em> sliced provolone</li>
+  <li><em>2 cups</em> mozarella cheese</li>
+</ul>
+<h2>Cookware</h2>
+<ul>
+  <li><em>1</em> pot</li>
+  <li><em>1</em> casserole dish</li>
+</ul>
+<h2>Steps</h2>
+<ol>
+  <li>
+    <p>set a pot of water on the stove, to boil (you'll need for pasta later), and preheat the oven to 350</p>
+  </li>
+  <li>
+    <p>cut mushrooms into slices, and sautee (no oil) in a pan over medium high heat until browned. Set aside</p>
+  </li>
+  <li>
+    <p>brown ground sausage in the same pan, seasoning with garlic powder, italian seasoning, and chili powder set aside</p>
+  </li>
+  <li>
+    <p>the water should hopefully be boiling by now</p>
+  </li>
+  <li>
+    <p>chop and sautee large yellow onion in olive oil. Seasoning with salt. Add the bell pepper, chopped</p>
+  </li>
+  <li>
+    <p>add back in the mushrooms and sausage, and pour pasta sauce over everything. Mix well, and allow it to simmer until it bubbles a bit at the bottom</p>
+  </li>
+  <li>
+    <p>mix together ricotta and shredded mozarella</p>
+  </li>
+  <li>
+    <p>layer half of the cooked pasta into the bottom of a greased casserole dish. Ladle half of the meat + veggie mixture on top. Then, spread the cheese mixture from the previous step on top of everything. Layer sliced provolone on that, followed by the rest of the sauce, the rest of the pasta, and a final layer of mozarella cheese. Sprinkle the top with italian seasoning</p>
+  </li>
+  <li>
+    <p>put the dish in the preheated oven for . Then it's all ready!</p>
+  </li>
+</ol>

data/clash/test-site/_layouts/default.html ADDED Viewed

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+</head>
+<body>
+<div class='site'>{{ content }}</div>
+</body>
+</html>

data/clash/test-site/_recipes/baked-ziti.cook ADDED Viewed

@@ -0,0 +1,19 @@
+---
+---
+set a #pot of water on the stove, to boil (you'll need for pasta later), and preheat the oven to 350
+cut @mushrooms{1%box} into slices, and sautee (no oil) in a pan over medium high heat until browned. Set aside
+brown @ground sausage{1%pound} in the same pan, seasoning with @garlic powder{}, @italian seasoning{}, and @chili powder{} set aside
+the water should hopefully be boiling by now-- add @dry ziti{1%pound} and leave to cook according to package instructions (usually around 10 minutes)
+chop and sautee @large yellow onion{1} in @olive oil{}. Seasoning with @salt{}. Add the @bell pepper{1}, chopped
+add back in the mushrooms and sausage, and pour @pasta sauce{1%jar} over everything. Mix well, and allow it to simmer until it bubbles a bit at the bottom
+mix together @ricotta{1%15oz package} and @shredded mozarella{1%cup}
+layer half of the cooked pasta into the bottom of a greased #casserole dish{}. Ladle half of the meat + veggie mixture on top. Then, spread the cheese mixture from the previous step on top of everything. Layer @sliced provolone{1%package} on that, followed by the rest of the sauce, the rest of the pasta, and a final layer of @mozarella cheese{2%cups}. Sprinkle the top with italian seasoning
+put the dish in the preheated oven for ~{25%minutes}. Then it's all ready!

data/clash/test-site/_site/index.html ADDED Viewed

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+</head>
+<body>
+<div class='site'>Test content
+</div>
+</body>
+</html>

data/clash/test-site/_site/recipes/baked-ziti.html ADDED Viewed

@@ -0,0 +1,52 @@
+<h2>Ingredients</h2>
+<ul>
+  <li><em>1 box</em> mushrooms</li>
+  <li><em>1 pound</em> ground sausage</li>
+  <li><em>some</em> garlic powder</li>
+  <li><em>some</em> italian seasoning</li>
+  <li><em>some</em> chili powder</li>
+  <li><em>1</em> large yellow onion</li>
+  <li><em>some</em> olive oil</li>
+  <li><em>some</em> salt</li>
+  <li><em>1</em> bell pepper</li>
+  <li><em>1 jar</em> pasta sauce</li>
+  <li><em>1 15oz package</em> ricotta</li>
+  <li><em>1 cup</em> shredded mozarella</li>
+  <li><em>1 package</em> sliced provolone</li>
+  <li><em>2 cups</em> mozarella cheese</li>
+</ul>
+<h2>Cookware</h2>
+<ul>
+  <li><em>1</em> pot</li>
+  <li><em>1</em> casserole dish</li>
+</ul>
+<h2>Steps</h2>
+<ol>
+  <li>
+    <p>set a pot of water on the stove, to boil (you'll need for pasta later), and preheat the oven to 350</p>
+  </li>
+  <li>
+    <p>cut mushrooms into slices, and sautee (no oil) in a pan over medium high heat until browned. Set aside</p>
+  </li>
+  <li>
+    <p>brown ground sausage in the same pan, seasoning with garlic powder, italian seasoning, and chili powder set aside</p>
+  </li>
+  <li>
+    <p>the water should hopefully be boiling by now</p>
+  </li>
+  <li>
+    <p>chop and sautee large yellow onion in olive oil. Seasoning with salt. Add the bell pepper, chopped</p>
+  </li>
+  <li>
+    <p>add back in the mushrooms and sausage, and pour pasta sauce over everything. Mix well, and allow it to simmer until it bubbles a bit at the bottom</p>
+  </li>
+  <li>
+    <p>mix together ricotta and shredded mozarella</p>
+  </li>
+  <li>
+    <p>layer half of the cooked pasta into the bottom of a greased casserole dish. Ladle half of the meat + veggie mixture on top. Then, spread the cheese mixture from the previous step on top of everything. Layer sliced provolone on that, followed by the rest of the sauce, the rest of the pasta, and a final layer of mozarella cheese. Sprinkle the top with italian seasoning</p>
+  </li>
+  <li>
+    <p>put the dish in the preheated oven for . Then it's all ready!</p>
+  </li>
+</ol>

data/clash/test-site/index.html ADDED Viewed

@@ -0,0 +1,5 @@
+---
+layout: default
+---
+Test content

data/lib/jekyll/converters/cooklang.rb ADDED Viewed

@@ -0,0 +1,128 @@
+module Jekyll
+  module Converters
+    class ToHTML
+      def to_html
+        "<em>hello world</em>"
+      end
+      def to_list_item
+        "<li>#{to_html}</li>"
+      end
+    end
+    class Ingredient < ToHTML
+      def initialize(quantity, unit, name)
+        @name = name
+        @unit = unit
+        @quantity = quantity
+      end
+      def to_html
+        return "<em>#{@quantity}</em> #{@name}" if @unit.empty?
+        "<em>#{@quantity} #{@unit}</em> #{@name}"
+      end
+    end
+    class CookWare < ToHTML
+      def initialize(quantity, name)
+        @name = name
+        @quantity = quantity
+      end
+      def to_html
+        return @name.to_s if @quantity.empty?
+        "<em>#{@quantity}</em> #{@name}"
+      end
+    end
+    class OrderedList < ToHTML
+      def initialize(items)
+        @items = items
+      end
+      def to_html
+        list_items = @items.map do |item|
+          item.to_list_item
+        end
+        "<ol>" + list_items.join + "</ol>"
+      end
+    end
+    class UnorderedList < ToHTML
+      def initialize(items)
+        @items = items
+      end
+      def to_html
+        list_items = @items.map do |item|
+          item.to_list_item
+        end
+        "<ul>" + list_items.join + "</ul>"
+      end
+    end
+    class Step < ToHTML
+      def initialize(step)
+        @text = step.map do |substep|
+          case substep["type"]
+          when "cookware"
+            substep["name"]
+          when "ingredient"
+            substep["name"]
+          when "text"
+            substep["value"]
+          end
+        end.join
+      end
+      def to_html
+        "<p>#{@text}</p>"
+      end
+    end
+    class CooklangConverter < Converter
+      safe true
+      def matches(ext)
+        ext =~ /^.cook/i
+      end
+      def output_ext(ext)
+        ".html"
+      end
+      def convert(content)
+        recipe = CooklangRb::Recipe.from(content)
+        ingredients = recipe["steps"].flatten.select { |item|
+          item["type"] == "ingredient"
+        }.map { |item|
+          Ingredient.new(item["quantity"].to_s, item["units"].to_s, item["name"].to_s)
+        }
+        cookware = recipe["steps"].flatten.select { |item|
+          item["type"] == "cookware"
+        }.map { |item|
+          CookWare.new(item["quantity"].to_s, item["name"].to_s)
+        }
+        steps = recipe["steps"].map do |step|
+          Step.new(step)
+        end
+        ingredients_list = UnorderedList.new(ingredients)
+        cookware_list = UnorderedList.new(cookware)
+        steps_list = OrderedList.new(steps)
+        HtmlBeautifier.beautify(
+          "<h2>Ingredients</h2>" +
+            ingredients_list.to_html +
+            "<h2>Cookware</h2>" +
+            cookware_list.to_html +
+            "<h2>Steps</h2>" +
+            steps_list.to_html
+        ) + "\n"
+      end
+    end
+  end
+end

data/lib/jekyll-cooklang-converter/version.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module Jekyll
+  module CooklangConverter
+    VERSION = "0.2.0"
+  end
+end

data/lib/jekyll-cooklang-converter.rb ADDED Viewed

@@ -0,0 +1,10 @@
+require "jekyll"
+require "cooklang_rb"
+require "htmlbeautifier"
+require "jekyll-cooklang-converter/version"
+require "jekyll/converters/cooklang"
+module Jekyll
+  module CooklangConverter
+  end
+end

data/sig/jekyll/cooklang/converter.rbs ADDED Viewed

@@ -0,0 +1,8 @@
+module Jekyll
+  module Cooklang
+    module Converter
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-cooklang-converter
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- BraeTroutman
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.4
+- !ruby/object:Gem::Dependency
+  name: cooklang_rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: htmlbeautifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: clash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+description:
+email:
+- btroutma@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- README.md
+- Rakefile
+- clash/_clash.yml
+- clash/test-site/_config.yml
+- clash/test-site/_expected/index.html
+- clash/test-site/_expected/recipes/baked-ziti.html
+- clash/test-site/_layouts/default.html
+- clash/test-site/_recipes/baked-ziti.cook
+- clash/test-site/_site/index.html
+- clash/test-site/_site/recipes/baked-ziti.html
+- clash/test-site/index.html
+- lib/jekyll-cooklang-converter.rb
+- lib/jekyll-cooklang-converter/version.rb
+- lib/jekyll/converters/cooklang.rb
+- sig/jekyll/cooklang/converter.rbs
+homepage: https://github.com/BraeTroutman/jekyll-cooklang-converter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/BraeTroutman/jekyll-cooklang-converter
+  source_code_uri: https://github.com/BraeTroutman/jekyll-cooklang-converter
+  changelog_uri: https://github.com/BraeTroutman/jekyll-cooklang-converter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A simple Jekyll Converter that maps .cook files to HTML
+test_files: []