activerecord-sort 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ad6ad083d32b5354b090af30d25fb20c5b43c74
-  data.tar.gz: 9cbb97bae8eefbae937cf0ebc82154fbae1020e8
+  metadata.gz: 64d26616c5be5b175e976284d70e5dcc6b79990b
+  data.tar.gz: 7ffa19e030b2e7de432f52187d4dec524a68b96b
 SHA512:
-  metadata.gz: 589a24220b64270fc59cb5e75f286fb51858150a451f1f4d464a3c45137c163c0d4e02f64d6946181b77fc41fce2a46cda96db965fb379349c5aaf09c17147bf
-  data.tar.gz: 63024dc5a854cf4f18ddadc8d5e13e6816ce671c2fcf9a7cdef34ad636b18ed63642330447401bcb750b81885b989bcf0828f6b63dc226aa0e193c6f08c9a4e7
+  metadata.gz: 1da137f286a3a2d0005cef33b91534cda3caab256e1cf9dbb105aed2c851f01a81ccb0e2b4104b2daabad1f5ac8726c56efa8b975dc166428c5299807f3ca503
+  data.tar.gz: 3ee7ff9be612e95a2906f4a559d3661aba387c238c25409334cc1f8a6290122b2f890103dcf74360a448875afec2a637aced2d448e11fff9f6f635d5e1991885

data/README.md

@@ -1,2 +1,46 @@
-# activerecord-sort
-A safe way to accept user parameters and order against your ActiveRecord Models
+# ActiveRecord::sort
+
+`ActiveRecord::sort` provides and easy way to accept user input and order a query by the input.
+
+Installtion
+-----------
+
+- Add `gem 'activerecord-sort', require: 'active_record/sort'
+- Run `bundle install`
+
+Examples
+--------
+`ActiveRecord::sort` supports the following cases:
+
+```ruby
+Property.order(:id).to_sql
+# => "...ORDER BY properties.id ASC"
+
+Property.order(:id, :name).to_sql
+# => "...ORDER BY properties.id ASC, properties.name ASC"
+
+Property.order(:id => :desc).to_sql
+# => "...ORDER BY properties.id DESC"
+
+Property.order(:id => {:asc => :nulls_first})
+# => "...ORDER BY properties.id ASC NULLS FIRST"
+
+Property.order(:id => {:asc => :nulls_last})
+# => "...ORDER BY properties.id ASC NULLS LAST"
+```
+
+It can also sort on relations:
+
+```ruby
+Property.order(:addresses => :id).to_sql
+# => "...INNER JOIN addresses ON addresses.property_id = properties.id
+# => "   ORDER BY addresses.id ASC"
+
+Property.order(:addresses => {:id => :desc}).to_sql
+# => "...INNER JOIN addresses ON addresses.property_id = properties.id
+# => "   ORDER BY addresses.id DESC"
+
+Property.order(:addresses => {:id => {:asc => :nulls_frist}}).to_sql
+# => "...INNER JOIN addresses ON addresses.property_id = properties.id
+# => "   ORDER BY addresses.id ASC NULLS FIRST"
+```

data/ext/active_record/base.rb

@@ -15,7 +15,7 @@ class ActiveRecord::Base
       return resource if ordering.size == 0
       
       ordering.each do |order|
-        order = sort_order_to_column_and_options(order)
+        order = Array(order)
 
         order.each do |column_or_relation, options|
           if self.column_names.include?(column_or_relation.to_s)
@@ -54,7 +54,7 @@ class ActiveRecord::Base
         options = [options] if !options.is_a?(Array)
 
         options.each do |order|
-          order = sort_order_to_column_and_options(order)
+          order = Array(order)
           order.each do |column, options|
             column = relation.klass.arel_table[column]
             direction = (options.is_a?(Hash) ? options.keys.first.to_sym : options.to_s.downcase.to_sym)
@@ -87,7 +87,7 @@ class ActiveRecord::Base
         options = [options] if !options.is_a?(Array)
 
         options.each do |order|
-          order = sort_order_to_column_and_options(order)
+          order = Array(order)
           order.each do |column, options|
             column = relation.klass.arel_table[column]
             direction = (options.is_a?(Hash) ? options.keys.first.to_sym : options.to_s.downcase.to_sym)
@@ -108,13 +108,5 @@ class ActiveRecord::Base
       resource
     end
 
-    def sort_order_to_column_and_options(column)
-      if column.is_a?(Symbol)
-        [column]
-      else
-        column
-      end
-    end
-
   end
 end

data/lib/active_record/sort/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Sort
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-sort
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jon Bracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2015-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg