inquirex 0.6.0 → 0.7.0

data/.relaxed_rubocop.yml

@@ -1,153 +0,0 @@
-# Relaxed.Ruby.Style
-## Version 2.5
-
-Style/Alias:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylealias
-
-Style/AsciiComments:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleasciicomments
-
-Style/BeginBlock:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylebeginblock
-
-Style/BlockDelimiters:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleblockdelimiters
-
-Style/CommentAnnotation:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylecommentannotation
-
-Style/Documentation:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styledocumentation
-
-Layout/DotPosition:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#layoutdotposition
-
-Style/DoubleNegation:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styledoublenegation
-
-Style/EndBlock:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleendblock
-
-Style/FormatString:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleformatstring
-
-Style/IfUnlessModifier:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleifunlessmodifier
-
-Style/Lambda:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylelambda
-
-Style/ModuleFunction:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylemodulefunction
-
-Style/MultilineBlockChain:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylemultilineblockchain
-
-Style/NegatedIf:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylenegatedif
-
-Style/NegatedWhile:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylenegatedwhile
-
-Style/NumericPredicate:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylenumericpredicate
-
-Style/ParallelAssignment:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleparallelassignment
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylepercentliteraldelimiters
-
-Style/PerlBackrefs:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleperlbackrefs
-
-Style/Semicolon:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylesemicolon
-
-Style/SignalException:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylesignalexception
-
-Style/SingleLineBlockParams:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylesinglelineblockparams
-
-Style/SingleLineMethods:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylesinglelinemethods
-
-Layout/SpaceBeforeBlockBraces:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#layoutspacebeforeblockbraces
-
-Layout/SpaceInsideParens:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#layoutspaceinsideparens
-
-Style/SpecialGlobalVars:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylespecialglobalvars
-
-Style/StringLiterals:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylestringliterals
-
-Style/TrailingCommaInArguments:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarguments
-
-Style/TrailingCommaInArrayLiteral:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarrayliteral
-
-Style/TrailingCommaInHashLiteral:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainhashliteral
-
-Style/SymbolArray:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylesymbolarray
-
-Style/WhileUntilModifier:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylewhileuntilmodifier
-
-Style/WordArray:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylewordarray
-
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#lintambiguousregexpliteral
-
-Lint/AssignmentInCondition:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
-
-Layout/LineLength:
-  Enabled: false
-
-Metrics:
-  Enabled: false
-

data/.ruby-version

@@ -1 +0,0 @@
-4.0.5

data/.secrets.baseline

@@ -1,127 +0,0 @@
-{
-  "version": "1.5.0",
-  "plugins_used": [
-    {
-      "name": "ArtifactoryDetector"
-    },
-    {
-      "name": "AWSKeyDetector"
-    },
-    {
-      "name": "AzureStorageKeyDetector"
-    },
-    {
-      "name": "Base64HighEntropyString",
-      "limit": 4.5
-    },
-    {
-      "name": "BasicAuthDetector"
-    },
-    {
-      "name": "CloudantDetector"
-    },
-    {
-      "name": "DiscordBotTokenDetector"
-    },
-    {
-      "name": "GitHubTokenDetector"
-    },
-    {
-      "name": "GitLabTokenDetector"
-    },
-    {
-      "name": "HexHighEntropyString",
-      "limit": 3.0
-    },
-    {
-      "name": "IbmCloudIamDetector"
-    },
-    {
-      "name": "IbmCosHmacDetector"
-    },
-    {
-      "name": "IPPublicDetector"
-    },
-    {
-      "name": "JwtTokenDetector"
-    },
-    {
-      "name": "KeywordDetector",
-      "keyword_exclude": ""
-    },
-    {
-      "name": "MailchimpDetector"
-    },
-    {
-      "name": "NpmDetector"
-    },
-    {
-      "name": "OpenAIDetector"
-    },
-    {
-      "name": "PrivateKeyDetector"
-    },
-    {
-      "name": "PypiTokenDetector"
-    },
-    {
-      "name": "SendGridDetector"
-    },
-    {
-      "name": "SlackDetector"
-    },
-    {
-      "name": "SoftlayerDetector"
-    },
-    {
-      "name": "SquareOAuthDetector"
-    },
-    {
-      "name": "StripeDetector"
-    },
-    {
-      "name": "TelegramBotTokenDetector"
-    },
-    {
-      "name": "TwilioKeyDetector"
-    }
-  ],
-  "filters_used": [
-    {
-      "path": "detect_secrets.filters.allowlist.is_line_allowlisted"
-    },
-    {
-      "path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies",
-      "min_level": 2
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_indirect_reference"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_likely_id_string"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_lock_file"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_not_alphanumeric_string"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_potential_uuid"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_sequential_string"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_swagger_file"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_templated_secret"
-    }
-  ],
-  "results": {},
-  "generated_at": "2026-04-13T21:29:03Z"
-}

data/Brewfile

@@ -1,7 +0,0 @@
-# Please run `brew bundle` before running `lefthook install`
-
-brew 'lefthook'
-brew 'codespell'
-brew 'mdformat'
-brew 'detect-secrets'
-

data/Rakefile

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "timeout"
-require "yard"
-
-def shell(*args)
-  puts "running: #{args.join(" ")}"
-  system(args.join(" "))
-end
-
-task :clean do
-  shell("rm -rf pkg/ tmp/ coverage/ doc/ ")
-end
-
-task gem: [:build] do
-  shell("gem install pkg/*")
-end
-
-task permissions: [:clean] do
-  shell("chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*")
-  shell("find . -type d -exec chmod o+x,g+x {} \\;")
-end
-
-task build: :permissions
-
-YARD::Rake::YardocTask.new(:doc) do |t|
-  t.files = %w[lib/**/*.rb exe/*.rb - README.md LICENSE.txt CHANGELOG.md]
-  t.options.unshift("--title", '"FlowEngine — DSL + AST for buildiong complex flows in Ruby."')
-  t.after = -> { exec("open doc/index.html") } if RUBY_PLATFORM =~ /darwin/
-end
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/docs/badges/coverage_badge.svg

@@ -1,21 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg xmlns="http://www.w3.org/2000/svg" width="99" height="20">
-  <linearGradient id="b" x2="0" y2="100%">
-    <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
-    <stop offset="1" stop-opacity=".1"/>
-  </linearGradient>
-  <mask id="a">
-    <rect width="99" height="20" rx="3" fill="#fff"/>
-  </mask>
-  <g mask="url(#a)">
-    <path fill="#555" d="M0 0h63v20H0z"/>
-    <path fill="#4c1" d="M63 0h36v20H63z"/>
-    <path fill="url(#b)" d="M0 0h99v20H0z"/>
-  </g>
-  <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
-    <text x="31.5" y="15" fill="#010101" fill-opacity=".3">coverage</text>
-    <text x="31.5" y="14">coverage</text>
-    <text x="80" y="15" fill="#010101" fill-opacity=".3">96%</text>
-    <text x="80" y="14">96%</text>
-  </g>
-</svg>

data/examples/01_readme_example.rb

@@ -1,55 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "inquirex"
-
-DEFINITION = Inquirex.define id: "tax-intake-2025", version: "1.0.0" do
-  meta title: "Tax Preparation Intake", subtitle: "Let's understand your situation"
-  start :filing_status
-
-  ask :filing_status do
-    type :enum
-    question "What is your filing status?"
-    options single: "Single", married_jointly: "Married Filing Jointly"
-    widget target: :desktop, type: :radio_group, columns: 2
-    widget target: :mobile,  type: :dropdown
-    transition to: :dependents
-  end
-
-  ask :dependents do
-    type :integer
-    question "How many dependents?"
-    default 0
-    transition to: :business_income
-  end
-
-  confirm :business_income do
-    question "Do you have business income?"
-    transition to: :business_count, if_rule: equals(:business_income, true)
-    transition to: :done
-  end
-
-  ask :business_count do
-    type :integer
-    question "How many businesses?"
-    transition to: :done
-  end
-
-  say :done do
-    text "Thanks for completing the intake."
-  end
-end
-
-engine = Inquirex::Engine.new(DEFINITION)
-
-engine.answer("single") # filing_status
-engine.answer(2)        # dependents
-engine.answer(false)    # business_income
-engine.advance          # done (display step)
-engine.finished?        # => true
-
-if __FILE__ == $0
-  require 'json'
-  puts JSON.pretty_generate(DEFINITION.to_h)
-end

data/examples/02_readme_mermaid.rb

@@ -1,36 +0,0 @@
-#!/usr/bin/env ruby
-
-require_relative '01_readme_example'
-require 'inquirex'
-require 'stringio'
-
-output = StringIO.new
-exporter = Inquirex::Graph::MermaidExporter.new(DEFINITION)
-output << exporter.export
-
-source = <<~HTML
-  <html>
-    <head>
-      <meta charset="utf-8">
-    </head>
-    <body>
-    <meta charset="utf-8">
-    <div class="mermaid">
-      #{output.string}
-    </div>
-    <script type="module">
-      import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
-      mermaid.initialize({ startOnLoad: true });
-    </script>
-  </html>
-HTML
-
-if __FILE__ == $0
-  File.write('mermaid.html', source)
-  system("open mermaid.html")
-  sleep 10
-
-  at_exit do
-    File.delete('mermaid.html')
-  end
-end

data/examples/03_send_email_actions.rb

@@ -1,97 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# Example 03: Post-completion actions building emails into the outbox.
-#
-# The `action` verb runs server-side after the flow finishes. send_email
-# builds Mail::Message objects — nothing is delivered here; a host Rails app
-# would iterate answers.outbox and deliver via its own ActionMailer config.
-#
-# Run:
-#   bundle exec ruby examples/03_send_email_actions.rb
-
-require "bundler/setup"
-require "inquirex"
-
-DEFINITION = Inquirex.define id: "lead-intake", version: "1.0.0" do
-  # Egress allowlist: webhook effects may only POST to these hosts.
-  allowed_domains "*.agentica.group"
-
-  meta title: "Lead Intake", subtitle: "Tell us about your project"
-  start :name
-
-  ask :name do
-    type :string
-    question "What is your name?"
-    transition to: :email
-  end
-
-  ask :email do
-    type :email
-    question "Where can we reach you? (leave blank to skip the receipt)"
-    transition to: :budget
-  end
-
-  ask :budget do
-    type :currency
-    question "What is your approximate budget?"
-  end
-
-  # Sent only when the visitor left an email address.
-  action :client_receipt, if: not_empty(:email) do
-    send_email to:      "{{email}}",
-      from:    "forms@agentica.group",
-      subject: "Thanks {{name}} — we got your inquiry",
-      text:    <<~TEXT,
-        Hi {{name}},
-
-        We received your answers and will reply within one business day.
-
-        {{answers_summary}}
-      TEXT
-      html:    <<~HTML
-        <p>Hi {{name}},</p>
-        <p>We received your answers and will reply within one business day.</p>
-        {{answers_summary}}
-      HTML
-  end
-
-  # Always notify the site owner, and demonstrate the Ruby escape hatch.
-  action :admin_alert do
-    send_email to: "owner@agentica.group",
-      from: "forms@agentica.group",
-      subject: "New lead: {{name}} (budget {{budget}})",
-      html: "{{answers_summary}}"
-    run { |answers, _outbox| puts ">> run{} saw budget: #{answers.budget}" }
-  end
-
-  # Webhook to an allowed_domains host. Gated by an always-false rule so this
-  # example runs offline — it records :skipped instead of POSTing. Drop the
-  # if: to exercise it for real.
-  action :crm_push, if: equals(:name, "__network_demo__") do
-    webhook url: "https://hooks.agentica.group/inquirex",
-      headers: { "X-Api-Key" => "demo" }
-  end
-end
-
-answers = Inquirex::Actions.run(
-  DEFINITION,
-  name:   "Ada Lovelace",
-  email:  "ada@lovelace.io",
-  budget: 12_500.00
-)
-
-puts "Built #{answers.outbox.size} message(s):"
-answers.outbox.each do |mail|
-  puts "-" * 60
-  puts "To:      #{mail.to.join(", ")}"
-  puts "Subject: #{mail.subject}"
-  puts "Parts:   #{mail.multipart? ? "text + html" : mail.content_type}"
-end
-
-puts "-" * 60
-puts "Results: #{answers.outbox.results.map { |r| "#{r.action_id}=#{r.status}" }.join(", ")}"
-
-# The definition (rules and all) round-trips through JSON — run{} is stripped:
-restored = Inquirex::Definition.from_json(DEFINITION.to_json)
-puts "Actions after JSON round-trip: #{restored.actions.map(&:id).inspect}"

data/examples/README.md

@@ -1,33 +0,0 @@
-# Examples
-
-This folder contains just a couple examples to demonstrate the API and the functionality.
-
-For a fuller list of more comprehensive examples, please see the [examples in the `inquirex-tty` gem](https://github.com/inquirex/inquirex-tty/tree/main/examples).
-
-## Running Examples
-
-These examples are meant to be run as executables from the root level of the gem folder.
-
-### First Example
-
-This example should print to stdout the DSL definition in JSON:
-
-```bash
-# First example — creates a DSL definition and prints it to stdout in JSON format
-./examples/01_readme_example.rb | jq
-```
-
-### Second Example
-
-This is a more interesting example. It builds on the first, takes that definition and uses the mermaid converter to write a tiny HTML file with a mermaid diagram inside, which represents the definition defined in the first file.
-
-```bash
-# creates a mermaid.html file at the root of the project
-# opens the browser with the file and waits 10 seconds
-# deletes the HTML file and exits
-./examples/02_readme_mermaid.rb
-```
-
-The mermaid file generated should look like this:
-
-<img src="02_readme_mermaid.png" width="300px" text-align="left"></img>

data/justfile

@@ -1,70 +0,0 @@
-# Tell 'just' to run bash, source our setup script, then execute the recipe
-set shell := ["bash", "-c"]
-
-version := `grep VERSION lib/inquirex/version.rb | awk '{print $3}' | tr -d '"' | tr -d '\n'`
-rbenv   := 'eval "$(rbenv init bash)"; bundle exec '
-repo    := 'git@github.com:inquirex/inquirex.git'
-
-[no-exit-message]
-recipes:
-    just --choose
-
-# Sync all dependencies
-install:
-    bin/setup
-
-build: install
-
-# Lint and reformat files
-lint:
-    {{ rbenv }} rubocop
-
-# Lint and reformat files (-a) — pass -A as an argument
-format *args:
-    {{ rbenv }} rubocop -a {{ args }}
-
-# Run all the tests
-test *args: 
-    export ENVIRONMENT=test; {{ rbenv }} rspec {{args}}
-
-# Run tests with coverage
-test-coverage *args:
-    export ENVIRONMENT=test; export COVERAGE=true; {{ rbenv }} rspec {{ args }}
-
-ci: lint test-coverage 
-
-alias check-all := ci
-
-clean:
-    #!/usr/bin/env bash
-    @find . -name .DS_Store -delete -print || true
-    @rm -rf tmp/*
-
-# Run all lefthook pre-commit hooks
-lefthook:
-    {{ rbenv }} lefthook run pre-commit --all-files
-
-# Print current gem version
-version:
-    @echo "{{ version }}"
-
-# Clobber
-clobber: 
-    {{ rbenv }} rake clobber
-
-# Generate documentation
-doc: 
-    #!/usr/bin/env bash
-    {{ rbenv }} rake doc
-
-# Create
-publish: build
-    {{ rbenv }} rake release[remote]
-
-# Tag v{{ version }}, publish the GH release, & refresh the Homebrew tap.
-release:
-    git fetch --tags
-    git tag -f "v{{ version }}"
-    git push -f --tags
-    gh release delete -y "v{{ version }}" --repo {{ repo }} 2>/dev/null || true
-    gh release create "v{{ version }}" --generate-notes --repo {{ repo }}

data/lefthook.yml

@@ -1,35 +0,0 @@
-output:
-  - summary
-  - failure
-
-pre-commit:
-  parallel: true
-  jobs:
-    - name: lint
-      run: bundle exec rubocop -c .rubocop.yml {staged_files}
-      glob: "*.{rb,Gemfile}"
-      stage_fixed: true
-
-    - name: check for conflict markers and whitespace issues
-      run: git --no-pager diff --check
-
-    # If tests take >1 second, move this (or just the long-running tests) to pre-push.
-    - name: run tests
-      run: just test
-
-    - name: fix rubocop formatting issues
-      run: bundle exec rubocop -a {staged_files}
-      glob: "*.{rb,Gemfile,gemspec}"
-      stage_fixed: true
-
-    - name: spell check
-      run: codespell {staged_files}
-      glob: "*.{rb,md,gemspec}"
-
-    - name: format markdown
-      run: mdformat {staged_files}
-      glob: "*.md"
-      stage_fixed: true
-
-    - name: scan for secrets
-      run: detect-secrets-hook --baseline .secrets.baseline

data/sig/inquirex.rbs

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