esse-will_paginate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 159d99fc2a6d995b75e48f2fce0e18736e3d0786012c910116abebc1fdc73c44
+  data.tar.gz: aa085968ac6c40b1a2743976d4dac911813fa4abca80c281a32f961ba9d1813a
+SHA512:
+  metadata.gz: 4b1ca146cc9cd444576c6587cc3fb5b2bdff02a2d0f7f900d222fc4264448c380cb287d76056be8c2e7e1e6f99938843369667d0102ab7652080fecdcfa3fff0
+  data.tar.gz: 201127cb56b66ba0ac60ca443408b54d6844d25e74ea4772104d7d7416aa034baa56fedba62862ce97687f08340de1acf8268cc90c3d2026dacdb67b6cfd2aee

data/.rubocop.yml

@@ -0,0 +1,26 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - standard/cop/block_single_line_braces
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+  Exclude:
+    - "db/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+  NewCops: enable
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.0.1 - 2022-07-05
+The first release of the esse-will_paginate plugin

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "esse", git: "https://github.com/marcosgz/esse.git", branch: "main"
+gem "will_paginate", "~> 3.1"
+gem "esse-rspec"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,113 @@
+GIT
+  remote: https://github.com/marcosgz/esse.git
+  revision: 34a9fff95b2c46ad1b5fca85f0906fbdea1704ee
+  branch: main
+  specs:
+    esse (0.2.4)
+      multi_json
+      thor (>= 0.19)
+
+PATH
+  remote: .
+  specs:
+    esse-will_paginate (0.0.1)
+      esse (>= 0.2.4)
+      pagy (>= 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    esse-rspec (0.0.6)
+      esse (>= 0.2.4)
+      rspec (>= 3)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    method_source (1.0.0)
+    multi_json (1.15.0)
+    pagy (6.2.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.25.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    standard (1.32.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.57.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.2)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.2.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.19.1)
+    thor (1.3.0)
+    unicode-display_width (2.5.0)
+    will_paginate (3.3.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  esse!
+  esse-rspec
+  esse-will_paginate!
+  pry
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  standard
+  will_paginate (~> 3.1)
+
+BUNDLED WITH
+   2.4.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Marcos G. Zimmermann
+
+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,48 @@
+# Esse WillPaginate Plugin
+
+This gem is a [esse](https://github.com/marcosgz/esse) plugin for the [will_paginate](https://github.com/mislav/will_paginate) pagination.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'esse-will_paginate'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+```ruby
+# Single index
+@search = UsersIndex.search(params[:q]).paginate(page: params[:page], per_page: 10)
+@search = UsersIndex.search(params[:q], body: { query: {}, from: 0, size: 10}) # or if you prefer pass elasticsearch/opensearch pagination in the query body
+
+# Multiple indexes
+@search = Esse.cluster.search(CitiesIndex, CountiesIndex, body: { ... }).paginate(page: params[:page], per_page: 10)
+@search = Esse.cluster.search(CitiesIndex, CountiesIndex, body: { query: {}, from: 0, size: 10}) # or if you prefer pass elasticsearch/opensearch pagination in the query body
+```
+
+```erb
+
+<%= will_paginate @search.results %>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake none` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcosgz/esse-will_paginate.
+
+## 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,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/esse/will_paginate/pagination.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Esse
+  module WillPaginate
+    module Pagination
+      module SearchQuery
+        def self.included(base)
+          base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            # Define the `paginate` WillPaginate method
+            #
+            # @param [Hash] options
+            # @option options [Integer] :page
+            # @option options [Integer] :per_page
+            # @return [Esse::WillPaginate::SearchQuery]
+            def paginate(options = {})
+              curr_page = ::WillPaginate::PageNumber(options[:page] || 1)
+              limit_val = (options[:per_page] || ::WillPaginate.per_page).to_i
+              offset_val = (curr_page - 1) * limit_val
+              limit(limit_val).offset(offset_val)
+            end
+          RUBY
+        end
+
+        def paginated_results
+          page = (offset_value / limit_value.to_f).ceil + 1
+          ::WillPaginate::Collection.create(page, limit_value, response.total) do |pager|
+            pager.replace response.hits
+          end
+        end
+      end
+    end
+  end
+end

data/lib/esse/will_paginate/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Esse
+  module WillPaginate
+    VERSION = "0.0.1"
+  end
+end

data/lib/esse/will_paginate.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "esse"
+require "will_paginate"
+require "will_paginate/collection"
+
+require_relative "will_paginate/version"
+require_relative "will_paginate/pagination"
+
+Esse::Search::Query.__send__ :include, Esse::WillPaginate::Pagination::SearchQuery

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: esse-will_paginate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marcos G. Zimmermann
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: esse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: WillPaginate extensions for Esse
+email:
+- mgzmaster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/esse/will_paginate.rb
+- lib/esse/will_paginate/pagination.rb
+- lib/esse/will_paginate/version.rb
+homepage: https://github.com/marcosgz/esse-will_paginate
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/marcosgz/esse-will_paginate
+  source_code_uri: https://github.com/marcosgz/esse-will_paginate
+  changelog_uri: https://github.com/marcosgz/esse-will_paginate/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: WillPaginate extensions for Esse
+test_files: []