filterer 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a138d652fabbc12e24e17721a99cd126ae35591
-  data.tar.gz: 4d651ac67a3d09a90a4a198abdc2e6b860c8e8d7
+  metadata.gz: 8f2be938199447e226d9ae6551db7dfb601c4c4c
+  data.tar.gz: d3cecf768d8c860468b9cd61069453f0c8cd7c01
 SHA512:
-  metadata.gz: e9accb1c92193354c204b89585a6ba6d75642b9613573acba6dce924bc76ccb4c968b8d3ce5ab4853bc02a0265c858078c282291ad74566e25d5e23fb453096b
-  data.tar.gz: 0cba437c9e6e9a896987c2d927a145c14bd5c989f54db85042915f0c8d86f902a17aeff08e2945ba5c6fc21ca69d5b252518022e60d48bb66246df53c493faac
+  metadata.gz: 0e89f19b32af85c618fa6ac27531d2d7c3d5289af89ba03e4ff6a6fd73f2ba21dc5758388dfa03cb9aab841a8d616f13875f76d67b5e7a03ff06db2e60aaaf00
+  data.tar.gz: 29d5c3bc304a8f43d054a2a558d64f0d0bdec9f466bb3fedfd4aa1c5c8f99adca98a3fc2605d0b63f2d6da3c3469c187894744467e18e6e58ffd7fb3a7b70971

data/lib/filterer/base.rb

@@ -1,23 +1,22 @@
 module Filterer
   class Base
-
     IGNORED_PARAMS = [:page]
 
     attr_accessor :results, :meta, :direction, :sort, :params, :opts
 
-    class << self
-      attr_accessor :sort_options, :per_page_num, :per_page_allow_override
+    class_attribute :sort_options
+    self.sort_options = []
 
-      def sort_options
-        @sort_options ||= []
-      end
+    class_attribute :per_page
+    self.per_page = 20
 
-      def inherited(subclass)
-        %w(sort_options per_page_num per_page_allow_override).each do |x|
-          subclass.send("#{x}=", instance_variable_get("@#{x}"))
-        end
-      end
+    class_attribute :per_page_allow_override
+    self.per_page_allow_override = false
 
+    class_attribute :per_page_max
+    self.per_page_max = 1000
+
+    class << self
       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
@@ -39,16 +38,19 @@ module Filterer
           raise "Tiebreaker can't be a proc."
         end
 
-        sort_options << {
+        self.sort_options += [{
           key: key,
           query_string_or_proc: query_string_or_proc,
           opts: opts
-        }
+        }]
       end
 
-      def per_page(num, opts = {})
-        @per_page_num = num
-        @per_page_allow_override = opts[:allow_override]
+      def count(params = {}, opts = {})
+        self.new(params, { chainable: true }.merge(opts)).results.count
+      end
+
+      def chain(params = {}, opts = {})
+        self.new(params, { chainable: true }.merge(opts)).results
       end
     end
 
@@ -71,35 +73,32 @@ module Filterer
 
     def get_per_page
       if self.class.per_page_allow_override && @params[:per_page].present?
-        @params[:per_page]
+        [@params[:per_page], self.per_page_max].min
       else
-        self.class.per_page_num || 20
+        self.class.per_page
       end
     end
 
     def find_results
       @results = opts.delete(:starting_query) || starting_query
-
-      # Add params
       add_params_to_query
-
       return if @opts[:chainable]
-
-      # Order results
       order_results
-
-      @meta[:total] = @results.unscope(:select).count
-      @meta[:last_page] = [(@meta[:total].to_f / @meta[:per_page]).ceil, 1].max
-      @meta[:page] = [@meta[:last_page], @meta[:page]].min
-
-      return if @opts[:count_only]
+      add_meta
 
       # Add custom meta data if we've defined the method
       @meta.merge!(self.custom_meta_data) if self.respond_to?(:custom_meta_data)
 
+      # Return the paginated results
       @results = @results.limit(@meta[:per_page]).offset((@meta[:page] - 1)*@meta[:per_page])
     end
 
+    def add_meta
+      @meta[:total] = @results.unscope(:select).count
+      @meta[:last_page] = [(@meta[:total].to_f / @meta[:per_page]).ceil, 1].max
+      @meta[:page] = [@meta[:last_page], @meta[:page]].min
+    end
+
     def add_params_to_query
       @params.reject { |k, v| k.in?(IGNORED_PARAMS) }
              .select { |k, v| v.present? }
@@ -113,57 +112,59 @@ module Filterer
     def order_results
       @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
+
+      if !get_sort_option(@sort)
+        @results = @results.order default_sort_sql
+      elsif get_sort_option(@sort)[:query_string_or_proc].is_a?(String)
+        @results = @results.order basic_sort_sql
       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, self)
+        apply_sort_proc
       end
     end
 
+    def default_sort_sql
+      "#{@results.model.table_name}.id ASC"
+    end
+
+    def basic_sort_sql
+      %{
+        #{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
+    end
+
+    def apply_sort_proc
+      sort_key = get_sort_option(@sort)[:key]
+      matches = sort_key.is_a?(Regexp) && @sort.match(sort_key)
+      @results = get_sort_option(@sort)[:query_string_or_proc].call(@results, matches, self)
+    end
+
     def get_sort_option(x)
-      self.class.sort_options.find { |sort_option|
+      self.class.sort_options.detect do |sort_option|
         if sort_option[:key].is_a?(Regexp)
           x.match(sort_option[:key])
         else # String
           x == sort_option[:key]
         end
-      }
+      end
     end
 
     def default_sort_param
-      self.class.sort_options.find { |sort_option|
+      self.class.sort_options.detect do |sort_option|
         sort_option[:opts][:default]
-      }.try(:[], :key)
+      end.try(:[], :key)
     end
 
     def tiebreaker_sort_string
-      self.class.sort_options.find { |sort_option|
+      self.class.sort_options.detect do |sort_option|
         sort_option[:opts][:tiebreaker]
-      }.try(:[], :query_string_or_proc)
+      end.try(:[], :query_string_or_proc)
     end
 
-
     def starting_query
       raise 'You must override this method!'
     end
-
-    def self.count(params = {}, opts = {})
-      filterer = self.new(params, { count_only: true }.merge(opts))
-      return filterer.meta[:total]
-    end
-
-    def self.chain(params = {}, opts = {})
-      filterer = self.new(params, { chainable: true }.merge(opts))
-      return filterer.results
-    end
-
   end
 end

data/lib/filterer/version.rb

@@ -1,3 +1,3 @@
 module Filterer
-  VERSION = "0.3.4"
+  VERSION = '0.4.0'
 end

metadata

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