active-query-explorer 0.1.0

data/lib/active_query_explorer/query_discovery.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module ActiveQueryExplorer
+  class QueryDiscovery
+    def grouped_queries
+      query_classes = ActiveQuery::Base.registry.select { |k| k.is_a?(Class) }
+      query_classes.group_by { |klass| namespace_for(klass) }.map do |namespace, klasses|
+        {
+          namespace: namespace,
+          query_objects: klasses.map { |k| query_object_payload(k) }
+        }
+      end
+    end
+
+    def find_query_class!(name)
+      ActiveQuery::Base.registry.find { |k| k.name == name } or
+        raise NameError, "Unknown query class: #{name}"
+    end
+
+    def find_query_def!(klass, query_name)
+      (klass.queries || []).find { |q| q[:name] == query_name } or
+        raise NameError, "Unknown query :#{query_name} on #{klass.name}"
+    end
+
+    private
+
+    def query_object_payload(klass)
+      {
+        class_name: klass.name,
+        source_location: source_location_for(klass),
+        queries: (klass.queries || []).map do |q|
+          {
+            name: q[:name],
+            description: q[:description],
+            params: (q[:args_def] || {}).map do |name, config|
+              {
+                name: name,
+                type: config[:type]&.name,
+                optional: config[:optional] || false,
+                default: config[:default]
+              }.compact
+            end
+          }
+        end
+      }
+    end
+
+    def source_location_for(klass)
+      file, line = Object.const_source_location(klass.name)
+      return nil unless file
+      { file: file, line: line }
+    end
+
+    def namespace_for(klass)
+      name = klass.name.to_s
+      last_separator = name.rindex("::")
+      last_separator ? name[0...last_separator] : ""
+    end
+  end
+end

data/lib/active_query_explorer/query_executor.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ActiveQueryExplorer
+  class QueryExecutor
+    def execute(klass, query_name, raw_args, args_def)
+      args = coerce_args(raw_args, args_def)
+
+      if args.empty?
+        klass.public_send(query_name)
+      else
+        klass.public_send(query_name, args)
+      end
+    end
+
+    private
+
+    def coerce_args(args_hash, args_def)
+      return {} if args_hash.blank?
+
+      permitted_keys = args_def.keys.map(&:to_s)
+      safe_args = args_hash.permit(*permitted_keys).to_h.symbolize_keys
+
+      safe_args.each_with_object({}) do |(key, value), result|
+        next if value.blank? && (args_def.dig(key, :optional) == true)
+
+        type = args_def.dig(key, :type)
+        result[key] = coerce_value(value, type)
+      end
+    end
+
+    def coerce_value(value, type)
+      return value.to_s unless type && ActiveQuery::TypeRegistry.coercer?(type)
+
+      ActiveQuery::TypeRegistry.coerce(type, value)
+    end
+  end
+end

data/lib/active_query_explorer/query_text_formatter.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ActiveQueryExplorer
+  class QueryTextFormatter
+    def format(grouped_queries)
+      grouped_queries.flat_map { |group| format_group(group) }.join("\n")
+    end
+
+    private
+
+    def format_group(group)
+      group[:query_objects].map { |qo| format_query_object(qo, group[:namespace]) }
+    end
+
+    def format_query_object(query_object, namespace)
+      query_object[:queries].map do |query|
+        format_query(query, query_object, namespace)
+      end.join("\n")
+    end
+
+    def format_query(query, query_object, namespace)
+      lines = []
+      lines << "=== QUERY START ==="
+      lines << "name: #{query_object[:class_name]}##{query[:name]}"
+      lines << "namespace: #{namespace.presence || "root"}"
+      lines << "description: #{query[:description] || "unknown"}"
+      lines << "returns: unknown"
+      lines << "side_effects: unknown"
+      lines << "idempotent: unknown"
+      lines << "safety: unknown"
+      lines << ""
+      lines << format_inputs(query[:params])
+      lines << "=== QUERY END ==="
+      lines.join("\n")
+    end
+
+    def format_inputs(params)
+      return "inputs: none" if params.nil? || params.empty?
+
+      lines = ["inputs:"]
+      params.each do |param|
+        lines << "- name: #{param[:name]}"
+        lines << "  type: #{param[:type] || "unknown"}"
+        lines << "  required: #{!param[:optional]}"
+        lines << "  default: #{param.key?(:default) ? param[:default].inspect : "none"}"
+      end
+      lines.join("\n")
+    end
+  end
+end

data/lib/active_query_explorer/result_serializer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ActiveQueryExplorer
+  class ResultSerializer
+    def initialize(limit: ActiveQueryExplorer.result_limit)
+      @limit = limit
+    end
+
+    def serialize(result)
+      case result
+      when ActiveRecord::Relation then result.limit(@limit).as_json
+      when Integer, Float, String, NilClass, TrueClass, FalseClass then result
+      when ActiveRecord::Base then result.as_json
+      when Enumerable then result.first(@limit).as_json
+      else result.as_json
+      end
+    end
+  end
+end

data/lib/active_query_explorer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveQueryExplorer
+  VERSION = "0.1.0"
+end

data/lib/active_query_explorer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "active_query"
+require_relative "active_query_explorer/version"
+require_relative "active_query_explorer/query_discovery"
+require_relative "active_query_explorer/query_executor"
+require_relative "active_query_explorer/result_serializer"
+require_relative "active_query_explorer/query_text_formatter"
+require_relative "active_query_explorer/engine" if defined?(Rails::Engine)
+
+module ActiveQueryExplorer
+  mattr_accessor :result_limit, default: 100
+  mattr_accessor :query_paths, default: %w[queries query_objects]
+  mattr_accessor :discovery_class, default: QueryDiscovery
+  mattr_accessor :executor_class, default: QueryExecutor
+  mattr_accessor :serializer_class, default: ResultSerializer
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: active-query-explorer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matias Asis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active-query
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ActiveQuery Explorer provides a web GUI (similar to GraphiQL) that discovers
+  all registered ActiveQuery objects, displays their metadata, and allows executing
+  them with parameters.
+email:
+- matiasis.90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- active-query-explorer.gemspec
+- app/assets/javascripts/active_query_explorer/application.js
+- app/assets/stylesheets/active_query_explorer/application.css
+- app/controllers/active_query_explorer/queries_controller.rb
+- app/views/active_query_explorer/queries/index.html.erb
+- config/routes.rb
+- lib/active_query_explorer.rb
+- lib/active_query_explorer/engine.rb
+- lib/active_query_explorer/query_discovery.rb
+- lib/active_query_explorer/query_executor.rb
+- lib/active_query_explorer/query_text_formatter.rb
+- lib/active_query_explorer/result_serializer.rb
+- lib/active_query_explorer/version.rb
+homepage: https://github.com/matiasasis/active-query-explorer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/matiasasis/active-query-explorer
+  source_code_uri: https://github.com/matiasasis/active-query-explorer
+  bug_tracker_uri: https://github.com/matiasasis/active-query-explorer/issues
+  changelog_uri: https://github.com/matiasasis/active-query-explorer/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: A mountable Rails engine for browsing and executing ActiveQuery query objects.
+test_files: []