mongoid_orderable 4.0.0 → 4.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Njk2ODJiZDJmM2RiNmY2MTkzNDljNjkzYmI1ZGIzMzI5YzlhNjI1ZQ==
+    YThjMDBhYzQ5YmQ4NzJlZWRjMjdhZTIyNTdmMTkwMmE0YmZlZWI5NQ==
   data.tar.gz: !binary |-
-    NjU4ZWExYTdjN2MzOGY0YWQzN2RiMTk1NzI1ODM1NzUyNTdjMDkyNw==
+    ZjBmZDk1OTM1MmE1ZGNiMmFiMDU1Y2IxYTAwMzZlZTkzZWFiMjhlYQ==
 SHA512:
   metadata.gz: !binary |-
-    OWMyZGZkOTliN2MzNmVhOTExMWJkZDI5OTg0MzY0MTcwMjcyY2Q4MzMzZDdh
-    OTFkM2Q2NWNkMDQwZGQ0Y2FhZDQ4OTliN2ViMDM2MGJiNGY2M2FkMzI1NWRl
-    MjQ1MTM3NjkyNDZmOWYzZTYxYzY2NjI3ODI4OTQwYWJmZmMwNzA=
+    NDc5NWY5NTlkMDYzNWMzZGI3OGRiNjc0MDEzNjdhYWJiMDA5MTkzOTE5OGMx
+    YzA4NWZmNmZmZTJmNTZmNTdlNDFjZDk2NmJkOGQyNDMyMTM2Mjg2ZjU5NGE1
+    MmI0YzU2MmVhODdmMWY1MGI5ZDhhZTVkNGQ0NjRlNzNlMzI4ZDU=
   data.tar.gz: !binary |-
-    ODFjOGIwNDhhMjdjNjk4M2E5MzY2M2JmZDdiMWI2MDgzNWI2M2Y0NDA0YzAz
-    Mjg1YmU1OTM3YzgyNDVjZGU2ODdhMWU0YTcxYTc4YzQxYzE0MTRkYWIxYWNk
-    ZTU2NThlOGZlMmRjMDc3NGQ4MmVkYjQxYzM4YzY0MzhkZmY1N2E=
+    NTYyN2E1ZTVlNDQ5YzZhNDY5Y2UyNDMzZWVhZWQ4YWZmMTJkNTI0ZDNhNzIy
+    ZDg0MTkyZjY3YWVkNzdmNWM5ZDY3ZWJiNDMxYzk2NDM0ZWUxOTFiMmMxMWEy
+    ZjE2MmRiZDcyY2U5NTg1MjU3ODkwOGIwMDIxMDY0NDMyMmExMzQ=

data/.travis.yml

@@ -1,9 +1,9 @@
 rvm:
   - 1.8.7
-  - 1.9.2
   - 1.9.3
-  - ruby-head
-  #- rbx-19mode
+  - 2.0.0
+  - 2.1.1
+  # - rbx
 
 env:
   - MONGOID_VERSION=2
@@ -16,9 +16,5 @@ matrix:
       env: MONGOID_VERSION=3
     - rvm: 1.8.7
       env: MONGOID_VERSION=4
-    - rvm: 1.9.2
-      env: MONGOID_VERSION=3
-    - rvm: 1.9.2
-      env: MONGOID_VERSION=4
 
 services: mongodb

data/CHANGELOG.md

@@ -1,5 +1,13 @@
+# master
+
+# 4.1.0
+
+  * Resolving scope foreign key form passed relation name (@dsci)
+  * Fix: relation metadata quering (@pjkelly)
+  * `previous_items` and `next_items` methods (@mrjlynch)
+
 # 4.0.0
 
   * Semantic versioning
   * Added Mongoid 4 support (@dblock)
-  * Fixes by @johnnyshields and @zhengjia
+  * Fixes by @johnnyshields and @zhengjia

data/README.md

@@ -7,8 +7,8 @@ Mongoid::Orderable is a ordered list implementation for your mongoid models.
 # Why?
 
 * It uses native mongo batch increment feature
-* It supports assignable api
-* It proper assingns position while moving document between scopes
+* It supports mutators api
+* It correctly assigns the position while moving document between scopes
 * It supports mongoid 2, 3 and 4
 
 # How?
@@ -25,12 +25,16 @@ class Item
   include Mongoid::Orderable
 
   # belongs_to :group
+  # belongs_to :drawer, class_name: "Office::Drawer",
+  #            foreign_key: "legacy_drawer_key_id"
 
   # orderable
-  # orderable :scope => :group, :column => :pos
-  # orderable :scope => lambda { |document| where(:group_id => document.group_id) }
-  # orderable :index => false # this one if you want specify indexes manually
-  # orderable :base => 0 # count position from zero as the top-most value (1 is the default value)
+  # orderable scope: :group, column: :pos
+  # orderable scope: :drawer, column: :pos # resolves scope foreign key from relation
+  # orderable scope: 'drawer', column: :pos # but if you pass a string - it will use it as is, as the column name for scope
+  # orderable scope: lambda { |document| where(group_id: document.group_id) }
+  # orderable index: false # this one if you want specify indexes manually
+  # orderable base: 0 # count position from zero as the top-most value (1 is the default value)
 end
 ```
 
@@ -52,6 +56,12 @@ item.move_to_top
 item.move_to_bottom
 item.move_higher
 item.move_lower
+
+item.next_items # return a collection of items higher on the list
+item.previous_items # return a collection of items lower on the list
+
+item.next_item # returns the next item in the list
+item.previous_item # returns the previous item in the list
 ```
 
 # Contributing

data/lib/mongoid/orderable.rb

@@ -11,7 +11,17 @@ module Mongoid::Orderable
       }
 
       configuration.merge! options if options.is_a?(Hash)
-      configuration[:scope] = "#{configuration[:scope]}_id".to_sym if configuration[:scope].is_a?(Symbol) && configuration[:scope].to_s !~ /_id$/
+
+      if configuration[:scope].is_a?(Symbol) && configuration[:scope].to_s !~ /_id$/
+        scope_relation = self.relations[configuration[:scope].to_s]
+        if scope_relation
+          configuration[:scope] = scope_relation.key.to_sym
+        else
+          configuration[:scope] = "#{configuration[:scope]}_id".to_sym
+        end
+      elsif configuration[:scope].is_a?(String)
+        configuration[:scope] = configuration[:scope].to_sym
+      end
 
       field configuration[:column], orderable_field_opts(configuration)
       if configuration[:index]
@@ -58,6 +68,42 @@ module Mongoid::Orderable
     end
   end
 
+  ##
+  # Returns items above the current document.
+  # Items with a position lower than this document's position.
+  def previous_items
+    orderable_scoped.where(orderable_column.lt => self.position)
+  end
+  alias_method :prev_items, :previous_items
+
+  ##
+  # Returns items below the current document.
+  # Items with a position greater than this document's position.
+  def next_items
+    orderable_scoped.where(orderable_column.gt => self.position)
+  end
+
+  # returns the previous item in the list
+  def previous_item
+    if previous_items.present?
+      previous_position = self.position - 1
+      orderable_scoped.where(:position => previous_position).first
+    else
+      nil
+    end
+  end
+  alias_method :prev_item, :previous_item
+
+  # returns the next item in the list
+  def next_item
+    if next_items.present?
+      next_position = self.position + 1
+      orderable_scoped.where(:position => next_position).first
+    else
+      nil
+    end
+  end
+
   def move_to! target_position
     @move_to = target_position
     save
@@ -126,7 +172,7 @@ private
 
   def orderable_scoped
     if embedded?
-      send(metadata.inverse).send(metadata.name).orderable_scope(self)
+      send(MongoidOrderable.metadata(self).inverse).send(MongoidOrderable.metadata(self).name).orderable_scope(self)
     else
       (orderable_inherited_class || self.class).orderable_scope(self)
     end

data/lib/mongoid_orderable.rb

@@ -13,6 +13,14 @@ module MongoidOrderable
       instance.inc(attribute => value)
     end
   end
+
+  def self.metadata instance
+    if MongoidOrderable.mongoid2? || MongoidOrderable.mongoid3?
+      instance.metadata
+    else
+      instance.relation_metadata
+    end
+  end
 end
 
 require 'mongoid'

data/lib/mongoid_orderable/version.rb

@@ -1,3 +1,3 @@
 module MongoidOrderable
-  VERSION = '4.0.0'
+  VERSION = '4.1.0'
 end

data/spec/mongoid/orderable_spec.rb

@@ -25,6 +25,15 @@ describe Mongoid::Orderable do
     orderable :scope => :group
   end
 
+  class StringScopedOrderable
+    include Mongoid::Document
+    include Mongoid::Orderable
+
+    field :some_scope, :type => Integer
+
+    orderable :scope => 'some_scope'
+  end
+
   class EmbedsOrderable
     include Mongoid::Document
 
@@ -74,6 +83,16 @@ describe Mongoid::Orderable do
   class Orange < Fruit
   end
 
+  class ForeignKeyDiffersOrderable
+    include Mongoid::Document
+    include Mongoid::Orderable
+
+    belongs_to  :different_scope, :class_name => "ForeignKeyDiffersOrderable",
+                :foreign_key => "different_orderable_id"
+
+    orderable :scope => :different_scope
+  end
+
   describe SimpleOrderable do
 
     before :each do
@@ -200,6 +219,21 @@ describe Mongoid::Orderable do
         record.reload.position.should == 3
       end
     end
+
+    describe 'utiity methods' do
+
+      it "should return a collection of items lower/higher on the list for next_items/previous_items" do
+        record_1 = SimpleOrderable.where(:position => 1).first
+        record_2 = SimpleOrderable.where(:position => 2).first
+        record_3 = SimpleOrderable.where(:position => 3).first
+        record_4 = SimpleOrderable.where(:position => 4).first
+        record_5 = SimpleOrderable.where(:position => 5).first
+        expect(record_1.next_items.to_a).to eq([record_2, record_3, record_4, record_5])
+        expect(record_5.previous_items.to_a).to eq([record_1, record_2, record_3, record_4])
+        expect(record_3.previous_items.to_a).to eq([record_1, record_2])
+        expect(record_3.next_items.to_a).to eq([record_4, record_5])
+      end
+    end
   end
 
   describe ScopedOrderable do
@@ -321,6 +355,38 @@ describe Mongoid::Orderable do
         end
       end
     end
+
+    describe 'utiity methods' do
+
+      it "should return a collection of items lower/higher on the list for next_items/previous_items" do
+        record_1 = SimpleOrderable.where(:position => 1).first
+        record_2 = SimpleOrderable.where(:position => 2).first
+        record_3 = SimpleOrderable.where(:position => 3).first
+        record_4 = SimpleOrderable.where(:position => 4).first
+        record_5 = SimpleOrderable.where(:position => 5).first
+        expect(record_1.next_items.to_a).to eq([record_2, record_3, record_4, record_5])
+        expect(record_5.previous_items.to_a).to eq([record_1, record_2, record_3, record_4])
+        expect(record_3.previous_items.to_a).to eq([record_1, record_2])
+        expect(record_3.next_items.to_a).to eq([record_4, record_5])
+        # next_item & previous_item testing
+        expect(record_1.next_item).to eq(record_2)
+        expect(record_2.previous_item).to eq(record_1)
+        expect(record_1.previous_item).to eq(nil)
+        expect(record_5.next_item).to eq(nil)
+      end
+    end
+  end
+
+  describe StringScopedOrderable do
+
+    it 'uses the foreign key of the relationship as scope' do
+      orderable1 = StringScopedOrderable.create(:some_scope => 1)
+      orderable2 = StringScopedOrderable.create(:some_scope => 1)
+      orderable3 = StringScopedOrderable.create(:some_scope => 2)
+      expect(orderable1.position).to eq 1
+      expect(orderable2.position).to eq 2
+      expect(orderable3.position).to eq 1
+    end
   end
 
   describe EmbeddedOrderable do
@@ -492,6 +558,26 @@ describe Mongoid::Orderable do
         record.reload.position.should == 3
       end
     end
+
+    describe 'utiity methods' do
+
+      it "should return a collection of items lower/higher on the list for next_items/previous_items" do
+        record_1 = SimpleOrderable.where(:position => 1).first
+        record_2 = SimpleOrderable.where(:position => 2).first
+        record_3 = SimpleOrderable.where(:position => 3).first
+        record_4 = SimpleOrderable.where(:position => 4).first
+        record_5 = SimpleOrderable.where(:position => 5).first
+        expect(record_1.next_items.to_a).to eq([record_2, record_3, record_4, record_5])
+        expect(record_5.previous_items.to_a).to eq([record_1, record_2, record_3, record_4])
+        expect(record_3.previous_items.to_a).to eq([record_1, record_2])
+        expect(record_3.next_items.to_a).to eq([record_4, record_5])
+        # next_item & previous_item testing
+        expect(record_1.next_item).to eq(record_2)
+        expect(record_2.previous_item).to eq(record_1)
+        expect(record_1.previous_item).to eq(nil)
+        expect(record_5.next_item).to eq(nil)
+      end
+    end
   end
 
   describe Fruit do
@@ -503,4 +589,21 @@ describe Mongoid::Orderable do
       fruit2.position.should == 2
     end
   end
+
+  describe ForeignKeyDiffersOrderable do
+
+    it 'uses the foreign key of the relationship as scope' do
+      orderable1, orderable2, orderable3 = nil
+      parent_scope1 = ForeignKeyDiffersOrderable.create
+      parent_scope2 = ForeignKeyDiffersOrderable.create
+      expect do
+        orderable1 = ForeignKeyDiffersOrderable.create(:different_scope => parent_scope1)
+        orderable2 = ForeignKeyDiffersOrderable.create(:different_scope => parent_scope1)
+        orderable3 = ForeignKeyDiffersOrderable.create(:different_scope => parent_scope2)
+      end.to_not raise_error
+      expect(orderable1.position).to eq 1
+      expect(orderable2.position).to eq 2
+      expect(orderable3.position).to eq 1
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_orderable
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - pyromaniac
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-22 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mongoid_orderable
-rubygems_version: 2.1.9
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Acts as list mongoid implementation