cursory 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 229ca42db3396db3fcba7861d4ca9190add686d8
-  data.tar.gz: cd3cef0295e37f7bc030434f669b781f0382094b
+  metadata.gz: 2bbbba609be8dd669f16a07b29e17622af6ea8b6
+  data.tar.gz: 7aa3758c6ff1f9eb96a9af76a10aa465418067af
 SHA512:
-  metadata.gz: b6cce56a0efe576138bff969e640dfe82f6cb54da3d981b586cfbfe67f64b3436a6a82e2ef286ee0acdcd41ae2a9ac2c38bc1ff015f26599d76e356ccacc81cc
-  data.tar.gz: 1fa130538648970422324f06a5012080386bf5ecec568dfa7ab58d42cda60935c4c0a3a6b51fd6a9a3095fe856087366e700464fb0c30ebcbe0d0b25133daa97
+  metadata.gz: e26cdde6e018c71848cd41810c3fb92d0e6838892a623765e5569c1e9034db860b40fba6baad7a091f0a0af4f11fc27020e34ab6f10f1cca950a58ef6358d3d6
+  data.tar.gz: 26b5e67ce33352c9f324d84d205b57ca0bab40705dbfe0719e8d1957d9528ebc19bcffa452737b598b8dcae19538eee148fa29ed5a1d51ee2507e4f9582fad53

data/lib/cursory/base.rb

@@ -1,155 +1,157 @@
 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
+module Cursory
+  class 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
+    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
-  end
 
-  def search
-    constrained_search.send(*search_type)
-  end
+    def search
+      constrained_search.send(*search_type)
+    end
 
-  def search_type
-    fail UnimplementedError
-  end
+    def search_type
+      fail UnimplementedError
+    end
 
-  def clamped_offset
-    [0, offset.to_i].max
-  end
+    def clamped_offset
+      [0, offset.to_i].max
+    end
 
-  def constrained_search
-    fail UnimplementedError
-  end
+    def constrained_search
+      fail UnimplementedError
+    end
 
-  def search_results
-    @results ||= uncached_search
-  end
+    def search_results
+      @results ||= uncached_search
+    end
 
-  def uncached_search
-    fail UnimplementedError
-  end
+    def uncached_search
+      fail UnimplementedError
+    end
 
-  def current_cursor
-    cursor || render_cursor
-  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 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)
+    def next_cursor
+      if record_for_next_cursor
+        render_cursor cursor_data(id: record_for_next_cursor.id.to_s)
+      end
     end
-  end
 
-  def count
-    @count ||= criteria.count
-  end
+    def count
+      @count ||= criteria.count
+    end
 
-  def uncached_count
-    fail UnimplementedError
-  end
+    def uncached_count
+      fail UnimplementedError
+    end
 
-  def sort_keys
-    sort || model_sort || ''
-  end
+    def sort_keys
+      sort || model_sort || ''
+    end
 
-  def model
-    fail UnimplementedError
-  end
+    def model
+      fail UnimplementedError
+    end
 
-  def model_sort
-    model.respond_to?(:default_sort_key) && model.default_sort_key
-  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 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 decompose_order_key(k)
+      [ k.gsub(/\A[-+]?/,'').to_sym, k.start_with?('-') ? 'desc' : 'asc' ]
+    end
 
-  def order_clause
-    fail UnimplementedError
-  end
+    def order_clause
+      fail UnimplementedError
+    end
 
-  def clamped_limit
-    [1, limit.to_i, MAX_LIMIT].sort[1]
-  end
+    def clamped_limit
+      [1, limit.to_i, MAX_LIMIT].sort[1]
+    end
 
-  def cursor_clauses
-    fail UnimplementedError
-  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
+    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
-  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')
+    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
-      y.yield clause_for_key(name, direction)
     end
-  end
 
-  def clause_for_key key, direction
-    fail UnimplementedError
-  end
+    def clause_for_key key, direction
+      fail UnimplementedError
+    end
 
-  def cursor_object
-    @cursor_object ||= uncached_cursor_object
-  end
+    def cursor_object
+      @cursor_object ||= uncached_cursor_object
+    end
 
-  def uncached_cursor_object
-    fail UnimplementedError
-  end
+    def uncached_cursor_object
+      fail UnimplementedError
+    end
 
-  def render_cursor(data={})
-    ::Base64.urlsafe_encode64(JSON.dump(data))
-  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 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_id
+      cursor_data['id']
+    end
 
-  def cursor_data(overrides={})
-    (parsed_cursor || {}).merge(overrides)
-  end
+    def cursor_data(overrides={})
+      (parsed_cursor || {}).merge(overrides)
+    end
 
-  class InvalidCursorError < StandardError; end
+    class InvalidCursorError < StandardError; end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cursory
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Simon Hildebrandt