ask-rails-harness 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70e5e797b91144992c18866c357d73811226b3281955a208437eed7ae02b0b63
-  data.tar.gz: c110d660dbd193597f1bfcbae2ea5b3184f676984d4e9dc1ce9401df899d36e4
+  metadata.gz: 3138db7c116e0f0742a091cad7c5ecfdbe8263de2b27c892830e56d32e259691
+  data.tar.gz: b0a87afaed52e3d66313fea3c1d1536d19934876e1e52dd6503b4e3ce112aaed
 SHA512:
-  metadata.gz: ce9d990603fed30ed9bdf9ee20cd3087694dc7739f3751d03343f9f4d0b6a957bd9b8ba7b7146a58a45c002ef8931d26766548ed3e50aed2233acbfe16595746
-  data.tar.gz: 353fbc3c92ba503b3d6bb9732d9030c4d967279584814810768c32556b98c6584eaa5465b33eef3e0e00425f163e5a6466136aa040d8bb0342847a068c6a4959
+  metadata.gz: 1e3e71b34c262d91350dd2ccd213bdbca3915d75302307dbc3e94b89b1e803b98d0568ef7ea5b94b6a197b0859b53276f337a7d4885d8cf496cddf9f5ea65904
+  data.tar.gz: a6db27db6dfc1b050c45aa5bea45d6c1862937e45998f265ccb5226a5a09df94b4f73d0be486468a421854c55b7483ff655ed554d80e880979b90f9996d122cf

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## [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

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.3.0"
+      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,31 +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/run_command"
-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::RunCommand,
-  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask-rails-harness
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  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
@@ -155,23 +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_log.rb
-- lib/ask/rails/harness/tools/read_model.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/version.rb
 - lib/ask/skills/rails.db_debug/SKILL.md
 - lib/ask/skills/rails.deploy_pipeline/SKILL.md
@@ -180,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

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

@@ -1,185 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-module Ask
-  module Rails
-    module Harness
-      # Append-only audit log for tool executions.
-      #
-      # Every tool call made by an agent is recorded in the +ask_audit_logs+
-      # table with the intent (sanitized params) and outcome (status, timing),
-      # but not the data returned. This gives a trustworthy, queryable record
-      # of what the agent did without becoming a PII liability.
-      #
-      # Sensitive param values (keys matching +password+, +secret+, +token+,
-      # +api_key+, +key+) are automatically redacted before logging.
-      module AuditLog
-        SENSITIVE_KEYS = /\A(password|secret|token|api_key|key|auth_token|access_token)\z/i
-
-        class << self
-          # Log a tool execution event.
-          #
-          # @param session_id [String] The agent session that triggered this call
-          # @param tool_name [String] Name of the tool that ran
-          # @param params [Hash] The parameters passed to the tool (sanitized automatically)
-          # @param result [Ask::Result, Hash, nil] The result returned by the tool
-          # @param error [StandardError, nil] The exception if the tool raised
-          # @param duration_ms [Integer] Wall-clock time for the tool execution
-          # @param user_context [Hash, nil] Who initiated the session (from config)
-          def log(session_id:, tool_name:, params:, result: nil, error: nil, duration_ms:)
-            now = Time.now.utc
-            entry = {
-              session_id: session_id,
-              tool_name: tool_name,
-              params: sanitize_params(params),
-              result_summary: build_summary(tool_name, result, error),
-              status: determine_status(result, error),
-              error_message: determine_error(result, error),
-              duration_ms: duration_ms,
-              user_context: resolve_user_context,
-              environment: environment_name,
-              recorded_at: now,
-              created_at: now,
-              updated_at: now
-            }
-
-            if table_exists?
-              write_entry(entry)
-            end
-
-            # Fire an ActiveSupport notification so host apps can subscribe
-            ActiveSupport::Notifications.instrument("audit_log.ask_rails_harness", entry)
-
-            entry
-          end
-
-          private
-
-          def sanitize_params(params)
-            return {} unless params.is_a?(Hash)
-
-            params.each_with_object({}) do |(key, value), sanitized|
-              if SENSITIVE_KEYS.match?(key.to_s)
-                sanitized[key] = "[REDACTED]"
-              else
-                sanitized[key] = value
-              end
-            end
-          end
-
-          def determine_status(result, error)
-            return "error" if error
-            return "rejected" if result.is_a?(Ask::Result) && (result.error? || result.blocked?)
-            "success"
-          end
-
-          def determine_error(result, error)
-            return error.message if error
-            if result.is_a?(Ask::Result)
-              return result.error.to_s if result.error?
-              return result.content.to_s if result.blocked?
-            end
-            nil
-          end
-
-          def extract_data(result)
-            return nil unless result
-
-            if result.is_a?(Ask::Result)
-              result.content.is_a?(Hash) ? result.content : nil
-            elsif result.is_a?(Hash)
-              result
-            else
-              nil
-            end
-          end
-
-          def build_summary(tool_name, result, error)
-            if error
-              return { error: error.class.name }
-            end
-
-            if result.is_a?(Ask::Result)
-              if result.error?
-                return { error: "rejected: #{result.error.to_s.truncate(200)}" }
-              end
-              if result.blocked?
-                return { error: "blocked: #{result.content.to_s.truncate(200)}" }
-              end
-            end
-
-            data = extract_data(result)
-            return {} unless data
-
-            summary = {}
-            summary[:rows] = data[:rows]&.length if data.key?(:rows)
-            summary[:columns] = data[:columns]&.length if data.key?(:columns)
-            summary[:exit_status] = data[:exit_status] if data.key?(:exit_status)
-            summary[:size] = data[:size] if data.key?(:size)
-            summary[:matched_lines] = data[:matched_lines] if data.key?(:matched_lines)
-            summary[:results] = data[:results]&.length if data.key?(:results)
-            summary[:model] = data[:name] if data.key?(:name)
-            summary
-          end
-
-          def resolve_user_context
-            proc = Ask::Rails::Harness.configuration.current_user
-            return nil unless proc.respond_to?(:call)
-
-            result = proc.call
-            result.is_a?(Hash) ? result : nil
-          rescue StandardError
-            nil
-          end
-
-          def environment_name
-            defined?(::Rails) && ::Rails.respond_to?(:env) ? ::Rails.env.to_s : "unknown"
-          end
-
-          def table_exists?
-            return false unless defined?(ActiveRecord::Base)
-
-            # Only cache the true result — recheck if it was false
-            return @table_exists if @table_exists
-
-            @table_exists = begin
-              conn = ActiveRecord::Base.connection
-              conn.data_source_exists?("ask_audit_logs")
-            rescue StandardError
-              false
-            end
-          end
-
-          def write_entry(entry)
-            # Serialize JSON fields for database storage
-            serialized = entry.dup
-            %i[params result_summary user_context].each do |key|
-              serialized[key] = ::JSON.generate(serialized[key]) if serialized[key].is_a?(Hash)
-            end
-
-            # Use raw SQL to avoid requiring a model class
-            columns = serialized.keys
-            values = columns.map { |col| ActiveRecord::Base.connection.quote(serialized[col]) }
-            ActiveRecord::Base.connection.execute(
-              "INSERT INTO ask_audit_logs (#{columns.join(', ')})
-               VALUES (#{values.join(', ')})"
-            )
-          rescue StandardError => e
-            # Silently fail — audit log should never crash the caller.
-            # ::Rails avoids the bare-`Rails` constant resolving to Ask::Rails;
-            # `&.` guards against Rails.logger returning nil (no app booted).
-            ::Rails.logger&.warn("[ask-rails-harness] Audit log write failed: #{e.message}") if defined?(::Rails.logger)
-          end
-
-          # Reset cached table check (useful in tests)
-          public
-
-          def reset_table_check!
-            @table_exists = nil
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-module Ask
-  module Rails
-    module Harness
-      class Configuration
-        attr_accessor :default_model, :max_turns, :system_prompt,
-                      :tool_concurrency, :persistence_adapter, :tools,
-                      :current_user, :allowed_commands, :denied_commands,
-                      :max_session_age, :max_sessions
-
-        # @return [Hash{Symbol => EnvironmentPermissions}] per-environment permission rules
-        attr_reader :environments
-
-        def initialize
-          @default_model = "gpt-4o"
-          @max_turns = 25
-          @system_prompt = nil
-          @tool_concurrency = 5
-          @persistence_adapter = nil
-          @tools = []
-          @current_user = nil
-          @allowed_commands = nil
-          @denied_commands = nil
-          @max_session_age = nil
-          @max_sessions = nil
-          @environments = {}
-        end
-
-        # Configure permissions for a specific Rails environment.
-        #
-        #   config.environment :production do |env|
-        #     env.mode = :read_only
-        #     env.allowed_commands = [/^rails routes/]
-        #     env.denied_commands = [/rm/, /dropdb/]
-        #   end
-        #
-        # @param name [Symbol, String] environment name (:production, :development, :staging, etc.)
-        def environment(name)
-          env = EnvironmentPermissions.new
-          yield env
-          @environments[name.to_sym] = env
-        end
-
-        # Resolved allowed commands for the current Rails environment.
-        # Falls back to the global +allowed_commands+ if no per-env config.
-        #
-        # @return [Array<Regexp>, nil]
-        def effective_allowed_commands
-          env = @environments[::Rails.env.to_sym]
-          env&.allowed_commands || @allowed_commands
-        end
-
-        # Resolved denied commands for the current Rails environment.
-        # Falls back to the global +denied_commands+ if no per-env config.
-        #
-        # @return [Array<Regexp>, nil]
-        def effective_denied_commands
-          env = @environments[::Rails.env.to_sym]
-          env&.denied_commands || @denied_commands
-        end
-
-        # Resolved access mode for the current Rails environment.
-        #
-        # @return [Symbol, nil] +:full_access+, +:read_only+, +:ask_before_changes+, or nil
-        def effective_mode
-          env = @environments[::Rails.env.to_sym]
-          env&.mode || nil
-        end
-      end
-    end
-  end
-end