mongoid-list 0.3.0 → 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8f75debecad6fdacc61bcea0f0869164576c476
+  data.tar.gz: 7c34bc6ad23242cd59c19a306e92638f3f142a3a
+SHA512:
+  metadata.gz: f24971c39f6885a7f99c5e767456e8c9c9318b3b55c018404202de23fed490e3ad53d7ee98e450658522e71f958daabafd6046d5c38dc536d51d48608007ea48
+  data.tar.gz: 16dc802018bd4622896c5d22eabdfd442a4f3acc5e4f817cd2bfac7fc8af412de9d425224a96ce5b3ae5e71ad9d01accfeb8833d4295b8cde45dd160ba2625c5

data/.ruby-gemset

@@ -0,0 +1 @@
+mongoid-list

data/.ruby-version

@@ -0,0 +1 @@
+2.0

data/README.md

@@ -1 +1,81 @@
-Needs Documentation
+Mongoid List
+============
+
+Mongoid List uses a position column to maintain an ordered list, with optional scoping.  It uses atomic updates to keep lists in either a Collection or Embedded in sync.
+
+Installation
+------------
+
+Add to your Gemfile:
+
+```ruby
+gem 'mongoid-list'
+```
+
+Usage
+-----
+
+Add a list:
+
+```ruby
+class CrowTRobot
+  include Mongoid::Document
+  include Mongoid::List
+
+  field :title
+  slug :title
+end
+```
+
+
+Available methods:
+
+```ruby
+
+# Update Position
+
+doc1.position  # => 1
+doc2.position  # => 2
+
+doc1.position = 2
+doc1.save
+
+doc1.position  # => 2
+doc2.position  # => 1
+
+
+# Reorder a Full List
+Klass.update_positions_in_list!(elements)
+
+Pass in all elements in new ordering.  Accepts documents or ids.
+
+# Scope Information
+doc.list_scoped?  		# If scoping has been defined
+doc.list_scope_field		# Which field to scope against
+doc.list_scope_value		# Value of the scoping field
+doc.list_scope_conditions	# Additional query conditions for scoped lists.
+
+```
+
+
+Scoping
+-------
+
+To scope the list, pass `:scope` on field definition:
+
+```ruby
+class TomServo
+  include Mongoid::Document
+  include Mongoid::Slug
+
+  field :position, type: Integer, scope: :satellite_of_love_id
+  belongs_to :satellite_of_love
+
+end
+```
+
+TO-DO
+-------
+* Helper methods to move individual documents within the list.
+* Customizable filed name.
+

data/lib/mongoid/list/collection.rb

@@ -9,7 +9,9 @@ module Mongoid
         def update_positions!(klass, elements)
           elements.each_with_index do |element, idx|
             id = element.kind_of?(Hash) ? element['id'] : element
-            id = Moped::BSON::ObjectId.from_string(id) if id.is_a?(String)
+            if klass.using_object_ids?
+              id = Moped::BSON::ObjectId.from_string(id) if id.is_a?(String)
+            end
             klass.collection.find({ _id: id }).update({ '$set' => { position: (idx + 1) } })
           end
         end

data/lib/mongoid/list/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module List
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

data/spec/mongoid/list/collection_spec.rb

@@ -12,7 +12,7 @@ describe Mongoid::List::Collection do
       Mongoid::List::Collection.new(simple)
     end
 
-    it "should assign simple to :obj" do
+    it "should assign simple to :doc" do
       collection.obj.should eq simple
     end
 
@@ -84,82 +84,109 @@ describe Mongoid::List::Collection do
 
     context "string Ids" do
 
-      let!(:obj1) { Simple.create }
-      let!(:obj2) { Simple.create }
-      let!(:obj3) { Simple.create }
+      let!(:doc1) { Simple.create }
+      let!(:doc2) { Simple.create }
+      let!(:doc3) { Simple.create }
 
       before do
-        Simple.update_positions_in_list!([obj2.id.to_s, obj1.id.to_s, obj3.id.to_s])
+        Simple.update_positions_in_list!([doc2.id.to_s, doc1.id.to_s, doc3.id.to_s])
       end
 
-      it "should change obj1 from :position of 1 to 2" do
-        obj1.position.should eq 1
-        obj1.reload.position.should eq 2
+      it "should change doc1 from :position of 1 to 2" do
+        doc1.position.should eq 1
+        doc1.reload.position.should eq 2
       end
 
-      it "should change obj2 from :position of 2 to 1" do
-        obj2.position.should eq 2
-        obj2.reload.position.should eq 1
+      it "should change doc2 from :position of 2 to 1" do
+        doc2.position.should eq 2
+        doc2.reload.position.should eq 1
       end
 
-      it "should not change obj3 from :position of 3" do
-        obj3.position.should eq 3
-        obj3.reload.position.should eq 3
+      it "should not change doc3 from :position of 3" do
+        doc3.position.should eq 3
+        doc3.reload.position.should eq 3
+      end
+
+    end
+
+    context "string Ids for class using custom Ids" do
+
+      let!(:doc1) { Custom.create(slug: "one") }
+      let!(:doc2) { Custom.create(slug: "two") }
+      let!(:doc3) { Custom.create(slug: "three") }
+
+      before do
+        Custom.update_positions_in_list!([ "two", "one", "three" ])
+      end
+
+      it "should change doc1 from :position of 1 to 2" do
+        doc1.position.should eq 1
+        doc1.reload.position.should eq 2
+      end
+
+      it "should change doc2 from :position of 2 to 1" do
+        doc2.position.should eq 2
+        doc2.reload.position.should eq 1
+      end
+
+      it "should not change doc3 from :position of 3" do
+        doc3.position.should eq 3
+        doc3.reload.position.should eq 3
       end
 
     end
 
     context "unscoped" do
 
-      let!(:obj1) { Simple.create }
-      let!(:obj2) { Simple.create }
-      let!(:obj3) { Simple.create }
+      let!(:doc1) { Simple.create }
+      let!(:doc2) { Simple.create }
+      let!(:doc3) { Simple.create }
 
       before do
-        Simple.update_positions_in_list!([obj2.id, obj1.id, obj3.id])
+        Simple.update_positions_in_list!([doc2.id, doc1.id, doc3.id])
       end
 
-      it "should change obj1 from :position of 1 to 2" do
-        obj1.position.should eq 1
-        obj1.reload.position.should eq 2
+      it "should change doc1 from :position of 1 to 2" do
+        doc1.position.should eq 1
+        doc1.reload.position.should eq 2
       end
 
-      it "should change obj2 from :position of 2 to 1" do
-        obj2.position.should eq 2
-        obj2.reload.position.should eq 1
+      it "should change doc2 from :position of 2 to 1" do
+        doc2.position.should eq 2
+        doc2.reload.position.should eq 1
       end
 
-      it "should not change obj3 from :position of 3" do
-        obj3.position.should eq 3
-        obj3.reload.position.should eq 3
+      it "should not change doc3 from :position of 3" do
+        doc3.position.should eq 3
+        doc3.reload.position.should eq 3
       end
 
     end
 
     context "scoped" do
 
-      let!(:obj1) { Scoped.create(group: "hell's angels") }
-      let!(:obj2) { Scoped.create(group: "hell's angels") }
-      let!(:obj3) { Scoped.create(group: "hell's angels") }
+      let!(:doc1) { Scoped.create(group: "hell's angels") }
+      let!(:doc2) { Scoped.create(group: "hell's angels") }
+      let!(:doc3) { Scoped.create(group: "hell's angels") }
       let!(:other) { Scoped.create(group: "charlie's angels") }
 
       before do
-        Scoped.update_positions_in_list!([obj3.id, obj2.id, obj1.id])
+        Scoped.update_positions_in_list!([doc3.id, doc2.id, doc1.id])
       end
 
-      it "should change obj1 from :position of 1 to 3" do
-        obj1.position.should eq 1
-        obj1.reload.position.should eq 3
+      it "should change doc1 from :position of 1 to 3" do
+        doc1.position.should eq 1
+        doc1.reload.position.should eq 3
       end
 
-      it "should not change obj2 from :position of 2" do
-        obj2.position.should eq 2
-        obj2.reload.position.should eq 2
+      it "should not change doc2 from :position of 2" do
+        doc2.position.should eq 2
+        doc2.reload.position.should eq 2
       end
 
-      it "should change obj3 from :position of 3 to 1" do
-        obj3.position.should eq 3
-        obj3.reload.position.should eq 1
+      it "should change doc3 from :position of 3 to 1" do
+        doc3.position.should eq 3
+        doc3.reload.position.should eq 1
       end
 
       it "should not have touched other scoped" do

data/spec/mongoid/list/embedded_spec.rb

@@ -16,7 +16,7 @@ describe Mongoid::List::Embedded do
       Mongoid::List::Embedded.new(item)
     end
 
-    it "should assign item to :obj" do
+    it "should assign item to :doc" do
       embedded.obj.should eq item
     end
 
@@ -118,81 +118,81 @@ describe Mongoid::List::Embedded do
 
     context "with String Ids" do
 
-      let!(:obj1) { container.items.create! }
-      let!(:obj2) { container.items.create! }
-      let!(:obj3) { container.items.create! }
+      let!(:doc1) { container.items.create! }
+      let!(:doc2) { container.items.create! }
+      let!(:doc3) { container.items.create! }
 
       before do
-        container.items.update_positions_in_list!([ obj2.id.to_s, obj1.id.to_s, obj3.id.to_s ])
+        container.items.update_positions_in_list!([ doc2.id.to_s, doc1.id.to_s, doc3.id.to_s ])
       end
 
-      it "should change obj1 from :position of 1 to 2" do
-        obj1.position.should eq 1
-        obj1.reload.position.should eq 2
+      it "should change doc1 from :position of 1 to 2" do
+        doc1.position.should eq 1
+        doc1.reload.position.should eq 2
       end
 
-      it "should change obj2 from :position of 2 to 1" do
-        obj2.position.should eq 2
-        obj2.reload.position.should eq 1
+      it "should change doc2 from :position of 2 to 1" do
+        doc2.position.should eq 2
+        doc2.reload.position.should eq 1
       end
 
-      it "should not change obj3 from :position of 3" do
-        obj3.position.should eq 3
-        obj3.reload.position.should eq 3
+      it "should not change doc3 from :position of 3" do
+        doc3.position.should eq 3
+        doc3.reload.position.should eq 3
       end
 
     end
     context "unscoped" do
 
-      let!(:obj1) { container.items.create! }
-      let!(:obj2) { container.items.create! }
-      let!(:obj3) { container.items.create! }
+      let!(:doc1) { container.items.create! }
+      let!(:doc2) { container.items.create! }
+      let!(:doc3) { container.items.create! }
 
       before do
-        container.items.update_positions_in_list!([obj2.id, obj1.id, obj3.id])
+        container.items.update_positions_in_list!([doc2.id, doc1.id, doc3.id])
       end
 
-      it "should change obj1 from :position of 1 to 2" do
-        obj1.position.should eq 1
-        obj1.reload.position.should eq 2
+      it "should change doc1 from :position of 1 to 2" do
+        doc1.position.should eq 1
+        doc1.reload.position.should eq 2
       end
 
-      it "should change obj2 from :position of 2 to 1" do
-        obj2.position.should eq 2
-        obj2.reload.position.should eq 1
+      it "should change doc2 from :position of 2 to 1" do
+        doc2.position.should eq 2
+        doc2.reload.position.should eq 1
       end
 
-      it "should not change obj3 from :position of 3" do
-        obj3.position.should eq 3
-        obj3.reload.position.should eq 3
+      it "should not change doc3 from :position of 3" do
+        doc3.position.should eq 3
+        doc3.reload.position.should eq 3
       end
 
     end
 
     context "scoped" do
 
-      let!(:obj1) { container.scoped_items.create!(group: "hell's angels") }
-      let!(:obj2) { container.scoped_items.create!(group: "hell's angels") }
-      let!(:obj3) { container.scoped_items.create!(group: "hell's angels") }
+      let!(:doc1) { container.scoped_items.create!(group: "hell's angels") }
+      let!(:doc2) { container.scoped_items.create!(group: "hell's angels") }
+      let!(:doc3) { container.scoped_items.create!(group: "hell's angels") }
       let!(:other) { container.scoped_items.create!(group: "charlie's angels") }
 
       before do
-        container.scoped_items.update_positions_in_list!([obj3.id, obj2.id, obj1.id])
+        container.scoped_items.update_positions_in_list!([doc3.id, doc2.id, doc1.id])
       end
 
-      it "should change obj1 from :position of 1 to 3" do
-        obj1.position.should eq 1
-        obj1.reload.position.should eq 3
+      it "should change doc1 from :position of 1 to 3" do
+        doc1.position.should eq 1
+        doc1.reload.position.should eq 3
       end
 
-      it "should not change obj2 from :position of 2" do
-        obj2.position.should eq 2
-        obj2.reload.position.should eq 2
+      it "should not change doc2 from :position of 2" do
+        doc2.position.should eq 2
+        doc2.reload.position.should eq 2
       end
 
-      it "should change obj3 from :position of 3 to 1" do
-        obj3.position.should eq 3
-        obj3.reload.position.should eq 1
+      it "should change doc3 from :position of 3 to 1" do
+        doc3.position.should eq 3
+        doc3.reload.position.should eq 1
       end
 
       it "should not have touched other scoped" do

data/spec/mongoid/list_spec.rb

@@ -740,27 +740,27 @@ describe Mongoid::List do
 
     context "on a Collection" do
 
-      let!(:obj1) { Simple.create }
-      let!(:obj2) { Simple.create }
-      let!(:obj3) { Simple.create }
+      let!(:doc1) { Simple.create }
+      let!(:doc2) { Simple.create }
+      let!(:doc3) { Simple.create }
 
       before do
-        Simple.update_positions_in_list!([obj2.id, obj1.id, obj3.id])
+        Simple.update_positions_in_list!([doc2.id, doc1.id, doc3.id])
       end
 
-      it "should change obj1 from :position of 1 to 2" do
-        obj1.position.should eq 1
-        obj1.reload.position.should eq 2
+      it "should change doc1 from :position of 1 to 2" do
+        doc1.position.should eq 1
+        doc1.reload.position.should eq 2
       end
 
-      it "should change obj2 from :position of 2 to 1" do
-        obj2.position.should eq 2
-        obj2.reload.position.should eq 1
+      it "should change doc2 from :position of 2 to 1" do
+        doc2.position.should eq 2
+        doc2.reload.position.should eq 1
       end
 
-      it "should not change obj3 from :position of 3" do
-        obj3.position.should eq 3
-        obj3.reload.position.should eq 3
+      it "should not change doc3 from :position of 3" do
+        doc3.position.should eq 3
+        doc3.reload.position.should eq 3
       end
 
     end
@@ -768,33 +768,33 @@ describe Mongoid::List do
     context "on an Embedded Collection" do
 
       let(:container) { Container.create! }
-      let!(:obj1) { container.items.create! }
-      let!(:obj2) { container.items.create! }
-      let!(:obj3) { container.items.create! }
-      let!(:obj4) { container.items.create! }
+      let!(:doc1) { container.items.create! }
+      let!(:doc2) { container.items.create! }
+      let!(:doc3) { container.items.create! }
+      let!(:doc4) { container.items.create! }
 
       before do
-        container.items.update_positions_in_list!([obj2.id, obj1.id, obj4.id, obj3.id])
+        container.items.update_positions_in_list!([doc2.id, doc1.id, doc4.id, doc3.id])
       end
 
-      it "should change obj1 from :position of 1 to 2" do
-        obj1.position.should eq 1
-        obj1.reload.position.should eq 2
+      it "should change doc1 from :position of 1 to 2" do
+        doc1.position.should eq 1
+        doc1.reload.position.should eq 2
       end
 
-      it "should change obj2 from :position of 2 to 1" do
-        obj2.position.should eq 2
-        obj2.reload.position.should eq 1
+      it "should change doc2 from :position of 2 to 1" do
+        doc2.position.should eq 2
+        doc2.reload.position.should eq 1
       end
 
-      it "should change obj3 from :position of 3 to 4" do
-        obj3.position.should eq 3
-        obj3.reload.position.should eq 4
+      it "should change doc3 from :position of 3 to 4" do
+        doc3.position.should eq 3
+        doc3.reload.position.should eq 4
       end
 
-      it "should change obj4 from :position of 4 to 3" do
-        obj4.position.should eq 4
-        obj4.reload.position.should eq 3
+      it "should change doc4 from :position of 4 to 3" do
+        doc4.position.should eq 4
+        doc4.reload.position.should eq 3
       end
     end
 
@@ -808,33 +808,33 @@ describe Mongoid::List do
         root.items.create!
       end
 
-      let!(:obj1) { embedded.items.create! }
-      let!(:obj2) { embedded.items.create! }
-      let!(:obj3) { embedded.items.create! }
-      let!(:obj4) { embedded.items.create! }
+      let!(:doc1) { embedded.items.create! }
+      let!(:doc2) { embedded.items.create! }
+      let!(:doc3) { embedded.items.create! }
+      let!(:doc4) { embedded.items.create! }
 
       before do
-        embedded.items.update_positions_in_list!([obj3.id, obj4.id, obj1.id, obj2.id])
+        embedded.items.update_positions_in_list!([doc3.id, doc4.id, doc1.id, doc2.id])
       end
 
-      it "should change obj1 from :position of 1 to 3" do
-        obj1.position.should eq 1
-        obj1.reload.position.should eq 3
+      it "should change doc1 from :position of 1 to 3" do
+        doc1.position.should eq 1
+        doc1.reload.position.should eq 3
       end
 
-      it "should change @obj2 from :position of 2 to 4" do
-        obj2.position.should eq 2
-        obj2.reload.position.should eq 4
+      it "should change @doc2 from :position of 2 to 4" do
+        doc2.position.should eq 2
+        doc2.reload.position.should eq 4
       end
 
-      it "should change @obj3 from :position of 3 to 1" do
-        obj3.position.should eq 3
-        obj3.reload.position.should eq 1
+      it "should change @doc3 from :position of 3 to 1" do
+        doc3.position.should eq 3
+        doc3.reload.position.should eq 1
       end
 
-      it "should change @obj4 from :position of 4 to 2" do
-        obj4.position.should eq 4
-        obj4.reload.position.should eq 2
+      it "should change @doc4 from :position of 4 to 2" do
+        doc4.position.should eq 4
+        doc4.reload.position.should eq 2
       end
 
     end

data/spec/support/models/custom.rb

@@ -0,0 +1,6 @@
+class Custom
+  include Mongoid::Document
+  include Mongoid::List
+  field :_id,   type: String, default: -> { slug }
+  field :slug,  type: String
+end

metadata

@@ -1,116 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-list
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 0.3.1
 platform: ruby
 authors:
 - Dave Krupinski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: guard-spork
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -130,7 +115,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
 - Gemfile
 - Guardfile
 - LICENSE
@@ -150,6 +136,7 @@ files:
 - spec/mongoid/list_spec.rb
 - spec/spec_helper.rb
 - spec/support/models/container.rb
+- spec/support/models/custom.rb
 - spec/support/models/embedded.rb
 - spec/support/models/embedded_deeply.rb
 - spec/support/models/scoped.rb
@@ -157,27 +144,26 @@ files:
 - spec/support/models/simple.rb
 homepage: https://github.com/davekrupinski/mongoid-list
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple list behavior for Mongoid
 test_files:
 - spec/mongoid/list/collection_spec.rb
@@ -185,6 +171,7 @@ test_files:
 - spec/mongoid/list_spec.rb
 - spec/spec_helper.rb
 - spec/support/models/container.rb
+- spec/support/models/custom.rb
 - spec/support/models/embedded.rb
 - spec/support/models/embedded_deeply.rb
 - spec/support/models/scoped.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm 1.9.3@mongoid-list