tiny_paginate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6b2caec64c2c5c746781cbc9e57bfac292c34545568337a420822a3a295da1f
+  data.tar.gz: 83d07ec849f9ccddcb4b383e5e9b52caefde77f4b694857d7ade9764842bf729
+SHA512:
+  metadata.gz: b8ccb5e57cc60d4d7359b8967288aec7c7d2aca5796b28b030c1fc2073979471c36921003e6456b422f59e07ca43ad62800c37e8717e7ea4ee3d6835ac005553
+  data.tar.gz: c756481b59e8504ac5570b8648154725a73d8214ef171df224beede9d8114b8955daa2cf9692d29605762048652020b97120c06cb5c50695b1cbb46e54f1f79d

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Tiny Paginate
+
+## 0.1.0(October 17, 2025)
+### Bug Fixes
+* none
+
+## Features
+* Pagination of active_record records

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Enow Mbi
+
+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,70 @@
+# tiny\_paginate
+  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+tiny_paginate is a lightweight and easy-to-use pagination gem for Ruby on Rails. Designed for simplicity and minimal overhead, it provides basic pagination functionality with clean helpers and minimal configuration—perfect for small projects or developers who want to avoid the complexity of larger pagination libraries.
+
+## Usage
+`tiny_paginate` is simple to use. Follow the steps below to install and use it.
+
+### Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "tiny_paginate"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install tiny_paginate
+```
+To work with this gem in your application, execute the following command:
+ ```bash
+$ rails g tiny_paginate:install
+```
+
+#### Modify controller
+Here, we'll add the following line to setup page instance variable and extract portion of the records:
+ 
+```
+@recordings = set_page_and_extract_portion_from(collection: Recording.all)
+```
+`set_page_and_extract_partion` returns records and also @page instance variable which is available to the views
+
+#### Modify the view
+In the page where you want to display the records, paste the following entries, assumming that you have a model called recording:
+```
+<p>
+  <%= link_to("Previous Page", recordings_path(page: @page.previous_page)) unless @page.first_page? %>
+  <%= link_to("Next Page", recordings_path(page: @page.next_page)) unless @page.last_page? %>
+</p>  
+```
+
+#### Change settings
+Upon installation, a tiny_paginate.rb file is created with a single configuration option: `max_records_per_page`, which defaults to 30. You can easily modify this value to suit the needs of your application.
+
+### Update
+After installation, you can use the most recent version of `tiny_paginate` by running the following commands:
+```bash
+$ bundle update --conservative tiny_paginate
+```
+and then execute:
+```bash
+$ rails g tiny_paginate:install
+```
+Continue to update the controller and view if you've not done so already.
+
+
+## Contributing
+* Close the Repo
+* Create a branch with the changes you desire
+* Create a PR against the main branch 
+
+PR will be approved and merged upon review by the repo gem owner.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/generators/tiny_paginate/install_generator.rb

@@ -0,0 +1,15 @@
+require "rails/generators"
+
+module TinyPaginate
+  class InstallGenerator < Rails::Generators::Base
+    def install
+      initializer("tiny_paginate.rb") do
+        <<-RUBY
+       # frozen_string_literal: true
+
+       # TinyPaginate.max_records_per_page = 30 # uncomment to change(default = 30)
+        RUBY
+      end
+    end
+  end
+end

data/lib/generators/tiny_paginate/templates/navigation_partial.erb.html

@@ -0,0 +1,5 @@
+<p id="navigation_buttons">
+<button id="first_page"></button>
+
+
+</p>

data/lib/tasks/tiny_paginate_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tiny_paginate do
+#   # Task goes here
+# end

data/lib/tiny_paginate/controller_helper_methods.rb

@@ -0,0 +1,13 @@
+module TinyPaginate
+  module ControllerHelperMethods
+    private
+    def set_page_and_extract_portion_from(collection:)
+      @page = TinyPaginate::Page.new(page_number: page_number_param, collection: collection)
+      @page.records
+    end
+
+    def page_number_param
+      params[:page].to_i  > 0 ? params[:page].to_i  :  1
+    end
+  end
+end

data/lib/tiny_paginate/page.rb

@@ -0,0 +1,36 @@
+module TinyPaginate
+  class Page
+    attr_accessor :page_number, :collection
+
+    def initialize(page_number:, collection:)
+      @page_number = page_number
+      @collection = collection
+    end
+
+    def records
+      collection.offset(offset).limit(TinyPaginate.max_records_per_page)
+    end
+
+    def next_page
+      page_number + 1
+    end
+
+    def previous_page
+      page_number - 1
+    end
+
+    def first_page?
+      page_number == 1
+    end
+
+    def last_page?
+      page_number >= (collection.length.to_f / TinyPaginate.max_records_per_page).ceil
+    end
+
+    private
+
+    def offset
+      TinyPaginate.max_records_per_page * (page_number - 1)
+    end
+  end
+end

data/lib/tiny_paginate/railtie.rb

@@ -0,0 +1,20 @@
+module TinyPaginate
+  class Railtie < ::Rails::Railtie
+    initializer "tiny_paginate.controller_helper_methods" do
+      ActiveSupport.on_load(:action_controller_base) do
+        include TinyPaginate::ControllerHelperMethods
+      end
+    end
+
+    # if defined?(FactoryBotRails)
+    #   config.factory_bot.definition_file_paths +=
+    #     [ File.expand_path("spec/factories", __dir__) ]
+    # end
+
+    # config.generators do |g|
+    #   g.test_framework :rspec
+    #   g.fixture_replacement :factory_bot
+    #   g.factory_bot dir: "spec/factories"
+    # end
+  end
+end

data/lib/tiny_paginate/version.rb

@@ -0,0 +1,3 @@
+module TinyPaginate
+  VERSION = "0.1.0"
+end

data/lib/tiny_paginate.rb

@@ -0,0 +1,8 @@
+require "tiny_paginate/version"
+require "tiny_paginate/railtie"
+require "tiny_paginate/page"
+require "tiny_paginate/controller_helper_methods"
+
+module TinyPaginate
+  mattr_accessor :max_records_per_page, default: 30
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: tiny_paginate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Enow Mbi
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.5.1
+description: Simple pagination plugin
+email:
+- benowmbi@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/tiny_paginate/install_generator.rb
+- lib/generators/tiny_paginate/templates/navigation_partial.erb.html
+- lib/tasks/tiny_paginate_tasks.rake
+- lib/tiny_paginate.rb
+- lib/tiny_paginate/controller_helper_methods.rb
+- lib/tiny_paginate/page.rb
+- lib/tiny_paginate/railtie.rb
+- lib/tiny_paginate/version.rb
+homepage: https://github.com/enowmbi/tiny_paginate
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/enowmbi/tiny_paginate
+  source_code_uri: https://github.com/enowmbi/tiny_paginate
+  changelog_uri: https://github.com/enowmbi/tiny_paginate/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: Simple pagination plugin
+test_files: []