sorted 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b665b8a96ecf9464b3c3845dae2edbdf3a8fef8
-  data.tar.gz: f698bb91b0fa131eef2928a89d8125f19813dde9
+  metadata.gz: 24619b1bb18184b31fed12d6dc314cea988201f7
+  data.tar.gz: 5b31c5ef8375ca83aa0853e2fe219477fa40afe5
 SHA512:
-  metadata.gz: d4cd81b4bde74202c5ab1a6e4f6bce6696fc882c78392dcba6a59539e658819dcc8080683a2da19b939028a55f4c76be7f3533e35092944278151b4bde1c25b6
-  data.tar.gz: a5e122727f4e42a6756b5b08685e8cff49db754446bcd95f8e00d205fdf289a4699a46ee81d5d3e2d36846411532771b32a7b0d21b545f8a1a6a1b3dc1946474
+  metadata.gz: 2a285ff4a99085d9ca9740a6e4c5187a594b14a6698750b03ec2e8846473d6f93145aedff4f1c98bfdd4aa4b32c28d395d3908ed428bbf4b62818f52f9461ff2
+  data.tar.gz: f77377cd895a964111ff98edf7fe62e16193a8ee5f397b9613fa1db66f7a6631f861f1a0cab2fbcb622fec21cec8ec833b25b2a3b1dad528b5d3de50418b9c2e

data/README.md

@@ -1,7 +1,6 @@
 # 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 at it's core is a set of objects that let you sort many different
 attributes in weird and wonderful ways.
@@ -16,7 +15,7 @@ b = Sorted::Set.new([['email', 'asc'], ['phone', 'asc']])
 
 s = a.direction_intersect(b)
 
-s.uniq.to_a #=> [['email', 'desc'], ['phone', 'asc'], ['name', 'asc']]
+s.to_a #=> [['email', 'desc'], ['phone', 'asc'], ['name', 'asc']]
 ```
 
 The best way to think about this is to imagine a spreed sheet and what happens
@@ -35,46 +34,10 @@ Currently implemented:
 
 * `Sorted::SQLQuery`
 * `Sorted::URIQuery`
+* `Sorted::JSONQuery`
 
-TODO:
+## Projects
 
-* `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.
-
-### View
-
-Generate a sorted link with the email attribute:
-
-```ruby
-link_to_sorted "Email", :email
-```
-
-Works the same as the `link_to` method except a second argument for the
-sort attribute is needed.
-
-### Model
-
-Using the `sorted` method with the optional default order argument:
-
-```ruby
-@users = User.sorted(params[:sort], "email ASC").page(params[:page])
-```
-
-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:
-
-```ruby
-@users = User.order(:id).sorted(nil, 'name DESC').resorted(params[:sort], 'email ASC')
-```
-
-## Supported ORMs
-
-* ActiveRecord
-* Mongoid
+* Mongoid https://github.com/dleavitt/sorted-mongoid
+* ActiveRecord https://github.com/mynameisrufus/sorted-activerecord
+* ActionView https://github.com/mynameisrufus/sorted-actionview

data/Rakefile

@@ -19,30 +19,24 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-namespace :spec do
-  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"
-      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake -t spec"
-    end
-  end
-end
-
 task :benchmark do
   require 'benchmark'
 
-  sort   = 'email_desc!name_desc'
-  order  = 'email ASC, phone ASC, name DESC'
+  uri = 'email_desc!name_desc'
+  sql = 'email ASC, phone ASC, name DESC'
+
+  uri_set = Sorted::SQLQuery.parse(uri)
+  sql_set = Sorted::SQLQuery.parse(sql)
 
   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 }
+    # Query
+    x.report(:uri_parse) { for i in 1..n; Sorted::URIQuery.parse(uri); end }
+    x.report(:sql_parse) { for i in 1..n; Sorted::SQLQuery.parse(sql); end }
+
+    # Set
+    x.report(:direction_intersect) { for i in 1..n; sql_set.direction_intersect(uri_set); end }
   end
 end
 
-task default: ['rubocop', 'spec:all']
+task default: ['rubocop', 'spec']

data/lib/sorted.rb

@@ -1,8 +1,7 @@
-require 'sorted/parser'
-
 module Sorted
   class Set
     include Enumerable
+    include Comparable
 
     def initialize(set = [])
       @set = set
@@ -60,6 +59,10 @@ module Sorted
       self.class.new(@set << a)
     end
 
+    def <=>(other)
+      @set <=> other.to_a
+    end
+
     def uniq
       self.class.new(@set.uniq)
     end
@@ -181,9 +184,19 @@ module Sorted
     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'
+  class JSONQuery
+    extend Parse
+
+    JSON_TO_SORTED = { 1 => 'asc', -1 => 'desc' }
+    SORTED_TO_JSON = { 'asc' => 1, 'desc' => -1 }
+
+    def self.parse(raw)
+      Set.new(raw.map { |key, val| [key, JSON_TO_SORTED[val]] })
+    end
+
+    def self.encode(set)
+      set.inject({}) { |a, e| a.merge(Hash[e[0], SORTED_TO_JSON[e[1]]]) }
+    end
+  end
 end

data/lib/sorted/version.rb

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

data/sorted.gemspec

@@ -5,11 +5,11 @@ Gem::Specification.new do |s|
   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.authors     = ['Rufus Post']
+  s.email       = ['rufuspost@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.description = 'Data sorting library, used by other libs to construct queries and more'
   s.license     = 'MIT'
 
   s.required_rubygems_version = '>= 1.3.6'
@@ -18,8 +18,6 @@ Gem::Specification.new do |s|
   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")

data/spec/json_query_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Sorted::JSONQuery, 'decode' do
+  it 'should return a nice array from the order sql' do
+    json = { 'email' => 1, 'phone' => 1, 'name' => -1 }
+    set = Sorted::JSONQuery.parse(json)
+    result = Sorted::Set.new([['email', 'asc'], ['phone', 'asc'], ['name', 'desc']])
+
+    expect(set).to eq(result)
+  end
+end
+
+describe Sorted::JSONQuery, 'encode' do
+  it 'should return an sql sort string' do
+    set = Sorted::Set.new([['email', 'desc'], ['name', 'desc'], ['phone', 'asc']])
+    result = { 'email' => -1, 'phone' => 1, 'name' => -1 }
+
+    expect(Sorted::JSONQuery.encode(set)).to eq(result)
+  end
+end

data/spec/set_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Sorted::Set do
+  it 'should bring phone to first order importance but not toggle ascendance' do
+    orders = Sorted::Set.new([['email', 'asc'], ['phone', 'asc']])
+    sorts  = Sorted::Set.new([['phone', 'asc']])
+    result = Sorted::Set.new([['phone', 'asc'], ['email', 'asc']])
+
+    expect(orders.direction_intersect(sorts)).to eq(result)
+  end
+
+  it 'should toggle ascendance of email' do
+    orders = Sorted::Set.new([['email', 'desc']])
+    sorts = Sorted::Set.new([['email', 'asc']])
+    result = Sorted::Set.new([['email', 'desc']])
+
+    expect(orders.direction_intersect(sorts)).to eq(result)
+  end
+
+  it 'should return both order params un-toggled with no sort param' do
+    orders = Sorted::Set.new([['email', 'asc'], ['phone', 'asc']])
+    sorts = Sorted::Set.new([])
+    result = Sorted::Set.new([['email', 'asc'], ['phone', 'asc']])
+
+    expect(orders.direction_intersect(sorts)).to eq(result)
+  end
+
+  it 'should toggle the email ascendance' do
+    orders = Sorted::Set.new([['email', 'asc']])
+    sorts = Sorted::Set.new([['email', 'asc'], ['phone', 'asc']])
+    result = Sorted::Set.new([['email', 'desc'], ['phone', 'asc']])
+
+    expect(orders.direction_intersect(sorts)).to eq(result)
+  end
+
+  it 'should toggle the email ascendance' do
+    orders = Sorted::Set.new([['email', 'desc']])
+    sorts = Sorted::Set.new([['email', 'asc'], ['phone', 'asc']])
+    result = Sorted::Set.new([['email', 'desc'], ['phone', 'asc']])
+
+    expect(orders.direction_intersect(sorts)).to eq(result)
+  end
+
+  it 'should toggle two 1..n sort values' do
+    orders = Sorted::Set.new([['email', 'asc'], ['phone', 'asc']])
+    sorts = Sorted::Set.new([['email', 'asc'], ['phone', 'asc']])
+    result = Sorted::Set.new([['email', 'desc'], ['phone', 'desc']])
+
+    expect(orders.direction_intersect(sorts)).to eq(result)
+  end
+
+  it 'should toggle based on sorts and not orders' do
+    orders = Sorted::Set.new([['email', 'desc'], ['phone', 'desc']])
+    sorts = Sorted::Set.new([['email', 'asc'], ['phone', 'asc']])
+    result = Sorted::Set.new([['email', 'desc'], ['phone', 'desc']])
+
+    expect(orders.direction_intersect(sorts)).to eq(result)
+  end
+
+  it 'should toggle based on sorts and not orders' do
+    orders = Sorted::Set.new([['email', 'asc']])
+    sorts = Sorted::Set.new([['name', 'asc']])
+    result = Sorted::Set.new([['email', 'asc'], ['name', 'asc']])
+
+    expect(orders.direction_intersect(sorts)).to eq(result)
+  end
+
+  it 'should return a hash' do
+    set = Sorted::Set.new([['email', 'asc']])
+    result = { 'email' => 'asc' }
+
+    expect(set.to_hash).to eq(result)
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,5 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-require 'sorted'
-require 'sorted/orms/mongoid'
-require 'sorted/orms/active_record'
-require 'sorted/view_helpers/action_view'
 require 'rspec'
+require 'sorted'

data/spec/sql_query_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Sorted::SQLQuery, 'decode' do
+  it 'should return a nice array from the order sql' do
+    sql = 'email ASC, phone ASC, name DESC'
+    set = Sorted::SQLQuery.parse(sql)
+    result = Sorted::Set.new([['email', 'asc'], ['phone', 'asc'], ['name', 'desc']])
+
+    expect(set).to eq(result)
+  end
+
+  it 'should allow numbers, underscores and full stops in order params' do
+    sql = 'assessmentsTable.name ASC, users_300.name_5 ASC'
+    set = Sorted::SQLQuery.parse(sql)
+    result = Sorted::Set.new([['assessmentsTable.name', 'asc'], ['users_300.name_5', 'asc']])
+
+    expect(set).to eq(result)
+  end
+
+  it 'should default to asc if sort params order is ommited' do
+    sql = :email
+    set = Sorted::SQLQuery.parse(sql)
+    result = [['email', 'asc']]
+
+    expect(set).to eq(result)
+  end
+
+  it 'sql injection using order by clause should not work' do
+    sql = '(case+when+((ASCII(SUBSTR((select+table_name+from+all_tables+where+rownum%3d1),1))>%3D128))+then+id+else+something+end)'
+    set = Sorted::SQLQuery.parse(sql)
+    result = Sorted::Set.new([['case', 'asc'], ['1', 'asc']])
+
+    expect(set).to eq(result)
+  end
+end
+
+describe Sorted::SQLQuery, 'encode' do
+  module FakeConnection
+    def self.quote_column_name(column_name)
+      "`#{column_name}`"
+    end
+  end
+
+  let(:quoter) {
+    ->(frag) { FakeConnection.quote_column_name(frag) }
+  }
+
+  it 'should properly escape sql column names' do
+    set = Sorted::Set.new([['users.name', 'desc']])
+    result = '`users`.`name` DESC'
+
+    expect(Sorted::SQLQuery.encode(set, quoter)).to eq(result)
+  end
+
+  it 'should return an sql sort string' do
+    set = Sorted::Set.new([['email', 'desc'], ['name', 'desc'], ['phone', 'asc']])
+    result = '`email` DESC, `name` DESC, `phone` ASC'
+
+    expect(Sorted::SQLQuery.encode(set, quoter)).to eq(result)
+  end
+end

data/spec/uri_query_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Sorted::URIQuery, 'decode' do
+  it 'should allow numbers, underscores and full stops in sort params' do
+    uri = 'assessmentsTable.name_desc!users_300.name_5_desc'
+    set = Sorted::URIQuery.parse(uri)
+    result = [['assessmentsTable.name', 'desc'], ['users_300.name_5', 'desc']]
+
+    expect(set).to eq(result)
+  end
+end
+
+describe Sorted::URIQuery, 'encode' do
+  it 'should return a nice array from the sort params' do
+    set = Sorted::Set.new([['email', 'desc'], ['name', 'desc'], ['phone', 'asc']])
+    result = 'email_desc!name_desc!phone_asc'
+
+    expect(Sorted::URIQuery.encode(set)).to eq(result)
+  end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sorted
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Rufus Post
-- Daniel Leavitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -53,34 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -95,10 +66,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.28'
-description: Allows you to sort large datasets over many pages, without losing state.
+description: Data sorting library, used by other libs to construct queries and more
 email:
 - rufuspost@gmail.com
-- daniel.leavitt@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -112,25 +82,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/active_record_40.gemfile
-- gemfiles/active_record_40.gemfile.lock
-- gemfiles/mongoid_30.gemfile
-- gemfiles/mongoid_30.gemfile.lock
 - lib/sorted.rb
-- lib/sorted/orms/active_record.rb
-- lib/sorted/orms/mongoid.rb
-- lib/sorted/parser.rb
-- lib/sorted/railtie.rb
-- lib/sorted/toggler.rb
 - lib/sorted/version.rb
-- lib/sorted/view_helpers/action_view.rb
 - sorted.gemspec
-- spec/sorted/orms/active_record_spec.rb
-- spec/sorted/orms/mongoid_spec.rb
-- spec/sorted/parser_spec.rb
-- spec/sorted/toggler_spec.rb
-- spec/sorted/view_helpers/action_view_spec.rb
+- spec/json_query_spec.rb
+- spec/set_spec.rb
 - spec/spec_helper.rb
+- spec/sql_query_spec.rb
+- spec/uri_query_spec.rb
 homepage: http://rubygems.org/gems/sorted
 licenses:
 - MIT