esse-pagy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ceea73edcb4eacd00a9864b43900232835379755d219c46c4754eda8c776f51
+  data.tar.gz: 4d521b34747076bb87b9ca2eb997f09d1138f230c9eb6b1ebb006699c533d72e
+SHA512:
+  metadata.gz: 8039872c6747a680ae3c133cb084add0d0035cc8aabeacc69d5a5508c2f3423c3a8b2c0c4e6b51c9a0a6565a78ade5a2c968c52508f4f6b1f1fe8b1e78d4670e
+  data.tar.gz: 25c887ea1f45cb9675faa2d96c22b243ff1c7648ae897a5a5a9b52e3832ddac5927b9fed06c5bd01cc845987b665ae9521ffbdbb6f6d014e2ac110d3582ee5ff

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,12 @@
+# 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 - 2023-11-14
+The first release of the esse-pagy plugin. This release includes the following features:
+* Add `pagy_search` method to the `Esse::Index` class.
+* Add `pagy_search` method to the `Esse::Cluster` class.
+* Add `pagy_esse` method to the `Pagy` class.
+* Add `pagy_esse` method to the `Pagy::Backend` class.

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "pagy", "~> 5.10", ">= 5.10.1"
+gem "esse", "~> 0.2.4"
+gem "esse-rspec", "~> 0.0.1"
+
+group :test do
+  gem "activesupport"
+  gem "rack"
+  gem "rake-manifest"
+end
+
+# Specify your gem's dependencies in esse-active_record.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,135 @@
+PATH
+  remote: .
+  specs:
+    esse-pagy (0.0.1)
+      esse (>= 0.2.4)
+      pagy (>= 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.0)
+    drb (2.2.0)
+      ruby2_keywords
+    esse (0.2.4)
+      multi_json
+      thor (>= 0.19)
+    esse-rspec (0.0.1)
+      esse (>= 0.2.4)
+      rspec (~> 3.12)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    method_source (1.0.0)
+    minitest (5.20.0)
+    multi_json (1.15.0)
+    mutex_m (0.2.0)
+    pagy (5.10.1)
+      activesupport
+    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)
+    rack (3.0.8)
+    rainbow (3.1.1)
+    rake-manifest (0.2.3)
+    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)
+    ruby2_keywords (0.0.5)
+    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)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activesupport
+  esse (~> 0.2.4)
+  esse-pagy!
+  esse-rspec (~> 0.0.1)
+  pagy (~> 5.10, >= 5.10.1)
+  pry
+  rack
+  rake-manifest
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  standard
+
+BUNDLED WITH
+   2.3.26

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 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,45 @@
+# Esse Pagy Extension
+
+This gem is a [esse](https://github.com/marcosgz/esse) plugin for the [pagy](https://github.com/ddnexus/pagy) pagination.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'esse-pagy'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+```ruby
+# Single index
+query = UsersIndex.pagy_search(body: { ... })
+
+# Multiple indexes
+query = Esse.cluster.pagy_search(CitiesIndex, CountiesIndex, body: { ... })
+query = Esse.cluster.pagy_search('esse_geos_*', body: { ... })
+
+# paginate it
+@pagy, @response = pagy_esse(collection, items: 10)
+```
+
+## 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-pagy.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/esse/pagy.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "esse"
+require "pagy"
+
+::Pagy::DEFAULT[:esse_search] ||= :search
+::Pagy::DEFAULT[:esse_pagy_search] ||= :pagy_search
+
+# I'll try to move this to the `pagy` gem. But we need to wait for the `pagy` author to accept the PR.
+# @see https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/elasticsearch_rails.rb
+
+module Esse
+  module Pagy
+    module IndexSearch
+      def pagy_esse(*args, &block)
+        kwargs = extract_search_options!(args)
+        [cluster, self, kwargs, block].tap do |args|
+          args.define_singleton_method(:method_missing) { |*a| args += a }
+        end
+      end
+      alias_method ::Pagy::DEFAULT[:esse_pagy_search], :pagy_esse
+    end
+
+    module ClusterSearch
+      def pagy_esse(*indices, **kwargs, &block)
+        [self, indices, kwargs, block].tap do |args|
+          args.define_singleton_method(:method_missing) { |*a| args += a }
+        end
+      end
+      alias_method ::Pagy::DEFAULT[:esse_pagy_search], :pagy_esse
+    end
+
+    module ClassMethods
+      def new_from_esse(query, vars = {})
+        vars[:count] = query.response.total
+        vars[:page] = (query.offset_value / query.limit_value.to_f).ceil + 1
+        vars[:items] = query.limit_value
+        ::Pagy.new(vars)
+      end
+    end
+
+    # Add specialized backend methods to paginate Esse::Search::Query
+    module Backend
+      private
+
+      # Return Pagy object and query
+      def pagy_esse(pagy_search_args, vars = {})
+        cluster, indices, kwargs, block, *called = pagy_search_args
+        vars = pagy_esse_get_vars(nil, vars)
+        query = cluster.send(::Pagy::DEFAULT[:esse_search], *indices, **kwargs, &block)
+          .limit(vars[:items])
+          .offset(vars[:items] * (vars[:page] - 1))
+        vars[:count] = query.response.total
+
+        pagy = ::Pagy.new(vars)
+        # with :last_page overflow we need to re-run the method in order to get the hits
+        return pagy_esse(pagy_search_args, vars.merge(page: pagy.page)) \
+               if defined?(::Pagy::OverflowExtra) && pagy.overflow? && pagy.vars[:overflow] == :last_page
+
+        [pagy, called.empty? ? query : query.send(*called)]
+      end
+
+      # Sub-method called only by #pagy_esse: here for easy customization of variables by overriding
+      # the _query argument is not available when the method is called
+      def pagy_esse_get_vars(_query, vars)
+        pagy_set_items_from_params(vars) if defined?(ItemsExtra)
+        vars[:items] ||= ::Pagy::DEFAULT[:items]
+        vars[:page] ||= (params[vars[:page_param] || ::Pagy::DEFAULT[:page_param]] || 1).to_i
+        vars
+      end
+    end
+  end
+end
+
+::Pagy::Backend.prepend(Esse::Pagy::Backend)
+::Pagy.extend(Esse::Pagy::ClassMethods)
+::Esse::Index.extend(Esse::Pagy::IndexSearch)
+::Esse::Cluster.prepend(Esse::Pagy::ClusterSearch)

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: esse-pagy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marcos G. Zimmermann
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-15 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: Pagy extensions for Esse
+email:
+- mgzmaster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/esse/pagy.rb
+homepage: https://github.com/marcosgz/esse-pagy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/marcosgz/esse-pagy
+  source_code_uri: https://github.com/marcosgz/esse-pagy
+  changelog_uri: https://github.com/marcosgz/esse-pagy/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.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Pagy extensions for Esse
+test_files: []