cursory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e5f54cdbbb19b88e5715f8629e0f34031f55521
+  data.tar.gz: 3308d79fe12e76fbddece661d10f48ccaf2021a2
+SHA512:
+  metadata.gz: 2784d3c0cccdfdebd345edc4fd9cf839eae23e010a5c1640bd7d246e0032561918d3d009f9ef265bb4660389141a1a3f056db91f1db5324fb18f8f7dff67dbc6
+  data.tar.gz: e342fcfdb131cd256bd04c03a64102e4fd4821442baba46db536686cf8c9dd342f892540c26b35680c8e7d0c96e7189010be5cc21d28e6c08dee01ce6e0bf3ea

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cursory.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Simon Hildebrandt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Cursory
+
+Cursory is generic paginator framework, intended to provide cursor-based seek-value and offset-based pagination behaviour, particularly for APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cursory'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cursory
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/Trunkplatform/cursory.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cursory"
+
+# 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/cursory.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cursory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cursory"
+  spec.version       = Cursory::VERSION
+  spec.authors       = ["Simon Hildebrandt"]
+  spec.email         = ["simon@trunkplatform.com"]
+
+  spec.summary       = %q{Paginator framework with out-of-the-box support for Mongoid.}
+  spec.description   = %q{Paginator framework with out-of-the-box support for Mongoid.}
+  spec.homepage      = "https://github.com/Trunkplatform/cursory"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/cursory/base.rb

@@ -0,0 +1,155 @@
+require 'json'
+require 'base64'
+
+class Cursory::Base
+  attr_accessor *%i{criteria sort limit offset cursor}
+
+  MAX_LIMIT = 100
+  SORT_KEY, LIMIT_KEY, CURSOR_KEY, OFFSET_KEY = %i{sort limit cursor offset}
+
+  def initialize criteria, params
+    @criteria = criteria
+    @sort = params[SORT_KEY]
+    @limit = params[LIMIT_KEY]
+    @offset = params[OFFSET_KEY]
+    @cursor = params[CURSOR_KEY]
+  end
+
+  def page
+    { total_count: count, items: search_results, self: current_cursor }.tap do |p|
+      catch(:no_more_results) do
+        p[:next] = next_cursor
+      end
+    end
+  end
+
+  def search
+    constrained_search.send(*search_type)
+  end
+
+  def search_type
+    fail UnimplementedError
+  end
+
+  def clamped_offset
+    [0, offset.to_i].max
+  end
+
+  def constrained_search
+    fail UnimplementedError
+  end
+
+  def search_results
+    @results ||= uncached_search
+  end
+
+  def uncached_search
+    fail UnimplementedError
+  end
+
+  def current_cursor
+    cursor || render_cursor
+  end
+
+  def record_for_next_cursor
+    search_results[clamped_limit-1] or throw(:no_more_results)
+  end
+
+  def next_cursor
+    if record_for_next_cursor
+      render_cursor cursor_data(id: record_for_next_cursor.id.to_s)
+    end
+  end
+
+  def count
+    @count ||= criteria.count
+  end
+
+  def uncached_count
+    fail UnimplementedError
+  end
+
+  def sort_keys
+    sort || model_sort || ''
+  end
+
+  def model
+    fail UnimplementedError
+  end
+
+  def model_sort
+    model.respond_to?(:default_sort_key) && model.default_sort_key
+  end
+
+  def order_keys
+    sort_keys.split(',').map{ |k| decompose_order_key(k) } + [[:id, 'asc']]
+  end
+
+  def decompose_order_key(k)
+    [ k.gsub(/\A[-+]?/,'').to_sym, k.start_with?('-') ? 'desc' : 'asc' ]
+  end
+
+  def order_clause
+    fail UnimplementedError
+  end
+
+  def clamped_limit
+    [1, limit.to_i, MAX_LIMIT].sort[1]
+  end
+
+  def cursor_clauses
+    fail UnimplementedError
+  end
+
+  def cursor_clause_set
+    keys = []
+    Enumerator.new do |y|
+      order_keys.each do |key|
+        y.yield cursor_clause(key, keys).reduce(&:merge)
+        keys << key
+      end
+    end
+  end
+
+  def cursor_clause(key, keys=[])
+    name, direction = key
+    Enumerator.new do |y|
+      keys.each do |name, direction|
+        y.yield clause_for_key(name, 'eq')
+      end
+      y.yield clause_for_key(name, direction)
+    end
+  end
+
+  def clause_for_key key, direction
+    fail UnimplementedError
+  end
+
+  def cursor_object
+    @cursor_object ||= uncached_cursor_object
+  end
+
+  def uncached_cursor_object
+    fail UnimplementedError
+  end
+
+  def render_cursor(data={})
+    ::Base64.urlsafe_encode64(JSON.dump(data))
+  end
+
+  def parsed_cursor
+    JSON.parse(::Base64.urlsafe_decode64(cursor || 'e30='))
+  rescue ArgumentError, JSON::ParserError
+    raise InvalidCursorError
+  end
+
+  def cursor_id
+    cursor_data['id']
+  end
+
+  def cursor_data(overrides={})
+    (parsed_cursor || {}).merge(overrides)
+  end
+
+  class InvalidCursorError < StandardError; end
+end

data/lib/cursory/mongoid.rb

@@ -0,0 +1,55 @@
+require 'cursory/base'
+
+module Cursory
+  class Mongoid < Base
+    def search_type
+      if cursor
+        [:where, cursor_clauses]
+      else
+        [:skip, clamped_offset]
+      end
+    end
+
+    def constrained_search
+      criteria.order_by(order_clause).limit(clamped_limit)
+    end
+
+    def uncached_count
+      criteria.count
+    end
+
+    def model
+      criteria.klass
+    end
+
+    def uncached_search
+      search.to_a
+    end
+
+    def order_clause
+      order_keys.inject({}) { |hash, (key, value)| hash[key] = value; hash }
+    end
+
+    def cursor_clauses
+      if cursor_id
+        { '$or' => cursor_clause_set.to_a }
+      end
+    end
+
+    def clause_for_key key, direction
+      { key.to_sym => { key_for_direction(direction) => cursor_object.send(key) } }
+    end
+
+    def key_for_direction(d)
+      {
+        'eq'   => '$eq',
+        'asc'  => '$gt',
+        'desc' => '$lt'
+      }[d]
+    end
+
+    def uncached_cursor_object
+      criteria.klass.find(cursor_id)
+    end
+  end
+end

data/lib/cursory/version.rb

@@ -0,0 +1,3 @@
+module Cursory
+  VERSION = "0.1.0"
+end

data/lib/cursory.rb

@@ -0,0 +1,5 @@
+require "cursory/version"
+
+module Cursory
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: cursory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon Hildebrandt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Paginator framework with out-of-the-box support for Mongoid.
+email:
+- simon@trunkplatform.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cursory.gemspec
+- lib/cursory.rb
+- lib/cursory/base.rb
+- lib/cursory/mongoid.rb
+- lib/cursory/version.rb
+homepage: https://github.com/Trunkplatform/cursory
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Paginator framework with out-of-the-box support for Mongoid.
+test_files: []