sorted 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc893cb851e4226ef3548dcba99ae5e44592d9c6
-  data.tar.gz: 9ee8b89780d7f29798643338f186846e58756508
+  metadata.gz: 1b665b8a96ecf9464b3c3845dae2edbdf3a8fef8
+  data.tar.gz: f698bb91b0fa131eef2928a89d8125f19813dde9
 SHA512:
-  metadata.gz: 1f0d30cbf53dfabf7d54f46c391218dd81674758655decf875531c014111ec2f1c6841c0a6e73af56249b41d8538525f064744574ece3e4e717b96d59eb5de86
-  data.tar.gz: 3f95d6fb84711892c6838a529f9caef5c006279322576c7dacd3ac2b0eb2e9167642880974f95983e82ebf64d8895828c3b303435fc22464610b68fac3148fca
+  metadata.gz: d4cd81b4bde74202c5ab1a6e4f6bce6696fc882c78392dcba6a59539e658819dcc8080683a2da19b939028a55f4c76be7f3533e35092944278151b4bde1c25b6
+  data.tar.gz: a5e122727f4e42a6756b5b08685e8cff49db754446bcd95f8e00d205fdf289a4699a46ee81d5d3e2d36846411532771b32a7b0d21b545f8a1a6a1b3dc1946474

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: .rubocop_todo.yml
+
+Style/Blocks:
+  Enabled: false
+
+Style/WordArray:
+  MinSize: 2

data/.rubocop_todo.yml

@@ -0,0 +1,50 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-12-14 20:28:26 +1100 using RuboCop version 0.28.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 5
+Lint/UselessAssignment:
+  Enabled: false
+
+# Offense count: 2
+Lint/Void:
+  Enabled: false
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 29
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 22
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 177
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 18
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 14
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 5
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/For:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MaxLineLength.
+Style/IfUnlessModifier:
+  Enabled: false

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.5
   - jruby-19mode
   - ruby-head
 

data/README.md

@@ -1,9 +1,50 @@
 # sorted
 
-[![Build Status](https://travis-ci.org/mynameisrufus/sorted.png?branch=master)](https://travis-ci.org/mynameisrufus/sorted)
+[![Build Status](https://travis-ci.org/mynameisrufus/sorted.svg?branch=master)](https://travis-ci.org/mynameisrufus/sorted)
+[![Gem Version](https://badge.fury.io/rb/sorted.svg)](http://badge.fury.io/rb/sorted)
 
-Sorted is a simple object that will take an sql order string and a url
-sort string to let you sort large datasets over many pages (using 
+Sorted at it's core is a set of objects that let you sort many different
+attributes in weird and wonderful ways.
+
+## Example
+
+The secret sauce is the `Sorted::Set` object, in this example we 'toggle' email:
+
+```ruby
+a = Sorted::Set.new([['email', 'asc'], ['name', 'asc']])
+b = Sorted::Set.new([['email', 'asc'], ['phone', 'asc']])
+
+s = a.direction_intersect(b)
+
+s.uniq.to_a #=> [['email', 'desc'], ['phone', 'asc'], ['name', 'asc']]
+```
+
+The best way to think about this is to imagine a spreed sheet and what happens
+when you sort by various columns, `Sorted::Set` pretty much just does that.
+
+## Parsers/Encoders
+
+Parsers return a `Sorted::Set` that can then be used by an encoder:
+
+```ruby
+set = Sorted::URIQuery.parse('name_asc!email_asc')
+Sorted::SQLQuery.encode(set) #=> 'name ASC email ASC'
+```
+
+Currently implemented:
+
+* `Sorted::SQLQuery`
+* `Sorted::URIQuery`
+
+TODO:
+
+* `Sorted::JSONQuery` (Mongoid)
+
+## Rails
+
+Sorted comes with `ActionView` helpers and ORM scopes out of the box.
+
+The ORM scopes will let you sort large datasets over many pages (using
 [will_paginate](https://github.com/mislav/will_paginate) or 
 [kaminari](https://github.com/amatsuda/kaminari)) without losing state.
 
@@ -18,12 +59,6 @@ link_to_sorted "Email", :email
 Works the same as the `link_to` method except a second argument for the
 sort attribute is needed.
 
-### Ruby 1.8.7 Rails 3.x
-
-```ruby
-gem 'sorted', '~> 0.4.3'
-```
-
 ### Model
 
 Using the `sorted` method with the optional default order argument:
@@ -32,12 +67,14 @@ Using the `sorted` method with the optional default order argument:
 @users = User.sorted(params[:sort], "email ASC").page(params[:page])
 ```
 
-### Rubies
+A `resorted` method is also available and works the same way as the `reorder` method in Rails.
+It forces the order to be the one passed in:
 
-* MRI 1.9.3, 2.0.0.
-* JRuby 1.9 mode
+```ruby
+@users = User.order(:id).sorted(nil, 'name DESC').resorted(params[:sort], 'email ASC')
+```
 
-### ORMs
+## Supported ORMs
 
 * ActiveRecord
 * Mongoid

data/Rakefile

@@ -1,18 +1,18 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rubocop/rake_task'
 require 'rspec/core'
 require 'rspec/core/rake_task'
+require 'rdoc/task'
+require 'sorted'
+
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-task :default => "spec:all"
+RuboCop::RakeTask.new
 
-require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  require 'sorted/version'
-
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "sorted #{Sorted::VERSION}"
   rdoc.rdoc_files.include('README*')
@@ -20,7 +20,7 @@ Rake::RDocTask.new do |rdoc|
 end
 
 namespace :spec do
-  desc "Run Tests against all ORMs"
+  desc 'Run Tests against all ORMs'
   task :all do
     %w(active_record_40 mongoid_30).each do |gemfile|
       sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle --quiet"
@@ -28,3 +28,21 @@ namespace :spec do
     end
   end
 end
+
+task :benchmark do
+  require 'benchmark'
+
+  sort   = 'email_desc!name_desc'
+  order  = 'email ASC, phone ASC, name DESC'
+
+  n = 50_000
+  Benchmark.bm do |x|
+    x.report(:lazy) { for i in 1..n; Sorted::Parser.new(sort, order); end }
+    x.report(:to_hash) { for i in 1..n; Sorted::Parser.new(sort, order).to_hash; end }
+    x.report(:to_sql) { for i in 1..n; Sorted::Parser.new(sort, order).to_sql; end }
+    x.report(:to_a) { for i in 1..n; Sorted::Parser.new(sort, order).to_a; end }
+    x.report(:toggle) { for i in 1..n; Sorted::Parser.new(sort, order).toggle; end }
+  end
+end
+
+task default: ['rubocop', 'spec:all']

data/gemfiles/active_record_40.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/rufuspost/Projects/ruby/gems/sorted
   specs:
-    sorted (1.0.0)
+    sorted (1.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -33,6 +33,9 @@ GEM
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
     arel (4.0.1)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
     atomic (1.1.14)
     atomic (1.1.14-java)
     builder (3.1.4)
@@ -42,6 +45,10 @@ GEM
     jdbc-sqlite3 (3.7.2.1)
     minitest (4.7.5)
     multi_json (1.8.2)
+    parser (2.2.0.pre.8)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
@@ -50,6 +57,7 @@ GEM
       activesupport (= 4.0.0)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
+    rainbow (2.0.0)
     rake (10.1.0)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
@@ -66,6 +74,14 @@ GEM
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
+    rubocop (0.28.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.7, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.0)
+    slop (3.6.0)
     sqlite3 (1.3.8)
     thor (0.18.1)
     thread_safe (0.1.3)
@@ -88,5 +104,6 @@ DEPENDENCIES
   rake
   rspec (>= 2.0.0)
   rspec-rails (>= 2.0)
+  rubocop (>= 0.28)
   sorted!
   sqlite3 (>= 1.3.5)

data/gemfiles/mongoid_30.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    sorted (1.0.0)
+    sorted (1.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -24,6 +24,9 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
     bson (2.3.0)
     bson (2.3.0-java)
     builder (3.2.2)
@@ -45,6 +48,10 @@ GEM
       optionable (~> 0.2.0)
     optionable (0.2.0)
     origin (2.1.1)
+    parser (2.2.0.pre.8)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
@@ -53,6 +60,7 @@ GEM
       activesupport (= 4.1.4)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
+    rainbow (2.0.0)
     rake (10.3.2)
     rspec (3.0.0)
       rspec-core (~> 3.0.0)
@@ -74,6 +82,14 @@ GEM
       rspec-mocks (~> 3.0.0)
       rspec-support (~> 3.0.0)
     rspec-support (3.0.2)
+    rubocop (0.28.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.7, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.0)
+    slop (3.6.0)
     thor (0.19.1)
     thread_safe (0.3.4)
     thread_safe (0.3.4-java)
@@ -93,4 +109,5 @@ DEPENDENCIES
   rake
   rspec (>= 2.0.0)
   rspec-rails (>= 2.0)
+  rubocop (>= 0.28)
   sorted!

data/lib/sorted.rb

@@ -1,8 +1,189 @@
 require 'sorted/parser'
 
 module Sorted
+  class Set
+    include Enumerable
+
+    def initialize(set = [])
+      @set = set
+    end
+
+    def each(&block)
+      @set.each(&block)
+    end
+
+    ##
+    # Gets the keys from the array pairs
+    #
+    #   set = [["email", "name"], ["desc", "desc"]]
+    #   set.transpose #=> [["email", "name"], ["desc", "desc"]]
+    #   set.transpose.first #=> ["email", "name"]
+
+    def keys
+      @set.transpose.first || []
+    end
+
+    ##
+    # Returns a resulting set with specific keys flipped
+    #
+    #   a = Sorted::Set.new([['email', 'asc'], ['name', 'asc']])
+    #   b = Sorted::Set.new([['email', 'asc'], ['phone', 'asc']])
+    #   s = a.direction_intersect(b)
+    #   s.to_a #=> [['email', 'desc'], ['phone', 'asc'], ['name', 'asc']]
+
+    def direction_intersect(other)
+      self.class.new.tap do |memo|
+        unless other.keys.empty?
+          a(memo, other)
+          b(memo, other)
+        end
+        c(memo)
+        d(memo, other)
+      end
+    end
+
+    def -(other)
+      self.class.new.tap do |memo|
+        each do |a|
+          b = other.assoc(a.first)
+          next if b
+          memo << a
+        end
+      end
+    end
+
+    def +(other)
+      self.class.new(@set + other.to_a)
+    end
+
+    def <<(a)
+      self.class.new(@set << a)
+    end
+
+    def uniq
+      self.class.new(@set.uniq)
+    end
+
+    def assoc(o)
+      @set.assoc(o)
+    end
+
+    def at(i)
+      @set.at(i)
+    end
+
+    def to_a
+      @set
+    end
+
+    def to_hash
+      @set.inject({}) { |a, e| a.merge(Hash[e[0], e[1]]) }
+    end
+
+    private
+
+    # If the order of keys match upto the size of the set then flip them
+    def a(memo, other)
+      if keys == other.keys.take(keys.size)
+        keys.each do |order|
+          if other.keys.include?(order)
+            memo << [order, flip_direction(other.assoc(order).last)]
+          end
+        end
+      else
+        keys.each do |order|
+          if other.keys.include?(order)
+            memo << other.assoc(order)
+          end
+        end
+      end
+    end
+
+    # Add items from other that are common and not already added
+    def b(memo, other)
+      other.keys.each do |sort|
+        if keys.include?(sort) && !memo.keys.include?(sort)
+          memo << other.assoc(sort)
+        end
+      end
+    end
+
+    # Add items not in memo
+    def c(memo)
+      each do |order|
+        unless memo.keys.include?(order[0])
+          memo << order
+        end
+      end
+    end
+
+    # Add items from other not in memo
+    def d(memo, other)
+      other.each do |sort|
+        unless memo.keys.include?(sort[0])
+          memo << sort
+        end
+      end
+    end
+
+    def flip_direction(direction)
+      case direction
+      when 'asc' then 'desc'
+      when 'desc'then  'asc'
+      end
+    end
+  end
+
+  module Parse
+    def split(raw, delim, &block)
+      return Set.new if raw.nil?
+      raw.to_s.split(delim).inject(Set.new, &block)
+    end
+  end
+
+  class URIQuery
+    extend Parse
+
+    REGEXP = /([a-zA-Z0-9._]+)_(asc|desc)$/
+
+    def self.parse(raw)
+      split(raw, /!/) do |set, part|
+        m = part.match(REGEXP)
+        return set unless m
+        set << [m[1], m[2].downcase]
+      end
+    end
+
+    def self.encode(set)
+      set.map { |a| a.join('_') }.join('!')
+    end
+  end
+
+  class SQLQuery
+    extend Parse
+
+    REGEXP = /(([a-z0-9._]+)\s([asc|desc]+)|[a-z0-9._]+)/i
+
+    def self.parse(raw)
+      split(raw, /,/) do |set, part|
+        m = part.match(REGEXP)
+        return set unless m
+        set << [(m[2].nil? ? m[1] : m[2]), (m[3].nil? ? 'asc' : m[3].downcase)]
+      end
+    end
+
+    def self.encode(set, quote_proc = ->(f) { f })
+      set.map { |a| "#{column(a[0], quote_proc)} #{a[1].upcase}" }.join(', ')
+    end
+
+    def self.column(parts, quote_proc)
+      parts.split('.').map { |frag| quote_proc.call(frag) }.join('.')
+    end
+    private_class_method :column
+  end
 end
 
 if defined?(::Rails::Railtie)
+  ActiveSupport::Deprecation.warn('Rails helpers will be removed in version 2.0 of the sorted gem, use sorted-rails instead.')
   require 'sorted/railtie'
 end

data/lib/sorted/orms/mongoid.rb

@@ -5,12 +5,12 @@ module Sorted
   module Orms
     module Mongoid
       extend ActiveSupport::Concern
-      SQL_TO_MONGO = { "asc" => 1, "desc" => -1 }
+      SQL_TO_MONGO = { 'asc' => 1, 'desc' => -1 }
 
       included do
         def self.sorted(sort, default_order = nil)
           sorter = ::Sorted::Parser.new(sort, default_order)
-          order_by sorter.to_hash.merge(sorter) { |key, val| SQL_TO_MONGO[val] }
+          order_by sorter.to_hash.merge(sorter) { |_key, val| SQL_TO_MONGO[val] }
         end
       end
     end

data/lib/sorted/parser.rb

@@ -1,82 +1,68 @@
 require 'sorted/toggler'
 
 module Sorted
+  ##
   # Takes a sort query string and an SQL order string and parses the
+  #
   # values to produce key value pairs.
   #
   # Example:
-  #  Sorted::Parser.new('phone_desc', 'name ASC').to_s #-> "phone_desc!name_asc"
-  class Parser
-    attr_reader :sort, :order, :sorts, :orders
+  #  Sorted::Parser.new('phone_desc', 'name ASC').to_s #=> "phone_desc!name_asc"
+  #
+  #  TODO A more helpfull name than `Parser` because it only deals with URI and
+  #  SQL. Shoud be refactored before 2.x
 
-    # Regex to make sure we only get valid names and not injected code.
-    SORTED_QUERY_REGEX  = /([a-zA-Z0-9._]+)_(asc|desc)$/
-    SQL_REGEX           = /(([a-z0-9._]+)\s([asc|desc]+)|[a-z0-9._]+)/i
+  Parser = Struct.new(:sort, :order) do
+    def uri
+      URIQuery.parse(sort)
+    end
 
-    def initialize(sort, order = nil)
-      @sort   = sort
-      @order  = order
-      @sorts  = parse_sort
-      @orders = parse_order
+    def sql
+      SQLQuery.parse(order)
     end
 
-    def parse_sort
-      sort.to_s.split(/!/).map do |sort_string|
-        if m = sort_string.match(SORTED_QUERY_REGEX)
-          [m[1], m[2].downcase]
-        end
-      end.compact
+    def sorts
+      uri.to_a
     end
 
-    def parse_order
-      order.to_s.split(/,/).map do |order_string|
-        if m = order_string.match(SQL_REGEX)
-          [(m[2].nil? ? m[1] : m[2]),(m[3].nil? ? "asc" : m[3].downcase)]
-        end
-      end.compact
+    def orders
+      sql.to_a
     end
 
     def to_hash
-      array.inject({}){|h,a| h.merge(Hash[a[0],a[1]])}
+      set.to_hash
     end
 
-    def to_sql(quoter = ->(frag) { frag })
-      array.map do |a|
-        column = a[0].split('.').map{ |frag| quoter.call(frag) }.join('.')
-        "#{column} #{a[1].upcase}"
-      end.join(', ')
+    def to_sql(quote_proc = ->(f) { f })
+      SQLQuery.encode(set, quote_proc)
     end
 
     def to_s
-      array.map{|a| a.join('_') }.join('!')
+      URIQuery.encode(set)
     end
 
     def to_a
-      array
+      set.to_a
     end
 
     def toggle
-      @array = Toggler.new(sorts, orders).to_a
+      @set = Toggler.new(sorts, orders).toggle
       self
     end
 
     def reset
-      @array = default
+      @set = default
       self
     end
 
     private
 
-    def array
-      @array ||= default
+    def set
+      @set ||= default
     end
 
     def default
-      sorts_new = sorts.dup
-      orders.each do |o|
-        sorts_new << o unless sorts_new.flatten.include?(o[0])
-      end
-      sorts_new
+      uri + (sql - uri)
     end
   end
 end

data/lib/sorted/railtie.rb

@@ -2,7 +2,7 @@ require 'sorted'
 
 module Sorted
   class Railtie < Rails::Railtie
-    initializer "sorted.configure" do |app|
+    initializer 'sorted.configure' do |_app|
       if defined? ::ActiveRecord
         ActiveSupport.on_load :active_record do
           require 'sorted/orms/active_record'

data/lib/sorted/toggler.rb

@@ -1,62 +1,27 @@
 module Sorted
-  # Takes a parsed arrays of sorts and orders, it then will reorder the
-  # pairs and flip the assendance of the first sort pair.
+  ##
+  # Takes a parsed arrays of sorts and orders, it then will reorder the pairs
+  # and flip the ascendance of the first sort pair.
   #
   # Example:
   #   sorts  = [['name', 'asc'], ['phone', 'desc']]
   #   orders = [['name', 'asc']]
-  #   Sorted::Toggler.new(sorts, orders).to_a #-> [['name', 'desc'], ['phone', 'desc']]
+  #   Sorted::Toggler.new(sorts, orders).to_a
+  #
+  #  TODO Remove this in 2.x, it's only here for backwards compatibility.
+
   class Toggler
     def initialize(sorts, orders)
-      @array = []
-      @sorts      = sorts
-      @orders     = orders
-      @sort_keys  = sorts.transpose.first
-      @order_keys = orders.transpose.first
-      toggle_sorts unless @sort_keys.nil?
-      add_remaining_orders
-      add_remaining_sorts
-    end
-
-    def to_a
-      @array
-    end
-
-    def toggle_sorts
-      if @order_keys == @sort_keys.take(@order_keys.size)
-        @order_keys.select do |order|
-          @sort_keys.include?(order)
-        end.each do |order|
-          @array << [order, (case @sorts.assoc(order).last; when "asc"; "desc"; when "desc"; "asc" end)]
-        end
-      else
-        @order_keys.select do |order|
-          @sort_keys.include?(order)
-        end.each do |order|
-          @array << [order, @sorts.assoc(order).last]
-        end
-      end
-      @sort_keys.select do |sort|
-        @order_keys.include?(sort) && !@array.flatten.include?(sort)
-      end.each do |sort|
-        @array << [sort, @sorts.assoc(sort).last]
-      end
+      @sorts = Set.new(sorts)
+      @orders = Set.new(orders)
     end
 
-    def add_remaining_orders
-      @orders.select do |order|
-        !@array.flatten.include?(order[0])
-      end.each do |order|
-        @array << order
-      end
+    def toggle
+      @orders.direction_intersect(@sorts)
     end
 
-    def add_remaining_sorts
-      @sorts.select do |sort|
-        !@array.flatten.include?(sort[0])
-      end.each do |sort|
-        @array << sort
-      end
+    def to_a
+      toggle.to_a
     end
   end
 end

data/lib/sorted/version.rb

@@ -1,3 +1,3 @@
 module Sorted
-  VERSION = "1.0.1"
+  VERSION = '1.1.1'
 end

data/lib/sorted/view_helpers/action_view.rb

@@ -18,7 +18,7 @@ module Sorted
           if @parser.sorts.flatten.include? @parser.orders[0][0]
             "sorted #{@parser.sorts.assoc(@parser.orders[0][0]).last}"
           else
-            "sorted"
+            'sorted'
           end
         end
       end
@@ -71,10 +71,10 @@ module Sorted
       #   sortable_by :author_name, :title, ["Date of Publication", :published_at]
       #
       def sortable_by(*columns)
-        links = content_tag :span, "Sort by: "
+        links = content_tag :span, 'Sort by: '
         columns.each do |c|
           if c.is_a? Array
-            links += link_to_sorted(c[0],c[1].to_sym)
+            links += link_to_sorted(c[0], c[1].to_sym)
           else
             links += link_to_sorted(c.to_s.titleize, c.to_sym)
           end

data/sorted.gemspec

@@ -1,27 +1,28 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path("../lib/sorted/version", __FILE__)
+require File.expand_path('../lib/sorted/version', __FILE__)
 
 Gem::Specification.new do |s|
-  s.name        = "sorted"
+  s.name        = 'sorted'
   s.version     = Sorted::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Rufus Post", "Daniel Leavitt"]
-  s.email       = ["rufuspost@gmail.com", "daniel.leavitt@gmail.com"]
-  s.homepage    = "http://rubygems.org/gems/sorted"
-  s.summary     = %q{Data sorting library}
-  s.description = %q{Allows you to sort large datasets over many pages, without losing state.}
-  s.license     = "MIT"
+  s.authors     = ['Rufus Post', 'Daniel Leavitt']
+  s.email       = ['rufuspost@gmail.com', 'daniel.leavitt@gmail.com']
+  s.homepage    = 'http://rubygems.org/gems/sorted'
+  s.summary     = 'Data sorting library'
+  s.description = 'Allows you to sort large datasets over many pages, without losing state.'
+  s.license     = 'MIT'
 
-  s.required_rubygems_version = ">= 1.3.6"
-  s.rubyforge_project         = "sorted"
+  s.required_rubygems_version = '>= 1.3.6'
+  s.rubyforge_project         = 'sorted'
 
-  s.add_development_dependency "rake", ">= 0"
-  s.add_development_dependency "bundler", ">= 1.0.0"
-  s.add_development_dependency "rspec", ">= 2.0.0"
-  s.add_development_dependency "activesupport", ">= 3.0.0"
-  s.add_development_dependency "actionpack", ">= 3.0.0"
+  s.add_development_dependency 'rake', '>= 0'
+  s.add_development_dependency 'bundler', '>= 1.0.0'
+  s.add_development_dependency 'rspec', '>= 2.0.0'
+  s.add_development_dependency 'activesupport', '>= 3.0.0'
+  s.add_development_dependency 'actionpack', '>= 3.0.0'
+  s.add_development_dependency 'rubocop', '>= 0.28'
 
   s.files        = `git ls-files`.split("\n")
-  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.executables  = `git ls-files`.split("\n").map { |f| f =~ /^bin\/(.*)/ ? Regexp.last_match[1] : nil }.compact
   s.require_path = 'lib'
 end

data/spec/sorted/orms/active_record_spec.rb

@@ -14,20 +14,20 @@ if defined? ActiveRecord
       scope :page, -> { limit(50) }
     end
 
-    it "should integrate with ActiveRecord::Base" do
+    it 'should integrate with ActiveRecord::Base' do
       SortedActiveRecordTest.should respond_to(:sorted)
       SortedActiveRecordTest.should respond_to(:resorted)
     end
 
-    it "should play nice with other scopes" do
+    it 'should play nice with other scopes' do
       sql = "SELECT  \"sorted_active_record_tests\".* FROM \"sorted_active_record_tests\"  WHERE \"sorted_active_record_tests\".\"name\" = 'bob'  ORDER BY \"name\" ASC LIMIT 50"
-      SortedActiveRecordTest.where(:name => 'bob').page.sorted(nil, 'name ASC').to_sql.should == sql
-      SortedActiveRecordTest.page.sorted(nil, 'name ASC').where(:name => 'bob').to_sql.should == sql
+      SortedActiveRecordTest.where(name: 'bob').page.sorted(nil, 'name ASC').to_sql.should == sql
+      SortedActiveRecordTest.page.sorted(nil, 'name ASC').where(name: 'bob').to_sql.should == sql
     end
 
-    it "should override the provided order" do
+    it 'should override the provided order' do
       sql = "SELECT  \"sorted_active_record_tests\".* FROM \"sorted_active_record_tests\"  WHERE \"sorted_active_record_tests\".\"name\" = 'bob'  ORDER BY \"name\" ASC LIMIT 50"
-      SortedActiveRecordTest.page.where(:name => 'bob').order(:id).sorted(nil, 'name DESC').resorted(nil, 'name ASC').to_sql.should == sql
+      SortedActiveRecordTest.page.where(name: 'bob').order(:id).sorted(nil, 'name DESC').resorted(nil, 'name ASC').to_sql.should == sql
     end
   end
 end

data/spec/sorted/orms/mongoid_spec.rb

@@ -15,16 +15,16 @@ if defined? Mongoid
       end
     end
 
-    it "should integrate with Mongoid::Document" do
+    it 'should integrate with Mongoid::Document' do
       SortedMongoidTest.should respond_to(:sorted)
     end
 
-    it "should integrate with Mongoid::Criteria" do
+    it 'should integrate with Mongoid::Criteria' do
       SortedMongoidTest.page.should respond_to(:sorted)
     end
 
-    it "should play nice with other scopes" do
-      query_options = { limit: 50, sort: { "name" => 1 } }
+    it 'should play nice with other scopes' do
+      query_options = { limit: 50, sort: { 'name' => 1 } }
       SortedMongoidTest.page.sorted(nil, 'name ASC').options.should == query_options
       SortedMongoidTest.page.sorted(nil, 'name ASC').options.should == query_options
     end

data/spec/sorted/parser_spec.rb

@@ -1,66 +1,66 @@
 require 'spec_helper'
 
-describe Sorted::Parser, "params parsing" do
-  it "should not raise if pased nil arguments" do
-    lambda { Sorted::Parser.new(nil, nil).toggle }.should_not raise_error
+describe Sorted::Parser, 'params parsing' do
+  it 'should not raise if pased nil arguments' do
+    -> { Sorted::Parser.new(nil, nil).toggle }.should_not raise_error
   end
 
-  it "should return a nice array from the order sql" do
+  it 'should return a nice array from the order sql' do
     sort   = nil
-    order  = "email ASC, phone ASC, name DESC"
-    result = [["email", "asc"], ["phone", "asc"], ["name", "desc"]]
+    order  = 'email ASC, phone ASC, name DESC'
+    result = [['email', 'asc'], ['phone', 'asc'], ['name', 'desc']]
 
     sorter = Sorted::Parser.new(sort, order)
     sorter.orders.should eq result
   end
 
-  it "should return a nice array from the sort params" do
-    sort   = "email_desc!name_desc"
+  it 'should return a nice array from the sort params' do
+    sort   = 'email_desc!name_desc'
     order  = nil
-    result = [["email", "desc"], ["name", "desc"]]
+    result = [['email', 'desc'], ['name', 'desc']]
 
     sorter = Sorted::Parser.new(sort, order)
     sorter.sorts.should eq result
   end
 
-  it "should combine sort and order params with sort params being of higer importance" do
-    sort   = "email_desc!name_desc"
-    order  = "email ASC, phone ASC, name DESC"
-    result = [["email", "desc"], ["name", "desc"], ["phone", "asc"]]
+  it 'should combine sort and order params with sort params being of higer importance' do
+    sort   = 'email_desc!name_desc'
+    order  = 'email ASC, phone ASC, name DESC'
+    result = [['email', 'desc'], ['name', 'desc'], ['phone', 'asc']]
 
     sorter = Sorted::Parser.new(sort, order)
     sorter.to_a.should eq result
   end
 
-  it "should allow numbers, underscores and full stops in sort params" do
-    sort   = "assessmentsTable.name_desc!users_300.name_5_desc"
+  it 'should allow numbers, underscores and full stops in sort params' do
+    sort   = 'assessmentsTable.name_desc!users_300.name_5_desc'
     order  = nil
-    result = [["assessmentsTable.name", "desc"], ["users_300.name_5", "desc"]]
+    result = [['assessmentsTable.name', 'desc'], ['users_300.name_5', 'desc']]
 
     sorter = Sorted::Parser.new(sort, order)
     sorter.sorts.should eq result
   end
 
-  it "should allow numbers, underscores and full stops in order params" do
+  it 'should allow numbers, underscores and full stops in order params' do
     sort   = nil
-    order  = "assessmentsTable.name ASC, users_300.name_5 ASC"
-    result = [["assessmentsTable.name", "asc"], ["users_300.name_5", "asc"]]
+    order  = 'assessmentsTable.name ASC, users_300.name_5 ASC'
+    result = [['assessmentsTable.name', 'asc'], ['users_300.name_5', 'asc']]
 
     sorter = Sorted::Parser.new(sort, order)
     sorter.orders.should eq result
   end
 
-  it "should default to asc if sort params order is ommited" do
+  it 'should default to asc if sort params order is ommited' do
     sort   = nil
     order  = :email
-    result = [["email", "asc"]]
+    result = [['email', 'asc']]
 
     sorter = Sorted::Parser.new(sort, order)
     sorter.orders.should eq result
   end
 end
 
-describe Sorted::Parser, "return types" do
+describe Sorted::Parser, 'return types' do
   module FakeConnection
     def self.quote_column_name(column_name)
       "`#{column_name}`"
@@ -71,45 +71,45 @@ describe Sorted::Parser, "return types" do
     ->(frag) { FakeConnection.quote_column_name(frag) }
   }
 
-  it "should properly escape sql column names" do
-    order = "users.name DESC"
-    result = "`users`.`name` DESC"
+  it 'should properly escape sql column names' do
+    order = 'users.name DESC'
+    result = '`users`.`name` DESC'
 
     sorter = Sorted::Parser.new(nil, order)
     sorter.to_sql(quoter).should eq result
   end
 
-  it "should return an sql sort string" do
-    sort   = "email_desc!name_desc"
-    order  = "email ASC, phone ASC, name DESC"
-    result = "`email` DESC, `name` DESC, `phone` ASC"
+  it 'should return an sql sort string' do
+    sort   = 'email_desc!name_desc'
+    order  = 'email ASC, phone ASC, name DESC'
+    result = '`email` DESC, `name` DESC, `phone` ASC'
 
     sorter = Sorted::Parser.new(sort, order)
     sorter.to_sql(quoter).should eq result
   end
 
-  it "should return an hash" do
-    sort   = "email_desc!name_desc"
-    order  = "email ASC, phone ASC, name DESC"
-    result = {"email" => "desc", "name" => "desc", "phone" => "asc"}
+  it 'should return an hash' do
+    sort   = 'email_desc!name_desc'
+    order  = 'email ASC, phone ASC, name DESC'
+    result = { 'email' => 'desc', 'name' => 'desc', 'phone' => 'asc' }
 
     sorter = Sorted::Parser.new(sort, order)
     sorter.to_hash.should eq result
   end
 
-  it "should return an the encoded sort string" do
-    sort   = "email_desc!name_desc"
-    order  = "email ASC, phone ASC, name DESC"
-    result = "email_desc!name_desc!phone_asc"
+  it 'should return an the encoded sort string' do
+    sort   = 'email_desc!name_desc'
+    order  = 'email ASC, phone ASC, name DESC'
+    result = 'email_desc!name_desc!phone_asc'
 
     sorter = Sorted::Parser.new(sort, order)
     sorter.to_s.should eq result
   end
 
-  it "sql injection using order by clause should not work" do
-    sort   = "(case+when+((ASCII(SUBSTR((select+table_name+from+all_tables+where+rownum%3d1),1))>%3D128))+then+id+else+something+end)"
-    order  = "email ASC, phone ASC, name DESC"
-    result = "`email` ASC, `phone` ASC, `name` DESC"
+  it 'sql injection using order by clause should not work' do
+    sort   = '(case+when+((ASCII(SUBSTR((select+table_name+from+all_tables+where+rownum%3d1),1))>%3D128))+then+id+else+something+end)'
+    order  = 'email ASC, phone ASC, name DESC'
+    result = '`email` ASC, `phone` ASC, `name` DESC'
 
     sorter = Sorted::Parser.new(sort, order)
     sorter.to_sql(quoter).should eq result

data/spec/sorted/toggler_spec.rb

@@ -1,55 +1,73 @@
 require 'spec_helper'
 
 describe Sorted::Toggler do
-  it "should bring phone to first order importance but not toggle ascendance" do
-    orders = [["email", "asc"], ["phone", "asc"]]
-    sorts  = [["phone", "asc"]]
-    result = [["phone", "asc"], ["email", "asc"]]
+  it 'should bring phone to first order importance but not toggle ascendance' do
+    orders = [['email', 'asc'], ['phone', 'asc']]
+    sorts  = [['phone', 'asc']]
+    result = [['phone', 'asc'], ['email', 'asc']]
 
     toggler = Sorted::Toggler.new(sorts, orders)
     toggler.to_a.should eq result
   end
 
-  it "should toggle ascendance of email" do
-    orders = [["email", "desc"]]
-    sorts  = [["email", "asc"]]
-    result = [["email", "desc"]]
+  it 'should toggle ascendance of email' do
+    orders = [['email', 'desc']]
+    sorts  = [['email', 'asc']]
+    result = [['email', 'desc']]
 
     toggler = Sorted::Toggler.new(sorts, orders)
     toggler.to_a.should eq result
   end
 
-  it "should return both order params un-toggled with no sort param" do
-    orders = [["email", "asc"], ["phone", "asc"]]
+  it 'should return both order params un-toggled with no sort param' do
+    orders = [['email', 'asc'], ['phone', 'asc']]
     sorts  = []
-    result = [["email", "asc"], ["phone", "asc"]]
+    result = [['email', 'asc'], ['phone', 'asc']]
 
     toggler = Sorted::Toggler.new(sorts, orders)
     toggler.to_a.should eq result
   end
 
-  it "should toggle the email ascendance" do
-    orders = [["email", "asc"]]
-    sorts  = [["email", "asc"], ["phone", "asc"]]
-    result = [["email", "desc"], ["phone", "asc"]]
+  it 'should toggle the email ascendance' do
+    orders = [['email', 'asc']]
+    sorts  = [['email', 'asc'], ['phone', 'asc']]
+    result = [['email', 'desc'], ['phone', 'asc']]
 
     toggler = Sorted::Toggler.new(sorts, orders)
     toggler.to_a.should eq result
   end
 
-  it "should toggle the email ascendance" do
-    orders = [["email", "desc"]]
-    sorts  = [["email", "asc"], ["phone", "asc"]]
-    result = [["email", "desc"], ["phone", "asc"]]
+  it 'should toggle the email ascendance' do
+    orders = [['email', 'desc']]
+    sorts  = [['email', 'asc'], ['phone', 'asc']]
+    result = [['email', 'desc'], ['phone', 'asc']]
 
     toggler = Sorted::Toggler.new(sorts, orders)
     toggler.to_a.should eq result
   end
 
-  it "should toggle two 1..n sort values" do
-    orders = [["email", "asc"], ["phone", "asc"]]
-    sorts  = [["email", "asc"], ["phone", "asc"]]
-    result = [["email", "desc"], ["phone", "desc"]]
+  it 'should toggle two 1..n sort values' do
+    orders = [['email', 'asc'], ['phone', 'asc']]
+    sorts  = [['email', 'asc'], ['phone', 'asc']]
+    result = [['email', 'desc'], ['phone', 'desc']]
+
+    toggler = Sorted::Toggler.new(sorts, orders)
+    toggler.to_a.should eq result
+  end
+
+  it 'should toggle based on sorts and not orders' do
+    orders = [['email', 'desc'], ['phone', 'desc']]
+    sorts  = [['email', 'asc'], ['phone', 'asc']]
+    result = [['email', 'desc'], ['phone', 'desc']]
+
+    toggler = Sorted::Toggler.new(sorts, orders)
+    toggler.to_a.should eq result
+  end
+
+  it 'should toggle based on sorts and not orders' do
+    orders = [['email', 'asc']]
+    sorts  = [['name', 'asc']]
+    result = [['email', 'asc'], ['name', 'asc']]
 
     toggler = Sorted::Toggler.new(sorts, orders)
     toggler.to_a.should eq result

data/spec/sorted/view_helpers/action_view_spec.rb

@@ -1,45 +1,63 @@
 require 'spec_helper'
 
 describe Sorted::ViewHelpers::ActionView do
-  it "should integrate with ActiveRecord::Base" do
+  it 'should integrate with ActiveRecord::Base' do
     ActionView::Base.send(:include, Sorted::ViewHelpers::ActionView)
     ActionView::Base.new.should respond_to(:link_to_sorted)
   end
 end
 
 describe Sorted::ViewHelpers::ActionView::SortedViewHelper do
-  it "should return the default sort order and preserve the existing params" do
+  it 'should return the default sort order and preserve the existing params' do
     order  = :email
-    params = { :page => 10 }
-    result = { :page => 10, :sort => "email_asc" }
+    params = { page: 10 }
+    result = { page: 10, sort: 'email_asc' }
 
     sorter = Sorted::ViewHelpers::ActionView::SortedViewHelper.new order, params
     sorter.params.should eq result
   end
 
-  it "should only return the sorted css class if email has not yet been sorted" do
+  it 'should only return the sorted css class if email has not yet been sorted' do
     order  = :email
     params = {}
-    result = "sorted"
+    result = 'sorted'
 
     sorter = Sorted::ViewHelpers::ActionView::SortedViewHelper.new order, params
     sorter.css.should eq result
   end
 
-  it "should only return the sorted css class if email has not yet been sorted" do
+  it 'should only return the sorted css class if email has not yet been sorted' do
     order  = :email
-    params = { :sort => "email_asc" }
-    result = "sorted asc"
+    params = { sort: 'email_asc' }
+    result = 'sorted asc'
 
     sorter = Sorted::ViewHelpers::ActionView::SortedViewHelper.new order, params
     sorter.css.should eq result
   end
 
-  it "should return the default order when params are empty" do
+  it 'should return the default order when params are empty' do
     order  = :email
-    result = { :sort => "email_asc" }
+    result = { sort: 'email_asc' }
 
     sorter = Sorted::ViewHelpers::ActionView::SortedViewHelper.new order, {}
     sorter.params.should eq result
   end
+
+  it 'should correctly toggle multiple params' do
+    order  = 'email DESC, name DESC'
+    params = { sort: 'email_asc!name_asc' }
+    result = { sort: 'email_desc!name_desc' }
+
+    sorter = Sorted::ViewHelpers::ActionView::SortedViewHelper.new order, params
+    sorter.params.should eq result
+  end
+
+  it 'should have sort order over existing params' do
+    order  = :email
+    params = { sort: 'name_asc' }
+    result = { sort: 'email_asc!name_asc' }
+
+    sorter = Sorted::ViewHelpers::ActionView::SortedViewHelper.new order, params
+    sorter.params.should eq result
+  end
 end

data/spec/spec_helper.rb

@@ -1,14 +1,6 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-begin
-    require 'rails'
-rescue LoadError
-end
-
-require 'bundler/setup'
-Bundler.require
-
 require 'sorted'
 require 'sorted/orms/mongoid'
 require 'sorted/orms/active_record'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorted
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Rufus Post
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-12 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -81,6 +81,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.28'
 description: Allows you to sort large datasets over many pages, without losing state.
 email:
 - rufuspost@gmail.com
@@ -91,6 +105,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -135,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: sorted
-rubygems_version: 2.2.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Data sorting library