is_reviewable 0.1.1

data/lib/is_reviewable/reviewer.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+
+module IsReviewable
+  module Reviewer
+    
+    DEFAULT_CLASS_NAME = begin
+      if defined?(Account)
+        :account
+      else
+        :user
+      end
+    rescue
+      :user
+    end
+    
+  end
+end

data/lib/is_reviewable/support.rb

@@ -0,0 +1,49 @@
+module IsReviewable
+  module Support
+    
+    extend self
+    
+    # Shortcut method for generating conditions hash for polymorphic belongs_to-associations.
+    #
+    def polymorphic_conditions_for(object_or_type, field, *match)
+      match = [:id, :type] if match.blank?
+      # Note: {} is equivalent to Hash.new which takes a block, so we must do: ({}) or (Hash.new)
+      returning({}) do |conditions|
+        conditions.merge!(:"#{field}_id" => object_or_type.id) if object_or_type.is_a?(::ActiveRecord::Base) && match.include?(:id)
+        
+        if match.include?(:type)
+          type = case object_or_type
+          when ::Class
+            object_or_type.name
+          when ::Symbol, ::String
+            object_or_type.to_s.singularize.classify
+          else # Object - or raise NameError as usual
+            object_or_type.class.name
+          end
+          
+          conditions.merge!(:"#{field}_type" => type)
+        end
+      end
+    end
+    
+    # Check if object is a valid activerecord object.
+    #
+    def is_active_record?(object)
+      object.present? && object.is_a?(::ActiveRecord::Base) # TODO: ::ActiveModel if Rails 3?
+    end
+    
+    # Check if input is a valid format of IP, i.e. "#.#.#.#". Note: Just basic validation.
+    #
+    def is_ip?(object)
+      (object =~ /^\d{1,3}.\d{1,3}.\d{1,3}.\d{1,3}$/) rescue false
+    end
+    
+    # Hash conditions to array conditions converter, 
+    # e.g. {:key => value} will be turned to: ['key = :key', {:key => value}]
+    #
+    def hash_conditions_as_array(conditions)
+      [conditions.keys.collect { |key| "#{key} = :#{key}" }.join(' AND '), conditions]
+    end
+    
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'is_reviewable'))

data/test/is_reviewable_test.rb

@@ -0,0 +1,234 @@
+# coding: utf-8
+require 'test_helper'
+
+class IsReviewableTest < Test::Unit::TestCase
+  
+  def setup
+    @review = ::Review.new
+    @user = ::User.create
+    @user_2 = ::User.create
+    @user_3 = ::User.create
+    @guest = ::Guest.create
+    @account = ::Account.create
+    @regular_post = ::Post.create
+    @reviewable_post = ::ReviewablePost.create
+    @reviewable_article = ::ReviewableArticle.create
+  end
+  
+  context "initialization" do
+    
+    should "extend ActiveRecord::Base" do
+      assert_respond_to ::ActiveRecord::Base, :is_reviewable
+      assert_respond_to ::ActiveRecord::Base, :is_reviewable?
+    end
+    
+    should "extend with instance methods only for reviewable models" do
+      public_instance_methods = [
+          [:is_reviewable?, :reviewable?],
+          [:rating_scale, :reviewable_scale],
+          [:rating_precision, :reviewable_precision],
+          :reviewed_at,
+          :average_rating,
+          :average_rating_by,
+          [:number_of_reviews, :total_reviews],
+          [:is_reviewed?, :reviewed?],
+          [:is_reviewed_by?, :reviewed_by?],
+          :review_by,
+          :review!,
+          :unreview!,
+          :reviews
+        ].flatten
+        
+      assert public_instance_methods.all? { |m| @reviewable_post.respond_to?(m.to_sym) }
+      assert !public_instance_methods.all? { |m| @regular_post.respond_to?(m) }
+    end
+    
+    should "be enabled only for specified models" do
+      assert @reviewable_post.reviewable?
+      assert @reviewable_article.reviewable?
+      assert !@regular_post.reviewable?
+    end
+    
+  end
+  
+  context "reviewable" do
+    
+    should "have many reviews" do
+      assert @reviewable_post.respond_to?(:reviews)
+      assert @reviewable_article.respond_to?(:reviews)
+      
+      @reviewable_post.review!(:reviewer => @user, :rating => 2.5)
+      @reviewable_post.review!(:reviewer => @user_2, :rating => 2.5)
+      
+      assert_equal 2, @reviewable_post.reviews.size
+    end
+    
+    should "have many reviewers" do
+      assert @reviewable_post.respond_to?(:reviewers)
+      assert @reviewable_article.respond_to?(:reviewers)
+      
+      @reviewable_post.review!(:reviewer => @user, :rating => 2.5)
+      @reviewable_post.review!(:reviewer => @user_2, :rating => 2.5)
+      @reviewable_post.review!(:reviewer => @user_3, :rating => 2.5)
+      
+      assert_equal 3, @reviewable_post.reviewers.size
+    end
+    
+    should "have no reviews from the beginning" do
+      assert_equal(@reviewable_post.reviews.size, 0)
+    end
+    
+    should "count reviews and ratings based on IP correctly" do
+      @reviewable_post.review!(:reviewer => '128.0.0.0', :rating => 1)
+      @reviewable_post.review!(:reviewer => '128.0.0.1', :rating => 2.5)
+      
+      assert_equal 2, @reviewable_post.total_reviews
+      assert_equal 1.75, @reviewable_post.average_rating # with precision set to 2
+      
+      # should not count as  new, but update values
+      @reviewable_post.review!(:reviewer => '128.0.0.1', :rating => 3)
+      
+      assert_equal 2, @reviewable_post.total_reviews
+      assert_equal 2.0, @reviewable_post.average_rating
+      
+      # should not count in the end
+      @reviewable_post.review!(:reviewer => '128.0.0.3', :rating => 1)
+      @reviewable_post.unreview!(:reviewer => '128.0.0.3', :rating => 1)
+      
+      assert_equal 2, @reviewable_post.total_reviews
+      assert_equal 2.0, @reviewable_post.average_rating
+    end
+    
+    should "not accept any reviews on IP if disabled" do
+      assert_raise ::IsReviewable::InvalidReviewerError do
+        @reviewable_article.review!(:reviewer => '128.0.0.0', :rating => 1)
+      end
+    end
+    
+    should "count reviews based on reviewer object (user/account) correctly" do
+      @reviewable_post.review!(:reviewer => @user, :rating => 1)
+      @reviewable_post.review!(:reviewer => @user_2, :rating => 2.5)
+      
+      assert_equal 2, @reviewable_post.total_reviews
+      assert_equal 1.75, @reviewable_post.average_rating # with precision set to 2
+      
+      # should not count as  new, but update values
+      @reviewable_post.review!(:reviewer => @user_2, :rating => 3)
+      
+      assert_equal 2, @reviewable_post.total_reviews
+      assert_equal 2.0, @reviewable_post.average_rating
+      
+      # should not count in the end
+      @reviewable_post.review!(:reviewer => @user_3, :rating => 1)
+      @reviewable_post.unreview!(:reviewer => @user_3, :rating => 1)
+      
+      assert_equal 2, @reviewable_post.total_reviews
+      assert_equal 2.0, @reviewable_post.average_rating
+    end
+    
+    should "count reviews based on both IP and reviewer object (user/account) correctly" do
+      @reviewable_post.review!(:reviewer => @user, :rating => 1)
+      @reviewable_post.review!(:reviewer => '128.0.0.2', :rating => 2.5)
+      
+      assert_equal 2, @reviewable_post.total_reviews
+      assert_equal 1.75, @reviewable_post.average_rating # with precision set to 2
+      
+      # should not count as new, but update values
+      @reviewable_post.review!(:reviewer => '128.0.0.2', :rating => 3)
+      
+      assert_equal 2, @reviewable_post.total_reviews
+      assert_equal 2.0, @reviewable_post.average_rating
+    end
+    
+    should "not count NULL-ratings, e.g. reviews skipping rating value" do
+      @reviewable_post.review!(:reviewer => @user, :rating => nil)
+      
+      assert_equal 1, @reviewable_post.total_reviews
+      assert_equal 0.0, @reviewable_post.average_rating
+    end
+    
+    should "not accept ratings out of rating scale range" do
+      assert_raise ::IsReviewable::InvalidReviewValueError do
+        @reviewable_post.review!(:reviewer => @user, :rating => 6)
+      end
+    end
+    
+    should "save review body" do
+      review_body = "Lorem ipsum dolor sit amet, consectetur adipisicing elit..."
+      
+      # just body
+      review_1 = @reviewable_post.review!(:reviewer => @user, :body => review_body)
+      assert_equal(review_body, review_1.body)
+      
+      # body + rating
+      review_2 = @reviewable_post.review!(:reviewer => @user_2, :rating => 4, :body => review_body)
+      assert_equal(review_body, review_2.body)
+    end
+    
+    should "save any additional non-reserved attribute values" do
+      review = @reviewable_post.review!(:reviewer => @user, :rating => 4, :title => "My title")
+      assert_equal "My title", review.title
+      
+      # don't allow update of reserved fields
+      review = @reviewable_post.review!(:reviewer => @user_2, :reviewable_id => 666)
+      assert_not_equal 666, review.reviewable_id
+    end
+  end
+  
+  context "reviewer" do
+    
+    should "have many reviews" do
+      assert @user.respond_to?(:reviews)
+      assert @account.respond_to?(:reviews)
+      assert !@guest.respond_to?(:reviews)
+      
+      ReviewablePost.create.review!(:reviewer => @user, :rating => 2.5)
+      ReviewablePost.create.review!(:reviewer => @user, :rating => 2.5)
+      
+      assert_equal 2, @user.reviews.size
+    end
+    
+    should "have many reviewables" do
+      assert @user.respond_to?(:reviewables)
+      assert @account.respond_to?(:reviewables)
+      assert !@guest.respond_to?(:reviewables)
+      
+      ReviewablePost.create.review!(:reviewer => @user, :rating => 2.5)
+      ReviewablePost.create.review!(:reviewer => @user, :rating => 2.5)
+      ReviewablePost.create.review!(:reviewer => @user, :rating => 2.5)
+      
+      assert_equal 3, @user.reviewables.size
+    end
+    
+  end
+  
+  context "review" do
+    
+    # TODO: Test named scopes á la:
+    #   * http://www.simonecarletti.com/blog/2009/06/how-to-test-rails-activerecord-named-scopes/
+    #   * http://blog.confabulus.com/2008/11/24/testing-named-scopes, or similar.
+    
+    should "define named scopes" do
+      named_scopes = [
+          :between_dates
+        ]
+      
+      # Example: Review.complete.proxy_options # => :conditions=>["rating IS NOT NULL AND body IS NOT NULL AND LENGTH(body) > 0"]}
+      
+      # Old: This won't work...
+      # assert named_scopes.all? { |named_scope| Review.respond_to?(named_scope, true) }
+      #assert named_scopes.all? { |named_scope| @reviewable_post.reviews.respond_to?(named_scope, true) }
+    end
+    
+    should "return reviews by creation date with named scope :in_order" do
+      @reviewable_post.review!(:reviewer => @user, :rating => 1)
+      @reviewable_post.review!(:reviewer => @user_2, :rating => 2)
+      
+      # Old: This won't work...
+      #assert_equal @user, @reviewable_post.reviews.in_order.first.reviewer
+      #assert_equal @user_2, @reviewable_post.reviews.in_order.last.reviewer
+    end
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,59 @@
+# coding: utf-8
+require 'rubygems'
+
+gem 'test-unit',            '= 1.2.3'
+gem 'thoughtbot-shoulda',   '>= 2.10.2'
+gem 'sqlite3-ruby',         '>= 1.2.0'
+gem 'nakajima-acts_as_fu',  '>= 0.0.5'
+
+# Optional dependency
+begin
+  require 'monkeyspecdoc'
+rescue LoadError
+  begin
+    gem 'jgre-monkeyspecdoc',   '>= 0.9.5'
+    require 'monkeyspecdoc'
+  rescue LoadError
+    # skip
+  end
+end
+
+require 'test/unit'
+require 'shoulda'
+require 'acts_as_fu'
+
+require 'test_helper'
+
+require 'is_reviewable'
+
+build_model :reviews do
+  references  :reviewable,    :polymorphic => true
+  
+  references  :reviewer,      :polymorphic => true
+  string      :ip,            :limit => 24
+  
+  float       :rating
+  text        :body
+  
+  string      :title
+  
+  timestamps
+end
+
+build_model :guests
+build_model :users
+build_model :accounts
+build_model :posts
+
+build_model :reviewable_posts do
+  is_reviewable :by => :users, :scale => 1.0..5.0, :step => 0.5, :average_precision => 2, :accept_ip => true
+end
+
+build_model :reviewable_articles do
+  is_reviewable :by => [:accounts, :users], :scale => [1,2,3], :accept_ip => false
+end
+
+build_model :cached_reviewable_posts do
+  integer :reviews_count
+  integer :average_rating
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: is_reviewable
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Jonas Grimfelt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-02 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: "Rails: Make an ActiveRecord resource ratable/reviewable (rate + text), without the usual extra code-smell."
+email: grimen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- generators/is_reviewable_migration/is_reviewable_migration_generator.rb
+- generators/is_reviewable_migration/templates/reviews_migration.rb
+- generators/is_reviewable_model/is_reviewable_model_generator.rb
+- generators/is_reviewable_model/templates/review_model.rb
+- lib/is_reviewable.rb
+- lib/is_reviewable/review.rb
+- lib/is_reviewable/reviewable.rb
+- lib/is_reviewable/reviewer.rb
+- lib/is_reviewable/support.rb
+- rails/init.rb
+- test/is_reviewable_test.rb
+- test/test_helper.rb
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- generators/is_reviewable_migration/is_reviewable_migration_generator.rb
+- generators/is_reviewable_migration/templates/reviews_migration.rb
+- generators/is_reviewable_model/is_reviewable_model_generator.rb
+- generators/is_reviewable_model/templates/review_model.rb
+- lib/is_reviewable.rb
+- lib/is_reviewable/review.rb
+- lib/is_reviewable/reviewable.rb
+- lib/is_reviewable/reviewer.rb
+- lib/is_reviewable/support.rb
+- rails/init.rb
+- test/is_reviewable_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/grimen/is_reviewable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "Rails: Make an ActiveRecord resource ratable/reviewable (rate + text), without the usual extra code-smell."
+test_files: 
+- test/is_reviewable_test.rb
+- test/test_helper.rb