mongoid_order 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mongoid_order.gemspec
+gemspec
+
+gem 'bson_ext', '>= 1.0.4'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Ark Xu
+
+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.rdoc

@@ -0,0 +1,68 @@
+= mongoid_order
+
+An easy way to make mongoid documentation order-able.
+
+This class is extracted from benedikt's great gem https://github.com/benedikt/mongoid-tree with some modifications. Thanks to benedikt!
+
+
+== Requirements
+
+* mongoid (>= 2.0.0.beta.20)
+
+
+== Install
+
+To install mongoid_order, simply add it to your Gemfile:
+
+  gem 'mongoid_order'
+
+In order to get the latest development version of mongoid-tree:
+
+  gem 'mongoid_order', :git => 'https://github.com/arkxu/mongoid_order.git'
+
+And then:
+  bundle install
+
+
+== Usage
+
+Add the <tt>include Mongoid::Orderable</tt> in the model:
+
+  class Node
+    include Mongoid::Document
+    include Mongoid::Orderable
+  end
+
+
+=== Ordering
+
+This will add a <tt>position</tt> field to your document and provide additional utility methods:
+
+  node.move_up
+  node.move_down
+  node.move_to_top
+  node.move_to_bottom
+  node.move_above(other)
+  node.move_below(other)
+
+  node.at_top?
+  node.at_bottom?
+
+== Known issues
+
+See https://github.com/arkxu/mongoid_order/issues
+
+
+== Repository
+
+See https://github.com/arkxu/mongoid_order and feel free to fork it!
+
+
+== Contributors
+
+See a list of all contributors at https://github.com/arkxu/mongoid_order/contributors. Thanks a lot everyone!
+
+
+== Copyright
+
+Copyright (c) 2011 Ark Xu. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rake/testtask'
+require 'rake/gempackagetask'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+
+task :default => 'test'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << '.' << 'lib' << 'test'
+  t.pattern = 'test/lib/**/*_test.rb'
+  t.verbose = false
+end
+
+gemspec = eval(File.read('mongoid_order.gemspec'))
+Rake::GemPackageTask.new(gemspec) do |pkg|
+  pkg.gem_spec = gemspec
+end
+
+desc "build the gem and release it to rubygems.org"
+task :release => :gem do
+  sh "gem push pkg/mongoid_order-#{gemspec.version}.gem"
+end

data/lib/mongoid_order.rb

@@ -0,0 +1,153 @@
+module Mongoid
+  ##
+  # = Mongoid::Orderable
+  #
+  # == Utility methods
+  #
+  # There are several methods to move nodes around in the list:
+  #
+  #    node.move_up
+  #    node.move_down
+  #    node.move_to_top
+  #    node.move_to_bottom
+  #    node.move_above(other)
+  #    node.move_below(other)
+  #
+  # Additionally there are some methods to check aspects of the document
+  # in the list of children:
+  #
+  #    node.at_top?
+  #    node.at_bottom?
+  module Orderable
+    extend ActiveSupport::Concern
+
+    included do
+      field :position, :type => Integer
+
+      before_save :assign_default_position
+      after_destroy :move_lower_siblings_up
+    end
+
+    ##
+    # Returns siblings below the current document.
+    # Siblings with a position greater than this documents's position.
+    def lower_siblings
+      self.class.all.where(:position.gt => self.position)
+    end
+
+    ##
+    # Returns siblings above the current document.
+    # Siblings with a position lower than this documents's position.
+    def higher_siblings
+      self.class.all.where(:position.lt => self.position)
+    end
+
+    ##
+    # Returns the lowest sibling (could be self)
+    def last_sibling_in_list
+      self.class.all.asc(:position).last
+    end
+
+    ##
+    # Returns the highest sibling (could be self)
+    def first_sibling_in_list
+      self.class.all.asc(:position).first
+    end
+
+    ##
+    # Is this the highest sibling?
+    def at_top?
+      higher_siblings.empty?
+    end
+
+    ##
+    # Is this the lowest sibling?
+    def at_bottom?
+      lower_siblings.empty?
+    end
+
+    ##
+    # Move this node above all its siblings
+    def move_to_top
+      return true if at_top?
+      move_above(first_sibling_in_list)
+    end
+
+    ##
+    # Move this node below all its siblings
+    def move_to_bottom
+      return true if at_bottom?
+      move_below(last_sibling_in_list)
+    end
+
+    ##
+    # Move this node one position up
+    def move_up
+      return if at_top?
+      self.class.all.where(:position => self.position - 1).first.inc(:position, 1)
+      inc(:position, -1)
+    end
+
+    ##
+    # Move this node one position down
+    def move_down
+      return if at_bottom?
+      self.class.all.where(:position => self.position + 1).first.inc(:position, -1)
+      inc(:position, 1)
+    end
+
+    ##
+    # Move this node above the specified node
+    #
+    # This method changes the node's parent if nescessary.
+    def move_above(other)
+      if position > other.position
+        new_position = other.position
+        other.lower_siblings.where(:position.lt => self.position).each { |s| s.inc(:position, 1) }
+        other.inc(:position, 1)
+        self.position = new_position
+        save!
+      else
+        new_position = other.position - 1
+        other.higher_siblings.where(:position.gt => self.position).each { |s| s.inc(:position, -1) }
+        self.position = new_position
+        save!
+      end
+    end
+
+    ##
+    # Move this node below the specified node
+    #
+    # This method changes the node's parent if nescessary.
+    def move_below(other)
+      if position > other.position
+        new_position = other.position + 1
+        other.lower_siblings.where(:position.lt => self.position).each { |s| s.inc(:position, 1) }
+        self.position = new_position
+        save!
+      else
+        new_position = other.position
+        other.higher_siblings.where(:position.gt => self.position).each { |s| s.inc(:position, -1) }
+        other.inc(:position, -1)
+        self.position = new_position
+        save!
+      end
+    end
+
+    private
+
+      def move_lower_siblings_up
+        lower_siblings.each { |s| s.inc(:position, -1) }
+      end
+
+      def assign_default_position
+        return unless self.position.nil?
+
+        if self.class.all.empty? || self.class.all.collect(&:position).compact.empty?
+          self.position = 0
+        else
+          self.position = self.class.all.max(:position) + 1
+        end
+      end
+  end
+end

data/mongoid_order.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "mongoid_order"
+  s.version     = "0.0.2"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ark Xu"]
+  s.email       = ["ark.work@gmail.com"]
+  s.homepage    = "https://github.com/arkxu/mongoid_order"
+  s.summary     = %q{Make Mongoid documents order-able}
+  s.description = %q{An easy way to make Mongoid documents order-able by adding position field}
+
+  s.rubyforge_project = "mongoid_order"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_runtime_dependency('mongoid', ['>= 2.0.0.beta.20'])
+end

data/test/lib/mongoid/orderable_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+class MockModel
+  include Mongoid::Document
+  include Mongoid::Orderable
+  
+  field :title
+end
+
+class OrderableTest < Test::Unit::TestCase
+
+  def teardown
+    MockModel.destroy_all
+    Mongoid.database.collection("mock_models").drop
+  end
+  
+  def test_create_first_model
+    mm = MockModel.create(:title => "first one")
+    assert_equal mm.position, 0
+  end
+  
+  def test_create_two_models_and_move
+    mm = MockModel.create(:title => "first one")
+    assert_equal mm.position, 0
+    mm2 = MockModel.create(:title => "second one")
+    assert_equal mm2.position, 1
+    mm2.move_up
+    assert_equal mm2.position, 0
+    mm2.move_down
+    assert_equal mm2.position, 1
+    mm3 = MockModel.create(:title => "third one")
+    mm3.move_above(mm2)
+    assert_equal mm3.position, 1
+    mm3.move_below(mm2)
+    assert_equal mm3.position, 2
+    mm3.move_to_top
+    assert_equal mm3.position, 0
+    mm3.move_to_bottom
+    assert_equal mm3.position, 2
+  end
+  
+  def test_destroy_one
+    mm = MockModel.create(:title => "first one")
+    assert_equal mm.position, 0
+    mm2 = MockModel.create(:title => "second one")
+    assert_equal mm2.position, 1
+    mm.destroy
+    mm2.reload
+    assert_equal mm2.position, 0
+  end
+end # AssignTest

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems' unless RUBY_VERSION =~ /^(?:1.9.*)$/
+require 'test/unit'
+require 'test/unit/assertions'
+require 'bundler/setup'
+
+require 'mongoid'
+require 'mongoid_order'
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db('mongoid_order_test')
+  config.allow_dynamic_fields = false
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_order
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Ark Xu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-16 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 62196427
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  type: :runtime
+  version_requirements: *id001
+description: An easy way to make Mongoid documents order-able by adding position field
+email: 
+- ark.work@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/mongoid_order.rb
+- mongoid_order.gemspec
+- test/lib/mongoid/orderable_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/arkxu/mongoid_order
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: mongoid_order
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Make Mongoid documents order-able
+test_files: 
+- test/lib/mongoid/orderable_test.rb
+- test/test_helper.rb