rank 0.0.1

data/.gitignore

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

data/Gemfile

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

data/License.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Panayiotis Thomakos
+
+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.markdown

@@ -0,0 +1,47 @@
+# Rank
+
+Easily add rankings to arrays of objects.
+
+## Installation
+
+    gem install rank
+
+## Getting Started
+
+Add rankings to your objects:
+
+    things = [{:attr => 'a'}, {:attr => 'c'}, {:attr => 'b'}]
+    Rank.add things, :attr
+    => [{:attr=>"a", :rank=>1}, {:attr=>"b", :rank=>2}, {:attr=>"c", :rank=>3}]
+    
+You can add rank to ActiveRecord objects as well:
+
+    Rank.add User.all, :firstname, :lastname
+    
+In general anything that responds to '[]' can have a rank added to it.
+
+## Additional Options
+
+Adding a sorting order:
+    
+    Rank.add User.all, [:firstname, :asc], [:lastname, :desc]
+    
+You can specify a conversion to floating point or integer:
+
+    Rank.add User.all, [:id, :asc, :integer]
+        
+You can choose to honor ties or to ignore them:
+
+    things = [{:attr => 'a'}, {:attr => 'c'}, {:attr => 'b'}, {:attr => 'b'}]
+    
+    Rank.add things, :attr, :ties => false
+    => [{:attr=>"a", :rank=>1}, {:attr=>"b", :rank=>2}, {:attr=>"b", :rank=>3}, {:attr=>"c", :rank=>4}]
+    
+    Rank.add things, :attr, :ties => true
+    => [{:attr=>"a", :rank=>1}, {:attr=>"b", :rank=>2}, {:attr=>"b", :rank=>2}, {:attr=>"c", :rank=>4}]
+    
+You can leave the objects in their original positions:
+
+    things = [{:attr => 'a'}, {:attr => 'c'}, {:attr => 'b'}]
+    Rank.add things, :attr, :sort => false
+    [{:attr=>"a", :rank=>1}, {:attr=>"c", :rank=>2}, {:attr=>"b", :rank=>2}]

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/rank.rb

@@ -0,0 +1,60 @@
+module Rank
+  #assumes ascending :asc, but can also use descending :desc
+  def self.compare a, b, *attributes
+    attributes.each do |attribute, order, conversion|
+      a_attribute = self.perform_conversion a[attribute], conversion
+      b_attribute = self.perform_conversion b[attribute], conversion
+      use_order = order || :asc
+      if a_attribute.nil? and !b_attribute.nil?
+        return 1
+      elsif !a_attribute.nil? and b_attribute.nil?
+        return -1
+      elsif !a_attribute.nil? and !b_attribute.nil?
+        if a_attribute > b_attribute
+          return (use_order == :asc ? 1 : -1)
+        elsif a_attribute < b_attribute
+          return (use_order == :asc ? -1 : 1)
+        end
+      end
+    end
+    return 0
+  end
+
+  #add_rank athletes, :attribute => :created_at, :ties => true
+  def self.add objects, *attributes
+    options = { :ties => true, :sort => true }.merge(extract_options! attributes)
+
+    current_rank = 1
+    last_object = nil
+    objects.sort!{ |a, b| Rank.compare(a, b, *attributes) } if options[:sort]
+    objects.each_with_index do |object, i|
+      if options[:ties]
+        current_rank = i+1 if !!last_object && Rank.compare(object, last_object, *attributes) == 1
+      else
+        current_rank = i+1 if !!last_object
+      end
+      object[:rank] = current_rank
+      last_object = object
+    end
+
+    return objects
+  end
+  
+  def self.extract_options! args
+    args.last.is_a?(::Hash) ? args.pop : {}
+  end
+  
+  def self.perform_conversion value, conversion
+    begin
+      if conversion.nil? || conversion == :none
+        value
+      elsif conversion == :float
+        value.to_f
+      elsif conversion == :integer
+        value.to_i
+      end
+    rescue
+      nil
+    end
+  end
+end

data/lib/rank/version.rb

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

data/rank.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rank/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rank"
+  s.version     = Rank::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Pan Thomakos"]
+  s.email       = ["pan.thomakos@gmail.com"]
+  s.homepage    = "http://github.com/panthomakos/rank"
+  s.summary     = "rank-#{Rank::VERSION}"
+  s.description = %q{Easily add rankings to arrays of objects.}
+
+  s.rubyforge_project = "rank"
+
+  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.extra_rdoc_files = ['README.markdown', 'License.txt']
+  s.rdoc_options = ['--charset=UTF-8']
+  s.require_paths = ["lib"]
+end

data/test/rank_test.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/../lib/rank')
+require 'test/unit'
+
+class RankTest < Test::Unit::TestCase
+  def test_compare
+    first = {:id => 10}
+    second = {:id => 20}
+    assert_equal -1, Rank.compare(first, second, :id)
+    assert_equal  0, Rank.compare(first, first, :id)
+    assert_equal  1, Rank.compare(second, first, :id)
+  end
+  
+  def test_compare_with_multiple_attributes
+    first = {:one => 1, :two => 'b'}
+    second = {:one => 2, :two => 'a'}
+    assert_equal  1, Rank.compare(first, second, :two, :one)
+    assert_equal -1, Rank.compare(first, second, :one, :two)
+    assert_equal  0, Rank.compare(first, first, :one, :two)
+    assert_equal  0, Rank.compare(first, first, :two, :one)
+  end
+
+  def test_setting_rank_without_ties
+    first = {:id => 1}
+    second = {:id => 2}
+    Rank.add [first, second], :id, :ties => false
+    assert_equal 1, first[:rank]
+    assert_equal 2, second[:rank]
+  end
+  
+  def test_setting_rank_with_ties
+    first = {:one => 1}
+    second = {:one => 1}
+    third = {:one => 2}
+    Rank.add [first, second, third], :one, :ties => true
+    assert_equal 1, first[:rank]
+    assert_equal 1, second[:rank]
+    assert_equal 3, third[:rank]
+  end
+
+  def test_always_ranking_nil_values_last
+    first = {:one => 1}
+    second = {:one => nil}
+    third = {:one => 2}
+    
+    Rank.add [first, second, third], [:one, :asc], :ties => true, :sort => true
+    assert_equal 1, first[:rank]
+    assert_equal 2, third[:rank]
+    assert_equal 3, second[:rank]
+    
+    Rank.add [first, second, third], [:one, :desc], :ties => true, :sort => true
+    assert_equal 1, third[:rank]
+    assert_equal 2, first[:rank]
+    assert_equal 3, second[:rank]
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: rank
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Pan Thomakos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-19 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Easily add rankings to arrays of objects.
+email: 
+- pan.thomakos@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+- License.txt
+files: 
+- .gitignore
+- Gemfile
+- License.txt
+- README.markdown
+- Rakefile
+- lib/rank.rb
+- lib/rank/version.rb
+- rank.gemspec
+- test/rank_test.rb
+has_rdoc: true
+homepage: http://github.com/panthomakos/rank
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rank
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: rank-0.0.1
+test_files: 
+- test/rank_test.rb