appquery 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10872e5424d3f5853f5317384cd44927241c74ac6f1df8ba41f925796384816b
-  data.tar.gz: eaa746cb1b2c7b2a48058ae1ceb1374245b6a197fab801411d0d602f4f58e7e2
+  metadata.gz: 64e74167bbafa7217db5f9c0bab6efc8b55655abbbcb7e2fccefca3dfe1afae8
+  data.tar.gz: 16f6870106206b547ed307fb6cbcd8d9250610239ccf9dc046e6e6c9719d76dd
 SHA512:
-  metadata.gz: 8a11faf4af63d87413ccfd28e2224ad230e2e451cdf3518302c4faaf2df0594118f7d2ac99fa57d65a75feb52163780088038e9748ffeb2212b41cc4505ae0a3
-  data.tar.gz: 7a6e4c0337a2fff23f845b04878994f162f7c49b5e9d981f1713cd5d0c490d8b0ea226871a92d754b3a4a5cc0e0b873217d650ec9d9f52ba79a0cfc257d24acc
+  metadata.gz: 74ce3c5a8d22b2b41bc477069e9720c7b91cad52909ee3e4db8533c0a6f357227ec7e9485f513b8306a0d4994b53556971ae09284c72c2c5370bee45a0c244e3
+  data.tar.gz: 61b01b05753f3a6f27194e47b40bb91aa822c5c263dbe78d0328f1b09aad02d95acbfc7ba191d4fb773b536c1b1ad03465e05c87c4ecf1dc279ed3e461ba97b2

data/.standard.yml

@@ -1,3 +1,5 @@
 # For available configuration options, see:
 #   https://github.com/standardrb/standard
-ruby_version: 3.0
+ruby_version: 3.1
+ignore:
+  - 'examples/**/*'

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "rails-70" do
+  gem "rails", "~> 7.0"
+end
+
+appraise "rails-71" do
+  gem "rails", "~> 7.1"
+end
+
+appraise "rails-72" do
+  gem "rails", "~> 7.2"
+end
+
+appraise "rails-80" do
+  gem "rails", "~> 8.0"
+end

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Gert Goet
+Copyright (c) 2025 Gert Goet
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,32 +1,596 @@
-# Appquery
+# AppQuery - raw SQL 🥦, cooked :stew:
 
-TODO: Delete this and the text below, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/appquery.svg)](https://badge.fury.io/rb/appquery)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/appquery`. To experiment with that code, run `bin/console` for an interactive prompt.
+A Rubygem :gem: that makes working with raw SQL (READ) queries in Rails projects more convenient.  
+Specifically it provides:
+- **...a dedicated folder for queries**  
+  e.g. `app/queries/reports/weekly.sql` is instantiated via `AppQuery["reports/weekly"]`.
+- **...Rails/rspec generators**  
+  ```
+  $ rails generate query reports/weekly
+    create  app/queries/reports/weekly.sql
+    invoke  rspec
+    create    spec/queries/reports/weekly_query_spec.rb
+  ```
+- **...ERB templating**  
+  Simple ERB templating with helper-functions:
+  ```sql
+  -- app/queries/contracts.sql.erb
+  SELECT * FROM contracts
+  <%= order_by(order) %>
+  ```
+  ```ruby
+  AppQuery["contracts.sql.erb"].render(order: {year: :desc, month: :desc}).select_all
+  ```
+- **...positional and named binds**  
+  Intuitive binds:
+  ```ruby
+  AppQuery(%{select now() - (:interval)::interval as some_date}).select_value(binds: {interval: '1 day'})
+  AppQuery(<<~SQL).select_all(binds: [2.day.ago, Time.now, '5 minutes']).column("series")
+    select generate_series($1::timestamp, $2::timestamp, $3::interval) as series
+  SQL
+  ```
+- **...casting**  
+  Automatic and custom casting:
+  ```ruby
+  AppQuery(%{select array[1,2]}).select_value #=> [1,2]
+  cast = {"data" => ActiveRecord::Type::Json.new}
+  AppQuery(%{select '{"a": 1}' as data}).select_value(cast:)
+  ```
+- **...helpers to rewrite a query for introspection during development and testing**  
+  See what a CTE yields: `query.select_all(select: "SELECT * FROM some_cte")`.  
+  Query the end result: `query.select_one(select: "SELECT COUNT(*) FROM _ WHERE ...")`.  
+  Append/prepend CTEs:
+  ```ruby
+  query.prepend_cte(<<~CTE)
+    articles(id, title) AS (
+      VALUES(1, 'Some title'),
+            (2, 'Another article'))
+  CTE
+  ```  
+- **...rspec-helpers**  
+  ```ruby
+  RSpec.describe "AppQuery reports/weekly", type: :query do
+    describe "CTE some_cte" do
+      # see what this CTE yields
+      expect(described_query.select_all(select: "select * from some_cte")).to \
+        include(a_hash_including("id" => 1))
+  
+      # shorter: the query and CTE are derived from the describe-descriptions so this suffices:
+      expect(select_all).to include ...
+  ```
 
-## Installation
+> [!IMPORTANT]  
+> **Status**: alpha. API might change. See the CHANGELOG for breaking changes when upgrading.
+>
+
+## Rationale
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Sometimes ActiveRecord doesn't cut it, and you'd rather use raw SQL to get the right data out. That, however, introduces some new problems. First of all, you'll run into the not-so-intuitive use of [select_(all|one|value)](https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/DatabaseStatements.html#method-i-select_all) — for example, how they differ with respect to type casting, and how their behavior can vary between ActiveRecord versions. Then there's the testability, introspection, and maintainability of the resulting SQL queries.  
+This library aims to alleviate all of these issues by providing a consistent interface across select_* methods and ActiveRecord versions. It should make inspecting and testing queries easier—especially when they're built from CTEs.
+
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add appquery
+```
+
+## Usage
+
+> [!NOTE]
+> The following (trivial) examples are not meant to convince you to ditch your ORM, but just to show how this gem handles raw SQL queries.
+
+### ...from console
+
+Testdriving can be easily done from the console. Either by cloning this repository (recommended, see `Development`-section) or installing the gem in an existing Rails project.  
+<details>
+  <summary>Database setup (the `bin/console`-script does this for your)</summary>
+  
+  ```ruby
+  ActiveRecord::Base.logger = Logger.new(STDOUT)
+  ActiveRecord::Base.establish_connection(url: 'postgres://localhost:5432/some_db')
+  ```
+</details>
+
+The following examples assume PostgreSQL (SQLite where stated):
+
+```ruby
+# showing select_(all|one|value)
+> AppQuery(%{select date('now') as today}).select_all.to_a
+=> [{"today" => "2025-05-10"}]
+> AppQuery(%{select date('now') as today}).select_one
+=> {"today" => "2025-05-10"}
+> AppQuery(%{select date('now') as today}).select_value
+=> "2025-05-10"
+
+# binds
+# positional binds
+> AppQuery(%{select now() - ($1)::interval as date}).select_value(binds: ['2 days'])
+# named binds
+> AppQuery(%{select now() - (:interval)::interval as date}).select_value(binds: {interval: '2 days'})
+
+# casting
+> AppQuery(%{select date('now') as today}).select_all(cast: true).to_a
+=> [{"today" => Sat, 10 May 2025}]
+
+## SQLite doesn't have a notion of dates or timestamp's so casting won't do anything:
+sqlite> AppQuery(%{select date('now') as today}).select_one(cast: true)
+=> {"today" => "2025-05-12"}
+## Providing per-column-casts fixes this:
+casts = {"today" => ActiveRecord::Type::Date.new}
+sqlite> AppQuery(%{select date('now') as today}).select_one(cast: casts)
+=> {"today" => Mon, 12 May 2025}
+
+# rewriting queries (using CTEs)
+q = AppQuery(<<~SQL)
+  WITH articles(id,title,published_on) AS (
+    values(1, 'Some title', '2024-3-31'),
+          (2, 'Other title', '2024-10-31'),
+          (3, 'Same title?', '2024-3-31'))
+  select * from articles order by id DESC
+SQL
+
+## query the articles-CTE
+q.select_all(select: %{select * from articles where id < 2}).to_a
+
+## query the end-result (available as the CTE named '_')
+q.select_one(select: %{select * from _ limit 1})
+
+## ERB templating
+# Extract a query from q that can be sorted dynamically:
+q2 = q.with_select("select id,title,published_on::date from articles <%= order_by(order) %>")
+q2.render(order: {"published_on::date": :desc, 'lower(title)': "asc"}).select_all.entries
+# shows latest articles first, and titles sorted alphabetically
+# for articles published on the same date.
+# order_by raises when it's passed something that would result in just `ORDER BY`:
+q2.render(order: {})
+# doing a select using a query that should be rendered, a `AppQuery::UnrenderedQueryError` will be raised:
+q2.select_all.entries
+
+# NOTE you can use both `order` and `@order`: local variables like `order` are required,
+# while instance variables like `@order` are optional.
+# To skip the order-part when provided:
+<%= @order.presence && order_by(order) %>
+# or use a default when order-part is always wanted but not always provided:
+<%= order_by(@order || {id: :desc}) %>
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
 
+### ...in a Rails project
+
+> [!NOTE]
+> The included [example Rails app](./examples/ror) contains all data and queries described below.
+
+Create a query:  
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+rails g query recent_articles
 ```
 
-## Usage
+Have some SQL (for SQLite, in this example):
+```sql
+-- app/queries/recent_articles.sql
+WITH settings(default_min_published_on) as (
+  values(datetime('now', '-6 months'))
+),
+
+recent_articles(article_id, article_title, article_published_on, article_url) AS (
+  SELECT id, title, published_on, url
+  FROM articles
+  RIGHT JOIN settings
+  WHERE published_on > COALESCE(?1, settings.default_min_published_on)
+),
+
+tags_by_article(article_id, tags) AS (
+  SELECT articles_tags.article_id,
+    json_group_array(tags.name) AS tags
+  FROM articles_tags
+  JOIN tags ON articles_tags.tag_id = tags.id
+  GROUP BY articles_tags.article_id
+)
+
+SELECT recent_articles.*,
+       group_concat(json_each.value, ',' ORDER BY value ASC) tags_str
+FROM recent_articles
+JOIN tags_by_article USING(article_id),
+  json_each(tags)
+WHERE EXISTS (
+  SELECT 1
+  FROM json_each(tags)
+  WHERE json_each.value LIKE ?2 OR ?2 IS NULL
+)
+GROUP BY recent_articles.article_id
+ORDER BY recent_articles.article_published_on
+```
+
+The result would look like this:
+
+```ruby
+[{"article_id"=>292,
+ "article_title"=>"Rails Versions 7.0.8.2, and 7.1.3.3 have been released!",
+ "article_published_on"=>"2024-05-17",
+ "article_url"=>"https://rubyonrails.org/2024/5/17/Rails-Versions-7-0-8-2-and-7-1-3-3-have-been-released",
+ "tags_str"=>"release:7x,release:revision"},
+...
+]
+```
+
+Even for this fairly trivial query, there's already quite some things 'encoded' that we might want to verify or capture in tests:
+- only certain columns
+- only published articles
+- only articles _with_ tags
+- only articles published after some date
+  - either provided or using the default
+- articles are sorted in a certain order
+- tags appear in a certain order and are formatted a certain way
+
+Using the SQL-rewriting capabilities shown below, this library allows you to express these assertions in tests or verify them during development.
+
+### Verify query results
+
+> [!NOTE]
+> There's `AppQuery#select_all`, `AppQuery#select_one` and `AppQuery#select_value` to execute a query. `select_(all|one)` are tiny wrappers around the equivalent methods from `ActiveRecord::Base.connection`.  
+> Instead of [positional arguments](https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/DatabaseStatements.html#method-i-select_all), these methods accept keywords `select`, `binds` and `cast`. See below for examples.
+
+Given the query above, you can get the result like so:
+```ruby
+AppQuery[:recent_articles].select_all.entries
+# =>
+[{"article_id"=>292,
+ "article_title"=>"Rails Versions 7.0.8.2, and 7.1.3.3 have been released!",
+ "article_published_on"=>"2024-05-17",
+ "article_url"=>"https://rubyonrails.org/2024/5/17/Rails-Versions-7-0-8-2-and-7-1-3-3-have-been-released",
+ "tags_str"=>"release:7x,release:revision"},
+...
+]
+
+# we can provide a different cut off date via binds^1:
+AppQuery[:recent_articles].select_all(binds: [1.month.ago]).entries
+
+1) note that SQLite can deal with unbound parameters, i.e. when no binds are provided it assumes null for $1 and $2 (which our query can deal with).
+  For Postgres you would always need to provide 2 values, e.g. `binds: [nil, nil]`.
+```
+
+We can also dig deeper by query-ing the result, i.e. the CTE `_`:
+
+```ruby
+AppQuery[:recent_articles].select_one(select: "select count(*) as cnt from _")
+# => {"cnt" => 13}
+
+# For these kind of aggregate queries, we're only interested in the value:
+AppQuery[:recent_articles].select_value(select: "select count(*) from _")
+# => 13
+```
+
+Use `AppQuery#with_select` to get a new AppQuery-instance with the rewritten SQL:
+```ruby
+puts AppQuery[:recent_articles].with_select("select * from _")
+```
+
+
+### Verify CTE results
+
+You can select from a CTE similarly:
+```ruby
+AppQuery[:recent_articles].select_all(select: "SELECT * FROM tags_by_article")
+# => [{"article_id"=>1, "tags"=>"[\"release:pre\",\"release:patch\",\"release:1x\"]"},
+      ...]
+
+# NOTE how the tags are json strings. Casting allows us to turn these into proper arrays^1:
+types = {"tags" => ActiveRecord::Type::Json.new}
+AppQuery[:recent_articles].select_all(select: "SELECT * FROM tags_by_article", cast: types)
+
+1) PostgreSQL, unlike SQLite, has json and array types. Just casting suffices:
+AppQuery("select json_build_object('a', 1, 'b', true)").select_one(cast: true)
+# => {"json_build_object"=>{"a"=>1, "b"=>true}}
+```
+
+Using the methods `(prepend|append|replace)_cte`, we can rewrite the query beyond just the select:
+
+```ruby
+AppQuery[:recent_articles].replace_cte(<<~SQL).select_all.entries
+settings(default_min_published_on) as (
+  values(datetime('now', '-12 months'))
+)
+SQL
+```
+
+You could even mock existing tables (using PostgreSQL):
+```ruby
+# using Ruby data:
+sample_articles = [{id: 1, title: "Some title", published_on: 3.months.ago},
+                   {id: 2, title: "Another title", published_on: 1.months.ago}]
+# show the provided cutoff date works
+AppQuery[:recent_articles].prepend_cte(<<-CTE).select_all(binds: [6.weeks.ago, nil, JSON[sample_articles]).entries
+  articles AS (
+    SELECT * from json_to_recordset($3) AS x(id int, title text, published_on timestamp)
+  )
+CTE
+```
+
+Use `AppQuery#with_select` to get a new AppQuery-instance with the rewritten sql:
+```ruby
+puts AppQuery[:recent_articles].with_select("select * from some_cte")
+```
+
+### Spec
+
+When generating a query `reports/weekly`, a spec-file like below is generated:
+
+```ruby
+# spec/queries/reports/weekly_query_spec.rb
+require "rails_helper"
+
+RSpec.describe "AppQuery reports/weekly", type: :query, default_binds: [] do
+  describe "CTE articles" do
+    specify do
+      expect(described_query.select_all(select: "select * from :cte")).to \
+        include(a_hash_including("article_id" => 1))
+
+      # short version: query, cte and select are all implied from descriptions
+      expect(select_all).to include(a_hash_including("article_id" => 1))
+    end
+  end
+end
+```
+
+There's some sugar:
+- `described_query`  
+  ...just like `described_class` in regular class specs.  
+  It's an instance of `AppQuery` based on the last word of the top-description (i.e. "reports/weekly" from "AppQuery reports/weekly").
+- `:cte` placeholder  
+  When doing `select_all`, you can rewrite the `SELECT` of the query by passing `select`. There's no need to use the full name of the CTE as the spec-description contains the name (i.e. "articles" in "CTE articles").
+- default_binds  
+  The `binds`-value used when not explicitly provided.  
+  E.g. given a query with a where-clause `WHERE published_at > COALESCE($1::timestamp, NOW() - '3 month'::interval)`, when setting `defaults_binds: [nil]` then `select_all` works like `select_all(binds: [nil])`.
+
+## 💎 API Doc 💎
+
+### generic
+
+<details>
+  <summary><code>AppQuery(sql) ⇒ AppQuery::Q</code></summary>
+  
+  ### Examples
+  
+  ```ruby
+  AppQuery("some sql")
+  ```
+</details>
+
+### module AppQuery
+
+<details>
+<summary><code>AppQuery[query_name] ⇒ AppQuery::Q</code></summary>
+
+### Examples
+
+```ruby
+AppQuery[:recent_articles]
+AppQuery["export/articles"]
+```
+
+</details>
+
+<details>
+<summary><code>AppQuery.configure {|Configuration| ... } ⇒ void </code></summary>
+
+Configure AppQuery.
+
+### Examples
+
+```ruby
+AppQuery.configure do |cfg|
+  cfg.query_path = "db/queries" # default: "app/queries"
+end
+```
+
+</details>
 
-TODO: Write usage instructions here
+<details>
+<summary><code>AppQuery.configuration ⇒ AppQuery::Configuration </code></summary>
+
+Get configuration
+
+### Examples
+
+```ruby
+AppQuery.configure do |cfg|
+  cfg.query_path = "db/queries" # default: "app/queries"
+end
+AppQuery.configuration
+```
+
+</details>
+
+### class AppQuery::Q
+
+Instantiate via `AppQuery(sql)` or `AppQuery[:query_file]`.
+
+<details>
+<summary><code>AppQuery::Q#cte_names ⇒ [Array< String >] </code></summary>
+
+Returns names of CTEs in query.
+
+### Examples
+
+```ruby
+AppQuery("select * from articles").cte_names # => []
+AppQuery("with foo as(select 1) select * from foo").cte_names # => ["foo"]
+```
+
+</details>
+
+<details>
+<summary><code>AppQuery::Q#recursive? ⇒ Boolean </code></summary>
+
+Returns whether or not the WITH-clause is recursive or not.
+
+### Examples
+
+```ruby
+AppQuery("select * from articles").recursive? # => false
+AppQuery("with recursive foo as(select 1) select * from foo") # => true
+```
+
+</details>
+
+<details>
+<summary><code>AppQuery::Q#select ⇒ String </code></summary>
+
+Returns select-part of the query. When using CTEs, this will be `<select>` in a query like `with foo as (select 1) <select>`.
+
+### Examples
+
+```ruby
+AppQuery("select * from articles") # => "select * from articles"
+AppQuery("with foo as(select 1) select * from foo") # => "select * from foo"
+```
+
+</details>
+
+#### query execution
+
+<details>
+<summary><code>AppQuery::Q#select_all(select: nil, binds: [], cast: false) ⇒ AppQuery::Result</code></summary>
+
+`select` replaces the existing select. The existing select is wrapped in a CTE named `_`.  
+`binds` array with values for any (positional) placeholder in the query.  
+`cast` boolean or `Hash` indicating whether or not (and how) to cast. E.g. `{"some_column" => ActiveRecord::Type::Date.new}`.
+
+### Examples
+
+```ruby
+# SQLite
+aq = AppQuery(<<~SQL)
+with data(id, title) as (
+  values('1', 'Some title'),
+     ('2', 'Another title')
+)
+select * from data
+where id=?1 or ?1 is null
+SQL
+
+# selecting from the select
+aq.select_all(select: "select * from _ where id > 1").entries #=> [{...}]
+
+# selecting from a CTE
+aq.select_all(select: "select id from data").entries
+
+# casting
+aq.select_all(select: "select id from data", cast: {"id" => ActiveRecord::Type::Integer.new})
+
+# binds
+aq.select_all(binds: ['2'])
+```
+
+</details>
+
+<details>
+<summary><code>AppQuery::Q#select_one(select: nil, binds: [], cast: false) ⇒ AppQuery::Result </code></summary>
+
+First result from `AppQuery::Q#select_all`.
+
+See examples from `AppQuery::Q#select_all`.
+
+</details>
+
+<details>
+<summary><code>AppQuery::Q#select_value(select: nil, binds: [], cast: false) ⇒ AppQuery::Result </code></summary>
+
+First value from `AppQuery::Q#select_one`. Typically for selects like `select count(*) ...`, `select min(article_published_on) ...`.
+
+See examples from `AppQuery::Q#select_all`.
+
+</details>
+
+#### query rewriting
+
+<details>
+<summary><code>AppQuery::Q#with_select(sql) ⇒ AppQuery::Q</code></summary>
+
+Returns new instance with provided select. The existing select is available via CTE `_`.
+
+### Examples
+
+```ruby
+puts AppQuery("select 1").with_select("select 2")
+WITH _ as (
+  select 1
+)
+select 2
+```
+
+</details>
+
+<details>
+<summary><code>AppQuery::Q#prepend_cte(sql) ⇒ AppQuery::Q</code></summary>
+
+Returns new instance with provided CTE.
+
+### Examples
+
+```ruby
+query.prepend_cte("foo as (values(1, 'Some article'))").cte_names # => ["foo", "existing_cte"]
+```
+
+</details>
+
+<details>
+<summary><code>AppQuery::Q#append_cte(sql) ⇒ AppQuery::Q</code></summary>
+
+Returns new instance with provided CTE.
+
+### Examples
+
+```ruby
+query.append_cte("foo as (values(1, 'Some article'))").cte_names # => ["existing_cte", "foo"]
+```
+
+</details>
+
+<details>
+<summary><code>AppQuery::Q#replace_cte(sql) ⇒ AppQuery::Q</code></summary>
+
+Returns new instance with replaced CTE. Raises `ArgumentError` when CTE does not already exist.  
+
+### Examples
+
+```ruby
+query.replace_cte("recent_articles as (select values(1, 'Some article'))")
+```
+
+</details>
+
+## Compatibility
+
+- 💾 tested with **SQLite** and **PostgreSQL**
+- 🚆 tested with Rails **v6.1**, **v7** and **v8.0**
+- 💎 requires Ruby **>v3.2**  
+  Goal is to support [maintained Ruby versions](https://www.ruby-lang.org/en/downloads/branches/).
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. **Make sure to check it exits with status code 0.**
+
+Using [mise](https://mise.jdx.dev/) for env-vars recommended.
+
+### console
+
+The [console-script](./bin/console) is setup such that it's easy to connect with a database and experiment with the library:
+```bash
+$ ./bin/console sqlite3::memory:
+$ ./bin/console postgres://localhost:5432/some_db
+
+# more details
+$ ./bin/console -h
+```
+
+### various
+
+Run `rake spec` to run the tests.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/app_query/base.rb

@@ -0,0 +1,45 @@
+module AppQuery
+  class Base
+    class_attribute :_cast, default: true, instance_predicate: false
+    class_attribute :_default_binds, default: {}, instance_predicate: false
+
+    class << self
+      def run(build_only: false, binds: {}, vars: {}, cast: self.cast, select: nil, **)
+        _build(binds:, vars:, cast:, select:).then do
+          build_only ? _1 : _1.select_all
+        end
+      end
+
+      def build(**opts)
+        run(build_only: true, **opts)
+      end
+
+      def default_binds(v = nil)
+        return _default_binds if v.nil?
+        self._default_binds = v
+      end
+
+      def cast(v = nil)
+        return _cast if v.nil?
+        self._cast = v
+      end
+
+      def query_name
+        derive_query_name unless defined?(@query_name)
+        @query_name
+      end
+
+      attr_writer :query_name
+
+      private
+
+      def _build(cast:, binds: {}, select: nil, vars: {})
+        AppQuery[query_name, binds:, cast:].render(vars).with_select(select)
+      end
+
+      def derive_query_name
+        self.query_name = name.underscore.sub(/_query$/, "")
+      end
+    end
+  end
+end