filterer 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fed029c0db1f3a900c0af648704587166c5d4f6d
-  data.tar.gz: 6576fd8e1596594e5af46270d1bf9403b5ca34c0
+  metadata.gz: 7734d274d4ea4be3fa564c0d94a0b1a6fbb0910f
+  data.tar.gz: 09622d7c585ed55a808810ac358a1a052b5f4da5
 SHA512:
-  metadata.gz: b5e9b5c05cbb35451391cb5ced7f1e74537399a46fee94f56a7948fd966bf4dad7c9c69712cec25d77a722f7405fff9289a6d427be725f5c6e1a5279ff1478a6
-  data.tar.gz: 894a79cbddf677f8a2ac3ba0ce98a9537a07d5bf3cbfe22899dc99f0d2b95be3f744d79a2b0f2e04f2419ac185701711b0c7c35897047a3dcea3e799cf74fd09
+  metadata.gz: ba86f46c95b642b8606fdc5aac56e895c5dc5b4a4920f0be1bcb93a1eecf3b064836518b90e45c8657929819010b29bba5152ac605dbbc963231688b203ad6d4
+  data.tar.gz: 928079d0abddddf7a0c6b15a781332bc0bb52935190df90226852a2b417eeb9cd1f0d7a162d174311ceb41ab5e5850c25276c4e6b8313bace2c4c3347fee6aa0

data/lib/filterer/base.rb

@@ -1,9 +1,51 @@
 module Filterer
   class Base
 
+    IGNORED_PARAMS = [:page]
+
     attr_accessor :results, :meta, :direction, :sort, :params
 
-    IGNORED_PARAMS = [:page]
+    class << self
+      attr_accessor :sort_options
+
+      def sort_options
+        @sort_options ||= []
+      end
+
+      def inherited(subclass)
+        if @sort_options.present?
+          subclass.sort_options = @sort_options
+        end
+      end
+
+      def sort_option(key, query_string_or_proc = nil, opts = {})
+        if query_string_or_proc.is_a?(Hash)
+          opts, query_string_or_proc = query_string_or_proc.clone, nil
+        end
+
+        if !query_string_or_proc
+          if key.is_a?(String)
+            query_string_or_proc = key
+          else
+            raise 'Please provide a query string or a proc.'
+          end
+        end
+
+        if key.is_a?(Regexp) && opts[:default]
+          raise "Default sort option can't have a Regexp key."
+        end
+
+        if query_string_or_proc.is_a?(Proc) && opts[:tiebreaker]
+          raise "Tiebreaker can't be a proc."
+        end
+
+        sort_options << {
+          key: key,
+          query_string_or_proc: query_string_or_proc,
+          opts: opts
+        }
+      end
+    end
 
     def initialize(params = {}, opts = {})
       @params, @opts = params, opts
@@ -54,9 +96,46 @@ module Filterer
     end
 
     def order_results
-      # noop
+      @direction = @params[:direction] == 'desc' ? 'DESC' : 'ASC'
+      @sort = (params[:sort] && get_sort_option(params[:sort])) ? params[:sort] : default_sort_param
+      return unless get_sort_option(@sort)
+
+      if get_sort_option(@sort)[:query_string_or_proc].is_a?(String)
+        @results = @results.order %Q{
+          #{get_sort_option(@sort)[:query_string_or_proc]}
+          #{@direction}
+          #{get_sort_option(@sort)[:opts][:nulls_last] ? 'NULLS LAST' : ''}
+          #{tiebreaker_sort_string ? ',' + tiebreaker_sort_string : ''}
+        }.squish
+      elsif get_sort_option(@sort)[:query_string_or_proc].is_a?(Proc)
+        matches = get_sort_option(@sort)[:key].is_a?(Regexp) ? @sort.match(get_sort_option(@sort)[:key]) : nil
+        @results = get_sort_option(@sort)[:query_string_or_proc].call(@results, matches)
+      end
     end
 
+    def get_sort_option(x)
+      self.class.sort_options.find { |sort_option|
+        if sort_option[:key].is_a?(Regexp)
+          x.match(sort_option[:key])
+        else # String
+          x == sort_option[:key]
+        end
+      }
+    end
+
+    def default_sort_param
+      self.class.sort_options.find { |sort_option|
+        sort_option[:opts][:default]
+      }.try(:[], :key)
+    end
+
+    def tiebreaker_sort_string
+      self.class.sort_options.find { |sort_option|
+        sort_option[:opts][:tiebreaker]
+      }.try(:[], :query_string_or_proc)
+    end
+
+
     def starting_query
       raise 'You must override this method!'
     end

data/lib/filterer/paginator.rb

@@ -3,9 +3,9 @@ module Filterer
 
     attr_reader :pages
 
-    def initialize(searcher)
-      @searcher = searcher
-      return @pages = [1] if @searcher.meta[:last_page] == 1
+    def initialize(filterer)
+      @filterer = filterer
+      return @pages = [1] if @filterer.meta[:last_page] == 1
       push_default_pages
       calculate_additional_pages
       add_breaks
@@ -13,14 +13,14 @@ module Filterer
 
     def push_default_pages
       @pages = [1, 2]
-      push_page(@searcher.meta[:last_page], @searcher.meta[:last_page] - 1)
+      push_page(@filterer.meta[:last_page], @filterer.meta[:last_page] - 1)
     end
 
     def calculate_additional_pages
       offset = 0
-      current_page = @searcher.meta[:page]
+      current_page = @filterer.meta[:page]
 
-      while @pages.length < 11 && ( (current_page - offset >= 1) || (current_page + offset <= @searcher.meta[:last_page]) ) do
+      while @pages.length < 11 && ( (current_page - offset >= 1) || (current_page + offset <= @filterer.meta[:last_page]) ) do
         push_page(current_page - offset, current_page + offset)
         offset += 1
       end
@@ -43,7 +43,7 @@ module Filterer
 
     def push_page(*args)
       args.each do |page|
-        @pages.push(page) unless @pages.include?(page) || (page > @searcher.meta[:last_page]) || (page < 1)
+        @pages.push(page) unless @pages.include?(page) || (page > @filterer.meta[:last_page]) || (page < 1)
       end
     end
 

data/lib/filterer/version.rb

@@ -1,3 +1,3 @@
 module Filterer
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filterer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Adam Becker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-17 00:00:00.000000000 Z
+date: 2013-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails