ibham 0.1.2 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22773a5276f0ef750a2db5513314e96e0efe8093
+  data.tar.gz: 5ca1cf25287eb58391af77cec4d79555a98943cf
+SHA512:
+  metadata.gz: 24045afcc41bec10e7e197f41191f402ae98402f9e2c43523e60104971e23d9325135d0c20b94e780786f836d81e41f2cefeba5916fd74dacb794ce7abf6433b
+  data.tar.gz: ac0b566e3d53016118eab374931e52102e40ad8b9bcd95925d1e65ad2b6b0a791ea09592185a7ed9201f15756b274fa19b52b84d893b59d4ae18a260c63cc8e1

data/CHANGELOG.md

@@ -16,3 +16,9 @@
 * Remove database_cleaner gem
 * Refactor code
 * Add comments to methods
+
+## v0.1.3
+
+* Drop support for Ruby < 1.9
+* Add method: vote_result
+* Clean up code and comments

data/README.md

@@ -1,4 +1,4 @@
-# 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)
+# 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) [![Dependency Status](https://gemnasium.com/bloc40/ibham.png)](https://gemnasium.com/bloc40/ibham)
 
 Ibham is a gem that allows Rails apps to compute and display voting scores for active records models.
 
@@ -12,10 +12,6 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install ibham
-
 Generate the migration
 
     $ rails g ibham:install
@@ -49,12 +45,6 @@ The user can cast votes in the following ways:
     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:
 
@@ -64,13 +54,16 @@ cast vote for an item:
 
 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_votes             # Returns the total number of positive votes
+    item.down_votes           # Returns the total number of negative votes
+
+    item.up_percentage        # Returns the percentage of positive votes
+    item.down_percentage      # Returns the percentage of negative votes
 
-    item.up_percentage        # Return the percentage of positive votes
-    item.down_percentage      # Return the percentage of negative votes
+    item.vote_result          # Retuns the result of votes
 
-For more information visit [[the documentation page](http://rubydoc.info/github/bloc40/ibham/master/frames)]
+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/lib/generators/ibham/templates/migration.rb

@@ -1,11 +1,11 @@
 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
+      t.timestamps null: false
     end
 
     add_index :votes, [:voter_id, :voter_type]

data/lib/ibham/acts_as_voteable.rb

@@ -4,7 +4,8 @@ module Ibham
 
     module ClassMethods
 
-      # To turn an abject to a voteable, call <tt>acts_as_voteable</tt> in the Active Record model class.
+      # 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
@@ -20,33 +21,36 @@ 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.
+      # 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 => ALLOWED_VALUE).count
+        votes.where(value: ALLOWED_VALUE).count
       end
 
-      # To ruturn the count of negative votes, call <tt>down_votes</tt> on the voteable object.
+      # 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 => -ALLOWED_VALUE).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.
+      # 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 + 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.
+      # 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
@@ -60,18 +64,28 @@ module Ibham
         votes.map(&:voter)
       end
 
-      # To get the list of voters who casted positive votes, call <tt>up_voters</tt> on the voteable object.
+      # 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)
+        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.
+      # 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)
+        votes.where(value: -ALLOWED_VALUE).map(&:voter)
+      end
+
+      # To get the result of the votes, call <tt>vote_result</tt> on the
+      # voteable object.
+      #
+      # item.vote_result
+      def vote_result
+        votes.sum(:value)
       end
     end
   end

data/lib/ibham/acts_as_voter.rb

@@ -4,11 +4,10 @@ module Ibham
 
     module ClassMethods
 
-      # To turn an abject to a voter, call <tt>acts_as_voter</tt> in the Active Record model class.
+      # 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
+      #   class User < ActiveRecord::Base acts_as_voter end
       def acts_as_voter
         class_eval do
           include Voter
@@ -20,7 +19,7 @@ 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,
@@ -30,7 +29,7 @@ module Ibham
       #
       # This will return either true for false
       def can_vote_for?(voteable)
-        votes.build(:voteable => voteable, :value => ALLOWED_VALUE).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>
@@ -38,29 +37,21 @@ module Ibham
       #
       #   user.vote_up(item)
       #
-      # This will add a new record with a positive vote for this item by this user in the votes table.
+      # 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 => ALLOWED_VALUE)
+        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.
+      # 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.
+      # 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 => -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: -ALLOWED_VALUE)
       end
     end
   end

data/lib/ibham/version.rb

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

data/lib/models/vote.rb

@@ -2,11 +2,9 @@ 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 => [ALLOWED_VALUE, -ALLOWED_VALUE], :message => "should be either #{ALLOWED_VALUE} or -#{ALLOWED_VALUE}" }
+  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

@@ -5,23 +5,23 @@ describe Vote do
   let(:item) { Item.create! }
 
   describe 'Validations' do
-    it 'should be valid if the value is 1' do
-      vote = Vote.new(:value => 1)
+    it 'is valid if the value is 1' do
+      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)
+    it 'is valid if the value is -1' do
+      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)
+    it 'fails 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
+    it 'validates uniqueness of vote for voter and voteable' do
       user.vote_up(item)
       Vote.count.must_equal 1
       user.vote_up(item)

data/spec/modules/acts_as_voteable_spec.rb

@@ -15,55 +15,62 @@ describe 'ActsAsVoteable' do
   end
 
   describe '#up_votes' do
-    it 'should return the number of positive votes for voteable' do
+    it 'returns the number of positive votes for voteable' do
       item.up_votes.must_equal 2
     end
   end
 
   describe '#down_votes' do
-    it 'should return the number of negative votes for voteable' do
+    it 'returns the number of negative votes for voteable' do
       item.down_votes.must_equal 1
     end
   end
 
   describe '#up_percentage' do
-    it 'should return the percentage of positive votes' do
+    it 'returns the percentage of positive votes' do
       item.up_percentage.must_equal 67
     end
   end
 
   describe '#down_percentage' do
-    it 'should return the percentage of negative votes' do
+    it 'returns the percentage of negative votes' do
       item.down_percentage.must_equal 33
     end
 
-    it 'should return 100% if the item has 1 negative vote' do
+    it 'returns 100% if the item has 1 negative vote' do
       item2.down_percentage.must_equal 100
     end
 
-    it 'should return 0 if the item has 0 positive vote' do
+    it 'returns 0 if the item has 0 positive vote' do
       item2.up_percentage.must_equal 0
     end
   end
 
   describe '#voters' do
-    it 'should return the list of voters' do
+    it 'returns 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
+    it 'returns 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
+    it 'returns the list of users who casted negative votes' do
       item.down_voters.sort.must_equal [user2]
       item2.down_voters.must_equal [user1]
     end
   end
+
+  describe '#vote_result' do
+    it 'returns the result of the votes per item' do
+      item.vote_result.must_equal 1
+      item2.vote_result.must_equal -1
+    end
+  end
 end

data/spec/modules/acts_as_voter_spec.rb

@@ -5,18 +5,18 @@ describe 'ActsAsVoter' do
   let(:item) { Item.create! }
 
   describe '#can_vote_for?' do
-    it 'should return true if the voter can vote for an item' do
+    it 'returns true if the voter can vote for an item' do
       user.can_vote_for?(item).must_equal true
     end
 
-    it 'should return false if the voter can not vote for an item' do
+    it 'returns false if the voter can not vote for an item' do
       user.vote_down(item)
       user.can_vote_for?(item).must_equal false
     end
   end
 
   describe '#vote_up' do
-    it 'should create a positive vote' do
+    it 'creates a positive vote' do
       vote_count = Vote.count
       user.vote_up(item)
       Vote.count.must_equal vote_count + 1
@@ -25,27 +25,11 @@ describe 'ActsAsVoter' do
   end
 
   describe '#vote_down' do
-    it 'should create a positive vote' do
+    it 'creates a positive vote' do
       vote_count = Vote.count
       user.vote_down(item)
       Vote.count.must_equal vote_count + 1
       Vote.last.value.must_equal -1
     end
   end
-
-  describe '#cast_vote' do
-    it 'should create a positive vote' do
-      vote_count = Vote.count
-      vote = user.cast_vote(item, 1)
-      Vote.count.must_equal vote_count + 1
-      Vote.last.value.must_equal 1
-    end
-
-    it 'should create a negative vote' do
-      vote_count = Vote.count
-      vote = user.cast_vote(item, -1)
-      Vote.count.must_equal vote_count + 1
-      Vote.last.value.must_equal -1
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -3,11 +3,6 @@ require 'sqlite3'
 require 'ibham'
 require 'minitest/autorun'
 
-db_config = {
-  :adapter => 'sqlite3',
-  :database => ':memory:'
-}
-
 ActiveRecord::Migration.verbose = false
 
 class MiniTest::Spec
@@ -18,8 +13,8 @@ class MiniTest::Spec
   end
 
   config = {
-    :adapter => 'sqlite3',
-    :database => ':memory:'
+    adapter: 'sqlite3',
+    database: ':memory:'
   }
 
   ActiveRecord::Base.establish_connection(config)
@@ -29,11 +24,11 @@ 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
+    t.timestamps null: false
   end
 
   add_index :votes, [:voter_id, :voter_type]
@@ -41,12 +36,12 @@ ActiveRecord::Schema.define do
 
   create_table :users do |t|
     t.string :email
-    t.timestamps
+    t.timestamps null: false
   end
 
   create_table :items do |t|
     t.string :name
-    t.timestamps
+    t.timestamps null: false
   end
 end
 

metadata

@@ -1,49 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: ibham
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.1.3
 platform: ruby
 authors:
 - Jamal El Milahi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-10 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70249569608880 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70249569608880
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70249569608460 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70249569608460
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70249569608040 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70249569608040
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Voting System for Rails applications
 email:
 - jamal@elmilahi.com
@@ -51,8 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -72,27 +80,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/bloc40/ibham
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ibham is a gem that allows Rails apps to compute and display voting scores
   for active records models.
 test_files: