sortable 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-09-23
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/sortable.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_sortable.rb

data/README.rdoc

@@ -0,0 +1,63 @@
+= sortable
+
+* http://github.com/bscofield/sortable
+
+== DESCRIPTION:
+
+Sortable provides a DSL for defining sort order on any Ruby object
+
+To use it, you just call the sortable method and pass it a list of methods and/or blocks; when
+you call sort on a collection of these objects, each method/block is evaluated in turn, and the 
+first that provides a non-zero sort value is used.
+
+== EXAMPLE:
+
+  require 'sortable'
+  
+  class Book
+    attr_accessor :author, :title
+    
+    sortable :author, lambda {|book| book.title.sub(/^(The|A|An) /, '')}
+    
+    def initialize(author, title)
+      self.author = author
+      self.title  = title
+    end
+  end
+  
+  fforde  = Book.new('Fforde', 'Something Rotten')
+  stroud1 = Book.new('Stroud', 'The Golem\'s Eye')
+  stroud2 = Book.new('Stroud', 'The Amulet of Samarkand')
+  colfer  = Book.new('Colfer', 'Artemis Fowl')
+  
+  [fforde, stroud1, stroud2, colfer].sort #=> colfer, fforde, stroud2, stroud1
+
+== INSTALL:
+
+Installation is available with a simple: 
+  sudo gem install sortable
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Ben Scofield
+
+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/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/sortable'
+
+Hoe.plugin :newgem
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'sortable' do
+  self.developer 'Ben Scofield', 'ruby@turrean.com'
+  self.rubyforge_name       = 'sortable-object'
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/sortable.rb

@@ -0,0 +1,27 @@
+module Sortable
+  VERSION = '0.0.1'
+  
+  def self.included(base)
+    base.extend Sortable::ClassMethods
+  end
+  
+  module ClassMethods
+    def sortable(*sorters)
+      define_method :"<=>", lambda { |other|
+        comp = 0
+        sorters.each do |sorter|
+          comp = if sorter.respond_to?(:call)
+            sorter.call(self) <=> sorter.call(other)
+          else
+            self.send(sorter) <=> other.send(sorter)
+          end
+
+          break if comp != 0
+        end
+        comp
+      }
+    end
+  end
+end
+
+Object.send(:include, Sortable)

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/sortable.rb'}"
+puts "Loading sortable gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/sortable'

data/test/test_sortable.rb

@@ -0,0 +1,54 @@
+require 'pp'
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestBook
+  attr_accessor :author, :title
+  
+  def initialize(author, title)
+    self.author = author
+    self.title  = title
+  end
+end
+
+class TestSortable < Test::Unit::TestCase
+  def setup
+    @fforde  = TestBook.new('Fforde', 'Something Rotten')
+    @stroud1 = TestBook.new('Stroud', 'The Golem\'s Eye')
+    @stroud2 = TestBook.new('Stroud', 'The Amulet of Samarkand')
+    @colfer  = TestBook.new('Colfer', 'Artemis Fowl')
+    
+    @books = [@fforde, @stroud1, @stroud2, @colfer]
+  end
+  
+  def test_sortable_should_be_defined
+    assert_nothing_raised do
+      Sortable
+    end
+  end
+  
+  def test_object_should_include_sortable
+    assert Object.ancestors.include?(Sortable)
+  end
+  
+  def test_object_should_have_sortable_method
+    assert Object.respond_to?(:sortable)
+  end
+  
+  def test_books_should_sort_by_author_and_title
+    TestBook.send(:sortable, :author, :title)
+    
+    assert_equal [@colfer, @fforde, @stroud2, @stroud1], @books.sort
+  end
+  
+  def test_books_should_sort_by_unaltered_title
+    TestBook.send(:sortable, :title, :author)
+    
+    assert_equal [@colfer, @fforde, @stroud2, @stroud1], @books.sort
+  end
+  
+  def test_books_should_sort_by_altered_title
+    TestBook.send(:sortable, lambda {|book| book.title.sub(/^(The|A|An) /, '')}, :author)
+    
+    assert_equal [@stroud2, @colfer, @stroud1, @fforde], @books.sort
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: sortable
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben Scofield
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-23 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: |-
+  Sortable provides a DSL for defining sort order on any Ruby object
+  
+  To use it, you just call the sortable method and pass it a list of methods and/or blocks; when
+  you call sort on a collection of these objects, each method/block is evaluated in turn, and the 
+  first that provides a non-zero sort value is used.
+email: 
+- ruby@turrean.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/sortable.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_sortable.rb
+has_rdoc: true
+homepage: http://github.com/bscofield/sortable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: sortable-object
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Sortable provides a DSL for defining sort order on any Ruby object  To use it, you just call the sortable method and pass it a list of methods and/or blocks; when you call sort on a collection of these objects, each method/block is evaluated in turn, and the  first that provides a non-zero sort value is used.
+test_files: 
+- test/test_helper.rb
+- test/test_sortable.rb