Roll initial filter version

Author: coatless

.github/workflows/publish-website.yml

@@ -0,0 +1,68 @@
+on:
+    push:
+      branches: [main, master]
+    release:
+        types: [published]
+    workflow_dispatch: {}
+      
+name: demo-website
+
+jobs:
+    demo-page:
+        runs-on: ubuntu-latest
+        # Only restrict concurrency for non-PR jobs
+        concurrency:
+            group: quarto-publish-${{ github.event_name != 'pull_request' || github.run_id }}
+        permissions:
+            contents: read
+            pages: write
+            id-token: write
+        steps:
+        
+        - name: "Check out repository"
+          uses: actions/checkout@v4
+
+        # To render using knitr, we need a few more setup steps...
+        # If we didn't want the examples to use `engine: knitr`, we could
+        # skip a few of the setup steps.
+        - name: "Setup R"
+          uses: r-lib/actions/setup-r@v2
+
+        - name: "Setup R dependencies for Quarto's knitr engine"
+          uses: r-lib/actions/setup-r-dependencies@v2
+          with:
+            packages:
+                any::knitr
+                any::rmarkdown
+                any::downlit
+                any::xml2
+                any::reticulate
+
+        - name: "Set up Quarto"
+          uses: quarto-dev/quarto-actions/setup@v2
+          with:
+            version: "pre-release"
+
+        # Render the Quarto file
+        - name: "Render working directory"
+          uses: quarto-dev/quarto-actions/render@v2
+          with:
+            path: "docs"
+
+
+        # Upload a tar file that will work with GitHub Pages
+        # Make sure to set a retention day to avoid running into a cap
+        # This artifact shouldn't be required after deployment onto pages was a success.
+        - name: Upload Pages artifact
+          uses: actions/upload-pages-artifact@v3
+          with: 
+            retention-days: 1
+            path: 'docs/_site'
+
+        
+        # Use an Action deploy to push the artifact onto GitHub Pages
+        # This requires the `Action` tab being structured to allow for deployment
+        # instead of using `docs/` or the `gh-pages` branch of the repository
+        - name: Deploy to GitHub Pages
+          id: deployment
+          uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,3 @@
+/.luarc.json
+.DS_Store
+/docs/_site

README.md

@@ -1,25 +1,94 @@
-# Quarto Extension Development with Lua in a Devcontainer
+# ripper <img src="docs/ripper-animated-logo.svg" align ="right" alt="" width ="150"/>
 
-This repository houses a devcontainer that setups a [Quarto extension development environment](https://quarto.org/docs/extensions/lua.html). The container is setup to work with [GitHub Codespaces](https://github.com/features/codespaces) to instantly have a cloud-based developer workflow.
+A Quarto extension that automatically extracts code blocks from your documents and splits them by programming language into separate, executable script files.
 
-You can try out the Codespace by clicking on the following button:
+## Installation
 
-[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/coatless-devcontainer/quarto-extension-dev?quickstart=1)
+To install the `ripper` Quarto extension, follow these steps:
 
-**Note:** Codespaces are available to Students and Teachers for free [up to 180 core hours per month](https://docs.github.com/en/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom#about-github-codespaces) through [GitHub Education](https://education.github.com/). Otherwise, you will have [up to 60 core hours and 15 GB free per month](https://github.com/features/codespaces#pricing).
+1. Open your terminal.
+2. Execute the following command:
 
-The devcontainer contains:
+```sh
+quarto add coatless-quarto/ripper
+```
 
-- The latest [pre-release](https://quarto.org/docs/download/prerelease) version of Quarto.
-- [Quarto VS Code Extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto).
-- [Lua LSP VS Code Extension](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) for Lua code intelligence.
-- [GitHub copilot VS Code Extension](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot).
-- `R` and `Python`
-- `knitr` and `jupyter`
+This command will download and install the Quarto extension under the `_extensions` subdirectory of your Quarto project. If you are using version control, ensure that you include this directory in your repository.
 
-## References
+## Usage
+
+Add the `ripper` filter to your document's YAML front matter:
+
+````md
+---
+title: "My Analysis"
+filters:
+  - ripper
+---
+
+```{r}
+data <- mtcars
+summary(data)
+```
+
+```{python}
+import pandas as pd
+df = pd.DataFrame({"x": [1, 2, 3]})
+```
+````
+
+Render your document with Quarto:
+
+```bash
+quarto render my-analysis.qmd
+```
+
+Extracted scripts will be created in the same directory with names based on your document file name, e.g.
+
+- `my-analysis.R` - All R code extracted
+- `my-analysis.py` - All Python code extracted
+
+---
+
+## Configuration
+
+Ripper supports a single global option called `include-yaml` under `extensions.ripper`:
+
+```yaml
+---
+filters:
+  - ripper
+extensions:
+  ripper:
+    include-yaml: false   # Include YAML as comments (default: true)
+---
+```
+
+### Option: `include-yaml`
+
+- **`true` (default)**: Includes YAML frontmatter as commented lines at the top of each script
+- **`false`**: Extracts only code with no YAML comments
+
+## Supported Languages
+
+16 languages supported with appropriate file extensions and comment styles:
+
+| Language   | Extension | Comment |
+|------------|-----------|---------|
+| R          | .R        | #'      |
+| Python     | .py       | #'      |
+| Julia      | .jl       | #'      |
+| Bash       | .sh       | #'      |
+| JavaScript | .js       | //'     |
+| TypeScript | .ts       | //'     |
+| SQL        | .sql      | --'     |
+| Rust       | .rs       | //'     |
+| Go         | .go       | //'     |
+| C++        | .cpp      | //'     |
+| C          | .c        | //'     |
+| Java       | .java     | //'     |
+| Scala      | .scala    | //'     |
+| Ruby       | .rb       | #'      |
+| Perl       | .pl       | #'      |
+| PHP        | .php      | //'     |
 
-- [Quarto: Lua API Reference](https://quarto.org/docs/extensions/lua-api.html)
-- [Quarto: Lua Development](https://quarto.org/docs/extensions/lua.html)
-- [Pandoc: Lua Filters](https://pandoc.org/lua-filters.html)
-- [Lua: Manual](https://www.lua.org/manual/5.4/)

_extensions/ripper/_extension.yml

@@ -0,0 +1,7 @@
+title: Ripper
+author: James Joseph Balamuta
+version: 0.0.0-dev.1
+quarto-required: ">=1.7.0"
+contributes:
+  filters:
+    - ripper.lua

_extensions/ripper/ripper.lua

@@ -0,0 +1,183 @@
+local code_blocks = {}
+local yaml_meta = nil
+local include_yaml = true
+local output_name = nil
+
+-- Language to file extension mapping
+local lang_extensions = {
+  r = ".R",
+  python = ".py",
+  julia = ".jl",
+  bash = ".sh",
+  javascript = ".js",
+  typescript = ".ts",
+  sql = ".sql",
+  rust = ".rs",
+  go = ".go",
+  cpp = ".cpp",
+  c = ".c",
+  java = ".java",
+  scala = ".scala",
+  ruby = ".rb",
+  perl = ".pl",
+  php = ".php"
+}
+
+-- Comment style mapping for different languages
+local comment_styles = {
+  r = "#'",
+  python = "#'",
+  julia = "#'",
+  bash = "#'",
+  sql = "--'",
+  javascript = "//'",
+  typescript = "//'",
+  rust = "//'",
+  go = "//'",
+  cpp = "//'",
+  c = "//'",
+  java = "//'",
+  scala = "//'",
+  ruby = "#'",
+  perl = "#'",
+  php = "//'",
+}
+
+-- Get comment prefix for a language
+local function get_comment_prefix(lang)
+  return comment_styles[lang] or "#'"
+end
+
+-- Convert YAML metadata to commented lines
+local function format_yaml_header(meta, lang)
+  if not include_yaml then
+    return ""
+  end
+  
+  local comment = get_comment_prefix(lang)
+  local lines = {comment .. " ---"}
+  
+  -- Extract common metadata fields
+  if meta.title then
+    local title = pandoc.utils.stringify(meta.title)
+    table.insert(lines, comment .. " title: " .. title)
+  end
+  
+  if meta.author then
+    local author = pandoc.utils.stringify(meta.author)
+    table.insert(lines, comment .. " author: " .. author)
+  end
+  
+  if meta.date then
+    local date = pandoc.utils.stringify(meta.date)
+    table.insert(lines, comment .. " date: " .. date)
+  end
+  
+  if meta.format then
+    local format = pandoc.utils.stringify(meta.format)
+    table.insert(lines, comment .. " format: " .. format)
+  end
+  
+  table.insert(lines, comment .. " ---")
+  table.insert(lines, comment .. " ")
+  
+  return table.concat(lines, "\n") .. "\n"
+end
+
+-- Initialize code blocks storage for a language
+local function init_language(lang)
+  if not code_blocks[lang] then
+    code_blocks[lang] = {}
+  end
+end
+
+-- Process Meta block to get configuration and metadata
+function Meta(meta)
+  yaml_meta = meta
+  
+  -- Check for ripper configuration under extensions.ripper
+  if meta.extensions and meta.extensions.ripper then
+    local config = meta.extensions.ripper
+    
+    if config["include-yaml"] ~= nil then
+      include_yaml = config["include-yaml"]
+    end
+  end
+  
+  return meta
+end
+
+-- Process code blocks
+function CodeBlock(block)
+  -- Get the language (classes[1] is typically the language)
+  local lang = block.classes[1]
+  
+  if lang and lang_extensions[lang] then
+    init_language(lang)
+    
+    -- Store just the code text
+    table.insert(code_blocks[lang], block.text)
+  end
+  
+  return block
+end
+
+-- Write all collected code to separate files
+function Pandoc(doc)
+  -- Get the output filename base (without extension)
+  if not output_name then
+    output_name = pandoc.path.split_extension(PANDOC_STATE.output_file or "output")
+  end
+  
+  -- Write a file for each language
+  for lang, blocks in pairs(code_blocks) do
+    if #blocks > 0 then
+      local extension = lang_extensions[lang]
+      local filename = output_name .. extension
+      
+      -- Build file content
+      local content = {}
+      
+      -- Add YAML header if requested
+      local yaml_header = ""
+      if include_yaml and yaml_meta then
+        yaml_header = format_yaml_header(yaml_meta, lang)
+      end
+      
+      -- Only add yaml_header if it's not empty
+      if yaml_header ~= "" then
+        table.insert(content, yaml_header)
+      end
+      
+      -- Add all code blocks for this language
+      for i, code in ipairs(blocks) do
+        if i > 1 then
+          table.insert(content, "\n")  -- Separator between blocks
+        end
+        table.insert(content, code)
+      end
+      
+      -- Write to file
+      local file = io.open(filename, "w")
+      if file then
+        file:write(table.concat(content, "\n"))
+        file:write("\n")  -- Ensure file ends with newline
+        file:close()
+        
+        -- Log the file creation
+        quarto.log.output("Created: " .. filename)
+      else
+        quarto.log.error("Failed to create file: " .. filename)
+      end
+    end
+  end
+  
+  return doc
+end
+
+-- Return the filter functions
+return {
+  { Meta = Meta },
+  { CodeBlock = CodeBlock },
+  { Pandoc = Pandoc }
+}

docs/.gitignore

@@ -0,0 +1,2 @@
+/.quarto/
+**/*.quarto_ipynb

docs/_extensions

@@ -0,0 +1 @@
+../_extensions/