active_record-cursor_paginator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f0bf9b4efedd42ab91e3ad4cc65ceddc323e14482d412e191cd5f999c4b7652
+  data.tar.gz: '05907e8c002d776c4f06a7dae8352e058eab6790eaf509af22ba612c287c7369'
+SHA512:
+  metadata.gz: cbf06f52e6d3acb9be08eb0ec8e88a53d33000670783bb9841d5ece1a67b400478bee8ebbf3bf4a1f85c0f549b42834f5e760a740713a8b469833550495f0b2b
+  data.tar.gz: 1ff2dd7da5bd5ed0e5d63eeee7a41b4d80b0f3ab17dc511843859b63b1b624373ba64c4a84df745cca08bcd043d24ac90d0eb62a75cb55fa7c3151979ccf8426

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,489 @@
+inherit_from: .rubocop_todo.yml
+inherit_mode:
+  merge:
+    - Exclude
+
+# ref)
+# https://raw.githubusercontent.com/onk/onkcop/master/config/rubocop.yml
+
+# 自動生成されるものはチェック対象から除外する
+AllCops:
+  SuggestExtensions: false
+  NewCops: enable
+  Exclude:
+    - 'public/**/*'
+    - 'tmp/**/*'
+    - 'log/**/*'
+    - "vendor/**/*"
+    - "bin/*"
+    - "Gemfile*"
+    - "db/schema.rb"
+    - "db/seeds.rb"
+    - 'db/migrate/*_init_schema.rb' # squasher generated
+    - "frontend/**/*"
+    - 'spec/fixtures/**/*'
+    - 'terraform/**/*'
+    - "app/lib/qwan_exception.rb"
+    - "app/controllers/test_data_controller.rb"
+    - "app/apis/api/v1/concerns/errors.rb"
+    - 'docker/**/*'
+    - '**/node_modules/**/*'
+
+#################### Layout ################################
+
+# * 警告 120文字
+# * 禁止 160文字
+# のイメージ
+Layout/LineLength:
+  Max: 160
+  Exclude:
+    - "db/migrate/*.rb"
+    - "app/lib/ngword.rb"
+    - "app/exceptions/qwan_exception/shop_remove_location_despite_has_ticket.rb"
+    - "spec/apis/api/v1/contact_spec.rb"
+    - "spec/ledger/report/tenant_transactions_spec.rb"
+    - "spec/ledger/report/transactions_spec.rb"
+
+# ガード句と本質を分けるのは良いコードスタイルなので有効化
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+
+# メソッドをグループ分けして書き順を揃えておくと読みやすくなる。
+# 多少のツラミはあるかもしれない。
+# TODO:  https://github.com/pocke/rubocop-rails-order_model_declarative_methods
+Layout/ClassStructure:
+  Enabled: true
+
+# メソッドチェーンの改行は末尾に . を入れる
+# * REPL に貼り付けた際の暴発を防ぐため
+# * 途中にコメントをはさむことができて実用上圧倒的に便利
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+# 桁揃えが綺麗にならないことが多いので migration は除外
+Layout/ExtraSpacing:
+  Exclude:
+    - "db/migrate/*.rb"
+
+# special_inside_parentheses (default) と比べて
+# * 横に長くなりづらい
+# * メソッド名の長さが変わったときに diff が少ない
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: special_inside_parentheses
+
+# ({ と hash を開始した場合に ( の位置にインデントさせる
+# そもそも {} が必要ない可能性が高いが Style/BracesAroundHashParameters はチェックしないことにしたので
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: special_inside_parentheses
+  # EnforcedStyle: align_braces
+
+# private/protected は一段深くインデントする
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods
+
+# メソッドチェーン感がより感じられるインデントにする
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+# {} は 1 行で書くときに主に使われるので、スペースよりも
+# 横に長くならない方が嬉しさが多い。
+# そもそも {| のスタイルの方が一般的だったと認識している。
+Layout/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+# その時々でやりたい表現を尊重すれば良いと思う
+Layout/LineContinuationLeadingSpace:
+  Enabled: false
+
+#################### Lint ##################################
+
+# spec 内では
+# expect { subject }.to change { foo }
+# という書き方をよく行うので () を省略したい。
+# { foo } は明らかに change に紐付く。
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+# Style/EmptyCaseCondition と同じく網羅の表現力が empty when を認めた方が高いし、
+# 頻出する対象を最初の when で撥ねるのはパフォーマンス向上で頻出する。
+# また、
+#   case foo
+#   when 42
+#     # nop
+#   when 1..100
+#     ...
+#   end
+# と、下の when がキャッチしてしまう場合等に対応していない。
+# See. http://tech.sideci.com/entry/2016/11/01/105900
+Lint/EmptyWhen:
+  Enabled: false
+
+# RuntimeError は「特定の Error を定義できない場合」なので、
+# 定義できるエラーは RuntimeError ではなく StandardError を継承する。
+Lint/InheritException:
+  EnforcedStyle: standard_error
+
+# * 同名のメソッドがある場合にローカル変数に `_` を付ける
+# * 一時変数として `_` を付ける
+# というテクニックは頻出する
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+# 子クラスで実装させるつもりで中身が
+#   raise NotImplementedError
+# のみのメソッドが引っかかるので。
+# (raise せずに中身が空だと IgnoreEmptyMethods でセーフ)
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+# select 以外では引っかからないと思うので
+# mutating_methods のチェックを有効に。
+# TODO: select は引数が無い (ブロックのみ) の場合にだけチェックする
+# ようにすると誤検知がほぼ無くなる？
+Lint/Void:
+  CheckForMethodsWithNoSideEffects: true
+
+# messageを取り回してるだけなのでわざわざsuperを呼ばなくても良さそう
+Lint/MissingSuper:
+  Exclude:
+    - 'app/exceptions/qwan_exception/*'
+
+#################### Metrics ###############################
+
+# 目標: 20 まで下げたい。
+Metrics/AbcSize:
+  Max: 36
+  Exclude:
+    - "db/migrate/*"
+    - "app/controllers/test_data_controller.rb"
+    - "app/models/mission_master.rb"
+    - "app/models/region_player/status.rb"
+    - 'app/models/concerns/region_location_report_concern.rb'
+
+# Gemfile, Guardfile は DSL 的で基本的に複雑にはならないので除外
+# rake, rspec, environments, routes は巨大な block 不可避なので除外
+# TODO: ExcludedMethods の精査
+Metrics/BlockLength:
+  Max: 30
+  Exclude:
+    - "Rakefile"
+    - "**/*.rake"
+    - "spec/**/*.rb"
+    - "Gemfile"
+    - "Guardfile"
+    - "config/environments/*.rb"
+    - "config/routes.rb"
+    - "config/routes/**/*.rb"
+    - "*.gemspec"
+    - "app/apis/**/*.rb"
+    - 'app/models/concerns/firebase_auth_concern.rb'
+    - 'app/models/concerns/region_location_report_concern.rb'
+    - 'db/migrate/*_init_schema.rb' # squasher generated
+
+# 6 は強すぎるので緩める
+Metrics/CyclomaticComplexity:
+  Max: 11
+  Exclude:
+    - "app/models/mission_master.rb"
+
+Metrics/ClassLength:
+  Max: 500
+  CountAsOne: ['array', 'hash', 'heredoc']
+  Exclude:
+    - 'db/migrate/*_init_schema.rb' # squasher generated
+
+# 20 行超えるのは migration ファイル以外滅多に無い
+Metrics/MethodLength:
+  Max: 30
+  Exclude:
+    - "db/migrate/*.rb"
+    - "app/models/**/search.rb"
+    - "app/controllers/test_data_controller.rb"
+    - "app/models/mission_master.rb"
+    - "app/models/region_player/status.rb"
+
+# 分岐の数。ガード句を多用しているとデフォルト 7 だと厳しい
+Metrics/PerceivedComplexity:
+  Max: 10
+  Exclude:
+    - "app/models/mission_master.rb"
+
+Metrics/ParameterLists:
+  Max: 8
+
+#################### Naming ################################
+
+# 3 文字未満だと指摘されるが、未使用を示す _ や e(rror), b(lock),
+# n(umber) といった 1 文字変数は頻出するし、前置詞(by, to, ...)や
+# よく知られた省略語 (op: operator とか pk: primary key とか) も妥当。
+# 変数 s にどんな文字列かを形容したい場合と、不要な場合とがある＝無効
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Naming/InclusiveLanguage:
+  Enabled: true
+  FlaggedTerms:
+    blacklist:
+      Regex: '(?!)' # table名に使ってしまっているので修正は難しい
+
+#################### Security ##############################
+
+# 毎回 YAML.safe_load(yaml_str, [Date, Time]) するのは面倒で。。
+Security/YAMLLoad:
+  Enabled: false
+
+#################### Style #################################
+
+# レキシカルスコープの扱いが alias_method の方が自然。
+# https://ernie.io/2014/10/23/in-defense-of-alias/ のように
+# 問題になる場合は自分で緩める。
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+# redirect_to xxx and return のイディオムを維持したい
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+# 日本語のコメントを許可する
+Style/AsciiComments:
+  Enabled: false
+
+# Use a consistent style for named format string tokens.
+Style/FormatStringToken:
+  Enabled: false
+
+# do .. end から更にメソッドチェーンすると見づらいので
+# auto-correct せず、自分で修正する
+# spec 内は見た目が綺麗になるので許可
+Style/BlockDelimiters:
+  AutoCorrect: false
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+# scope が違うとか親 module の存在確認が必要とかデメリットはあるが、
+# namespace 付きのクラスはかなり頻繁に作るので簡単に書きたい。
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Style/CollectionMethods 自体は無効になっているのだが、
+#   https://github.com/bbatsov/rubocop/issues/1084
+#   https://github.com/bbatsov/rubocop/issues/1334
+# Performance/Detect がこの設定値を見るので PreferredMethods だけ変更しておく。
+#
+# デフォルト値から変えたのは
+#   find -> detect
+#     ActiveRecord の find と間違えやすいため
+#   reduce -> inject
+#     detect, reject, select と並べたときに韻を踏んでいるため。
+#     collect -> map を維持しているのは文字数が圧倒的に少ないため。
+Style/CollectionMethods:
+  PreferredMethods:
+    detect: "detect"
+    find: "detect"
+    inject: "inject"
+    reduce: "inject"
+
+# ドキュメントの無い public class を許可する
+Style/Documentation:
+  Enabled: false
+
+# !! のイディオムは積極的に使う
+Style/DoubleNegation:
+  Enabled: false
+
+# case
+# when ios?
+# when android?
+# end
+# のようなものは case の方が網羅の表現力が高い
+Style/EmptyCaseCondition:
+  Enabled: false
+
+# 明示的に else で nil を返すのは分かりやすいので許可する
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+# 空メソッドの場合だけ1行で書かなければいけない理由が無い
+# 「セミコロンは使わない」に寄せた方がルールがシンプル
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+# いずれかに揃えるのならば `sprintf` や `format` より String#% が好きです
+Style/FormatString:
+  EnforcedStyle: percent
+
+# まだ対応するには早い
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# if 文の中に 3 行程度のブロックを書くぐらいは許容した方が現実的
+# NOTE: https://github.com/bbatsov/rubocop/commit/29945958034db13af9e8ff385ec58cb9eb464596
+#       の影響で、if 文の中身が 1 行の場合に警告されるようになっている。
+#       Style/IfUnlessModifier の設定見てくれないかなぁ？ (v0.36.0)
+Style/GuardClause:
+  MinBodyLength: 5
+
+# rake タスクの順序の hash は rocket を許可する
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either
+  Exclude:
+    - "**/*.rake"
+    - "Rakefile"
+
+# 平たくしてしまうと条件のグルーピングが脳内モデルとズレやすい
+Style/IfInsideElse:
+  Enabled: false
+
+# 条件式の方を意識させたい場合には後置の if/unless を使わない方が分かりやすい
+Style/IfUnlessModifier:
+  Enabled: false
+
+# scope 等は複数行でも lambda ではなく ->{} で揃えた方が見た目が綺麗
+Style/Lambda:
+  EnforcedStyle: literal
+
+# end.some_method とチェインするのはダサい
+# Style/BlockDelimiters と相性が悪いけど、頑張ってコードを修正してください
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# この 2 つは単発で動かすのが分かっているので Object を汚染しても問題ない。
+# spec/dummy は Rails Engine を開発するときに絶対に引っかかるので入れておく。
+Style/MixinUsage:
+  Exclude:
+    - "bin/setup"
+    - "bin/update"
+    - "spec/dummy/bin/setup"
+    - "spec/dummy/bin/update"
+
+# 1_000_000 と区切り文字が 2 個以上必要になる場合のみ _ 区切りを必須にする
+# 10_000_00 は許可しない。(これは例えば 10000 ドルをセント単位にする時に便利だが
+# 頻出しないので foolproof に振る
+Style/NumericLiterals:
+  MinDigits: 7
+  Strict: true
+
+# foo.positive? は foo > 0 に比べて意味が曖昧になる
+# foo.zero? は許可したいけどメソッドごとに指定できないので一括で disable に
+Style/NumericPredicate:
+  Enabled: false
+
+# falsy な場合という条件式の方を意識させたい場合がある。
+# Style/IfUnlessModifier と同じ雰囲気。
+Style/OrAssignment:
+  Enabled: false
+
+# 正規表現にマッチさせた時の特殊変数の置き換えは Regex.last_match ではなく
+# 名前付きキャプチャを使って参照したいので auto-correct しない
+Style/PerlBackrefs:
+  AutoCorrect: false
+
+# Hash#has_key? の方が key? よりも意味が通る
+Style/PreferredHashMethods:
+  EnforcedStyle: verbose
+
+# begin - end を省略しろというのは分かりにくくなるため省略を推奨しない
+Style/RedundantBegin:
+  Enabled: false
+
+# 受け取り側で multiple assignment しろというのを明示
+Style/RedundantReturn:
+  AllowMultipleReturnValues: true
+
+# 特に model 内において、ローカル変数とメソッド呼び出しの区別をつけた方が分かりやすい場合が多い
+Style/RedundantSelf:
+  Enabled: false
+
+# 無指定だと StandardError を rescue するのは常識の範疇なので。
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+# user&.admin? が、[nil, true, false] の 3 値を返すことに一瞬で気づけず
+# boolean を返すっぽく見えてしまうので無効に。
+# user && user.admin? なら短絡評価で nil が返ってくるのが一目で分かるので。
+# (boolean を返すメソッド以外なら積極的に使いたいんだけどねぇ
+#
+# 他に auto-correct してはいけないパターンとして
+#   if hoge && hoge.count > 1
+# がある。
+Style/SafeNavigation:
+  Enabled: false
+
+# spec 内は見た目が綺麗になるので許可
+Style/Semicolon:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+# * 式展開したい場合に書き換えるのが面倒
+# * 文章ではダブルクォートよりもシングルクォートの方が頻出する
+# ことから EnforcedStyle: double_quotes 推奨
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+# 式展開中でもダブルクォートを使う
+# 普段の文字列リテラルがダブルクォートなので使い分けるのが面倒
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+# String#intern は ruby の内部表現すぎるので String#to_sym を使う
+Style/StringMethods:
+  Enabled: true
+
+# %w() と %i() が見分けづらいので Style/WordArray と合わせて無効に。
+# 書き手に委ねるという意味で、Enabled: false にしています。使っても良い。
+Style/SymbolArray:
+  Enabled: false
+
+# 三項演算子は分かりやすく使いたい。
+# () を外さない方が条件式が何なのか読み取りやすいと感じる。
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex
+
+# 複数行の場合はケツカンマを入れる(引数)
+# Ruby は関数の引数もカンマを許容しているので
+# * 単行は常にケツカンマ無し
+# * 複数行は常にケツカンマ有り
+# に統一したい。
+# 見た目がアレだが、ES2017 でも関数引数のケツカンマが許容されるので
+# 世界はそちらに向かっている。
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+# 複数行の場合はケツカンマを入れる(Arrayリテラル)
+# JSON がケツカンマを許していないという反対意見もあるが、
+# 古い JScript の仕様に縛られる必要は無い。
+# IE9 以降はリテラルでケツカンマ OK なので正しい差分行の検出に寄せる。
+# 2 insertions(+), 1 deletion(-) ではなく、1 insertions
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+# 複数行の場合はケツカンマを入れる(Hashリテラル)
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+# %w() と %i() が見分けづらいので Style/SymbolArray と合わせて無効に。
+# 書き手に委ねるという意味で、Enabled: false にしています。使っても良い。
+Style/WordArray:
+  Enabled: false
+
+# 0 <= foo && foo < 5 のように数直線上に並べるのは
+# コードを読みやすくするテクニックなので forbid_for_equality_operators_only に。
+Style/YodaCondition:
+  EnforcedStyle: forbid_for_equality_operators_only
+
+# 条件式で arr.size > 0 が使われた時に
+#   if !arr.empty?
+#   else
+#   end
+# に修正されるのが嫌。
+# 中身を入れ替えて否定外しても良いんだけど、どちらが例外的な処理なのかが分かりづらくなる。
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+# =begin...=end によるブロックコメントを許可する
+Style/BlockComments:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 999999`
+# on 2023-09-20 08:02:13 UTC using RuboCop version 1.56.3.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at sugiyama-shinichi@kayac.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_record-cursor_pagination.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+group :test do
+  gem 'temping'
+  gem 'pg', '>= 1.2', '< 2.0'
+  gem 'mysql2', '~> 0.5'
+end

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    active_record-cursor_paginator (0.1.0)
+      activerecord (>= 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.8)
+      activesupport (= 7.0.8)
+    activerecord (7.0.8)
+      activemodel (= 7.0.8)
+      activesupport (= 7.0.8)
+    activesupport (7.0.8)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.20.0)
+    mysql2 (0.5.5)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    pg (1.5.4)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    temping (4.0.0)
+      activerecord (>= 5.2, < 7.1)
+      activesupport (>= 5.2, < 7.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  active_record-cursor_paginator!
+  mysql2 (~> 0.5)
+  pg (>= 1.2, < 2.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  temping
+
+BUNDLED WITH
+   2.4.10

data/README.md

@@ -0,0 +1,62 @@
+# Activerecord::CursorPaginator
+
+This library is an implementation of cursor pagination for ActiveRecord relations based on "https://github.com/xing/rails_cursor_pagination.
+
+Additional features are:
+- receives a relation with orders, and it is unnecessary to specify orders toA this library separately
+- supports bidirectional pagination.
+
+## Supported environment
+
+- ActiveRecord
+- mysql or Postgresql
+
+## Installation
+
+Add the fllowing line to your `Gemfile` and execute `bundle install`
+
+```
+gem 'active_record-cursor_paginator', git: 'https://github.com/ssugiyama/active_record-cursor_paginator'
+```
+
+## Usage
+
+```ruby
+relation = Post.order(...)
+page = ActiveRecord::CursorPaginator.new(relarion, direction: :forward, cursor: '...', per_page: 10)
+```
+
+### parameters of CursorPaginator
+- cursor: String - cursor to paginate
+- per_page: Integer - record count per page (default to 10)
+- direction: Symbol - direction to paginate. `:forward` (default) or `:backward`
+
+### response of CursorPaginator
+
+- `page.records`: Array - records splitted per page (Notice: not ActiveRecord::Relation but Array)
+- `page.start_cursor`: String - cursor of the first record. used for the backward paginate call.
+- `page.end_cursor`: String - cursor of the last record. used for the forward paginate call.
+- `page.total`: Integer - total count of relation
+- `page.next_page?`:  Boolean - whether having the next page forward or not
+- `page.previous_page?`:  Boolean - whether having the next page backward or not
+
+## Development
+
+### Run test
+
+```shell
+ADAPTER=mysql bundle exec rspec
+ADAPTER=postgresql bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ssugiyama/activerecord-cursor_paginator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ssugiyama/activerecord-cursor_paginator/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Activerecord::CursorPagination project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ssugiyama/activerecord-cursor_paginator/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/active_record/cursor_paginator/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  class CursorPaginator
+    VERSION = '0.1.0'
+  end
+end

data/lib/active_record/cursor_paginator.rb

@@ -0,0 +1,261 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require_relative 'cursor_paginator/version'
+
+module ActiveRecord
+  class CursorPaginator
+    DIRECTIONS = [
+      DIRECTION_FORWARD  = :forward,
+      DIRECTION_BACKWARD = :backward,
+    ].freeze
+
+    class ParameterError < StandardError; end
+    class InvalidCursorError < ParameterError; end
+    class InvalidOrderError < ParameterError; end
+
+    # @param relation [ActiveRecord::Relation]
+    #   Relation that will be paginated.
+    # @param per_page [Integer, nil]
+    #   Number of records to return.
+    # @param cursor [String, nil]
+    #   Cursor to paginate
+    # @param order [Array, Hash, Symbol, nil]
+    #   Column to order by. If none is provided, will default to ID column.
+    def initialize(relation, per_page: nil, cursor: nil, direction: DIRECTION_FORWARD)
+      @is_forward_pagination = direction == DIRECTION_FORWARD
+      relation = relation.order(:id) if relation.order_values.empty?
+      relation = relation.reverse_order unless @is_forward_pagination
+      @fields = extract_order_fields(relation)
+      @fields.push({ 'id' => :asc }) if @fields.last.keys.first != 'id'
+      @relation = relation.reorder(@fields)
+      @cursor = cursor
+      @page_size = per_page
+
+      @memos = {}
+    end
+
+    # extract order parameter from relation as the format : [ { field1 => :asc}, { field2 => :desc}, ...]
+    # @param relation [ActiveRecord::Relation]
+    # @return [Array]
+    def extract_order_fields(relation)
+      orders = relation.order_values
+      fields = orders.flat_map do |o|
+        case o
+        when Arel::Attribute # .order(arel_table[:id])
+          { o.name => :asc }
+        when Arel::Nodes::Ascending # .order(id: :asc), .order(:id)
+          { o.expr.name => :asc }
+        when Arel::Nodes::Descending # .order(id: :desc)
+          { o.expr.name => :desc }
+        when String # .order('id desc')
+          o.split(',').map! do |s|
+            s.strip!
+            matches = s.match(/\A(\w+)(?:\s+(asc|desc))?\Z/i)
+            raise InvalidOrderError, 'relation has an unsupported order.' if matches.nil? || matches.length < 3
+
+            { matches[1] => (matches[2] || 'asc').downcase.to_sym }
+          end
+        else # complex arel expression
+          raise InvalidOrderError, 'relation has an unsupported order.'
+        end
+      end
+      fields.flatten
+    end
+
+    # Cursor of the first record on the current page
+    #
+    # @return [String, nil]
+    def start_cursor
+      return if records.empty?
+
+      cursor_for_record(records.first)
+    end
+
+    # Cursor of the last record on the current page
+    #
+    # @return [String, nil]
+    def end_cursor
+      return if records.empty?
+
+      cursor_for_record(records.last)
+    end
+
+    # Get the total number of records in the given relation
+    #
+    # @return [Integer]
+    def total
+      memoize(:total) { @relation.reorder('').size }
+    end
+
+    # Check if there is a page before the current one.
+    #
+    # @return [TrueClass, FalseClass]
+    def previous_page?
+      if paginate_forward?
+        # When paginating forwards and cursor is specified,
+        # we have the previous page, because specified cursor may be the end cursor of a page
+        @cursor.present?
+      else
+        # When paginating backwards, if we managed to load one more record than
+        # requested, this record will be available on the previous page.
+        records_plus_one.size > @page_size
+      end
+    end
+
+    # Check if there is another page after the current one.
+    #
+    # @return [TrueClass, FalseClass]
+    def next_page?
+      if paginate_forward?
+        # When paginating forward, if we managed to load one more record than
+        # requested, this record will be available on the next page.
+        records_plus_one.size > @page_size
+      else
+        # When paginating backward, in most cases,
+        # we have the next page, because specified cursor may be the start cursor of a page
+        true
+      end
+    end
+
+    # Load the correct records and return them in the right order
+    #
+    # @return [Array<ActiveRecord>]
+    def records
+      records = records_plus_one.first(@page_size)
+      paginate_forward? ? records : records.reverse
+    end
+
+    # Check if the pagination direction is forward
+    #
+    # @return [TrueClass, FalseClass]
+    def paginate_forward?
+      @is_forward_pagination
+    end
+
+    private
+
+      # Apply limit to filtered and sorted relation that contains one item more
+      # than the user-requested page size. This is useful for determining if there
+      # is an additional page available without having to do a separate DB query.
+      # Then, fetch the records from the database to prevent multiple queries to
+      # load the records and count them.
+      #
+      # @return [ActiveRecord::Relation]
+      def records_plus_one
+        memoize :records_plus_one do
+          filtered_and_sorted_relation.first(@page_size + 1)
+        end
+      end
+
+      # Generate a cursor for the given record and ordering field. The cursor
+      # encodes all the data required to then paginate based on it with the given
+      # ordering field.
+      #
+      # If we only order by ID, the cursor doesn't need to include any other data.
+      # But if we order by any other field, the cursor needs to include both the
+      # value from this other field as well as the records ID to resolve the order
+      # of duplicates in the non-ID field.
+      #
+      # @param record [ActiveRecord] Model instance for which we want the cursor
+      # @return [String]
+      def cursor_for_record(record)
+        unencoded_cursor = @fields.map {|field| { field.keys.first => record[field.keys.first] } }
+        Base64.strict_encode64(unencoded_cursor.to_json)
+      end
+
+      # Decode the provided cursor. Either just returns the cursor's ID or in case
+      # of pagination on any other field, returns a tuple of first the cursor
+      # record's other field's value followed by its ID.
+      #
+      # @return [Integer, Array]
+      def decoded_cursor
+        memoize(:decoded_cursor) { JSON.parse(Base64.strict_decode64(@cursor)) }
+      rescue ArgumentError, JSON::ParserError
+        raise InvalidCursorError, 'The given cursor could not be decoded'
+      end
+
+      # Ensure that the relation has the ID column and any potential `order_by`
+      # column selected. These are required to generate the record's cursor and
+      # therefore it's crucial that they are part of the selected fields.
+      #
+      # @return [ActiveRecord::Relation]
+      def relation_with_cursor_fields
+        return @relation if @relation.select_values.blank?
+
+        relation = @relation
+
+        @fields.each do |field|
+          field = field.keys.first
+          relation = relation.select(field) unless @relation.select_values.include?(field)
+        end
+
+        relation
+      end
+
+      # The given relation with the right ordering applied. Takes custom order
+      # columns as well as custom direction and pagination into account.
+      #
+      # @return [ActiveRecord::Relation]
+      def sorted_relation
+        relation_with_cursor_fields
+      end
+
+      # Applies the filtering based on the provided cursor and order column to the
+      # sorted relation.
+      #
+      # @return [ActiveRecord::Relation]
+      def filtered_and_sorted_relation
+        memoize :filtered_and_sorted_relation do
+          next sorted_relation if @cursor.blank?
+
+          cursor = decoded_cursor
+          unless cursor.length == @fields.length && cursor.map {|field| field.keys.first } == @fields.map {|field| field.keys.first }
+            raise InvalidCursorError, 'The given cursor is mismatched with current query'
+          end
+
+          prev_fields = []
+          relation = nil
+          cursor.zip(@fields).each do |cursor_field, field|
+            direction = field.values.first
+            # range では 〜より大きいということが表現できないのでarel_tableを使う
+            op = (direction == :asc) ? :gt : :lt
+            current_field = [field.keys.first, cursor_field.values.first]
+            new_relation = build_filter_query(sorted_relation, op, current_field, prev_fields)
+            relation = relation.nil? ? new_relation : relation.or(new_relation)
+
+            prev_fields.push(current_field)
+          end
+          relation
+        end
+      end
+
+      # Ensures that given block is only executed exactly once and on subsequent
+      # calls returns result from first execution. Useful for memoizing methods.
+      #
+      # @param key [Symbol]
+      #   Name or unique identifier of the method that is being memoized
+      # @yieldreturn [Object]
+      # @return [Object] Whatever the block returns
+      def memoize(key)
+        return @memos[key] if @memos.has_key?(key)
+
+        @memos[key] = yield
+      end
+
+      # Modelを[{ col1: :asc}, { col2: :asc}, { col3: :asc}] でソートする場合以下のようにする
+      # Model.where('col1 > ?').
+      #   or(Model.where('col1 = ?').where('col2 > ?')).
+      #   or(Model.where('col1 = ?').where('col2 = ?')).where('col3 > ?))
+      #
+      # @return [ActiveRecord::Relation]
+      def build_filter_query(sorted_relation, op, current_field, prev_fields)
+        relation = sorted_relation
+        prev_fields.each do |col, val|
+          relation = relation.where(relation.arel_table[col].send(:eq, val))
+        end
+        col, val = current_field
+        relation.where(relation.arel_table[col].send(op, val))
+      end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: active_record-cursor_paginator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shinichi Sugiyama
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: 'This library is an implementation of cursor pagination for ActiveRecord
+  relations based on "https://github.com/xing/rails_cursor_pagination". Additional
+  features are: - receives a relation with orders, and it is unnecessary to specify
+  orders to this library separately.- supports bidirectional pagination.'
+email:
+- sugiyama-shinichi@kayac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/active_record/cursor_paginator.rb
+- lib/active_record/cursor_paginator/version.rb
+homepage: https://github.com/ssugiyama/active_record-cursor_paginator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ssugiyama/active_record-cursor_paginator
+  source_code_uri: https://github.com/ssugiyama/active_record-cursor_paginator
+  changelog_uri: https://github.com/ssugiyama/active_record-cursor_paginator/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: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: cursor pagination for ActiveRecord
+test_files: []