Module: AjaxfulRating::Helpers

Includes:
Errors
Included in:
ActionView::Base
Defined in:
lib/axr/helpers.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) ajaxful_rating_script 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/axr/helpers.rb', line 13

def ajaxful_rating_script
  if protect_against_forgery?
    authenticity_script = %{
      csrf_param = "authenticity_token";
      csrf_token = #{form_authenticity_token.inspect};

      // Always send the authenticity_token with ajax
      $(document).ajaxSend(function(event, request, settings) {
        if ( settings.type == 'post' ) {
          settings.data = (settings.data ? settings.data + "&" : "")
            + encodeURIComponent( csrf_param ) + "=" + encodeURIComponent( csrf_token );
        }
      });
    }
  end

  %{<script>
    #{authenticity_script}

    $(document).ready(function(){
      $('.ajaxful-rating a').bind('click',function(event){
        event.preventDefault();
        $.ajax({
          type: $(this).attr('data-method'),
          url: $(this).attr('href'),
          data: {
                  stars: $(this).attr('data-stars'),
                  dimension: $(this).attr('data-dimension'),
                  size: $(this).attr('data-size'),
                  show_user_rating: $(this).attr('data-show_user_rating')
                },
          success: function(response){
            $('#' + response.id + ' .show-value').css('width', response.width + '%');
          }
        });
      });
    });
  </script>}
end

- (Object) ajaxful_rating_script_prototype 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/axr/helpers.rb', line 53

def ajaxful_rating_script_prototype
  %{
    $$('.ajaxful-rating a').observe('click', rateProduct);
    
    function rateProduct(event) {
      var element = event.element();

      new Ajax.Request(element.readAttribute('data-url'), {
        method: element.readAttribute('data-method'),
        parameters: {
          data-stars: element.readAttribute('data-stars'),
          data-dimension: element.readAttribute('data-dimension'),
          data-size: element.readAttribute('data-size'),
          data-show_user_rating: element.readAttribute('data-show_user_rating')
        },
        onSuccess: function(transport, json){
          alert(json ? Object.inspect(json) : "no JSON object");
        }
      });
    }
  }
end

- (Object) ajaxful_rating_style

Outputs the required css file, and the dynamic CSS generated for the current page.



7
8
9
10
11
 
# File 'lib/axr/helpers.rb', line 7

def ajaxful_rating_style
  @axr_css ||= CSSBuilder.new
  stylesheet_link_tag('ajaxful_rating') +
    content_tag(:style, @axr_css.to_css, :type => "text/css")
end

- (Object) ratings_for(*args)

Generates the stars list to submit a rate.

It accepts the next options:

  • :size Set this param to medium or small to display medium/small images. Default is false.

Default is => :post, :url => rate_rateablemodel_path(rateable).

  • :wrap Whether the star list is wrapped within a div tag or not. This is useful when page updating. Default is true.

  • :show_user_rating Set to true if you want to display only the current user's rating, instead of the global average.

  • :dimension The dimension to show the ratings for.

  • :force_static Force static stars even when you're passing a user instance.

Example:

<%= ratings_for @article, :wrap => false %> # => Will produce something like:
<ul class="ajaxful-rating">
  <li class="current-rating" style="width: 60%;">3</li>
  <li><%= link_to_remote 1, :url => rate_article_path(@article, :stars => 1), :method => :post, :html => {:class => 'stars-1', :title => '1 star out of 5'} %></li>
  <li><%= link_to_remote 2, :url => rate_article_path(@article, :stars => 2), :method => :post, :html => {:class => 'stars-2', :title => '2 stars out of 5'} %></li>
  <li><%= link_to_remote 3, :url => rate_article_path(@article, :stars => 3), :method => :post, :html => {:class => 'stars-3', :title => '3 stars out of 5'} %></li>
  <li><%= link_to_remote 4, :url => rate_article_path(@article, :stars => 4), :method => :post, :html => {:class => 'stars-4', :title => '4 stars out of 5'} %></li>
  <li><%= link_to_remote 5, :url => rate_article_path(@article, :stars => 5), :method => :post, :html => {:class => 'stars-5', :title => '5 stars out of 5'} %></li>
</ul>

It will try to use the method current_user as the user instance. You can specify a custom instance in the second parameter or pass :static to leave the list of stars static.

Example:

<%= ratings_for @article, @user, :size => 'small' %>
# => Will use @user instead <tt>current_user</tt>

<%= ratings_for @article, :static, :size => 'medium' %>
# => Will produce a static list of stars showing the current rating average for @article.

The user passed here will not be the one who submits the rate. It will be used only for the display behavior of the stars. Like for example, if there is a user logged in or if the current logged in user is able to submit a rate depending on the configuration (accepts update of rates, etc).

So to actually set the user who will rate the model you need to do it in your controller:

# controller
def rate
  @article = Article.find(params[:id])
  @article.rate(params[:stars], current_user) # or any user instance
  # update page, etc.
end

By default ratings_for will render the average rating for all users. If however you would like to display the rating for a single user, then set the :show_user_rating option to true. For example:

<%= ratings_for @article, :show_user_rating => true %>

Or

<%= ratings_for @article, @user, :show_user_rating => true %>

I18n:

You can translate the title of the images (the tool tip that shows when the mouse is over) and the 'Currently x/x stars' string by setting these keys on your translation hash:

ajaxful_rating:
  helper:
    global_average: "Global rating average: {{value}} out of {{max}}"
    user_rating: "Your rating: {{value}} out of {{max}}"
    hover: "Rate {{value}} out of {{max}}"    def ratings_for(*args)


137
138
139
140
141
142
143
144
 
# File 'lib/axr/helpers.rb', line 137

def ratings_for(*args)
  @axr_css ||= CSSBuilder.new
  options = args.extract_options!.symbolize_keys.slice(:size, :url, :method,
    :wrap, :show_user_rating, :dimension, :force_static, :current_user)
  rateable = args.shift
  user = args.shift || (respond_to?(:current_user) ? current_user : raise(NoUserSpecified))
  StarsBuilder.new(rateable, user, self, @axr_css, options).render
end