rateable 0.0.7 → 0.1.0

data/.gitignore

@@ -2,3 +2,6 @@
 .bundle
 Gemfile.lock
 pkg/*
+*.sw*
+coverage/
+*.gitkeep

data/Gemfile

@@ -2,3 +2,8 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in rateable.gemspec
 gemspec
+
+gem "meta_where"
+gem "launchy"
+gem "database_cleaner"
+gem "rcov"

data/README.rdoc

@@ -62,7 +62,7 @@ Add a rate action to the controller of the model that should be rateable, it sho
 
 Add a post action called "rate" to the resource in your "config/routes.rb"
   
-  resource :models do
+  resources :models do
     member do 
       post :rate
     end

data/Rakefile

@@ -1,2 +1,16 @@
 require 'bundler'
+require 'rubygems'
+require 'rspec/core/rake_task'
+
 Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--options', "spec/spec.opts"]
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new(:spec_rcov) do |t|
+  t.rspec_opts = ['--options', "spec/spec.opts"]
+  t.pattern = "spec/**/*_spec.rb"
+  t.rcov = true
+end

data/lib/rateable/helper.rb

@@ -1,9 +1,10 @@
 module Rateable
   module Helper
     def rating_for(rateable, args = {})
-      user = args[:user] || try(:current_user)
+      raise "The given model of class #{rateable.class} is not rateable" if rateable.nil? or not (rateable.respond_to?(:is_rateable?) and rateable.is_rateable?)
+      user = args[:user] || begin try(:current_user) rescue nil end
       if user and user.ratings.where(:rateable => rateable).empty?
-        render :partial => "rateable/rate", :locals => {:url => args[:url] ? args[:url] : url_for(rateable), :stars => args[:stars]}
+        render :partial => "rateable/rate", :locals => {:url => args[:url] ? args[:url] : url_for([:rate, rateable]), :stars => args[:stars]}
       else
         stars_average = rateable.ratings.average("stars")
         ratings_count = rateable.ratings.count

data/lib/rateable/is_rateable.rb

@@ -5,7 +5,9 @@ module Rateable
     end
 
     module ClassMethods
-      def is_rateable
+      def is_rateable(args = {})
+        raise ":stars must be an integer >= 1" if args[:stars] and not (args[:stars].is_a?(Integer) and args[:stars] >= 1)
+        @max_stars = args[:stars] || 5
         has_many :ratings, :as => :rateable, :class_name => "Rateable::Rate", :dependent => :destroy
         include Rateable::IsRateable::InstanceMethods
       end
@@ -13,6 +15,11 @@ module Rateable
       def is_rateable?
         true
       end
+      
+      def max_stars
+        @max_stars
+      end
+
     end
 
     module InstanceMethods
@@ -20,11 +27,19 @@ module Rateable
         true
       end
 
+      def max_stars
+        self.class.max_stars
+      end
+
       # include instance methods that are needed
       def rate(user,stars)
+        raise "#{user.inspect} is not a rater" unless user.respond_to?(:is_rater?) and user.is_rater?
         rating = Rate.where(:rateable => self, :rater => user).first
-        rating = Rate.create(:rateable => self, :rater => user) unless rating
-        rating.stars = stars
+        unless rating 
+          rating = Rate.create(:rateable => self, :rater => user, :stars => stars) 
+        else
+          rating.stars = stars
+        end
         rating.save
       end
     end

data/lib/rateable/rate.rb

@@ -5,6 +5,12 @@ module Rateable
 
     validates_presence_of :rateable
     validates_presence_of :rater
-    validates_inclusion_of :stars, :in => (1..5).to_a
+    validate :stars_must_be_in_range
+
+    def stars_must_be_in_range 
+      unless (1..rateable.max_stars).include? stars
+        errors.add :stars, "must be within 1 to #{rateable.max_stars}"
+      end
+    end
   end
 end

data/lib/rateable/rater.rb

@@ -21,7 +21,7 @@ module Rateable
       end
 
       def rate(obj,stars)
-        if obj.is_rateable?
+        if begin obj.is_rateable? rescue false end
           obj.rate(self,stars)
         else
           false

data/lib/rateable/version.rb

@@ -1,3 +1,3 @@
 module Rateable
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/rateable.gemspec

@@ -14,6 +14,12 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'rails', ">= 3.0.0"
   s.add_runtime_dependency 'activerecord', ">= 3.0.0"
+  s.add_runtime_dependency 'meta_where'
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "factory_girl_rails"
+  s.add_development_dependency "factory_girl"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/controllers/application_controller_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe ApplicationController do
+  let(:user){ Factory(:user) }
+
+  describe :login do
+    it "it saves the given user_id in the session" do
+      get :login, :user_id => user.id
+      session[:user_id].should == user.id
+    end
+
+    it "saves nil in the session if no id is given" do
+      get :login
+      session[:user_id].should == nil
+    end
+  end
+
+  describe :logout do
+    it "sets the user in the session to nil if user is logged in" do
+      session[:user_id] = user.id
+      get :logout
+      session[:user_id].should == nil
+    end
+
+    it "sets the user in the session to nil if no user logged in" do
+      get :logout
+      session[:user_id].should == nil
+    end
+  end
+
+  describe :current_user do
+    it "returns nil if session[:user_id] is nil and no user_id is given as param" do
+      session[:user_id] = nil
+      controller.current_user.should == nil
+    end
+
+    it "return user if session nil and user_id is given as param" do
+      session[:user_id] = nil
+      get :logout, :user_id => user.id
+      controller.current_user.should == user
+    end 
+
+    it "returns the User with session[:user_id] as it's id" do
+      session[:user_id] = user.id
+      controller.current_user.should == user
+    end
+  end
+end

data/spec/controllers/pictures_controller_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe PicturesController, "rating a picture" do
+
+  it "should rate the picture" do
+    picture = Factory(:picture)
+    user = Factory(:user)
+    post 'rate', :user_id => user.id, :id => picture.id, :stars => 1
+    ratings = user.reload.ratings
+    ratings.count.should == 1
+    ratings.first.rateable.should == picture
+    ratings.first.stars.should == 1
+    response.should be_success
+  end
+
+  it "is not possible unless logged in" do
+    picture = Factory(:picture)
+    post 'rate', :id => picture.id, :stars => 1
+    picture.ratings.count.should == 0
+    response.should_not be_success
+    response.body.should == "You are not allowed to vote for this item!"
+  end
+
+  it "is not possible if already voted" do
+    picture = Factory(:picture)
+    user = Factory(:user)
+    user.rate(picture, 1)
+    post 'rate', :id => picture.id, :user_id => user.id, :stars => 1
+    response.should_not be_success
+    picture.ratings.count.should == 1
+  end
+
+  it "is not possible to vote if no stars are given" do
+    picture = Factory(:picture)
+    user = Factory(:user)
+    post 'rate', :id => picture.id, :user_id => user.id
+    response.should_not be_success
+    picture.ratings.count.should == 0
+  end
+
+  it "should not be possible with to many stars" do
+    picture = Factory(:picture)
+    user = Factory(:user)
+    post 'rate', :id => picture.id, :user_id => user.id, :stars => picture.max_stars+1
+    response.should_not be_success
+    picture.ratings.count.should == 0
+  end
+
+  it "should not be possible with to less stars" do
+    picture = Factory(:picture)
+    user = Factory(:user)
+    post 'rate', :id => picture.id, :user_id => user.id, :stars => 0
+    response.should_not be_success
+    picture.ratings.count.should == 0
+  end
+
+end

data/spec/factories.rb

@@ -0,0 +1,8 @@
+require 'factory_girl'
+Factory.define :picture do |f|
+  f.sequence(:name) { |n| "Picture #{n}"}
+end
+
+Factory.define :user do |f|
+  f.sequence(:email) { |n| "#{n}@example.com" }
+end

data/spec/models/rateable_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Picture do
+
+  it "should have many ratings" do
+    Factory(:picture).should respond_to(:ratings)
+  end
+
+  describe :is_rateable? do
+    it "as instance method returns true" do
+      picture = Factory(:picture)
+      assert picture.is_rateable?
+    end
+
+    it "as class method returns true" do
+      assert Picture.is_rateable?
+    end
+  end
+
+  describe :rate do
+    let(:picture) { Factory(:picture) }
+    let(:user) { Factory(:user) }
+  
+    it "raises an exception if no valid rater is given" do
+      lambda{picture.rate(picture,1)}.should raise_error
+    end
+  
+    it "changes the rating of the given rater if already voted and stars are valid" do
+      rating = Rateable::Rate.create(:rateable => picture, :rater => user, :stars => 1)
+      picture.rate(user,2).should == true
+      rating.id.should == picture.ratings.last.id
+      picture.ratings.last.stars.should == 2
+    end
+
+    it "does not change the rating of the given rater if already voted and stars are not valid" do
+      Rateable::Rate.create(:rateable => picture, :rater => user, :stars => 1)
+      picture.rate(user,0).should == false
+      picture.ratings.last.stars.should == 1
+      picture.rate(user,100000).should == false
+      picture.ratings.last.stars.should == 1
+    end
+
+    it "creates a new rating if valid rater and stars are given and not already rated" do
+      user.ratings.empty?.should be_true
+      picture.rate(user,1).should be_true
+      rating = picture.ratings.last
+      rating.rater.should == user
+      rating.rateable.should == picture
+      rating.stars.should == 1
+    end
+
+    it "does not create a new rating if valid rater and invalid stars are given" do
+      picture.rate(user,0).should be_false
+      picture.ratings.last.should be_nil
+      picture.rate(user,10000).should be_false
+      picture.ratings.last.should be_nil
+    end
+  end
+
+  describe :max_stars do
+    it "returns the value of the class-method max_stars" do
+      Factory(:picture).max_stars.should == Picture.max_stars
+    end
+
+    it "returns an integer" do
+      Picture.max_stars.should be_an(Integer)
+      Picture.max_stars.should >= 1
+    end
+  end
+end

data/spec/models/rater_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe User do
+  describe :is_rater? do
+    it "as instance method returns true" do
+      user = Factory(:user) 
+      assert user.is_rater?
+    end
+
+    it "as class method returns true" do 
+      assert User.is_rater? 
+    end
+  end
+
+  describe :rate do
+    let(:user) { Factory(:user) }
+
+    it "should call Rateable.rate if object is rateable" do
+      picture = Factory(:picture)
+      picture.should_receive(:rate).with(user,1)
+      user.rate(picture,1)
+    end
+
+    it "returns false if the object does not respond to is_rateable?" do
+      user.rate(user,1).should == false
+    end
+
+    it "returns false if the object is nil" do
+      user.rate(nil,1).should == false
+    end
+  end
+end

data/spec/requests/pictures_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe "Pictures" do
+  it "shows the picture when visiting the show action" do
+    picture = Factory(:picture)
+    visit picture_path(picture)
+    page.should have_content(picture.name)
+  end
+
+  it "should not set current_user when no user_id is given" do
+    user = Factory(:user)
+    picture = Factory(:picture)
+    visit picture_path(picture)
+    User.all.each do |u|
+      page.should_not have_content(u.email)
+    end
+  end
+
+  it "should set current_user when a user_id is given" do
+    picture = Factory(:picture)
+    user = Factory(:user)
+    visit picture_path(picture, :user_id => user.id)
+    page.should have_content(user.email)
+  end
+
+  it "should show star images when not logged in" do
+    picture = Factory(:picture)
+    visit picture_path(picture)
+    page.should_not have_xpath('//div[@class="rating"]/a')
+    page.should have_xpath('//div[@class="rating"]/img')
+  end
+
+  it "should show a star links when logged in and not already voted" do
+    picture = Factory(:picture)
+    user = Factory(:user)
+    user.ratings.destroy_all
+    visit picture_path(picture, :user_id => user.id)
+    page.should have_xpath('//div[@class="rating"]/a[@class="rate"]')
+    page.should_not have_xpath('//div[@class="rating"]/img')
+  end
+
+  it "shows star images when logged in and already voted" do
+    picture = Factory(:picture)
+    user = Factory(:user)
+    user.rate(picture,1)
+    visit picture_path(picture, :user_id => user.id)
+    page.should_not have_xpath('//div[@class="rating"]/a[@class="rate"]')
+    page.should have_xpath('//div[@class="rating"]/img')
+  end
+
+  it "should be possible to vote", :js => true do
+    picture = Factory(:picture)
+    user = Factory(:user)
+    user.ratings.destroy_all
+    visit login_path(:user_id => user.id)
+    visit picture_path(picture)
+    page.should have_xpath('//div[@class="rating"]/a[@class="rate"]')
+    find(:xpath, '//div[@class="rating"]/a[@class="rate"][3]').click
+    page.should have_no_xpath('//div[@class="rating"]/a[@class="rate"]')
+    page.should have_xpath('//div[@class="rating"]/img[@alt="Star_filled"][1]')
+    page.should have_xpath('//div[@class="rating"]/img[@alt="Star_filled"][2]')
+    page.should have_xpath('//div[@class="rating"]/img[@alt="Star_filled"][3]')
+    page.should have_no_xpath('//div[@class="rating"]/img[@alt="Star_filled"][4]')
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format progress