ask-ruby-harness 0.1.0

data/lib/ask/ruby/harness.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+require "ask/agent"
+require "time"
+require "yaml"
+
+module Ask
+  module Ruby
+    module Harness
+      class << self
+        def configure
+          yield configuration
+        end
+
+        def configuration
+          @configuration ||= Configuration.new
+        end
+
+        # The project root the harness serves. Defaults to the current working
+        # directory; framework editions set it to the framework's root at boot
+        # (ask-rails-harness sets it to ::Rails.root).
+        def app_root
+          @app_root ||= Pathname.new(Dir.pwd)
+        end
+
+        def app_root=(path)
+          @app_root = path ? Pathname.new(path) : nil
+        end
+
+        # Environment detection without Rails: RAILS_ENV, RACK_ENV, APP_ENV.
+        def env
+          ENV["RAILS_ENV"] || ENV["RACK_ENV"] || ENV["APP_ENV"] || "development"
+        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
+          )
+        end
+
+        def discover_tools!
+          self.configuration.tools = Ask::Tools::Shell::TOOLS.map(&:new) + harness_tools + discovered_user_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.
+        def cleanup!
+          prune_old_sessions
+          limit_session_count
+        end
+
+        # Establish a standalone ActiveRecord connection when the host hasn't
+        # (Rails apps are already connected and are left untouched).
+        #
+        # Connection sources, in order: ASK_DATABASE_URL, config/database.yml.
+        def connect_database!
+          return if database_connected?
+
+          config = ENV["ASK_DATABASE_URL"] || database_config_from_yaml
+          ActiveRecord::Base.establish_connection(config) if config
+        rescue StandardError => e
+          warn "[ask-ruby-harness] database connect failed: #{e.message}"
+        end
+
+        def database_connected?
+          defined?(ActiveRecord::Base) && ActiveRecord::Base.connected?
+        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-ruby-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 harness_tools
+          HARNESS_TOOLS.map(&:new)
+        end
+
+        def discovered_user_tools
+          tools = []
+          files = Dir[app_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::Ruby::Harness::Tool
+          end
+          tools
+        rescue
+          tools
+        end
+
+        def database_config_from_yaml
+          path = app_root.join("config", "database.yml")
+          return nil unless path.exist?
+
+          yaml = YAML.safe_load(path.read, aliases: true) || {}
+          section = yaml[env] || yaml["development"] || {}
+          # Rails-style multi-database config nests the primary under a key.
+          section = section["primary"] if section.is_a?(Hash) && section["primary"].is_a?(Hash)
+          return nil unless section.is_a?(Hash)
+
+          section.slice(*Configuration::DATABASE_CONFIG_KEYS).presence
+        rescue Psych::Exception
+          nil
+        end
+
+        def default_system_prompt
+          <<~PROMPT
+            You are a Ruby software engineer.
+            You have direct access to the project'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
+end
+
+require_relative "harness/version"
+require_relative "harness/configuration"
+require_relative "harness/audit_log"
+require_relative "harness/environment_permissions"
+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/run_tests"
+
+# Define after all tool files are loaded so the constants resolve
+Ask::Ruby::Harness::HARNESS_TOOLS = [
+  Ask::Ruby::Harness::Tools::RunCommand, Ask::Ruby::Harness::Tools::QueryDatabase,
+  Ask::Ruby::Harness::Tools::ReadModel, Ask::Ruby::Harness::Tools::ReadLog,
+  Ask::Ruby::Harness::Tools::SchemaGraph, Ask::Ruby::Harness::Tools::RunTests
+].freeze

data/lib/minitest/ask_ruby_harness_plugin.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Minitest plugin for ask-ruby-harness.
+#
+# Registers the JSON reporter when a run was started by the harness's
+# run_tests tool (ASK_TEST_JSON_PATH set); ordinary test runs are untouched.
+#
+# Loading differs by minitest version:
+#   - minitest 5 auto-discovers `minitest/*_plugin.rb` files and calls
+#     init_plugins with `#{name}_plugin_init`.
+#   - minitest 6 dropped auto-discovery; the run_tests tool injects this file
+#     via RUBYOPT="-r <absolute path>" and init_plugins dispatches
+#     `plugin_#{name}_init` instead.
+# Either way, pushing the extension below (idempotent) makes init_plugins
+# dispatch to the matching init method after the composite reporter exists —
+# the only reliable point to append a reporter.
+# __dir__-based requires keep the file loadable before Bundler.setup.
+require File.expand_path("../ask/ruby/harness/minitest_json_reporter", __dir__)
+
+module Minitest
+  # Minitest 6 convention: init_plugins calls plugin_#{name}_init.
+  def self.plugin_ask_ruby_harness_init(options)
+    register_ask_ruby_harness_json_reporter(options)
+  end
+
+  # Minitest 5 convention: init_plugins calls #{name}_plugin_init.
+  def self.ask_ruby_harness_plugin_init(options)
+    register_ask_ruby_harness_json_reporter(options)
+  end
+
+  def self.register_ask_ruby_harness_json_reporter(_options)
+    path = ENV["ASK_TEST_JSON_PATH"]
+    return if path.nil? || path.to_s.empty?
+
+    Minitest.reporter << Ask::Ruby::Harness::MinitestJsonReporter.new(path)
+  end
+end
+
+Minitest.extensions << "ask_ruby_harness" unless Minitest.extensions.include?("ask_ruby_harness")

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: ask-ruby-harness
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kaka Ruto
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: ask-tools
+  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-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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Harness for AI coding agents working in any Ruby project. Ships a language-agnostic
+  tool contract (RunCommand, ReadLog, QueryDatabase, ReadModel, SchemaGraph, RunTests)
+  with structured returns, read-only DB enforcement, environment permissions, and
+  audit logging. The Rails edition (ask-rails-harness) adds framework-native tools
+  on top.
+email:
+- kaka@myrrlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/ask/ruby/harness.rb
+- lib/ask/ruby/harness/audit_log.rb
+- lib/ask/ruby/harness/configuration.rb
+- lib/ask/ruby/harness/environment_permissions.rb
+- lib/ask/ruby/harness/minitest_json_reporter.rb
+- lib/ask/ruby/harness/tool.rb
+- lib/ask/ruby/harness/tools/query_database.rb
+- lib/ask/ruby/harness/tools/read_log.rb
+- lib/ask/ruby/harness/tools/read_model.rb
+- lib/ask/ruby/harness/tools/run_command.rb
+- lib/ask/ruby/harness/tools/run_tests.rb
+- lib/ask/ruby/harness/tools/schema_graph.rb
+- lib/ask/ruby/harness/version.rb
+- lib/minitest/ask_ruby_harness_plugin.rb
+homepage: https://github.com/ask-rb/ask-ruby-harness
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ask-rb/ask-ruby-harness
+  source_code_uri: https://github.com/ask-rb/ask-ruby-harness
+  changelog_uri: https://github.com/ask-rb/ask-ruby-harness/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Admin AI copilot for Ruby projects — structured DB access, logs, commands,
+  and tests
+test_files: []