rateable 0.0.7

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 rateable.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,83 @@
+= Rateable
+
+This is my own simple way to add ajax voting to a rails application.
+
+== Installation
+
+Add the Gem to your Gemfile
+ 
+  gem "glynx_rateable"
+
+Then install the Gem
+  
+  bundle install
+
+=== Generating Files
+
+After installing you should generate the needed files
+
+  rails generate rateable
+
+=== Migrating 
+
+Then apply the migration to your Database
+  
+  rake db:migrate
+
+=== Includes
+
+Add the "rateable.css" and "rateable.js" to the includes in your layout file
+
+== Usage
+
+=== Model 
+
+Add to the user model that should be able to rate things:
+
+  class User < ActiveRecord::Base
+    is_rater
+  end
+
+Add to the model that should be rateable
+  
+  class Model < ActiveRecord::Base
+    is_rateable
+  end
+
+=== Controller
+
+Add a rate action to the controller of the model that should be rateable, it should look like this:
+
+    def rate
+      # Check if the current user has already voted
+      if current_user and current_user.ratings.where(:rateable => @model).empty?
+        @model.rate(current_user, params[:stars])
+        render :partial => "rateable/rating", :locals => {:rating => @model.ratings.average("stars").to_i}                                                                    
+      else
+        render :text => "You have already voted for this item!", :status => 500                                                                                                                           
+      end
+    end
+
+=== Routes
+
+Add a post action called "rate" to the resource in your "config/routes.rb"
+  
+  resource :models do
+    member do 
+      post :rate
+    end
+  end
+
+=== Views
+
+In your Views you can add the rating stars by adding:
+
+  <%= rating_for @model %>
+
+You can also supply the url for the rate action manually, for example when using nested resources
+
+  <%= rating_for @model, :url => url_for([:rate, @category, @model])  %>
+
+If there is no current_user method you can also supply your current user like this:
+
+  <%= rating_for @model, :user => @user %>

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app/coffeescripts/rateable.coffee

@@ -0,0 +1,17 @@
+rate = (star) ->
+  url = star.data()["url"]
+  stars = star.data()["stars"]
+  $.ajax url,
+    type: "POST"
+    data: 
+      stars : stars
+    dataType: "html"
+    error: (resp) ->
+      window.reload()
+    success: (resp) ->
+      star.parent().replaceWith(resp)
+
+jQuery ->
+  $(".rating a").bind "click", (e) ->
+    rate $(this)
+    e.preventDefault()

data/app/views/rateable/_rate.erb

@@ -0,0 +1,7 @@
+<% url ||= [:rate, rateable] %>
+<% stars ||= 5 %>
+<div class="rating" style="width: <%= stars*32 %>px;">
+  <% stars.times do |i| %>
+    <a class="rate" href="#" data-stars="<%=i+1%>" data-url="<%= url %>" style="width:<%=(i+1)*32%>px; z-index: <%= stars - i%>;"></a>
+  <% end %>
+</div>

data/app/views/rateable/_rating.erb

@@ -0,0 +1,7 @@
+<% stars ||= 5 %>
+<% tooltip ||= nil %>
+<div class="rating" style="width: <%=stars*32%>px;" <%= "title='#{tooltip}'" if tooltip %> >
+  <% stars.times do |i| %>
+    <%= image_tag (i < rating ? "rateable/star_filled.png" : "rateable/star_unfilled.png"), :style => "margin-left: #{i*32}px; z-index: #{stars - i}" %>
+  <% end %>
+</div>

data/lib/generators/rateable/USAGE

@@ -0,0 +1 @@
+This generates all files nessesary for using the rateable gem, including the migration.

data/lib/generators/rateable/rateable_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators/migration'
+
+class RateableGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_files
+     copy_file "star_unfilled.png", "public/images/rateable/star_unfilled.png"
+     copy_file "star_filled.png", "public/images/rateable/star_filled.png"
+     copy_file "rateable.js", "public/javascripts/rateable.js"
+     copy_file "rateable.css", "public/stylesheets/rateable.css"
+     migration_template "migration.rb", "db/migrate/rateable_migration"
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+class RateableMigration < ActiveRecord::Migration
+  def self.up
+    create_table :rates do |t|
+      t.integer 'rateable_id'
+      t.string 'rateable_type'
+      t.integer 'rater_id'
+      t.string 'rater_type'
+      t.integer 'stars'
+    end
+  end
+
+  def self.down
+    drop_table :rates
+  end
+end

data/lib/generators/rateable/templates/rateable.css

@@ -0,0 +1,22 @@
+.rating {
+  position: relative;
+  height: 32px;
+  background: url(/images/rateable/star_unfilled.png) top left repeat-x;
+}
+
+.rating a {
+    position: absolute;
+    height: 32px;
+    text-decoration: none;
+}
+
+.rating img {
+    position: absolute;
+    width: 32px;
+    text-decoration: none;
+}
+   
+
+.rating .rate:hover {
+    background: url(/images/rateable/star_filled.png) bottom left repeat-x;
+}

data/lib/generators/rateable/templates/rateable.js

@@ -0,0 +1,29 @@
+/* DO NOT MODIFY. This file was compiled Fri, 05 Aug 2011 22:17:18 GMT from
+ * /home/andre/Dokumente/yvi/comics/app/coffeescripts/rateable.coffee
+ */
+
+var rate;
+rate = function(star) {
+  var stars, url;
+  url = star.data()["url"];
+  stars = star.data()["stars"];
+  return $.ajax(url, {
+    type: "POST",
+    data: {
+      stars: stars
+    },
+    dataType: "html",
+    error: function(resp) {
+      return window.reload();
+    },
+    success: function(resp) {
+      return star.parent().replaceWith(resp);
+    }
+  });
+};
+jQuery(function() {
+  return $(".rating a").bind("click", function(e) {
+    rate($(this));
+    return e.preventDefault();
+  });
+});

data/lib/rateable/helper.rb

@@ -0,0 +1,14 @@
+module Rateable
+  module Helper
+    def rating_for(rateable, args = {})
+      user = args[:user] || try(:current_user)
+      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]}
+      else
+        stars_average = rateable.ratings.average("stars")
+        ratings_count = rateable.ratings.count
+        render :partial => "rateable/rating", :locals => {:stars => args[:stars], :rating => stars_average.to_i, :tooltip => "#{ratings_count} #{ratings_count == 1 ? "time" : "times"} rated, with an average value of #{stars_average}."}
+      end
+    end
+  end
+end

data/lib/rateable/is_rateable.rb

@@ -0,0 +1,33 @@
+module Rateable
+  module IsRateable
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def is_rateable
+        has_many :ratings, :as => :rateable, :class_name => "Rateable::Rate", :dependent => :destroy
+        include Rateable::IsRateable::InstanceMethods
+      end
+
+      def is_rateable?
+        true
+      end
+    end
+
+    module InstanceMethods
+      def is_rateable?
+        true
+      end
+
+      # include instance methods that are needed
+      def rate(user,stars)
+        rating = Rate.where(:rateable => self, :rater => user).first
+        rating = Rate.create(:rateable => self, :rater => user) unless rating
+        rating.stars = stars
+        rating.save
+      end
+    end
+  end
+end
+

data/lib/rateable/rate.rb

@@ -0,0 +1,10 @@
+module Rateable
+  class Rate < ActiveRecord::Base
+    belongs_to :rateable, :polymorphic => true
+    belongs_to :rater, :polymorphic => true
+
+    validates_presence_of :rateable
+    validates_presence_of :rater
+    validates_inclusion_of :stars, :in => (1..5).to_a
+  end
+end

data/lib/rateable/rater.rb

@@ -0,0 +1,32 @@
+module Rateable
+  module Rater
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def is_rater
+        has_many :ratings, :as => :rater, :class_name => "Rateable::Rate", :dependent => :destroy
+        include Rateable::Rater::InstanceMethods
+      end
+
+      def is_rater? 
+        true
+      end
+    end
+
+    module InstanceMethods
+      def is_rater?
+        true
+      end
+
+      def rate(obj,stars)
+        if obj.is_rateable?
+          obj.rate(self,stars)
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/rateable/version.rb

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

data/lib/rateable.rb

@@ -0,0 +1,21 @@
+require "active_record"
+require "action_view"
+require "action_controller"
+
+require 'rateable/is_rateable'
+require 'rateable/rater'
+require 'rateable/rate'
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send :include, Rateable::IsRateable
+  ActiveRecord::Base.send :include, Rateable::Rater
+end
+
+if defined?(ActionView::Base)
+  require 'rateable/helper'
+  ActionView::Base.send :include, Rateable::Helper
+end
+
+if defined?(ActionController::Base)
+  ActionController::Base.prepend_view_path File.dirname(__FILE__) + "/../app/views"
+end

data/rateable.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rateable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rateable"
+  s.version     = Rateable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["André Domnick"]
+  s.email       = ["andre@paniccrew.de"]
+  s.homepage    = ""
+  s.summary     = %q{Add a stars rating to your models}
+  s.description = %q{A way for simply adding an ajax rating to any of your models}
+
+  s.add_runtime_dependency 'rails', ">= 3.0.0"
+  s.add_runtime_dependency 'activerecord', ">= 3.0.0"
+
+  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

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: rateable
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 7
+  version: 0.0.7
+platform: ruby
+authors: 
+- "Andr\xC3\xA9 Domnick"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+description: A way for simply adding an ajax rating to any of your models
+email: 
+- andre@paniccrew.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- app/coffeescripts/rateable.coffee
+- app/views/rateable/_rate.erb
+- app/views/rateable/_rating.erb
+- lib/generators/rateable/USAGE
+- lib/generators/rateable/rateable_generator.rb
+- lib/generators/rateable/templates/migration.rb
+- lib/generators/rateable/templates/rateable.css
+- lib/generators/rateable/templates/rateable.js
+- lib/generators/rateable/templates/star_filled.png
+- lib/generators/rateable/templates/star_unfilled.png
+- lib/rateable.rb
+- lib/rateable/helper.rb
+- lib/rateable/is_rateable.rb
+- lib/rateable/rate.rb
+- lib/rateable/rater.rb
+- lib/rateable/version.rb
+- rateable.gemspec
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: Add a stars rating to your models
+test_files: []
+