aemadrid-sequel_orderable 0.0.4

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+.idea

data/CHANGELOG

@@ -0,0 +1,15 @@
+== 0.0.4 (2009-08-26)
+
+* Updated gem to latest plugin conventions.
+
+* Added exceptions for out-of-range situations.
+
+* Packed gem with Jeweler.
+
+== 0.0.3 (2007-12-30)
+
+* Updated gem dependency on sequel_model.
+
+* 2007.12.05 Modified for better readability and new plugin conventions.
+
+* 2007.12.02 Initial working revision.

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2007 Sharon Rosner, Wayne E. Seguin, Aman Gupta, Adrian Madrid
+
+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 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,175 @@
+= Sequel Orderable Plugin
+
+Allows for model instances to be part of an ordered list,
+based on a 'position' field in the database.
+
+== Basic Usage
+
+Load the plugin into the model:
+
+  plugin :orderable
+
+Given:
+
+  DB.create_table :items do
+    primary_key :id
+    varchar :name
+    int :position
+  end
+
+  class Item < Sequel::Model(:items)
+    plugin :orderable
+  end
+
+item = Item[1]
+
+The plugin provides access to the previous and next item in the list
+
+  item.next
+  item.prev
+
+And methods to change the position of an item (and update affected items accordingly)
+
+  item.move_to(new_position)
+  item.move_to_top
+  item.move_to_bottom
+  item.move_up
+  item.move_down
+
+== Scoping
+
+You can scope the position field by another field.
+
+For example, to allow each user to have their own a distinct orderable list:
+
+  DB.create_table :items do
+    primary_key :id
+    varchar :name
+    int :user_id
+    int :pos
+  end
+
+  class Item < Sequel::Model(:items)
+    plugin :orderable, :field => :pos, :scope => :user_id
+  end
+
+All the defined methods will operate within the 'user_id' field's scope.
+
+== Examples
+
+  # Input: irb
+  require 'sequel'
+  require 'sequel_orderable'
+  require 'sequel/extensions/pretty_table' # for pretty prints
+
+  DB = Sequel.sqlite
+
+  DB.create_table :items do
+    primary_key :id
+    varchar :name
+    int :position
+  end
+
+  class Item < Sequel::Model(:items)
+    plugin :orderable
+  end
+
+  Item.create :name => "alice",   :position => 2
+  Item.create :name => "bob",     :position => 1
+  Item.create :name => "charlie", :position => 4
+  Item.create :name => "darwin",  :position => 3
+
+  Item.print
+
+  Item[:name => "alice"].move_down
+  Item.print
+  Item[:name => "darwin"].move_to_top
+  Item.print
+  Item[:name => "alice"].next
+  Item.print
+  Item[:name => "bob"].prev
+  Item.print
+  Item[:name => "darwin"].move_to(3)
+  Item.print
+  Item[:name => "bob"].move_to_bottom
+  Item.print
+
+
+  # Output
+  >> Item.print
+  +--+-------+--------+
+  |id|name   |position|
+  +--+-------+--------+
+  | 2|bob    |       1|
+  | 1|alice  |       2|
+  | 4|darwin |       3|
+  | 3|charlie|       4|
+  +--+-------+--------+
+  => nil
+
+  >> Item[:name => "alice"].move_down
+  => #<Item @values={:name=>"alice", :position=>3, :id=>1}>
+
+  >> Item.print
+  +--+-------+--------+
+  |id|name   |position|
+  +--+-------+--------+
+  | 2|bob    |       1|
+  | 4|darwin |       2|
+  | 1|alice  |       3|
+  | 3|charlie|       4|
+  +--+-------+--------+
+  => nil
+
+  >> Item[:name => "darwin"].move_to_top
+  => #<Item @values={:name=>"darwin", :position=>1, :id=>4}>
+
+  >> Item.print
+  +--+-------+--------+
+  |id|name   |position|
+  +--+-------+--------+
+  | 4|darwin |       1|
+  | 2|bob    |       2|
+  | 1|alice  |       3|
+  | 3|charlie|       4|
+  +--+-------+--------+
+  => nil
+
+  >> Item[:name => "alice"].next
+  => #<Item @values={:name=>"charlie", :position=>4, :id=>3}>
+
+  >> Item[:name => "bob"].prev
+  => #<Item @values={:name=>"darwin", :position=>1, :id=>4}>
+
+  >> Item.print
+  +--+-------+--------+
+  |id|name   |position|
+  +--+-------+--------+
+  | 4|darwin |       1|
+  | 2|bob    |       2|
+  | 1|alice  |       3|
+  | 3|charlie|       4|
+  +--+-------+--------+
+  => nil
+
+
+== Copyright
+
+Copyright (c) 2007 Sharon Rosner, Wayne E. Seguin, Aman Gupta, Adrian Madrid
+
+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 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/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sequel_orderable"
+    gem.summary = %Q{Update of Aman Gupta's Sequel Orderable Plugin}
+    gem.email = "aemadrid@gmail.com"
+    gem.homepage = "http://github.com/aemadrid/sequel_orderable"
+    gem.authors = ["Adrian Madrid"]
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "orderable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/lib/sequel_orderable.rb

@@ -0,0 +1,113 @@
+module Sequel
+  module Plugins
+    # The orderable plugin allows for model instances to be part of an ordered list,
+    # based on a 'position' field in the database.
+    #
+    #   Page.plugin :orderable, :field => :position, :scope => :parent_id
+    #
+    module Orderable
+
+      def self.apply(model, opts = {})
+        opts[:field] ||= :position
+
+        position_field = opts[:field]
+        scope_field = opts[:scope]
+        if scope_field
+          model.dataset.order!(scope_field, position_field)
+        else
+          model.dataset.order!(position_field)
+        end
+
+        model.instance_eval <<-CODE
+          def orderable_options
+            #{opts.inspect}
+          end
+        CODE
+      end
+
+      module InstanceMethods
+        def orderable_position_field
+          self.class.orderable_options[:field]
+        end
+
+        def orderable_position_value
+          @values[orderable_position_field]
+        end
+
+        def orderable_scope_field
+          self.class.orderable_options[:scope]
+        end
+
+        def orderable_scope_value
+          orderable_scope_field && @values[orderable_scope_field]
+        end
+
+        def at_position(p)
+          if orderable_scope_field
+            self.class.dataset.first orderable_scope_field => orderable_scope_value, orderable_position_field => p
+          else
+            self.class.dataset.first orderable_position_field => p
+          end
+        end
+
+        def prev(n = 1)
+          target = orderable_position_value - n
+          return self if orderable_position_value == target
+          at_position target
+        end
+
+        def next(n = 1)
+          target = orderable_position_value + n
+          at_position target
+        end
+
+        def move_to(target)
+          raise "Moving too far up" if target < 0
+          raise "Moving too far down" if target > last_orderable_position
+          current = orderable_position_value
+          return self if target == current
+
+          db.transaction do
+            if target < current
+              ds = self.class.dataset.filter "? >= ? AND ? < ?", orderable_position_field, target, orderable_position_field, current
+              ds.filter! orderable_scope_field => orderable_scope_value if orderable_scope_field
+              ds.update orderable_position_field => "#{orderable_position_field} + 1".lit
+            else
+              ds = self.class.dataset.filter "? > ? AND ? <= ?", orderable_position_field, current, orderable_position_field, target
+              ds.filter! orderable_scope_field => orderable_scope_value if orderable_scope_field
+              ds.update orderable_position_field => "#{orderable_position_field} - 1".lit
+            end
+            update orderable_position_field => target
+          end
+        end
+
+        def move_up(n = 1)
+          target = orderable_position_value - n
+          raise "Moving too far up" if target < 0
+          self.move_to target 
+        end
+
+        def move_down(n = 1)
+          target = orderable_position_value + n
+          raise "Moving too far down" if target > last_orderable_position
+          self.move_to target
+        end
+
+        def move_to_top
+          self.move_to 1
+        end
+
+        def move_to_bottom
+          self.move_to last_orderable_position
+        end
+
+        def last_orderable_position
+          ds = self.class.dataset
+          ds = ds.filter orderable_scope_field => orderable_scope_value if orderable_scope_field
+          ds.max(orderable_position_field).to_i
+        end
+      end
+
+    end
+  end
+end

data/sequel_orderable.gemspec

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sequel_orderable}
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Adrian Madrid"]
+  s.date = %q{2009-08-26}
+  s.email = %q{aemadrid@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/sequel_orderable.rb",
+     "sequel_orderable.gemspec",
+     "spec/orderable_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/aemadrid/sequel_orderable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Update of Aman Gupta's Sequel Orderable Plugin}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/orderable_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/orderable_spec.rb

@@ -0,0 +1,133 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Orderable" do
+
+  before do
+  end
+
+  describe "without a scope" do
+    before :all do
+      @c = Class.new(Sequel::Model(:sites)) do
+        plugin :orderable
+      end
+    end
+
+    before :each do
+      @c.delete
+      @c.create :name => "hig", :position => 3
+      @c.create :name => "def", :position => 2
+      @c.create :name => "abc", :position => 1
+    end
+
+    it "should return rows in order of position" do
+      @c.map(&:position).should == [1,2,3]
+      @c.map(&:name).should == %w[ abc def hig ]
+    end
+
+    it "should define prev and next" do
+      i = @c[:name => "abc"]
+      i.prev.should == nil
+      i = @c[:name => "def"]
+      i.prev.should == @c[:name => "abc"]
+      i.next.should == @c[:name => "hig"]
+      i = @c[:name => "hig"]
+      i.next.should == nil
+    end
+
+    it "should define move_to" do
+      @c[:name => "def"].move_to(1)
+      @c.map(&:name).should == %w[ def abc hig ]
+
+      @c[:name => "abc"].move_to(3)
+      @c.map(&:name).should == %w[ def hig abc ]
+
+      proc { @c[:name => "abc"].move_to(-1) }.should raise_error(RuntimeError)
+      proc { @c[:name => "abc"].move_to(10) }.should raise_error(RuntimeError)
+    end
+
+    it "should define move_to_top and move_to_bottom" do
+      @c[:name => "def"].move_to_top
+      @c.map(&:name).should == %w[ def abc hig ]
+
+      @c[:name => "def"].move_to_bottom
+      @c.map(&:name).should == %w[ abc hig def ]
+    end
+
+    it "should define move_up and move_down" do
+      @c[:name => "def"].move_up
+      @c.map(&:name).should == %w[ def abc hig ]
+
+      @c[:name => "abc"].move_down
+      @c.map(&:name).should == %w[ def hig abc ]
+
+      proc { @c[:name => "def"].move_up(10) }.should raise_error(RuntimeError)
+      proc { @c[:name => "def"].move_down(10) }.should raise_error(RuntimeError)
+    end
+
+  end
+
+  describe "with a scope" do
+    before :all do
+      @c = Class.new(Sequel::Model(:pages)) do
+        plugin :orderable, :field => :pos, :scope => :parent_id
+      end
+    end
+
+    before :each do
+      @c.delete
+      p1 = @c.create :name => "Hm", :pos => 1, :parent_id => nil
+      p2 = @c.create :name => "Ps", :pos => 1, :parent_id => p1.id
+      @c.create :name => "P1", :pos => 1, :parent_id => p2.id
+      @c.create :name => "P2", :pos => 2, :parent_id => p2.id
+      @c.create :name => "P3", :pos => 3, :parent_id => p2.id
+      @c.create :name => "Au", :pos => 2, :parent_id => p1.id
+    end
+
+    it "should return rows in order of position" do
+      @c.map(&:name).should == %w[ Hm Ps Au P1 P2 P3 ]
+    end
+
+    it "should define prev and next" do
+      @c[:name => "Ps"].next.name.should == 'Au'
+      @c[:name => "Au"].prev.name.should == 'Ps'
+      @c[:name => "P1"].next.name.should == 'P2'
+      @c[:name => "P2"].prev.name.should == 'P1'
+
+      @c[:name => "Ps"].prev.should == nil
+      @c[:name => "Au"].next.should == nil
+      @c[:name => "P1"].prev.should == nil
+      @c[:name => "P3"].next.should == nil
+    end
+
+    it "should define move_to" do
+      @c[:name => "P2"].move_to(1)
+      @c.map(&:name).should == %w[ Hm Ps Au P2 P1 P3 ]
+
+      @c[:name => "P2"].move_to(3)
+      @c.map(&:name).should == %w[ Hm Ps Au P1 P3 P2 ]
+
+      proc { @c[:name => "P2"].move_to(-1) }.should raise_error(RuntimeError)
+      proc { @c[:name => "P2"].move_to(10) }.should raise_error(RuntimeError)
+    end
+
+    it "should define move_to_top and move_to_bottom" do
+      @c[:name => "Au"].move_to_top
+      @c.map(&:name).should == %w[ Hm Au Ps P1 P2 P3 ]
+
+      @c[:name => "Au"].move_to_bottom
+      @c.map(&:name).should == %w[ Hm Ps Au P1 P2 P3 ]
+    end
+
+    it "should define move_up and move_down" do
+      @c[:name => "P2"].move_up
+      @c.map(&:name).should == %w[ Hm Ps Au P2 P1 P3 ]
+
+      @c[:name => "P1"].move_down
+      @c.map(&:name).should == %w[ Hm Ps Au P2 P3 P1 ]
+
+      proc { @c[:name => "P1"].move_up(10) }.should raise_error(RuntimeError)
+      proc { @c[:name => "P1"].move_down(10) }.should raise_error(RuntimeError)
+    end
+
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--loadby
+mtime
+--backtrace
+--format
+specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'spec'
+require 'sequel'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'sequel_orderable'
+
+Spec::Runner.configure do |config|  
+end
+
+class Symbol
+  def to_proc() lambda{ |object, *args| object.send(self, *args) } end
+end
+
+DB = Sequel.connect ENV['SEQUEL_ORDERABLE_CONN'] || 'sqlite:/'
+
+DB.create_table :sites do
+  primary_key :id
+  varchar :name
+  int :position
+end
+
+DB.create_table :pages do
+  primary_key :id
+  varchar :name
+  int :pos
+  int :parent_id
+end
+
+

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: aemadrid-sequel_orderable
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Adrian Madrid
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: aemadrid@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- CHANGELOG
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sequel_orderable.rb
+- sequel_orderable.gemspec
+- spec/orderable_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/aemadrid/sequel_orderable
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Update of Aman Gupta's Sequel Orderable Plugin
+test_files: 
+- spec/spec_helper.rb
+- spec/orderable_spec.rb