ibham 0.1.1.rc1 → 0.1.1

data/CHANGELOG.md

@@ -5,3 +5,7 @@
 ## V0.1.1.rc1
 
 * Save the vote when calling cast_vote method
+
+## V0.1.1
+
+* Better desription for the gem

data/README.md

@@ -1,6 +1,6 @@
-# Ibham [![Build Status](https://secure.travis-ci.org/bloc40/ibham.png)](http://travis-ci.org/bloc40/ibham)
+# Ibham [![Build Status](https://secure.travis-ci.org/bloc40/ibham.png)](http://travis-ci.org/bloc40/ibham) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/bloc40/ibham)
 
-TODO: Write a gem description
+Ibham is a gem that allows Rails apps to compute and display voting scores for active records models.
 
 ## Installation
 
@@ -16,9 +16,59 @@ Or install it yourself as:
 
     $ gem install ibham
 
-## Usage
+Generate the migration
 
-TODO: Write usage instructions here
+    $ rails g ibham:install
+    $ rake db:migrate
+
+# Usage
+
+Let's say you have a user model (the voter). You need to add the mixin
+*acts_as_voter* to that model:
+
+    class User < ActiveRecord::Base
+      acts_as_voter
+    end
+
+And let's say you have an item model that the user can cast vote for
+(the voteable). you need to add the mixin *acts_as_voteable* to the item
+model:
+
+    class Item < ActiveRecord::Base
+      acts_as_voteable
+    end
+
+### Casting votes
+
+The user can cast votes in the following ways:
+
+    # Let's first create a user and an item:
+    user = User.create
+    item = Item.create
+
+    user.vote_up(item)        # Adds a positive vote
+    user.vote_down(item)      # Adds a negative vote
+
+or
+
+    # The only allowed values are 1 and -1
+    user.cast_vote(item, 1)   # Adds a positive vote
+    user.cast_vote(item, -1)  # Adds a negative vote
+
+Since a user can cast only one vote per item, to check if the user can
+cast vote for an item:
+
+    user.can_vote_for?(item)
+
+### Retrieving votes
+
+To retrieve the votes:
+
+    item.up_votes             # Return the total number of positive votes
+    item.down_votes           # Return the total number of negative votes
+
+    item.up_percentage        # Return the percentage of positive votes
+    item.down_percentage      # Return the percentage of negative votes
 
 ## Contributing
 

data/lib/ibham/version.rb

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

data/lib/models/vote.rb

@@ -5,5 +5,5 @@ class Vote < ActiveRecord::Base
   belongs_to :voter, polymorphic: true
 
   validates_uniqueness_of :voteable_id, scope: :voter_id
-  validates :value, inclusion: { in: [1, -1] }
+  validates :value, inclusion: { in: [1, -1], message: 'should be either 1 or -1' }
 end

data/spec/models/vote_spec.rb

@@ -18,6 +18,7 @@ describe Vote do
     it 'should fail if the value is other than 1 or -1' do
       vote = Vote.new(value: 2)
       vote.valid?.must_equal false
+      vote.errors.full_messages.must_include 'Value should be either 1 or -1'
     end
 
     it 'should validate uniqueness of vote for voter and voteable' do

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: ibham
 version: !ruby/object:Gem::Version
-  version: 0.1.1.rc1
-  prerelease: 6
+  version: 0.1.1
+  prerelease: 
 platform: ruby
 authors:
 - Jamal El Milahi
@@ -13,7 +13,7 @@ date: 2012-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70226356473360 !ruby/object:Gem::Requirement
+  requirement: &70361593621620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70226356473360
+  version_requirements: *70361593621620
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70226356471720 !ruby/object:Gem::Requirement
+  requirement: &70361593618840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70226356471720
+  version_requirements: *70361593618840
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &70226356469800 !ruby/object:Gem::Requirement
+  requirement: &70361593617980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70226356469800
+  version_requirements: *70361593617980
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70226356468640 !ruby/object:Gem::Requirement
+  requirement: &70361593643540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70226356468640
+  version_requirements: *70361593643540
 description: Voting System for Rails applications
 email:
 - jamal@elmilahi.com
@@ -96,9 +96,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17