mongoid-sleeping_king_studios 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29178b4032ba47697556efe5804600c73450fb69
-  data.tar.gz: 1df094986f9fba1e988117c46df89ae85b44134c
+  metadata.gz: 287eebf704b95b0ecc4b7d38feecd57d335f743c
+  data.tar.gz: 92be00de6a85145ad88e07bb74b83e33a4b14f72
 SHA512:
-  metadata.gz: c492123648a5e294f516a5b06494ae133166ae1c8c565453dc427ab066479e88ab0c1ae1dfe30a234a294149cc64526eab701c61112c7314e8db83f84accad7a
-  data.tar.gz: 163787e59bc295cac492c8da46e21563c2f98cc441729c91f045149caa71d7cf814865740d92ff6e5fe970a4129b3c7e2aefcb5b6ca7d2aafc7fe8bbd289244d
+  metadata.gz: b389a9cead7baeb1462535a446a89d772b9bb438e48fdd8dc8e08e0a30722f671d1be7e453eddc6ad260cab6302918079b12611425addfcc6d59afe4fda918c5
+  data.tar.gz: 8d093d8555253a54afae3a8924023ad422e1f5c2d44c303400a8c126988164f4e3380d30685139ce25add4d5c6eb13022829869d8061a6c57b9437c80a73a087

data/CHANGELOG.md

@@ -1,8 +1,22 @@
 # Changelog
 
+## 0.7.6
+
+### New Features
+
+* Moved Orderable finders into included/extended modules, so classes including
+  the concern can override the finders and use super() to call the originals. 
+  Also adds optional scope parameter to finders, which filters the results and
+  defaults to base class ::all.
+
+### Resolved Issues
+
+* Add unique relation names for each ordering, fixing some undefined behavior 
+  when multiple orderings were defined on the same model.
+
 ## 0.7.5
 
-## New Features
+### New Features
 
 * Add #first and #last helpers to Orderable concern.
 
@@ -22,13 +36,13 @@
 
 ## 0.7.1
 
-## New Features
+### New Features
 
 * Add #next and #prev helpers to Orderable concern.
 
 ## 0.7.0
 
-## New Features
+### New Features
 
 * Add Orderable concern.
 

data/README.md

@@ -108,21 +108,25 @@ via the :as option (see below). For example, providing :as =>
 :alphabetical_order will generate helpers \#next_alphabetical, 
 \#prev_alphabetical, and ::reorder_alphabetical!.
 
-##### \#first_ordering_name
+##### \#next_ordering_name
 
-Finds the first document, based on the stored ordering values.
+Finds the next document, based on the stored ordering values. Takes an optional
+scope parameter to filter the results.
 
-##### \#last_ordering_name
+##### \#prev_ordering_name
 
-Finds the last document, based on the stored ordering values.
+Finds the previous document, based on the stored ordering values. Takes an 
+optional scope parameter to filter the results.
 
-##### \#next_ordering_name
+##### \::first_ordering_name
 
-Finds the next document, based on the stored ordering values.
+(Class Method) Finds the first document, based on the stored ordering values. 
+Takes an optional scope parameter to filter the results.
 
-##### \#prev_ordering_name
+##### \::last_ordering_name
 
-Finds the previous document, based on the stored ordering values.
+(Class Method) Finds the last document, based on the stored ordering values. 
+Takes an optional scope parameter to filter the results.
 
 ##### ::reorder_ordering_name!
 

data/lib/mongoid/sleeping_king_studios/orderable/metadata.rb

@@ -6,30 +6,51 @@ module Mongoid::SleepingKingStudios
   module Orderable
     # Stores information about an Orderable concern.
     class Metadata < Mongoid::SleepingKingStudios::Concern::Metadata
-      # @param [Symbol, String] name The name of the concern or relation.
-      # @param [Hash] properties The properties of the concern or relation.
-      def initialize name, properties = {}
-        super
+      class << self
+        def default_field_name sort_params
+          (sort_params.map { |key, value|
+            "#{key}_#{value == 1 ? 'asc' : 'desc'}"
+          }.join('_') + '_order').intern
+        end # class method default_field_name
 
-        self[:sort_params] = case properties[:sort_params]
-        when Array
-          properties[:sort_params].reduce({}) do |hsh, param|
-            hsh.merge parse_sort_param(param)
-          end # each
-        when Hash
-          properties[:sort_params].each.with_object({}) do |(key, value), hsh|
-            hsh[key] = parse_sort_direction(value)
-          end # each
-        when Symbol, Origin::Key
-          parse_sort_param(properties[:sort_params])
-        end # case
-      end # method initialize
+        def normalize_sort_params sort_params
+          case sort_params
+          when Array
+            sort_params.reduce({}) do |hsh, param|
+              hsh.merge parse_sort_param(param)
+            end # each
+          when Hash
+            sort_params.each.with_object({}) do |(key, value), hsh|
+              hsh[key] = parse_sort_direction(value)
+            end # each
+          when Symbol, Origin::Key
+            parse_sort_param(sort_params)
+          end # case
+        end # class method normalize_sort_params
+
+        private
+
+        def parse_sort_direction direction
+          (direction == -1 || direction.to_s.downcase == 'desc') ? -1 : 1
+        end # class method parse_sort_direction
+
+        def parse_sort_param param
+          case param
+          when Array
+            { param[0] => parse_sort_direction(param[1]) }
+          when Origin::Key
+            { param.name => param.operator }
+          when Symbol
+            { param => 1 }
+          end # case
+        end # class method parse_sort_param
+      end # class << self
 
       # The name of the field used to store the order.
       #
       # @return [Symbol] The field name.
       def field_name
-        fetch(:as, default_field_name).intern
+        fetch(:as, Metadata.default_field_name(self[:sort_params])).intern
       end # method field_name
 
       # @return [Boolean] True if a custom field name is defined; otherwise
@@ -83,29 +104,6 @@ module Mongoid::SleepingKingStudios
       def sort_criteria criteria
         filter_criteria(criteria).order_by(self[:sort_params])
       end # method sort_criteria
-
-      private
-
-      def default_field_name
-        self[:sort_params].map { |key, value|
-          "#{key}_#{value == 1 ? 'asc' : 'desc'}"
-        }.join('_') + '_order'
-      end # method default_field_name
-
-      def parse_sort_param param
-        case param
-        when Array
-          { param[0] => parse_sort_direction(param[1]) }
-        when Origin::Key
-          { param.name => param.operator }
-        when Symbol
-          { param => 1 }
-        end # case
-      end # method sort_param=
-
-      def parse_sort_direction direction
-        (direction == -1 || direction.to_s.downcase == 'desc') ? -1 : 1
-      end # method parse_sort_direction
     end # class
   end # module
 end # module

data/lib/mongoid/sleeping_king_studios/orderable.rb

@@ -33,9 +33,10 @@ module Mongoid::SleepingKingStudios
     #   collection, generating the cached order index.
     # @param [Hash] options The options for the relation.
     def self.apply base, sort_params, options
-      name = :orderable
       validate_options    name, options
+      sort_params = Metadata.normalize_sort_params(sort_params)
       options.update :sort_params => sort_params
+      name = options.fetch(:as, Metadata.default_field_name(sort_params))
       meta = characterize name, options, Metadata
 
       relate base, name, meta
@@ -109,24 +110,33 @@ module Mongoid::SleepingKingStudios
       base_name = metadata.field_name.to_s.gsub(/_order\z/,'')
       filtered  = metadata.filter_criteria(base)
 
-      base.send :define_method, :"first_#{base_name}" do
-        filtered.order_by(metadata.field_name.asc).limit(1).first
+      # Define instance-level helpers.
+      instance_methods = Module.new
+
+      instance_methods.send :define_method, :"next_#{base_name}" do |scope = base|
+        metadata.filter_criteria(scope).asc(metadata.field_name).
+          where(metadata.field_name.gt => send(metadata.field_name)).limit(1).first
       end # method
 
-      base.send :define_method, :"last_#{base_name}" do
-        filtered.order_by(metadata.field_name.desc).limit(1).first
+      instance_methods.send :define_method, :"prev_#{base_name}" do |scope = base|
+        metadata.filter_criteria(scope).desc(metadata.field_name).
+          where(metadata.field_name.lt => send(metadata.field_name)).limit(1).first
       end # method
-      
-      base.send :define_method, :"next_#{base_name}" do
-        filtered.order_by(metadata.field_name.asc).where(metadata.field_name.gt => send(metadata.field_name)).limit(1).first
+
+      base.send :include, instance_methods
+
+      # Define class-level helpers.
+      class_methods = Module.new
+
+      class_methods.send :define_method, :"first_#{base_name}" do |scope = base|
+        metadata.filter_criteria(scope).asc(metadata.field_name).limit(1).first
       end # method
 
-      base.send :define_method, :"prev_#{base_name}" do
-        filtered.order_by(metadata.field_name.desc).where(metadata.field_name.lt => send(metadata.field_name)).limit(1).first
+      class_methods.send :define_method, :"last_#{base_name}" do |scope = base|
+        metadata.filter_criteria(scope).desc(metadata.field_name).limit(1).first
       end # method
 
-      meta = class << base; self; end
-      meta.send :define_method, :"reorder_#{base_name}!" do
+      class_methods.send :define_method, :"reorder_#{base_name}!" do
         base.update_all(metadata.field_name => nil)
         
         criteria = metadata.sort_criteria(base)
@@ -136,6 +146,8 @@ module Mongoid::SleepingKingStudios
           record.set(metadata.field_name => index)
         end # each
       end # method
+
+      base.extend class_methods
     end # module method define_helpers
 
     # Returns a list of options that are valid for this concern.
@@ -175,6 +187,26 @@ module Mongoid::SleepingKingStudios
         concern.apply self, sort_params, options
       end # class method slugify
 
+      # @!method first_ordering_name
+      #   Finds the first 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 #first_alphabetical.
+      # 
+      #   @return [Mongoid::Document, nil] The first document in the order, or
+      #     nil if there are no documents in the collection.
+
+      # @!method last_ordering_name
+      #   Finds the last 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 #last_alphabetical.
+      # 
+      #   @return [Mongoid::Document, nil] The last document in the order, or nil
+      #     if there are no documents in the collection.
+
       # @!method reorder_ordering_name!
       #   Iterates through the entire collection and sets the cached order of
       #   each item to its current order index. Filtered items have their order
@@ -187,26 +219,6 @@ module Mongoid::SleepingKingStudios
       #   result in a class method ::reorder_alphabetical!.
     end # module
 
-    # @!method first_ordering_name
-    #   Finds the first 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 #first_alphabetical.
-    # 
-    #   @return [Mongoid::Document, nil] The first document in the order, or
-    #     nil if there are no documents in the collection.
-
-    # @!method last_ordering_name
-    #   Finds the last 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 #last_alphabetical.
-    # 
-    #   @return [Mongoid::Document, nil] The last document in the order, or nil
-    #     if there are no documents in the collection.
-
     # @!method next_ordering_name
     #   Finds the next document, based on the stored ordering values.
     # 

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.5'
+    VERSION = '0.7.6'
   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.5
+  version: 0.7.6
 platform: ruby
 authors:
 - Rob "Merlin" Smith