solidus_pagy

Solidus Pagy

Add Pagy pagination ability to use on the Solidus Admin content.

Installation

Add solidus_pagy to your Gemfile:

gem 'solidus_pagy', github: 'jtapia/solidus_pagy'

Bundle your dependencies and run the installation generator:

bin/rails generate solidus_pagy:install

Solidus configuration

After the installation, inside the file app/cofig/initializers/solidus_pagy you will be able to setup the Pagy pagination options:

#  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# | Option     | Helper               | Path                     |
#  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# | default    | pagy_nav             |                          |
# | bootstrap  | pagy_bootstrap_nav   | pagy/extras/bootstrap    |
# | bulma      | pagy_bulma_nav       | pagy/extras/bulma        |
# | foundation | pagy_foundation_nav  | pagy/extras/foundation   |
# | materialize| pagy_materialize_nav | pagy/extras/materialize  |
# | semantic   | pagy_semantic_nav    | pagy/extras/semantic     |
# | uikit      | pagy_uikit_nav       | pagy/extras/uikit        |
#  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

SolidusPagy.configure do |config|
  config.nav_helper = 'pagy_nav' # default
  config.page = 1 # default
  config.items = 20 # default
  config.outset = 0 # default
  config.orders_per_page = 15 # default
  config.promotions_per_page = 15 # default
  config.properties_per_page = 15 # default
  config.admin_products_per_page = 10 # default
  config.admin_variants_per_page = 20 # defaults
end

If you want to use bootstrap you need to require the path:

require 'pagy/extras/bootstrap'

SolidusPagy.configure do |config|
  config.nav_helper = 'pagy_bootstrap_nav'
  ...
end

Usage

Include in your application_controller.rb:

include Pagy::Backend

and in your application_helper.rb:

include Pagy::Frontend

Development

Testing the extension

First bundle your dependencies, then run bin/rake. bin/rake will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using bin/rake extension:test_app.

bin/rake

To run Rubocop static code analysis run

bundle exec rubocop

When testing your application's integration with this extension you may use its factories. Simply add this require statement to your spec/spec_helper.rb:

require 'solidus_pagy/testing_support/factories'

Or, if you are using FactoryBot.definition_file_paths, you can load Solidus core factories along with this extension's factories using this statement:

SolidusDevSupport::TestingSupport::Factories.load_for(SolidusPagy::Engine)

Running the sandbox

To run this extension in a sandboxed Solidus application, you can run bin/sandbox. The path for the sandbox app is ./sandbox and bin/rails will forward any Rails commands to sandbox/bin/rails.

Here's an example:

$ bin/rails server
=> Booting Puma
=> Rails 6.0.2.1 application starting in development
* Listening on tcp://127.0.0.1:3000
Use Ctrl-C to stop

Updating the changelog

Before and after releases the changelog should be updated to reflect the up-to-date status of the project:

bin/rake changelog
git add CHANGELOG.md
git commit -m "Update the changelog"

Releasing new versions

Please refer to the dedicated page on Solidus wiki.

License

Copyright (c) 2022 [name of extension author], released under the New BSD License.