mm_sortable_item 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format d

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.2@mm_sortable_item_gem

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mm_sortable_item.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# mm\_sortable\_item
+
+This is a quick little MongoMapper plugin that provides some basic acts-as-list style functionality on mongo documents. By default things are added to the list bottom.
+
+## Usage
+
+In the gemfile:
+
+    gem 'mm_sortable_item'
+    
+In your model:
+
+``` ruby
+  class SortableDocument
+    include MongoMapper::Document
+    plugin MongoMapper::Plugins::SortableItem
+    
+    list_scope_column :parent_id # optional if you want to scope the lists
+    
+    # ...
+  end
+```
+
+Then you have access to some helpful methods, such as:
+
+* `.in_order` retrieves the list items in order
+* `.in_list(id)` retrieves the items scoped as you wish
+* `.reorder(orderd_array_of_ids)` sets the positions of the given ids in order
+* `object.set_position(position)` inserts object into the list at the given position
+
+## Credit
+
+John Nunemaker for mongo_mapper itself, as well as a start down the road of how to implement this. It's definitely not as "fully functional" as `acts_as_list`, but it does everything I need :).
+
+* Author: Matt Wilson (mwilson@agoragames.com)
+* GitHub: http://github.com/hypomodern

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/mm_sortable_item.rb

@@ -0,0 +1,111 @@
+require "mm_sortable_item/version"
+require "mongo_mapper"
+
+# An ActsAsList-ish plugin for MongoMapper, since this doesn't seem to exist in a well-tested form.
+# Props to John Nunemaker for starting us down the right path here
+module MongoMapper
+  module Plugins
+    module SortableItem
+      extend ActiveSupport::Concern
+  
+      included do
+        key :position, Integer
+        scope :in_order, sort(:position)
+        class_attribute :sortable_item_options
+        self.sortable_item_options = { :list_scope => nil }
+      
+        # some callbacks we'll want
+        before_create :add_to_list_bottom, :unless => :in_list?
+        before_destroy :decrement_positions_on_lower_items
+      end
+  
+      module ClassMethods
+        def reorder(ids)
+          ids.each_with_index do |id, index|
+            set(id, :position => index + 1)
+          end
+        end
+      
+        def in_list list_id = nil
+          where(conditions_for_list_scope(list_id))
+        end
+      
+        def conditions_for_list_scope list_id
+          the_query = {}        
+          the_column = list_scope_column
+          if the_column
+            the_query = { the_column => list_id }
+          end
+          the_query
+        end
+      
+        def list_scope_column= new_column
+          self.sortable_item_options[:list_scope] = new_column
+        end
+      
+        def list_scope_column
+          self.sortable_item_options[:list_scope]
+        end
+      end
+
+      module InstanceMethods
+        def in_list?
+          !send(:position).nil?
+        end
+      
+        def scoped_list_id
+          the_column = self.class.list_scope_column
+          the_column ? self.send(the_column) : nil
+        end
+      
+        def add_to_list_bottom
+          add_to_list
+        end
+      
+        def add_to_list_top
+          add_to_list 1
+        end
+      
+        def add_to_list position = bottom_of_list
+          remove_from_list
+          increment_positions_on_lower_items position
+          set_position position
+        end
+      
+        def bottom_of_list
+          self.class.in_list( scoped_list_id ).count + 1
+        end
+      
+        def lower_than_conditions position = self.position
+          query = self.class.conditions_for_list_scope scoped_list_id
+          query.merge( :position.gte => position )
+        end
+      
+        def decrement_positions_on_lower_items position = self.position
+          self.class.decrement( lower_than_conditions(position), { :position => 1 } )
+        end
+      
+        def increment_positions_on_lower_items position = self.position
+          self.class.increment( lower_than_conditions(position), { :position => 1 } )
+        end
+      
+        def remove_from_list
+          if in_list?
+            decrement_positions_on_lower_items
+            self.position = nil
+          end
+        end
+      
+        def set_position new_position
+          remove_from_list
+          increment_positions_on_lower_items new_position
+          if new_position != self.position
+            self.position = new_position
+            save unless new_record?
+          end
+        end
+      
+      end
+    end
+  end
+end

data/lib/mm_sortable_item/version.rb

@@ -0,0 +1,3 @@
+module MmSortableItem
+  VERSION = "0.0.1"
+end

data/mm_sortable_item.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mm_sortable_item/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mm_sortable_item"
+  s.version     = MmSortableItem::VERSION
+  s.authors     = ["Matt Wilson"]
+  s.email       = ["mhw@hypomodern.com"]
+  s.homepage    = "https://github.com/agoragames/mm_sortable_item"
+  s.summary     = "Tiny MongoMapper plugin for treating a collection as a list"
+  s.description = "Tiny MongoMapper plugin for treating a collection as a list"
+
+  s.rubyforge_project = "mm_sortable_item"
+
+  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('mongo_mapper')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('fabrication')
+  s.add_development_dependency('database_cleaner')
+end

data/spec/fabricators/sortable_helper_fabricator.rb

@@ -0,0 +1,7 @@
+if !defined?(SortableHelper)
+  class SortableHelper; end
+end
+Fabricator(:sortable_helper) do
+  name { sequence(:name) { |i| "leet_sortable_#{i}" } }
+  list_scope_id { (1..3).to_a.sample }
+end

data/spec/mm_sortable_item_spec.rb

@@ -0,0 +1,196 @@
+require 'spec_helper'
+
+module MongoMapper::Plugins
+  describe SortableItem do
+    after do
+      SortableHelper.sortable_item_options = { :list_scope => nil }
+    end
+    
+    describe "plugin .included magic" do
+      it "sets a new mongo key of :position on the document" do
+        the_position_key = SortableHelper.keys["position"]
+        the_position_key.should_not be_nil
+        
+        the_position_key.type.should == Integer
+      end
+      it "provides a new scope named .in_order" do
+        SortableHelper.scopes.keys.should include(:in_order)
+      end
+      it "sets up a class_accessor called .sortable_item_options" do
+        SortableHelper.sortable_item_options.should == { :list_scope => nil }
+      end
+      
+      describe "default callbacks" do
+        it "sets up a before_create callback to ensure the item gets added to the list" do
+          the_callbacks = SortableHelper._create_callbacks
+          the_callbacks.find { |cb| cb.kind == :before && cb.filter == :add_to_list_bottom }.
+            should_not be_nil
+        end
+        it "adds new items to the bottom of the list by default" do
+          3.times { Fabricate(:sortable_helper) }
+          new_item = Fabricate(:sortable_helper)
+          new_item.position.should == 4
+        end
+        context "with already-ordered items" do
+          it "doesn't change the position" do
+            (1..3).to_a.each { |i| Fabricate(:sortable_helper, :position => i + 1) }
+            new_item = Fabricate(:sortable_helper, :position => 1)
+            new_item.reload
+            new_item.position.should == 1
+            SortableHelper.in_order.first.should == new_item
+          end
+        end
+        it "sets up a before_destroy callback to ensure the item gets removed from the list" do
+          the_callbacks = SortableHelper._destroy_callbacks
+          the_callbacks.find { |cb| cb.kind == :before && cb.filter == :decrement_positions_on_lower_items }.
+            should_not be_nil
+        end
+        it "gracefully removes an item from the list, leaving it in proper order on destroy" do
+          (1..3).to_a.each { |i| Fabricate(:sortable_helper, :position => i) }
+          SortableHelper.in_order.first.destroy
+          SortableHelper.in_order.all.map { |sh| sh.position }.should == [1, 2]
+        end
+      end
+    end
+    
+    describe ".list_scope_column=" do
+      it "allows you to give it a column name that will be saved into the options" do
+        SortableHelper.list_scope_column = :list_scope_id
+        SortableHelper.sortable_item_options.should == { :list_scope => :list_scope_id }
+      end
+    end
+    
+    describe ".list_scope_column" do
+      it "returns the defined list_scope_column" do
+        SortableHelper.list_scope_column = :list_scope_id
+        SortableHelper.list_scope_column.should == :list_scope_id
+      end
+      it "returns nil by default" do
+        SortableHelper.list_scope_column.should be_nil
+      end
+    end
+    
+    describe ".in_list" do
+      it "returns a scope that... uh, scopes the list" do
+        SortableHelper.in_list.should be_a_kind_of(Plucky::Query)
+      end
+      it "filters nothing by default (entire collection is the list)" do
+        3.times { Fabricate(:sortable_helper) }
+        recs = SortableHelper.in_list.in_order.all
+        recs.size.should == 3
+      end
+      it "uses the :list_scope option to build the scope" do
+        SortableHelper.list_scope_column = :list_scope_id
+        SortableHelper.should_receive(:where).with({:list_scope_id => 3})
+        SortableHelper.in_list(3)
+      end
+      it "correctly scopes the list, baby" do
+        5.times { Fabricate(:sortable_helper, :list_scope_id => 1) }
+        5.times { Fabricate(:sortable_helper, :list_scope_id => 2) }
+        SortableHelper.list_scope_column = :list_scope_id
+        
+        SortableHelper.in_list(1).count.should == 5
+        SortableHelper.in_list(2).count.should == 5
+        SortableHelper.count.should == 10
+      end
+    end
+    
+    describe ".reorder" do
+      it "updates the positions of the given ids based on their array order" do
+        items = (1..3).to_a.map { |i| Fabricate(:sortable_helper, :position => i) }
+        
+        SortableHelper.reorder([items[2].id, items[0].id, items[1].id])
+        new_list = SortableHelper.in_list.in_order.all
+        new_list[0].should == items[2]
+        new_list[1].should == items[0]
+        new_list[2].should == items[1]
+      end
+    end
+    
+    describe "#in_list?" do
+      it "returns false if the record doesn't have a numeric position" do
+        sortable = Fabricate.build(:sortable_helper)
+        sortable.stub!(:position).and_return(nil)
+        sortable.position.should be_nil
+        sortable.should_not be_in_list
+      end
+      it "returns true if the record has a numeric position" do
+        sortable = Fabricate.build(:sortable_helper)
+        sortable.position = 1
+        sortable.should be_in_list
+      end
+    end
+    
+    describe "#scoped_list_id" do
+      it "returns nil if there is no defined list scope" do
+        Fabricate.build(:sortable_helper).scoped_list_id.should be_nil
+      end
+      it "returns the value of the given column" do
+        SortableHelper.list_scope_column = :list_scope_id
+        sortable = Fabricate.build(:sortable_helper)
+        sortable.scoped_list_id.should == sortable.list_scope_id
+      end
+    end
+    
+    describe "#bottom_of_list" do
+      before do
+        SortableHelper.list_scope_column = :list_scope_id
+        5.times { Fabricate(:sortable_helper, :list_scope_id => 1) }
+        2.times { Fabricate(:sortable_helper, :list_scope_id => 2) }
+      end
+      it "returns the position that an item at the bottom of the list should have" do
+        list_1 = Fabricate.build(:sortable_helper, :list_scope_id => 1)
+        list_2 = Fabricate.build(:sortable_helper, :list_scope_id => 2)
+        list_1.bottom_of_list.should == 6
+        list_2.bottom_of_list.should == 3
+      end
+    end
+    
+    describe "#remove_from_list" do
+      before do
+        @list = (1..5).to_a.map { |i| Fabricate(:sortable_helper, :name => "Item #{i}") }
+        @middle_item = @list[2]
+      end
+      it "sets the current position to nil" do
+        @middle_item.remove_from_list
+        @middle_item.position.should be_nil
+      end
+      it "pushes everything below the current item up a notch" do
+        old_position = @middle_item.position
+        @middle_item.remove_from_list
+        item_3 = @list[3]
+        item_3.reload
+        item_3.position.should == old_position
+        
+        item_4 = @list[4]
+        item_4.reload
+        item_4.position.should == old_position + 1
+      end
+    end
+    
+    describe "#set_position" do
+      it "sets the item to the new position" do
+        item = Fabricate.build(:sortable_helper)
+        item.set_position 5
+        item.position.should == 5
+      end
+      it "moves everything below the given position down a notch" do
+        list = (1..5).to_a.map { |i| Fabricate(:sortable_helper, :name => "Item #{i}") }
+        item = Fabricate(:sortable_helper)
+        item.set_position 3
+        old_item_3 = SortableHelper.find(list[2].id)
+        old_item_3.reload
+        old_item_3.position.should == 4
+      end
+      it "inserts it correctly into the list" do
+        list = (1..5).to_a.map { |i| Fabricate(:sortable_helper, :name => "Item #{i}") }
+        item = Fabricate(:sortable_helper, :name => "The New Guy")
+        item.set_position 3
+        new_list = SortableHelper.in_list.in_order.all
+        new_list[2].should == item
+        new_list.map { |i| i.name + ": pos = " + i.position.to_s }.should == ["Item 1: pos = 1", "Item 2: pos = 2", "The New Guy: pos = 3", "Item 3: pos = 4", "Item 4: pos = 5", "Item 5: pos = 6"]
+      end
+    end
+  
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+require 'rspec'
+require 'fabrication'
+require 'database_cleaner'
+
+
+require 'mm_sortable_item'
+
+MongoMapper.database = 'mm_sortable_item_spec'
+
+class SortableHelper
+  include MongoMapper::Document
+  plugin MongoMapper::Plugins::SortableItem
+
+  key :name, String
+  key :list_scope_id, Integer
+end
+
+SortableHelper.collection.remove
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+    DatabaseCleaner.clean
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: mm_sortable_item
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-31 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fabrication
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Tiny MongoMapper plugin for treating a collection as a list
+email: 
+- mhw@hypomodern.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- lib/mm_sortable_item.rb
+- lib/mm_sortable_item/version.rb
+- mm_sortable_item.gemspec
+- spec/fabricators/sortable_helper_fabricator.rb
+- spec/mm_sortable_item_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/agoragames/mm_sortable_item
+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: mm_sortable_item
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Tiny MongoMapper plugin for treating a collection as a list
+test_files: 
+- spec/fabricators/sortable_helper_fabricator.rb
+- spec/mm_sortable_item_spec.rb
+- spec/spec_helper.rb