ratyrate 1.2.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: afb9049229e09fc34ff2b76ce661361b05914316
+  data.tar.gz: 97b29e7fd7793f1355e76ebdb8480dc7b2b804c7
+SHA512:
+  metadata.gz: 137685240d3d6f07ec47aed48a9790ee7e8cbcd48133d6194fc1e416c0ebc8a717451ab8ecac41510c19b870db8c88d010533746e927d601ab3203b226d017e0
+  data.tar.gz: 5cd42119f1040208e7fb3c5b59ac926fc5712d03935d8fd8e794f808e09803778f0010c5480155af15de93984fe8e8dc1245e6f362daf9fd099ff8f2a2c7167a

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+/pkg/*
+

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "2.1.0"
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem 'jquery-rails', '>= 3.1.1'
+
+ruby '2.1.0'
+
+# Specify your gem's dependencies in ratyrate.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    ratyrate (1.0.9)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (4.1.4)
+      actionview (= 4.1.4)
+      activesupport (= 4.1.4)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.4)
+      activesupport (= 4.1.4)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activesupport (4.1.4)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    builder (3.2.2)
+    erubis (2.7.0)
+    i18n (0.6.11)
+    jquery-rails (3.1.1)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.1)
+    minitest (5.4.0)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.1.4)
+      actionpack (= 4.1.4)
+      activesupport (= 4.1.4)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jquery-rails (>= 3.1.1)
+  ratyrate!

data/README.md

@@ -0,0 +1,169 @@
+# RatyRate Stars Rating Gem [![endorse](http://api.coderwall.com/wazery/endorsecount.png)](http://coderwall.com/wazery)
+
+A Ruby Gem that wrap the functionality of [jQuery Raty](https://github.com/wbotelhos/raty) library, and provides optional IMDB style rating.
+
+[![Gem Version](https://badge.fury.io/rb/money-rails.png)](http://badge.fury.io/rb/money-rails)
+[![Build Status](https://travis-ci.org/wazery/ratyrate.svg)](http://travis-ci.org/wazery/ratyrate)
+[![Dependency Status](https://gemnasium.com/wazery/ratyrate.svg)](https://gemnasium.com/wazery/ratyrate)
+[![Code Climate](https://codeclimate.com/github/wazery/ratyrate.png)](https://codeclimate.com/github/wazery/ratyrate)
+[![License](http://img.shields.io/license/MIT.png?color=green)](http://opensource.org/licenses/MIT)
+[![Support jQuery Raty](http://img.shields.io/gittip/wbotelhos.svg)](https://www.gittip.com/wazery "Git Tip")
+
+## Repository
+
+This is a fork against the repository [muratguzel/ratyrate](https://github.com/muratguzel/ratyrate), the aim of this fork is to refresh the development in this Gem with a new scope and features, so please if you have any pull request issue it here, also I imported all the issues in the original repo.
+
+## Changelog from the main repository
+
+1. Exposed a lot of jQuery Raty plugin [features](http://wbotelhos.com/raty)
+  1. Added cancel button that can be customized and inserted to left or right
+  2. Added the ability to set custom star images for on, half or off state
+  3. Added the ability to set a custom path for the images
+  4. Added the ability to enable/disable half stars
+  5. Added the ability to turn on/off half star
+2. Their is a new option now to disable or enable the rating after the first rate
+3. Added a star style to show just the score of the dimension, but this star is not editable
+4. Added an overall average star just like IMDB style
+3. Nothing else
+4. :wq
+
+## TODO
+
+1. Write RSpec tests for this Gem
+2. Create a Heroku app to illustrate this Gem's purpose and features (MovieStore)
+3. Add option to show the number of users who gave rates
+4. Add a share helper to Facebook, Twitter
+
+## Detailed view of the new features
+
+![Detailed view of the new featurews](https://dl.dropboxusercontent.com/u/71605080/RatyRate%20Features.png)
+
+## Instructions
+
+### Install
+
+Add the ratyrate gem into your Gemfile
+
+```ruby
+gem 'ratyrate'
+```
+
+### Generate
+
+```
+rails g ratyrate User
+```
+
+The generator takes one argument which is the name of your existing devise user model UserModelName. This is necessary to bind the user and rating datas.
+Also the generator copies necessary files (jQuery Raty plugin files, star icons and JavaScript files)
+
+Example:
+
+Suppose you will have a devise user model which name is User. The devise generator and ratyrate generator should be like below
+
+```
+rails g devise:install
+rails g devise user
+
+rails g ratyrate user # => user is the model generated by devise
+```
+
+This generator will create Rate and RatingCache models and link to your user model.
+
+### Prepare
+
+I suppose you have a car model
+
+```
+rails g model car name:string
+```
+
+You should add the ratyrate_rateable function with its dimensions option. You can add multiple dimensions.
+
+```ruby
+class Car < ActiveRecord::Base
+  ratyrate_rateable "speed", "engine", "price"
+end
+```
+
+Then you need to add a call ratyrate_rater in the user model.
+
+```ruby
+class User < ActiveRecord::Base
+  ratyrate_rater
+end
+```
+
+### Using
+
+There is a helper method which name is rating_for to add the star links. By default rating_for will display the average rating and accept the
+new rating value from authenticated user.
+
+```erb
+<%# show.html.erb -> /cars/1 %>
+
+Speed  : <%= rating_for @car, "speed" %>
+Engine : <%= rating_for @car, "engine" %>
+Price  : <%= rating_for @car, "price" %>
+```
+
+### Available Options
+
+1- If you need to change the star number, you should use star option like below.
+```erb
+Speed : <%= rating_for @car, "speed", :star => 10 %>
+Speed : <%= rating_for @car, "engine", :star => 7 %>
+Speed : <%= rating_for @car, "price" %>
+```
+2- To enable half stars use the option *enable_half*
+```erb
+Speed : <%= rating_for @car, "speed", :enable_half => true %>
+```
+3- To show or hide the half stars use *half_show*
+```erb
+Speed : <%= rating_for @car, "speed", :half_show => true %>
+```
+4- To change the path in which the star images (star-on.png, star-off.png, star-half.png, ..etc) are located use
+```erb
+Speed : <%= rating_for @car, "speed", :star_path => true %>
+```
+
+To just change one of the star images choose from these options (star_on, star_off, star_half)
+
+5- To add the cancel button to the left, or right of the stars use **(default is false)**
+```erb
+Speed : <%= rating_for @car, "speed", :cancel => true %>
+```
+6- To change the place of the cancel button (left, or right) use **(default is left)**
+```erb
+Speed : <%= rating_for @car, "speed", :cancel_place => left %>
+```
+7- To change the hint on the cancel button use **(default is "Cancel current rating!" )**
+```erb
+Speed : <%= rating_for @car, "speed", :cancel_hint => "Cancel this rating!" %>
+```
+8- To change the image of the cancel on button use
+```erb
+Speed : <%= rating_for @car, "speed", :cancel_on => "cancel-on2.png" %>
+```
+9- To change the image of the cancel off use
+```erb
+  Speed : <%= rating_for @car, "speed", :cancel_off => "cancel-off2.png" %>
+```
+### Other Helpers
+
+You can use the *rating_for_user* helper method to show the star rating for the user.
+
+```erb
+Speed : <%= rating_for_user @car, current_user, "speed", :star => 10 %>
+```
+
+And you can use the *imdb_style_rating_for* to show a similar to IMDB rating style.
+
+```erb
+Speed : <%= imdb_style_rating_for @car, current_user %>
+```
+
+## Feedback
+If you find bugs please open a ticket at [https://github.com/wazery/ratyrate/issues](https://github.com/wazery/ratyrate/issues)
+

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+desc "Bundle the gem"
+task :bundle do
+  sh('bundle install')
+  sh 'gem build *.gemspec'
+  sh 'gem install *.gem'
+  sh 'rm *.gem'
+end
+
+task(:default).clear
+task :default => :bundle

data/lib/generators/ratyrate/ratyrate_generator.rb

@@ -0,0 +1,56 @@
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+class RatyrateGenerator < ActiveRecord::Generators::Base
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc "copying jquery.raty files to assets directory ..."
+  def copying
+    copy_file 'jquery.raty.js', 'app/assets/javascripts/jquery.raty.js'
+    copy_file 'star-on.png', 'app/assets/images/star-on.png'
+    copy_file 'star-off.png', 'app/assets/images/star-off.png'
+    copy_file 'star-half.png', 'app/assets/images/star-half.png'
+    copy_file 'mid-star.png', 'app/assets/images/mid-star.png'
+    copy_file 'big-star.png', 'app/assets/images/big-star.png'
+    copy_file 'cancel-on.png', 'app/assets/images/cancel-on.png'
+    copy_file 'cancel-off.png', 'app/assets/images/cancel-off.png'
+    copy_file 'ratyrate.js.erb', 'app/assets/javascripts/ratyrate.js.erb'
+    copy_file 'rater_controller.rb', 'app/controllers/rater_controller.rb'
+  end
+
+  desc "model is creating..."
+  def create_model
+    model_file = File.join('app/models', "#{file_path}.rb")
+    raise "User model (#{model_file}) must exits." unless File.exists?(model_file)
+    class_collisions 'Rate'
+    template 'model.rb', File.join('app/models', "rate.rb")
+    template 'cache_model.rb', File.join('app/models', "rating_cache.rb")
+    template 'average_cache_model.rb', File.join('app/models', "average_cache.rb")
+    template 'overall_average_model.rb', File.join('app/models', "overall_average.rb")
+  end
+
+  def add_rate_path_to_route
+    route "post '/rate' => 'rater#create', :as => 'rate'"
+  end
+
+  desc "cacheable rating average migration is creating ..."
+  def create_cacheable_migration
+    migration_template "cache_migration.rb", "db/migrate/create_rating_caches.rb"
+  end
+
+  desc "migration is creating ..."
+  def create_ratyrate_migration
+    migration_template "migration.rb", "db/migrate/create_rates.rb"
+  end
+
+  desc "average caches migration is creating ..."
+  def create_average_caches_migration
+    migration_template "average_cache_migration.rb", "db/migrate/create_average_caches.rb"
+  end
+
+  desc "overall averages migration is creating ..."
+  def create_overall_averages_migration
+    migration_template "overall_average_migration.rb", "db/migrate/create_overall_averages.rb"
+  end
+end

data/lib/generators/ratyrate/templates/average_cache_migration.rb

@@ -0,0 +1,17 @@
+class CreateAverageCaches < ActiveRecord::Migration
+
+  def self.up
+    create_table :average_caches do |t|
+      t.belongs_to :rater
+      t.belongs_to :rateable, :polymorphic => true
+      t.float :avg, :null => false
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :average_caches
+  end
+
+end
+

data/lib/generators/ratyrate/templates/average_cache_model.rb

@@ -0,0 +1,4 @@
+class AverageCache < ActiveRecord::Base
+  belongs_to :rater, :class_name => "<%= file_name.classify %>"
+  belongs_to :rateable, :polymorphic => true
+end

data/lib/generators/ratyrate/templates/cache_migration.rb

@@ -0,0 +1,19 @@
+class CreateRatingCaches < ActiveRecord::Migration
+
+  def self.up
+      create_table :rating_caches do |t|
+        t.belongs_to :cacheable, :polymorphic => true
+        t.float :avg, :null => false
+        t.integer :qty, :null => false
+        t.string :dimension
+        t.timestamps
+      end
+
+      add_index :rating_caches, [:cacheable_id, :cacheable_type]
+    end
+
+    def self.down
+      drop_table :rating_caches
+    end
+
+end

data/lib/generators/ratyrate/templates/cache_model.rb

@@ -0,0 +1,3 @@
+class RatingCache < ActiveRecord::Base
+  belongs_to :cacheable, :polymorphic => true
+end