next-pageable 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9f88eff8dad2504dd32c9a49afc24c19448da58ced5b120dd360f97e9d9710d
-  data.tar.gz: 391ee2340288123774b646ed0001a11004c3e12ddf174462967a3a7e699d1ee1
+  metadata.gz: 5abdd23f398d5f529f959da4793c30db99807474476a51f56ca692068105f188
+  data.tar.gz: f525d4493a6f6aee5d27a530f4ec51510084effe7075d7bc17ac18c23b6f3b5b
 SHA512:
-  metadata.gz: 6815d4b264c273e91642237acd7eaea2613a4075f2282a7574ec48215c147f131721f6519a7afd7c1f4f65e0de2f234526cf8ee87385f32845266c9680dcfd45
-  data.tar.gz: df93a85fad5b596b143f27bcaabf32d133c6dd6ddc3cf9e59adc495c8570bf7e182be39e3af2f2317e9af789f28d07bdc3fc28527ca657ec78e627be39a42f1e
+  metadata.gz: ead4b6ee1a3abacfb9a9f5a0cebabcf54e18bcb8f7d1336ee59a47fc08abf45dd4122248d1e13543f27d26df2f3ae7dd1d38725379e63eca81efe1a75dd669dd
+  data.tar.gz: 40dad7991b5840033976cbd1b40e134664439a2254e5fe3cdd88596b787bdacba54052c846b676a92881184f7eda3df379abd38535827873f3fc29cdd6ef0588

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    next-pageable (0.1.1)
+    next-pageable (0.1.3)
       activesupport
 
 GEM
@@ -50,6 +50,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   minitest (~> 5.0)

data/README.md

@@ -1,6 +1,10 @@
 # NextPageable
 
-An ActiveRecord concern for basic paging support of ActiveRecord relations.
+A minimalstic ActiveRecord concern for basic paging support of ActiveRecord relations avoiding extra count queries where not needed.
+
+This gem is the perfect companion for [turbo-scroll](https://github.com/allcrux/turbo-scroll).
+
+[![Ruby](https://github.com/allcrux/next-pageable/actions/workflows/main.yml/badge.svg)](https://github.com/allcrux/next-pageable/actions/workflows/main.yml)
 
 ## Installation
 
@@ -16,17 +20,16 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 To make your ActiveRecord relations pageable, inlude NextPageable on the models that you want to enrich.
 
-```
+```rb
 class Article < ActiveRecord::Base
   include NextPageable
   ...
 end
 ```
 
-Alternatively, you can include NextPageable directly on your ApplicationRecord if you want it to be available to all
-of your models
+Alternatively, you can include NextPageable directly on your ApplicationRecord if you want it to be available to all of your models.
 
-```
+```rb
 class ApplicationRecord < ActiveRecord::Base
     include NextPageable
   ...
@@ -36,28 +39,28 @@ end
 For models that are enriched one extra class method `page` becomes available.
 It can be chained onto existing scope methods but should be the last method in the chain.
 
-```
+```rb
 page = Article.all.page(0) # returns the 1st page for all articles
 page = Article.in_stock.page(3) # returns the 4th page for articles currently in stock
 ```
 
-Default pagesize is 15 but it can be passed as an extra parameter
+Default pagesize is 15 but it can be passed as an extra parameter.
 
-```
+```rb
 page = Article.all.page(1, pagesize: 50) # returns the 2nd page for all articles with a pagesize of 50
 ```
 
-You can directly iterate over the records on the page object:
+You can directly iterate over the records on the page object.
 
-```
+```rb
 page.each do |article|
   puts article
 end
 ```
 
-A page object also knows if there is a next page available and what the page value is
+A page object also knows if there is a next page available and what the page value is.
 
-```
+```rb
 page.next_page? # true
 page.next_page_index # 4
 ```
@@ -70,8 +73,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/allcrux/next_pageable.
-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/[USERNAME]/next_pageable/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/allcrux/next-pageable.
+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/allcrux/next-pageable/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -79,4 +82,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the NextPageable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/next_pageable/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the NextPageable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/allcrux/next-pageable/blob/main/CODE_OF_CONDUCT.md).

data/lib/next-pageable/page.rb

@@ -1,4 +1,4 @@
-require 'active_support/core_ext/module/delegation'
+require "active_support/core_ext/module/delegation"
 
 module NextPageable
   class Page

data/lib/next-pageable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NextPageable
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/next-pageable.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'active_support/concern'
+
+require "active_support/concern"
 
 require_relative "next-pageable/version"
 require_relative "next-pageable/page"
@@ -8,18 +9,18 @@ module NextPageable
   extend ActiveSupport::Concern
 
   class_methods do
-    def page(page, pagesize: 15)
+    def paginate(page, pagesize: 15)
       collection =
-        self
-          .limit(pagesize+1)
-          .offset(page.to_i*pagesize)
+
+        limit(pagesize + 1)
+          .offset(page.to_i * pagesize)
 
       if collection.length > pagesize
-        next_page_index = page.to_i+1
+        next_page_index = page.to_i + 1
         collection = collection[0...-1]
       end
 
-      return Page.new(collection: collection, next_page_index: next_page_index)
+      Page.new(collection: collection, next_page_index: next_page_index)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: next-pageable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Koen handekyn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-05 00:00:00.000000000 Z
+date: 2022-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -42,16 +42,15 @@ files:
 - lib/next-pageable.rb
 - lib/next-pageable/page.rb
 - lib/next-pageable/version.rb
-- next-pageable.gemspec
 - sig/next-pageable.rbs
-homepage: https://github.com/allcrux/next_pageable
+homepage: https://github.com/allcrux/next-pageable
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/allcrux/next_pageable
-  source_code_uri: https://github.com/allcrux/next_pageable
-  changelog_uri: https://github.com/allcrux/next_pageable/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/allcrux/next-pageable
+  source_code_uri: https://github.com/allcrux/next-pageable
+  changelog_uri: https://github.com/allcrux/next-pageable/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

data/next-pageable.gemspec

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/next-pageable/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "next-pageable"
-  spec.version = NextPageable::VERSION
-  spec.authors = ["Koen handekyn"]
-  spec.email = ["koen@handekyn.com"]
-
-  spec.summary = "Simple paging extension for ActiveRecord::Model."
-  spec.description = "An ActiveModel concern for basic paging without an extra count query."
-  spec.homepage = "https://github.com/allcrux/next_pageable"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.0.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/allcrux/next_pageable"
-  spec.metadata["changelog_uri"] = "https://github.com/allcrux/next_pageable/blob/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "activesupport"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end