cursored 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ae0a3f8e6c4e971ccd13824fb7116260c94f02c
+  data.tar.gz: 0b5214af83c7b3d8079f97a064e9019dddf24975
+SHA512:
+  metadata.gz: 2221a85991e56b949f7a2e6e893018c6e8ecc9394765a7e1c51b252decfdd7cef9e705f432d7fc91b795b8048f218a4af2b785f2005bf819c307cf87f8c2428d
+  data.tar.gz: 77c8a5380ad559c1cef20bc18db37cf0f2bdbbe151b62e8a6801b14a02cf5e83cb5cc9cb10c012ed21373165fae9af2c5d810ec59f669de8da7b75886db11e85

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jason Kriss
+
+MIT License
+
+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,39 @@
+# Cursored
+
+Super simple cursor-based pagination.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cursored'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cursored
+
+Finally:
+
+    $ rails g cursored:install
+
+## Usage
+
+Simply use `render_cursored` in your controller actions:
+
+```ruby
+def index
+  render_cursored(Item.all)
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/jasonkriss/cursored/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/cursored.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cursored/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cursored"
+  spec.version       = Cursored::VERSION
+  spec.authors       = ["Jason Kriss"]
+  spec.email         = ["jasonkriss@gmail.com"]
+  spec.summary       = %q{Super simple cursor-based pagination.}
+  spec.homepage      = "https://github.com/jasonkriss/cursored"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/cursored.rb

@@ -0,0 +1,7 @@
+require 'cursored/version'
+require 'cursored/configuration'
+require 'cursored/controller'
+
+module Cursored
+
+end

data/lib/cursored/collection.rb

@@ -0,0 +1,38 @@
+module Cursored
+  class Collection
+    def initialize(relation, opts = {})
+      @relation = relation
+      @limit = opts.fetch(:limit, Cursored.config.limit)
+      @cursor = opts[:cursor]
+    end
+
+    def records
+      padded_records[0..(limit - 1)]
+    end
+
+    def next
+      records.last.send(Cursored.config.field) if has_more?
+    end
+
+    private
+    attr_reader :relation, :limit, :cursor
+
+    def padded_limit
+      @padded_limit ||= limit + 1
+    end
+
+    def padded_records
+      @padded_records ||= fetch_padded_records
+    end
+
+    def fetch_padded_records
+      field = Cursored.config.field
+      padded = relation.order(field => :desc).limit(padded_limit)
+      cursor ? padded.where("#{relation.table_name}.#{field} < ?", cursor) : padded
+    end
+
+    def has_more?
+      padded_records.length == padded_limit
+    end
+  end
+end

data/lib/cursored/configuration.rb

@@ -0,0 +1,18 @@
+module Cursored
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :field, :limit
+
+    def initialize
+      @field = :id
+      @limit = 25
+    end
+  end
+end

data/lib/cursored/controller.rb

@@ -0,0 +1,21 @@
+require 'cursored/collection'
+
+module Cursored
+  module Controller
+    extend ActiveSupport::Concern
+
+    protected
+    def render_cursored(relation, opts = {})
+      options = opts.merge(params.slice(:cursor))
+      collection = Cursored::Collection.new(relation, options)
+
+      render({
+        status: :ok,
+        json: collection.records,
+        meta: {
+          cursor: collection.next
+        }
+      })
+    end
+  end
+end

data/lib/cursored/version.rb

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

data/lib/generators/cursored/install/install_generator.rb

@@ -0,0 +1,17 @@
+module Cursored
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_cursored_initializer
+        copy_file 'cursored.rb', 'config/initializers/cursored.rb'
+      end
+
+      def inject_cursored_into_application_controller
+        inject_into_class "app/controllers/application_controller.rb", ApplicationController do
+          "  include Cursored::Controller\n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/cursored/install/templates/cursored.rb

@@ -0,0 +1,4 @@
+Cursored.configure do |config|
+  config.field = :id
+  config.limit = 25
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: cursored
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Kriss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: 
+email:
+- jasonkriss@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cursored.gemspec
+- lib/cursored.rb
+- lib/cursored/collection.rb
+- lib/cursored/configuration.rb
+- lib/cursored/controller.rb
+- lib/cursored/version.rb
+- lib/generators/cursored/install/install_generator.rb
+- lib/generators/cursored/install/templates/cursored.rb
+homepage: https://github.com/jasonkriss/cursored
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Super simple cursor-based pagination.
+test_files: []