sorted 0.3.9 → 0.4.0

data/README.rdoc

@@ -5,105 +5,18 @@ sort string to let you sort large datasets over many pages (using
 {will_paginate}[http://github.com/mislav/will_paginatea] or
 {kaminari}[https://github.com/amatsuda/kaminari]) without loosing state.
 
-If you would like to see it in action clone the
-{example app}[https://github.com/mynameisrufus/sorted_app]
-
 === Gemfile
 
-  gem 'sorted' '~> 0.3.9'
+  gem 'sorted', '~> 0.4.0'
 
 === View
 
-  link_to_sorted "Email", :email
-
-This will generate a link with a url like this:
-
-  http://myapp/users?sort=email_asc
+Generate a sorted link with the email attribute:
 
-and on the next page load when you then sort by something else....
-
-  http://myapp/users?sort=name_asc!email_asc
+  link_to_sorted "Email", :email
 
 === Model
 
-This will initially sort by email ascending with the optional second
-default order argument:
-
-  @users = User.sort(params[:sort], "email ASC").page(params[:page])
-
-==== Joins and includes
-
-If you want to sort by a belongs to relationship add the table name to
-the order argument. For example assuming a user belongs to a company:
-
-  @users = User.joins(:company).sort(params[:sort], "companies.name ASC").page(params[:page])
-
-When generating links using the +link_to_sorted+ method you should
-specify the table for every attribute you use as well otherwise you
-will probably get an ambiguous column name error.
-
-  <th class="ui-state-default"><%= link_to_sorted "Company name", 'companies.name' %></th>
-  <th class="ui-state-default"><%= link_to_sorted "Users name", 'users.name' %></th>
-
-==== Typecasting and DB functions
-
-Do your type casting and function calls in your select statement with an
-alias, for example:
-
-  # controller
-  @users = User.select("income::BigInt as bg_income").sort(params[:sort], "bg_income ASC")
-  
-  # view
-  <th class="ui-state-default"><%= link_to_sorted "Income", 'bg_income' %></th>
-
-or using a DB function:
-
-  # controller
-  @users = User.select("inet_aton(`ip_address`) AS in_ip").sort(params[:sort], "in_ip ASC")
-
-  # view
-  <th class="ui-state-default"><%= link_to_sorted "IP address", 'in_ip' %></th>
-
-== Presentation
-
-You might want to roll your own +link_to_sorted+ method to use jQuery ui
-css classes for example, all you need is the sorted object.
-
-  def link_to_sorted(name, order)
-    dup_params = (request.get? && !params.nil?) ? params.dup : nil
-    sorter     = ActionView::Base::SortedViewHelper.new(order, dup_params)
-    css_class  = case sorter.css
-                 when "sorted asc"
-                   "ui-icon ui-icon-triangle-1-n"
-                 when "sorted desc"
-                   "ui-icon ui-icon-triangle-1-s"
-                 when "sorted"
-                   "ui-icon ui-icon-carat-2-n-s"
-                 end
-    link_to(content_tag(:span, nil, {:class => css_class}) + name.to_s, sorter.params)
-  end
-
-Tables are best displayed with alternating shades for each row, so add
-an alternating class to you table rows using the rails +cycle+ method:
-
-  <tr class="<%= cycle 'odd', 'even' %>">
-
-== Rails 2.3.x
-
-Sorted works with rails 2.3.x but you will have to roll your own scope
-and view helper.
-
-Here is the named scope for your model(s):
-
-  named_scope :sort, lambda { |sort, order|
-    { :order =>  Sorted::Parser.new(sort, order).to_sql }
-  }
-
-and the application helper method:
+Using the +sort+ method with the optional default order argument:
 
-  def link_to_sorted(name, order, options = {})
-    dup_params      = (request.get? && !params.nil?) ? params.dup : nil
-    sorter          = Sorted::ViewHelpers::ActionView::SortedViewHelper.new(order, dup_params)
-    options[:class] = [options[:class], sorter.css].join(' ').strip
-    link_to(name.to_s, sorter.params, options)
-  end
+  @users = User.sorted(params[:sort], "email ASC").page(params[:page])

data/lib/sorted/orms/active_record.rb

@@ -4,12 +4,10 @@ require 'sorted'
 module Sorted
   module Orms
     module ActiveRecord
-      def self.enable!
-        ::ActiveRecord::Base.class_eval do
-          def self.sort(sort, order = nil)
-            sorter = ::Sorted::Parser.new(sort, order)
-            order sorter.to_sql
-          end
+      def self.included(base)
+        def base.sorted(sort, default_order = nil)
+          sorter = ::Sorted::Parser.new(sort, default_order)
+          order sorter.to_sql
         end
       end
     end

data/lib/sorted/railtie.rb

@@ -2,16 +2,18 @@ require 'sorted'
 
 module Sorted
   class Railtie < Rails::Railtie
-    initializer "sorted.active_record" do |app|
-      if defined? ::ActiveRecord
+    if defined? ::ActiveRecord
+      initializer "sorted.active_record" do |app|
         require 'sorted/orms/active_record'
-        Sorted::Orms::ActiveRecord.enable!
+        ::ActiveRecord::Base.send(:include, Sorted::Orms::ActiveRecord)
       end
     end
     
-    initializer "sorted.action_view" do |app|
-      require 'sorted/view_helpers/action_view'
-      ::ActionView::Base.send(:include, Sorted::ViewHelpers::ActionView)
+    if defined? ::ActiveRecord
+      initializer "sorted.action_view" do |app|
+        require 'sorted/view_helpers/action_view'
+        ::ActionView::Base.send(:include, Sorted::ViewHelpers::ActionView)
+      end
     end
   end
 end

data/lib/sorted/version.rb

@@ -1,3 +1,3 @@
 module Example
-  VERSION = "0.3.9"
+  VERSION = "0.4.0"
 end

data/sorted.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bundler", ">= 1.0.0"
   s.add_development_dependency "rails", ">= 3.1.2"
   s.add_development_dependency "rspec", ">= 2.0.0"
+  s.add_development_dependency "sqlite3", ">= 1.3.5"
 
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact

data/spec/sorted/orms/active_record_spec.rb

@@ -1,11 +1,27 @@
 require 'spec_helper'
 
 describe Sorted::Orms::ActiveRecord do
-  before(:each) do
-    Sorted::Orms::ActiveRecord.enable!
+  ActiveRecord::Base.send(:include, Sorted::Orms::ActiveRecord)
+  
+  class SortedActiveRecordTest < ActiveRecord::Base
+    establish_connection :adapter => 'sqlite3', :database => '/tmp/foobar.db'
+
+    connection.create_table table_name, :force => true do |t|
+      t.string :name
+    end
+
+    scope :page, lambda {
+      limit(50)
+    }
   end
 
   it "should integrate with ActiveRecord::Base" do
-    ActiveRecord::Base.should respond_to(:sort)
+    SortedActiveRecordTest.should respond_to(:sorted)
+  end
+
+  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
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorted
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-20 00:00:00.000000000 Z
+date: 2012-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70134746957060 !ruby/object:Gem::Requirement
+  requirement: &70297045252360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70134746957060
+  version_requirements: *70297045252360
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70134746956600 !ruby/object:Gem::Requirement
+  requirement: &70297045251840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.1.2
   type: :development
   prerelease: false
-  version_requirements: *70134746956600
+  version_requirements: *70297045251840
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70134746956100 !ruby/object:Gem::Requirement
+  requirement: &70297045251140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,18 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *70134746956100
+  version_requirements: *70297045251140
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70297045247200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: *70297045247200
 description: lets you sort large data sets using view helpers and a scope
 email:
 - rufuspost@gmail.com
@@ -84,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -354722037037653326
+      hash: -603896101193403601
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: