ask-rails 0.2.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6e0eb7fb3f6797eb16e096b2f2e5b0c79eb002d697be20df6ac0b2bbe5abf3a
-  data.tar.gz: 4c6ffe88deca00e9e43472e286fb37630ba30953a5488d577a37ee805ccd7b73
+  metadata.gz: 1a8258ca96d9513529bc1c0c9c54bd8e2492a110e48d90c9af3f53ca3aa24d9f
+  data.tar.gz: 4a776f46230d7a87719d5a6e12154e90987f71f60af63707da686ba2cce20377
 SHA512:
-  metadata.gz: 3aafbab19ef97841a392242282f19886624412ec92602dfc525dcfd2743f05adc523f2604c139e847a9078ec307f596c85005796d8dab484ca32bb84bcd36e3e
-  data.tar.gz: 0f13102f41d739aa2215684508a8d705df6ef2ad842b2404d4232bf4b689840ec0eca0153ea71f503ce114eadb11bd0396bee6d3d30202e9376caf04ebd506bc
+  metadata.gz: 894f5146923889fd014f1ac770c52eba2cfdc6d84fd546062c05ac85473f6e716e70a298761f25a19ea1b00ba60461aae3ab38889c05a95698d891320879cc86
+  data.tar.gz: d58b94569c064b58493bd0a929cfb1dde3310a43c110c92474947c57e711f5a4e6d57ca596c389e73fcb4ee6bddeff7e8797bc5915ca8e4cbf94eadaf5f2353d

data/CHANGELOG.md

@@ -1,35 +1,7 @@
-## [0.2.5] - 2026-06-25
-
-### Changed
-- Expanded tests: Persistence(7t), Configuration(7t), ServiceDiscovery(5t), Engine(7t), InstallGenerator(7t), Tools(24t with live DB). Infrastructure: rubocop, overcommit, CI matrix, Appraisals, gemspec.
-## 0.2.4 (2026-06-21)
+## [0.1.0] — 2026-07-26
 
 ### Added
-- `Ask::Rails::Engine` — Rails engine for autoloading and generator discovery
-- Skills directory with methodology skills (rails.db_debug, rails.deploy_pipeline, rails.route_trouble)
-- Gemspec metadata for Rubygems discovery
-
-# Changelog
 
-## 0.2.0 (2026-06-10)
-
-### Added
-- `Ask::Rails::QueryDatabase` — read-only SQL queries via ActiveRecord with auto-LIMIT, 
-  binary column handling, and production write guards
-- `Ask::Rails::ReadModel` — structured model introspection returning columns, associations,
-  validators, and primary keys; supports detail filtering
-- `Ask::Rails::ReadLog` — filtered log reading that tail-reads from end of file, supports
-  level filtering (ERROR/WARN/INFO/DEBUG), case-insensitive search, and automatically
-  detects log rotation files
-
-## 0.1.0 (2026-06-10)
-
-### Added
-- Railtie — `Ask::Rails::Railtie` configures and discovers tools/services on boot
-- Configuration — `Ask::Rails::Configuration` with `default_model`, `max_turns`, `system_prompt`, `tool_concurrency`
-- Session Factory — `Ask::Rails.agent_session` creates pre-configured `Ask::Agent::Session`
-- Service Discovery — auto-discovers installed `ask-*` service gems, injects context into system prompt
-- AR Persistence — `Ask::Rails::Persistence` saves/loads session state to database
-- Rails Tools — `ReadFile`, `RunCommand`, `SearchCodebase`, `ReadRoutes` (Rails.root-aware)
-- Generators — `rails generate ask_rails:install` creates migration, initializer, `app/tools/`
-- Dependencies: rails >= 7.1, ask-tools, ask-tools-shell, ask-agent, ask-auth
+- Initial release of `ask-rails` — Rails integration for the ask-rb ecosystem.
+- **Install generator** — `rails generate ask:install` creates `config/initializers/ask.rb`, `app/agents/application_agent.rb`, and `app/agents/` directory.
+- **Railtie** — Wires `Ask::Agent.logger` to `Rails.logger`, discovers agent definitions in `app/agents/`.

data/README.md

@@ -1,34 +1,59 @@
 # ask-rails
 
-Rails integration for the ask-rb ecosystem. The only gem a Rails app needs to join
-the ask-rb stack — provides a Railtie, AR session persistence, a session factory,
-automatic service gem discovery, and generators.
+Rails integration for the [ask-rb](https://github.com/ask-rb) ecosystem. Provides generators, file conventions, and railtie for using AI agents in your Rails app.
 
 ## Installation
 
 ```bash
 bundle add ask-rails
-rails generate ask_rails:install
+rails generate ask:install
 ```
 
+This creates:
+- `config/initializers/ask.rb` — agent configuration
+- `app/agents/application_agent.rb` — base class for your agents
+- `app/agents/` — directory for agent definitions
+
 ## Usage
 
+Define an agent:
+
 ```ruby
-# In any Rails context
-session = Ask::Rails.agent_session
-session.run("Find all open issues labeled 'bug' in our repo")
+# app/agents/support_bot.rb
+class Agents::SupportBot < ApplicationAgent
+  model "gpt-4o"
+  system_prompt "You help users with support questions."
+
+  tool :bash
+  tool :read
+  tool :grep
+end
 ```
 
-Service gems like `ask-github`, `ask-slack` are auto-discovered — the agent gets their
-context (auth info, quick-start snippets, error guides) in the system prompt automatically.
+Run it:
+
+```ruby
+agent = Ask::Agent.new("support_bot")
+response = agent.run("Find all open issues in the codebase")
+puts response
+```
 
-## Development
+Or use `Ask.chat` for one-off conversations:
 
-```bash
-bin/setup
-bundle exec rake test
+```ruby
+Ask.chat("Summarize this article: #{text}")
 ```
 
+## Configuration
+
+API keys are resolved automatically by `Ask::Auth`:
+
+- **Environment variables:** `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, etc.
+- **Rails credentials:** `rails credentials:edit` → add `ask.openai`, `ask.anthropic`
+- **File:** `~/.ask/credentials.yml`
+
+No manual credential setup is required.
+
 ## License
 
 MIT

data/lib/ask/rails/generators/install/install_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Ask
+  module Rails
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+
+        desc "Sets up ask-rb for Rails — creates initializer and app/agents/ directory"
+
+        def create_initializer
+          template "initializer.rb", "config/initializers/ask.rb"
+        end
+
+        def create_application_agent
+          template "application_agent.rb", "app/agents/application_agent.rb"
+        end
+
+        def create_agents_directory
+          empty_directory "app/agents"
+          create_file "app/agents/.keep", "" unless options[:skip_keep]
+        end
+      end
+    end
+  end
+end

data/lib/ask/rails/generators/install/templates/application_agent.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Base class for your application's AI agents.
+#
+# Subclass this to define agents:
+#
+#   class Agents::SupportBot < ApplicationAgent
+#     model "gpt-4o"
+#     system_prompt "You help users with support questions."
+#
+#     tool :search_knowledge_base
+#   end
+#
+# Then run:
+#   agent = Ask::Agent.new("support_bot")
+#   agent.run("How do I reset my password?")
+#
+class ApplicationAgent < Ask::Agent::Definition
+  # Default instructions — override in subclasses
+  system_prompt "You are a helpful assistant."
+
+  # Uncomment to add built-in tools:
+  # tool :bash
+  # tool :read
+  # tool :grep
+end

data/lib/ask/rails/generators/install/templates/initializer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Ask Agent Configuration
+# ========================
+#
+# API keys are resolved automatically by Ask::Auth:
+#   - Environment variables: OPENAI_API_KEY, ANTHROPIC_API_KEY, etc.
+#   - Rails credentials: rails credentials:edit → ask.openai, ask.anthropic
+#   - ~/.ask/credentials.yml
+#
+# See https://github.com/ask-rb/ask-auth for details.
+
+Ask::Agent.configure do |config|
+  # config.default_model = "gpt-4o"
+end

data/lib/ask/rails/railtie.rb

@@ -3,25 +3,8 @@
 module Ask
   module Rails
     class Railtie < ::Rails::Railtie
-      rake_tasks do
-        # Load rake tasks if any
-      end
-
       generators do
-        require_relative "../../generators/ask/rails/install/install_generator"
-      end
-
-      initializer "ask_rails.configure" do |app|
-        Ask::Rails.configuration.default_model ||= ENV["ASK_DEFAULT_MODEL"] || "gpt-4o"
-        Ask::Rails.configuration.max_turns ||= (ENV["ASK_MAX_TURNS"] || 25).to_i
-      end
-
-      initializer "ask_rails.discover_tools", after: :eager_load_most do
-        Ask::Rails.discover_tools!
-      end
-
-      initializer "ask_rails.discover_services", after: :eager_load_most do
-        Ask::Rails::ServiceDiscovery.discover!
+        require_relative "generators/install/install_generator"
       end
     end
   end

data/lib/ask/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Ask
   module Rails
-    VERSION = "0.2.5"
+    VERSION = "0.4.0"
   end
 end

data/lib/ask/rails.rb

@@ -1,80 +1,11 @@
 # frozen_string_literal: true
 
-require "rails"
 require "ask/agent"
-require "ask/auth"
 
 module Ask
   module Rails
-    class << self
-      def configure
-        yield configuration
-      end
-
-      def configuration
-        @configuration ||= Configuration.new
-      end
-
-      def agent_session(**extra)
-        tools = configuration.tools.map { |t| t.is_a?(Class) ? t.new : t }
-        prompt = extra.delete(:system_prompt) || configuration.system_prompt || default_system_prompt
-
-        Ask::Agent::Session.new(
-          model: configuration.default_model,
-          max_turns: configuration.max_turns,
-          system_prompt: prompt,
-          tools: tools,
-          persistence: configuration.persistence_adapter,
-          **extra
-        )
-      end
-
-      def discover_tools!
-        self.configuration.tools = Ask::Tools::Shell::TOOLS.map(&:new) + discovered_rails_tools
-      end
-
-      def root
-        @root ||= Pathname.new(File.expand_path("..", __dir__))
-      end
-
-      private
-
-      def discovered_rails_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::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
 
 require_relative "rails/version"
-require_relative "rails/engine"
-require_relative "rails/configuration"
-require_relative "rails/railtie"
-require_relative "rails/persistence"
-require_relative "rails/service_discovery"
-require_relative "rails/tool"
-require_relative "rails/tools/read_file"
-require_relative "rails/tools/run_command"
-require_relative "rails/tools/search_codebase"
-require_relative "rails/tools/read_routes"
-require_relative "rails/tools/query_database"
-require_relative "rails/tools/read_model"
-require_relative "rails/tools/read_log"
+require_relative "rails/railtie" if defined?(::Rails::Railtie)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Kaka Ruto
@@ -23,34 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.1'
-- !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
@@ -65,34 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: ask-auth
-  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: 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
@@ -135,8 +79,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-description: Railtie, AR session persistence, session factory, service gem discovery,
-  and generators.
+description: Rails generators, file conventions, and railtie for using ask-agent in
+  Rails apps.
 email:
 - kaka@myrrlabs.com
 executables: []
@@ -148,33 +92,18 @@ files:
 - README.md
 - lib/ask-rails.rb
 - lib/ask/rails.rb
-- lib/ask/rails/configuration.rb
-- lib/ask/rails/engine.rb
-- lib/ask/rails/persistence.rb
+- lib/ask/rails/generators/install/install_generator.rb
+- lib/ask/rails/generators/install/templates/application_agent.rb
+- lib/ask/rails/generators/install/templates/initializer.rb
 - lib/ask/rails/railtie.rb
-- lib/ask/rails/service_discovery.rb
-- lib/ask/rails/tool.rb
-- lib/ask/rails/tools/query_database.rb
-- lib/ask/rails/tools/read_file.rb
-- lib/ask/rails/tools/read_log.rb
-- lib/ask/rails/tools/read_model.rb
-- lib/ask/rails/tools/read_routes.rb
-- lib/ask/rails/tools/run_command.rb
-- lib/ask/rails/tools/search_codebase.rb
 - lib/ask/rails/version.rb
-- lib/ask/skills/rails.db_debug/SKILL.md
-- lib/ask/skills/rails.deploy_pipeline/SKILL.md
-- lib/ask/skills/rails.route_trouble/SKILL.md
-- lib/generators/ask/rails/install/install_generator.rb
-- lib/generators/ask/rails/install/templates/initializer.rb
-- lib/generators/ask/rails/install/templates/migration.rb
 homepage: https://github.com/ask-rb/ask-rails
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ask-rb/ask-rails
   source_code_uri: https://github.com/ask-rb/ask-rails
-  changelog_uri: https://github.com/ask-rb/ask-rails/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/ask-rb/ask-rails/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib

data/lib/ask/rails/configuration.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Ask
-  module Rails
-    class Configuration
-      attr_accessor :default_model, :max_turns, :system_prompt,
-                    :tool_concurrency, :persistence_adapter, :tools
-
-      def initialize
-        @default_model = "gpt-4o"
-        @max_turns = 25
-        @system_prompt = nil
-        @tool_concurrency = 5
-        @persistence_adapter = nil
-        @tools = []
-      end
-    end
-  end
-end

data/lib/ask/rails/engine.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "railtie"
-
-module Ask
-  module Rails
-    class Engine < ::Rails::Engine
-      isolate_namespace Ask::Rails
-    end
-  end
-end

data/lib/ask/rails/persistence.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Ask
-  module Rails
-    class Persistence
-      def initialize(model_class: nil)
-        @model_class = model_class
-      end
-
-      def save(session_id, data)
-        record = model_class.find_or_initialize_by(session_id: session_id)
-        record.update!(data: data)
-      end
-
-      def load(session_id)
-        record = model_class.find_by(session_id: session_id)
-        record&.data
-      end
-
-      def delete(session_id)
-        model_class.where(session_id: session_id).delete_all
-      end
-
-      def list
-        model_class.pluck(:session_id)
-      end
-
-      private
-
-      def model_class
-        @model_class || (raise "No model class configured. Use Persistence.new(model_class: MyModel)")
-      end
-    end
-  end
-end

data/lib/ask/rails/service_discovery.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Ask
-  module Rails
-    module ServiceDiscovery
-      SERVICE_GEMS_PATTERN = /\Aask-(?!tools|tools-shell|agent|rails|core|auth|schema|llm)/
-
-      module_function
-
-      def discover!
-        service_gems = Gem.loaded_specs.keys.select { |name| name.match?(SERVICE_GEMS_PATTERN) }
-        contexts = []
-
-        service_gems.each do |name|
-          begin
-            require "#{name.tr("-", "/")}/context"
-            mod = name.split("-").map(&:capitalize).join.constantize
-            contexts << mod if mod.respond_to?(:const_defined?) && mod.const_defined?(:DESCRIPTION)
-          rescue LoadError, NameError
-          end
-        end
-
-        unless contexts.empty?
-          prompt = build_system_prompt(contexts)
-          existing = Ask::Rails.configuration.system_prompt
-          Ask::Rails.configuration.system_prompt = [existing, prompt].compact.join("\n\n")
-        end
-
-        contexts
-      end
-
-      def build_system_prompt(contexts)
-        sections = ["## Available Services"]
-
-        contexts.each do |mod|
-          name = mod.respond_to?(:name) ? mod.name.to_s.split("::").last || "Unknown" : "Unknown"
-          sections << "### #{name}"
-          sections << mod::DESCRIPTION if mod.const_defined?(:DESCRIPTION)
-          sections << "Documentation: #{mod::DOCS_URL}" if mod.const_defined?(:DOCS_URL)
-          sections << "Authentication: #{mod::AUTH_HOW}" if mod.const_defined?(:AUTH_HOW)
-          sections << ""
-        end
-
-        sections.join("\n")
-      end
-    end
-  end
-end

data/lib/ask/rails/tool.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Ask
-  module Rails
-    class Tool < Ask::Tool
-      def rails_root
-        ::Rails.root
-      end
-    end
-  end
-end

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

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module Ask
-  module Rails
-    module Tools
-      class QueryDatabase < Ask::Rails::Tool
-        description "Run a read-only SQL query against the application database. " \
-                     "Returns columns and rows. Only SELECT queries are allowed in production."
-
-        param :sql,   type: :string, desc: "SQL query (SELECT only in production)", required: true
-        param :limit, type: :integer, desc: "Max rows to return (default 50)", required: false
-
-        WRITE_STATEMENTS = /\A\s*(INSERT|UPDATE|DELETE|DROP|TRUNCATE|ALTER|CREATE|GRANT|REVOKE)\b/i
-
-        def execute(sql:, limit: 50)
-          sql = sql.strip
-
-          if WRITE_STATEMENTS.match?(sql)
-            return Ask::Result.failure(
-              "Only SELECT queries are allowed. Write statements (#{sql.match(WRITE_STATEMENTS)[1]}) are rejected in all environments."
-            )
-          end
-
-          if ::Rails.env.production? && !sql.match?(/\A\s*SELECT\b/i)
-            return Ask::Result.failure(
-              "Only SELECT queries are allowed in the production environment."
-            )
-          end
-
-          pool = ActiveRecord::Base.connection_pool
-          pool.with_connection do |conn|
-            limited_sql = sql.match?(/\bLIMIT\b/i) ? sql : "#{sql.chomp(';')} LIMIT #{limit.to_i}"
-            result = conn.exec_query(limited_sql)
-            columns = result.columns
-            rows = result.rows.first(limit.to_i).map { |row| build_row(row, columns) }
-            {
-              columns: columns,
-              rows: rows,
-              count: rows.size,
-              truncated: result.rows.size > limit.to_i
-            }
-          end
-        rescue ActiveRecord::StatementInvalid => e
-          Ask::Result.failure("SQL error: #{e.message}")
-        rescue ActiveRecord::ConnectionNotEstablished => e
-          Ask::Result.failure("Database not connected: #{e.message}. Verify the database is running and Rails is connected.")
-        end
-
-        private
-
-        def build_row(row, columns)
-          columns.each_with_index.each_with_object({}) do |(col, i), hash|
-            value = row[i]
-            hash[col] = sanitize_value(value)
-          end
-        end
-
-        def sanitize_value(value)
-          return "[BINARY DATA]" if binary_value?(value)
-          return value.iso8601 if value.respond_to?(:iso8601)
-          value
-        end
-
-        def binary_value?(value)
-          value.is_a?(String) && value.encoding == Encoding::ASCII_8BIT && value.bytesize > 0
-        rescue
-          false
-        end
-      end
-    end
-  end
-end

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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Ask
-  module Rails
-    module Tools
-      class ReadFile < Ask::Rails::Tool
-        description "Read a file from the Rails app. Paths are relative to Rails.root."
-
-        param :path, type: :string, desc: "Relative path from Rails.root", required: true
-
-        def execute(path:)
-          full_path = rails_root.join(path)
-          return Ask::Result.error(message: "File not found: #{path}") unless full_path.exist?
-
-          content = full_path.read
-          Ask::Result.success(
-            data: { path: path, content: content, size: content.length },
-            metadata: { path: path, size: content.length }
-          )
-        end
-      end
-    end
-  end
-end