active_sort_order 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '089c16d2abd0a4aeb75c3a377d54f70883a7397758841c55f7bb64940cb3b205'
-  data.tar.gz: caf3be0137352d2c1df913f9bdf6749253d15e7ed852d1bba646a2ce58fe90f4
+  metadata.gz: 863fc9f8899a7aea2e126c5f482b1bb8d422513c644eaf26f4f58fbc52d82f6b
+  data.tar.gz: 81e3205c167c100991cbb2cf80a3528e6b4c471cfa63fa652d56572d5e981867
 SHA512:
-  metadata.gz: aaf7872401a767653abe756bc53955e2daa7df56cc1c37a204feff1f409290b0b11ea6cd9afc6e2376992e7be594f6d7c63add7f47e5ebee042fa9092f2dda1a
-  data.tar.gz: aff10d7f87d429fe6e6e3c14a1697d2641eaf7a2cd427475c79d6f803bcbca64a47861d8e0f93de79e26ed8c44fa9267b981cd5e5b83a4cf40ae3dd0c92b47bf
+  metadata.gz: f222b38e5900633eb6b2925a33e58d15425848183501b8ff5ab22010ad8fcd68ab2429dbf4de6302dae3155f49026330aa6c41c95fc52b777e13e257045cb7e8
+  data.tar.gz: 85f20d93e24af7b65ffb9371605e18d8729c0b4e2e34d1ad7283bc51beed78016e924a77a55a081d19e90af8c8e81b38d3a010b243de67547337947a1aa88c53

data/CHANGELOG.md

@@ -1,7 +1,13 @@
 CHANGELOG
 ---------
 
-- **Unreleased - [View Diff](https://github.com/westonganger/active_sort_order/compare/v0.9.2...master)**
+- **Unreleased - [View Diff](https://github.com/westonganger/active_sort_order/compare/v0.9.4...master)**
+  * Nothing yet
+
+- **v0.9.4 - [View Diff](https://github.com/westonganger/active_sort_order/compare/v0.9.3...v0.9.4)**
+  * Improve error handling for sort_col_sql argument
+
+- **v0.9.3 - [View Diff](https://github.com/westonganger/active_sort_order/compare/v0.9.2...v0.9.3)**
   * Allow ability to sort on multiple fields
 
 - **v0.9.2 - Apr 28, 2021 - [View Diff](https://github.com/westonganger/active_sort_order/compare/v0.9.1...v0.9.2)**

data/lib/active_sort_order/concerns/sort_order_concern.rb

@@ -5,13 +5,19 @@ module ActiveSortOrder
     included do
       
       scope :sort_order, ->(sort_col_sql = nil, sort_direction_sql = nil, base_sort_order: true){
-        if sort_col_sql.present?
-          if sort_col_sql.is_a?(Array)
-            sort_col_sql = sort_col_sql.map{|x| x.to_s }
+        if !sort_col_sql.is_a?(Array)
+          sort_col_sql = [sort_col_sql].compact
+        end
+
+        sort_col_sql.each_with_index do |x, i|
+          if [String, Symbol].exclude?(x.class)
+            raise ArgumentError.new("Invalid first argument `sort_col_sql`, expecting a String or Symbol or Array")
           else
-            sort_col_sql = sort_col_sql.to_s
+            sort_col_sql[i] = x.to_s
           end
+        end
 
+        if sort_col_sql.present?
           ### SORT DIRECTION HANDLING
           if sort_direction_sql.is_a?(Symbol)
             sort_direction_sql = sort_direction_sql.to_s.gsub('_', ' ')
@@ -41,10 +47,6 @@ module ActiveSortOrder
             end
           end
 
-          if !sort_col_sql.is_a?(Array)
-            sort_col_sql = [sort_col_sql]
-          end
-
           sql_str = sort_col_sql.map{|x| "#{x} #{sort_direction_sql}" }.join(", ")
         end
         

data/lib/active_sort_order/version.rb

@@ -1,3 +1,3 @@
 module ActiveSortOrder
-  VERSION = "0.9.3".freeze
+  VERSION = "0.9.4".freeze
 end

data/test/dummy_app/log/test.log

@@ -540,3 +540,215 @@ ActiveSortOrderTest: test_override_base_sort_order_only
 ActiveSortOrderTest: test_exposes_main_module
 ---------------------------------------------
   TRANSACTION (0.0ms)  rollback transaction
+   (1.0ms)  SELECT sqlite_version(*)
+   (0.1ms)  SELECT "ar_internal_metadata"."value" FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ?  [["key", "schema_sha1"]]
+   (0.0ms)  SELECT sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+  ActiveRecord::InternalMetadata Load (0.1ms)  SELECT "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ? LIMIT ?  [["key", "environment"], ["LIMIT", 1]]
+   (0.9ms)  DELETE FROM posts;
+   (0.7ms)  UPDATE `sqlite_sequence` SET `seq` = 0 WHERE `name` = 'posts';
+  Post Load (0.1ms)  SELECT "posts".* FROM "posts" WHERE "posts"."a" = ? AND "posts"."b" = ? LIMIT ?  [["a", 1], ["b", 3], ["LIMIT", 1]]
+  TRANSACTION (0.0ms)  begin transaction
+  Post Create (0.2ms)  INSERT INTO "posts" ("a", "b") VALUES (?, ?)  [["a", 1], ["b", 3]]
+  TRANSACTION (0.6ms)  commit transaction
+  Post Load (0.1ms)  SELECT "posts".* FROM "posts" WHERE "posts"."a" = ? AND "posts"."b" = ? LIMIT ?  [["a", 2], ["b", 2], ["LIMIT", 1]]
+  TRANSACTION (0.0ms)  begin transaction
+  Post Create (0.2ms)  INSERT INTO "posts" ("a", "b") VALUES (?, ?)  [["a", 2], ["b", 2]]
+  TRANSACTION (0.6ms)  commit transaction
+  Post Load (0.1ms)  SELECT "posts".* FROM "posts" WHERE "posts"."a" = ? AND "posts"."b" = ? LIMIT ?  [["a", 3], ["b", 2], ["LIMIT", 1]]
+  TRANSACTION (0.0ms)  begin transaction
+  Post Create (0.2ms)  INSERT INTO "posts" ("a", "b") VALUES (?, ?)  [["a", 3], ["b", 2]]
+  TRANSACTION (0.5ms)  commit transaction
+  Post Load (0.1ms)  SELECT "posts".* FROM "posts" WHERE "posts"."a" = ? AND "posts"."b" = ? LIMIT ?  [["a", 4], ["b", 1], ["LIMIT", 1]]
+  TRANSACTION (0.0ms)  begin transaction
+  Post Create (0.2ms)  INSERT INTO "posts" ("a", "b") VALUES (?, ?)  [["a", 4], ["b", 1]]
+  TRANSACTION (0.6ms)  commit transaction
+  Post Load (0.1ms)  SELECT "posts".* FROM "posts" WHERE "posts"."a" = ? AND "posts"."b" = ? LIMIT ?  [["a", 5], ["b", 1], ["LIMIT", 1]]
+  TRANSACTION (0.0ms)  begin transaction
+  Post Create (0.2ms)  INSERT INTO "posts" ("a", "b") VALUES (?, ?)  [["a", 5], ["b", 1]]
+  TRANSACTION (0.5ms)  commit transaction
+  TRANSACTION (0.0ms)  begin transaction
+-----------------------------------------------
+ActiveSortOrderTest: test_sort_direction_errors
+-----------------------------------------------
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-------------------------------------------------
+ActiveSortOrderTest: test_sort_on_multiple_fields
+-------------------------------------------------
+   (0.1ms)  SELECT COUNT(*) FROM "posts"
+  PostWithBaseOrderA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY b asc, a asc, posts.a ASC
+  PostWithBaseOrderA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY b desc, a desc, posts.a ASC
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+---------------------------------------------
+ActiveSortOrderTest: test_exposes_main_module
+---------------------------------------------
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+----------------------------------------------------
+ActiveSortOrderTest: test_class_base_sort_order_only
+----------------------------------------------------
+   (0.1ms)  SELECT COUNT(*) FROM "posts"
+  PostWithBaseOrderA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY posts.a ASC
+  PostWithBaseOrderB Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY posts.b ASC
+  PostWithBaseOrderAAndB Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY posts.a ASC, posts.b ASC
+  PostWithBaseOrderBAndA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY posts.b ASC, posts.a ASC
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-------------------------------------------------------------
+ActiveSortOrderTest: test_class_method_base_sort_order_errors
+-------------------------------------------------------------
+  TRANSACTION (0.1ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-------------------------------------------------------
+ActiveSortOrderTest: test_override_base_sort_order_only
+-------------------------------------------------------
+   (0.1ms)  SELECT COUNT(*) FROM "posts"
+  PostWithBaseOrderA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY posts.b ASC
+  PostWithBaseOrderA Load (0.0ms)  SELECT "posts".* FROM "posts" ORDER BY "posts"."id" ASC
+  PostWithBaseOrderA Load (0.0ms)  SELECT "posts".* FROM "posts" ORDER BY "posts"."id" ASC
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-------------------------------------------------------
+ActiveSortOrderTest: test_base_sort_order_default_value
+-------------------------------------------------------
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+---------------------------------------------------------
+ActiveSortOrderTest: test_argument_base_sort_order_errors
+---------------------------------------------------------
+  TRANSACTION (0.1ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-----------------------------------------
+ActiveSortOrderTest: test_exposes_version
+-----------------------------------------
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+--------------------------------------------------
+ActiveSortOrderTest: test_base_sort_order_and_sort
+--------------------------------------------------
+   (0.1ms)  SELECT COUNT(*) FROM "posts"
+  PostWithBaseOrderA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY posts.a DESC, posts.a ASC
+  PostWithBaseOrderB Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY posts.b DESC, posts.b ASC
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-----------------------------------------
+ActiveSortOrderTest: test_sort_str_errors
+-----------------------------------------
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-----------------------------------
+ActiveSortOrderTest: test_sort_only
+-----------------------------------
+   (0.1ms)  SELECT COUNT(*) FROM "posts"
+  PostWithBaseOrderA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY a desc, posts.a ASC
+  PostWithBaseOrderA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY posts.a DESC, posts.a ASC
+  TRANSACTION (0.0ms)  rollback transaction
+   (0.7ms)  SELECT sqlite_version(*)
+   (0.1ms)  SELECT "ar_internal_metadata"."value" FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ?  [["key", "schema_sha1"]]
+   (0.1ms)  SELECT sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+   (0.0ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+  ActiveRecord::InternalMetadata Load (0.1ms)  SELECT "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ? LIMIT ?  [["key", "environment"], ["LIMIT", 1]]
+   (1.3ms)  DELETE FROM posts;
+   (1.0ms)  UPDATE `sqlite_sequence` SET `seq` = 0 WHERE `name` = 'posts';
+  Post Load (0.1ms)  SELECT "posts".* FROM "posts" WHERE "posts"."a" = ? AND "posts"."b" = ? LIMIT ?  [["a", 1], ["b", 3], ["LIMIT", 1]]
+  TRANSACTION (0.0ms)  begin transaction
+  Post Create (0.2ms)  INSERT INTO "posts" ("a", "b") VALUES (?, ?)  [["a", 1], ["b", 3]]
+  TRANSACTION (0.6ms)  commit transaction
+  Post Load (0.1ms)  SELECT "posts".* FROM "posts" WHERE "posts"."a" = ? AND "posts"."b" = ? LIMIT ?  [["a", 2], ["b", 2], ["LIMIT", 1]]
+  TRANSACTION (0.0ms)  begin transaction
+  Post Create (0.2ms)  INSERT INTO "posts" ("a", "b") VALUES (?, ?)  [["a", 2], ["b", 2]]
+  TRANSACTION (0.7ms)  commit transaction
+  Post Load (0.1ms)  SELECT "posts".* FROM "posts" WHERE "posts"."a" = ? AND "posts"."b" = ? LIMIT ?  [["a", 3], ["b", 2], ["LIMIT", 1]]
+  TRANSACTION (0.0ms)  begin transaction
+  Post Create (0.2ms)  INSERT INTO "posts" ("a", "b") VALUES (?, ?)  [["a", 3], ["b", 2]]
+  TRANSACTION (0.7ms)  commit transaction
+  Post Load (0.1ms)  SELECT "posts".* FROM "posts" WHERE "posts"."a" = ? AND "posts"."b" = ? LIMIT ?  [["a", 4], ["b", 1], ["LIMIT", 1]]
+  TRANSACTION (0.0ms)  begin transaction
+  Post Create (0.2ms)  INSERT INTO "posts" ("a", "b") VALUES (?, ?)  [["a", 4], ["b", 1]]
+  TRANSACTION (0.6ms)  commit transaction
+  Post Load (0.1ms)  SELECT "posts".* FROM "posts" WHERE "posts"."a" = ? AND "posts"."b" = ? LIMIT ?  [["a", 5], ["b", 1], ["LIMIT", 1]]
+  TRANSACTION (0.0ms)  begin transaction
+  Post Create (0.2ms)  INSERT INTO "posts" ("a", "b") VALUES (?, ?)  [["a", 5], ["b", 1]]
+  TRANSACTION (0.7ms)  commit transaction
+  TRANSACTION (0.0ms)  begin transaction
+--------------------------------------------------
+ActiveSortOrderTest: test_base_sort_order_and_sort
+--------------------------------------------------
+   (0.1ms)  SELECT COUNT(*) FROM "posts"
+  PostWithBaseOrderA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY posts.a DESC, posts.a ASC
+  PostWithBaseOrderB Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY posts.b DESC, posts.b ASC
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-------------------------------------------------------------
+ActiveSortOrderTest: test_class_method_base_sort_order_errors
+-------------------------------------------------------------
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-----------------------------------
+ActiveSortOrderTest: test_sort_only
+-----------------------------------
+   (0.1ms)  SELECT COUNT(*) FROM "posts"
+  PostWithBaseOrderA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY a desc, posts.a ASC
+  PostWithBaseOrderA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY posts.a DESC, posts.a ASC
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-----------------------------------------
+ActiveSortOrderTest: test_exposes_version
+-----------------------------------------
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-----------------------------------------------
+ActiveSortOrderTest: test_sort_direction_errors
+-----------------------------------------------
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+---------------------------------------------------------
+ActiveSortOrderTest: test_argument_base_sort_order_errors
+---------------------------------------------------------
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-------------------------------------------------------
+ActiveSortOrderTest: test_override_base_sort_order_only
+-------------------------------------------------------
+   (0.1ms)  SELECT COUNT(*) FROM "posts"
+  PostWithBaseOrderA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY posts.b ASC
+  PostWithBaseOrderA Load (0.0ms)  SELECT "posts".* FROM "posts" ORDER BY "posts"."id" ASC
+  PostWithBaseOrderA Load (0.0ms)  SELECT "posts".* FROM "posts" ORDER BY "posts"."id" ASC
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-------------------------------------------------
+ActiveSortOrderTest: test_sort_on_multiple_fields
+-------------------------------------------------
+   (0.1ms)  SELECT COUNT(*) FROM "posts"
+  PostWithBaseOrderA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY b asc, a asc, posts.a ASC
+  PostWithBaseOrderA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY b desc, a desc, posts.a ASC
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-----------------------------------------
+ActiveSortOrderTest: test_sort_str_errors
+-----------------------------------------
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+---------------------------------------------
+ActiveSortOrderTest: test_exposes_main_module
+---------------------------------------------
+  TRANSACTION (0.0ms)  rollback transaction
+  TRANSACTION (0.0ms)  begin transaction
+-------------------------------------------------------
+ActiveSortOrderTest: test_base_sort_order_default_value
+-------------------------------------------------------
+  TRANSACTION (0.3ms)  rollback transaction
+  TRANSACTION (0.2ms)  begin transaction
+----------------------------------------------------
+ActiveSortOrderTest: test_class_base_sort_order_only
+----------------------------------------------------
+   (0.7ms)  SELECT COUNT(*) FROM "posts"
+  PostWithBaseOrderA Load (0.4ms)  SELECT "posts".* FROM "posts" ORDER BY posts.a ASC
+  PostWithBaseOrderB Load (0.4ms)  SELECT "posts".* FROM "posts" ORDER BY posts.b ASC
+  PostWithBaseOrderAAndB Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY posts.a ASC, posts.b ASC
+  PostWithBaseOrderBAndA Load (0.1ms)  SELECT "posts".* FROM "posts" ORDER BY posts.b ASC, posts.a ASC
+  TRANSACTION (0.1ms)  rollback transaction

data/test/unit/errors_test.rb

@@ -15,6 +15,8 @@ class ActiveSortOrderTest < ActiveSupport::TestCase
       :foo,
       nil,
       "",
+      [],
+      [:foo],
     ]
 
     valid.each do |v|
@@ -25,7 +27,6 @@ class ActiveSortOrderTest < ActiveSupport::TestCase
     invalid = [
       true,
       false,
-      [],
       Object.new,
     ]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_sort_order
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Weston Ganger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-14 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord