activerecord-refined 0.9.0 → 0.10.0

data/lib/activerecord-refined/version.rb

@@ -2,6 +2,6 @@
 
 module Activerecord
   module Refined
-    VERSION = "0.9.0"
+    VERSION = "0.10.0"
   end
 end

data/lib/activerecord-refined.rb

@@ -5,6 +5,7 @@ require "active_record"
 require "bigdecimal"
 require "active_record/relation"
 require "active_record/refined/ast"
+require "active_record/refined/dialect"
 require "active_record/refined"
 
 ActiveRecord::QueryMethods.prepend ActiveRecord::Refined::QueryMethods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-refined
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
   - Shugo Maeda
@@ -217,6 +217,38 @@ dependencies:
           - ">="
           - !ruby/object:Gem::Version
             version: "0"
+  - !ruby/object:Gem::Dependency
+    name: yard
+    requirement: !ruby/object:Gem::Requirement
+      requirements:
+        -
+          - ">="
+          - !ruby/object:Gem::Version
+            version: "0"
+    type: :development
+    prerelease: false
+    version_requirements: !ruby/object:Gem::Requirement
+      requirements:
+        -
+          - ">="
+          - !ruby/object:Gem::Version
+            version: "0"
+  - !ruby/object:Gem::Dependency
+    name: yard-markdown-relative-links
+    requirement: !ruby/object:Gem::Requirement
+      requirements:
+        -
+          - ">="
+          - !ruby/object:Gem::Version
+            version: "0"
+    type: :development
+    prerelease: false
+    version_requirements: !ruby/object:Gem::Requirement
+      requirements:
+        -
+          - ">="
+          - !ruby/object:Gem::Version
+            version: "0"
 description: Adding clean and powerful query syntax on Active Record using refinements
 email:
   - shugo@ruby-lang.org
@@ -224,17 +256,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-  - .github/workflows/push_gem.yml
-  - .github/workflows/sandbox.yml
-  - .github/workflows/test.yml
-  - .gitignore
-  - .rubocop.yml
-  - Gemfile
+  - .yardopts
   - LICENSE.txt
   - README.md
-  - Rakefile
   - activerecord-refined.gemspec
-  - benchmark/query_building.rb
+  - docs/conditions.md
+  - docs/ctes.md
+  - docs/expressions.md
+  - docs/functions.md
+  - docs/grouping.md
+  - docs/joins.md
+  - docs/json.md
+  - docs/ordering.md
+  - docs/time_zones.md
+  - docs/windows.md
+  - docs/writing.md
   - examples/aggregations.rb
   - examples/complex_joins.rb
   - examples/ctes.rb
@@ -247,13 +283,21 @@ files:
   - examples/writes.rb
   - lib/active_record/refined.rb
   - lib/active_record/refined/ast.rb
+  - lib/active_record/refined/dialect.rb
+  - lib/active_record/refined/dialect/mariadb.rb
+  - lib/active_record/refined/dialect/mysql.rb
+  - lib/active_record/refined/dialect/mysql_compat.rb
+  - lib/active_record/refined/dialect/oracle.rb
+  - lib/active_record/refined/dialect/postgresql.rb
+  - lib/active_record/refined/dialect/sql_server.rb
+  - lib/active_record/refined/dialect/sqlite.rb
   - lib/activerecord-refined.rb
   - lib/activerecord-refined/version.rb
-  - test/test_block_syntax.rb
-  - test/test_helper.rb
 homepage: "https://github.com/shugo/activerecord-refined"
-licenses: []
-metadata: {}
+licenses:
+  - MIT
+metadata:
+  documentation_uri: "https://rubydoc.info/gems/activerecord-refined"
 rdoc_options: []
 require_paths:
   - lib
@@ -273,6 +317,4 @@ requirements: []
 rubygems_version: 4.1.0.dev
 specification_version: 4
 summary: Write Active Record queries as Ruby expressions
-test_files:
-  - test/test_block_syntax.rb
-  - test/test_helper.rb
+test_files: []

data/.github/workflows/push_gem.yml

@@ -1,45 +0,0 @@
-name: push gem
-
-on:
-  push:
-    tags:
-      - "v*"
-
-jobs:
-  push:
-    if: github.repository == 'shugo/activerecord-refined'
-    runs-on: ubuntu-latest
-
-    environment:
-      name: release
-      url: https://rubygems.org/gems/activerecord-refined
-
-    permissions:
-      # release-gem pushes the tag, and needs id-token to identify itself to
-      # RubyGems.org instead of an API key.
-      contents: write
-      id-token: write
-
-    env:
-      # Nothing here loads pg or mysql2, and building them needs client
-      # libraries the runner would have to install first.
-      BUNDLE_WITHOUT: db
-
-    steps:
-      - uses: actions/checkout@v5
-        with:
-          # release-gem sets up its own short-lived git credentials.
-          persist-credentials: false
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          # Not `ruby`: the gemspec requires 4.1.0.dev for Proc#refined, so
-          # bundler refuses to resolve on a released Ruby.
-          ruby-version: head
-          bundler-cache: true
-
-      # Runs `rake release`, which builds the gem and pushes it. The tag it
-      # would create already exists here, so that step is skipped.
-      - uses: rubygems/release-gem@v1
-        with:
-          attestations: false

data/.github/workflows/sandbox.yml

@@ -1,295 +0,0 @@
-name: sandbox
-
-on:
-  push:
-    branches: [master]
-  pull_request:
-  workflow_dispatch:
-
-concurrency:
-  group: sandbox-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: sandbox
-
-    steps:
-      - uses: actions/checkout@v7
-
-      # The host Ruby cannot be 4.1: ruby_wasm's native extension depends on
-      # rb-sys, which does not build against Ruby 4.1's headers.  rbwasm is
-      # only a build tool -- the Ruby it produces is the one that matters.
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '4.0'
-          bundler-cache: false
-          working-directory: sandbox
-
-      - uses: actions/setup-node@v7
-        with:
-          node-version: '24'
-
-      # What the binary is made of: the gems with C extensions, the scripts
-      # that drive the build -- RUBY_REV and the toolchain versions are pinned
-      # in them -- the staged extension, and the host Ruby.  Not the gem's own
-      # lib and not the page, neither of which the binary contains; those are
-      # files the page fetches at startup.
-      #
-      # Naming the build after this rather than after the binary is what makes
-      # the URL stable.  The build is not reproducible to the byte -- the same
-      # tree twice over came out 1 KB apart, mtimes riding along in the packed
-      # filesystem -- so a hash of the output would change on every deploy and
-      # give every visitor 12 MB to fetch again for nothing.
-      - name: Identify the build
-        id: build
-        run: |
-          hash="${{ hashFiles('sandbox/.ruby-version', 'sandbox/Gemfile.lock', 'sandbox/bin/build-wasm', 'sandbox/bin/rbwasm-build.rb', 'sandbox/bin/install-wasi-sdk.rb', 'sandbox/ext/**') }}"
-
-          # hashFiles gives back an empty string when it matches nothing, and
-          # an empty hash would quietly name every build alike -- and hand out
-          # whichever binary happened to be uploaded first, for good.
-          if [ -z "$hash" ]; then
-            echo "::error::hashFiles matched none of the build inputs" >&2
-            exit 1
-          fi
-
-          echo "hash=$hash" >> "$GITHUB_OUTPUT"
-          echo "key=ruby-${hash:0:16}.wasm" >> "$GITHUB_OUTPUT"
-          echo "this build is ruby-${hash:0:16}.wasm"
-
-      # The binary for these inputs may already be in the bucket from an
-      # earlier deploy, in which case there is nothing to build: 12 MB comes
-      # down in a few seconds where a build takes two minutes warm and sixteen
-      # cold.  The examples are still checked against it below, which is what
-      # the deploy is really for.
-      #
-      # Anything at all going wrong here -- no credentials, as on a fork, a
-      # network failure, a half-written file -- falls through to building.
-      - name: Fetch this build from R2 if it is there
-        id: prebuilt
-        if: vars.R2_PUBLIC_URL != ''
-        env:
-          AWS_ACCESS_KEY_ID: ${{ secrets.R2_ACCESS_KEY_ID }}
-          AWS_SECRET_ACCESS_KEY: ${{ secrets.R2_SECRET_ACCESS_KEY }}
-          AWS_DEFAULT_REGION: auto
-          AWS_REQUEST_CHECKSUM_CALCULATION: when_required
-          AWS_RESPONSE_CHECKSUM_VALIDATION: when_required
-          ENDPOINT: https://${{ secrets.CLOUDFLARE_ACCOUNT_ID }}.r2.cloudflarestorage.com
-          BUCKET: ${{ vars.R2_BUCKET }}
-          KEY: ${{ steps.build.outputs.key }}
-        run: |
-          if aws s3api get-object \
-               --endpoint-url "$ENDPOINT" \
-               --bucket "$BUCKET" \
-               --key "$KEY" \
-               /tmp/ruby.wasm.gz \
-               --no-cli-pager > /dev/null 2>&1 &&
-             gunzip -c /tmp/ruby.wasm.gz > ruby.wasm
-          then
-            echo "found=true" >> "$GITHUB_OUTPUT"
-            echo "took $KEY from the bucket; not building"
-            ls -l ruby.wasm
-          else
-            rm -f ruby.wasm
-            echo "$KEY is not in the bucket; building it"
-          fi
-
-      # The Ruby checkout and the build tree have to be cached together.  make
-      # decides by mtime, so restoring objects next to a freshly cloned Ruby
-      # would rebuild everything.  Keyed on the same inputs as the binary, so
-      # the two cannot drift apart.
-      #
-      # restore-keys is what keeps this worth caching -- a key change would
-      # otherwise mean a cold 16-minute build rather than two minutes -- but it
-      # also means a bad tree outlives the key that produced it, since the
-      # prefix still matches.  Editing a file in the key does not clear it;
-      # deleting the cache does.  bin/build-wasm rejects a ruby.wasm built from
-      # such a tree, so it fails the run rather than shipping.
-      - name: Restore the WASM build tree
-        if: steps.prebuilt.outputs.found != 'true'
-        uses: actions/cache@v6
-        with:
-          path: sandbox/build
-          key: wasm-${{ runner.os }}-${{ steps.build.outputs.hash }}
-          restore-keys: wasm-${{ runner.os }}-
-
-      - run: bundle install --jobs 4
-      - run: npm ci
-
-      - name: Build ruby.wasm
-        if: steps.prebuilt.outputs.found != 'true'
-        run: ./bin/build-wasm
-
-      - name: Assemble the Ruby files served to the page
-        run: ./bin/prepare-rb
-
-      # Runs every example through the same WASI shim the page uses.  The
-      # larger stack is needed to compile Active Record's relation.rb; see the
-      # note in sandbox/README.md.
-      - name: Check the examples
-        run: node --stack-size=4000 check-examples.mjs
-
-      # ruby.wasm is 40 MB and nearly all of the bandwidth this page uses, so
-      # it is served from R2 -- egress there is free -- and only the page
-      # itself from Pages.
-      #
-      # Only when it was built here: found in the bucket, it is already up.
-      # The object is therefore written once and never rewritten, which is what
-      # the immutable caching claims.  R2 serves what it is given and does not
-      # compress, hence gzip with the encoding recorded on the object: 40 MB
-      # becomes 12 MB on the wire.
-      #
-      # Without the secrets configured the upload is skipped and ruby.wasm
-      # rides along in the Pages artifact as before, which keeps forks working.
-      # Uploaded over R2's S3-compatible API rather than with wrangler, so that
-      # the token can be an Object Read & Write one scoped to this bucket.
-      # Those permissions exist only on the S3 API: wrangler goes through
-      # Cloudflare's REST API, which answers 403 to them and wants Admin Read &
-      # Write -- a token that can create and delete every bucket in the
-      # account, which is not what a public repository's CI should hold.
-      - name: Upload ruby.wasm to R2
-        id: r2
-        if: >-
-          github.ref == 'refs/heads/master' && vars.R2_PUBLIC_URL != ''
-          && steps.prebuilt.outputs.found != 'true'
-        env:
-          KEY: ${{ steps.build.outputs.key }}
-          AWS_ACCESS_KEY_ID: ${{ secrets.R2_ACCESS_KEY_ID }}
-          AWS_SECRET_ACCESS_KEY: ${{ secrets.R2_SECRET_ACCESS_KEY }}
-          AWS_DEFAULT_REGION: auto
-          # R2 sends no checksum headers back, which newer AWS CLIs insist on.
-          AWS_REQUEST_CHECKSUM_CALCULATION: when_required
-          AWS_RESPONSE_CHECKSUM_VALIDATION: when_required
-          ENDPOINT: https://${{ secrets.CLOUDFLARE_ACCOUNT_ID }}.r2.cloudflarestorage.com
-          BUCKET: ${{ vars.R2_BUCKET }}
-          # How many builds to keep, the newest included.  A page loaded just
-          # before a deploy goes on finding its binary, and a bad build can be
-          # rolled back by hand; further back is 12 MB apiece for nothing.
-          KEEP: 3
-        run: |
-          gzip -9 -c ruby.wasm > /tmp/ruby.wasm.gz
-
-          aws s3api put-object \
-            --endpoint-url "$ENDPOINT" \
-            --bucket "$BUCKET" \
-            --key "$KEY" \
-            --body /tmp/ruby.wasm.gz \
-            --content-type application/wasm \
-            --content-encoding gzip \
-            --cache-control "public, max-age=31536000, immutable" \
-            --no-cli-pager
-
-          echo "uploaded=true" >> "$GITHUB_OUTPUT"
-
-          # Distinct keys have nothing to remove them, so the oldest go here.
-          # Ordered by age rather than by name, since a key says which inputs
-          # built it but not which came first; the timestamps are UTC ISO 8601,
-          # so sorting them as text sorts them by time.  `head -n -KEEP` is
-          # every line but the last KEEP, and prints nothing until there are
-          # more.
-          #
-          # The listing is written out before it is sorted, so that what the if
-          # tests is the listing: a pipeline would report the sort, which
-          # succeeds on no input either way.  A failure is said rather than
-          # raised, since the binary is already up and a stale object left
-          # behind is no reason to hold back the deploy that needs the new one.
-          if aws s3api list-objects-v2 \
-               --endpoint-url "$ENDPOINT" \
-               --bucket "$BUCKET" \
-               --prefix ruby- \
-               --query "Contents[].[LastModified,Key]" \
-               --output text --no-cli-pager > /tmp/builds
-          then
-            sort /tmp/builds | head -n "-$KEEP" | cut -f2 | while read -r stale; do
-              # The one just uploaded is never stale, whatever the listing says
-              # of its age: it is the binary the page about to be deployed asks
-              # for.  Whatever else is under the prefix is not ours to delete.
-              case "$stale" in
-                "$KEY") echo "keeping $stale, which is this build"; continue ;;
-                ruby-*.wasm) ;;
-                *) echo "leaving $stale alone"; continue ;;
-              esac
-              echo "removing $stale"
-              aws s3api delete-object \
-                --endpoint-url "$ENDPOINT" \
-                --bucket "$BUCKET" \
-                --key "$stale" \
-                --no-cli-pager ||
-                echo "::warning::could not remove $stale"
-            done
-          else
-            echo "::warning::could not list $BUCKET; older builds were left in place"
-          fi
-
-      # The preload in the head is what the page fetches the binary by, and it
-      # ships pointing at the local build.  Naming R2 there rather than in a
-      # file the page has to read first is worth a round trip on every visit:
-      # the browser can start on the 12 MB while it is still parsing the head,
-      # instead of after the scripts have loaded and asked where to look.
-      #
-      # Done whether the binary went up in this run or was already there.  A
-      # checkout with no deployment behind it keeps the line as written, and
-      # the artifact carries the ruby.wasm beside it.
-      - name: Point the page at R2
-        id: r2url
-        if: steps.prebuilt.outputs.found == 'true' || steps.r2.outputs.uploaded == 'true'
-        env:
-          URL: ${{ vars.R2_PUBLIC_URL }}/${{ steps.build.outputs.key }}
-        run: |
-          before=$(grep -c 'id="ruby-wasm"' index.html)
-          if [ "$before" != 1 ]; then
-            echo "::error::expected one preload link in index.html, found $before" >&2
-            exit 1
-          fi
-
-          sed -i "s|\(<link id=\"ruby-wasm\"[^>]*href=\)\"[^\"]*\"|\1\"$URL\"|" index.html
-          grep '<link id="ruby-wasm"' index.html
-
-          if ! grep -q "href=\"$URL\"" index.html; then
-            echo "::error::the preload link was not rewritten" >&2
-            exit 1
-          fi
-          echo "served=true" >> "$GITHUB_OUTPUT"
-
-      - uses: actions/upload-artifact@v7
-        with:
-          name: sandbox
-          path: |
-            sandbox/index.html
-            sandbox/boot.rb
-            sandbox/examples.js
-            sandbox/pglite-bridge.mjs
-            sandbox/manifest.json
-            ${{ steps.r2url.outputs.served != 'true' && 'sandbox/ruby.wasm' || '' }}
-            sandbox/rb
-            sandbox/assets
-          if-no-files-found: ignore
-          retention-days: 7
-
-  deploy:
-    if: github.ref == 'refs/heads/master'
-    needs: build
-    runs-on: ubuntu-latest
-    permissions:
-      pages: write
-      id-token: write
-    environment:
-      name: github-pages
-      url: ${{ steps.deploy.outputs.page_url }}
-
-    steps:
-      - uses: actions/download-artifact@v8
-        with:
-          name: sandbox
-          path: site
-
-      - uses: actions/configure-pages@v6
-      - uses: actions/upload-pages-artifact@v5
-        with:
-          path: site
-      - id: deploy
-        uses: actions/deploy-pages@v5

data/.github/workflows/test.yml

@@ -1,104 +0,0 @@
-name: test
-
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-
-jobs:
-  rubocop:
-    runs-on: ubuntu-latest
-    env:
-      BUNDLE_WITHOUT: db
-    steps:
-      - uses: actions/checkout@v5
-      - uses: ruby/setup-ruby@v1
-        with:
-          # Linting needs no Proc#refined, but bundler reads the gemspec's
-          # required_ruby_version and 4.1.0.dev leaves head the only fit.
-          ruby-version: head
-          bundler-cache: true
-      - run: bundle exec rubocop
-
-  sqlite:
-    runs-on: ubuntu-latest
-    env:
-      # Nothing here loads pg or mysql2, so skip building the extensions.
-      BUNDLE_WITHOUT: db
-    steps:
-      - uses: actions/checkout@v5
-      - uses: ruby/setup-ruby@v1
-        with:
-          # Proc#refined has not been released yet, so master is the only
-          # Ruby that can run this.
-          ruby-version: head
-          bundler-cache: true
-      - run: bundle exec rake test
-
-  postgresql:
-    runs-on: ubuntu-latest
-    env:
-      ADAPTER: postgresql
-      DB_USERNAME: postgres
-      DB_PASSWORD: postgres
-    services:
-      postgres:
-        image: postgres:16
-        env:
-          POSTGRES_PASSWORD: postgres
-        ports:
-          - 5432:5432
-        options: >-
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-    steps:
-      - uses: actions/checkout@v5
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: head
-          bundler-cache: true
-      - run: bundle exec rake test
-
-  # Both answer to the mysql2 adapter and they do not agree: MariaDB's json
-  # column is a checked longtext where MySQL's is a type of its own, and
-  # MariaDB casts to integer where MySQL knows only signed.  Each has passed
-  # while the other failed, so both run.
-  mysql:
-    name: mysql (${{ matrix.image }})
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - image: mysql:8
-            health: mysqladmin ping -proot
-          - image: mariadb:11
-            health: healthcheck.sh --connect --innodb_initialized
-    env:
-      ADAPTER: mysql2
-      # The suite creates its own database, which MYSQL_USER would not be
-      # granted; root is the account that can.
-      DB_USERNAME: root
-      DB_PASSWORD: root
-    services:
-      mysql:
-        image: ${{ matrix.image }}
-        env:
-          MYSQL_ROOT_PASSWORD: root
-        ports:
-          - 3306:3306
-        options: >-
-          --health-cmd "${{ matrix.health }}"
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-    steps:
-      - uses: actions/checkout@v5
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: head
-          bundler-cache: true
-      - run: bundle exec rake test

data/.gitignore

@@ -1,19 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.ruby-version
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-t.rb
-test/tmp
-test/version_tmp
-tmp