question_kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37b2cc86be99b7513693957fd7e67cd9f19209c47ab31678836acfc0a8332661
+  data.tar.gz: 882bc674404e1cf01084da328595a14a0deff0096c96a775648ba97e54960d7a
+SHA512:
+  metadata.gz: f51ba58ee9eafbeaa9faa1539f617c5bbddb09bf0248a35462537323f5fda0131968c725ec4f867de5f671ee472443067dce5b3ac2b4085cc6f076ee6dd69a46
+  data.tar.gz: c7be35b2bbe19282322aa576353a6a7ee50f3f1479b42e787e1688f3884d220d01812a2bec116446bc655262346642bb4236c910dd39da2826a1666b9f9eab83

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# question_kit
+Shared question and game layer between easy_flow and alembic

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "the_local/rake"

data/lib/question_kit/railtie.rb

@@ -0,0 +1,4 @@
+module QuestionKit
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/question_kit/version.rb

@@ -0,0 +1,3 @@
+module QuestionKit
+  VERSION = "0.1.0"
+end

data/lib/question_kit.rb

@@ -0,0 +1,7 @@
+require "easy_flow"
+require "question_kit/version"
+require "question_kit/railtie"
+
+module QuestionKit
+  # Your code goes here...
+end

data/lib/tasks/question_kit_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :question_kit do
+#   # Task goes here
+# end

data/the_local/agents/question_kit-develop.md

@@ -0,0 +1,50 @@
+---
+name: question_kit-develop
+description: Use PROACTIVELY for reading which question_kit version a host app has loaded, and for checking that version before code relies on a question_kit release — MUST BE USED instead of reading Gem.loaded_specs, parsing Gemfile.lock, or comparing version strings by hand.
+tools: Bash, Read, Write, Edit, Grep
+scope: shared question and answer rules for easy_flow quizzes — what an answer to a question step is worth, which answers are right, and how a quiz is built
+---
+
+This local writes host app code against question_kit's declared interface only, and follows these steps exactly.
+
+## What question_kit is
+
+A Rails gem for apps that run quizzes as easy_flow flows, meant to hold the rules those apps share: what an answer to a question step is worth, which answers are right, and how a quiz is built. Today its only code-facing interface is its version constant. Use this local when host app code needs to know which question_kit release is loaded. Building the quiz flow, its question steps, runs and answers belongs to the easy_flow locals.
+
+## Interface
+
+- `QuestionKit::VERSION` — a string such as `"0.1.0"` naming the question_kit release loaded in the host app.
+
+## How to use it
+
+1. Confirm question_kit is in the host app's `Gemfile.lock`. If it is not, hand the work to `question_kit-install` and stop.
+2. In the file that reads the version, require the gem explicitly at the top:
+
+   ```ruby
+   require "question_kit"
+   ```
+
+   This also loads easy_flow, so no separate `require "easy_flow"` is needed.
+3. Read the version where it is needed:
+
+   ```ruby
+   QuestionKit::VERSION
+   ```
+
+4. When code depends on a release, compare with `Gem::Version`, never with string comparison:
+
+   ```ruby
+   Gem::Version.new(QuestionKit::VERSION) >= Gem::Version.new("0.2.0")
+   ```
+
+5. Ask the developer what the app does when the loaded version is older than the one its code needs: raise at boot, log a warning, or skip the feature. Do not pick one.
+6. If the check runs at boot, put it in an initializer under `config/initializers/` in the host app. Otherwise put it beside the code that depends on the release.
+7. Write a test in the host app that asserts the app's own behaviour for each branch of the check, and run it.
+
+## Conventions
+
+- Never hard-code the version string in host app code. Read `QuestionKit::VERSION`.
+- Never assign to or redefine `QuestionKit::VERSION`.
+- question_kit has no scoring, right-answer or quiz-building methods yet. Do not invent calls for them. If the developer asks for that behaviour, say the gem does not offer it and ask whether to build it in the host app or wait for question_kit to add it.
+- Adding the gem, and upgrading it, belongs to `question_kit-install`.
+- Flows, step types, runs and answers belong to the easy_flow locals.

data/the_local/agents/question_kit-info.md

@@ -0,0 +1,49 @@
+---
+name: question_kit-info
+description: Use to learn what question_kit offers — shared rules for easy_flow quizzes, covering what an answer to a question step is worth, which answers are right, and how a quiz is built.
+tools: Read
+scope: shared question and answer rules for easy_flow quizzes — what an answer to a question step is worth, which answers are right, and how a quiz is built
+---
+
+This local explains question_kit and makes no changes.
+
+## What question_kit is
+
+question_kit is a Rails gem for apps that run quizzes as easy_flow flows. Each
+quiz question is an easy_flow question step. The gem is meant to hold the rules
+those apps share: what an answer to a question step is worth, which answers are
+right, and how a quiz is built. With the rules in one gem, each app does not
+keep its own copy.
+
+Today the gem holds none of those rules yet. It loads easy_flow into the host
+app and reports its own version, and nothing more. Reach for it when an app
+runs easy_flow quizzes and should follow the shared rules as they are added.
+Until then, it is only a dependency to put in place.
+
+## Interface
+
+This local documents no commands. The other two locals cover everything the
+gem exposes:
+
+- The install local, `question_kit-install`, adds the gem to a host app.
+- The develop local, `question_kit-develop`, covers the code a host app writes against the gem.
+
+Anything about building or running the flows themselves, such as the canvas,
+step types, runs and answers, belongs to easy_flow. The easy_flow locals cover
+that.
+
+## How to use it
+
+- To add question_kit to an app, use `question_kit-install`.
+- To write code that uses question_kit, use `question_kit-develop`.
+- To build the quiz flow or a question step, use the easy_flow locals.
+
+## Conventions
+
+- **Quiz** — an easy_flow flow whose steps ask the visitor questions.
+- **Question step** — one easy_flow step that asks one question and records the
+  visitor's answer.
+- **Worth** — what an answer is worth toward the quiz's result.
+- **Right answer** — an answer the quiz counts as correct for its question.
+- **Host app** — the Rails app that installs question_kit and easy_flow and runs
+  the quizzes.

data/the_local/agents/question_kit-install.md

@@ -0,0 +1,44 @@
+---
+name: question_kit-install
+description: Use to hook question_kit into a project — adding the gem to the host app's Gemfile and installing it alongside easy_flow.
+tools: Bash, Read, Edit
+scope: shared question and answer rules for easy_flow quizzes — what an answer to a question step is worth, which answers are right, and how a quiz is built
+---
+
+This local follows these steps exactly and invents none.
+
+## What question_kit is
+
+A Rails gem holding the shared quiz rules for apps that run quizzes as easy_flow flows, hooked in when a host app runs easy_flow quizzes.
+
+## Interface
+
+- `gem "question_kit"` — the Gemfile line that adds question_kit, and with it easy_flow, to the host app.
+
+## How to use it
+
+1. Check the host app's Rails version in `Gemfile.lock`. question_kit needs Rails 8.1.3 or later, so stop and tell the developer if the app is older.
+2. Check `Gemfile.lock` for easy_flow. question_kit needs easy_flow 0.35 or a later 0.x release. If the app pins an easy_flow version outside that range, ask the developer whether to move the pin before going on.
+3. Add the gem to the host app's `Gemfile`:
+
+   ```ruby
+   gem "question_kit"
+   ```
+
+4. Run:
+
+   ```
+   bundle install
+   ```
+
+   This edits `Gemfile.lock` and brings in easy_flow if the app did not have it.
+5. Check whether easy_flow is already hooked into the app: its migrations copied and run, its engine mounted, and its hosts declared. If any of that is missing, hand the work to `easy_flow-install`, and ask the developer which hosts to declare rather than picking them.
+
+question_kit has no generator, no initializer, no migrations and no routes of its own. Requiring the gem loads easy_flow, so the host app needs no separate `require "easy_flow"`.
+
+## Conventions
+
+- After install, run `bundle list | grep -E "question_kit|easy_flow"` and confirm both gems are listed.
+- After a `bundle update question_kit`, check `Gemfile.lock` again for the easy_flow version it brought in, and run `easy_flow-install` for any new easy_flow migrations.
+- Setting up easy_flow itself, its hosts, step types and admin pages belongs to `easy_flow-install`.
+- Writing code against question_kit belongs to `question_kit-develop`.

data/the_local/interface.yml

@@ -0,0 +1,12 @@
+scope: shared question and answer rules for easy_flow quizzes — what an answer to a question step is worth, which answers are right, and how a quiz is built
+
+install:
+  - gem "question_kit"
+
+develop:
+  - QuestionKit::VERSION
+
+sources:
+  - question_kit.gemspec
+  - lib/question_kit.rb
+  - lib/question_kit/version.rb

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: question_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tylercschneider
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.3
+- !ruby/object:Gem::Dependency
+  name: easy_flow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+description: QuestionKit holds the rules for what an answer to an easy_flow question
+  step is worth, which answers are right, and how a quiz is built, so apps share them
+  rather than each keeping a copy.
+email:
+- tylercschneider@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/question_kit.rb
+- lib/question_kit/railtie.rb
+- lib/question_kit/version.rb
+- lib/tasks/question_kit_tasks.rake
+- the_local/agents/question_kit-develop.md
+- the_local/agents/question_kit-info.md
+- the_local/agents/question_kit-install.md
+- the_local/interface.yml
+homepage: https://github.com/DYB-Development/question_kit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DYB-Development/question_kit
+  source_code_uri: https://github.com/DYB-Development/question_kit
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Shared question and answer rules for apps that run easy_flow quizzes.
+test_files: []