sequel_orderable 0.0.1

data/CHANGELOG

@@ -0,0 +1 @@
+* 2007.12.02 Initial working revision.

data/COPYING

@@ -0,0 +1,18 @@
+Copyright (c) 2007 Sharon Rosner, Wayne E. Seguin, Aman Gupta
+
+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

@@ -0,0 +1,187 @@
+= 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:
+
+  is :orderable
+
+Given:
+
+class Item < Sequel::Model(:items)
+  set_schema do
+    primary_key :id
+    varchar :name
+    int :position
+  end
+  is :orderable, :field => :position
+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:
+
+class UserItem < Sequel::Model(:items)
+  set_schema do
+    primary_key :id
+    varchar :name
+    int :user_id
+    int :pos
+  end
+  is :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"
+
+DB = Sequel.sqlite
+class Item < Sequel::Model(:items)
+  set_schema do
+    primary_key :id
+    varchar :name
+    int :position
+  end
+  is :orderable, :field => :position
+end
+
+Item.create_table!
+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
+=> {:position=>3}
+
+>> Item.print
++--+-------+--------+
+|id|name   |position|
++--+-------+--------+
+| 2|bob    |       1|
+| 4|darwin |       2|
+| 1|alice  |       3|
+| 3|charlie|       4|
++--+-------+--------+
+=> nil
+
+>> Item[:name => "darwin"].move_to_top
+=> {:position=>1}
+
+>> Item.print
++--+-------+--------+
+|id|name   |position|
++--+-------+--------+
+| 4|darwin |       1|
+| 2|bob    |       2|
+| 1|alice  |       3|
+| 3|charlie|       4|
++--+-------+--------+
+=> nil
+
+>> Item[:name => "alice"].next
+=> #<Item:0x119dbc8 @values={:position=>4, :name=>"charlie", :id=>3}, newfalse
+
+>> Item.print
++--+-------+--------+
+|id|name   |position|
++--+-------+--------+
+| 4|darwin |       1|
+| 2|bob    |       2|
+| 1|alice  |       3|
+| 3|charlie|       4|
++--+-------+--------+
+=> nil
+
+>> Item[:name => "bob"].prev
+=> #<Item:0x1184bb4 @values={:position=>1, :name=>"darwin", :id=>4}, newfalse
+
+>> Item.print
++--+-------+--------+
+|id|name   |position|
++--+-------+--------+
+| 4|darwin |       1|
+| 2|bob    |       2|
+| 1|alice  |       3|
+| 3|charlie|       4|
++--+-------+--------+
+=> nil
+
+>> Item[:name => "darwin"].move_to(3)
+=> {:position=>3}
+
+>> Item.print
++--+-------+--------+
+|id|name   |position|
++--+-------+--------+
+| 2|bob    |       1|
+| 1|alice  |       2|
+| 4|darwin |       3|
+| 3|charlie|       4|
++--+-------+--------+
+=> nil
+
+>> Item[:name => "bob"].move_to_bottom
+=> {:position=>4}
+
+>> Item.print
++--+-------+--------+
+|id|name   |position|
++--+-------+--------+
+| 1|alice  |       1|
+| 4|darwin |       2|
+| 3|charlie|       3|
+| 2|bob    |       4|
++--+-------+--------+
+=> nil

data/Rakefile

@@ -0,0 +1,158 @@
+##############################################################################
+# Constants
+##############################################################################
+
+PluginName = "sequel_orderable"
+Version    = "0.0.1"
+Title      = "Orderable Sequel Plugin"
+Summary    = "Sequel Plugin"
+Authors    = "Wayne E. Seguin & Aman Gupta"
+Emails     = "wayneeseugin@gmail.com,sequel@tmm1.net"
+Homepage   = "http://sequel.rubyforge.org"
+
+##############################################################################
+# Gem Management
+##############################################################################
+require "rake"
+require "rake/clean"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+require "fileutils"
+
+include FileUtils
+
+CLEAN.include ["**/.*.sw?", "pkg/*", ".config", "doc/*", "coverage/*"]
+
+RDocOptions = [
+  "--quiet", "--title", Title,
+  "--opname", "index.html",
+  "--line-numbers",
+  "--main", "README",
+  "--inline-source"
+]
+
+desc "Packages up the Sequel Plugin: #{PluginName}."
+task :default => [:package]
+task :package => [:clean]
+
+task :doc => [:rdoc]
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = "doc/rdoc"
+  rdoc.options += RDocOptions
+  rdoc.main = "README"
+  rdoc.title = Title
+  rdoc.rdoc_files.add ["README", "COPYING", "lib/#{PluginName}.rb", "lib/**/*.rb"]
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = PluginName
+  s.version = Version
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "CHANGELOG", "COPYING"]
+  s.rdoc_options += RDocOptions# + 
+    #["--exclude", "^(examples|extras)\/", "--exclude", "lib/sequel.rb"]
+  s.summary = Summary
+  s.description = Summary
+  s.author = Authors
+  s.email = Emails
+  s.homepage = Homepage
+  # change this to the plugin name, if the plugin has command line portion
+  #s.executables = ["sequel"]
+
+  s.add_dependency("sequel")
+  #s.add_dependency("sequel", ">= 0.4.1")
+  
+  #s.required_ruby_version = ">= 1.8.4" # Sequel should take care of this :)
+
+  s.files = %w(COPYING README Rakefile) + Dir.glob("{bin,doc,spec,lib}/**/*")
+  
+  s.require_path = "lib"
+  s.bindir = "bin"
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.need_tar = true
+  p.gem_spec = spec
+end
+
+task :release => [:package] do
+  sh %{rubyforge login}
+  sh %{rubyforge add_release sequel #{PluginName} #{Version} pkg/#{PluginName}-#{Version}.tgz}
+  sh %{rubyforge add_file sequel #{PluginName} #{Version} pkg/#{PluginName}-#{Version}.gem}
+end
+
+task :install do
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{PluginName}-#{Version}.gem}
+end
+
+task :install_no_docs do
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{PluginName}-#{Version} --no-rdoc --no-ri}
+end
+
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{PluginName}}
+end
+
+desc "Update docs and upload to rubyforge.org"
+task :doc_rforge do
+  sh %{rake doc}
+  sh %{scp -r doc/rdoc/* ciconia@rubyforge.org:/var/www/gforge-projects/sequel/plugins/#{PluginName}}
+end
+
+##############################################################################
+# rSpec
+##############################################################################
+
+require "spec/rake/spectask"
+
+desc "Run specs with coverage"
+Spec::Rake::SpecTask.new("spec") do |spec_task|
+  spec_task.spec_opts  = File.read("spec/spec.opts").split("\n")
+  spec_task.spec_files = FileList["spec/*_spec.rb"].sort
+  spec_task.rcov       = true
+end
+
+desc "Run specs without coverage"
+Spec::Rake::SpecTask.new("spec_no_cov") do |spec_task|
+  spec_task.spec_opts  = File.read("spec/spec.opts").split("\n")
+  spec_task.spec_files = FileList["spec/*_spec.rb"].sort
+end
+
+desc "Run all specs with coverage"
+Spec::Rake::SpecTask.new("specs") do |spec_task|
+  spec_task.spec_opts  = File.read("spec/spec.opts").split("\n")
+  spec_task.spec_files = FileList["spec/**/*_spec.rb"].sort
+  spec_task.rcov       = true
+end
+
+desc "Run all specs without coverage"
+Spec::Rake::SpecTask.new("specs_no_cov") do |spec_task|
+  spec_task.spec_opts  = File.read("spec/spec.opts").split("\n")
+  spec_task.spec_files = FileList["spec/**/*_spec.rb"].sort
+end
+
+desc "Run all specs and output html"
+Spec::Rake::SpecTask.new("specs_html") do |spec_task|
+  spec_task.spec_opts  = ["--format", "html"]
+  spec_task.spec_files = Dir["spec/**/*_spec.rb"].sort
+end
+
+##############################################################################
+# Statistics
+##############################################################################
+
+STATS_DIRECTORIES = [
+  %w(Code   lib/),
+  %w(Spec   spec/)
+].collect { |name, dir| [ name, "./#{dir}" ] }.select { |name, dir| File.directory?(dir) }
+
+desc "Report code statistics (KLOCs, etc) from the application"
+task :stats do
+  require "extra/stats"
+  verbose = true
+  CodeStatistics.new(*STATS_DIRECTORIES).to_s
+end

data/lib/sequel_orderable.rb

@@ -0,0 +1,84 @@
+module Sequel
+  module Plugins
+    module Orderable
+      
+      def self.apply(model, opts = {})
+        position_field = opts[:field] || :position
+        scope_field = opts[:scope]
+
+        model.class_def(:at_position) do |p|
+          if scope_field
+            dataset.first(scope_field => @values[scope_field], position_field => p)
+          else
+            dataset.first(position_field => p)
+          end
+        end
+
+        model.class_def(:move_to) do |pos|
+          # XXX: error checking, negative pos?
+          cur_pos = position
+          return self if pos == cur_pos
+
+          db.transaction do
+            if pos < cur_pos
+              ds = self.class.filter {position_field >= pos and position_field < cur_pos}
+              ds.filter!(scope_field => @values[scope_field]) if scope_field
+              ds.update(position_field => "#{position_field} + 1".lit)
+            elsif pos > cur_pos
+              ds = self.class.filter {position_field > cur_pos and position_field <= pos}
+              ds.filter!(scope_field => @values[scope_field]) if scope_field
+              ds.update(position_field => "#{position_field} - 1".lit)
+            end
+            set(position_field => pos)
+          end
+        end
+
+        model.class_def(:move_to_bottom) do
+          ds = dataset
+          ds = ds.filter(scope_field => @values[scope_field]) if scope_field
+          last = ds.select(:max[position_field] => :max).first.values[:max].to_i
+          self.move_to(last)
+        end
+
+        model.class_def(:position) {self[position_field]}
+
+        if scope_field
+          model.dataset.order!(scope_field, position_field)
+        else
+          model.dataset.order!(position_field)
+        end
+
+        model.send(:include, InstanceMethods)
+      end
+
+      module InstanceMethods
+        def prev(n = 1)
+          target = position - n
+          # XXX: error checking, negative target?
+          return self if position == target
+          at_position(target)
+        end
+
+        def next(n = 1)
+          target = position + n
+          at_position(target)
+        end
+
+        def move_up(n = 1)
+          # XXX: position == 1 already?
+          self.move_to(position-n)
+        end
+
+        def move_down(n = 1)
+          # XXX: what if we're already at the bottom
+          self.move_to(position+n)
+        end
+
+        def move_to_top
+          self.move_to(1)
+        end
+      end
+
+    end
+  end
+end

data/spec/sequel_orderable_spec.rb

@@ -0,0 +1,116 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+DB = Sequel.sqlite
+ 
+class Item < Sequel::Model(:items)
+
+  set_schema do
+    primary_key :id
+    varchar :name
+    int :pos
+  end
+
+  is :orderable, :field => :pos
+
+end
+
+describe Item do
+  before(:all) {
+    Item.create_table!
+ 
+    Item.create :name => "one",   :pos => 3
+    Item.create :name => "two",   :pos => 2
+    Item.create :name => "three", :pos => 1
+  }
+ 
+  it "should return rows in order of position" do
+    Item.map(&:pos).should == [1,2,3]
+    Item.map(&:name).should == %w[ three two one ]
+  end
+ 
+  it "should define prev and next" do
+    i = Item[:name => "two"]
+    i.prev.should == Item[:name => "three"]
+    i.next.should == Item[:name => "one"]
+  end
+ 
+  it "should define move_to" do
+    Item[:name => "two"].move_to(1)
+    Item.map(&:name).should == %w[ two three one ]
+ 
+    Item[:name => "two"].move_to(3)
+    Item.map(&:name).should == %w[ three one two ]
+  end
+ 
+  it "should define move_to_top and move_to_bottom" do
+    Item[:name => "two"].move_to_top
+    Item.map(&:name).should == %w[ two three one ]
+ 
+    Item[:name => "two"].move_to_bottom
+    Item.map(&:name).should == %w[ three one two ]
+  end
+ 
+  it "should define move_up and move_down" do
+    Item[:name => "one"].move_up
+    Item.map(&:name).should == %w[ one three two ]
+ 
+    Item[:name => "three"].move_down
+    Item.map(&:name).should == %w[ one two three ]
+  end
+  
+end
+ 
+class ListItem < Sequel::Model(:list_items)
+
+  set_schema do
+    primary_key :id
+    int :list_id
+    varchar :name
+    int :position
+  end
+
+  is :orderable, :scope => :list_id
+
+end
+ 
+describe ListItem do
+  
+  before(:all) {
+    ListItem.create_table!
+ 
+    ListItem.create :name => "a", :list_id => 1, :position => 3
+    ListItem.create :name => "b", :list_id => 1, :position => 2
+    ListItem.create :name => "c", :list_id => 1, :position => 1
+ 
+    ListItem.create :name => "d", :list_id => 2, :position => 1
+    ListItem.create :name => "e", :list_id => 2, :position => 2
+    ListItem.create :name => "f", :list_id => 2, :position => 3
+  }
+ 
+  it "should print in order with scope provided" do
+    ListItem.map(&:name).should == %w[ c b a d e f ]
+  end
+ 
+  it "should fetch prev and next records with scope" do
+    b = ListItem[:name => "b"]
+    b.next.name.should == "a"
+    b.prev.name.should == "c"
+    b.next.next.should be_nil
+    b.prev.prev.should be_nil
+ 
+    e = ListItem[:name => "e"]
+    e.next.name.should == "f"
+    e.prev.name.should == "d"
+    e.next.next.should be_nil
+    e.prev.prev.should be_nil
+  end
+ 
+  it "should move only within the scope provided" do
+    ListItem[:name => "b"].move_to_top
+    ListItem.map(&:name).should == %w[ b c a d e f ]
+ 
+    ListItem[:name => "c"].move_to_bottom
+    ListItem.map(&:name).should == %w[ b a c d e f ]
+  end
+  
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "sequel"
+require File.join(File.dirname(__FILE__), "../lib/sequel_orderable")
+
+class Symbol
+  def to_proc() lambda{ |object, *args| object.send(self, *args) } end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: sequel_orderable
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Wayne E. Seguin & Aman Gupta
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2007-12-04 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Sequel Plugin
+email: wayneeseugin@gmail.com,sequel@tmm1.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGELOG
+- COPYING
+files: 
+- COPYING
+- README
+- Rakefile
+- spec/sequel_orderable_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- lib/sequel_orderable.rb
+- CHANGELOG
+has_rdoc: true
+homepage: http://sequel.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --quiet
+- --title
+- Orderable Sequel Plugin
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README
+- --inline-source
+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: 0.9.5
+signing_key: 
+specification_version: 2
+summary: Sequel Plugin
+test_files: []
+