lessonplanet-acts_as_rateable 3.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Cosmin Radoi
+
+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,47 @@
+ActsAsRateable
+==============
+A Rails 3.2 ready gem that adds rateable functionality to models.
+
+## Install
+* ```gem 'lessonplanet-acts_as_rateable', :require => 'acts_as_rateable'```
+* Create a new rails migration and add the following self.up and self.down methods
+ 
+```ruby
+  def self.up
+    create_table "ratings", :force => true do |t|
+      t.column "rating", :integer, :default => 0
+      t.column "created_at", :datetime, :null => false
+      t.column "rateable_type", :string, :limit => 15, :default => "", :null => false
+      t.column "rateable_id", :integer, :default => 0, :null => false
+      t.column "user_id", :integer, :default => 0, :null => false
+    end
+  
+    add_index "ratings", ["user_id"]
+  end
+
+  def self.down
+    drop_table :ratings
+  end
+```
+ 
+## Usage
+
+Make you ActiveRecord model act as rateable:
+
+```ruby
+ class Model < ActiveRecord::Base
+ 	acts_as_rateable
+ end
+```
+ 
+Add a rating to a model instance:
+
+```ruby
+ object.rate_it 1, current_user
+```
+ 
+Get average rating:
+
+```ruby
+ Model.last.rating
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/acts_as_rateable.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_rateable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "lessonplanet-acts_as_rateable"
+  s.version     = ActsAsRateable::VERSION
+  s.authors     = ["Jason Rust"]
+  s.email       = ["jason@lessonplanet.com"]
+  s.homepage    = ""
+  s.summary     = %q{Rails plugin providing a rating interface for ActiveRecord models}
+  s.description = %q{Rails plugin providing a rating interface for ActiveRecord models}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/acts_as_rateable.rb

@@ -0,0 +1,14 @@
+require "active_record"
+require "active_record/version"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "acts_as_rateable/rateable.rb"
+require "acts_as_rateable/acts_as_rateable/core.rb"
+require "acts_as_rateable/rating.rb"
+
+$LOAD_PATH.shift
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend ActsAsRateable::Rateable
+end

data/lib/acts_as_rateable/acts_as_rateable/core.rb

@@ -0,0 +1,49 @@
+module ActsAsRateable::Rateable
+  module Core
+    def self.included(base)
+      base.send :include, ActsAsRateable::Rateable::Core::InstanceMethods
+      base.extend ActsAsRateable::Rateable::Core::ClassMethods
+    end
+
+    module ClassMethods
+      # Helper method to lookup for ratings for a given object.
+      # This method is equivalent to obj.ratings
+      def ratings_for(obj)
+        rateable = ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
+        scoped(
+          :conditions => { :rateable_id => obj.id, :rateable_type => rateable },
+          :order => 'created_at DESC'
+        )
+      end
+      
+      # Helper class method to lookup ratings for
+      # the mixin rateable type written by a given user.  
+      # This method is NOT equivalent to Rating.find_ratings_for_user
+      def ratings_by_user(user) 
+        rateable = ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
+        scoped(
+          :conditions => { :user_id => user.id, :rateable_type => rateable },
+          :order => 'created_at DESC'
+        )
+      end
+    end
+
+    module InstanceMethods
+      # Helper method that defaults the current time to the submitted field.
+      def rate_it(rating, user)
+        ratings.where(:user_id => user.id).delete_all if user.present?
+        ratings << ActsAsRateable::Rating.new(:rating => rating.to_i, :user_id => user.try(:id))
+      end
+      
+      # Helper method that returns the average rating
+      def rating
+        ratings.average(:rating).to_f
+      end
+      
+      # Check to see if a user already rated this rateable
+      def rated_by_user?(user)
+        ratings.where(:user_id => user.id).count > 0
+      end
+    end
+  end
+end

data/lib/acts_as_rateable/rateable.rb

@@ -0,0 +1,10 @@
+module ActsAsRateable
+  module Rateable
+    def acts_as_rateable(options = {})
+      class_eval do
+        has_many :ratings, :as => :rateable, :dependent => :destroy, :class_name => 'ActsAsRateable::Rating'
+        include ActsAsRateable::Rateable::Core
+      end
+    end
+  end
+end

data/lib/acts_as_rateable/rating.rb

@@ -0,0 +1,6 @@
+module ActsAsRateable
+  class Rating < ActiveRecord::Base
+    belongs_to :rateable, :polymorphic => true
+    belongs_to :user
+  end
+end

data/lib/acts_as_rateable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsRateable
+  VERSION = "3.0.0"
+end

data/lib/tasks/acts_as_rateable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :acts_as_rateable do
+#   # Task goes here
+# end

data/test/acts_as_rateable_test.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class ActsAsRateableTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: lessonplanet-acts_as_rateable
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jason Rust
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-29 00:00:00.000000000 Z
+dependencies: []
+description: Rails plugin providing a rating interface for ActiveRecord models
+email:
+- jason@lessonplanet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- acts_as_rateable.gemspec
+- lib/acts_as_rateable.rb
+- lib/acts_as_rateable/acts_as_rateable/core.rb
+- lib/acts_as_rateable/rateable.rb
+- lib/acts_as_rateable/rating.rb
+- lib/acts_as_rateable/version.rb
+- lib/tasks/acts_as_rateable_tasks.rake
+- test/acts_as_rateable_test.rb
+homepage: ''
+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: Rails plugin providing a rating interface for ActiveRecord models
+test_files:
+- test/acts_as_rateable_test.rb