sorted 0.3.7 → 0.3.8

data/.gitignore

@@ -17,5 +17,7 @@ tmtags
 coverage
 rdoc
 pkg
+.rvmrc
+Gemfile.lock
 
 ## PROJECT::SPECIFIC

data/.watchr

@@ -0,0 +1,24 @@
+module WatchrActions
+  def self.run_spec(file)
+    unless File.exist?(file)
+      puts "#{file} does not exist"
+      return
+    end
+
+    puts "Running #{file}"
+    system "rspec #{file}"
+  end
+end
+
+watch(/^lib\/(?:sorted\/)?(.*).rb/) do |m|
+  WatchrActions.run_spec("spec/#{m[1]}_spec.rb")
+end
+
+watch(/^spec\/.*_spec.rb/) do |m|
+  WatchrActions.run_spec(m[0])
+end
+
+watch(/^lib\/sorted\/finders\/active_record.rb/) do |m|
+  WatchrActions.run_spec('spec/sorted_spec.rb')
+end
+

data/README.rdoc

@@ -28,7 +28,13 @@ This will initially sort by email ascending:
 
   @users = User.sorted(:order => "email ASC", :sort => params[:sort]).paginate(:page => params[:page])
 
-Or you can just clone the example app https://github.com/mynameisrufus/sorted_app
+Or you can just clone the example app https://github.com/mynameisrufus/sorted_app.
+
+If you want to sort by a belongs_to relationship, just provide sort order as "RELATIONS.COLUMN ASC|DESC" where
+RELATIONS is the name of the relationship table and COLUMN is an attribute in that table.  For example, 
+assuming the User model belongs_to a :company.
+
+  @users = User.sorted(:order => "companies.name asc", :sort => params[:sort]).paginate(:page => params[:page])
 
 == Presentation
 

data/lib/sorted/finders/active_record.rb

@@ -6,8 +6,33 @@ module Sorted
     module ActiveRecord
       def self.enable!
         ::ActiveRecord::Base.class_eval do
+          # Define a symbolic sort column. This allows mapping a simple column name
+          # to a more complex sql order clause.
+          #  class Model < ActiveRecord::Base
+          #    symbolic_sort :ip_address, 'inet_aton(`ip_address`)'
+          #  end
+          def self.symbolic_sort(key, sql)
+            symbolic_sorts[key] = sql
+          end
+
           def self.sorted(params)
-            order(::Sorted::Sorter.new(params[:order], :sort => params[:sort]).to_sql)
+            sorter = ::Sorted::Sorter.new(params[:order], :sort => params[:sort], :symbolic_sorts => symbolic_sorts)
+            # Check if we parsed some relationship includes and apply them
+            # before applying the order
+            relation = self
+            if sorter.includes.size > 0
+              # Remove self.name from includes
+              my_name = self.name.to_sym
+              real_includes = sorter.includes.delete_if{|include_name| include_name == my_name}
+              relation = includes(real_includes) if real_includes.size > 0
+            end
+            relation.order(sorter.to_sql)
+          end
+
+          private
+
+          def self.symbolic_sorts
+            @symbolic_sorts ||= {}
           end
         end
       end

data/lib/sorted/sorter.rb

@@ -1,6 +1,10 @@
 module Sorted
   class Sorter
+    attr_reader :includes
     def initialize(order, params = nil)
+      @includes = []
+      @symbolic_sorts = {}
+
       if order.is_a?(String) || order.is_a?(Symbol)
         parse_order(order)
       end
@@ -9,6 +13,7 @@ module Sorted
         if @params[:sort].is_a?(String) 
           parse_sort @params[:sort]
         end
+        @symbolic_sorts = @params[:symbolic_sorts] || {}
       end
     end
     
@@ -30,13 +35,23 @@ module Sorted
     
     def parse_query(sort)
       if m = sort.match(/([a-zA-Z0-9._]+)_(asc|desc)$/)
+        parse_include(m[1])
         [m[1],m[2]]
       end
     end
 
     def parse_sql(order)
-      if m = order.match(/(([a-zA-Z._:]+)\s([asc|ASC|desc|DESC]+)|[a-zA-Z._:]+)/)
-        [(m[2].nil? ? m[1] : m[2]),(m[3].nil? ? "asc" : m[3].downcase)]
+      if m = order.match(/(([a-zA-Z._:][a-zA-Z._:0-9]*)\s([asc|ASC|desc|DESC]+)|[a-zA-Z._:][a-zA-Z._:0-9]*)/)
+        sort_column = (m[2].nil? ? m[1] : m[2])
+        parse_include(sort_column)
+        [sort_column,(m[3].nil? ? "asc" : m[3].downcase)]
+      end
+    end
+
+    def parse_include(order)
+      if match_data = /^([^\.]+)\..+/.match(order)
+        include_name = match_data[1].singularize.to_sym
+        @includes << include_name unless @includes.include?(include_name)
       end
     end
 
@@ -55,7 +70,10 @@ module Sorted
     end
     
     def to_sql
-      array.map{|a| "#{a[0]} #{a[1].upcase}"}.join(', ')
+      array.map do |a|
+        column = @symbolic_sorts[a[0].to_sym] || a[0]
+        "#{column} #{a[1].upcase}"
+      end.join(', ')
     end
 
     def to_s

data/lib/sorted/version.rb

@@ -1,3 +1,3 @@
 module Example
-  VERSION = "0.3.7"
+  VERSION = "0.3.8"
 end

data/spec/sorted_spec.rb

@@ -10,6 +10,34 @@ describe Sorted::Finders::ActiveRecord do
   it "should integrate with ActiveRecord::Base" do
     ActiveRecord::Base.should respond_to(:sorted)
   end
+
+  it "should define a symbolic_sorts method" do
+    ActiveRecord::Base.should respond_to(:symbolic_sort)
+  end
+
+  it "should define symbolic_sorts" do
+    a = Class.new(ActiveRecord::Base)
+    b = Class.new(ActiveRecord::Base)
+
+    a.symbolic_sort(:foo, 'foo')
+    b.symbolic_sort(:bar, 'bar')
+
+    a.instance_variable_get(:@symbolic_sorts).should == {:foo => 'foo'}
+    b.instance_variable_get(:@symbolic_sorts).should == {:bar => 'bar'}
+  end
+
+  it "should add orders to the relation" do
+    a = Class.new(ActiveRecord::Base)
+    relation = a.sorted(:order => nil, :sort => 'a_asc')
+    relation.order_values.should == ["a ASC"]
+  end
+
+  it "should add orders to the relation using symbolic_sorts" do
+    a = Class.new(ActiveRecord::Base)
+    a.symbolic_sort(:ip, 'inet_aton(`ip`)')
+    relation = a.sorted(:order => nil, :sort => 'ip_asc')
+    relation.order_values.should == ["inet_aton(`ip`) ASC"]
+  end
 end
 
 describe Sorted::ViewHelpers::ActionView do
@@ -26,6 +54,9 @@ describe Sorted::ViewHelpers::ActionView do
       def request
         Request.new
       end
+      
+      def _prefixes
+      end
     end
     class Request
       def get?; true end

data/spec/sorter_spec.rb

@@ -17,9 +17,10 @@ describe Sorted::Sorter, "parse methods" do
     sorter.sorts.should == [["email", "desc"], ["name", "desc"]]
   end
 
-  it "should allow underscores, full stops and colons in" do
-    sorter = Sorted::Sorter.new('users.email ASC, users.phone_number DESC, assessments.name ASC, assessments.number_as_string::BigInt', {:sort => "users.email_desc!users.first_name_desc"})
-    sorter.to_sql.should == "users.email DESC, users.first_name DESC, users.phone_number DESC, assessments.name ASC, assessments.number_as_string::BigInt ASC"
+  it "should allow numbers, underscores, full stops and colons in" do
+    sorter = Sorted::Sorter.new('users.email ASC, users.phone_number DESC, assessments.name ASC, assessments.number_as_string::BigInt, assessments.column_with_number_123', {:sort => "users.email_desc!users.first_name_desc"})
+    sorter.to_sql.should == "users.email DESC, users.first_name DESC, users.phone_number DESC, assessments.name ASC, assessments.number_as_string::BigInt ASC, assessments.column_with_number_123 ASC"
+    sorter.includes.size.should == 2
   end
 end
 
@@ -27,6 +28,7 @@ describe Sorted::Sorter, "logic:" do
   it "should not toggle the sort order and include any sql orders not in sort params" do
     sorter = Sorted::Sorter.new("email ASC, phone ASC, name DESC", {:sort => "email_desc!name_desc"})
     sorter.to_a.should == [["email", "desc"], ["name", "desc"], ["phone", "asc"]]
+    sorter.includes.size.should == 0
   end
 
   it "should return an sql sort string" do
@@ -43,6 +45,11 @@ describe Sorted::Sorter, "logic:" do
     sorter = Sorted::Sorter.new('email ASC, phone DESC, name ASC', {:sort => "email_desc!name_desc"})
     sorter.to_sql.should == "email DESC, name DESC, phone DESC"
   end
+
+  it "should substitute symbolic sorts" do
+    sorter = Sorted::Sorter.new('ip_address', :symbolic_sorts => {:ip_address => 'inet_aton(`ip_address`)'})
+    sorter.to_sql.should == "inet_aton(`ip_address`) ASC"
+  end
 end
 
 describe Sorted::Sorter, "to_css" do

metadata

@@ -1,79 +1,59 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sorted
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 7
-  version: 0.3.7
+version: !ruby/object:Gem::Version
+  version: 0.3.8
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Rufus Post
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-12-16 00:00:00 +11:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70138519878420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rails
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70138519878420
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70138519876540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70138519876540
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70138519874500 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.0.0
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *70138519874500
 description: lets you sort large data sets using view helpers and a scope
-email: 
+email:
 - rufuspost@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .document
 - .gitignore
+- .watchr
 - Gemfile
 - LICENSE
 - README.rdoc
@@ -90,39 +70,31 @@ files:
 - spec/sorter_spec.rb
 - spec/spec_helper.rb
 - spec/toggler_spec.rb
-has_rdoc: true
 homepage: http://rubygems.org/gems/sorted
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1254694282220959241
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: sorted
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: sort data with a database
 test_files: []
-