active_record-order_by_ids 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3afa8338134c4e7b9f441477d71e9424e55ec92d8dd6f357cf5bc4c767408e8d
-  data.tar.gz: 01b929e254b8bd933c97d4966289a9963c53c698567e39910b518c8417768173
+  metadata.gz: f4b4601b1f55aa5a1b0978ca907b20498150c0c8e21007184cf2abdc703c860e
+  data.tar.gz: 2ef33bf45124c8cc6008f585f0da6db7a9a74e6362a66ce94fcfe74fdc42093d
 SHA512:
-  metadata.gz: 1a0c9cd88df3ee766afdecab5d6e7c0f9e05bbeb99ac95925f2be2c61b83f9582385261c1822ea2a43e4f332747e9c15da1a3f65c3039e12f77fcc94640d716f
-  data.tar.gz: 7e4dee5772a214d6857f162a8ef08eca473a7b7ab392d1f2e9fc24a1fd66fbf15d02c12e2c2374be85f8f4ff01bf525be69f42c30d6bd4d5bab354f154bc087c
+  metadata.gz: 1989430231c2fa54376ebf8e95e899c02f1271e07b039de7a2ac5c7d830bd41b128c1888c652207d533314b2dd8c3cd7b8996bad1741395a9a8b7be4f093c3aa
+  data.tar.gz: cea1a292c37da0c86225065254e2ecc5547fb82905ed435c71ede05f4ab746273939c0f4020405e195bef38c257396a6c20ff43357760d40f261f3704d26762b

data/.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 /.ruby-version
+/Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -1,8 +1,6 @@
 # ActiveRecord::OrderByIds
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/active_record/order_by_ids`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+ActiveRecord scope methods for ordering by an explicit list of values.
 
 ## Installation
 
@@ -22,7 +20,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem adds two methods to active record scopes: `.order_by_ids`, and the more general `.order_by`.
+
+Examples:
+
+```ruby
+user1 = User.create(id: 1)
+user2 = User.create(id: 2)
+user3 = User.create(id: 3)
+
+User.order_by_ids([2,3,1]) #=> [user2, user3, user1]
+```
+
+```ruby
+user3 = User.create(parent_id: 3)
+user2 = User.create(parent_id: 2)
+user1 = User.create(parent_id: 1)
+
+User.order_by(parent_id: [2,3,1]) #=> [user2, user3, user1]
+```
 
 ## Development
 

data/lib/active_record/order_by_ids.rb

@@ -4,10 +4,16 @@ require "active_record"
 module ActiveRecord
   module OrderByIds
     def order_by_ids ids
-      fragments = []
-      fragments += ["#{primary_key} NOT IN (#{ids.map(&:to_s).join(",")})"] if ids.any?
-      fragments += ids.reverse.map { |id| "#{primary_key}=#{id}" }
-      reorder(Arel.sql(fragments.join(", ")))
+      order_by(primary_key => ids)
+    end
+
+    def order_by hash
+      hash.reduce(reorder(false)) do |scope, (key, ids)|
+        fragments = []
+        fragments += ["#{key} NOT IN (#{ids.map(&:to_s).join(",")}) OR #{key} IS NULL"] if ids.any?
+        fragments += ids.reverse.map { |id| "#{key}=#{id}" }
+        scope.order!(Arel.sql(fragments.join(", ")))
+      end
     end
   end
 end

data/lib/active_record/order_by_ids/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module OrderByIds
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record-order_by_ids
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Micah Geisel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2020-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -119,7 +119,6 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,65 +0,0 @@
-PATH
-  remote: .
-  specs:
-    active_record-order_by_ids (0.1.0)
-      activerecord
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activerecord (6.0.2.1)
-      activemodel (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activesupport (6.0.2.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    appraisal (2.2.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    byebug (11.1.1)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    i18n (1.8.2)
-      concurrent-ruby (~> 1.0)
-    minitest (5.14.0)
-    rake (10.5.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    sqlite3 (1.4.2)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.6)
-      thread_safe (~> 0.1)
-    zeitwerk (2.2.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  active_record-order_by_ids!
-  appraisal
-  bundler (~> 2.0)
-  byebug
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  sqlite3
-
-BUNDLED WITH
-   2.1.4