diff --git a/.gitignore b/.gitignore index 2f761fe..85ed304 100644 --- a/.gitignore +++ b/.gitignore @@ -41,3 +41,4 @@ coverage config/settings.local.yml config/settings/*.local.yml config/environments/*.local.yml +.idea diff --git a/Gemfile b/Gemfile index fc76bca..1374916 100644 --- a/Gemfile +++ b/Gemfile @@ -29,6 +29,9 @@ gem 'activeadmin' gem 'activeadmin_addons' gem 'devise' +gem 'alba' +gem 'pagy' + group :development, :test do gem 'bundler-audit' gem 'capybara' diff --git a/Gemfile.lock b/Gemfile.lock index d66b198..996a68a 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -95,6 +95,8 @@ GEM uri (>= 0.13.1) addressable (2.8.7) public_suffix (>= 2.0.2, < 7.0) + alba (3.5.0) + ostruct (~> 0.6) arbre (1.7.0) activesupport (>= 3.0.0) ruby2_keywords (>= 0.0.2) @@ -251,6 +253,7 @@ GEM racc (~> 1.4) orm_adapter (0.5.0) ostruct (0.6.0) + pagy (9.3.3) parallel (1.26.3) parser (3.3.4.2) ast (~> 2.4.1) @@ -448,6 +451,7 @@ DEPENDENCIES activeadmin activeadmin_addons activerecord-import + alba bundler-audit capybara config @@ -460,6 +464,7 @@ DEPENDENCIES factory_bot_rails fasterer ffaker + pagy parallel pg pry-byebug diff --git a/app/controllers/books_controller.rb b/app/controllers/books_controller.rb new file mode 100644 index 0000000..1e59761 --- /dev/null +++ b/app/controllers/books_controller.rb @@ -0,0 +1,12 @@ +class BooksController < ApplicationController + include Pagination + def index + query = Book.includes(:authors, :genres, :keywords, :folder, :language) + + render json: paginate_json( + scope: query, + key: :books, + serializer: BookSerializer + ) + end +end diff --git a/app/controllers/concerns/pagination.rb b/app/controllers/concerns/pagination.rb new file mode 100644 index 0000000..302aba1 --- /dev/null +++ b/app/controllers/concerns/pagination.rb @@ -0,0 +1,18 @@ +module Pagination + extend ActiveSupport::Concern + include Pagy::Backend + + def paginate_json(scope:, key:, serializer:) + pagy, records = pagy(scope) + + { + key => serializer.new(records), + pagination: { + page: pagy.page, + per_page: pagy.limit, + page_count: pagy.pages, + total: pagy.count + } + } + end +end diff --git a/app/serializers/author_serializer.rb b/app/serializers/author_serializer.rb new file mode 100644 index 0000000..b68aaa3 --- /dev/null +++ b/app/serializers/author_serializer.rb @@ -0,0 +1,5 @@ +class AuthorSerializer + include Alba::Resource + + attributes :id, :first_name, :last_name, :middle_name, :original +end diff --git a/app/serializers/book_serializer.rb b/app/serializers/book_serializer.rb new file mode 100644 index 0000000..23b15cd --- /dev/null +++ b/app/serializers/book_serializer.rb @@ -0,0 +1,15 @@ +class BookSerializer + include Alba::Resource + + attributes :id, :title, :series, :serno, :libid, :size, :filename, + :del, :ext, :published_at, :insno + + one :folder, resource: FolderSerializer + many :authors, resource: AuthorSerializer + many :genres, resource: GenreSerializer + many :keywords, resource: KeywordSerializer + + attribute :language do |book| + book.language.slug + end +end diff --git a/app/serializers/folder_serializer.rb b/app/serializers/folder_serializer.rb new file mode 100644 index 0000000..9295e0f --- /dev/null +++ b/app/serializers/folder_serializer.rb @@ -0,0 +1,5 @@ +class FolderSerializer + include Alba::Resource + + attributes :id, :name +end diff --git a/app/serializers/genre_serializer.rb b/app/serializers/genre_serializer.rb new file mode 100644 index 0000000..f61b639 --- /dev/null +++ b/app/serializers/genre_serializer.rb @@ -0,0 +1,5 @@ +class GenreSerializer + include Alba::Resource + + attributes :id, :slug, :name +end diff --git a/app/serializers/keyword_serializer.rb b/app/serializers/keyword_serializer.rb new file mode 100644 index 0000000..eeb9acd --- /dev/null +++ b/app/serializers/keyword_serializer.rb @@ -0,0 +1,5 @@ +class KeywordSerializer + include Alba::Resource + + attributes :id, :name +end diff --git a/config/database.yml b/config/database.yml index 48f30ee..4277af8 100644 --- a/config/database.yml +++ b/config/database.yml @@ -17,6 +17,7 @@ development: test: <<: *default + <<: *postgre database: library_test production: diff --git a/config/initializers/pagy.rb b/config/initializers/pagy.rb new file mode 100644 index 0000000..c2d5074 --- /dev/null +++ b/config/initializers/pagy.rb @@ -0,0 +1,220 @@ +# frozen_string_literal: true + +# Pagy initializer file (9.3.3) +# Customize only what you really need and notice that the core Pagy works also without any of the following lines. +# Should you just cherry pick part of this file, please maintain the require-order of the extras + + +# Pagy Variables +# See https://ddnexus.github.io/pagy/docs/api/pagy#variables +# You can set any pagy variable as a Pagy::DEFAULT. They can also be overridden per instance by just passing them to +# Pagy.new|Pagy::Countless.new|Pagy::Calendar::*.new or any of the #pagy* controller methods +# Here are the few that make more sense as DEFAULTs: +Pagy::DEFAULT[:limit] = Settings.app.items_per_page +# Pagy::DEFAULT[:size] = 7 # default +# Pagy::DEFAULT[:ends] = true # default +# Pagy::DEFAULT[:page_param] = :page # default +# Pagy::DEFAULT[:count_args] = [] # example for non AR ORMs +# Pagy::DEFAULT[:max_pages] = 3000 # example + + +# Extras +# See https://ddnexus.github.io/pagy/categories/extra + + +# Legacy Compatibility Extras + +# Size extra: Enable the Array type for the `:size` variable (e.g. `size: [1,4,4,1]`) +# See https://ddnexus.github.io/pagy/docs/extras/size +# require 'pagy/extras/size' # must be required before the other extras + + +# Backend Extras + +# Arel extra: For better performance utilizing grouped ActiveRecord collections: +# See: https://ddnexus.github.io/pagy/docs/extras/arel +# require 'pagy/extras/arel' + +# Array extra: Paginate arrays efficiently, avoiding expensive array-wrapping and without overriding +# See https://ddnexus.github.io/pagy/docs/extras/array +# require 'pagy/extras/array' + +# Calendar extra: Add pagination filtering by calendar time unit (year, quarter, month, week, day) +# See https://ddnexus.github.io/pagy/docs/extras/calendar +# require 'pagy/extras/calendar' +# Default for each calendar unit class in IRB: +# >> Pagy::Calendar::Year::DEFAULT +# >> Pagy::Calendar::Quarter::DEFAULT +# >> Pagy::Calendar::Month::DEFAULT +# >> Pagy::Calendar::Week::DEFAULT +# >> Pagy::Calendar::Day::DEFAULT +# +# Uncomment the following lines, if you need calendar localization without using the I18n extra +# module LocalizePagyCalendar +# def localize(time, opts) +# ::I18n.l(time, **opts) +# end +# end +# Pagy::Calendar.prepend LocalizePagyCalendar + +# Countless extra: Paginate without any count, saving one query per rendering +# See https://ddnexus.github.io/pagy/docs/extras/countless +# require 'pagy/extras/countless' +# Pagy::DEFAULT[:countless_minimal] = false # default (eager loading) + +# Elasticsearch Rails extra: Paginate `ElasticsearchRails::Results` objects +# See https://ddnexus.github.io/pagy/docs/extras/elasticsearch_rails +# Default :pagy_search method: change only if you use also +# the searchkick or meilisearch extra that defines the same +# Pagy::DEFAULT[:elasticsearch_rails_pagy_search] = :pagy_search +# Default original :search method called internally to do the actual search +# Pagy::DEFAULT[:elasticsearch_rails_search] = :search +# require 'pagy/extras/elasticsearch_rails' + +# Headers extra: http response headers (and other helpers) useful for API pagination +# See https://ddnexus.github.io/pagy/docs/extras/headers +# require 'pagy/extras/headers' +# Pagy::DEFAULT[:headers] = { page: 'Current-Page', +# limit: 'Page-Items', +# count: 'Total-Count', +# pages: 'Total-Pages' } # default + +# Keyset extra: Paginate with the Pagy keyset pagination technique +# See https://ddnexus.github.io/pagy/docs/extras/keyset +# require 'pagy/extras/keyset' + +# Meilisearch extra: Paginate `Meilisearch` result objects +# See https://ddnexus.github.io/pagy/docs/extras/meilisearch +# Default :pagy_search method: change only if you use also +# the elasticsearch_rails or searchkick extra that define the same method +# Pagy::DEFAULT[:meilisearch_pagy_search] = :pagy_search +# Default original :search method called internally to do the actual search +# Pagy::DEFAULT[:meilisearch_search] = :ms_search +# require 'pagy/extras/meilisearch' + +# Metadata extra: Provides the pagination metadata to Javascript frameworks like Vue.js, react.js, etc. +# See https://ddnexus.github.io/pagy/docs/extras/metadata +# you must require the JS Tools internal extra (BEFORE the metadata extra) ONLY if you need also the :sequels +# require 'pagy/extras/js_tools' +# require 'pagy/extras/metadata' +# For performance reasons, you should explicitly set ONLY the metadata you use in the frontend +# Pagy::DEFAULT[:metadata] = %i[scaffold_url page prev next last] # example + +# Searchkick extra: Paginate `Searchkick::Results` objects +# See https://ddnexus.github.io/pagy/docs/extras/searchkick +# Default :pagy_search method: change only if you use also +# the elasticsearch_rails or meilisearch extra that defines the same +# Pagy::DEFAULT[:searchkick_pagy_search] = :pagy_search +# Default original :search method called internally to do the actual search +# Pagy::DEFAULT[:searchkick_search] = :search +# require 'pagy/extras/searchkick' +# uncomment if you are going to use Searchkick.pagy_search +# Searchkick.extend Pagy::Searchkick + + +# Frontend Extras + +# Bootstrap extra: Add nav, nav_js and combo_nav_js helpers and templates for Bootstrap pagination +# See https://ddnexus.github.io/pagy/docs/extras/bootstrap +# require 'pagy/extras/bootstrap' + +# Bulma extra: Add nav, nav_js and combo_nav_js helpers and templates for Bulma pagination +# See https://ddnexus.github.io/pagy/docs/extras/bulma +# require 'pagy/extras/bulma' + +# Pagy extra: Add the pagy styled versions of the javascript-powered navs +# and a few other components to the Pagy::Frontend module. +# See https://ddnexus.github.io/pagy/docs/extras/pagy +# require 'pagy/extras/pagy' + +# Multi size var used by the *_nav_js helpers +# See https://ddnexus.github.io/pagy/docs/extras/pagy#steps +# Pagy::DEFAULT[:steps] = { 0 => 5, 540 => 7, 720 => 9 } # example + + +# Feature Extras + +# Gearbox extra: Automatically change the limit per page depending on the page number +# See https://ddnexus.github.io/pagy/docs/extras/gearbox +# require 'pagy/extras/gearbox' +# set to false only if you want to make :gearbox_extra an opt-in variable +# Pagy::DEFAULT[:gearbox_extra] = false # default true +# Pagy::DEFAULT[:gearbox_limit] = [15, 30, 60, 100] # default + +# Limit extra: Allow the client to request a custom limit per page with an optional selector UI +# See https://ddnexus.github.io/pagy/docs/extras/limit +# require 'pagy/extras/limit' +# set to false only if you want to make :limit_extra an opt-in variable +# Pagy::DEFAULT[:limit_extra] = false # default true +# Pagy::DEFAULT[:limit_param] = :limit # default +# Pagy::DEFAULT[:limit_max] = 100 # default + +# Overflow extra: Allow for easy handling of overflowing pages +# See https://ddnexus.github.io/pagy/docs/extras/overflow +# require 'pagy/extras/overflow' +# Pagy::DEFAULT[:overflow] = :empty_page # default (other options: :last_page and :exception) + +# Trim extra: Remove the page=1 param from links +# See https://ddnexus.github.io/pagy/docs/extras/trim +# require 'pagy/extras/trim' +# set to false only if you want to make :trim_extra an opt-in variable +# Pagy::DEFAULT[:trim_extra] = false # default true + +# Standalone extra: Use pagy in non Rack environment/gem +# See https://ddnexus.github.io/pagy/docs/extras/standalone +# require 'pagy/extras/standalone' +# Pagy::DEFAULT[:url] = 'http://www.example.com/subdir' # optional default + +# Jsonapi extra: Implements JSON:API specifications +# See https://ddnexus.github.io/pagy/docs/extras/jsonapi +# require 'pagy/extras/jsonapi' # must be required after the other extras +# set to false only if you want to make :jsonapi an opt-in variable +# Pagy::DEFAULT[:jsonapi] = false # default true + +# Rails +# Enable the .js file required by the helpers that use javascript +# (pagy*_nav_js, pagy*_combo_nav_js, and pagy_limit_selector_js) +# See https://ddnexus.github.io/pagy/docs/api/javascript + +# With the asset pipeline +# Sprockets need to look into the pagy javascripts dir, so add it to the assets paths +# Rails.application.config.assets.paths << Pagy.root.join('javascripts') + +# I18n + +# Pagy internal I18n: ~18x faster using ~10x less memory than the i18n gem +# See https://ddnexus.github.io/pagy/docs/api/i18n +# Notice: No need to configure anything in this section if your app uses only "en" +# or if you use the i18n extra below +# +# Examples: +# load the "de" built-in locale: +# Pagy::I18n.load(locale: 'de') +# +# load the "de" locale defined in the custom file at :filepath: +# Pagy::I18n.load(locale: 'de', filepath: 'path/to/pagy-de.yml') +# +# load the "de", "en" and "es" built-in locales: +# (the first passed :locale will be used also as the default_locale) +# Pagy::I18n.load({ locale: 'de' }, +# { locale: 'en' }, +# { locale: 'es' }) +# +# load the "en" built-in locale, a custom "es" locale, +# and a totally custom locale complete with a custom :pluralize proc: +# (the first passed :locale will be used also as the default_locale) +# Pagy::I18n.load({ locale: 'en' }, +# { locale: 'es', filepath: 'path/to/pagy-es.yml' }, +# { locale: 'xyz', # not built-in +# filepath: 'path/to/pagy-xyz.yml', +# pluralize: lambda{ |count| ... } ) + + +# I18n extra: uses the standard i18n gem which is ~18x slower using ~10x more memory +# than the default pagy internal i18n (see above) +# See https://ddnexus.github.io/pagy/docs/extras/i18n +# require 'pagy/extras/i18n' + + +# When you are done setting your own default freeze it, so it will not get changed accidentally +Pagy::DEFAULT.freeze diff --git a/config/routes.rb b/config/routes.rb index ae608d2..75e2b42 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -19,6 +19,7 @@ # # delete 'logout', to: 'sessions#destroy' # # end # end + get 'books(/:page)', to: 'books#index', defaults: { page: 1 }, constraints: { page: /\d+/ } # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500. # Can be used by load balancers and uptime monitors to verify that the app is live.