kaminari_guard 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b44fbde9a13417da9517247015905637b23cca3c54879a025947fab865a33ac
+  data.tar.gz: 5a0bdbaa2f5698006c07f8906d5e78c947438d25636c17690160e8c9cdc4a463
+SHA512:
+  metadata.gz: e6dcb92fa1eca12c4295bf1e74f976b34fec899cdb9dfe31dc7ee06d8d8c47099c452f4d40a08fd9776599c084f0512bc35a784ea4ae98a422548bfa981d3e0f
+  data.tar.gz: 5412eab9a6dfbc846656f3887be5c22109783f4162b415a0694ea1dbb6a66313aad965d0e670c64ef373c91e6167a85d3c9fbd2edd24339b78506531cbd6c2fc

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 3.2
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 aki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# ⚡️kaminari_guard🛡️
+
+`kaminari_guard` is a gem that helps you detect missing `paginate` method calls in `kaminari`, ensuring that your pagination works correctly.
+
+## Installation
+
+Gemfile
+```ruby
+group :development, :test do
+  gem 'kaminari_guard'
+end
+```
+
+## Usage
+
+In app/controllers/application_controller.rb
+
+```ruby
+class ApplicationController < ActionController::Base
+  kaminari_guard unless Rails.env.production?
+end
+```
+
+In app/models/application_record.rb
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  kaminari_guard unless Rails.env.production?
+end
+```
+
+## Example
+
+The following code will raise an exception.
+
+```ruby
+class PostsController < ApplicationController
+  def index
+    @posts = Post.all.page(params[:page])
+  end
+end
+```
+
+```erb
+<% if @posts.present? %>
+  <% @posts.each do |post| %>
+    <div><%= post.title %></div>
+  <% end %>
+  <!-- Forgot to call the `paginate` helper -->
+<% else %>
+  <div>No posts</div>
+<% end %>
+```
+
+## 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 KaminariGuard project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/aki77/kaminari_guard/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/kaminari_guard/active_record_extension.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module KaminariGuard
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def kaminari_guard
+        singleton_class.alias_method :kaminari_page, :page
+
+        define_singleton_method :page do |num|
+          kaminari_page(num).tap { KaminariGuard::Current.add(_1) }
+        end
+      end
+    end
+  end
+end

data/lib/kaminari_guard/controller_extension.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module KaminariGuard
+  module ControllerExtension
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def kaminari_guard
+        after_action lambda {
+          KaminariGuard::Current.scopes.each(&:verify_total_pages_called!)
+        }
+      end
+    end
+  end
+end

data/lib/kaminari_guard/current.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "active_support"
+
+module KaminariGuard
+  class Current < ActiveSupport::CurrentAttributes
+    attribute :scopes, default: -> { [] }
+
+    def add(scope)
+      scopes << scope
+    end
+  end
+end

data/lib/kaminari_guard/page_scope_methods_extension.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module KaminariGuard
+  module PageScopeMethodsExtension
+    def total_pages
+      @total_pages_called = true
+      super
+    end
+
+    def verify_total_pages_called!
+      return unless loaded? && size.positive? && @total_pages_called.nil?
+
+      raise KaminariGuard::Error, "total_pages method is not called!"
+    end
+  end
+end

data/lib/kaminari_guard/railtie.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require_relative "controller_extension"
+require_relative "active_record_extension"
+require_relative "page_scope_methods_extension"
+require_relative "current"
+
+module KaminariGuard
+  class Railtie < Rails::Railtie
+    initializer :kaminari_guard do
+      ActiveSupport.on_load(:action_controller) do
+        include KaminariGuard::ControllerExtension
+      end
+
+      ActiveSupport.on_load(:active_record) do
+        include KaminariGuard::ActiveRecordExtension
+      end
+    end
+
+    initializer :kaminari_guard_page_scope_methods, after: :load_config_initializers do
+      Kaminari::PageScopeMethods.prepend KaminariGuard::PageScopeMethodsExtension
+    end
+  end
+end

data/lib/kaminari_guard/version.rb

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

data/lib/kaminari_guard.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "kaminari_guard/railtie"
+require_relative "kaminari_guard/version"
+
+module KaminariGuard
+  class Error < StandardError; end
+end

data/sig/kaminari_guard.rbs

@@ -0,0 +1,4 @@
+module KaminariGuard
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: kaminari_guard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- aki77
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.4
+description: KaminariGuard is a gem that helps you detect missing paginate method
+  calls in Kaminari, ensuring that your pagination works correctly.
+email:
+- aki77@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/kaminari_guard.rb
+- lib/kaminari_guard/active_record_extension.rb
+- lib/kaminari_guard/controller_extension.rb
+- lib/kaminari_guard/current.rb
+- lib/kaminari_guard/page_scope_methods_extension.rb
+- lib/kaminari_guard/railtie.rb
+- lib/kaminari_guard/version.rb
+- sig/kaminari_guard.rbs
+homepage: https://github.com/aki77/kaminari_guard
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aki77/kaminari_guard
+  source_code_uri: https://github.com/aki77/kaminari_guard
+  changelog_uri: https://github.com/aki77/kaminari_guard/releases
+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.16
+signing_key:
+specification_version: 4
+summary: A gem to detect missing paginate method calls in Kaminari.
+test_files: []