actionset 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5026afa544f9def59209497c089522877b6ab900
-  data.tar.gz: 3bfbd8ff3930d022ac45e8680390ad9a42c4406c
+  metadata.gz: 27ec348f94bbc668c2b2b0488ae39f551aa4eb07
+  data.tar.gz: 926fda73f52119dd20c4e355ff0a501d25238f54
 SHA512:
-  metadata.gz: f78f95e0cf017f4a22dd8339cfb2338d4ca8c01c97a3d68d7f7200895e74572073be94bc1756fc115cee336660738f8988354275e794d5280b6c70028ecddf0a
-  data.tar.gz: e165d731e37993c0a92a3d407642d7823dbaaf5414ae137a5d11fbdf1bb64bdfdb7c859c6c1cfae11acfcc596dc852b5957d336137dfa8330fec22b06d3b9bfd
+  metadata.gz: bdcadbe61ad8a0b6209015df5e9c0302ee6923d2aa33782b9baa75873650c457ac8e092513d5f2dd9dbc33a07f8ab6bc60a3f79121532bd8e429c4aa8098dc0e
+  data.tar.gz: f503e4ae5a77fc6a435b09519e1f26d09400e64e4b1d5d0354b7b7b6394400cbf8ee9c7d2419970919dbc6e3cb3496f982c3c0eef1f6f29e7da3cec26997688a

data/CHANGELOG

@@ -1,3 +1,6 @@
+v 0.3.0
+  - Add a `paginate_set` method that is a part of the `process_set` chain now
+  - Add `paginate` view helper for rendering a pagination navigation
 v 0.2.1
   - Extract the `set_filters_ivar` method so that app controllers can use it in a before action for filter forms that are present on multiple actions
 v 0.2.0

data/lib/action_set.rb

@@ -7,13 +7,13 @@ require 'ostruct'
 
 require 'action_set/version'
 require_relative './action_set/instructions/entry_value'
-require_relative './action_set/view_helpers'
+require_relative './action_set/helpers/helper_methods'
 
 module ActionSet
   class Railtie < ::Rails::Railtie
     initializer 'action_set.view_helpers' do
       ActiveSupport.on_load :action_view do
-        include ViewHelpers
+        include Helpers::HelperMethods
       end
     end
   end
@@ -30,25 +30,31 @@ module ActionSet
   module InstanceMethods
     def process_set(set)
       @set = set
-      sort_set(filter_set(ActiveSet.new(set)))
+      paginate_set(sort_set(filter_set(ActiveSet.new(set))))
     end
 
     def filter_set(set)
       set_filters_ivar
-      active_set = set.is_a?(ActiveSet) ? set : ActiveSet.new(set)
+      active_set = ensure_active_set(set)
       active_set = active_set.filter(filter_structure) if filter_params.any?
       active_set
     end
 
     def sort_set(set)
-      active_set = set.is_a?(ActiveSet) ? set : ActiveSet.new(set)
+      active_set = ensure_active_set(set)
       active_set = active_set.sort(sort_params) if sort_params.any?
       active_set
     end
 
+    def paginate_set(set)
+      active_set = ensure_active_set(set)
+      active_set = active_set.paginate(paginate_structure) if paginate_params.any?
+      active_set
+    end
+
     def export_set(set)
       return send_file(set, export_set_options(request.format)) if set.is_a?(String) && File.file?(set)
-      active_set = set.is_a?(ActiveSet) ? set : ActiveSet.new(set)
+      active_set = ensure_active_set(set)
       transformed_data = active_set.transform(transform_structure)
       send_data(transformed_data, export_set_options(request.format))
     end
@@ -60,10 +66,6 @@ module ActionSet
 
     private
 
-    def filter_params
-      params.fetch(:filter, {}).to_unsafe_hash
-    end
-
     def filter_structure
       filter_params.flatten_keys.reject { |_, v| v.blank? }.each_with_object({}) do |(keypath, value), memo|
         instruction = ActiveSet::Instructions::Entry.new(keypath, value)
@@ -75,6 +77,10 @@ module ActionSet
       end
     end
 
+    def paginate_structure
+      paginate_params.transform_values(&:to_i)
+    end
+
     def transform_structure
       {}.tap do |struct|
         struct[:format] = transform_params[:format] || request.format.symbol
@@ -90,10 +96,18 @@ module ActionSet
       end
     end
 
+    def filter_params
+      params.fetch(:filter, {}).to_unsafe_hash
+    end
+
     def sort_params
       params.fetch(:sort, {}).to_unsafe_hash
     end
 
+    def paginate_params
+      params.fetch(:paginate, {}).to_unsafe_hash
+    end
+
     def transform_params
       params.fetch(:transform, {}).to_unsafe_hash
     end
@@ -105,6 +119,12 @@ module ActionSet
         opts[:disposition] = :inline if %w[development test].include?(Rails.env.to_s)
       end
     end
+
+    def ensure_active_set(set)
+      return set if set.is_a?(ActiveSet)
+
+      ActiveSet.new(set)
+    end
   end
 
   def self.included(receiver)

data/lib/action_set/helpers/helper_methods.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative './sort_linker'
+require_relative './paginator'
+
+module ActionSet
+  module Helpers
+    module HelperMethods
+      def sort_link(column, title)
+        Helpers::SortLinker.new(self).render(column, title)
+      end
+
+      def paginate(set)
+        Helpers::Paginator.new(self).render(set)
+      end
+    end
+  end
+end

data/lib/action_set/helpers/paginator.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module ActionSet
+  module Helpers
+    class Paginator
+      def initialize(template)
+        @template = template
+        @info = {}
+      end
+
+      def render(set)
+        @info = info_for_set(set)
+
+        content_tag(:ul, class: 'pagination') do
+          safe_join([
+            link_to_first_page,
+            link_to_prev_page,
+            link_to_prev_gap,
+            safe_join(relevant_page_numbers.map do |num|
+              page = PageInterface.new(num, @info)
+              link = link_to(page, page_link_url(page), rel: page.rel)
+              content_tag(:li, link, class: ['page', (page.current? ? 'active' : nil)].compact)
+            end),
+            link_to_next_gap,
+            link_to_next_page,
+            link_to_last_page
+          ].compact)
+        end
+      end
+
+      private
+
+      def info_for_set(set)
+        {
+          current_page: set.instructions.dig(:paginate, :page),
+          page_size: set.instructions.dig(:paginate, :size),
+          total_pages: (set.total_count.to_f / set.instructions.dig(:paginate, :size)).ceil,
+          left_window_size: 2,
+          right_window_size: 2
+        }
+      end
+
+      def relevant_page_numbers
+        current_page = [@info[:current_page]]
+        left_window = [*(@info[:current_page] - @info[:left_window_size])..@info[:current_page]]
+        right_window = [*@info[:current_page]..(@info[:current_page] + @info[:right_window_size])]
+
+        (left_window | current_page | right_window).sort.reject { |x| (x < 1) || (x > @info[:total_pages]) }
+      end
+
+      def page_link_url(page_number)
+        request.query_parameters
+               .merge(controller: controller.controller_path,
+                      action: controller.action_name,
+                      paginate: {
+                        page: page_number
+                      })
+      end
+
+      def link_to_prev_gap
+        return unless @info[:current_page] > 1
+        return unless @info[:current_page] <= @info[:total_pages]
+        return unless (@info[:current_page] - 1) > (@info[:left_window_size] + 1)
+
+        link = link_to('…', '#', onclick: 'return false;')
+        content_tag(:li, link, class: 'page prev_gap disabled')
+      end
+
+      def link_to_next_gap
+        return unless @info[:current_page] >= 1
+        return unless @info[:current_page] <= @info[:total_pages]
+        return unless (@info[:total_pages] - @info[:current_page]) > (@info[:right_window_size] + 1)
+
+        link = link_to('…', '#', onclick: 'return false;')
+        content_tag(:li, link, class: 'page next_gap disabled')
+      end
+
+      def link_to_first_page
+        return unless @info[:current_page] > 1
+
+        link = link_to('« First', page_link_url(1))
+        content_tag(:li, link, class: 'page first')
+      end
+
+      def link_to_prev_page
+        return unless @info[:current_page] > 1
+        return unless @info[:current_page] <= @info[:total_pages]
+
+        link = link_to('‹ Prev', page_link_url(@info[:current_page] - 1), rel: 'prev')
+        content_tag(:li, link, class: 'page prev')
+      end
+
+      def link_to_last_page
+        return unless @info[:current_page] != @info[:total_pages]
+        return unless @info[:current_page] <= @info[:total_pages]
+
+        link = link_to('Last »', page_link_url(@info[:total_pages]))
+        content_tag(:li, link, class: 'page last')
+      end
+
+      def link_to_next_page
+        return unless @info[:current_page] != @info[:total_pages]
+        return unless @info[:current_page] <= @info[:total_pages]
+
+        link = link_to('Next ›', page_link_url(@info[:current_page] + 1), rel: 'next')
+        content_tag(:li, link, class: 'page next')
+      end
+
+      # delegates view helper methods to @template
+      def method_missing(name, *args, &block)
+        @template.respond_to?(name) ? @template.send(name, *args, &block) : super
+      end
+
+      # Wraps a "page number" and provides some utility methods
+      class PageInterface
+        def initialize(page, info)
+          @page = page
+          @info = info
+        end
+
+        def number
+          @page
+        end
+
+        def current?
+          @page == @info[:current_page]
+        end
+
+        def first?
+          @page == 1
+        end
+
+        def last?
+          @page == @info[:total_pages]
+        end
+
+        def prev?
+          @page == @info[:current_page] - 1
+        end
+
+        def next?
+          @page == @info[:current_page] + 1
+        end
+
+        def rel
+          return 'next' if next?
+          return 'prev' if prev?
+          nil
+        end
+
+        def out_of_range?
+          @page > @info[:total_pages]
+        end
+
+        def to_i
+          number
+        end
+
+        def to_s
+          number.to_s
+        end
+      end
+    end
+  end
+end

data/lib/action_set/helpers/sort_linker.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module ActionSet
+  module Helpers
+    class SortLinker
+      def initialize(template)
+        @template = template
+      end
+
+      def render(column, title = nil)
+        column = column.to_s
+        title ||= sort_link_title(column)
+
+        @template.link_to title, sort_link_url(column)
+      end
+
+      private
+
+      def sort_link_title(column)
+        I18n.t(column,
+               scope: :attributes,
+               default: default_sort_link_title(column))
+      end
+
+      def sort_link_url(column)
+        @template.request
+                 .query_parameters
+                 .merge(controller: @template.controller.controller_path,
+                        action: @template.controller.action_name,
+                        sort: {
+                          column => sort_link_direction(column)
+                        })
+      end
+
+      def sort_link_direction(column)
+        return 'asc' unless sort_params_include_column?(column)
+        return 'asc' unless sort_params_only_include_valid_directions?
+
+        sort_direction_inverses = { 'asc' => 'desc', 'desc' => 'asc' }
+        sort_direction_inverses[@template.params.dig(:sort, column).to_s]
+      end
+
+      def default_sort_link_title(column)
+        ActiveSet::Instructions::Entry::KeyPath.new(column).titleized
+      end
+
+      def sort_params_include_column?(column)
+        @template.params[:sort]&.keys&.include?(column.to_s)
+      end
+
+      def sort_params_only_include_valid_directions?
+        (sort_params_directions - %w[asc desc]).empty?
+      end
+
+      def sort_params_directions
+        @template.params[:sort]&.values&.map(&:to_s)&.uniq
+      end
+    end
+  end
+end

data/lib/action_set/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionSet
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionset
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Stephen Margheim
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-25 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeset
@@ -227,9 +227,11 @@ files:
 - bin/setup
 - config.ru
 - lib/action_set.rb
+- lib/action_set/helpers/helper_methods.rb
+- lib/action_set/helpers/paginator.rb
+- lib/action_set/helpers/sort_linker.rb
 - lib/action_set/instructions/entry_value.rb
 - lib/action_set/version.rb
-- lib/action_set/view_helpers.rb
 homepage: https://github.com/fractaledmind/actionset
 licenses:
 - MIT

data/lib/action_set/view_helpers.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module ActionSet
-  module ViewHelpers
-    def sort_link(column, title = nil)
-      column = column.to_s
-      title ||= sort_link_title(column)
-
-      link_to title, sort_link_url(column)
-    end
-
-    private
-
-    def sort_link_url(column)
-      request.query_parameters.merge(controller: controller.controller_path,
-                                     action: controller.action_name,
-                                     sort: {
-                                       column => sort_link_direction(column)
-                                     })
-    end
-
-    def sort_link_title(column)
-      I18n.t(column,
-             scope: :attributes,
-             default: default_sort_link_title(column))
-    end
-
-    def sort_link_direction(column)
-      return 'asc' unless params[:sort]&.keys&.include?(column.to_s)
-
-      sort_direction_inverses = { 'asc' => 'desc', 'desc' => 'asc' }
-      sort_direction_inverses[params.dig(:sort, column)]
-    end
-
-    def default_sort_link_title(column)
-      ActiveSet::Instructions::Entry::KeyPath.new(column).titleized
-    end
-  end
-end