dm-is-list 0.9.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Sindre Aarsaether (somebee.com)
+
+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

@@ -0,0 +1,58 @@
+dm-is-list
+==========
+
+DataMapper plugin for creating and organizing lists.
+
+== Installation
+
+Download dm-more and install dm-is-list. Remember to require it in your app.
+
+== Getting started
+
+Lets say we have a user-class, and we want to give users the possibility of
+having their own todo-lists
+
+class Todo
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :title, String
+  property :done, DateTime
+
+  belongs_to :user
+
+  # here we define that this should be a list, scoped on :user_id
+  is :list, :scope => [:user_id]
+end
+
+You can now move objects around like this:
+
+ item = Todo.get(1)
+ other = Todo.get(2)
+
+ item.move(:highest)        # moves to top of list
+ item.move(:lowest)         # moves to bottom of list
+ item.move(:up)             # moves one up (:higher and :up is the same)
+ item.move(:down)           # moves one up (:lower and :down is the same)
+ item.move(:to => position) # moves item to a specific position
+ item.move(:above => other) # moves item above the other item.*
+ item.move(:below => other) # moves item above the other item.*
+
+ * won't move if the other item is in another scope. (should this be allowed?)
+
+The list will try to act as intelligently as possible. If you set the position
+manually, and then save, the list will reorganize itself to correctly:
+
+ item.position = 3 # setting position manually
+ item.save # the list will now move the item correctly, and updating others
+
+If you move items between scopes, the list will also try to do what you most
+likely want to do:
+
+ item.user_id # => 1
+ item.user_id = 2 # giving this item to another user
+ item.save # the list will now have detached item from old list, and inserted
+           # at the bottom of the new (user 2) list.
+
+If something is not behaving intuitively, it is a bug, and should be reported.
+Report it here: http://wm.lighthouseapp.com/projects/4819-datamapper/overview

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'spec'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'pathname'
+
+CLEAN.include '{log,pkg}/'
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'dm-is-list'
+  s.version          = '0.9.2'
+  s.platform         = Gem::Platform::RUBY
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ README LICENSE TODO ]
+  s.summary          = 'DataMapper plugin for creating and organizing lists'
+  s.description      = s.summary
+  s.author           = 'Sindre Aarsaether'
+  s.email            = 'sindre [a] identu [d] no'
+  s.homepage         = 'http://github.com/sam/dm-more/tree/master/dm-is-list'
+  s.require_path     = 'lib'
+  s.files            = FileList[ '{lib,spec}/**/*.rb', 'spec/spec.opts', 'Rakefile', *s.extra_rdoc_files ]
+  s.add_dependency('dm-core', "=#{s.version}")
+end
+
+task :default => [ :spec ]
+
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
+SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install #{spec.name} #{spec.version} (default ruby)"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources", :verbose => false
+end
+
+desc "Uninstall #{spec.name} #{spec.version} (default ruby)"
+task :uninstall => [ :clobber ] do
+  sh "#{SUDO} gem uninstall #{spec.name} -v#{spec.version} -I -x", :verbose => false
+end
+
+namespace :jruby do
+  desc "Install #{spec.name} #{spec.version} with JRuby"
+  task :install => [ :package ] do
+    sh %{#{SUDO} jruby -S gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources}, :verbose => false
+  end
+end
+
+desc 'Run specifications'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+  t.spec_files = Pathname.glob(Pathname.new(__FILE__).dirname + 'spec/**/*_spec.rb')
+end

data/TODO

@@ -0,0 +1,3 @@
+TODO
+====
+* Add support for scopes

data/lib/dm-is-list.rb

@@ -0,0 +1,13 @@
+
+require 'rubygems'
+require 'pathname'
+
+gem 'dm-core', '=0.9.2'
+require 'dm-core'
+
+gem 'dm-adjust', '=0.9.2'
+require 'dm-adjust'
+
+require Pathname(__FILE__).dirname.expand_path / 'dm-is-list' / 'is' / 'list.rb'
+
+DataMapper::Model.append_extensions DataMapper::Is::List

data/lib/dm-is-list/is/list.rb

@@ -0,0 +1,195 @@
+module DataMapper
+  module Is
+    module List
+
+      ##
+      # method for making your model a list.
+      # it will define a :position property if it does not exist, so be sure to have a
+      # position-column in your database (will be added automatically on auto_migrate)
+      # if the column has a different name, simply make a :position-property and set a
+      # custom :field
+      #
+      # @example [Usage]
+      #   is :list  # put this in your model to make it act as a list.
+      #   is :list, :scope => [:user_id] # you can also define scopes
+      #   is :list, :scope => [:user_id, :context_id] # also works with multiple params
+      #
+      # @param options <Hash> a hash of options
+      #
+      # @option :scope<Array> an array of attributes that should be used to scope lists
+      #
+      def is_list(options={})
+        options = { :scope => [] }.merge(options)
+
+        extend  DataMapper::Is::List::ClassMethods
+        include DataMapper::Is::List::InstanceMethods
+
+        property :position, Integer unless properties.detect{|p| p.name == :position && p.type == Integer}
+
+        @list_scope = options[:scope]
+
+        before :save do
+          if self.new_record?
+            # a position has been set before save => open up and make room for item
+            # no position has been set => move to bottom of my scope-list (or keep detached?)
+            self.position ? self.move_without_saving(:to => self.position) : self.move_without_saving(:lowest)
+          else
+            # if the scope has changed, we need to detach our item from the old list
+            if self.list_scope != self.original_list_scope
+              oldpos = self.original_values[:position]
+              newpos = self.position
+
+              self.detach(self.original_list_scope) # removing from old list
+              self.move_without_saving(oldpos ? {:to => newpos} : :lowest) # moving to pos or bottom of new list
+
+            elsif self.attribute_dirty?(:position)
+              self.move_without_saving(:to => self.position)
+            end
+            # a (new) position has been set => move item to this position (only if position has been set manually)
+            # the scope has changed => detach from old list, and possibly move into position
+            # the scope and position has changed => detach from old, move to pos in new
+          end
+        end
+
+        before :destroy do
+          self.detach
+        end
+
+        # we need to make sure that STI-models will inherit the list_scope.
+        after_class_method :inherited do |target|
+          target.instance_variable_set(:@list_scope, @list_scope.dup)
+        end
+
+      end
+
+      module ClassMethods
+        attr_reader :list_scope
+
+        ##
+        # use this function to repair / build your lists.
+        #
+        # @example [Usage]
+        #   MyModel.repair_list # repairs the list, given that lists are not scoped
+        #   MyModel.repair_list(:user_id => 1) # fixes the list for user 1, given that the scope is [:user_id]
+        #
+        # @param scope [Hash]
+        #
+        def repair_list(scope={})
+          return false unless scope.keys.all?{|s| list_scope.include?(s) || s == :order }
+          all({:order => [:position.asc]}.merge(scope)).each_with_index{ |item,i| item.position = i+1; item.save }
+        end
+      end
+
+      module InstanceMethods
+
+        def list_scope
+          self.class.list_scope.map{|p| [p,attribute_get(p)]}.to_hash
+        end
+
+        def original_list_scope
+          self.class.list_scope.map{|p| [p,original_values.key?(p) ? original_values[p] : attribute_get(p)]}.to_hash
+        end
+
+        def list_query
+          list_scope.merge(:order => [:position.asc])
+        end
+
+        def list(scope=list_query)
+          self.class.all(scope)
+        end
+
+        ##
+        # repair the list this item belongs to
+        #
+        def repair_list
+          self.class.repair_list(list_scope)
+        end
+
+        ##
+        # reorder the list this item belongs to
+        #
+        def reorder_list(order)
+          self.class.repair_list(list_scope.merge(:order => order))
+        end
+
+        ##
+        # move item to a position in the list. position should _only_ be changed through this
+        #
+        # @example [Usage]
+        #   * node.move :higher           # moves node higher unless it is at the top of parent
+        #   * node.move :lower            # moves node lower unless it is at the bottom of parent
+        #   * node.move :below => other   # moves this node below other resource in the set
+        #
+        # @param vector <Symbol, Hash> A symbol, or a key-value pair that describes the requested movement
+        #
+        # @option :higher<Symbol> move item higher
+        # @option :up<Symbol> move item higher
+        # @option :highest<Symbol> move item to the top of the list
+        # @option :lower<Symbol> move item lower
+        # @option :down<Symbol> move item lower
+        # @option :lowest<Symbol> move item to the bottom of the list
+        # @option :above<Resource> move item above other item. must be in same scope
+        # @option :below<Resource> move item below other item. must be in same scope
+        # @option :to<Fixnum> move item to a specific location in the list
+        #
+        # @return <TrueClass, FalseClass> returns false if it cannot move to the position, otherwise true
+        # @see move_without_saving
+        def move(vector)
+          move_without_saving(vector)
+          save
+        end
+
+        ##
+        # does all the actual movement in #move, but does not save afterwards. this is used internally in
+        # before :save, and will probably be marked private. should not be used by organic beings.
+        #
+        # @see move_without_saving
+        def move_without_saving(vector)
+          if vector.is_a? Hash then action,object = vector.keys[0],vector.values[0] else action = vector end
+
+          prepos = self.original_values[:position]||self.position
+          maxpos = list.last ? (list.last == self ? prepos : list.last.position + 1) : 1
+          newpos = case action
+            when :highest     then 1
+            when :lowest      then maxpos
+            when :higher,:up  then [position-1,1].max
+            when :lower,:down then [position+1,maxpos].min
+            when :above       then object.position
+            when :below       then object.position+1
+            when :to          then [object.to_i,maxpos].min
+          end
+
+          return false if !newpos || ([:above,:below].include?(action) && list_scope != object.list_scope)
+          return true if newpos == position || (newpos == maxpos && position == maxpos-1)
+
+          if !position
+            list.all(:position.gte => newpos).adjust!({:position => +1},true) unless action == :lowest
+          elsif newpos > position
+            newpos -= 1 if [:lowest,:above,:below,:to].include?(action)
+            list.all(:position => position..newpos).adjust!({:position => -1},true)
+          elsif newpos < position
+            list.all(:position => newpos..position).adjust!({:position => +1},true)
+          end
+
+          self.position = newpos
+
+          true
+        end
+
+        def detach(scope=list_scope)
+          list(scope).all(:position.gt => position).adjust!({:position => -1},true)
+          self.position = nil
+        end
+
+        def left_sibling
+          list.reverse.first(:position.lt => position)
+        end
+
+        def right_sibling
+          list.first(:position.gt => position)
+        end
+
+      end
+    end # List
+  end # Is
+end # DataMapper

data/spec/integration/list_spec.rb

@@ -0,0 +1,181 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
+  describe 'DataMapper::Is::List' do
+
+    class User
+      include DataMapper::Resource
+
+      property :id, Serial
+      property :name, String
+
+      has n, :todos
+    end
+
+    class Todo
+      include DataMapper::Resource
+
+      property :id, Serial
+      property :title, String
+
+      belongs_to :user
+
+      is :list, :scope => [:user_id]
+    end
+
+    before :all do
+      User.auto_migrate!(:default)
+      Todo.auto_migrate!(:default)
+
+      u1 = User.create!(:name => "Johnny")
+      Todo.create!(:user => u1, :title => "Write down what is needed in a list-plugin")
+      Todo.create!(:user => u1, :title => "Complete a temporary version of is-list")
+      Todo.create!(:user => u1, :title => "Squash bugs in nested-set")
+
+      u2 = User.create!(:name => "Freddy")
+      Todo.create!(:user => u2, :title => "Eat tasty cupcake")
+      Todo.create!(:user => u2, :title => "Procrastinate on paid work")
+      Todo.create!(:user => u2, :title => "Go to sleep")
+
+    end
+
+    describe 'automatic positioning' do
+      it 'should get the shadow variable of the last position' do
+        repository(:default) do |repos|
+          Todo.get(3).position=8
+          Todo.get(3).dirty?.should == true
+          Todo.get(3).attribute_dirty?(:position).should == true
+          Todo.get(3).original_values[:position].should == 3
+          Todo.get(3).list_scope.should == Todo.get(3).original_list_scope
+        end
+      end
+
+      it 'should insert items into the list automatically' do
+        repository(:default) do |repos|
+          Todo.get(3).position.should == 3
+          Todo.get(6).position.should == 3
+        end
+      end
+    end
+
+    describe 'movement' do
+      it 'should rearrange items correctly when moving :higher' do
+        repository(:default) do |repos|
+          Todo.get(3).move :higher
+          Todo.get(3).position.should == 2
+          Todo.get(2).position.should == 3
+          Todo.get(4).position.should == 1
+        end
+      end
+
+      it 'should rearrange items correctly when moving :lower' do
+        repository(:default) do |repos|
+          Todo.get(3).position.should == 2
+          Todo.get(2).position.should == 3
+          Todo.get(3).move :lower
+          Todo.get(3).position.should == 3
+          Todo.get(2).position.should == 2
+
+          Todo.get(4).position.should == 1
+        end
+      end
+
+      it 'should rearrange items correctly when moving :highest or :lowest' do
+        repository(:default) do |repos|
+
+          # list 1
+          Todo.get(1).position.should == 1
+          Todo.get(1).move(:lowest)
+          Todo.get(1).position.should == 3
+
+          # list 2
+          Todo.get(6).position.should == 3
+          Todo.get(6).move(:highest)
+          Todo.get(6).position.should == 1
+          Todo.get(5).position.should == 3
+        end
+      end
+
+      it 'should not rearrange when trying to move top-item up, or bottom item down' do
+        repository(:default) do |repos|
+          Todo.get(6).position.should == 1
+          Todo.get(6).move(:higher).should == false
+          Todo.get(6).position.should == 1
+
+          Todo.get(1).position.should == 3
+          Todo.get(2).position.should == 1
+          Todo.get(1).move(:lower).should == false
+        end
+      end
+
+      it 'should rearrange items correctly when moving :above or :below' do
+        repository(:default) do |repos|
+          Todo.get(6).position.should == 1
+          Todo.get(5).position.should == 3
+          Todo.get(6).move(:below => Todo.get(5))
+          Todo.get(6).position.should == 3
+          Todo.get(5).position.should == 2
+        end
+      end
+    end
+
+    describe 'scoping' do
+      it 'should detach from old list if scope changed' do
+        repository(:default) do |repos|
+          item = Todo.get(4)
+          item.position.should == 1
+          item.user_id = 1
+          item.save
+
+          item.position.should == 4
+          Todo.get(5).position.should == 1
+
+          item.user_id = 2
+          item.position = 1
+          item.save
+
+          item.position.should == 1
+          Todo.get(5).position.should == 2
+
+        end
+      end
+
+      it 'should not allow you to move item into another scope' do
+        repository(:default) do |repos|
+          item = Todo.get(1)
+          item.position.should == 1
+          item.move(:below => Todo.get(5)).should == false
+        end
+      end
+
+      it 'should detach from list when deleted' do
+        repository(:default) do |repos|
+          item = Todo.get(4)
+          item.position.should == 1
+          Todo.get(5).position.should == 2
+          item.destroy
+
+          Todo.get(5).position.should == 1
+
+        end
+      end
+    end
+
+    describe 'reparation' do
+      it 'should fix them lists' do
+        repository(:default) do |repos|
+          # Need to do this with a batch update, as setting position = 20 wont
+          # work (it will set it to bottom of list, not more)
+          Todo.all(:position => 3).update!(:position => 20)
+
+          item = Todo.get(6)
+          item.position.should == 20
+          item.repair_list
+          item.position.should == 3
+        end
+      end
+    end
+
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+gem 'rspec', '>=1.1.3'
+require 'spec'
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/dm-is-list'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  lib = "do_#{name}"
+
+  begin
+    gem lib, '=0.9.2'
+    require lib
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue Gem::LoadError => e
+    warn "Could not load #{lib}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: dm-is-list
+version: !ruby/object:Gem::Version 
+  version: 0.9.2
+platform: ruby
+authors: 
+- Sindre Aarsaether
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-25 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: DataMapper plugin for creating and organizing lists
+email: sindre [a] identu [d] no
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- lib/dm-is-list/is/list.rb
+- lib/dm-is-list.rb
+- spec/integration/list_spec.rb
+- spec/spec_helper.rb
+- spec/spec.opts
+- Rakefile
+- README
+- LICENSE
+- TODO
+has_rdoc: true
+homepage: http://github.com/sam/dm-more/tree/master/dm-is-list
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: DataMapper plugin for creating and organizing lists
+test_files: []
+