technicalpickles-rankles 0.0.2

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Josh Nichols
+
+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.rdoc

@@ -0,0 +1,30 @@
+= rankles
+
+Rankles is a collection of ranking algorithms (technically only one at the moment) implemented in Ruby.
+
+The idea is simple. Give Rankles some data, and it will give you a number. You probably want to sort based on this number.
+
+Quick example:
+
+    reddit = Rankles::Reddit.new :date => entry.published_at,
+                                 :upvotes => entry.cached_upvotes_count,
+                                 :downvotes => entry.cached_downvotes_count
+
+    reddit.to_f
+
+If you're dealing with ActiveRecord objects, you can actually assign the Rankles object to a float field, and it will handle converstion:
+
+    class Entry < ActiveRecord::Base
+      # ommitted
+      def calculate_ranking
+        reddit_ranking = Rankles::Reddit.new :date => entry.published_at,
+                                     :upvotes => entry.cached_upvotes_count,
+                                     :downvotes => entry.cached_downvotes_count
+
+        update_attributes! :ranking => reddit_ranking
+      end
+    end
+
+== Copyright
+
+Copyright (c) 2009 Josh Nichols. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rankles"
+    gem.summary = %Q{Ranking algorithms.}
+    gem.email = "josh@technicalpickles.com"
+    gem.homepage = "http://github.com/technicalpickles/rankles"
+    gem.authors = ["Josh Nichols"]
+    gem.rubyforge_project = "pickles"
+    gem.add_dependency "activesupport"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+  Jeweler::RubyforgeTasks.new
+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.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  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 = "rankles #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/rankles.rb

@@ -0,0 +1,38 @@
+require 'activesupport'
+module Rankles
+  class Reddit
+    attr_accessor :date, :upvotes, :downvotes
+
+    # Setup data for ranking calculation. Required options:
+    # * <tt>:date</tt>
+    # * <tt>:upvotes</tt>
+    # * <tt>:downvotes</tt>
+    def initialize(options = {})
+      self.date      = options[:date]
+      self.upvotes   = options[:upvotes]
+      self.downvotes = options[:downvotes]
+    end
+
+    # http://www.seomoz.org/img/upload/reddit_cf_algorithm.png 
+    #
+    # Gives the result of the reddit algorithm. Higher is better.
+    def to_f
+      ts = date - Time.utc(2005, 12, 8, 7, 46, 43)
+      x = upvotes - downvotes
+
+      y = case
+          when x > 0  then 1
+          when x == 0 then 0
+          when x < 0  then -1
+          end
+
+      z = if x.abs >= 1
+            x.abs
+          else
+            1
+          end
+
+      Math.log10(z) + (y * ts) / 12.5.hours
+    end
+  end
+end

data/rankles.gemspec

@@ -0,0 +1,51 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rankles}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Josh Nichols"]
+  s.date = %q{2009-05-14}
+  s.email = %q{josh@technicalpickles.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rankles.rb",
+     "rankles.gemspec",
+     "spec/rankles_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/technicalpickles/rankles}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{pickles}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Ranking algorithms.}
+  s.test_files = [
+    "spec/rankles_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end

data/spec/rankles_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Rankles::Reddit do
+  it "should not blow up" do
+    reddit = Rankles::Reddit.new :date => Time.now, :upvotes => 0, :downvotes => 0
+    reddit.to_f
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rankles'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: technicalpickles-rankles
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Josh Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-14 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: josh@technicalpickles.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rankles.rb
+- rankles.gemspec
+- spec/rankles_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/technicalpickles/rankles
+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: pickles
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ranking algorithms.
+test_files: 
+- spec/rankles_spec.rb
+- spec/spec_helper.rb