mongoid-sleeping_king_studios 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 218763356e4b6bc56393162ae45be295d7ccc478
-  data.tar.gz: 3fa4cfd1063e65e22322c5be1b183a6f04f10fc7
+  metadata.gz: fdbcd42bc1fb3604aaf7be52d70f408408af12b4
+  data.tar.gz: 05958760903d551da4b9789b2357ce27fb3df707
 SHA512:
-  metadata.gz: 1c2f385e2cc2184c33009e5907a15b8b052780dfbe90345dfa3bc9679a637e955df9acac88f2d429a207d53ba738d491db5d8ab491b2e4fa170b95f885803367
-  data.tar.gz: 7b579653a20b03b32db94736019d9c0caec715884948b9eff640397cae9d518c3f364d47c25e09a4bb2795151531f7f35316940aca01ee01629b1a4dd3c669d0
+  metadata.gz: 7440b1410fcef46d1c2e35c9e813253d492faa2b4a92b5b880e2ca620edc6acd2b62e7146863c3b1d3f01c6683bcbd085dca6a125226a5f353093f15e891eb1e
+  data.tar.gz: c51b962818822ec95937220a58f5a6189e10d239abf8237017e4bcf42e809a18c9089823601f3379c99adac5c9e61eca3fb389cca3a752123d5fba870c6d21e0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.7.1
+
+* Add #next and #prev helpers to Orderable concern.
+
 ## 0.7.0
 
 * Add Orderable concern.

data/README.md

@@ -102,14 +102,27 @@ The ::cache_ordering method accepts a subset of the params for an Origin
 
 #### Helpers
 
-Creating an ordering cache also creates the following helpers:
+Creating an ordering cache also creates the following helpers. The name of the
+generated helpers will depend on the sort params provided, or the name given 
+via the :as option (see below). For example, providing :as => 
+:alphabetical_order will generate helpers \#next_alphabetical, 
+\#prev_alphabetical, and ::reorder_alphabetical!.
+
+##### \#next_ordering_name
+
+Finds the next document, based on the stored ordering values.
+
+##### \#prev_ordering_name
+
+Finds the previous document, based on the stored ordering values.
 
 ##### ::reorder_ordering_name!
 
-Loops through the collection and sets each item's field to the appropriate
-ordered index. Normally, this is handled on item save, but this helper allows
-a bulk update of the collection when adding the concern to an existing model,
-or if data corruption or other issues have broken the existing values.
+(Class Method) Loops through the collection and sets each item's field to the 
+appropriate ordered index. Normally, this is handled on item save, but this 
+helper allows a bulk update of the collection when adding the concern to an 
+existing model, or if data corruption or other issues have broken the existing 
+values.
 
 #### Options
 

data/lib/mongoid/sleeping_king_studios/orderable.rb

@@ -106,7 +106,19 @@ module Mongoid::SleepingKingStudios
     # @param [Class] base The base class into which the concern is mixed in.
     # @param [Metadata] metadata The metadata for the relation.
     def self.define_helpers base, metadata
-      name = :"reorder_#{metadata.field_name.to_s.gsub(/_order\z/,'')}!"
+      base_name = metadata.field_name.to_s.gsub(/_order\z/,'')
+      
+      name = :"next_#{base_name}"
+      base.send :define_method, name do
+        base.order_by(metadata.field_name.asc).where(metadata.field_name.gt => send(metadata.field_name)).limit(1).first
+      end # method
+
+      name = :"prev_#{base_name}"
+      base.send :define_method, name do
+        base.order_by(metadata.field_name.desc).where(metadata.field_name.lt => send(metadata.field_name)).limit(1).first
+      end # method
+
+      name = :"reorder_#{base_name}!"
       meta = class << base; self; end
       meta.send :define_method, name do
         base.update_all(metadata.field_name => nil)
@@ -166,7 +178,27 @@ module Mongoid::SleepingKingStudios
       # 
       #   The generated name of this method will depend on the sort params or
       #   the :as option provided. For example, :as => :alphabetical_order will
-      #   result in a class method ::reorder_alphabetical!
+      #   result in a class method ::reorder_alphabetical!.
     end # module
+
+    # @!method next_ordering_name
+    #   Finds the next document, based on the stored ordering values.
+    # 
+    #   The generated name of this method will depend on the sort params or the
+    #   :as option provided. For example, :as => :alphabetical_order will
+    #   result in an instance method #next_alphabetical.
+    # 
+    #   @return [Mongoid::Document, nil] The next document in the order, or nil
+    #     if there are no more documents in the collection.
+
+    # @!method prev_ordering_name
+    #   Finds the previous document, based on the stored ordering values.
+    # 
+    #   The generated name of this method will depend on the sort params or the
+    #   :as option provided. For example, :as => :alphabetical_order will
+    #   result in an instance method #prev_alphabetical.
+    # 
+    #   @return [Mongoid::Document, nil] The previous document in the order, or
+    #     nil if there are no prior documents in the collection.
   end # module
 end # module

data/lib/mongoid/sleeping_king_studios/version.rb

@@ -3,6 +3,6 @@
 module Mongoid
   module SleepingKingStudios
     # The current version of the gem.
-    VERSION = '0.7.0'
+    VERSION = '0.7.1'
   end # module
 end # module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-sleeping_king_studios
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Rob "Merlin" Smith