seems_rateable 1.0.4 → 1.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWNkMTk4N2JjOTk5ZTkzMTNkZmVmNGNkMzg0NmYwYTZiNjBiNDExMQ==
+    OWYwNDQ2NGZmYmRjZTg0ZGIxNzA5ZWMzMjI2ZDA5OWE4ZWMxOTRhMw==
   data.tar.gz: !binary |-
-    YjdmZWZiMzFkMDc1ODI3ODgzNjQ3ZTA0MzlhMDhmMGIwMWVhNDcxNg==
+    NDRiN2U5NmVlMGM5YWM0MGM1ZGIxMTBjMGQ4ODQ3NTdiZmNjOGNhOA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NzM3ZDI4ZjdhZGU2M2I1NGQ3OWNiNDViYWZlYzRkN2U3NTIzZjM3ZDE0Yjc0
-    OGI2NDkyOWVlMTZmNzUxMjMwYjhjNGQ3MDYxNjI4Yjc3MDAzZTdkNWY2ZGRh
-    ZDQ1MzFmNWQwY2NjOGVhODU3NWI5NTA2MmM1NmE3ZjQyYTM5MzY=
+    Mjg0OWY5ZTFjYmM3OTNhN2E1YTVlOWQzYWEwOGIyMDk4YjRhM2Y4ZDQ5ZTI5
+    Y2IyZWI2NWQzNDAzOWE0Mzc2ZTc3Yjk0OWM4NDQzNTU0OGE3ZmJiM2Y3MjQ4
+    OGIxM2RjNjA0ZjY5MDRkMjkzMzk1NzBhNGEyNjhjNDlkM2VjMDc=
   data.tar.gz: !binary |-
-    MTQzYTUwYjNiOGFjYjY1MDc2NTU5ZDllNzVkMWNmN2FlZmM4ZjE0MzA0YTZk
-    ZjQzZjZlZGNiYjMzNGUzYzZkNTUyOWE5Y2I0MmUyMTkwYjQ3NDNkYmFlODE0
-    MTVjMzhiZWFiZWQzYTJkMjlhYTUxMGEyZTMyMzVlZDg3ODNhMGY=
+    MTViMzBjN2U5MWYxZmQxNWUwZjk1MjFiYTIwNDgyZWE3Y2U2MDExY2I2MDRm
+    NjgxZTM4ZTg4ZjNkY2EyNjE2NmNiNWRiYzc1YWFiZThiMTczZGViMTk4YjUy
+    ZDJkNjU4NjE0ZGE4MzlmZDE1Y2VmYzE0YTcwZjY1NjY1ZjVkMWI=

data/README.md

@@ -1,6 +1,6 @@
 # SeemsRateable
 
-Star rating gem for Rails application using jQuery plugin jRating
+Star rating gem for Rails application using jQuery plugin <a href="http://www.myjqueryplugins.com/jquery-plugin/jrating">jRating</a>
 
 ## Demo
 
@@ -26,11 +26,79 @@ Or install it yourself as:
 
     $ rails g seems_rateable User
     
-Generator takes one argument which is name of an existing user model e.g User, Client, Player ... <br>
-The generator creates necessary model, controller and asset files. It also creates route and migration files that are already migrated
+Generator takes one argument which is the name of an existing user model e.g User, Client, Player ... <br>
+The generator creates necessary model, controller and asset files. It also creates route and migration files that are already being migrated
 
-### 
+### Prepare
+    
+Include Javascript files adding these lines to application.js
+     
+     #application.js    
+     //= require rateable/jRating.jquery
+     //= require rateable/rateable.jquery
+     
+Include CSS file adding <code><%= seems_rateable_style %></code> to your layaut head tag
+
+Also make sure you have an existing <code>current_user</code> object. If not, add something like this to your application controller
+    
+    #application_controller.rb
+    helper_method :current_user
+    private
+    def current_user
+    	@current_user ||= User.find(session[:user_id]) if session[:user_id]
+    end 
+
+To prepare model be rateable add <code>seems_rateable</code> to your model file. You can also pass a hash of options to 
+customize the functionality
+
+<ul>
+<li><code>:dimensions</code> Array of dimensions e.g. <code>:dimensions => [:quality, :price, :performance]</code></li>
+<li><code>:allow_update</code> Allowing user to re-rate his own ratings, default set to false e.g <code>:allow_update=> true</code>
+</ul>
+
+    class Computer < ActiveRecord::Base
+        seems_rateable :dimensions => [:quality, :price, :performance], :allow_update => true
+    end
+
+Each object of the model now gain these methods :
+<ul>
+<li><code>@computer.rates_without_dimension</code> returns array of ratings given to the object</li>
+<li><code>@computer.raters_without_dimension</code> returns array of users that rated the object</li>
+<li><code>@computer.rate_average_without_dimension</code> returns cached database object containing average rate and quantity of given ratings of the object</li>
+</ul>
+
+Depending on the passed dimensions your object also gain these methods :
+
+<ul>
+<li><code>@computer.dimension_rates</code> e.g <code>@computer.quality_rates</code></li>
+<li><code>@computer.dimension_raters</code> e.g <code>@computer.price_raters</code></li>
+<li><code>@computer.dimension_average</code> e.g <code>@computer.performance_average</code></li>
+</ul>
+
+To track user's given ratings add <code>seems_rateable_rater</code> to your user model.
+Now you can access user's ratings by <code>@user.ratings_given</code>
+
+### Usage
+
+To display star rating use helper method <code>rating_for</code> in your view
+
+    #index.html.erb
+    
+    rating_for @computer
+    
+    rating_for @computer, :dimension => :price, :id => "storage"
+    
+    rating_for @computer, :static => true
+
+You can specify these options :
+<ul>
+<li><code>:dimension</code>The dimension of the object</li>
+<li><code>:static</code>Set to true to display static star rating, default false</li>
+<li><code>:id</code>ID of the div e.g <code>:id => "info"</code>, default nil</li>
+</ul>
 
+To edit the javascript options locate rateable.jquery.js file in /vendor/assets/javascripts/rateable/.
+The javascript options are explained directly in the file
 
 ## Contributing
 

data/lib/generators/seems_rateable_destroy_generator.rb

@@ -0,0 +1,19 @@
+require 'fileutils'
+class SeemsRateableDestroyGenerator < Rails::Generators::Base
+
+  def remove_asset_files    
+    FileUtils.remove_dir('vendor/assets/stylesheets/rateable')
+    FileUtils.remove_dir('vendor/assets/javascripts/rateable')
+    FileUtils.remove_dir('vendor/assets/images/rateable')
+  end
+  
+  def remove_model_files
+    FileUtils.rm('app/models/rate.rb')
+    FileUtils.rm('app/models/cached_rating.rb')
+  end
+  
+   def remove_controller_file
+    FileUtils.rm('app/controllers/ratings_controller.rb')
+  end
+  
+end

data/lib/seems_rateable/version.rb

@@ -1,3 +1,3 @@
 module SeemsRateable
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seems_rateable
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Peter Toth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-15 00:00:00.000000000 Z
+date: 2013-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -77,6 +77,7 @@ files:
 - lib/generators/seems_rateable/templates/model.rb
 - lib/generators/seems_rateable/templates/rate_migration.rb
 - lib/generators/seems_rateable/templates/stylesheets/jRating.jquery.css
+- lib/generators/seems_rateable_destroy_generator.rb
 - lib/seems_rateable.rb
 - lib/seems_rateable/helpers.rb
 - lib/seems_rateable/record.rb