volleyball 0.1.2

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.1.1 / 2010-06-03
+
+* starting point
+
+
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/volleyball.rb
+rails/init.rb
+test/test_volleyball.rb

data/README.txt

@@ -0,0 +1,71 @@
+= Vollyball
+
+* http://www.bitbucket.org/digger250/vollyball
+
+== DESCRIPTION:
+
+A small library for yes/no voting on ActiveRecord models.
+
+== FEATURES/PROBLEMS:
+
+* None yet
+
+== SYNOPSIS:
+
+voteable
+
+== REQUIREMENTS:
+
+* Must have a model called user
+
+== INSTALL:
+
+* gem install vollball
+* Create a new rails migration and add the following self.up and self.down methods
+
+ def self.up
+   create_table "votes", :force => true do |t|
+     t.boolean :up, {:null=>false}
+     t.string :subject_type, {:null=>false}
+     t.integer :subject_id, {:null=>false}
+     t.integer :user_id, {:null=>false}
+     t.timestamps
+   end
+ 
+   add_index "votes", ["user_id"], :name => "fk_votes_user"
+ end
+
+ def self.down
+   drop_table :votes
+ end
+
+
+* Add yes_votes/no_votes columns for vote rollup and score on the table you count votes for:
+  add_column :my_objects, :yes_votes, :integer, {:default => 0, :null=>false}
+  add_column :my_objects, :no_votes, :integer, {:default => 0, :null=>false}
+  add_column :my_objects, :score, :float
+
+== LICENSE:
+
+(The MIT License)
+
+  Copyright (c) 2010 Justin Coyne
+
+  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,23 @@
+# -*- ruby -*-
+
+
+require 'rake/clean'
+require 'rubygems'
+require 'hoe'
+CLEAN.include %w(**/*.orig)
+Hoe.plugins.delete :rubyforge
+Hoe.plugin :hg
+
+Hoe.spec 'volleyball' do
+  developer('Justin Coyne', 'jcoyne@justincoyne.com')
+  extra_deps <<  %w(statistics2 >=0.54) 
+  extra_dev_deps << %w(shoulda >=2.10.0) << %w(mocha >=0.9.8) << %w(active_support)
+end
+
+task :install =>:package do
+  $:<< 'lib'
+  require 'volleyball'
+  puts `GEM_HOME=~/.gem/ruby/1.8 gem install pkg/volleyball-#{Volleyball::VERSION}.gem`
+end
+# vim: syntax=ruby
+#

data/lib/volleyball.rb

@@ -0,0 +1,45 @@
+require 'statistics2'
+module Volleyball
+  VERSION = "0.1.2"
+  
+  def self.included(base)
+    base.extend ClassMethods
+    
+  end
+  
+  module ClassMethods
+    def votable (args={})
+      has_many :votes, :as=>:subject
+      before_save :calculate_score
+      cattr_accessor :yes_adjustment
+      cattr_accessor :no_adjustment
+      self.yes_adjustment = args[:yes_start] ? args[:yes_start] : 0
+      self.no_adjustment = args[:no_start] ? args[:no_start] : 0
+      
+      include Volleyball::InstanceMethods
+    end
+  end
+  
+  module InstanceMethods
+    def calculate_score
+      self.score = (rank * 100).floor.to_f/10
+    end
+
+    def rank 
+      adjusted_yes_votes = self.yes_votes + self.class.yes_adjustment
+      adjusted_total_votes = self.no_votes + adjusted_yes_votes + self.class.no_adjustment
+      ci_lower_bound(adjusted_yes_votes, adjusted_total_votes, 0.10) 
+    end  
+
+    # This is the Wilson Confidence Interval
+    # http://www.evanmiller.org/how-not-to-sort-by-average-rating.html
+    def ci_lower_bound(pos, n, power)
+      return 0 if n == 0
+      z = Statistics2.normaldist(1-power/2)
+      phat = 1.0*pos/n
+      (phat + z*z/(2*n) - z * Math.sqrt((phat*(1-phat)+z*z/(4*n))/n))/(1+z*z/n)
+    end
+  end
+  
+end
+

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'volleyball'
+ActiveRecord::Base.send(:include, Volleyball)

data/test/test_volleyball.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require "test/unit"
+require 'volleyball'
+require 'shoulda'
+require 'mocha'
+require 'ruby-debug'
+require 'active_support' #for cattr_accessor
+class TestVolleyball < Test::Unit::TestCase
+
+  class MockArModel
+    include Volleyball
+  end
+  
+  context "volleyball lib" do 
+  
+    setup do
+      MockArModel.expects(:has_many).with(:votes, {:as => :subject})
+      MockArModel.expects(:before_save).with(:calculate_score)
+      MockArModel.any_instance.stubs(:yes_votes).returns(200)
+      MockArModel.any_instance.stubs(:no_votes).returns(121)
+      MockArModel.votable :yes_start=>7, :no_start=>5
+    end
+    should "have yes_adjustment" do
+      assert_equal 7, MockArModel.yes_adjustment
+    end
+    should "have no_adjustment" do
+      assert_equal 5, MockArModel.no_adjustment
+    end
+    
+    should "Calculate score" do
+      instance = MockArModel.new
+      instance.expects(:score=).with(5.9)
+      assert instance.calculate_score
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: volleyball
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Justin Coyne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: statistics2
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 103
+        segments: 
+        - 0
+        - 54
+        version: "0.54"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 2
+        - 10
+        - 0
+        version: 2.10.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 6
+        - 1
+        version: 2.6.1
+  type: :development
+  version_requirements: *id005
+description: A small library for yes/no voting on ActiveRecord models.
+email: 
+- jcoyne@justincoyne.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/volleyball.rb
+- rails/init.rb
+- test/test_volleyball.rb
+has_rdoc: true
+homepage: http://www.bitbucket.org/digger250/vollyball
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: volleyball
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A small library for yes/no voting on ActiveRecord models.
+test_files: 
+- test/test_volleyball.rb