appquery 0.7.0.rc5 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0a7427b588822074b0d97fa98f7008bd4a66a9630619e425421341ad5d74b2d
-  data.tar.gz: bfc1eead06bc7f5c8044694adb349260bab5ce8b0f11d8918fa1e068b736a2ac
+  metadata.gz: f5eeb81f992ea777b44680277fcf8ef0d763aa1e8d4d6b1750eb81f9198d5262
+  data.tar.gz: d9939585c40818303e0da886c459ad65c030b2501f8399942cf5b0b2a6d308ab
 SHA512:
-  metadata.gz: 9fd7aad6bcc1ec6a05f2fa2bdcebfd2c23b46d48ab9faa3b166651c2d680da82cb4ebee3faa8fcc7d20690777e2342943bbb01180eefab0bcf75ae7ca820745e
-  data.tar.gz: c3d0cfb70e26b846dadc3b0dc89b1cbdaa6aa5d9de7a5b06cdee583ccd9fb7fd517aa128a8dda341eed92f3e615f501986b06b778c71642810aae485bcc5ed10
+  metadata.gz: 8f5a4abb4f4e38477dba038d927ac19bef2c0b252f41d820e78706ab60bd2d22dcd07ee739781266fa52bb86317f44347a98bae1e109159c5a805c778534602c
+  data.tar.gz: 73f165536629ca28cd7077156ed67ee5b78f6b750fe7c69d62d98c8c6005ba004b770972b600378f7a05be36bb7a5bc214f2bf55a8c7695f509d76971a37dd3d

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 ## [Unreleased]
 
+### 💥 Breaking Changes
+
+- ⛔ drop Ruby 3.2 support  
+  Ruby 3.2 will be EOL in 2 months but is already no longer working for Rails >v8.1.
+
+### ✨ Features
+
+- 🗒️ Paginatable: unpaginated  
+  Override any setting for pagination:
+  ```ruby
+  query = ArticlesQuery.build
+  => #<RecentQuery:0x000000016ed7ef78 @page=1, @per_page=10, ...>
+  query.unpaginated.count
+  #=> 699
+  ```
+  Also: when `@page.nil?` then paginate erb-helper renders nothing:
+  ```ruby
+  # articles_query.erb.sql
+  # before
+  # skip pagination when we need the total count
+  <%= @page && paginate(page:, per_page:) -%>
+  # after
+  <%= paginate(page:, per_page:) -%>
+  ```
+- 🌗 darkmode for API docs
+
 ### 🐛 Fixes
 
 - 🔧 Fix literal strings containing parentheses breaking CTE-parsing.

data/lib/app_query/base_query.rb

@@ -64,14 +64,17 @@ module AppQuery
   # @example SQL template (app/queries/articles.sql.erb)
   #   SELECT * FROM articles
   #   WHERE author_id = :author_id
-  #   <% if @status %>AND status = :status<% end %>
+  #   <% if @editor %>AND status = :status<% end %>
   #   ORDER BY <%= @order_by %>
   #
   # @example Query class (app/queries/articles_query.rb)
   #   class ArticlesQuery < AppQuery::BaseQuery
   #     bind :author_id
   #     bind :status, default: nil
+  #
+  #     var :editor, default: false
   #     var :order_by, default: "created_at DESC"
+  #
   #     cast published_at: :datetime
   #   end
   #

data/lib/app_query/paginatable.rb

@@ -125,6 +125,12 @@ module AppQuery
       self
     end
 
+    def unpaginated
+      @page = nil
+      @per_page = nil
+      self
+    end
+
     def entries
       @_entries ||= build_paginated_result(super)
     end
@@ -135,7 +141,7 @@ module AppQuery
 
     def unpaginated_query
       base_query
-        .render(**render_vars.except(:page, :per_page))
+        .render(**render_vars, page: nil)
         .with_binds(**bind_vars)
     end
 

data/lib/app_query/render_helpers.rb

@@ -214,6 +214,7 @@ module AppQuery
     #
     # @raise [ArgumentError] if page or per_page is not a positive integer
     def paginate(page:, per_page:)
+      return "" if page.nil?
       raise ArgumentError, "page must be a positive integer (got #{page.inspect})" unless page.is_a?(Integer) && page > 0
       raise ArgumentError, "per_page must be a positive integer (got #{per_page.inspect})" unless per_page.is_a?(Integer) && per_page > 0
 

data/lib/app_query/tokenizer.rb

@@ -104,7 +104,7 @@ module AppQuery
 
     def lex_append_cte
       emit_token "COMMA", v: ","
-      emit_token "WHITESPACE", v: "\n  "
+      emit_token "WHITESPACE", v: "\n"
       push_return :lex_recursive_cte
     end
 

data/lib/app_query/version.rb

@@ -3,5 +3,5 @@
 module AppQuery
   # This should just contain the .dev of the upcoming version.
   # When doing the actual release, CI will write the tag here before pushing the gem.
-  VERSION = "0.7.0.rc5"
+  VERSION = "0.7.0"
 end

data/lib/app_query.rb

@@ -772,8 +772,9 @@ module AppQuery
       # Replace :_ with the current CTE name
       processed_sql = sql.gsub(/:_\b/, current_cte)
 
-      # Wrap current SELECT in numbered CTE
-      new_cte = "#{current_cte} AS (\n  #{select}\n)"
+      # Wrap current SELECT in numbered CTE (indent all lines, strip trailing whitespace)
+      indented_select = select.rstrip.gsub("\n", "\n  ")
+      new_cte = "#{current_cte} AS (\n  #{indented_select}\n)"
 
       append_cte(new_cte).then do |q|
         # Replace the SELECT token with processed_sql and increment depth
@@ -963,5 +964,3 @@ rescue LoadError
 end
 
 require_relative "app_query/rspec" if Object.const_defined? :RSpec
-
-require "app_query/base" if defined?(ActiveRecord::Base)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appquery
 version: !ruby/object:Gem::Version
-  version: 0.7.0.rc5
+  version: 0.7.0
 platform: ruby
 authors:
 - Gert Goet
@@ -56,7 +56,6 @@ files:
 - assets/banner-dark.svg
 - assets/banner-light.svg
 - lib/app_query.rb
-- lib/app_query/base.rb
 - lib/app_query/base_query.rb
 - lib/app_query/mappable.rb
 - lib/app_query/paginatable.rb

data/lib/app_query/base.rb

@@ -1,45 +0,0 @@
-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