Ask It is a Rails Engine that brings multi types of quizzes, surveys and contests into your Rails application. Ask It models were designed to be flexible enough in order to be extended and integrated with your own models. Ask It was initially extracted from a real application that handles contests and quizzes.
You can view the Ask It documentation in RDoc format here:
http://rubydoc.info/github/dr-click/questionnaire/master/frames
Add Ask It to your Gemfile for Rails 6 and 7:
gem 'ask_it'
or
gem 'ask_it'
Now generate and run migrations:
rails generate ask_it:install
bundle exec rake db:migrate
To make a model aware of you just need to add has_surveys on it:
class User < ActiveRecord::Base
has_surveys
#... (your code) ...
end
There is the concept of participant, in our example we choose the User Model.
Every participant can respond to surveys and every response is registered as a attempt.
By default, survey logic assumes an infinite number of attempts per participant
but if your surveys need to have a maximum number of attempts
you can pass the attribute attempts_number when creating them.
# Each Participant can respond 4 times this survey
AskIt::Survey.new(:name => "Star Wars Quiz", :attempts_number => 4)
In this example we are using the current_user helper but you can do it in the way you want.
class ContestsController < ApplicationController
helper_method :survey, :participant
# create a new attempt to this survey
def new
@survey = AskIt::Survey.active.last
@attempt = @survey.attempts.new
@attempt.answers.build
@participant = current_user # you have to decide what to do here
end
# create a new attempt in this survey
# an attempt needs to have a participant assigned
def create
@survey = AskIt::Survey.active.last
@attempt = @survey.attempts.new(attempt_params)
@attempt.participant = current_user
if @attempt.valid? and @attempt.save
redirect_to view_context.new_attempt_path, alert: I18n.t("attempts_controller.#{action_name}")
else
flash.now[:error] = @attempt.errors.full_messages.join(', ')
render :action => :new
end
end
#######
private
#######
# Rails 4 Strong Params
def attempt_params
if Rails::VERSION::MAJOR < 4
params[:survey_attempt]
else
params.require(:survey_attempt).permit(answers_attributes: [:id, :question_id, :option_id, :option_text, :option_number, :predefined_value_id, :_destroy, :finished])
end
end
end
To add a survey to a particular model (model has_many :surveys), use the has_many_surveys helper
class Lesson < ActiveRecord::Base
has_many_surveys
#... (your code) ...
end
Then, create a module mixin that adds belongs_to to the survey model based on your class name
# app/models/survey/belongs_to_lesson.rb
module Survey
module BelongsToLesson
extend ActiveSupport::Concern
included do
belongs_to :lesson
end
end
end
This will dynamically add the association to the survey model. However, you will need to generate a migration in order to add the foreign key to the survey_surveys table like so:
class AddLessonIdToSurveySurveys < ActiveRecord::Migration
def change
add_column :survey_surveys, :lesson_id, :integer
end
end
To control which page participants see you can use method avaliable_for_participant?
that checks if the participant already spent his attempts.
<h3><%= flash[:alert]%></h3>
<h3><%= flash[:error]%></h3>
<% if @survey.avaliable_for_participant?(@participant) %>
<%= render 'form' %>
<% else %>
<p>
<%= @participant.name %> spent all the possible attempts to answer this Survey
</p>
<% end -%>
<% # in _form.html.erb %>
<h1><%= @survey.name %></h1>
<p><%= @survey.description %></p>
<%= form_for(@attempt, :url => attempt_scope(@attempt)) do |f| %>
<%= f.fields_for :answers do |builder| %>
<ul>
<% seq = 0 %>
<% @survey.sections.each do |section| %>
<p><span><%= "#{section.head_number} : " if section.head_number %></span><%= section.name%></p>
<p><%= section.description if section.description %></p>
<% section.questions.each do |question| %>
<% seq += 1 %>
<li>
<p><span><%= "#{question.head_number} : " if question.head_number %></span><%= question.text %></p>
<p><%= question.description if question.description %></p>
<% question.options.each do |option| %>
<% if option.options_type_id == AskIt::OptionsType.multi_choices %>
<%= hidden_field_tag "survey_attempt[answers_attributes][#{seq}][question_id]", question.id %>
<%= check_box_tag "survey_attempt[answers_attributes][#{seq}][option_id]", option.id %>
<% seq += 1 %>
<% elsif option.options_type_id == AskIt::OptionsType.single_choice %>
<%= hidden_field_tag "survey_attempt[answers_attributes][#{seq}][question_id]", question.id %>
<%= radio_button_tag "survey_attempt[answers_attributes][#{seq}][option_id]", option.id %>
<% elsif option.options_type_id == AskIt::OptionsType.number %>
<%= hidden_field_tag "survey_attempt[answers_attributes][#{seq}][question_id]", question.id %>
<%= hidden_field_tag "survey_attempt[answers_attributes][#{seq}][option_id]", option.id %>
<%= number_field_tag "survey_attempt[answers_attributes][#{seq}][option_number]", "", :style => "width: 40px;" %>
<% seq += 1 %>
<% elsif option.options_type_id == AskIt::OptionsType.text %>
<%= hidden_field_tag "survey_attempt[answers_attributes][#{seq}][question_id]", question.id %>
<%= hidden_field_tag "survey_attempt[answers_attributes][#{seq}][option_id]", option.id %>
<%= text_field_tag "survey_attempt[answers_attributes][#{seq}][option_text]", "" %>
<% seq += 1 %>
<% end %>
<%= option.text %> <br/>
<% end -%>
</li>
<% end -%>
<% end -%>
</ul>
<% end -%>
<%= f.submit "Submit" %>
<% end -%>
If you are using Rails Admin or Active Admin, you can generate base CRUD screens for Survey with:
rails generate survey active_admin
rails generate survey rails_admin
If you want a simple way to get started you can use the plain option which is a simple Rails scaffold to generate the controller and views related with survey logic.
By default when you type rails g survey plain it generates a controller in the admin namespace but you can choose your own namespace as well:
rails generate survey plain namespace:contests
By default when you generates your controllers using the plain command the task
generates the associated routes as well.
Afterwards if you want to generate more routes, you can using the command:
rails generate survey routes namespace:admin
Every user has a collection of attempts for each survey that he respond to. Is up to you to make averages and collect reports based on that information. What makes Survey useful is that all the logic behind surveys is now abstracted and well integrated, making your job easier.
# select the first active Survey
survey = AskIt::Survey.active.first
# select all the attempts from this survey
survey_answers = survey.attempts
# check the highest score for current user
user_highest_score = survey_answers.for_participant(@user).high_score
#check the highest score made for this survey
global_highest_score = survey_answers.high_score
Survey supports Rails 3 and 4. For use in Rails 4 without using protected_attributes gem. Rails 4 support is recent, so some minor issues may still be present, please report them.
Only support versions of Active Admin higher than 0.3.1.
FAQs
Unknown package
We found that ask_it demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.