ibham 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ibham.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jamal El Milahi
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Ibham
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ibham'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ibham
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :rspec
+
+RSpec::Core::RakeTask.new(:rspec) do |test|
+  test.rspec_opts = ['--color']
+  test.pattern = './spec/**/*_spec.rb'
+end

data/ibham.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ibham/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'ibham'
+  gem.version       = Ibham::VERSION
+  gem.authors       = ['Jamal El Milahi']
+  gem.email         = ['jamal@elmilahi.com']
+  gem.description   = %q{Voting System for Rails applications}
+  gem.summary       = %q{Ibham is a gem that allows Rails apps to compute and display voting scores for active records models.}
+  gem.homepage      = 'https://github.com/bloc40/ibham'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'activerecord'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'database_cleaner'
+  gem.add_development_dependency 'sqlite3'
+end

data/lib/generators/ibham/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module Ibham
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+    def self.next_migration_number(path)
+      ActiveRecord::Generators::Base.next_migration_number(path)
+    end
+
+    desc 'Create migration file required by ibham gem.'
+    def create_migration_file
+      unless self.class.migration_exists?(File.dirname(File.expand_path('db/migrate/ibham_create_votes')), 'ibham_create_votes')
+        migration_template 'migration.rb', 'db/migrate/ibham_create_votes.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+class IbhamCreateVotes < ActiveRecord::Migration
+  def change
+    create_table :votes do |t|
+      t.references :voter, polymorphic: true
+      t.references :voteable, polymorphic: true
+      t.integer :value
+
+      t.timestamps
+    end
+
+    add_index :votes, [:voter_id, :voter_type]
+    add_index :votes, [:voteable_id, :voteable_type]
+  end
+end

data/lib/ibham/acts_as_voteable.rb

@@ -0,0 +1,37 @@
+module Ibham
+  module ActsAsVoteable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def acts_as_voteable
+        class_eval do
+          include Voteable
+        end
+      end
+    end
+
+    module Voteable
+      extend ActiveSupport::Concern
+
+      included do
+        has_many :votes, as: :voteable, dependent: :destroy
+      end
+
+      def up_votes
+        votes.where(value: 1).count
+      end
+
+      def down_votes
+        votes.where(value: -1).count
+      end
+
+      def up_percentage
+        up_votes * 100 / votes.count.to_f
+      end
+
+      def down_percentage
+        100 - up_percentage
+      end
+    end
+  end
+end

data/lib/ibham/acts_as_voter.rb

@@ -0,0 +1,37 @@
+module Ibham
+  module ActsAsVoter
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def acts_as_voter
+        class_eval do
+          include Voter
+        end
+      end
+    end
+
+    module Voter
+      extend ActiveSupport::Concern
+
+      included do
+        has_many :votes, as: :voter, dependent: :destroy
+      end
+
+      def can_vote_for?(voteable)
+        votes.build(voteable: voteable, value: 1).valid?
+      end
+
+      def vote_up(voteable)
+        votes.create(voteable: voteable, value: 1)
+      end
+
+      def vote_down(voteable)
+        votes.create(voteable: voteable, value: -1)
+      end
+
+      def cast_vote(voteable, value)
+        votes.build(voteable: voteable, value: value)
+      end
+    end
+  end
+end

data/lib/ibham/version.rb

@@ -0,0 +1,3 @@
+module Ibham
+  VERSION = '0.1.0'
+end

data/lib/ibham.rb

@@ -0,0 +1,13 @@
+require 'ibham/version'
+require 'ibham/acts_as_voter'
+require 'ibham/acts_as_voteable'
+require 'models/vote'
+
+module Ibham
+  # Your code goes here...
+end
+
+ActiveRecord::Base.class_eval do
+  include Ibham::ActsAsVoter
+  include Ibham::ActsAsVoteable
+end

data/lib/models/vote.rb

@@ -0,0 +1,9 @@
+class Vote < ActiveRecord::Base
+  attr_accessible :value, :voteable
+
+  belongs_to :voteable, polymorphic: true
+  belongs_to :voter, polymorphic: true
+
+  validates_uniqueness_of :voteable_id, scope: :voter_id
+  validates :value, inclusion: { in: [1, -1] }
+end

data/spec/models/vote_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Vote do
+  let(:user) { User.create!(email: 'foo@example.com') }
+  let(:item) { Item.create!(name: 'item') }
+
+  describe 'Validations' do
+    it 'should be valid if the value is 1' do
+      vote = Vote.new(value: 1)
+      vote.should be_valid
+    end
+
+    it 'should be valid if the value is -1' do
+      vote = Vote.new(value: -1)
+      vote.should be_valid
+    end
+
+    it 'should fail if the value is other than 1 or -1' do
+      vote = Vote.new(value: 2)
+      vote.should_not be_valid
+    end
+
+    it 'should validate uniqueness of vote for voter and voteable' do
+      user.vote_up(item)
+      expect {
+        user.vote_up(item)
+      }.to change(Vote, :count).by(0)
+    end
+  end
+end

data/spec/modules/acts_as_voteable_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe 'ActsAsVoteable' do
+  let(:user1) { User.create! }
+  let(:user2) { User.create! }
+  let(:user3) { User.create! }
+  let(:item)  { Item.create! }
+  let(:item2) { Item.create! }
+
+  before do
+    user1.vote_up(item)
+    user2.vote_down(item)
+    user3.vote_up(item)
+    user1.vote_down(item2)
+  end
+
+  describe '#up_votes' do
+    it 'should return the number of positive votes for voteable' do
+      item.up_votes.should == 2
+    end
+  end
+
+  describe '#down_votes' do
+    it 'should return the number of negative votes for voteable' do
+      item.down_votes.should == 1
+    end
+  end
+
+  describe '#up_percentage' do
+    it 'should return the percentage of positive votes' do
+      item.up_percentage.should be_within(0.1).of(66.6)
+    end
+  end
+
+  describe '#down_percentage' do
+    it 'should return the percentage of negative votes' do
+      item.down_percentage.should be_within(0.1).of(33.3)
+    end
+
+    it 'should return 100% if the item has 1 negative vote' do
+      item2.down_percentage.should == 100
+    end
+
+    it 'should return 0 if the item has 0 positive vote' do
+      item2.up_percentage.should == 0
+    end
+  end
+end

data/spec/modules/acts_as_voter_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe 'ActsAsVoter' do
+  let(:user) { User.create!(email: 'foo@example.com') }
+  let(:item) { Item.create!(name: 'item') }
+
+  describe '#can_vote_for?' do
+    it 'should return true if the voter can vote for an item' do
+      user.can_vote_for?(item).should be_true
+    end
+
+    it 'should return false if the voter can not vote for an item' do
+      user.vote_down(item)
+      user.can_vote_for?(item).should be_false
+    end
+  end
+
+  describe '#vote_up' do
+    it 'should create a positive vote' do
+      expect { user.vote_up(item) }.to change { Vote.count }.by(1)
+      Vote.last.value.should == 1
+    end
+  end
+
+  describe '#vote_down' do
+    it 'should create a positive vote' do
+      expect { user.vote_down(item) }.to change { Vote.count }.by(1)
+      Vote.last.value.should == -1
+    end
+  end
+
+  describe '#cast_vote' do
+    it 'should create a positive vote' do
+      Vote.count.should == 0
+      expect do
+        vote = user.cast_vote(item, 1)
+        vote.save
+      end.to change { Vote.count }.by(1)
+      Vote.last.value.should == 1
+    end
+
+    it 'should create a negative vote' do
+      Vote.count.should == 0
+      expect do
+        vote = user.cast_vote(item, -1)
+        vote.save
+      end.to change { Vote.count }.by(1)
+      Vote.last.value.should == -1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,51 @@
+require 'active_record'
+require 'database_cleaner'
+require 'sqlite3'
+require 'ibham'
+
+db_config = {
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+}
+
+ActiveRecord::Base.establish_connection(db_config)
+
+ActiveRecord::Migration.verbose = false
+
+RSpec.configure do |config|
+  config.before(:each) { DatabaseCleaner.start }
+  config.after(:each) { DatabaseCleaner.clean }
+end
+
+ActiveRecord::Schema.define do
+  create_table :votes do |t|
+    t.references :voter, polymorphic: true
+    t.references :voteable, polymorphic: true
+    t.integer :value
+
+    t.timestamps
+  end
+
+  add_index :votes, [:voter_id, :voter_type]
+  add_index :votes, [:voteable_id, :voteable_type]
+
+  create_table :users do |t|
+    t.string :email
+    t.timestamps
+  end
+
+  create_table :items do |t|
+    t.string :name
+    t.timestamps
+  end
+end
+
+class User < ActiveRecord::Base
+  has_many :items
+  acts_as_voter
+end
+
+class Item < ActiveRecord::Base
+  belongs_to :user
+  acts_as_voteable
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: ibham
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jamal El Milahi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70263820298980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70263820298980
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70263820298200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70263820298200
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70263820313380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70263820313380
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &70263820312720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70263820312720
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70263820312040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70263820312040
+description: Voting System for Rails applications
+email:
+- jamal@elmilahi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ibham.gemspec
+- lib/generators/ibham/install_generator.rb
+- lib/generators/ibham/templates/migration.rb
+- lib/ibham.rb
+- lib/ibham/acts_as_voteable.rb
+- lib/ibham/acts_as_voter.rb
+- lib/ibham/version.rb
+- lib/models/vote.rb
+- spec/models/vote_spec.rb
+- spec/modules/acts_as_voteable_spec.rb
+- spec/modules/acts_as_voter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bloc40/ibham
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Ibham is a gem that allows Rails apps to compute and display voting scores
+  for active records models.
+test_files:
+- spec/models/vote_spec.rb
+- spec/modules/acts_as_voteable_spec.rb
+- spec/modules/acts_as_voter_spec.rb
+- spec/spec_helper.rb