cursed 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2af86e7660623d2cb8d56b06e3c30c4fd32b4ec3
-  data.tar.gz: 4b661132d4d8b4551abcdea318bfd9ac5e0a11d1
+  metadata.gz: ddec2faf831b8c8a33d1aa2e9bef2f15fee19dae
+  data.tar.gz: 0e54d9462488a3db7f7b9558bd137125c1eba0d9
 SHA512:
-  metadata.gz: a7d526ef920e90529009fa27fe1bc1808b4565ddd5f57ae4d0dcad2d7fd7f8856165a7c2b3e5b69d957d13863087c52fd03309412569746a669b703a2c2f6b64
-  data.tar.gz: 2b709005118b8a5158f1f017ae131ae27e9191249a9a3a5fca0afa6882191e4fb4041562b74734ff94328ef02d78ae7a380cdccbc5438d606935aefd9af8cd5c
+  metadata.gz: cefdc4be655a383b79111be16db1906d5091d0ec87ef97399493456168e82519ca778d9c340e2d4f6699bf5b094cb13e99c7826fff59bd7ba0736f9d946a3985
+  data.tar.gz: 577e3192cd34290aabe16cc8e5f2450099030c82eae83691f63fb7a08add56080be3fffa61de7f5a3a15c6583cc38c6117a979318d4eb2aa4bc91a9a35995b33

data/.rubocop.yml

@@ -8,6 +8,9 @@ Style/Documentation:
 Style/ClassAndModuleChildren:
   Enabled: false
 
+Style/MethodName:
+  Enabled: false
+
 Metrics/LineLength:
   Max: 120
 

data/README.md

@@ -1,4 +1,6 @@
-# Cursed
+
+
+# Cursed [![CircleCI](https://circleci.com/gh/influitive/cursed.svg?style=svg)](https://circleci.com/gh/influitive/cursed)
 
 Cursed is a gem that implements the cursoring pattern in Postgres with the
 ActiveRecord and Sequel gems.  The cursoring pattern is an alternative to
@@ -52,11 +54,16 @@ The `Collection` is enumerable so you can use it as you would us any array
 ```
 
 To generate your next link and previous link merge in the values of `#next_page_params`
-and `#prev_page_params` into your URL generator
+and `#prev_page_params` into your URL generator.  `#next_page?` and `#prev_page?` can
+be used to determine if there are next or previous pages of records currently.
 
 ```erb
-  <%= link_to 'Previous Page', widgets_path(collection.prev_page_params) %>
-  <%= link_to 'Next Page', widgets_path(collection.next_page_params) %>
+  <% if collection.prev_page? %>
+    <%= link_to 'Previous Page', widgets_path(collection.prev_page_params) %>
+  <% end %>
+  <% if collection.next_page? %>
+    <%= link_to 'Next Page', widgets_path(collection.next_page_params) %>
+  <% end %>
 ```
 
 ## Development

data/lib/cursed.rb

@@ -3,4 +3,5 @@
 require 'cursed/version'
 require 'cursed/cursor'
 require 'cursed/collection'
+require 'cursed/page'
 require 'cursed/adapter'

data/lib/cursed/adapter/base.rb

@@ -28,4 +28,15 @@ module Cursed
       end
     end
   end
+
+  module_function
+
+  def Adapter(value)
+    case value
+    when -> (x) { x.is_a?(Class) && x.ancestors.include?(Adapter::Base) } then value
+    when Sequel::Dataset then Adapter::Sequel
+    when ActiveRecord::Base, ActiveRecord::Relation then Adapter::ActiveRecord
+    else raise ArgumentError, "unable to cast #{value.inspect} to Adapter"
+    end
+  end
 end

data/lib/cursed/collection.rb

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
+require 'forwardable'
+
 module Cursed
   class Collection
+    extend Forwardable
     include Enumerable
 
+    def_delegators :current_page, :each, :maximum_id, :minimum_id, :next_page_params, :prev_page_params
+
     attr_reader :relation, :cursor, :adapter
 
     # @param relation [ActiveRecord::Relation or Sequel::Dataset] the relation to cursor on
@@ -12,72 +17,46 @@ module Cursed
     def initialize(relation:, cursor:, adapter: nil)
       @relation = relation
       @cursor = cursor
-      @adapter = adapter || determine_adapter(relation)
+      @adapter = Cursed::Adapter(adapter || relation)
     end
 
-    # Iterates through each element in the current page
-    def each(*args, &block)
-      collection.each(*args, &block)
-    end
-
-    # Invalidates the local cache of the current page - the next call to {#each}
-    # (or any Enumerable method that calls it) will fetch a fresh page.
+    # invalidates the {#current_page}, {#next_page} and {#prev_page}
+    # @see Page#invalidate!
     def invalidate!
-      @collection = nil
+      [prev_page, next_page, current_page].each(&:invalidate!)
     end
 
-    # Returns the maximum cursor index in the current page
-    def maximum_id
-      collection.map(&cursor.attribute).max
+    # @return [Page] the current page
+    def current_page
+      @current_page ||= build_page(cursor)
     end
 
-    # Returns the minimum cursor index in the current page
-    def minimum_id
-      collection.map(&cursor.attribute).min
+    # @return [Page] the page following this one
+    def next_page
+      @next_page ||= build_page(current_page.next_page_cursor)
     end
 
-    # Returns a hash of parameters which should be used for generating a next
-    # page link.
-    # @return [Hash] a hash containing any combination of :before, :after, :limit
-    def next_page_params
-      if cursor.forward?
-        after_maximum_params
-      else
-        before_minimum_params
-      end
+    # @return [Page] the page previous to this one
+    def prev_page
+      @prev_page ||= build_page(current_page.prev_page_cursor)
     end
 
-    # Returns a hash of parameters which should be used for generating a previous
-    # page link.
-    # @return [Hash] a hash containing any combination of :before, :after, :limit
-    def prev_page_params
-      if cursor.forward?
-        before_minimum_params
-      else
-        after_maximum_params
-      end
+    # @return [Boolean] true if there are records that follow records in the current page
+    def next_page?
+      next_page.any?
     end
 
-    private
-
-    def collection
-      @collection ||= adapter.new(relation).apply_to(cursor).to_a
+    # @return [Boolean] true if there are records that preceede records in the current page
+    def prev_page?
+      prev_page.any?
     end
 
-    def determine_adapter(relation)
-      case relation
-      when Sequel::Dataset then Adapter::Sequel
-      when ActiveRecord::Base, ActiveRecord::Relation then Adapter::ActiveRecord
-      else raise ArgumentError, "unable to determine adapter for #{relation.inspect}"
-      end
-    end
+    private
 
-    def after_maximum_params
-      { after: maximum_id, limit: cursor.clamped_limit }
-    end
+    attr_reader :relation, :cursor, :adapter
 
-    def before_minimum_params
-      { before: minimum_id, limit: cursor.clamped_limit }
+    def build_page(cursor)
+      Page.new(relation: adapter.new(relation.dup).apply_to(cursor), cursor: cursor)
     end
   end
 end

data/lib/cursed/page.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Cursed
+  class Page
+    include Enumerable
+
+    def initialize(relation:, cursor:)
+      @relation = relation
+      @cursor = cursor
+    end
+
+    # Iterates through each element in the current page
+    def each(*args, &block)
+      collection.each(*args, &block)
+    end
+
+    # Invalidates the local cache of the current page - the next call to {#each}
+    # (or any Enumerable method that calls it) will fetch a fresh page.
+    def invalidate!
+      @collection = nil
+      @count = nil
+    end
+
+    # @return [Integer] the number of records in this page
+    def count
+      @count ||= @collection.try(:length) || relation.count
+    end
+
+    # @return [Boolean] if there are records on this page
+    def any?
+      count > 0
+    end
+
+    # @return [Integer] the maximum cursor index in the current page
+    def maximum_id
+      collection.map(&cursor.attribute).max
+    end
+
+    # @return [Integer] the minimum cursor index in the current page
+    def minimum_id
+      collection.map(&cursor.attribute).min
+    end
+
+    # Returns a hash of parameters which should be used for generating a next
+    # page link.
+    # @return [Hash] a hash containing any combination of :before, :after, :limit
+    def next_page_params
+      if cursor.forward?
+        after_maximum_params
+      else
+        before_minimum_params
+      end
+    end
+
+    # Returns a hash of parameters which should be used for generating a previous
+    # page link.
+    # @return [Hash] a hash containing any combination of :before, :after, :limit
+    def prev_page_params
+      if cursor.forward?
+        before_minimum_params
+      else
+        after_maximum_params
+      end
+    end
+
+    # @return [Cursor] with the values to fetch the next page
+    def next_page_cursor
+      params = next_page_params.merge(
+        maximum: cursor.maximum,
+        direction: cursor.direction,
+        attribute: cursor.attribute
+      )
+
+      Cursor.new(params)
+    end
+
+    # @return [Cursor] with the values to fetch the previous page
+    def prev_page_cursor
+      params = prev_page_params.merge(
+        maximum: cursor.maximum,
+        direction: cursor.direction,
+        attribute: cursor.attribute
+      )
+
+      Cursor.new(params)
+    end
+
+    private
+
+    attr_reader :relation, :cursor
+
+    def collection
+      @collection ||= relation.to_a
+    end
+
+    def after_maximum_params
+      { after: maximum_id || cursor.after, limit: cursor.clamped_limit }
+    end
+
+    def before_minimum_params
+      { before: minimum_id || cursor.before, limit: cursor.clamped_limit }
+    end
+  end
+end

data/lib/cursed/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Cursed
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cursed
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Will Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-30 00:00:00.000000000 Z
+date: 2016-07-04 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -37,6 +37,7 @@ files:
 - lib/cursed/adapter/sequel.rb
 - lib/cursed/collection.rb
 - lib/cursed/cursor.rb
+- lib/cursed/page.rb
 - lib/cursed/version.rb
 homepage: https://www.github.com/influitive/cursed
 licenses: