rostra 0.0.10 → 0.0.11

data/README.rdoc

@@ -18,9 +18,9 @@ Install and run the necessary migrations:
   rake rostra:install:migrations
   rake db:migrate
 
-Run the generator to create the configuration file:
+Run the generator to create <tt>config/initializers/rostra.rb</tt> and <tt>app/helpers/application_helper.rb</tt>:
 
-  rails generate rostra:install   # see `config/initializers/rostra.rb` for details
+  rails generate rostra:install
 
 Call <tt>rostra</tt> in your user model:
 
@@ -38,7 +38,9 @@ There's some stuff you'll almost definitely want to do in order to get Rostra wo
 Also, be sure to read through <tt>config/initializers/rostra.rb</tt> and override configuration options to suit your app. At the very least, you'll want to change:
 
   config.deliver_emails_from = 'change_me@example.com'
-`
+
+Finally, have a look at <tt>app/helpers/rostra/application_helper.rb</tt>, you may need to add/override helper methods.
+
 == Customizing the question and answer models
 Rostra provides a DSL for adding application specific logic to <tt>Rostra::Question</tt> and <tt>Rostra:Answer</tt>:
 
@@ -67,6 +69,11 @@ Rostra provides a DSL for adding application specific logic to <tt>Rostra::Quest
     end
   end
 
+== Setting permissions
+Under the hood, Rostra uses <tt>CanCan</tt> to set permissions. By default anyone can read rostra content - even if they are not logged in. A user can contribute content (i.e. ask questions, give answers, and leave comments) as long as they've logged in.
+
+If you need to change these defaults, override <tt>can_participate_in_rostra?</tt> in your user model. <tt>CanCan</tt> will use this method to determine who can participate. If you need to specify even more complicated permissions, override <tt>app/models/rostra/ability.rb</tt> and go wild.
+
 
 == Contributing to Rostra
 Fork the project, make your changes, and submit a pull request. Please ensure the tests pass:

data/app/assets/javascripts/rostra/application.js

@@ -47,7 +47,7 @@ $(document).ready(function() {
     theme_advanced_buttons3 : "",
     theme_advanced_toolbar_location : "top",
     theme_advanced_toolbar_align : "left",
-    plugins: 'paste, autoresize',
+    plugins: 'paste',
     paste_remove_styles: true,
     paste_remove_spans: true,
     setup: function (ed) {

data/app/helpers/rostra/application_helper.rb

@@ -1,68 +1,5 @@
 module Rostra
   module ApplicationHelper
-
-    # Loop thru included helper files and include them in the project.
-    #
-    Rostra::Config.included_helpers.each do |helper_file|
-      include helper_file
-    end
-
-    # Creates a list of tags linking to the index showing only questions with that tag
-    #
-    def tag_list(question)
-      content_tag :div, "Tags: #{question.tags.map { |tag| link_to tag, questions_path(:tag_search => "#{tag}")}.join}".html_safe, class: 'tags'
-    end
-
-    # Finds the url to the user's avatar following this logic:
-    #
-    #   1. Calls the method defined in the <tt>Rostra::Config</tt>
-    #   2. Uses the users email address to looks for a gravatar
-    #   3. Renders <tt>app/assets/images/rostra/anonymous_avatar.png</tt>
-    #
-    def avatar_url(user)
-      avatar_method = Rostra::Config.rostra_user_avatar
-
-      if user.respond_to?(avatar_method)
-        user.send(avatar_method)
-      else
-        default_url = "#{main_app.root_url}assets/rostra/anonymous_avatar.png"
-        gravatar_id = Digest::MD5.hexdigest(user.rostra_user_email.downcase)
-        "http://gravatar.com/avatar/#{gravatar_id}.png?s=48&d=#{CGI.escape(default_url)}"
-      end
-    end
-
-    # Method to build links for ajax-y voting arrows.
-    #
-    def link_to_vote(direction, resource)
-      if user_signed_in? && ( (direction == :up && rostra_user.voted_for?(resource)) || (direction == :down && rostra_user.voted_against?(resource)) )
-        selected = 'selected'
-      else
-        selected = ''
-      end
-
-      link_to "Vote #{direction.capitalize}", vote_path(resource, direction), method: :put, remote: true, class: "vote #{direction} #{selected}"
-    end
-
-    # Returns a rostra object's base class name. For example, <tt>@question</tt> is an instance of
-    # Rostra::Question and so:
-    #
-    #   class_name(@question)  # => 'question'
-    #
-    def class_name(resource)
-      resource.class.name.split('::').last.downcase
-    end
-
-    private
-
-    def vote_path(resource, direction)
-      return '#' if !user_signed_in? || can?(:manage, resource)
-
-      if resource.is_a?(Rostra::Question)
-        vote_question_path(resource, vote_direction: direction)
-      else
-        vote_question_answer_path(resource.question, resource, vote_direction: direction)
-      end
-    end
-
+    include Rostra::BaseHelper
   end
 end

data/app/helpers/rostra/base_helper.rb

@@ -0,0 +1,86 @@
+module Rostra
+  module BaseHelper
+
+    # Method used to render to user names (e.g. where it says: "John Does says:"). You can,
+    # for example, use this method to turn "John Doe" into a link to his profile page.
+    #
+    def link_to_profile(user)
+      link_to user.rostra_user_name, main_app.user_path(user)
+    end
+
+    # Used to populate both the <tt>title</tt> and <tt>h1</tt> elements for each page.
+    #
+    def page_title_helper
+      case "#{controller_name}##{action_name}"
+      when "questions#show" then @question.title
+      when "questions#index" then
+        if params[:tag_search].present?
+          "Recent Questions for tag #{params[:tag_search]}"
+        else
+          "Recent Questions"
+        end
+      when "questions#new" then "Post a new question"
+      when "questions#edit" then "Editing question"
+      when "answers#edit" then "Editing answer"
+      else "Recent Questions"
+      end
+    end
+
+    # Creates a list of tags linking to the index showing only questions with that tag
+    #
+    def tag_list(question)
+      tags = question.tags.map { |tag| link_to tag, questions_path(:tag_search => "#{tag}")}.join
+      content_tag :div, "Tags: #{tags}".html_safe, class: 'tags'
+    end
+
+    # Finds the url to the user's avatar following this logic:
+    #
+    #   1. Calls <tt>avatar</tt> on the user object
+    #   2. Uses the users email address to look for a gravatar
+    #   3. Renders <tt>app/assets/images/rostra/anonymous_avatar.png</tt>
+    #
+    def avatar_url(user)
+      if user.respond_to?(:avatar)
+        user.avatar
+      else
+        default_url = "#{main_app.root_url}assets/rostra/anonymous_avatar.png"
+        gravatar_id = Digest::MD5.hexdigest(user.rostra_user_email.downcase)
+        "http://gravatar.com/avatar/#{gravatar_id}.png?s=48&d=#{CGI.escape(default_url)}"
+      end
+    end
+
+    # Method to build links for ajax-y voting arrows.
+    #
+    def link_to_vote(direction, resource)
+      if user_signed_in? && ( (direction == :up && rostra_user.voted_for?(resource)) || (direction == :down && rostra_user.voted_against?(resource)) )
+        selected = 'selected'
+      else
+        selected = ''
+      end
+
+      link_to "Vote #{direction.capitalize}", vote_path(resource, direction), method: :put, remote: true, class: "vote #{direction} #{selected}"
+    end
+
+    # Returns a rostra object's base class name. For example, <tt>@question</tt> is an instance of
+    # Rostra::Question and so:
+    #
+    #   class_name(@question)  # => 'question'
+    #
+    def class_name(resource)
+      resource.class.name.split('::').last.downcase
+    end
+
+    private
+
+    def vote_path(resource, direction)
+      return '#' if !user_signed_in? || can?(:manage, resource)
+
+      if resource.is_a?(Rostra::Question)
+        vote_question_path(resource, vote_direction: direction)
+      else
+        vote_question_answer_path(resource.question, resource, vote_direction: direction)
+      end
+    end
+
+  end
+end

data/app/models/rostra/ability.rb

@@ -7,7 +7,7 @@ module Rostra
     def initialize(user)
       @user = user || User.new
 
-      if logged_in?
+      if @user.can_participate_in_rostra?
         can :manage, Question, :user => user
         can :manage, Answer, :user => user
         can :manage, Comment, :user => user
@@ -22,11 +22,5 @@ module Rostra
       can :read, :all
     end
 
-    private
-
-    def logged_in?
-      ! user.new_record?
-    end
-
   end
 end

data/app/views/layouts/rostra/application.html.erb

@@ -1,9 +1,9 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Rostra</title>
-  <%= stylesheet_link_tag "rostra/application" %>
-  <%= javascript_include_tag "rostra/application" %>
+  <title><%=page_title_helper || 'Rostra' %></title>
+  <%= stylesheet_link_tag 'rostra/application' %>
+  <%= javascript_include_tag 'rostra/application' %>
   <%= csrf_meta_tags %>
 </head>
 <body id="<%= controller_name %>" class="<%= action_name %>">
@@ -15,21 +15,7 @@
       <%= content_tag :div, msg, id: "flash_#{name}", class: 'flash' %>
     <% end %>
 
-    <h1><%=
-      case "#{controller_name}##{action_name}"
-      when "questions#show" then @question.title
-      when "questions#index" then
-        if params[:tag_search].present?
-          "Recent Questions for tag #{params[:tag_search]}"
-        else
-          "Recent Questions"
-        end
-      when "questions#new" then "Post a new question"
-      when "questions#edit" then "Editing question"
-      when "answers#edit" then "Editing answer"
-      else "Recent Questions"
-      end
-    %></h1>
+    <h1><%=page_title_helper %></h1>
 
     <%= yield %>
   </div>

data/app/views/rostra/questions/index.html.erb

@@ -22,7 +22,6 @@
               <div class="views_count">
                 <span class="count"><%= question.unique_page_views %></span>
                 <span class="type"><%= question.unique_page_views.abs == 1 ? 'view' : 'views' %></span>
-
               </div>
             </div>
 
@@ -30,7 +29,7 @@
 
             <h3 class="title"><%= link_to question.title, question %></h3>
             <cite>
-              Asked by <%= question.user.rostra_user_name %>
+              Asked by <%= link_to_profile(question.user) %>
               <%= link_to 'edit', edit_question_path(question) if can? :manage, question %>
             </cite>
             <div class="text">

data/app/views/rostra/questions/show.html.erb

@@ -6,7 +6,7 @@
     <%= render partial: 'rostra/shared/votes', locals: { resource: @question } %>
     <%= image_tag avatar_url(@question.user), class: 'avatar' %>
     <cite>
-      Asked by <%= @question.user.rostra_user_name %>
+      Asked by <%= link_to_profile(@question.user) %>
       <%= link_to 'edit', edit_question_path(@question) if can? :manage, @question %>
     </cite>
     <div class="text"><%= simple_format(@question.details) %></div>
@@ -22,7 +22,7 @@
           <%= render partial: 'rostra/shared/votes', locals: { resource: answer } %>
           <%= image_tag avatar_url(answer.user), class: 'avatar' %>
           <cite>
-            <%= answer.user.rostra_user_name %> says:
+            <%= link_to_profile(answer.user) %> says:
             <%= link_to('edit', edit_question_answer_path(@question, answer)) if can? :manage, answer %>
           </cite>
           <div class="text"><%= simple_format(answer.text) %></div>
@@ -34,10 +34,10 @@
                 <div class="comment text">
                   <div class="editable" data-ajax_url="<%= question_comment_path(@question, comment) %>"><%= comment.comment %></div>
                   <div class="timestamp">
-                    <%= comment.user.rostra_user_name %> – <%= time_ago_in_words(comment.updated_at) %> ago
+                    <%= link_to_profile(comment.user) %> – <%= time_ago_in_words(comment.updated_at) %> ago
                     <% if can? :manage, comment %>
                       <%= link_to('edit', question_comment_path(@question, comment), class: 'edit_comment') %>
-                      <%= link_to('delete', question_comment_path(@question, comment), method: :delete, confirm: 'Are you sure?') if can? :manage, comment %>
+                      <%= link_to('delete', question_comment_path(@question, comment), method: :delete, confirm: 'Are you sure?') %>
                     <% end %>
                   </div>
                 </div>
@@ -47,9 +47,9 @@
 
 
           <% if can? :manage, Comment %>
-            <%= link_to("leave comment", '#', class: 'leave_comment') %>
+            <%= link_to("comment on this answer", '#', class: 'leave_comment') %>
           <% else %>
-            <%= link_to("login leave comment", main_app_login_path) %>
+            <%= link_to("login to leave comment", main_app_login_path) %>
           <% end %>
 
 

data/lib/generators/rostra/install_generator.rb

@@ -5,10 +5,16 @@ module Rostra
       source_root File.expand_path('../templates', __FILE__)
       class_option :template_engine
 
+      desc "Generate configuration file where you can set/override Rostra options"
       def copy_config
         directory 'config'
       end
 
+      desc "Generate application helper file where you can set/override Rostra helper methods"
+      def copy_application_helper
+        directory 'app'
+      end
+
     end
   end
 end

data/lib/generators/rostra/templates/app/helpers/rostra/application_helper.rb

@@ -0,0 +1,58 @@
+module Rostra
+  module ApplicationHelper
+    # If you don't need to make any changes, you can delete this file.
+    #
+    # Include base helper methods required for Rostra views. You probably don't want to remove
+    # this line but you can add/override rostra methods in this file. The helpers which you may
+    # need to override are listed below. Just un-comment them and make changes.
+    #
+    include Rostra::BaseHelper
+
+    # If you want to user helper methods defined elsewhere in your app, you can include them here
+    # as well. For example:
+    #
+    # include MainAppHelper
+
+    # Creates a list of tags linking to the index showing only questions with that tag
+    #
+    # def tag_list(question)
+    #   tags = question.tags.map { |tag| link_to tag, questions_path(:tag_search => "#{tag}")}.join
+    #   content_tag :div, "Tags: #{tags}".html_safe, class: 'tags'
+    # end
+
+    # Finds the url to the user's avatar following this logic:
+    #
+    #   1. Calls <tt>avatar</tt> on the user object
+    #   2. Uses the users email address to look for a gravatar
+    #   3. Renders <tt>app/assets/images/rostra/anonymous_avatar.png</tt>
+    #
+    # def avatar_url(user)
+    #   if user.respond_to?(:avatar)
+    #     user.avatar
+    #   else
+    #     default_url = "#{main_app.root_url}assets/rostra/anonymous_avatar.png"
+    #     gravatar_id = Digest::MD5.hexdigest(user.rostra_user_email.downcase)
+    #     "http://gravatar.com/avatar/#{gravatar_id}.png?s=48&d=#{CGI.escape(default_url)}"
+    #   end
+    # end
+
+    # Used to populate both the <tt>title</tt> and <tt>h1</tt> elements for each page.
+    #
+    # def page_title_helper
+    #   case "#{controller_name}##{action_name}"
+    #   when "questions#show" then @question.title
+    #   when "questions#index" then
+    #     if params[:tag_search].present?
+    #       "Recent Questions for tag #{params[:tag_search]}"
+    #     else
+    #       "Recent Questions"
+    #     end
+    #   when "questions#new" then "Post a new question"
+    #   when "questions#edit" then "Editing question"
+    #   when "answers#edit" then "Editing answer"
+    #   else "Recent Questions"
+    #   end
+    # end
+
+  end
+end

data/lib/generators/rostra/templates/config/initializers/rostra.rb

@@ -1,13 +1,5 @@
 # Use this setup block to configure all options available in Rostra.
 Rostra::Config.setup do |config|
-
-  # If you want to access helpers defined in your main app, add them to this array.
-  # For example, if you'd like to use helpers defined in your <tt>ApplicationHelper</tt>:
-  #
-  #   config.included_helpers = [ ApplicationHelper ]
-  #
-  # config.included_helpers = []
-
   # Helper method used to access current user in the view
   # config.deliver_emails_from = 'change_me@example.com'
 
@@ -20,15 +12,6 @@ Rostra::Config.setup do |config|
   # Method called on the rostra'd model (e.g. User) to access the users email address
   # config.rostra_user_email = :email
 
-  # Method called on the rostra'd model (e.g. User) to access the users avatar. It
-  # looks for an avatar in this order:
-  #
-  #   1. Calls the method defined here
-  #   2. Uses the users email address to looks for a gravatar
-  #   3. Renders <tt>app/assets/images/rostra/anonymous_avatar.png</tt>
-  #
-  # config.rostra_user_avatar = :avatar
-
   # Route to your login page
   # config.main_app_login_path = :new_user_session_path
 

data/lib/rostra/config.rb

@@ -1,14 +1,6 @@
 module Rostra
   module Config
 
-    # If you want to access helpers defined in your main app, add them to this array.
-    # For example, if you'd like to use helpers defined in your <tt>ApplicationHelper</tt>:
-    #
-    #   config.included_helpers = [ ApplicationHelper ]
-    #
-    mattr_accessor :included_helpers
-    @@included_helpers = []
-
     # Helper method used to access current user in the view
     #
     mattr_accessor :deliver_emails_from
@@ -29,16 +21,6 @@ module Rostra
     mattr_accessor :rostra_user_email
     @@rostra_user_email = :email
 
-    # Method called on the rostra'd model (e.g. User) to access the users avatar. It looks
-    # for an avatar in this order:
-    #
-    #   1. Calls the method defined here
-    #   2. Uses the users email address to looks for a gravatar
-    #   3. Renders <tt>app/assets/images/rostra/anonymous_avatar.png</tt>
-    #
-    mattr_accessor :rostra_user_avatar
-    @@rostra_user_avatar = :avatar
-
     # Route to your login page
     #
     mattr_accessor :main_app_login_path

data/lib/rostra/version.rb

@@ -1,3 +1,3 @@
 module Rostra
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/lib/rostra.rb

@@ -63,6 +63,22 @@ module Rostra
         end
       end
 
+      # By default anyone can read rostra content - even if they are not logged in. This method
+      # determines if users can contribute content (i.e. ask questions, give answers, and leave
+      # comments). If <tt>can_participate_in_rostra?</tt> returns true, the user can contribute
+      # content, otherwise they're restricted to read only.
+      #
+      # Under the hood, Rostra uses <tt>CanCan</tt> to set permissions and this is the only
+      # place where <tt>can_participate_in_rostra?</tt> is actully used. The default is very
+      # simple, if the user exists (i.e. they are logged in), then they may participate. But
+      # you can override this method in your <tt>User</tt> model to set more complicated
+      # conditions participation. If you need to specify even more complicated permissions,
+      # override <tt>app/models/rostra/ability.rb</tt> and go wild.
+      #
+      def can_participate_in_rostra?
+        !new_record?
+      end
+
       # Rostra will use this method to find a user's full name.
       #
       def rostra_user_name

metadata

@@ -2,7 +2,7 @@
 name: rostra
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors: 
 - Cory Schires
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-20 00:00:00 -05:00
+date: 2011-10-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -490,13 +490,13 @@ files:
 - app/controllers/rostra/comments_controller.rb
 - app/controllers/rostra/questions_controller.rb
 - app/helpers/rostra/application_helper.rb
+- app/helpers/rostra/base_helper.rb
 - app/mailers/rostra/application_mailer.rb
 - app/models/comment.rb
 - app/models/rostra/ability.rb
 - app/models/rostra/answer.rb
 - app/models/rostra/question.rb
 - app/models/rostra/question_following.rb
-- app/models/rostra/vote.rb
 - app/models/vote.rb
 - app/views/layouts/rostra/application.html.erb
 - app/views/rostra/answers/_form.html.erb
@@ -526,6 +526,7 @@ files:
 - db/migrate/20111016021105_create_impressions_table.rb
 - db/migrate/20111019162723_create_rostra_question_followings.rb
 - lib/generators/rostra/install_generator.rb
+- lib/generators/rostra/templates/app/helpers/rostra/application_helper.rb
 - lib/generators/rostra/templates/config/initializers/rostra.rb
 - lib/rostra/config.rb
 - lib/rostra/email_notifier.rb

data/app/models/rostra/vote.rb

@@ -1,19 +0,0 @@
-module Rostra
-  class Vote < ActiveRecord::Base
-
-    scope :for_voter, lambda { |*args| where(["voter_id = ? AND voter_type = ?", args.first.id, args.first.class.name]) }
-    scope :for_voteable, lambda { |*args| where(["voteable_id = ? AND voteable_type = ?", args.first.id, args.first.class.name]) }
-    scope :recent, lambda { |*args| where(["created_at > ?", (args.first || 2.weeks.ago)]) }
-    scope :descending, order("created_at DESC")
-
-    belongs_to :voteable, :polymorphic => true
-    belongs_to :voter, :polymorphic => true
-
-    attr_accessible :vote, :voter, :voteable
-
-
-    # Comment out the line below to allow multiple votes per user.
-    validates_uniqueness_of :voteable_id, :scope => [:voteable_type, :voter_type, :voter_id]
-
-  end
-end