inquirex 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17d01981ef4e69be2150f96efb297012bbfb2af2b3128ba6aea45f39c9aec821
-  data.tar.gz: '0298dbc81566df2384ab1c634303f4504313e6a35a091b559f10ffb668508cb5'
+  metadata.gz: a59215d626aa41651ff87814be16abcbdb802f208151ffe0911111ab252f89b0
+  data.tar.gz: f6178810008d8800b4ada40ed83bb2b161653ef9f469acd09eee64607e1bec4a
 SHA512:
-  metadata.gz: c3ddd23f48c9781b11e2692690bf8dfd1dc5b3e764b089167a71053f74950fd2f18465aadc548364dd660c8db8599c092c46eba21eb9f7df80e429d9633210f2
-  data.tar.gz: f53e0183422971270e3db8f069206aa8f23d83e8439a6738922d878da5066937693a4c8303a6786cd8347aef4ab6ae3a228acca583cb0a3861616f7ed6e82c37
+  metadata.gz: 94d4312b92047971aca5cd95ed99731c927515954b662c15c43f67034523d6e5a5827829f991161b65d7df7e998b29163a0f7930e531cf6b130c558b3febb80b
+  data.tar.gz: 5b5fce185e6c80c33ab289e1403c6db89c92e3c4c8e270e098c1ff22f1a697e39f4a59ac55a4818b88f711e1474e51dc95ffe9d9c76b910902deec9424b42d0c

data/.ruby-version

@@ -1 +1 @@
-4.0.2
+4.0.5

data/README.md

@@ -4,6 +4,19 @@
 
 `inquirex` is a pure Ruby, declarative, rules-driven questionnaire engine for building conditional intake forms, qualification wizards, and branching surveys.
 
+> [!IMPORTANT]
+>
+> Note that `inquirex` is the base gem of the ecosystem that contains:
+>
+> - [`inquirex`](https://github.com/inquirex/inquirex)
+> - [`inquirex-llm`](https://github.com/inquirex/inquirex-llm)
+> - [`inquirex-tty`](https://github.com/inquirex/inquirex-)
+> - [`inquirex-js`](https://github.com/inquirex/inquirex-js)
+>
+> For a presentation on these gems and what they do please watch the [RubySF presentation](https://www.youtube.com/watch?v=iaoKW7Ap3_M&t=1s) and you can also [view the slides form the presentation](https://reinvent.one/images/talks/pdfs/2026.inquirex.pdf).
+
+## Summary
+
 It is the core gem in the Inquirex ecosystem and focuses on:
 
 - A conversational DSL (`ask`, `say`, `header`, `btw`, `warning`, `confirm`)
@@ -17,8 +30,8 @@ It is the core gem in the Inquirex ecosystem and focuses on:
 
 ## Status
 
-- Version: `0.2.0`
-- Ruby: `>= 4.0.0` (project currently uses `4.0.2`)
+- Version: `0.4.0`
+- Ruby: `>= 4.0.0` (project currently uses `4.0.5`)
 - Test suite: `220 examples, 0 failures`
 - Coverage: ~`94%` line coverage
 
@@ -282,7 +295,11 @@ engine.totals             # => { price: 700.0, complexity: 4 }
 
 ### JSON wire format
 
-Accumulators serialize predictably, keeping the contract with `inquirex-js` explicit:
+Accumulators serialize predictably, keeping the contract with `inquirex-js` explicit.
+
+> [!NOTE]
+>
+> You can convert between Ruby DSL and JSON using the [`inquirex-tty`](https://github.com/inquirex/inquirex-tty) gem.
 
 ```json
 {
@@ -381,6 +398,23 @@ Behavior:
 - Use `finished?` to detect completion
 - Use `total(:price)` / `totals` to read running totals
 - Use `to_state` / `.from_state` for persistence/resume (totals included)
+- Use `prefill!(hash)` to merge externally-supplied answers into the state,
+  e.g. fields extracted by an LLM from a free-text answer (see
+  [inquirex-llm](#extension-gems)). Existing answers are preserved; `nil`
+  and empty values are ignored so they don't spuriously satisfy
+  `not_empty` rules. The engine auto-advances past any newly-skippable step.
+
+```ruby
+engine = Inquirex::Engine.new(definition)
+engine.answer("I'm MFJ with two kids in California.") # free-text :describe
+
+# Step is now :extracted (a clarify node); adapter returns a Hash.
+result = adapter.call(engine.current_step, engine.answers)
+engine.answer(result)           # store under the clarify step's id
+engine.prefill!(result)         # splat into top-level answers
+# Downstream :filing_status, :dependents, :state are now auto-skipped by
+# `skip_if not_empty(:filing_status)` etc.
+```
 
 ### Validation Adapter
 

data/docs/badges/coverage_badge.svg

@@ -15,7 +15,7 @@
   <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">94%</text>
-    <text x="80" y="14">94%</text>
+    <text x="80" y="15" fill="#010101" fill-opacity=".3">95%</text>
+    <text x="80" y="14">95%</text>
   </g>
 </svg>

data/justfile

@@ -1,38 +1,69 @@
-set shell := ["bash", "-lc"]
+# Tell 'just' to run bash, source our setup script, then execute the recipe
+set shell := ["bash", "-c"]
 
-rbenv := 'eval "$(rbenv init -)"'
+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
+    just --choose
 
 # Sync all dependencies
 install:
-    {{rbenv}} && bin/setup
+    bin/setup
 
-# Lint and reformat files
-lint-fix *args:
-    {{rbenv}} && bundle exec rubocop -a
-
-alias format := lint-fix
+build: install
 
 # Lint and reformat files
 lint:
-    {{rbenv}} && bundle exec rubocop
+    {{ rbenv }} rubocop
+
+# Lint and reformat files (-a) — pass -A as an argument
+format *args:
+    {{ rbenv }} rubocop -a {{ args }}
 
 # Run all the tests
 test *args: 
-    {{rbenv}} &&  ENVIRONMENT=test bundle exec rspec {{args}}
+    export ENVIRONMENT=test; {{ rbenv }} rspec {{args}}
 
 # Run tests with coverage
 test-coverage *args:
-    ENVIRONMENT=test COVERAGE=true bundle exec rspec
+    export ENVIRONMENT=test; export COVERAGE=true; {{ rbenv }} rspec {{ args }}
+
+check-all: lint test-coverage 
 
 clean:
     #!/usr/bin/env bash
-    find . -name .DS_Store -delete -print || true
-    rm -rf tmp/*
+    @find . -name .DS_Store -delete -print || true
+    @rm -rf tmp/*
 
 # Run all lefthook pre-commit hooks
-ci:
-    {{rbenv}} && lefthook run pre-commit --all-files
+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/lib/inquirex/engine.rb

@@ -74,6 +74,33 @@ module Inquirex
       advance_step
     end
 
+    # Merges a hash of { step_id => value } into the top-level answers without
+    # clobbering answers the user has already provided. Used by LLM clarify
+    # steps to populate downstream answers from free-text extraction so that
+    # `skip_if not_empty(:id)` rules on later steps will fire.
+    #
+    # Nil/empty values in the hash are ignored so that "unknown" LLM outputs
+    # don't spuriously satisfy `not_empty` rules.
+    #
+    # If the engine's current step becomes skippable as a result of the prefill,
+    # it auto-advances past it.
+    #
+    # @param hash [Hash] answers keyed by step id
+    # @return [Hash] the updated answers
+    def prefill!(hash)
+      return @answers unless hash.is_a?(Hash)
+
+      hash.each do |key, value|
+        next if value.nil?
+        next if value.respond_to?(:empty?) && value.empty?
+
+        sym = key.to_sym
+        @answers[sym] = value unless @answers.key?(sym)
+      end
+      skip_if_needed unless finished?
+      @answers
+    end
+
     # Serializable state snapshot for persistence or resumption.
     #
     # @return [Hash]

data/lib/inquirex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Inquirex
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: inquirex
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
@@ -18,8 +18,7 @@ description: Inquirex lets you define multi-step questionnaires as directed grap
   immutable definitions.
 email:
 - kigster@gmail.com
-executables:
-- inquirex
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -33,7 +32,6 @@ files:
 - README.md
 - Rakefile
 - docs/badges/coverage_badge.svg
-- exe/inquirex
 - justfile
 - lefthook.yml
 - lib/inquirex.rb

data/exe/inquirex

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-
-require "inquirex"