ask-rails-harness 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b7c1f9342c45ef3d4472772717fcc6ff302b35999e74806bd8964510f729f2f
-  data.tar.gz: 017c0f1b89629f435bde77c637c96e866caffb3be86f27d99adcf6431cc79cb3
+  metadata.gz: 3138db7c116e0f0742a091cad7c5ecfdbe8263de2b27c892830e56d32e259691
+  data.tar.gz: b0a87afaed52e3d66313fea3c1d1536d19934876e1e52dd6503b4e3ce112aaed
 SHA512:
-  metadata.gz: 4a3c0d99ae4b7f7725365827e4707fc56ca680bcee0fe7d0617c03bc7aa4e8c14039ee858016ad867648e4c5dec545acaec1b1b7934f6b3ed20d72d6a9d122db
-  data.tar.gz: 0b9c8b0b65b3baab555bde4c7e938c447b6b0527ea073a0abc3f9179d3ce8836e4f49221b601b20fd95446d33b40571f49f61bc25380baeba2cfe162a087b7bc
+  metadata.gz: 1e3e71b34c262d91350dd2ccd213bdbca3915d75302307dbc3e94b89b1e803b98d0568ef7ea5b94b6a197b0859b53276f337a7d4885d8cf496cddf9f5ea65904
+  data.tar.gz: a6db27db6dfc1b050c45aa5bea45d6c1862937e45998f265ccb5226a5a09df94b4f73d0be486468a421854c55b7483ff655ed554d80e880979b90f9996d122cf

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+## [0.4.0] — 2026-08-10
+
+### Changed
+
+- **Generic tools moved to the new `ask-ruby-harness` gem** — `RunCommand`,
+  `QueryDatabase`, `ReadModel`, `ReadLog`, `SchemaGraph`, and `RunTests` now
+  live in the language-agnostic harness (`Ask::Ruby::Harness`), which this
+  gem depends on. This gem keeps the Rails-native surface: the Engine
+  (mount at /ask), railtie, generators, auth, persistence, and
+  `RouteInspector`.
+- **Backward-compatible aliases** — `Ask::Rails::Harness::Tools::*`,
+  `Ask::Rails::Harness::AuditLog`, `Ask::Rails::Harness::Configuration`, and
+  `Ask::Rails::Harness::MinitestJsonReporter` still resolve (to the generic
+  implementations), and `Ask::Rails::Harness::Tool` subclasses the generic
+  base. `app_root` is pinned to `::Rails.root` by the railtie.
+- **Audit notification renamed** — the generic audit log now fires
+  `audit_log.ask_ruby_harness` (was `audit_log.ask_rails_harness`).
+
+### Removed
+
+- `lib/minitest/ask_rails_harness_plugin.rb` — superseded by
+  `minitest/ask_ruby_harness_plugin.rb` in ask-ruby-harness.
+
+## [0.3.0] — 2026-08-10
+
+### Removed
+
+- **`ReadFile`, `SearchCodebase`, `ReadRoutes` tools removed** — generic
+  file-read and grep capabilities that coding agents provide natively.
+  `RouteInspector` fully supersedes `ReadRoutes` (parsed table vs raw file,
+  including `draw`-split and engine routes). The harness now ships only
+  Rails-aware tools: `QueryDatabase`, `ReadModel`, `ReadLog`, `RunCommand`,
+  `SchemaGraph`, `RouteInspector`, `RunTests`. Skills updated to use the
+  shell `Read` tool and `RouteInspector`.
+
 ## [0.2.1] — 2026-08-10
 
 ### Fixed

data/README.md

@@ -68,15 +68,18 @@ Available settings: `default_model`, `max_turns`, `tool_concurrency`, `system_pr
 
 | Tool | What it does |
 |---|---|
-| `ReadFile` | Read any file relative to `Rails.root` |
 | `QueryDatabase` | Read-only SQL (non-SELECT rejected in production) |
 | `ReadModel` | Inspect an ActiveRecord model's columns, associations, validations |
-| `ReadRoutes` | Read `config/routes.rb` |
 | `ReadLog` | Read log files with level/search filtering |
-| `RunCommand` | Run shell commands in the app root |
-| `SearchCodebase` | Grep the codebase |
+| `RunCommand` | Run shell commands in the app root, gated by permission rules |
 | `SchemaGraph` | Full schema introspection: models, tables, columns, associations |
 | `RouteInspector` | Parsed route table with filters |
+| `RunTests` | Structured test results with failure reruns (minitest/rspec) |
+
+Generic file and search capabilities (read, grep, edit) are provided by the
+agent's native tools; the harness focuses on what only a Rails-aware layer
+can give an agent: database access, schema/model introspection, routes,
+logs, and tests — all permission-gated and audited.
 
 ## Full documentation
 

data/lib/ask/rails/harness/railtie.rb

@@ -17,6 +17,7 @@ module Ask
         end
 
         initializer "ask_rails_harness.configure" do |app|
+          Ask::Ruby::Harness.app_root = ::Rails.root
           Ask::Rails::Harness.configuration.default_model ||= ENV["ASK_DEFAULT_MODEL"] || "gpt-4o"
           Ask::Rails::Harness.configuration.max_turns ||= (ENV["ASK_MAX_TURNS"] || 25).to_i
         end

data/lib/ask/rails/harness/tool.rb

@@ -3,39 +3,10 @@
 module Ask
   module Rails
     module Harness
-      class Tool < Ask::Tool
-        def rails_root
-          ::Rails.root
-        end
-
-        # Override call to add audit logging around every tool execution.
-        # Logs the intent (sanitized params) and outcome (status, timing),
-        # but not the returned data.
-        def call(args = {}, abort_controller = nil)
-          start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-          result = super
-          duration_ms = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time) * 1000).round
-
-          AuditLog.log(
-            session_id: Thread.current[:ask_session_id],
-            tool_name: name,
-            params: args,
-            result: result,
-            duration_ms: duration_ms
-          )
-
-          result
-        end
-
-        # Allow the session to set its ID for audit log correlation.
-        # Called by the agent loop before executing a tool.
-        def self.session_id=(id)
-          Thread.current[:ask_session_id] = id
-        end
-
-        def self.session_id
-          Thread.current[:ask_session_id]
-        end
+      # The Rails edition's tool base. app_root is pinned to ::Rails.root by
+      # the railtie; everything else (audit logging, session correlation)
+      # comes from the generic ask-ruby-harness base.
+      class Tool < Ask::Ruby::Harness::Tool
       end
     end
   end

data/lib/ask/rails/harness/tools.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Backward-compatible constant aliases: the generic tools moved to
+# ask-ruby-harness (Ask::Ruby::Harness::Tools::*). Existing references to
+# Ask::Rails::Harness::Tools::*, AuditLog, and Configuration keep working.
+# (MinitestJsonReporter is intentionally not aliased — it lives behind the
+# minitest plugin and must not load minitest at app boot.)
+module Ask
+  module Rails
+    module Harness
+      Configuration = Ask::Ruby::Harness::Configuration
+      AuditLog = Ask::Ruby::Harness::AuditLog
+
+      module Tools
+        RunCommand = Ask::Ruby::Harness::Tools::RunCommand
+        QueryDatabase = Ask::Ruby::Harness::Tools::QueryDatabase
+        ReadModel = Ask::Ruby::Harness::Tools::ReadModel
+        ReadLog = Ask::Ruby::Harness::Tools::ReadLog
+        SchemaGraph = Ask::Ruby::Harness::Tools::SchemaGraph
+        RunTests = Ask::Ruby::Harness::Tools::RunTests
+      end
+    end
+  end
+end

data/lib/ask/rails/harness/version.rb

@@ -3,7 +3,7 @@
 module Ask
   module Rails
     module Harness
-      VERSION = "0.2.1"
+      VERSION = "0.4.0"
     end
   end
 end

data/lib/ask/rails/harness.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "rails"
-require "ask/agent"
+require "ask/ruby/harness"
 require "ask/auth"
 require "time"
 
@@ -9,148 +9,31 @@ module Ask
   module Rails
     module Harness
       class << self
+        # The Rails edition shares the generic configuration — the generic
+        # gem owns the runtime, this gem adapts it to Rails.
         def configure
           yield configuration
         end
 
         def configuration
-          @configuration ||= Configuration.new
+          Ask::Ruby::Harness.configuration
         end
 
         def agent_session(**extra)
-          # Auto-prune if configured
-          cleanup! if configuration.max_session_age || configuration.max_sessions
-
-          tools = configuration.tools.map { |t| t.is_a?(Class) ? t.new : t }
-          prompt = extra.delete(:system_prompt) || configuration.system_prompt || default_system_prompt
-
-          # Resolve environment-specific permissions and wire into agent hooks
-          hooks = build_environment_hooks
-
-          Ask::Agent::Session.new(
-            model: configuration.default_model,
-            max_turns: configuration.max_turns,
-            system_prompt: prompt,
-            tools: tools,
-            state: configuration.persistence_adapter,
-            hooks: hooks,
-            **extra
-          )
+          Ask::Ruby::Harness.agent_session(**extra)
         end
 
         def discover_tools!
-          self.configuration.tools = Ask::Tools::Shell::TOOLS.map(&:new) + core_rails_tools + discovered_user_tools
+          Ask::Ruby::Harness.discover_tools!
         end
 
-        # Prune old sessions and audit logs based on configuration limits.
-        #
-        # Removes sessions older than +max_session_age+ seconds, and limits the
-        # total number of sessions to +max_sessions+ (deleting the oldest first).
-        # Audit log entries older than the oldest kept session are also removed.
-        #
-        # Call manually via rake task or cron, or configure limits to auto-prune
-        # on agent_session creation.
         def cleanup!
-          prune_old_sessions
-          limit_session_count
+          Ask::Ruby::Harness.cleanup!
         end
 
         def root
           @root ||= Pathname.new(File.expand_path("../..", __dir__))
         end
-
-        private
-
-        def build_environment_hooks
-          env_mode = configuration.effective_mode
-          return {} unless env_mode
-
-          perms = Ask::Agent::Policies::Permissions.new(mode: env_mode)
-          { before_tool: [perms.method(:before_tool_call)] }
-        rescue ArgumentError => e
-          warn "[ask-rails-harness] Invalid environment mode: #{e.message}"
-          {}
-        end
-
-        def prune_old_sessions
-          age = configuration.max_session_age
-          return unless age&.> 0
-          return unless persistence_available?
-
-          cutoff = age.seconds.ago
-          count = 0
-
-          configuration.persistence_adapter.list.each do |id|
-            data = configuration.persistence_adapter.load(id)
-            created = data&.dig(:metadata, :created_at)
-            if created && Time.parse(created) < cutoff
-              configuration.persistence_adapter.delete(id)
-              count += 1
-            end
-          end
-
-          count
-        rescue StandardError
-          nil
-        end
-
-        def limit_session_count
-          max = configuration.max_sessions
-          return unless max&.> 0
-          return unless persistence_available?
-
-          sessions = configuration.persistence_adapter.list
-          excess = sessions.size - max
-          return unless excess > 0
-
-          # Delete oldest sessions first
-          with_timestamps = sessions.map { |id|
-            data = configuration.persistence_adapter.load(id)
-            created = data&.dig(:metadata, :created_at)
-            [id, created ? Time.parse(created) : Time.at(0)]
-          }.sort_by(&:last)
-
-          with_timestamps.first(excess).each do |id, _|
-            configuration.persistence_adapter.delete(id)
-          end
-
-          excess
-        rescue StandardError
-          nil
-        end
-
-        def persistence_available?
-          defined?(ActiveRecord::Base) &&
-            ActiveRecord::Base.connection.data_source_exists?("ask_sessions")
-        rescue StandardError
-          false
-        end
-
-        def core_rails_tools
-          CORE_RAILS_TOOLS.map(&:new)
-        end
-
-        def discovered_user_tools
-          tools = []
-          files = Dir[::Rails.root.join("app", "tools", "*.rb")]
-          files.each do |f|
-            require f
-            klass = File.basename(f, ".rb").camelize.constantize rescue next
-            tools << klass if klass < Ask::Rails::Harness::Tool
-          end
-          tools
-        rescue
-          tools
-        end
-
-        def default_system_prompt
-          <<~PROMPT
-            You are a Ruby on Rails software engineer.
-            You have direct access to the application's code, database, and runtime.
-            Use your tools to inspect and modify the codebase.
-            Once you have enough information, stop calling tools and give your answer.
-          PROMPT
-        end
       end
     end
   end
@@ -158,35 +41,22 @@ end
 
 require_relative "harness/version"
 require_relative "harness/engine"
-require_relative "harness/configuration"
-require_relative "harness/audit_log"
-require_relative "harness/environment_permissions"
 require_relative "harness/auth"
 require_relative "harness/persistence"
 require_relative "harness/service_discovery"
 require_relative "harness/tool"
-require_relative "harness/tools/read_file"
-require_relative "harness/tools/run_command"
-require_relative "harness/tools/search_codebase"
-require_relative "harness/tools/read_routes"
-require_relative "harness/tools/query_database"
-require_relative "harness/tools/read_model"
-require_relative "harness/tools/read_log"
-require_relative "harness/tools/schema_graph"
+require_relative "harness/tools" # backward-compat constant aliases
 require_relative "harness/tools/route_inspector"
-require_relative "harness/tools/run_tests"
-require_relative "harness/minitest_json_reporter"
 
 # Railtie is loaded only when Rails is fully available
 if defined?(::Rails::Railtie)
   require_relative "harness/railtie"
 end
 
-# Define after all tool files are loaded so the constants resolve
+# Define after all tool files are loaded so the constants resolve. The
+# generic Rails-aware tools come from ask-ruby-harness; this gem adds the
+# Rails-native ones (RouteInspector) on top.
 Ask::Rails::Harness::CORE_RAILS_TOOLS = [
-  Ask::Rails::Harness::Tools::ReadFile, Ask::Rails::Harness::Tools::RunCommand,
-  Ask::Rails::Harness::Tools::SearchCodebase, Ask::Rails::Harness::Tools::ReadRoutes,
-  Ask::Rails::Harness::Tools::QueryDatabase, Ask::Rails::Harness::Tools::ReadModel,
-  Ask::Rails::Harness::Tools::ReadLog, Ask::Rails::Harness::Tools::SchemaGraph,
-  Ask::Rails::Harness::Tools::RouteInspector, Ask::Rails::Harness::Tools::RunTests
+  *Ask::Ruby::Harness::HARNESS_TOOLS,
+  Ask::Rails::Harness::Tools::RouteInspector
 ].freeze

data/lib/ask/skills/rails.deploy_pipeline/SKILL.md

@@ -15,7 +15,7 @@ RunCommand.new.call(command: "bin/rails db:migrate:status | grep 'down'")
 ```
 
 If there are pending migrations:
-1. Review them with `ReadFile.new.call(path: "db/migrate/<TIMESTAMP>_migration_name.rb")`
+1. Review them with `Read.new.call(path: Rails.root.join("db/migrate/<TIMESTAMP>_migration_name.rb").to_s)`
 2. Verify they're reversible: check `change`, `up`/`down`, or `reversible` blocks
 3. Check for data migrations (e.g., backfills) that should run separately
 4. Estimate execution time — large tables may need locking strategy
@@ -38,8 +38,8 @@ For importmap or esbuild/vite setups:
 
 ```ruby
 # Check build config
-ReadFile.new.call(path: "package.json")
-ReadFile.new.call(path: "vite.config.ts") if File.exist?("Rails.root.join('vite.config.ts')")
+Read.new.call(path: Rails.root.join("package.json").to_s)
+Read.new.call(path: Rails.root.join("vite.config.ts").to_s) if Rails.root.join("vite.config.ts").exist?
 ```
 
 ## Step 3: Review Credentials and Secrets
@@ -70,7 +70,7 @@ Glob.new.call(pattern: "app/jobs/**/*.rb")
 For any new or modified jobs:
 1. Verify the queue adapter is configured in `production.rb`
 2. Check for job retry logic that might affect rollback
-3. Review `ReadFile.new.call(path: "config/sidekiq.yml")` if using Sidekiq
+3. Review `Read.new.call(path: Rails.root.join("config/sidekiq.yml").to_s)` if using Sidekiq
 4. Verify scheduled/cron jobs if using `sidekiq-cron` or `whenever`
 
 ## Step 5: Review Production Log for Pre-deploy Issues
@@ -102,10 +102,10 @@ RunCommand.new.call(command: "bundle platform")
 Verify configuration files for the target environment:
 
 ```ruby
-ReadFile.new.call(path: "config/environments/production.rb")
-ReadFile.new.call(path: "config/database.yml")
-ReadFile.new.call(path: "config/cable.yml") if File.exist?("config/cable.yml")
-ReadFile.new.call(path: "config/storage.yml") if File.exist?("config/storage.yml")
+Read.new.call(path: Rails.root.join("config/environments/production.rb").to_s)
+Read.new.call(path: Rails.root.join("config/database.yml").to_s)
+Read.new.call(path: Rails.root.join("config/cable.yml").to_s) if Rails.root.join("config/cable.yml").exist?
+Read.new.call(path: Rails.root.join("config/storage.yml").to_s) if Rails.root.join("config/storage.yml").exist?
 ```
 
 Key production checks:

data/lib/ask/skills/rails.route_trouble/SKILL.md

@@ -6,15 +6,17 @@ description: Step-by-step methodology for debugging routing issues in Rails
 Use this skill when a route is returning 404, you're getting route matching errors,
 or routes aren't behaving as expected in a Rails application.
 
-## Step 1: Read the Routes File
+## Step 1: Inspect the Route Table
 
-Start by examining the routes configuration:
+Start by examining the parsed route table:
 
 ```ruby
-ReadRoutes.new.call
+RouteInspector.new.call
 ```
 
-This reads `config/routes.rb` — the source of truth for all route definitions.
+This returns every route with its verb, path, controller, action, and name —
+covering routes split across `draw` files and engines that a raw read of
+`config/routes.rb` would miss.
 
 Look for:
 - The overall structure (namespaced, nested, shallow routes?)
@@ -82,7 +84,7 @@ error message tells you what routes were tried before failing.
 If the route exists but the controller isn't found:
 
 ```ruby
-ReadFile.new.call(path: "app/controllers/users_controller.rb")
+Read.new.call(path: Rails.root.join("app/controllers/users_controller.rb").to_s)
 ```
 
 ## Step 5: Check Namespace and Module Nesting

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask-rails-harness
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Kaka Ruto
@@ -24,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.1'
 - !ruby/object:Gem::Dependency
-  name: ask-tools
+  name: ask-ruby-harness
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -37,34 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: ask-tools-shell
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: ask-agent
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.28.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.28.0
 - !ruby/object:Gem::Dependency
   name: ask-auth
   requirement: !ruby/object:Gem::Requirement
@@ -135,10 +107,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-description: Rails Engine that mounts an admin AI agent at /ask. Ships 9 Rails-aware
-  tools (ReadFile, QueryDatabase, ReadModel, ReadRoutes, RouteInspector, ReadLog,
-  RunCommand, SearchCodebase, SchemaGraph), session persistence, audit logging, environment
-  permissions, and service gem discovery. Previously developed as ask-rails (0.1.0–0.11.1).
+description: Rails Engine that mounts an admin AI agent at /ask. Ships Rails-aware
+  tools (QueryDatabase, ReadModel, ReadLog, RunCommand, SchemaGraph, RouteInspector,
+  RunTests), session persistence, audit logging, environment permissions, and service
+  gem discovery. Previously developed as ask-rails (0.1.0–0.11.1).
 email:
 - kaka@myrrlabs.com
 executables: []
@@ -155,26 +127,14 @@ files:
 - config/routes.rb
 - lib/ask-rails-harness.rb
 - lib/ask/rails/harness.rb
-- lib/ask/rails/harness/audit_log.rb
 - lib/ask/rails/harness/auth.rb
-- lib/ask/rails/harness/configuration.rb
 - lib/ask/rails/harness/engine.rb
-- lib/ask/rails/harness/environment_permissions.rb
-- lib/ask/rails/harness/minitest_json_reporter.rb
 - lib/ask/rails/harness/persistence.rb
 - lib/ask/rails/harness/railtie.rb
 - lib/ask/rails/harness/service_discovery.rb
 - lib/ask/rails/harness/tool.rb
-- lib/ask/rails/harness/tools/query_database.rb
-- lib/ask/rails/harness/tools/read_file.rb
-- lib/ask/rails/harness/tools/read_log.rb
-- lib/ask/rails/harness/tools/read_model.rb
-- lib/ask/rails/harness/tools/read_routes.rb
+- lib/ask/rails/harness/tools.rb
 - lib/ask/rails/harness/tools/route_inspector.rb
-- lib/ask/rails/harness/tools/run_command.rb
-- lib/ask/rails/harness/tools/run_tests.rb
-- lib/ask/rails/harness/tools/schema_graph.rb
-- lib/ask/rails/harness/tools/search_codebase.rb
 - lib/ask/rails/harness/version.rb
 - lib/ask/skills/rails.db_debug/SKILL.md
 - lib/ask/skills/rails.deploy_pipeline/SKILL.md
@@ -183,7 +143,6 @@ files:
 - lib/generators/ask/rails/harness/install/templates/audit_log_migration.rb
 - lib/generators/ask/rails/harness/install/templates/initializer.rb
 - lib/generators/ask/rails/harness/install/templates/migration.rb
-- lib/minitest/ask_rails_harness_plugin.rb
 homepage: https://github.com/ask-rb/ask-rails-harness
 licenses:
 - MIT