solidus_pagy 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45c5fe64e0ad5ad3bfdeedefa752875c8dc3100d902d39870e43f9978621431f
+  data.tar.gz: d7edee57426ed7926cfa540b627611b0c180738056217f4bbe147b7e5356549b
+SHA512:
+  metadata.gz: 726d3da4a6c1d901f5e5b81d0a11798276c228539126bb10bbd88e04b7e12548220fa828603f6eeb58effcec236c514882a8cf6a6f91615bd4677c3017b0d0f4
+  data.tar.gz: c0a16a7e7367cdeec8fbd31cbe0aec9919d45d622d437fed6f5ee8112af904c23127f1bc337a35cee8ab0eb84fa496074d9fa24b977e4cadad79004040b52a79

data/.circleci/config.yml

@@ -0,0 +1,39 @@
+version: 2.1
+
+orbs:
+  browser-tools: circleci/browser-tools@1.1
+
+  # Always take the latest version of the orb, this allows us to
+  # run specs against Solidus supported versions only without the need
+  # to change this configuration every time a Solidus version is released
+  # or goes EOL.
+  solidusio_extensions: solidusio/extensions@volatile
+
+jobs:
+  run-specs-with-postgres:
+    executor: solidusio_extensions/postgres
+    steps:
+      - browser-tools/install-browser-tools
+      - solidusio_extensions/run-tests
+  run-specs-with-mysql:
+    executor: solidusio_extensions/mysql
+    steps:
+      - browser-tools/install-browser-tools
+      - solidusio_extensions/run-tests
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql
+  "Weekly run specs against master":
+    triggers:
+      - schedule:
+          cron: "0 0 * * 4" # every Thursday
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql

data/.gem_release.yml

@@ -0,0 +1,5 @@
+bump:
+  recurse: false
+  file: 'lib/solidus_pagy/version.rb'
+  message: Bump SolidusPagy to %{version}
+  tag: true

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: false
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It might be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.github_changelog_generator

@@ -0,0 +1,2 @@
+issues=false
+exclude-labels=infrastructure

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+spec/examples.txt
+/sandbox
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,37 @@
+require:
+  - solidus_dev_support/rubocop
+
+inherit_gem:
+  solidus_dev_support: .rubocop.yml
+
+AllCops:
+  NewCops: disable
+  Exclude:
+    - bin/*
+    - spec/dummy/**/*
+    - vendor/**/*
+
+Rails/SkipsModelValidations:
+  Exclude:
+    - db/migrate/**/*
+
+Gemspec/OrderedDependencies:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/LeadingSubject:
+  Enabled: false
+
+RSpec/MessageChain:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

data/Gemfile

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+
+solidus_git, solidus_frontend_git = if (branch == 'master') || (branch >= 'v3.2')
+                                      %w[solidusio/solidus solidusio/solidus_frontend]
+                                    else
+                                      %w[solidusio/solidus] * 2
+                                    end
+
+gem 'solidus', github: solidus_git, branch: branch
+gem 'solidus_api', github: solidus_git, branch: branch
+gem 'solidus_backend', github: solidus_git, branch: branch
+gem 'solidus_core', github: solidus_git, branch: branch
+gem 'solidus_frontend', github: solidus_frontend_git, branch: branch
+gem 'solidus_sample', github: solidus_git, branch: branch
+
+# Needed to help Bundler figure out how to resolve dependencies,
+# otherwise it takes forever to resolve them.
+# See https://github.com/bundler/bundler/issues/6677
+gem 'rails', ENV.fetch('RAILS_VERSION', nil)
+
+# Provides basic authentication functionality for testing parts of your engine
+gem 'solidus_auth_devise'
+
+case ENV.fetch('DB', nil)
+when 'mysql'
+  gem 'mysql2'
+when 'postgresql'
+  gem 'pg'
+else
+  gem 'sqlite3'
+end
+
+group :test do
+  gem 'rails-controller-testing'
+  gem 'rspec-activemodel-mocks'
+end
+
+group :development, :test do
+  gem 'factory_bot', '> 4.10.0'
+  gem 'pry-rails'
+end
+
+gemspec
+
+# Use a local Gemfile to include development dependencies that might not be
+# relevant for the project or for other contributors, e.g.: `gem 'pry-debug'`.
+eval_gemfile 'Gemfile-local' if File.exist? 'Gemfile-local'

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2022 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Solidus nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,142 @@
+# Solidus Pagy
+
+[![CircleCI](https://circleci.com/gh/jtapia/solidus_pagy.svg?style=shield)](https://circleci.com/gh/jtapia/solidus_pagy)
+[![codecov](https://codecov.io/gh/jtapia/solidus_pagy/branch/master/graph/badge.svg)](https://codecov.io/gh/jtapia/solidus_pagy)
+
+Add [Pagy](https://github.com/ddnexus/pagy) pagination ability to use on the Solidus Admin content.
+
+## Installation
+
+Add `solidus_pagy` to your Gemfile:
+
+```ruby
+gem 'solidus_pagy', github: 'jtapia/solidus_pagy'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+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:
+
+```ruby
+#  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+# | 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:
+
+```ruby
+require 'pagy/extras/bootstrap'
+
+SolidusPagy.configure do |config|
+  config.nav_helper = 'pagy_bootstrap_nav'
+  ...
+end
+```
+
+## Usage
+
+Include in your `application_controller.rb`:
+
+```ruby
+include Pagy::Backend
+```
+
+and in your `application_helper.rb`:
+
+```ruby
+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`.
+
+```shell
+bin/rake
+```
+
+To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
+
+```shell
+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`:
+
+```ruby
+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:
+
+```ruby
+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:
+
+```shell
+bin/rake changelog
+git add CHANGELOG.md
+git commit -m "Update the changelog"
+```
+
+### Releasing new versions
+
+Please refer to the dedicated [page](https://github.com/solidusio/solidus/wiki/How-to-release-extensions) on Solidus wiki.
+
+## License
+
+Copyright (c) 2022 [name of extension author], released under the New BSD License.

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
+
+task default: 'extension:specs'

data/app/assets/javascripts/spree/backend/solidus_pagy.js

@@ -0,0 +1 @@
+require 'pagy'

data/app/assets/javascripts/spree/frontend/solidus_pagy.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/solidus_pagy.css

@@ -0,0 +1,7 @@
+ul.pagination {
+  justify-content: center !important;
+}
+
+nav.pagination {
+  justify-content: center !important;
+}

data/app/assets/stylesheets/spree/frontend/solidus_pagy.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

data/app/decorators/controllers/solidus_pagy/admin/base_controller_decorator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SolidusPagy
+  module Admin
+    module BaseControllerDecorator
+      def self.prepended(base)
+        base.include ::Pagy::Backend
+      end
+
+      ::Spree::Admin::BaseController.prepend(self)
+    end
+  end
+end

data/app/decorators/controllers/solidus_pagy/admin/orders_controller_decorator.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module SolidusPagy
+  module Admin
+    module OrdersControllerDecorator
+      def self.prepended(base)
+        base.class_eval do
+          def index
+            params[:q] ||= {}
+            params[:q][:completed_at_not_null] ||= '1' if ::Spree::Config[:show_only_complete_orders_by_default]
+            @show_only_completed = params[:q][:completed_at_not_null] == '1'
+            params[:q][:s] ||= @show_only_completed ? 'completed_at desc' : 'created_at desc'
+            params[:q][:completed_at_not_null] = '' unless @show_only_completed
+
+            # As date params are deleted if @show_only_completed, store
+            # the original date so we can restore them into the params
+            # after the search
+            created_at_gt = params[:q][:created_at_gt]
+            created_at_lt = params[:q][:created_at_lt]
+
+            params[:q].delete(:inventory_units_shipment_id_null) if params[:q][:inventory_units_shipment_id_null] == "0"
+
+            if params[:q][:created_at_gt].present?
+              params[:q][:created_at_gt] = begin
+                Time.zone.parse(params[:q][:created_at_gt]).beginning_of_day
+              rescue StandardError
+                ''
+              end
+            end
+
+            if params[:q][:created_at_lt].present?
+              params[:q][:created_at_lt] = begin
+                Time.zone.parse(params[:q][:created_at_lt]).end_of_day
+              rescue StandardError
+                ''
+              end
+            end
+
+            if @show_only_completed
+              params[:q][:completed_at_gt] = params[:q].delete(:created_at_gt)
+              params[:q][:completed_at_lt] = params[:q].delete(:created_at_lt)
+            end
+
+            @search = ::Spree::Order.accessible_by(current_ability, :index).ransack(params[:q])
+            @result = pagy(
+              @search.result.includes([:user]),
+              page: params[:page],
+              items: params[:per_page] || ::SolidusPagy.config.orders_per_page
+            )
+            @pagy = @result.first
+            @orders = @result.second
+
+            # Restore dates
+            params[:q][:created_at_gt] = created_at_gt
+            params[:q][:created_at_lt] = created_at_lt
+          end
+        end
+      end
+
+      ::Spree::Admin::OrdersController.prepend(self)
+    end
+  end
+end

data/app/decorators/controllers/solidus_pagy/admin/prices_controller_decorator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module SolidusPagy
+  module Admin
+    module PricesControllerDecorator
+      def self.prepended(base)
+        base.class_eval do
+          def index
+            params[:q] ||= {}
+
+            @search = @product.prices
+                              .accessible_by(current_ability, :index)
+                              .ransack(params[:q])
+            master_prices_search_result(@search)
+            variant_prices_search_result(@search)
+          end
+
+          private
+
+          def master_prices_search_result(search)
+            @result = pagy(
+              search.result
+                    .currently_valid
+                    .for_master
+                    .order(:variant_id, :country_iso, :currency),
+              page: params[:page],
+              items: Spree::Config.admin_variants_per_page
+            )
+            @pagy_master_prices = @result.first
+            @master_prices = @result.second
+          end
+
+          def variant_prices_search_result(search)
+            @result = pagy(
+              search.result
+                    .currently_valid
+                    .for_variant
+                    .order(:variant_id, :country_iso, :currency),
+              page: params[:variants_page],
+              items: Spree::Config.admin_variants_per_page
+            )
+            @pagy_variant_prices = @result.first
+            @variant_prices = @result.second
+          end
+        end
+      end
+
+      ::Spree::Admin::PricesController.prepend(self)
+    end
+  end
+end

data/app/decorators/controllers/solidus_pagy/admin/products_controller_decorator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SolidusPagy
+  module Admin
+    module ProductsControllerDecorator
+      def self.prepended(base)
+        base.class_eval do
+          private
+
+          def collection
+            return @collection if @collection
+
+            params[:q] ||= {}
+            params[:q][:s] ||= 'name asc'
+            # @search needs to be defined as this is passed to search_form_for
+            @search = super.ransack(params[:q])
+            @result = pagy(
+              @search.result.order(id: :asc)
+                            .includes(product_includes),
+              page: params[:page],
+              items: ::SolidusPagy.config.admin_products_per_page
+            )
+            @pagy = @result.first
+            @collection = @result.second
+          end
+        end
+      end
+
+      ::Spree::Admin::ProductsController.prepend(self)
+    end
+  end
+end

data/app/decorators/controllers/solidus_pagy/admin/promotion_codes_controller_decorator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SolidusPagy
+  module Admin
+    module PromotionCodesControllerDecorator
+      def self.prepended(base)
+        base.class_eval do
+          def index
+            @promotion = ::Spree::Promotion.accessible_by(current_ability, :show)
+                                           .find(params[:promotion_id])
+            @promotion_codes = @promotion.promotion_codes.order(:value)
+
+            respond_to do |format|
+              format.html do
+                @result = pagy(
+                  @promotion_codes,
+                  page: params[:page],
+                  items: 50
+                )
+                @pagy = @result.first
+                @promotion_codes = @result.second
+              end
+
+              format.csv do
+                filename = "promotion-code-list-#{@promotion.id}.csv"
+                headers["Content-Type"] = "text/csv"
+                headers["Content-disposition"] = "attachment; filename=\"#{filename}\""
+              end
+            end
+          end
+        end
+      end
+
+      ::Spree::Admin::PromotionCodesController.prepend(self)
+    end
+  end
+end

data/app/decorators/controllers/solidus_pagy/admin/promotions_controller_decorator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SolidusPagy
+  module Admin
+    module PromotionsControllerDecorator
+      def self.prepended(base)
+        base.class_eval do
+          private
+
+          def collection
+            return @collection if @collection
+
+            params[:q] ||= HashWithIndifferentAccess.new
+            params[:q][:s] ||= 'id desc'
+
+            @collection = super
+            @search = @collection.ransack(params[:q])
+            @result = pagy(
+              @search.result(distinct: true).includes(promotion_includes),
+              page: params[:page],
+              items: params[:per_page] || ::SolidusPagy.config.promotions_per_page
+            )
+            @pagy = @result.first
+            @collection = @result.second
+          end
+        end
+      end
+
+      ::Spree::Admin::PromotionsController.prepend(self)
+    end
+  end
+end

data/app/decorators/controllers/solidus_pagy/admin/properties_controller_decorator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SolidusPagy
+  module Admin
+    module PropertiesControllerDecorator
+      def self.prepended(base)
+        base.class_eval do
+          private
+
+          def collection
+            return @collection if @collection
+
+            # params[:q] can be blank upon pagination
+            params[:q] = {} if params[:q].blank?
+
+            @collection = super
+            @search = @collection.ransack(params[:q])
+            @result = pagy(
+              @search.result,
+              page: params[:page],
+              items: ::SolidusPagy.config.properties_per_page
+            )
+            @pagy = @result.first
+            @collection = @result.second
+          end
+        end
+      end
+
+      ::Spree::Admin::PropertiesController.prepend(self)
+    end
+  end
+end