paginative 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5cef3e31235b6ee8b8e8bd64f29f9702be0e2a0
-  data.tar.gz: 3624c839c406848e43290ced9f17d09c7ac58f0e
+  metadata.gz: b88a52a9b7c22d3a811c3e011020e3b7ea1c624a
+  data.tar.gz: c5b8c8e2f43df8fed6cc57502afc717cad2944eb
 SHA512:
-  metadata.gz: 6e4c301c39d85570c897fee526235594f2ea1e46d0c5f54c5e3911fc6fd3dfeb0a178968ce6b4cf581e06aa6681841f615f7b2ff9e326b6c5cff4a52c11df32f
-  data.tar.gz: 7c136f4ee68fe21d7b1181db71832e7eb0d205d7f6614ee716065caddb69279c1f75388c4bf39a50a0ca5943b0dae0fa23d2835c8d9be8cc9992c9c483994351
+  metadata.gz: f0f7ac4dcf60b1741760d3ba714ed7d9ae2931c46a8b843e89655fbd359ed889329a9818e7026aa7d575c15a0931e95f618c23f8e8ba411fae21ecb56616eaa0
+  data.tar.gz: c0a047e197c29d41642368da7cd4dd12de36db57e412c8d5969bb5278277dae2b7f713a590268c87b405cc85ef66660ca4fd1d3e651dc6ee615ddc9370940575

data/Rakefile

@@ -1,4 +1,5 @@
 begin
+  require 'rubygems'
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'

data/lib/paginative/models/model_extension.rb

@@ -5,6 +5,9 @@ module Paginative
     included do
       include Paginative::OrderingHelpers
 
+      mattr_accessor :paginative_fields
+      @@paginative_fields = {}
+
       def self.by_distance_from(latitude, longitude, distance=0, limit=25)
         return [] unless latitude.present? && longitude.present?
         distance_sql = send(:distance_sql, latitude.to_f, longitude.to_f, {:units => :km, select_bearing: false})
@@ -23,24 +26,98 @@ module Paginative
 
       def self.with_field_from(field="", value="", limit=25, order="asc")
         order ||= "asc"
-        if field.is_a? Array
-          return raise "Wrong number of values. Expected 2, got #{value.try(:length)}. You must pass a value for each field that you are sorting by" unless value.is_a?(Array) && value.length == 2
-            # You can now pass in an array of 'field' params so that you can have a secondary sort order.
-            # This is important if your primary sort field could have duplicate values
-            primary_sort_field = field[0]
-            primary_value = value[0]
-            secondary_sort_field = field[1]
-            secondary_value = value[1]
-            # This allows us to pass in 2 different sort columns and still paginate correctly.
-            return self.order(sanitized_ordering(self.table_name, field, order)).where("#{self.table_name}.#{primary_sort_field} <= ? AND (#{self.table_name}.#{primary_sort_field} != ? OR #{self.table_name}.#{secondary_sort_field} < ?)", primary_value, primary_value, secondary_value) if order.try(:downcase) == "desc"
-
-            self.order(sanitized_ordering(self.table_name, field, order)).where("#{self.table_name}.#{primary_sort_field} >= ? AND (#{self.table_name}.#{primary_sort_field} != ? OR #{self.table_name}.#{secondary_sort_field} > ?)", primary_value, primary_value, secondary_value)
+
+        # Wrap and flatten whatever comes in, if it's a single value, we end up with an array.
+        # If it's an array, stays an array.
+        fields = Array.wrap(field).flatten
+        values = Array.wrap(value).flatten
+        zipped = fields.zip(values)
+        fields, values = prune_fields(zipped).transpose
+
+        q = self.all
+        if fields.present? && fields.any?
+          return raise "Wrong number of values. Expected 2, got #{values.try(:length)}. You must pass a value for each field that you are sorting by" unless values.length <= 2 && values.length == fields.length
+
+          mapped_fields = map_fields(fields)
+          q = q.order(sanitized_ordering(self.table_name, mapped_fields, order))
+
+          mapped_fields.each_with_index do |field, idx|
+            if idx == 0
+              value = values[idx]
+              operator = sort_operator(idx, mapped_fields.count, order)
+
+              q = q.where("#{field} #{operator} ?", value)
+            else
+              previous_field = mapped_fields[idx - 1]
+              previous_value = values[idx - 1]
+              value = values[idx]
+              operator = sort_operator(idx, mapped_fields.count, order)
+
+              q = q.where("#{previous_field} != ? OR #{field} #{operator} ?", previous_value, value)
+            end
+          end
+        end
+
+        return q.limit(limit)
+      end
+
+      private
+
+      # Steps through the provided paginated fields, zipped with their values, and removes those not
+      # in the `paginative_fields` hash as specified with `allow_paginative_on`.
+      def self.prune_fields(zipped)
+        zipped.select{ |f, v| self.paginative_fields.has_key? f.to_sym }.tap do |pruned|
+          unless pruned.nil?
+            items = zipped.map(&:first) - pruned.map(&:first)
+            Rails.logger.warn "Paginative ignored unpermitted field: #{items}"
+          end
+        end
+      end
+
+      # Takes the pruned fields as an array, and returns the mapped versions.
+      def self.map_fields(fields)
+        fields.map{ |f| self.paginative_fields[f.to_sym] }
+      end
+
+      # Returns the appropriate order given sort direction and current field in the collection.
+      # We don't want to use inclusive paging if we are at the last field being paginated, so either lt or gt is used.
+      def self.sort_operator(index, count, direction)
+        if direction.try(:downcase) == "desc"
+          index < (count - 1) ? '<=' : '<'
+        else
+          index < (count - 1) ? '>=' : '>'
+        end
+      end
+    end
+
+    module ClassMethods
+      # Sets the paginative fields set of the class to the specified columns.
+      def allow_paginative_on(*mappings)
+        self.paginative_fields = process_fields(mappings)
+      end
+
+      private
+
+      # Process specified mappings to either scope to the table name of the current class
+      # or to use the mappings provided.
+      def process_fields(mappings)
+        result = {}
+
+        mappings.each do |mapping|
+          if mapping.is_a?(Hash)
+            result.merge!(mapping)
           else
-            value = value.to_i if self.column_for_attribute(field).type == :integer
-            return self.order(sanitized_ordering(self.table_name, field, order)).where("#{self.table_name}.#{field} < ?", value).limit(limit) if order.try(:downcase) == "desc"
-            self.order(sanitized_ordering(self.table_name, field, order)).where("#{self.table_name}.#{field} > ?", value).limit(limit)
+            result[mapping] = self_map(mapping)
           end
         end
+
+        result
+      end
+
+      # Returns a string scoping the specified field to the current class' table.
+      def self_map(field)
+        "#{self.table_name}.#{field}"
       end
     end
   end
+end

data/lib/paginative/models/ordering_helpers.rb

@@ -3,20 +3,13 @@ module Paginative
     extend ActiveSupport::Concern
 
     included do
-      def self.sanitized_ordering(table_name, field, order)
-        if field.is_a? Array
-          return raise "Wrong number of sorting fields. Expected 2, got #{field.length}. If you want to sort by a singular field please pass field argument as a string rather than an array." unless field.length == 2
-
-          "#{table_name}.#{sanitize_column(field[0])} #{sanitize_column_direction(order)}, #{table_name}.#{sanitize_column(field[1])} #{sanitize_column_direction(order)}"
-        else
-          "#{table_name}.#{sanitize_column(field)} #{sanitize_column_direction(order)}"
-        end
+      def self.sanitized_ordering(table_name, fields, order)
+        fields.map do |field|
+          "#{field} #{sanitize_column_direction(order)}"
+        end.join(', ')
       end
 
       private
-      def self.sanitize_column(column)
-        self.column_names.include?(column) ? column : "created_at"
-      end
 
       def self.sanitize_column_direction(direction)
         direction = direction.upcase

data/lib/paginative/version.rb

@@ -1,3 +1,3 @@
 module Paginative
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/spec/dummy/app/models/joint_model.rb

@@ -0,0 +1,2 @@
+class JointModel < ActiveRecord::Base
+end

data/spec/dummy/app/models/test_model.rb

@@ -2,4 +2,14 @@ class TestModel < ActiveRecord::Base
   include Paginative::ModelExtension
 
   reverse_geocoded_by :latitude, :longitude
+
+  # Associations
+  has_many :joint_models
+
+  class << self
+    def joint
+      joins(:joint_models).select('test_models.*, joint_models.created_at')
+        .order('joint_models.created_at DESC')
+    end
+  end
 end

data/spec/dummy/db/migrate/20150922072155_create_joint_models.rb

@@ -0,0 +1,10 @@
+class CreateJointModels < ActiveRecord::Migration
+  def change
+    create_table :joint_models do |t|
+      t.string :name
+      t.references :test_model, index: true
+
+      t.timestamps null: false
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -9,17 +9,26 @@
 # from scratch. The latter is a flawed and unsustainable approach (the more migrations
 # you'll amass, the slower it'll run and the greater likelihood for issues).
 #
-# It's strongly recommended to check this file into your version control system.
+# It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20140416035443) do
+ActiveRecord::Schema.define(version: 20150922072155) do
 
-  create_table "test_models", :force => true do |t|
+  create_table "joint_models", force: :cascade do |t|
+    t.string   "name"
+    t.integer  "test_model_id"
+    t.datetime "created_at",    null: false
+    t.datetime "updated_at",    null: false
+  end
+
+  add_index "joint_models", ["test_model_id"], name: "index_joint_models_on_test_model_id"
+
+  create_table "test_models", force: :cascade do |t|
     t.string   "name"
     t.string   "address"
     t.float    "latitude"
     t.float    "longitude"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
 
 end

data/spec/dummy/spec/factories/joint_models.rb

@@ -0,0 +1,6 @@
+# Read about factories at https://github.com/thoughtbot/factory_girl
+
+FactoryGirl.define do
+  factory :joint_model do
+  end
+end

data/spec/factories/paginative_joint_models.rb

@@ -0,0 +1,7 @@
+# Read about factories at https://github.com/thoughtbot/factory_girl
+
+FactoryGirl.define do
+  factory :joint_model, class: 'JointModel' do
+    sequence(:name) { |n| "#{("a".."zzz").to_a[n]}" }
+  end
+end

data/spec/models/paginative/test_model_spec.rb

@@ -4,10 +4,7 @@ describe TestModel do
 
   before :each do
     TestModel.class_eval do
-      include Paginative::ModelExtension
-
-      reverse_geocoded_by :latitude, :longitude
-      after_validation :reverse_geocode          # auto-fetch coordinates
+      allow_paginative_on :id, :latitude, :longitude, :name, :address, :created_at
     end
   end
 
@@ -53,7 +50,6 @@ describe TestModel do
   end
 
   context "by name" do
-
     it "is valid" do
       model = FactoryGirl.create(:test_model)
 
@@ -81,6 +77,15 @@ describe TestModel do
   end
 
   context "By distance" do
+    before :each do
+      TestModel.class_eval do
+        include Paginative::ModelExtension
+
+        allow_paginative_on :latitude, :longitude
+        reverse_geocoded_by :latitude, :longitude
+        after_validation :reverse_geocode
+      end
+    end
 
     it "limits the results" do
       models = FactoryGirl.create_list(:test_model, 30)
@@ -150,4 +155,80 @@ describe TestModel do
       expect(TestModel.with_field_from(["latitude", "longitude"], [150, 12])).to eq [@third, @fourth]
     end
   end
+
+  context 'restricted fields' do
+    before do
+      TestModel.paginative_fields = { name: 'test_models.name' }
+
+      @first = FactoryGirl.create(:test_model, name: 'abc', address: 'abc')
+      @second = FactoryGirl.create(:test_model, name: 'abc', address: 'bcd')
+      @third = FactoryGirl.create(:test_model, name: 'abc', address: 'cde')
+      @fourth = FactoryGirl.create(:test_model, name: 'abc', address: 'def')
+    end
+
+    it 'ignores unpermitted fields with a warning' do
+      expect(Rails.logger).to receive(:warn)
+
+      TestModel.with_field_from('address', 'bcd')
+    end
+
+    it 'prunes the fields to those only permitted' do
+      expect(TestModel).to receive(:map_fields).with(['name']) { ['test_models.name'] }
+      TestModel.with_field_from(["name", "address"], ["abc", "bcd"])
+    end
+
+    it 'returns the original scope and ordering, still limited' do
+      result = TestModel.with_field_from('address', 'bcd', 2)
+      expect(result).to eq [@first, @second]
+    end
+  end
+
+  describe 'restricting fields' do
+    before do
+      TestModel.paginative_fields = {}
+    end
+
+    context 'no fields' do
+      it 'defaults to no paginative fields' do
+        expect(TestModel.paginative_fields).to be_empty
+      end
+    end
+
+    context 'self mapped columns' do
+      before do
+        TestModel.class_eval do
+          allow_paginative_on :created_at
+        end
+      end
+
+      it 'sets the paginative fields to self mappings' do
+        expect(TestModel.paginative_fields).to eq({ created_at: 'test_models.created_at' })
+      end
+    end
+
+    context 'join mapped columns' do
+      before do
+        TestModel.class_eval do
+          allow_paginative_on created_at: 'other_models.created_at'
+        end
+      end
+
+      it 'sets the paginative fields to the specified mapping' do
+        expect(TestModel.paginative_fields).to eq({ created_at: 'other_models.created_at' })
+      end
+    end
+  end
+
+  describe 'paginating joint fields' do
+    before do
+      TestModel.paginative_fields = { created_at: 'joint_models.created_at' }
+
+      @first = FactoryGirl.create(:test_model, name: 'abc', address: 'abc', joint_models: [FactoryGirl.build(:joint_model, created_at: Time.now)])
+      @second = FactoryGirl.create(:test_model, name: 'abc', address: 'bcd', joint_models: [FactoryGirl.build(:joint_model, created_at: 5.minutes.ago)])
+    end
+
+    it 'can be paginated on the secondary column (strings)' do
+      expect(TestModel.joint.with_field_from('created_at', 3.minutes.ago, 24, 'DESC')).to eq [@second]
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ require 'rspec/rails'
 require 'rspec/autorun'
 require 'factory_girl_rails'
 require 'database_cleaner'
+require 'pry'
 
 Rails.backtrace_cleaner.remove_silencers!
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paginative
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Isaac Norman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-28 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -136,6 +136,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: After spending a lot of time screwing around with orphaned objects and
   every other problem that pagination causes, this is the solution
 email:
@@ -151,11 +179,8 @@ files:
 - app/assets/stylesheets/paginative/application.css
 - app/controllers/paginative/application_controller.rb
 - app/helpers/paginative/application_helper.rb
-- app/models/paginative/test_model.rb
 - app/views/layouts/paginative/application.html.erb
 - config/routes.rb
-- db/migrate/20140415060518_create_paginative_test_models.rb
-- db/migrate/20140416020706_add_address_to_test_models.rb
 - lib/paginative.rb
 - lib/paginative/engine.rb
 - lib/paginative/models/model_extension.rb
@@ -169,6 +194,7 @@ files:
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/joint_model.rb
 - spec/dummy/app/models/test_model.rb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/bin/bundle
@@ -193,13 +219,14 @@ files:
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
 - spec/dummy/db/migrate/20140416035443_create_test_models.rb
+- spec/dummy/db/migrate/20150922072155_create_joint_models.rb
 - spec/dummy/db/schema.rb
-- spec/dummy/db/test.sqlite3
-- spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
+- spec/dummy/spec/factories/joint_models.rb
+- spec/factories/paginative_joint_models.rb
 - spec/factories/paginative_test_models.rb
 - spec/models/paginative/test_model_spec.rb
 - spec/spec_helper.rb
@@ -232,6 +259,7 @@ test_files:
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/joint_model.rb
 - spec/dummy/app/models/test_model.rb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/bin/bundle
@@ -256,15 +284,16 @@ test_files:
 - spec/dummy/config/secrets.yml
 - spec/dummy/config.ru
 - spec/dummy/db/migrate/20140416035443_create_test_models.rb
+- spec/dummy/db/migrate/20150922072155_create_joint_models.rb
 - spec/dummy/db/schema.rb
-- spec/dummy/db/test.sqlite3
-- spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/Rakefile
 - spec/dummy/README.rdoc
+- spec/dummy/spec/factories/joint_models.rb
+- spec/factories/paginative_joint_models.rb
 - spec/factories/paginative_test_models.rb
 - spec/models/paginative/test_model_spec.rb
 - spec/spec_helper.rb