fix: Migrate to Rails 5.2

.travis.yml

@@ -1,9 +1,5 @@
 language: ruby
 rvm:
-  - "1.9.2"
-  - "1.9.3"
-  - "2.0.0"
-  - rbx-18mode
-  - rbx-19mode
+  - "2.2.2"
 # uncomment this line if your project needs to run something other than `rake`:
-# script: bundle exec rspec spec
+# script: bundle exec rspec spec

Gemfile

@@ -1,6 +1,10 @@
 source "http://rubygems.org"
 
-gem 'jquery-rails'
+gem 'jquery-rails', '~> 4.3', '>= 4.3.1'
+
+ruby '2.2.2'
+
+# gem 'rspec'
 
 # Specify your gem's dependencies in letsrate.gemspec
 gemspec

Gemfile.lock

@@ -1,49 +1,75 @@
 PATH
   remote: .
   specs:
-    letsrate (1.0.9)
+    ratyrate (1.2.2.alpha)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionpack (4.0.2)
-      activesupport (= 4.0.2)
-      builder (~> 3.1.0)
-      erubis (~> 2.7.0)
-      rack (~> 1.5.2)
-      rack-test (~> 0.6.2)
-    activesupport (4.0.2)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
-      thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    atomic (1.1.14)
-    builder (3.1.4)
-    erubis (2.7.0)
-    i18n (0.6.9)
-    jquery-rails (3.0.4)
-      railties (>= 3.0, < 5.0)
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.2)
+    erubi (1.6.1)
+    i18n (0.8.6)
+    jquery-rails (4.3.1)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
       thor (>= 0.14, < 2.0)
-    minitest (4.7.5)
-    multi_json (1.8.2)
-    rack (1.5.2)
-    rack-test (0.6.2)
-      rack (>= 1.0)
-    railties (4.0.2)
-      actionpack (= 4.0.2)
-      activesupport (= 4.0.2)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    minitest (5.10.3)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.3)
+    rack-test (0.7.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.4)
+      actionpack (= 5.1.4)
+      activesupport (= 5.1.4)
+      method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.1.1)
-    thor (0.18.1)
-    thread_safe (0.1.3)
-      atomic
-    tzinfo (0.3.38)
+    rake (12.1.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  jquery-rails
-  letsrate!
+  jquery-rails (~> 4.3, >= 4.3.1)
+  ratyrate!
+
+RUBY VERSION
+   ruby 2.2.2p95
+
+BUNDLED WITH
+   1.15.4

README.md

@@ -1,46 +1,97 @@
-# Letsrate Rating Gem
+# RatyRate Stars Rating Gem
 
-Provides the best way to add rating capabilites to your Rails application with jQuery Raty plugin.
+A Ruby Gem that wrap the functionality of [jQuery Raty](https://github.com/wbotelhos/raty) library, and provides optional IMDB style rating.
 
-[![Build Status](https://secure.travis-ci.org/muratguzel/letsrate.png)](http://travis-ci.org/muratguzel/letsrate)
-[![Dependency Status](https://gemnasium.com/muratguzel/letsrate.png)](https://gemnasium.com/muratguzel/letsrate)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/muratguzel/letsrate)
+[![Gem Version](https://badge.fury.io/rb/ratyrate.svg)](http://badge.fury.io/rb/ratyrate)
+[![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")
+[![Stories in Ready](https://badge.waffle.io/wazery/ratyrate.png?label=ready&title=Ready)](https://waffle.io/wazery/ratyrate)
+[![Code Triagers Badge](https://www.codetriage.com/wazery/ratyrate/badges/users.svg)](https://www.codetriage.com/wazery/ratyrate)
 
 ## Repository
 
-Find it at [github.com/muratguzel/letsrate](https://github.com/muratguzel/letsrate)
+This is a fork against the repository [muratguzel/letsrate](https://github.com/muratguzel/letsrate), 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
+5. Created a Heroku app to illustrate this Gem's purpose and features (MovieStore)
+6. [Wrote a complete tutorial on SitePoint that illustrates how to use this gem](http://www.sitepoint.com/ratyrate-add-rating-rails-app/)
+3. Nothing else
+4. :wq
+
+## TODO
+
+1. Write RSpec tests for this Gem
+3. Add option to show the number of users who gave rates
+4. Add a share helper to Facebook, Twitter
+5. Force refresh after rating when ***disable_after_rate*** and ***imdb_avg*** options is set to true.
+
+## Detailed view of the new features
+
+![Detailed view of the new featurews](http://i.imgur.com/m6n25ZF.png)
+
+## Complete tutorial for this Gem on SitePoint - Ruby
+
+I wrote a complete tutorial on SitePoint to cover this Gem's features in detail, if you are concerned to learn more about it just pay a visit to this [link](http://www.sitepoint.com/ratyrate-add-rating-rails-app/).
 
 ## Instructions
 
 ### Install
 
-Add the letsrate gem into your Gemfile
+Add the ratyrate gem into your Gemfile
 
 ```ruby
-gem 'letsrate'
+gem 'ratyrate'
 ```
 
 ### Generate
 
 ```
-rails g letsrate User
+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 javascripts)
+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 letsrate generator should be like below
+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 letsrate user # => user is the model generated by devise
+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.
+This generator will create Rate and RatingCache models,
+db/migrations, 
+and link to your user model.
+
+### Database Migration
+
+Run the migrations:
+```
+rake db:migrate
+```
+
+### Javascript include
+```
+//= require jquery.raty
+//= require ratyrate
+```
 
 ### Prepare
 
@@ -50,19 +101,19 @@ I suppose you have a car model
 rails g model car name:string
 ```
 
-You should add the letsrate_rateable function with its dimensions option. You can add multiple dimensions.
+You should add the ratyrate_rateable function with its dimensions option. You can add multiple dimensions.
 
 ```ruby
 class Car < ActiveRecord::Base
-  letsrate_rateable "speed", "engine", "price"
+  ratyrate_rateable "speed", "engine", "price"
 end
 ```
 
-Then you need to add a call letsrate_rater in the user model.
+Then you need to add a call ratyrate_rater in the user model.
 
 ```ruby
 class User < ActiveRecord::Base
-  letsrate_rater
+  ratyrate_rater
 end
 ```
 
@@ -74,25 +125,85 @@ 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" %>
+Speed  : <%= rating_for @car, 'speed' %>
+Engine : <%= rating_for @car, 'engine' %>
+Price  : <%= rating_for @car, 'price' %>
 ```
 
-If you need to change the star number, you should use star option like below.
+### 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" %>
+Speed  : <%= rating_for @car, 'speed', star: 10 %>
+Engine : <%= rating_for @car, 'engine', star: 7 %>
+Price  : <%= rating_for @car, 'price' %>
 ```
+2- If you want to disable/enable the rating after user's first rate use the new option *disable_after_rate*
+```erb
+Speed : <%= rating_for @car, 'speed', disable_after_rate: true %>
+```
+To enable changes after first user rate set ```disable_after_rate``` to false
 
-You can use the rating_for_user helper method to show the star rating for the user.
+3- To enable half stars use the option *enable_half*
+```erb
+Speed : <%= rating_for @car, 'speed', enable_half: true %>
+```
+4- To show or hide the half stars use *half_show*
+```erb
+Speed : <%= rating_for @car, 'speed', half_show: true %>
+```
+5- 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)
+
+6- 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 %>
+```
+7- To change the place of the cancel button (left, or right) use **(default is left)**
+```erb
+Speed : <%= rating_for @car, 'speed', cancel_place: left %>
+```
+8- 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!' %>
+```
+9- To change the image of the cancel on button use
+```erb
+Speed : <%= rating_for @car, 'speed', cancel_on: 'cancel-on2.png' %>
+```
+10- 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 : <%= rating_for_user @car, current_user, "speed", :star => 10 %>
+Speed : <%= imdb_style_rating_for @car, current_user %>
 ```
 
+## Semantic Versioning
+
+Ratyrate attempts to follow semantic versioning in the format of `x.y.z`, where:
+
+`x` stands for a major version (new features that are not backward-compatible).
+
+`y` stands for a minor version (new features that are backward-compatible).
+
+`z` stands for a patch (bug fixes).
+
+In other words: `Major.Minor.Patch`.
 
 ## Feedback
-If you find bugs please open a ticket at [https://github.com/muratguzel/letsrate/issues](https://github.com/muratguzel/letsrate/issues)
+If you find bugs please open a ticket at [https://github.com/wazery/ratyrate/issues](https://github.com/wazery/ratyrate/issues)