api_only_pagination 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df8d4b65cd6919886b92cc7aa4321cb56c64acd0656ad54aa5b057b772b94815
-  data.tar.gz: 82e0979809dcbc13f795a161e5345e52192730d301b7b61ca5612414b0e2ec67
+  metadata.gz: f6d061e8e8b177a9162d5d74908e3cc3ba5e2fc2bae27e5d4623c036b31a8690
+  data.tar.gz: 6a8de04ac9425d054808fbb3c5d4554c28a3444753229f2a047891ebaa183a63
 SHA512:
-  metadata.gz: 8851f8382e803cfc15b291f40feba6c005f4ed94ea46b45ca76a62453f0950ebe5a346529f8a262149537e86eb196f35dc706edfde5e7287033c8bb935204dbb
-  data.tar.gz: 588b778f574d748a74be48911e6c18c22722a55246088d6e4796e5069314e68b79592f4aa36b2cf75d717807b3a24c74a2deeee93c757896a9d8596ae16c8782
+  metadata.gz: e187502965e71964a3224647ffbaa34e13763780c292d8f01a3c2e350632bff1738d314a10a8b9534bf84522f6fdfdf8bad020c6dca122907040f27cc19a692b
+  data.tar.gz: d2d059b67a91be138b6aae23d0506c41c5d5c8ee957f5de172e338d5e2c2c53a6786d51f77606e24295f452fd354e7f0a986dd0a28c794032391effbbc4ae9b5

data/Gemfile.lock

@@ -0,0 +1,123 @@
+PATH
+  remote: .
+  specs:
+    api_only_pagination (0.1.2)
+      activerecord (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.1.7.3)
+      actionview (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.1.7.3)
+      activesupport (= 6.1.7.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.1.7.3)
+      activesupport (= 6.1.7.3)
+    activerecord (6.1.7.3)
+      activemodel (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
+    activesupport (6.1.7.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.1)
+    loofah (2.20.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    nokogiri (1.13.10-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (6.1.7.3)
+      actionpack (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (4.0.2)
+      actionpack (>= 4.2)
+      activesupport (>= 4.2)
+      railties (>= 4.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.11.0)
+    thor (1.2.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  api_only_pagination!
+  rake (~> 13.0)
+  rspec (~> 3.6)
+  rspec-rails (~> 4.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.9

data/README.md

@@ -1,24 +1,43 @@
 # ApiOnlyPagination
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/api_only_pagination`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
+Lightweight pagination gem that works only with Activerecord for Api only applications
+ ## Installation
+To install this gem,
+```
+   $ gem install api_only_pagination
+```
+or add it to your Gemfile
+```
+   gem 'api_only_pagination'
+```
 ## Usage
 
-TODO: Write usage instructions here
+Configure your pagination adding api_only_pagination.rb file in config/initializers unless it will take default configurations.
+ 
+ ```
+ ApiOnlyPagination.configure do |config|
+   config.default_page_size = 3
+   config.max_per_page = 100
+   config.default_page = 1
+ end
+ ```
+
+ Now you can call chain .do_paginate(page, per_page) to your activerecord query.
+```
+ response = User.do_paginate(1,20)
+ ```
+
+ The response will be 
+
+      
+         { 
+         "data" => [], 
+         "per_page" => 3,
+         "current_page" => 1,
+         "total_pages" => 2,
+         "total_records" => 5
+         }
+         
+
 
 ## Development
 

data/api_only_pagination.gemspec

@@ -10,15 +10,14 @@ Gem::Specification.new do |spec|
 
   spec.summary = "pagination with api response only"
   spec.description = "pagination with api response only"
-  # spec.homepage = ""
+  spec.homepage = "https://github.com/ashok1/api_only_pagination"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
 
-  # spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = ""
-  # spec.metadata["changelog_uri"] = ""
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
 
   # 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.
@@ -30,7 +29,9 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
+  spec.add_dependency "activerecord", ">= 5.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "rspec-rails", "~> 4.0"
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
 

data/lib/api_only_pagination/active_record_paginate.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "active_record"
+
+module ApiOnlyPagination
+  module ActiveRecordPaginate
+    extend ActiveSupport::Concern
+    module ClassMethods
+      def do_paginate(page = ApiOnlyPagination.configuration.default_page,
+                      per_page = ApiOnlyPagination.configuration.default_page_size)
+        pagination = ApiOnlyPagination::Pagination.new(all, { page: page, per_page: per_page })
+        meta_data = pagination.metadata
+
+        ApiOnlyPagination::PaginatedData
+          .new(data: pagination.results,
+               per_page: meta_data.per_page,
+               current_page: page,
+               total_pages: meta_data.total_pages,
+               total_records: meta_data.count)
+      end
+    end
+  end
+end

data/lib/api_only_pagination/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ApiOnlyPagination
+  class Configuration
+    attr_accessor :default_page_size, :max_per_page, :default_page
+
+    def initialize
+      @default_page_size = 20
+      @max_per_page = 100
+      @default_page = 1
+    end
+  end
+end

data/lib/api_only_pagination/paginate.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ApiOnlyPagination
+  class Paginate
+    attr_reader :page, :count, :per_page
+
+    def initialize(page, per_page, count)
+      @page     = (page || ApiOnlyPagination.configuration.default_page).to_i
+      @count    = count
+      @per_page = [(per_page.to_i || ApiOnlyPagination.configuration.default_page_size),
+                   ApiOnlyPagination.configuration.max_per_page].min
+    end
+
+    def offset
+      return 0 if page == 1
+
+      per_page * (page.to_i - 1)
+    end
+
+    def next_page
+      page + 1 unless last_page?
+    end
+
+    def next_page?
+      page < total_pages
+    end
+
+    def previous_page
+      page - 1 unless first_page?
+    end
+
+    def previous_page?
+      page > 1
+    end
+
+    def last_page?
+      page == total_pages
+    end
+
+    def first_page?
+      page == 1
+    end
+
+    def total_pages
+      (count / per_page.to_f).ceil
+    end
+  end
+end

data/lib/api_only_pagination/paginated_data.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Main module
+module ApiOnlyPagination
+  # Response object class
+  class PaginatedData
+    attr_accessor :data,
+                  :per_page,
+                  :current_page,
+                  :total_pages,
+                  :total_records
+
+    def initialize(data:, per_page:, current_page:, total_pages:, total_records:)
+      @data = data
+      @per_page = per_page
+      @current_page = current_page
+      @total_pages = total_pages
+      @total_records = total_records
+    end
+  end
+end

data/lib/api_only_pagination/pagination.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ApiOnlyPagination
+  class Pagination
+    attr_reader :collection, :params
+
+    def initialize(collection, params = {})
+      @collection = collection
+      @params = params.merge(count: collection.count)
+    end
+
+    def metadata
+      @metadata ||= ApiOnlyPagination::Paginate.new(params[:page], params[:per_page], params[:count])
+    end
+
+    def results
+      collection
+        .limit(metadata.per_page)
+        .offset(metadata.offset)
+    end
+  end
+end

data/lib/api_only_pagination/version.rb

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

data/lib/api_only_pagination.rb

@@ -1,19 +1,14 @@
 # frozen_string_literal: true
 
+require "active_record"
 require_relative "api_only_pagination/version"
 require_relative "api_only_pagination/configuration"
 require_relative "api_only_pagination/paginate"
 require_relative "api_only_pagination/pagination"
+require_relative "api_only_pagination/paginated_data"
+require_relative "api_only_pagination/active_record_paginate"
 
 module ApiOnlyPagination
-  def paginated_response(collection ,
-     page = ApiOnlyPagination.configuration.default_page, 
-     per_page = ApiOnlyPagination.configuration.default_page_size )
-    pagination = ApiOnlyPagination::Pagination.new(collection, {page: page, per_page: per_page})
-    meta_data = pagination.metadata
-    meta_data.as_json.merge({ data: pagination.results })
-  end
-
   class << self
     def configuration
       @configuration ||= Configuration.new
@@ -28,3 +23,8 @@ module ApiOnlyPagination
     end
   end
 end
+
+ActiveSupport.on_load(:active_record) do
+  include ApiOnlyPagination::ActiveRecordPaginate
+  ActiveRecord::Relation.include(ApiOnlyPagination::ActiveRecordPaginate)
+end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: api_only_pagination
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Ashok
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-24 00:00:00.000000000 Z
-dependencies: []
+date: 2023-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: pagination with api response only
 email:
 - kingkoirala1@gmail.com
@@ -21,17 +63,25 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - api_only_pagination.gemspec
 - lib/api_only_pagination.rb
+- lib/api_only_pagination/active_record_paginate.rb
+- lib/api_only_pagination/configuration.rb
+- lib/api_only_pagination/paginate.rb
+- lib/api_only_pagination/paginated_data.rb
+- lib/api_only_pagination/pagination.rb
 - lib/api_only_pagination/version.rb
 - sig/api_only_pagination.rbs
-homepage:
+homepage: https://github.com/ashok1/api_only_pagination
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/ashok1/api_only_pagination
+  source_code_uri: https://github.com/ashok1/api_only_pagination
 post_install_message:
 rdoc_options: []
 require_paths: