cursed 0.1.0

checksums.yaml

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

data/.env.example

@@ -0,0 +1 @@
+DATABASE_URL: postgres://root:@localhost/cursed_test

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/tmp/
+.env

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,15 @@
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ParameterLists:
+  Max: 10

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cursed.gemspec
+gemspec
+
+gem 'rubocop'
+
+gem 'activerecord', require: 'active_record'
+
+gem 'sequel'
+
+gem 'pg'
+
+gem 'rspec'
+gem 'rspec-its'
+
+gem 'yard'
+
+gem 'pry-byebug'
+
+gem 'dotenv'
+
+gem 'geminabox'

data/README.md

@@ -0,0 +1,74 @@
+# 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
+traditional pagination which is superior in that it is stable for collections
+that are constantly changing.
+
+Instead of providing a parameter `page` we instead provide any of three
+parameters `before`, `after` and `limit` (you may customize these as you wish).
+By choosing to 'paginate' by providing the maximum ID you know about you can
+be assured that the same record will not appear twice if records behind it have
+changed it's position.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cursed'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cursed
+
+## Usage
+
+In your controller code call your collection in this manner.
+
+```ruby
+Cursed::Collection.new(
+  relation: MyModel.unscoped,
+  cursor: Cursed::Cursor.new(
+    after: params[:after],
+    before: params[:before],
+    limit: params[:limit],
+    maximum: 20
+  )
+)
+```
+
+The `Collection` is enumerable so you can use it as you would us any array
+
+```erb
+<% @collection.each do |record| %>
+  <%= record.name %>
+<% end %>
+```
+
+To generate your next link and previous link merge in the values of `#next_page_params`
+and `#prev_page_params` into your URL generator
+
+```erb
+  <%= link_to 'Previous Page', widgets_path(collection.prev_page_params) %>
+  <%= link_to 'Next Page', widgets_path(collection.next_page_params) %>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/influitive/cursed.
+
+## License
+
+This gem is licensed under the MIT license.

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'cursed'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,11 @@
+machine:
+  environment:
+    DATABASE_URL: postgresql://ubuntu:@localhost/circle_ruby_test
+
+database:
+  override:
+    - createdb -O ubuntu circle_ruby_test
+
+test:
+  override:
+    - bundle exec rspec

data/cursed.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cursed/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cursed'
+  spec.version       = Cursed::VERSION
+  spec.licenses      = ['MIT']
+  spec.authors       = ['Will Howard']
+  spec.email         = ['will@influitive.com']
+  spec.homepage      = 'https://www.github.com/influitive/cursed'
+
+  spec.summary       = 'PostgreSQL based cursoring in ActiveRecord and Sequel'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+end

data/lib/cursed.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'cursed/version'
+require 'cursed/cursor'
+require 'cursed/collection'
+require 'cursed/adapter'

data/lib/cursed/adapter.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'adapter/base'
+require_relative 'adapter/sequel'
+require_relative 'adapter/active_record'
+require_relative 'adapter/array'

data/lib/cursed/adapter/active_record.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Cursed
+  module Adapter
+    class ActiveRecord < Base
+      def descend_by(attribute)
+        @relation = relation.reorder(attribute => :desc)
+      end
+
+      def ascend_by(attribute)
+        @relation = relation.reorder(attribute => :asc)
+      end
+
+      def limit(count)
+        @relation = relation.limit(count)
+      end
+
+      def after(attribute, value)
+        @relation = relation.where(relation.table[attribute].gt(value))
+      end
+
+      def before(attribute, value)
+        @relation = relation.where(relation.table[attribute].lt(value))
+      end
+    end
+  end
+end

data/lib/cursed/adapter/array.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Cursed
+  module Adapter
+    class Array < Base
+      def descend_by(attribute)
+        relation.sort_by!(&attribute)
+        relation.reverse!
+      end
+
+      def ascend_by(attribute)
+        relation.sort_by!(&attribute)
+      end
+
+      def limit(count)
+        @relation = relation.take(count)
+      end
+
+      def after(attribute, value)
+        relation.select! { |x| x.public_send(attribute) > value }
+      end
+
+      def before(attribute, value)
+        relation.select! { |x| x.public_send(attribute) < value }
+      end
+    end
+  end
+end

data/lib/cursed/adapter/base.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Cursed
+  module Adapter
+    class Base
+      attr_reader :relation
+
+      def initialize(array)
+        @relation = array
+      end
+
+      def apply_to(cursor)
+        attr = cursor.attribute
+
+        after(attr, cursor.after) if cursor.after?
+
+        before(attr, cursor.before) if cursor.before?
+
+        if cursor.forward?
+          ascend_by(attr)
+        else
+          descend_by(attr)
+        end
+
+        limit(cursor.clamped_limit)
+
+        relation
+      end
+    end
+  end
+end

data/lib/cursed/adapter/sequel.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Cursed
+  module Adapter
+    class Sequel < Base
+      def descend_by(attribute)
+        @relation = relation.order(attribute).reverse
+      end
+
+      def ascend_by(attribute)
+        @relation = relation.order(attribute)
+      end
+
+      def limit(count)
+        @relation = relation.limit(count)
+      end
+
+      def after(attribute, value)
+        @relation = relation.where(::Sequel.expr(attribute) > value)
+      end
+
+      def before(attribute, value)
+        @relation = relation.where(::Sequel.expr(attribute) < value)
+      end
+    end
+  end
+end

data/lib/cursed/collection.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Cursed
+  class Collection
+    include Enumerable
+
+    attr_reader :relation, :cursor, :adapter
+
+    # @param relation [ActiveRecord::Relation or Sequel::Dataset] the relation to cursor on
+    # @param cursor [Cursor] the value object containing parameters for the cursor
+    # @param adapter [Adapter] an object which plays the Adapter role
+    def initialize(relation:, cursor:, adapter: nil)
+      @relation = relation
+      @cursor = cursor
+      @adapter = adapter || determine_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.
+    def invalidate!
+      @collection = nil
+    end
+
+    # Returns the maximum cursor index in the current page
+    def maximum_id
+      collection.map(&cursor.attribute).max
+    end
+
+    # Returns 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
+
+    private
+
+    def collection
+      @collection ||= adapter.new(relation).apply_to(cursor).to_a
+    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
+
+    def after_maximum_params
+      { after: maximum_id, limit: cursor.clamped_limit }
+    end
+
+    def before_minimum_params
+      { before: minimum_id, limit: cursor.clamped_limit }
+    end
+  end
+end

data/lib/cursed/cursor.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Cursed
+  # Cursor is a value object that has all the parameters required to determine
+  # how to fetch a page of records using the cursor pattern.
+  class Cursor
+    DIRECTIONS = %i(forward backward).freeze
+
+    attr_reader :after, :before, :limit, :maximum, :attribute, :direction
+
+    # @param [Integer] after The cursor index to retrieve records after
+    # @param [Integer] before The cursor index to retrive records before
+    # @param [Integer] limit The maximum number of records to retrieve
+    # @param [Integer] maximum The maximum value that :limit can have
+    # @param [Symbol] attribute The name of the attribute to cursor upon
+    # @param [:forward or :backward] direction The direction the cursor will advance in the collection
+    def initialize(after: nil, before: nil, limit: 10, maximum: 20, attribute: :cursor, direction: :forward)
+      @after = Integer(after) unless after.nil?
+      @before = Integer(before) unless before.nil?
+      @limit = Integer(limit)
+      @maximum = Integer(maximum)
+      @attribute = attribute
+      @direction = direction
+      raise ArgumentError, "#{direction} is not a valid direction" unless DIRECTIONS.include?(direction)
+    end
+
+    # returns the value of {#limit} clamped into the range of 1..{#maximum} (inclusive)
+    def clamped_limit
+      [1, limit, maximum].sort[1]
+    end
+
+    # returns true when the direction is forward
+    def forward?
+      direction == :forward
+    end
+
+    # returns true when the direction is backward
+    def backward?
+      direction == :backward
+    end
+
+    # returns true when the before parameter is set to a non-nil value
+    def before?
+      !before.nil?
+    end
+
+    # returns true when the after parameter is set to a non-nil value
+    def after?
+      !after.nil?
+    end
+  end
+end

data/lib/cursed/version.rb

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

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: cursed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Will Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-30 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- will@influitive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- cursed.gemspec
+- lib/cursed.rb
+- lib/cursed/adapter.rb
+- lib/cursed/adapter/active_record.rb
+- lib/cursed/adapter/array.rb
+- lib/cursed/adapter/base.rb
+- lib/cursed/adapter/sequel.rb
+- lib/cursed/collection.rb
+- lib/cursed/cursor.rb
+- lib/cursed/version.rb
+homepage: https://www.github.com/influitive/cursed
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: PostgreSQL based cursoring in ActiveRecord and Sequel
+test_files: []
+has_rdoc: