ibham 0.1.1 → 0.1.2

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
 env:
   - DB=postgresql

data/CHANGELOG.md

@@ -9,3 +9,10 @@
 ## V0.1.1
 
 * Better desription for the gem
+
+## v0.1.2
+
+* Add methods: Voteable#up_voters and down_voters
+* Remove database_cleaner gem
+* Refactor code
+* Add comments to methods

data/README.md

@@ -70,6 +70,7 @@ To retrieve the votes:
     item.up_percentage        # Return the percentage of positive votes
     item.down_percentage      # Return the percentage of negative votes
 
+For more information visit [[the documentation page](http://rubydoc.info/github/bloc40/ibham/master/frames)]
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -2,7 +2,7 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 desc 'Default: run specs.'
-task default: :test
+task :default => :test
 
 Rake::TestTask.new do |test|
   test.pattern = './spec/**/*_spec.rb'

data/ibham.gemspec

@@ -19,6 +19,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'activerecord'
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'database_cleaner'
   gem.add_development_dependency 'sqlite3'
 end

data/lib/generators/ibham/templates/migration.rb

@@ -1,8 +1,8 @@
 class IbhamCreateVotes < ActiveRecord::Migration
   def change
     create_table :votes do |t|
-      t.references :voter, polymorphic: true
-      t.references :voteable, polymorphic: true
+      t.references :voter, :polymorphic => true
+      t.references :voteable, :polymorphic => true
       t.integer :value
 
       t.timestamps

data/lib/ibham.rb

@@ -4,7 +4,8 @@ require 'ibham/acts_as_voteable'
 require 'models/vote'
 
 module Ibham
-  # Your code goes here...
+  ALLOWED_VALUE = 1
+  DELTA = 0.00001
 end
 
 ActiveRecord::Base.class_eval do

data/lib/ibham/acts_as_voteable.rb

@@ -3,6 +3,12 @@ module Ibham
     extend ActiveSupport::Concern
 
     module ClassMethods
+
+      # To turn an abject to a voteable, call <tt>acts_as_voteable</tt> in the Active Record model class.
+      #
+      #   class Item < ActiveRecord::Base
+      #     acts_as_voteable
+      #   end
       def acts_as_voteable
         class_eval do
           include Voteable
@@ -14,23 +20,58 @@ module Ibham
       extend ActiveSupport::Concern
 
       included do
-        has_many :votes, as: :voteable, dependent: :destroy
+        has_many :votes, :as => :voteable, :dependent => :destroy
       end
 
+      # To ruturn the count of positive votes, call <tt>up_votes</tt> on the voteable object.
+      #
+      #   item.up_votes
       def up_votes
-        votes.where(value: 1).count
+        votes.where(:value => ALLOWED_VALUE).count
       end
 
+      # To ruturn the count of negative votes, call <tt>down_votes</tt> on the voteable object.
+      #
+      #   item.down_votes
       def down_votes
-        votes.where(value: -1).count
+        votes.where(:value => -ALLOWED_VALUE).count
       end
 
+      # To ruturn the percentage of positive votes, call <tt>up_percentage</tt> on the voteable object.
+      # This is ideal to use with sparkbars.
+      #
+      #   item.up_percentage
       def up_percentage
-        up_votes * 100 / votes.count.to_f
+        (up_votes * 100 / (votes.count.to_f + DELTA)).round
       end
 
+      # To ruturn the percentage of positive votes, call <tt>down_percentage</tt> on the voteable object.
+      # This is ideal to use with sparkbars.
+      #
+      #   item.down_percentage
       def down_percentage
-        100 - up_percentage
+        (down_votes * 100 / (votes.count.to_f + DELTA)).round
+      end
+
+      # To get the list of voters, call <tt>voters</tt> on the voteable object.
+      #
+      #   item.voters
+      def voters
+        votes.map(&:voter)
+      end
+
+      # To get the list of voters who casted positive votes, call <tt>up_voters</tt> on the voteable object.
+      #
+      #   item.up_voters
+      def up_voters
+        votes.where(:value => ALLOWED_VALUE).map(&:voter)
+      end
+
+      # To get the list of voters who casted negative votes, call <tt>down_voters</tt> on the voteable object.
+      #
+      #   item.down_voters
+      def down_voters
+        votes.where(:value => -ALLOWED_VALUE).map(&:voter)
       end
     end
   end

data/lib/ibham/acts_as_voter.rb

@@ -3,6 +3,12 @@ module Ibham
     extend ActiveSupport::Concern
 
     module ClassMethods
+
+      # To turn an abject to a voter, call <tt>acts_as_voter</tt> in the Active Record model class.
+      #
+      #   class User < ActiveRecord::Base
+      #     acts_as_voter
+      #   end
       def acts_as_voter
         class_eval do
           include Voter
@@ -14,23 +20,47 @@ module Ibham
       extend ActiveSupport::Concern
 
       included do
-        has_many :votes, as: :voter, dependent: :destroy
+        has_many :votes, :as => :voter, :dependent => :destroy
       end
 
+      # To check if the voter (the user for example) can vote for this item,
+      # call <tt>can_vote_for?</tt> on the voter with the object to vote for.
+      #
+      #   user.can_vote_for?(item)
+      #
+      # This will return either true for false
       def can_vote_for?(voteable)
-        votes.build(voteable: voteable, value: 1).valid?
+        votes.build(:voteable => voteable, :value => ALLOWED_VALUE).valid?
       end
 
+      # To cast a positive vote, the voter (e.g. the use) calls <tt>vote_up</tt>
+      # with the object to vote for.
+      #
+      #   user.vote_up(item)
+      #
+      # This will add a new record with a positive vote for this item by this user in the votes table.
       def vote_up(voteable)
-        votes.create(voteable: voteable, value: 1)
+        votes.create(:voteable => voteable, :value => ALLOWED_VALUE)
       end
 
+      # To cast a negative vote, the voter (e.g. the use) can call <tt>vote_up</tt>
+      # with the object to vote for.
+      #
+      #   user.vote_up(item)
+      #
+      # This will add a new record with a negative vote for this item by this user in the votes table.
       def vote_down(voteable)
-        votes.create(voteable: voteable, value: -1)
+        votes.create(:voteable => voteable, :value => -ALLOWED_VALUE)
       end
 
+      # To allow the user to dynamically cast a vote, call <tt>cast_vote</tt> with the item
+      # to vote for and the value (1 or -1)
+      #
+      #   user.cast_vote(item, 1)
+      #
+      # This will add a new record with a positive vote.
       def cast_vote(voteable, value)
-        votes.create(voteable: voteable, value: value)
+        votes.create(:voteable => voteable, :value => value)
       end
     end
   end

data/lib/ibham/version.rb

@@ -1,3 +1,3 @@
 module Ibham
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/models/vote.rb

@@ -1,9 +1,12 @@
 class Vote < ActiveRecord::Base
+
+  ALLOWED_VALUE = 1
+
   attr_accessible :value, :voteable
 
-  belongs_to :voteable, polymorphic: true
-  belongs_to :voter, polymorphic: true
+  belongs_to :voteable, :polymorphic => true
+  belongs_to :voter, :polymorphic => true
 
-  validates_uniqueness_of :voteable_id, scope: :voter_id
-  validates :value, inclusion: { in: [1, -1], message: 'should be either 1 or -1' }
+  validates_uniqueness_of :voteable_id, :scope => :voter_id
+  validates :value, :inclusion => { :in => [ALLOWED_VALUE, -ALLOWED_VALUE], :message => "should be either #{ALLOWED_VALUE} or -#{ALLOWED_VALUE}" }
 end

data/spec/models/vote_spec.rb

@@ -1,22 +1,22 @@
 require_relative '../spec_helper'
 
 describe Vote do
-  let(:user) { User.create!(email: 'foo@example.com') }
-  let(:item) { Item.create!(name: 'item') }
+  let(:user) { User.create! }
+  let(:item) { Item.create! }
 
   describe 'Validations' do
     it 'should be valid if the value is 1' do
-      vote = Vote.new(value: 1)
+      vote = Vote.new(:value => 1)
       vote.valid?.must_equal true
     end
 
     it 'should be valid if the value is -1' do
-      vote = Vote.new(value: -1)
+      vote = Vote.new(:value => -1)
       vote.valid?.must_equal true
     end
 
     it 'should fail if the value is other than 1 or -1' do
-      vote = Vote.new(value: 2)
+      vote = Vote.new(:value => 2)
       vote.valid?.must_equal false
       vote.errors.full_messages.must_include 'Value should be either 1 or -1'
     end

data/spec/modules/acts_as_voteable_spec.rb

@@ -28,13 +28,13 @@ describe 'ActsAsVoteable' do
 
   describe '#up_percentage' do
     it 'should return the percentage of positive votes' do
-      item.up_percentage.must_be_close_to 66.6, 0.1
+      item.up_percentage.must_equal 67
     end
   end
 
   describe '#down_percentage' do
     it 'should return the percentage of negative votes' do
-      item.down_percentage.must_be_close_to 33.3, 0.1
+      item.down_percentage.must_equal 33
     end
 
     it 'should return 100% if the item has 1 negative vote' do
@@ -45,4 +45,25 @@ describe 'ActsAsVoteable' do
       item2.up_percentage.must_equal 0
     end
   end
+
+  describe '#voters' do
+    it 'should return the list of voters' do
+      item.voters.sort.must_equal [user2, user1, user3].sort
+      item2.voters.must_equal [user1]
+    end
+  end
+
+  describe '#up_voters' do
+    it 'should return the list of users who casted positive votes' do
+      item.up_voters.sort.must_equal [user1, user3].sort
+      item2.up_voters.must_equal []
+    end
+  end
+
+  describe '#down_voters' do
+    it 'should return the list of users who casted negative votes' do
+      item.down_voters.sort.must_equal [user2]
+      item2.down_voters.must_equal [user1]
+    end
+  end
 end

data/spec/modules/acts_as_voter_spec.rb

@@ -1,8 +1,8 @@
 require_relative '../spec_helper'
 
 describe 'ActsAsVoter' do
-  let(:user) { User.create!(email: 'foo@example.com') }
-  let(:item) { Item.create!(name: 'item') }
+  let(:user) { User.create! }
+  let(:item) { Item.create! }
 
   describe '#can_vote_for?' do
     it 'should return true if the voter can vote for an item' do

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 require 'active_record'
-require 'database_cleaner'
 require 'sqlite3'
 require 'ibham'
 require 'minitest/autorun'
@@ -9,19 +8,29 @@ db_config = {
   :database => ':memory:'
 }
 
-ActiveRecord::Base.establish_connection(db_config)
-
 ActiveRecord::Migration.verbose = false
 
 class MiniTest::Spec
-  before(:each) { DatabaseCleaner.start }
-  after(:each) { DatabaseCleaner.clean }
+  before do
+    User.destroy_all
+    Item.destroy_all
+    Vote.destroy_all
+  end
+
+  config = {
+    :adapter => 'sqlite3',
+    :database => ':memory:'
+  }
+
+  ActiveRecord::Base.establish_connection(config)
+  ActiveRecord::Base.connection.create_database config[:database] rescue nil
+  ActiveRecord::Base.connection.drop_database config[:database] rescue nil
 end
 
 ActiveRecord::Schema.define do
   create_table :votes do |t|
-    t.references :voter, polymorphic: true
-    t.references :voteable, polymorphic: true
+    t.references :voter, :polymorphic => true
+    t.references :voteable, :polymorphic => true
     t.integer :value
 
     t.timestamps

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ibham
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-05 00:00:00.000000000 Z
+date: 2012-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70361593621620 !ruby/object:Gem::Requirement
+  requirement: &70249569608880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70361593621620
+  version_requirements: *70249569608880
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70361593618840 !ruby/object:Gem::Requirement
+  requirement: &70249569608460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,21 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70361593618840
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: &70361593617980 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70361593617980
+  version_requirements: *70249569608460
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70361593643540 !ruby/object:Gem::Requirement
+  requirement: &70249569608040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70361593643540
+  version_requirements: *70249569608040
 description: Voting System for Rails applications
 email:
 - jamal@elmilahi.com
@@ -111,3 +100,4 @@ test_files:
 - spec/modules/acts_as_voteable_spec.rb
 - spec/modules/acts_as_voter_spec.rb
 - spec/spec_helper.rb
+has_rdoc: