actionset 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a682e0da229e04c37aca7d4da4181a8725c837dd
-  data.tar.gz: 98c6cd09dedad0b048cf11551f7290c388fef9c8
+  metadata.gz: 5a6420257cd324299c5517e5e47ba01f2213ce66
+  data.tar.gz: a505a2bb2c880fad25b8e1bfb4ec09627421fa25
 SHA512:
-  metadata.gz: b6eeaedd38735cd6d63de62db3fc53cee81c3bf3350be60a91841a1c846a096ceee710a975a730192531ee7da2972b694de0933f0964b25ddaf4c91644426d4f
-  data.tar.gz: 3ac5879e34de2d2a3b3d4b91e5ec62f78ccbc63cd34a969843589b1f6d152e11f55aec84013f509dccfdfbd470e75a40950e9d38734ab52ba2de74a55907c874
+  metadata.gz: 2e28535d83f7e8313ed211713c56338fb61c5f83e693092c55b22c99bea548d4f55b6f5dcf8d5d699a9d9bfd096b89b4c4e1f65582a980eb9fa0609c41ca0b6f
+  data.tar.gz: bcabe55d13513680c032a23cb640644d291e766c1867404d37597547e52dbb402b07b089db8a31bbdc8e3cd983c8292fb990d39e70330497142a88f784170fec

data/.gitignore

@@ -12,3 +12,4 @@
 .rspec_status
 *.gem
 *.sqlite
+.DS_Store

data/CHANGELOG

@@ -1,3 +1,5 @@
+v 0.4.1
+  - Fix the helper methods to work properly with the new version of ActiveSet
 v 0.4.0
   - Update to work with the new version of ActiveSet
 v 0.3.5

data/actionset.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 4.0.2'
   spec.add_dependency 'railties'
 
+  spec.add_development_dependency 'rails', '~> 5.1.0'
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/lib/action_set.rb

@@ -7,7 +7,7 @@ require 'active_set'
 require 'ostruct'
 
 require 'action_set/version'
-require_relative './action_set/instructions/entry_value'
+require_relative './action_set/instruction/value'
 require_relative './action_set/helpers/helper_methods'
 
 module ActionSet
@@ -68,8 +68,9 @@ module ActionSet
         instruction = ActiveSet::Instruction.new(keypath, value)
         item_with_value = set.find { |i| !instruction.value_for(item: i).nil? }
         item_value = instruction.value_for(item: item_with_value)
-        typecast_value = ActionSet::Instructions::EntryValue.new(value)
-                                                            .cast(to: item_value.class)
+        typecast_value = Instruction::Value.new(value)
+                                           .cast(to: item_value.class)
+
         memo[keypath] = typecast_value
       end
     end

data/lib/action_set/helpers/helper_methods.rb

@@ -1,18 +1,24 @@
 # frozen_string_literal: true
 
-require_relative './sort_linker'
-require_relative './paginator'
+require_relative './sort/current_direction_for_helper'
+require_relative './sort/description_for_helper'
+require_relative './sort/link_for_helper'
+require_relative './sort/next_direction_for_helper'
+require_relative './sort/path_for_helper'
+require_relative './pagination/links_for_helper'
+require_relative './pagination/path_for_helper'
 
 module ActionSet
   module Helpers
     module HelperMethods
-      def sort_link_for(column, title = nil)
-        Helpers::SortLinker.new(self).render(column, title)
-      end
+      include Sort::CurrentDirectionForHelper
+      include Sort::DescriptionForHelper
+      include Sort::LinkForHelper
+      include Sort::NextDirectionForHelper
+      include Sort::PathForHelper
 
-      def pagination_links_for(set)
-        Helpers::Paginator.new(self).render(set)
-      end
+      include Pagination::PathForHelper
+      include Pagination::LinksForHelper
     end
   end
 end

data/lib/action_set/helpers/pagination/links_for_helper.rb

@@ -0,0 +1,79 @@
+module Pagination
+  module LinksForHelper
+    def pagination_links_for(set)
+      content_tag(:nav, class: 'pagination', 'aria-label': 'Page navigation') do
+        safe_join([
+          link_to_first_page(set),
+          link_to_prev_page(set),
+          description_of_current_page(set),
+          link_to_next_page(set),
+          link_to_last_page(set)
+        ])
+      end
+    end
+
+    private
+
+    def description_of_current_page(set)
+      description = "Page&nbsp;<strong>#{current_page_for(set)}</strong>&nbsp;of&nbsp;<strong>#{total_pages_for(set)}</strong>".html_safe
+
+      content_tag(:span,
+                  description,
+                  class: 'page-current')
+    end
+
+    def link_to_first_page(set)
+      if current_page_for(set) > 1
+        link_to('« First', paginate_path_for(1), class: 'page-link page-first')
+      else
+        content_tag(:span, '« First', class: 'page-link page-first disabled')
+      end
+    end
+
+    def link_to_prev_page(set)
+      current_page = current_page_for(set)
+
+      if current_page > 1 && current_page <= total_pages_for(set)
+        link_to('‹ Prev', paginate_path_for(current_page - 1), rel: 'prev', class: 'page-link page-prev')
+      else
+        content_tag(:span, '‹ Prev', class: 'page-link page-prev disabled')
+      end
+    end
+
+    def link_to_last_page(set)
+      current_page = current_page_for(set)
+      total_pages = total_pages_for(set)
+
+      if current_page != total_pages && current_page <= total_pages
+        link_to('Last »',  paginate_path_for(total_pages), class: 'page-link page-last')
+      else
+        content_tag(:span, 'Last »', class: 'page-link page-last disabled')
+      end
+    end
+
+    def link_to_next_page(set)
+      current_page = current_page_for(set)
+      total_pages = total_pages_for(set)
+
+      if current_page != total_pages && current_page <= total_pages
+        link_to('Next ›', paginate_path_for(current_page + 1), rel: 'next', class: 'page-link page-next')
+      else
+        content_tag(:span, 'Next ›', class: 'page-link page-next disabled')
+      end
+    end
+
+    def total_pages_for(set)
+      total_set_size = set.set.count
+
+      (total_set_size.to_f / page_size_for(set)).ceil
+    end
+
+    def current_page_for(set)
+      set.instructions.dig(:paginate, :page)
+    end
+
+    def page_size_for(set)
+      set.instructions.dig(:paginate, :size)
+    end
+  end
+end

data/lib/action_set/helpers/pagination/path_for_helper.rb

@@ -0,0 +1,16 @@
+module Pagination
+  module PathForHelper
+    def paginate_path_for(page)
+      page ||= 1
+      url_for paginate_params_for(page)
+    end
+
+    private
+
+    def paginate_params_for(page)
+      current_params.merge(paginate: {
+        page: page
+      })
+    end
+  end
+end

data/lib/action_set/helpers/sort/current_direction_for_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sort
+  module CurrentDirectionForHelper
+    def current_sort_direction_for(attribute, format: :short)
+      direction = current_params.dig(:sort, attribute).to_s.downcase
+
+      return _ascending(format) if direction.presence_in %w[asc ascending]
+      return _descending(format) if direction.presence_in %w[desc descending]
+
+      direction
+    end
+
+    def current_params
+      return params.to_unsafe_hash if params.respond_to? :to_unsafe_hash
+
+      params
+    end
+  end
+end

data/lib/action_set/helpers/sort/description_for_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sort
+  module DescriptionForHelper
+    def sort_description_for(attribute)
+      "sort by '#{attribute}' in #{next_sort_direction_for(attribute, format: :long)} order"
+    end
+  end
+end

data/lib/action_set/helpers/sort/link_for_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Sort
+  module LinkForHelper
+    def sort_link_for(attribute, name = nil)
+      link_to(name || attribute.titleize,
+              sort_path_for(attribute),
+              'aria-label': sort_description_for(attribute))
+    end
+  end
+end

data/lib/action_set/helpers/sort/next_direction_for_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# depends upon #current_sort_direction_for
+
+module Sort
+  module NextDirectionForHelper
+    def next_sort_direction_for(attribute, format: :short)
+      direction = current_sort_direction_for(attribute)
+
+      return _ascending(format) unless direction
+      return _ascending(format) unless direction.presence_in %w[asc desc ascending descending]
+      return _ascending(format) if direction.presence_in %w[desc descending]
+      return _descending(format) if direction.presence_in %w[asc ascending]
+    end
+
+    private
+
+    def _ascending(format)
+      return 'asc' if format.to_s == 'short'
+
+      'ascending'
+    end
+
+    def _descending(format)
+      return 'desc' if format.to_s == 'short'
+
+      'descending'
+    end
+  end
+end

data/lib/action_set/helpers/sort/path_for_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Sort
+  module PathForHelper
+    def sort_path_for(attribute)
+      url_for sort_params_for(attribute)
+    end
+
+    private
+
+    def sort_params_for(attribute)
+      current_params.merge(only_path: true,
+                           sort: {
+                             attribute => next_sort_direction_for(attribute)
+                           })
+    end
+  end
+end

data/lib/action_set/{instructions/entry_value.rb → instruction/value.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module ActionSet
-  module Instructions
-    class EntryValue
+  module Instruction
+    class Value
       attr_reader :raw
 
       def initialize(value)
@@ -81,6 +81,7 @@ module ActionSet
           @possible_typecasters ||= type_class.constants
                                               .map(&:to_s)
                                               .select { |t| can_typecast?(t) }
+                                              .reject { |t| t == 'Time' }
                                               .map { |t| init_typecaster(t) }
                                               .compact
         end
@@ -142,6 +143,7 @@ module ActionSet
           return if @raw.is_a? @target
           return unless @target.eql?(ActiveSupport::TimeWithZone)
           time_value = ActiveModelAdapter.new(@raw, Time).process
+
           return unless time_value.is_a?(Time)
           return time_value unless time_value.respond_to?(:in_time_zone)
           time_value.in_time_zone

data/lib/action_set/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionset
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Stephen Margheim
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-20 00:00:00.000000000 Z
+date: 2018-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeset
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -228,9 +242,14 @@ files:
 - 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/helpers/pagination/links_for_helper.rb
+- lib/action_set/helpers/pagination/path_for_helper.rb
+- lib/action_set/helpers/sort/current_direction_for_helper.rb
+- lib/action_set/helpers/sort/description_for_helper.rb
+- lib/action_set/helpers/sort/link_for_helper.rb
+- lib/action_set/helpers/sort/next_direction_for_helper.rb
+- lib/action_set/helpers/sort/path_for_helper.rb
+- lib/action_set/instruction/value.rb
 - lib/action_set/version.rb
 homepage: https://github.com/fractaledmind/actionset
 licenses:

data/lib/action_set/helpers/paginator.rb

@@ -1,165 +0,0 @@
-# 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
-               .deep_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

@@ -1,60 +0,0 @@
-# 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