shopify-kaminari 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 570e3cec212e5ffa136c2fdd279ab02c568f252eb41972d3f0d1c339f31999b9
-  data.tar.gz: d2c2956304dcd1e2819d7da01921ecf401f5bf42079a5ac7fe7519483b9138c6
+  metadata.gz: 2a614836a3884fb0529055ef9357624a8fb64d06780605440adfb51facdf0f2f
+  data.tar.gz: 3263018947abd0c2f8f9926c5be6304e91ff04311d2b03392ea9557d484e3740
 SHA512:
-  metadata.gz: fb6eedc2d04d4c137dce13f6cd2771913e2cf8f411bf415d835055cc4a0580e72ba8f3a77b10d99708751bca08cb3bda02866616215c2e4e61b8aa2dc7c044d8
-  data.tar.gz: 7945a630991dc163ef1ed01e9c31529bbcc0c9d5e7ae1825b544065762ca925aaa3cc32ac09ec69ebd2ce394fc5a82203466b375c0f3baeff7d57f8a016d6b6c
+  metadata.gz: 0b3e08f6d2c6bd8f092501be5fb2932085926692d85488174fc3097bcc1938f59dc520c99b6a3b721ce6a83c44bbd7c472e771e7a866e398d2eb581e65e75ddc
+  data.tar.gz: 34599fb94e3578eaf6f67c750fa70abc193c1fb2c7d3a47ba47acd598756fb74a0b072465e3a954c3aa140bb7d61804f946a52c882a49a222e95a247bba13381

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify-kaminari (1.0.0)
+    shopify-kaminari (1.1.0)
       kaminari
       shopify_api
 

data/lib/shopify-kaminari.rb

@@ -1,6 +1,7 @@
 # coding: utf-8
 # frozen_string_literal: true
 
+require 'kaminari'
 require 'shopify_api'
 
 module Shopify
@@ -10,5 +11,12 @@ module Shopify
   end
 end
 
-# Set the Shopify API's default collection parser.
-ShopifyAPI::Base.collection_parser = Shopify::Kaminari::Collection
+ShopifyAPI::Base.class_eval do
+  # Set the default collection parser.
+  self.collection_parser = Shopify::Kaminari::Collection
+
+  # Create the #page method.
+  define_singleton_method :"#{Kaminari.config.page_method_name}" do |num = 1|
+    all(params: { page: num })
+  end
+end

data/lib/shopify/kaminari/collection.rb

@@ -9,16 +9,49 @@
 # @example Paginating products.
 #   products = Shopify::Product.all(params: { page: 2, limit: 25 })
 class Shopify::Kaminari::Collection < ActiveResource::Collection
+  include ::Kaminari::ConfigurationMethods
+
   alias_method :model, :resource_class
 
   # Shopify returns this many records by default if no limit is given.
   DEFAULT_LIMIT_VALUE = 50
 
+  ENTRIES_INFO_I18N_KEY = 'helpers.page_entries_info.entry'.freeze
+
+  self.paginates_per(DEFAULT_LIMIT_VALUE)
+
   # The page that was requested from the API.
   #
   # @return [Integer] The current page.
   def current_page
-    @current_page ||= original_params.fetch(:page, 1).to_i
+    original_params.fetch(:page, 1).to_i
+  end
+
+  # @return [Integer] Current per-page number.
+  def current_per_page
+    limit_value
+  end
+
+  # Used for page_entries_info ActionView helper.
+  #
+  # @param [Hash] options Options provided by Kaminari.
+  # @return [String] Numbers of displayed vs. total entries.
+  def entry_name(options = {})
+    options = options.reverse_merge(
+      default: model_name.singular.pluralize(options[:count])
+    )
+
+    I18n.t(ENTRIES_INFO_I18N_KEY, options)
+  end
+
+  # @return [true, false] If on the first page.
+  def first_page?
+    current_page == 1
+  end
+
+  # @return [true, false] If on the last page.
+  def last_page?
+    current_page == total_pages
   end
 
   # The maximum amount of records each page will have.
@@ -46,32 +79,53 @@ class Shopify::Kaminari::Collection < ActiveResource::Collection
   #
   # @return [Integer, NilClass] The next page number, or nil if on the last.
   def next_page
-    @next_page ||= current_page + 1 if current_page < total_pages
+    current_page + 1 unless last_page? || out_of_range?
+  end
+
+  # Checks if the specified page is out of the range of the collection.
+  #
+  # @return [true, false] If out of range.
+  def out_of_range?
+    current_page > total_pages
+  end
+
+  # Fetches a new collection from the Shopify server using the same
+  # parameters, except with a new value for limit.
+  #
+  # @param [Integer] limit New limit to apply to the collection.
+  # @return [Shopify::Kaminari::Collection] Updated collection.
+  def per(limit)
+    params = original_params.with_indifferent_access.merge(limit: limit)
+
+    resource_class.all(params: params)
   end
 
   # Gets the number of the previous page.
   #
   # @return [Integer, NilClass] The previous page number or nil if on the first.
   def prev_page
-    @prev_page ||= current_page - 1 if current_page > 1
+    current_page - 1 unless first_page? || out_of_range?
   end
 
-  # Calculates the total number of expected pages based on the number
-  # reported by the API.
+  # Gets the total number of entries available on the server for the original
+  # parameters used to fetch the collection.
   #
-  # @return [Integer] Total number of pages.
-  def total_pages
-    @total_pages ||= begin
+  # @return [Integer] Total number of entries.
+  def total_count
+    @total_count ||= begin
       # Get the parameters without the pagination parameters.
-      params = original_params.with_indifferent_access.except(:page, :limit)
-
-      options = params.empty? ? {} : params
+      options = original_params.with_indifferent_access.except(:page, :limit)
 
       # Ask Shopify how many records there are for the given query.
       count = resource_class.count(options)
-
-      # Calculate the number of pages.
-      (count.to_f / limit_value.to_f).ceil
     end
   end
+
+  # Calculates the total number of expected pages based on the number
+  # reported by the API.
+  #
+  # @return [Integer] Total number of pages.
+  def total_pages
+    @total_pages ||= (total_count.to_f / limit_value.to_f).ceil
+  end
 end

data/lib/shopify/kaminari/version.rb

@@ -4,6 +4,6 @@
 module Shopify
   module Kaminari
     # The gem's semantic version.
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-kaminari
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Travis Haynes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-27 00:00:00.000000000 Z
+date: 2018-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shopify_api