mongoid-sortable 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid-sortable.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Elliott Pogue
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Mongoid::Sortable
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid-sortable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-sortable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/mongoid-sortable.rb

@@ -0,0 +1,71 @@
+require 'mongoid-sortable/version'
+require 'active_support/concern'
+
+module Mongoid
+  module Sortable
+    extend ActiveSupport::Concern
+    
+    included do
+      cattr_accessor :mongoid_sortable_options
+      self.mongoid_sortable_options = {}
+
+      field :position, type: Integer, default: 1
+      
+      before_create :set_position
+      after_destroy :set_sibling_positions
+    end
+
+    module ClassMethods
+      def sortable(options = {})
+        options = {
+          scope: []
+        }.merge(options)
+
+        options[:scope].map!(&:to_sym)
+
+        self.mongoid_sortable_options = options
+      end
+    end
+    
+    def previous
+      position_scope.lt(position: position).order_by('position desc').first
+    end
+    
+    def next
+      position_scope.gt(position: position).order_by('position asc').first
+    end
+    
+    def reorder(ids)
+      ids.map!(&:to_s) # ensure entities are strings
+      ids.each_with_index do |id, index|
+        position_scope.find(id).set(:position, index + 1)
+      end
+    end
+    
+    def position_at(new_position)
+      position_scope.gt(position: position).each{|d| d.inc(:position, -1) }
+      set(:position, nil)
+      position_scope.gte(position: new_position).each{|d| d.inc(:position, 1) }
+      set(:position, new_position)
+    end
+        
+    def set_position
+      self.position = position_scope.count + (embedded? ? 0 : 1)
+    end
+    
+    def set_sibling_positions
+      position_scope.gt(position: position).each{|d| d.inc(:position, -1) }
+    end
+
+    def relation
+      (embedded? ? send(self.metadata.inverse).send(self.metadata.name) : self.class).unscoped.scoped
+    end
+
+    def position_scope(options = {})
+      scopes = Array(mongoid_sortable_options[:scope])
+      scopes.inject(relation) do |criteria, scope_field|
+        criteria.where(scope_field => self.send(scope_field))
+      end
+    end
+  end
+end

data/lib/mongoid-sortable/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Sortable
+    VERSION = "0.0.1"
+  end
+end

data/mongoid-sortable.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mongoid-sortable/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Elliott Pogue"]
+  gem.email         = ["epogue@gmail.com"]
+  # gem.description   = %q{TODO: Write a gem description}
+  gem.summary       = %q{A Mongoid 3.0 module for sorting}
+  gem.homepage      = "https://github.com/epogue/mongoid-sortable"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mongoid-sortable"
+  gem.require_paths = ["lib"]
+  gem.version       = Mongoid::Sortable::VERSION
+
+  gem.add_dependency 'mongoid', '~> 3.0.0.rc'
+  
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'database_cleaner'
+  gem.add_development_dependency 'factory_girl', '~> 3.0'
+end

data/spec/db/mongoid.yml

@@ -0,0 +1,8 @@
+test:
+  sessions:
+    default:
+      database: mongoid_sortable_test
+      hosts:
+        - localhost:27017
+      options:
+        consistency: :strong

data/spec/mongoid_sortable_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe "MongoidSortable" do
+	describe "sortable items" do
+		let(:parent) { FactoryGirl.create(:parent_document) }
+		let!(:document1) { FactoryGirl.create(:document, parent_document: parent) }
+		let!(:document2) { FactoryGirl.create(:document, parent_document: parent) }
+		let!(:document3) { FactoryGirl.create(:document, parent_document: parent) }
+
+		it_should_behave_like 'a sortable item'
+
+		it "should properly sort" do
+			parent.documents.order_by('position asc').to_a.should == [document1, document2, document3]
+		end
+
+		context "with distinct parents" do
+		  let(:parent1) { FactoryGirl.create(:parent_document) }
+		  let(:parent2) { FactoryGirl.create(:parent_document) }
+		  let!(:p1_doc1) { FactoryGirl.create(:document, parent_document: parent1) }
+		  let!(:p1_doc2) { FactoryGirl.create(:document, parent_document: parent1) }
+			let!(:p2_doc1) { FactoryGirl.create(:document, parent_document: parent2) }
+			let!(:p2_doc2) { FactoryGirl.create(:document, parent_document: parent2) }
+
+			it "should have their proper positions" do
+			  p1_doc1.position.should == 1
+			  p1_doc2.position.should == 2
+			  p2_doc1.position.should == 1
+			  p2_doc2.position.should == 2
+			end
+
+			it "should scope previous/next" do
+			  p1_doc1.next.should == p1_doc2
+			  p1_doc2.previous.should == p1_doc1
+			  p2_doc1.next.should == p2_doc2
+			  p2_doc2.previous.should == p2_doc1
+			end
+
+			it "should scope position_at" do
+			  p1_doc1.position_at(2)
+			  p1_doc1.reload.position.should == 2
+			  p1_doc2.reload.position.should == 1
+			  p2_doc1.reload.position.should == 1
+			  p2_doc2.reload.position.should == 2
+			end
+		end
+	end
+
+	describe "sortable embedded documents" do
+		let(:parent) { FactoryGirl.create(:document) }
+		let!(:document1) { FactoryGirl.create(:embedded_document, document: parent) }
+		let!(:document2) { FactoryGirl.create(:embedded_document, document: parent) }
+		let!(:document3) { FactoryGirl.create(:embedded_document, document: parent) }
+
+		it_should_behave_like 'a sortable item'
+
+		it "should properly sort" do
+			parent.embedded_documents.order_by('position asc').to_a.should == [document1, document2, document3]
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+plugin_test_dir = File.dirname(__FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec'
+require 'logger'
+
+require 'active_support'
+require 'active_model'
+require 'mongoid'
+
+Dir["./spec/support/**/*.rb"].each {|f| require f}
+
+ENV["MONGOID_ENV"] = "test"
+Mongoid.load!(plugin_test_dir + "/db/mongoid.yml")
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

data/spec/support/factories.rb

@@ -0,0 +1,21 @@
+require 'factory_girl'
+
+FactoryGirl.define do
+	factory :parent_document do
+		trait :with_documents do
+			after(:create) do |parent, evaluator|
+				3.times { FactoryGirl.create(:document, parent_document: parent) }
+			end
+		end
+	end
+
+	factory :document do
+		trait :with_embedded_docs do
+			after(:create) do |parent, evaluator|
+				3.times { FactoryGirl.create(:embedded_document, document: parent) }
+			end
+		end
+	end
+
+	factory :embedded_document
+end

data/spec/support/models.rb

@@ -0,0 +1,24 @@
+require 'mongoid-sortable'
+
+class ParentDocument
+	include Mongoid::Document
+
+	has_many :documents
+end
+
+class Document
+	include Mongoid::Document
+	include Mongoid::Sortable
+
+	belongs_to :parent_document
+	embeds_many :embedded_documents
+	sortable scope: [:parent_document_id]
+end
+
+class EmbeddedDocument
+	include Mongoid::Document
+	include Mongoid::Sortable
+
+	embedded_in :document
+	sortable
+end

data/spec/support/mongoid.rb

@@ -0,0 +1,16 @@
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner[:mongoid].strategy = :truncation
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner[:mongoid].start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner[:mongoid].clean
+  end
+end

data/spec/support/shared_examples_for_a_sortable_item.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+shared_examples_for 'a sortable item' do
+	it { document1.position.should == 1 }
+	it { document2.position.should == 2 }
+	it { document3.position.should == 3 }
+
+	it "should get the next item" do
+		document2.next.should == document3
+	end
+
+	it "should get the previous item" do
+		document2.previous.should == document1
+	end
+
+	it "should be positioned at new position" do
+		document1.position_at(2)
+		document1.reload.position.should == 2
+	end
+
+	it "should reposition others when repositioned" do
+	  document1.position_at(2)
+	  document2.reload.position.should == 1
+	  document3.reload.position.should == 3
+	end
+
+	it "should reposition others when destroyed" do
+	  document1.destroy
+	  document2.reload.position.should == 1
+	  document3.reload.position.should == 2
+	end
+
+	it "should reorder items when given an array" do
+		the_order = [document2.id.to_s, document3.id.to_s, document1.id.to_s]
+		document1.reorder(the_order)
+		document1.reload.position.should == 3
+		document2.reload.position.should == 1
+	  document3.reload.position.should == 2
+	end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-sortable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Elliott Pogue
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-03 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.0.0.rc
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- epogue@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mongoid-sortable.rb
+- lib/mongoid-sortable/version.rb
+- mongoid-sortable.gemspec
+- spec/db/mongoid.yml
+- spec/mongoid_sortable_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+- spec/support/models.rb
+- spec/support/mongoid.rb
+- spec/support/shared_examples_for_a_sortable_item.rb
+homepage: https://github.com/epogue/mongoid-sortable
+licenses: []
+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.23
+signing_key: 
+specification_version: 3
+summary: A Mongoid 3.0 module for sorting
+test_files:
+- spec/db/mongoid.yml
+- spec/mongoid_sortable_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+- spec/support/models.rb
+- spec/support/mongoid.rb
+- spec/support/shared_examples_for_a_sortable_item.rb