yap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a6e5086f1ca35d0aaf0fadbc47d90b07734bd2b
+  data.tar.gz: 42d6f6430addc6accecfb55958c689528aa11131
+SHA512:
+  metadata.gz: 015d9317569706f7fe83ac1e877b4c750480fd05e09d79f048df30083b505448f5d6f021d588dae713a0fc7bdb89d7fca278989e56996af33e90f5fd32fa22bc
+  data.tar.gz: 3c98bd37fa8c4988dec2e2cd8a4cdac610f3c179f92d4c884e35f46e14559403bfdc708407f8f564577197fad4dfea9436d25dff35033ae694929e2336c807ed

data/lib/yap.rb

@@ -0,0 +1,70 @@
+require 'active_support/concern'
+
+##
+# Include into model to make it paginatable. The paginate scope takes a hash as only parameter. All options are optional
+# and can be combined arbitrarily.
+#
+#   User.paginate         # => Page 1 with default order and size.
+#   User.paginate(params) # => Use this in controller to pass query parameters.
+#   User.paginate(
+#       page:       1,
+#       per_page:   10,
+#       sort:       :id,
+#       direction:  :asc
+#   )                     # => Invocation with custom options.
+#
+# @param [Hash] the parameters used for pagination (:page, :per_page, :sort, :direction)
+#
+module Yap
+  extend ActiveSupport::Concern
+
+  DEFAULTS = Struct.new(:page, :per_page, :sort, :direction)
+                 .new(1, 10, :id, :asc)
+
+  def self.configure
+    raise ArgumentError, 'No block given.' unless block_given?
+    yield(DEFAULTS)
+  end
+
+  included do
+    scope :paginate, -> (params = {}) {
+      page, per_page, sort, direction = extract_pagination_params(params)
+      limit(per_page).offset((page-1)*per_page).order(sort => direction)
+    }
+
+    private
+
+    def self.extract_pagination_params(params)
+      page = params[:page].present? ? extract_number(params[:page]) : DEFAULTS.page
+      per_page = params[:per_page].present? ? extract_number(params[:per_page]) : DEFAULTS.per_page
+      sort = params[:sort].present? ? extract_sort(params[:sort]) : DEFAULTS.sort
+      direction = params[:direction].present? ? extract_direction(params[:direction]) : DEFAULTS.direction
+
+      return page, per_page, sort, direction
+    end
+
+    def self.extract_number(number)
+      begin
+        number = Integer(number)
+      rescue
+        raise PaginationError.new("'#{number}' is not a valid number.")
+      end
+
+      raise PaginationError.new('Only positive numbers are accepted.') unless number > 0
+      number
+    end
+
+    def self.extract_sort(sort)
+      raise PaginationError.new("Cannot sort by '#{sort}'.") unless column_names.include? sort.to_s
+      sort
+    end
+
+    def self.extract_direction(direction)
+      dir = direction.downcase.to_sym
+      raise PaginationError.new("'#{direction}' is not a valid direction. Use 'asc' or 'desc'.") unless [:asc, :desc].include? dir
+      dir
+    end
+  end
+
+  class PaginationError < StandardError; end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: yap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Finn Glöe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Yet another paginator for Ruby on Rails, which adds a paginate scope
+  to your ActiveRecords.
+email: finn.gloee@1und1.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/yap.rb
+homepage: http://rubygems.org/gems/yap
+licenses:
+- GPL v2
+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: Yet another paginator for Ruby on Rails
+test_files: []