ff-tbl-macros 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79904c11fa31dc14eceb836af6d1dfb2295a3f9693e8d65afda08ab0619b8677
-  data.tar.gz: 94e7cf11b821957245bf0d9e35f233233f27dc8c9a9d11a5562394068a5d99f0
+  metadata.gz: 683c3f02309ce122e5841382c567d6033af6174969c8cbd5690abbc058e0ab9e
+  data.tar.gz: 74939c7eee9dd5410d4bba6a9fce3d5762b306ab1a171866d495a74bbcaabfaf
 SHA512:
-  metadata.gz: a8b0383e70ff72e254e603265e981e5f1ae3fd1cd53bad6e76d534a45d6e00cb6cbd5038f3acad08318da2ac9db5b13d5d063242928de348c9baf188bd318aa9
-  data.tar.gz: 4ab6c3b2e7969221bb833743fb90f2caace029c79c1050ba1b9cf0ba7681fce299fb5ac7da16c36ed8f8cac00768be14f6e6b93a168bf215e3d49f9506b6ada1
+  metadata.gz: f5dc808dc25712ecd9fadbdff7f0f08a897955ebab9ddbf3f499aac54160f56ae2d657253b305c51c89d05ac755af040505af16cb41f0ebcbe85292b2fb282a7
+  data.tar.gz: eaba1884dd96f8038cdd75bb8c374d52bf236fbebc00ea58bbc95266be96d71d42e77109e23db07e224d6262a4112c517cf81c07a9239340af30252172679e64

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+## [2.0.0] - 2019-04-24
+### Changed
+- Search macro rebuilded to use pagination with [pagy](https://github.com/ddnexus/pagy) gem
+
 ## [1.0.2] - 2019-04-08
 ### Fixed
 - Fix gem's dependencies versions

data/Gemfile

@@ -5,6 +5,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
+  gem 'pagy'
   gem 'recursive-open-struct'
   gem 'reform'
   gem 'require_all'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ff-tbl-macros (1.0.1)
+    ff-tbl-macros (2.0.0)
       activesupport (>= 5.2)
       require_all (~> 2.0)
       trailblazer (>= 2.0)
@@ -35,8 +35,9 @@ GEM
     jaro_winkler (1.5.2)
     json (2.2.0)
     minitest (5.11.3)
+    pagy (2.1.5)
     parallel (1.17.0)
-    parser (2.6.2.0)
+    parser (2.6.2.1)
       ast (~> 2.4.0)
     pipetree (0.1.1)
     psych (3.1.0)
@@ -61,7 +62,7 @@ GEM
       rspec-mocks (>= 2.99, < 4.0)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec-expectations (3.8.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-mocks (3.8.0)
@@ -103,6 +104,7 @@ PLATFORMS
 
 DEPENDENCIES
   ff-tbl-macros!
+  pagy
   recursive-open-struct
   reform
   require_all

data/lib/macros/search/query.rb

@@ -1,14 +1,19 @@
 # frozen_string_literal: true
 
+require 'pagy'
+
 module Macros
   class Search
     class Query < Macros::Base
+      include Pagy::Backend
+
       # @return [Macros::Search::Results] step macro instance
       #
-      # @example searchable is optional
+      # @example searchable is optional, paginate is true by default
       #   Macros::Search::Query(searchable: Admin)
-      def initialize(searchable:)
+      def initialize(searchable:, paginate: true)
         @searchable = searchable
+        @paginate = paginate
       end
 
       # @param ctx [Trailblazer::Skill] tbl context hash
@@ -22,12 +27,20 @@ module Macros
         return false unless @searchable
 
         ctx[:searchable] = @searchable
-        ransack_search_result = @searchable.ransack params[:q]
-        ctx[:query] = ransack_search_result
 
-        temp_search_results = ransack_search_result.result
-        search_results = order ? temp_search_results.order(order) : temp_search_results
-        ctx[:search_results] = search_results.page params[:page]
+        ransack_search = @searchable.ransack params[:q]
+        ctx[:query] = ransack_search
+
+        temp_search_results = ransack_search.result
+
+        if @paginate
+          page = params[:page] || 1
+          pagy, records = pagy(temp_search_results, page: page)
+          ctx[:pages] = pagy
+          temp_search_results = records
+        end
+
+        ctx[:search_results] = order ? temp_search_results.order(order) : temp_search_results
       end
     end
   end

data/lib/macros/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Macros
-  VERSION = '1.0.2'
+  VERSION = '2.0.0'
 end

data/spec/lib/search/query_spec.rb

@@ -1,23 +1,53 @@
 # frozen_string_literal: true
 
 RSpec.describe Macros::Search::Query do
-  subject(:query_step) { described_class.new(searchable: klass) }
+  subject(:query_step) { described_class.new(macro_params) }
+  let(:macro_params) { { searchable: klass, paginate: false } }
+  let(:params) { { q: query, page: page } }
+  let(:ctx) { { params: params } }
+  let(:query) { { name_cont: 'foo' } }
 
-  let(:page) { 1 }
   let(:result) { double('result', page: page) }
-  let(:ransack_result) { OpenStruct.new(q: query, result: result) }
-  let(:klass) { mock_model('User', ransack: ransack_result) }
+  let(:ransack_search) { double('Ransack::Search', result: [user1, user2]) }
+  let(:klass) { mock_model('User', ransack: ransack_search) }
 
-  let(:query) { { name_cont: 'foo' } }
-  let(:params) { { q: query, page: page } }
-  let(:ctx) { { params: params } }
+  let(:user1) { double('User') }
+  let(:user2) { double('User') }
+  let(:records) { [user1, user2] }
+
+  describe 'search without paginate' do
+    let(:paginate) { false }
+    let(:page) { nil }
+
+    it 'returns records without pagy' do
+      expect(klass).to receive(:ransack).with(query).and_return(ransack_search)
+      expect(ransack_search).to receive(:result).and_return(records)
+      expect(subject).not_to receive(:pagy)
+
+      query_step.call(ctx, params: params)
+
+      expect(ctx[:search_results]).to eql records
+      expect(ctx[:pages]).to be nil
+      expect(ctx[:query]).to eql ransack_search
+    end
+  end
+
+  describe 'search with paginate' do
+    let(:macro_params) { { searchable: klass, paginate: true } }
+    let(:paginate) { true }
+    let(:page) { 1 }
+    let(:pagy) { double('pagy') }
 
-  it 'expects to search' do
-    expect(klass).to receive(:ransack).with(query)
+    it 'returns records with pagy' do
+      expect(klass).to receive(:ransack).with(query).and_return(ransack_search)
+      expect(ransack_search).to receive(:result).and_return(records)
+      expect(subject).to receive(:pagy).with(records, page: 1).and_return([pagy, records])
 
-    query_step.call(ctx, params: params)
+      query_step.call(ctx, params: params)
 
-    expect(ctx[:query].q).to eql query
-    expect(ctx[:query].result).to eql result
+      expect(ctx[:search_results]).to eql records
+      expect(ctx[:pages]).to eql pagy
+      expect(ctx[:query]).to eql ransack_search
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ff-tbl-macros
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Artur Szwed, Claudio Perez Gamayo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2019-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport