rapidfire 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5931093a48962d9159db2f33f779444a64ebec1
-  data.tar.gz: 91f3a91079f2e3588373f6c6056fcf79275b8e57
+  metadata.gz: 27b98c4be749e5dd26dc5021426543880ad344c8
+  data.tar.gz: 70dd426049dce2c447d567ccf25b1206201e32ab
 SHA512:
-  metadata.gz: 58aa967e0dd9018371d7acdc8158457aecc6941f9489e80a9fd04e198dad2db050d5cd25d2aba0bfedd94bdf9f43ce60f0e29ff4b3bf068309070f2b96eaee37
-  data.tar.gz: b5d67e8d5c7a7bf06286641f188cc3e7543e2fd88ccb7a14c0cfa46cac090b72e3c982c9d785aed4e2d8beea2803de5837069660d1f994888d2a35909b671376
+  metadata.gz: 394966bd048f4932b06c9a7a222f88a1754a85275591c2ab38397bea7d318b1a9ff9bf27ad78f2924592dec81c194fb57db34df01fa235ec2122b1055cba6787
+  data.tar.gz: 95c9d6b0eb5c44d854699fb3b3a64d0f44ab81935f5b2c8916fa4773220e6bfc3155e9cb7f1be29e80178d341d8453874d69c75b6d6b0330f3018e2376e8a992

data/README.md

@@ -1,10 +1,10 @@
 # Rapidfire
-[![Code Climate](https://codeclimate.com/repos/51a70089f3ea000534070811/badges/aedc90c3b5481e7569bb/gpa.png)](https://codeclimate.com/repos/51a70089f3ea000534070811/feed)
+[![Code Climate](https://codeclimate.com/github/code-mancers/rapidfire/badges/gpa.svg)](https://codeclimate.com/github/code-mancers/rapidfire)
 [![Build Status](https://travis-ci.org/code-mancers/rapidfire.png?branch=master)](https://travis-ci.org/code-mancers/rapidfire)
 
 One stop solution for all survey related requirements! Its tad easy!
 
-This gem supports both **rails 3.2.13+** and **rails4** versions.
+This gem supports **rails 3.2.13+**, **rails4** and **rails5** versions.
 
 You can see a demo of this gem [here](https://rapidfire.herokuapp.com).
 And the source code of demo [here](https://github.com/code-mancers/rapidfire-demo).
@@ -12,13 +12,17 @@ And the source code of demo [here](https://github.com/code-mancers/rapidfire-dem
 ## Installation
 Add this line to your application's Gemfile:
 
+```rb
     gem 'rapidfire'
+```
 
 And then execute:
 
+```shell
     $ bundle install
     $ bundle exec rake rapidfire:install:migrations
     $ bundle exec rake db:migrate
+```
 
 And if you want to customize rapidfire views, you can do
 
@@ -28,7 +32,9 @@ And if you want to customize rapidfire views, you can do
 
 Add this line to your routes will and you will be good to go!
 
+```rb
     mount Rapidfire::Engine => "/rapidfire"
+```
 
 And point your browser to [http://localhost:3000/rapidfire](http://localhost:3000/rapidfire)
 
@@ -41,7 +47,7 @@ methods `current_user` and `can_administer?` on your `ApplicationController`
 
 Typical implementation would be:
 
-```ruby
+```rb
   class ApplicationController < ActionController::Base
     def current_user
       @current_user ||= User.find(session[:user_id])
@@ -66,7 +72,7 @@ You can see them by running `bundle exec rake routes`.
 2. Optionally, each survey can by answered by visiting this path:
 
    ```
-     localhost:3000/rapidfire/question_groups/<survey-id>/answer_groups/new
+     localhost:3000/rapidfire/surveys/<survey-id>/answer_groups/new
    ```
 
    You can distribute this url so that survey takers can answer a particular survey
@@ -76,7 +82,7 @@ You can see them by running `bundle exec rake routes`.
 A new api is released which helps in seeing results for each survey. The api is:
 
 ```
-  GET /rapidfire/question_groups/<survey-id>/results
+  GET /rapidfire/surveys/<survey-id>/results
 ```
 This new api supports two formats: `html` and `json`. The `json` format is supported
 so that end user can use any javascript based chart solutions and render results
@@ -179,13 +185,22 @@ The typical flow about how to use this gem is:
      is validated with these values.
 
 5. Once the questions are populated, you can return to root_path ie by clicking
-   `Question Groups` and share distribute answer url so that others can answer
+   `Surveys` and share distribute answer url so that others can answer
    the questions populated.
 6. Note that answers fail to persist of the criteria that you have provided while
    creating questions fail.
 
 
 ## Notes on upgrading
+
+##### Upgrading from 2.1.0 to 3.0.0
+
+If you are upgrading you need to rename your `rapidfire_question_groups` to `rapidfire_surveys` and `rapidfire_answer_groups` to `rapidfire_attempts`. Run the given task to do that for you.
+
+```shell
+    $ rake rapidfire:upgrade:migrations:from210to300
+```
+
 ##### Upgrading from 1.2.0 to 2.0.0
 
 The default delimiter which is used to store options for questions like select
@@ -199,7 +214,8 @@ to make existing questions or stored answers to use new delimiter.
 
 NOTE: Please take database backup before running this rake task.
 
-```ruby
+```rb
+  bundle exec rake rapidfire:change_delimiter_from_comma_to_srsn
   bundle exec rake rapidfire:change_delimiter_from_comma_to_srsn
 ```
 
@@ -209,19 +225,18 @@ as delimiter, then please use this initializer, but be warned that in future
 delimiter will be hardcoded to `\r\n`:
 
 
-```ruby
-# /<path-to-app>/config/initializers/rapidfire.rb
+```rb
+  # /<path-to-app>/config/initializers/rapidfire.rb
 
-Rapidfire.config do |config|
-  config.answers_delimiter = ','
-end
+  Rapidfire.config do |config|
+    config.answers_delimiter = ','
+  end
 ```
 
 
 ## TODO
 1. Add ability to sort questions, so that order is preserved.
 2. Add multi tenant support.
-3. Rename question-groups to surveys, and change routes accordingly.
 
 ## Contributing
 

data/app/controllers/rapidfire/attempts_controller.rb

@@ -0,0 +1,29 @@
+module Rapidfire
+  class AttemptsController < Rapidfire::ApplicationController
+    before_filter :find_survey!
+
+    def new
+      @attempt_builder = AttemptBuilder.new(attempt_params)
+    end
+
+    def create
+      @attempt_builder = AttemptBuilder.new(attempt_params)
+
+      if @attempt_builder.save
+        redirect_to surveys_path
+      else
+        render :new
+      end
+    end
+
+    private
+    def find_survey!
+      @survey = Survey.find(params[:survey_id])
+    end
+
+    def attempt_params
+      answer_params = { params: (params[:attempt] || {}) }
+      answer_params.merge(user: current_user, survey: @survey)
+    end
+  end
+end

data/app/controllers/rapidfire/questions_controller.rb

@@ -2,33 +2,21 @@ module Rapidfire
   class QuestionsController < Rapidfire::ApplicationController
     before_filter :authenticate_administrator!
 
-    before_filter :find_question_group!
+    before_filter :find_survey!
     before_filter :find_question!, :only => [:edit, :update, :destroy]
 
     def index
-      @questions = @question_group.questions
+      @questions = @survey.questions
     end
 
     def new
-      @question_form = QuestionForm.new(:question_group => @question_group)
+      @question_form = QuestionForm.new(:survey => @survey)
     end
 
     def create
-      form_params = params[:question].merge(:question_group => @question_group)
-      @question_form = QuestionForm.new(form_params)
-      @question_form.save
+      form_params = question_params.merge(:survey => @survey)
 
-      if @question_form.errors.empty?
-        respond_to do |format|
-          format.html { redirect_to index_location }
-          format.js
-        end
-      else
-        respond_to do |format|
-          format.html { render :new }
-          format.js
-        end
-      end
+      save_and_redirect(form_params, :new)
     end
 
     def edit
@@ -36,8 +24,23 @@ module Rapidfire
     end
 
     def update
-      form_params = params[:question].merge(:question => @question)
-      @question_form = QuestionForm.new(form_params)
+      form_params = question_params.merge(:question => @question)
+
+      save_and_redirect(form_params, :edit)
+    end
+
+    def destroy
+      @question.destroy
+      respond_to do |format|
+        format.html { redirect_to index_location }
+        format.js
+      end
+    end
+
+    private
+
+    def save_and_redirect(params, on_error_key)
+      @question_form = QuestionForm.new(params)
       @question_form.save
 
       if @question_form.errors.empty?
@@ -47,32 +50,30 @@ module Rapidfire
         end
       else
         respond_to do |format|
-          format.html { render :edit }
+          format.html { render on_error_key.to_sym }
           format.js
         end
       end
     end
 
-    def destroy
-      @question.destroy
-      respond_to do |format|
-        format.html { redirect_to index_location }
-        format.js
-      end
-    end
-
-    private
-
-    def find_question_group!
-      @question_group = QuestionGroup.find(params[:question_group_id])
+    def find_survey!
+      @survey = Survey.find(params[:survey_id])
     end
 
     def find_question!
-      @question = @question_group.questions.find(params[:id])
+      @question = @survey.questions.find(params[:id])
     end
 
     def index_location
-      rapidfire.question_group_questions_url(@question_group)
+      rapidfire.survey_questions_url(@survey)
+    end
+
+    def question_params
+      if Rails::VERSION::MAJOR == 4 || Rails::VERSION::MAJOR == 5
+        params.require(:question).permit!
+      else
+        params[:question]
+      end
     end
   end
 end

data/app/controllers/rapidfire/surveys_controller.rb

@@ -0,0 +1,60 @@
+module Rapidfire
+  class SurveysController < Rapidfire::ApplicationController
+    before_filter :authenticate_administrator!, except: :index
+
+    def index
+      @surveys = Survey.all
+    end
+
+    def new
+      @survey = Survey.new
+    end
+
+    def create
+      @survey = Survey.new(survey_params)
+      if @survey.save
+        respond_to do |format|
+          format.html { redirect_to surveys_path }
+          format.js
+        end
+      else
+        respond_to do |format|
+          format.html { render :new }
+          format.js
+        end
+      end
+    end
+
+    def destroy
+      @survey = Survey.find(params[:id])
+      @survey.destroy
+
+      respond_to do |format|
+        format.html { redirect_to surveys_path }
+        format.js
+      end
+    end
+
+    def results
+      @survey = Survey.find(params[:id])
+      @survey_results =
+        SurveyResults.new(survey: @survey).extract
+
+      respond_to do |format|
+        format.json { render json: @survey_results, root: false }
+        format.html
+        format.js
+      end
+    end
+
+    private
+
+    def survey_params
+      if Rails::VERSION::MAJOR >= 4
+        params.require(:survey).permit(:name)
+      else
+        params[:survey]
+      end
+    end
+  end
+end

data/app/models/rapidfire/answer.rb

@@ -1,13 +1,13 @@
 module Rapidfire
   class Answer < ActiveRecord::Base
     belongs_to :question
-    belongs_to :answer_group, inverse_of: :answers
+    belongs_to :attempt, inverse_of: :answers
 
-    validates :question, :answer_group, presence: true
+    validates :question, :attempt, presence: true
     validate  :verify_answer_text, :if => "question.present?"
 
     if Rails::VERSION::MAJOR == 3
-      attr_accessible :question_id, :answer_group, :answer_text
+      attr_accessible :question_id, :attempt, :answer_text
     end
 
     private

data/app/models/rapidfire/attempt.rb

@@ -0,0 +1,11 @@
+module Rapidfire
+  class Attempt < ActiveRecord::Base
+    belongs_to :survey
+    belongs_to :user, polymorphic: true
+    has_many   :answers, inverse_of: :attempt, autosave: true
+
+    if Rails::VERSION::MAJOR == 3
+      attr_accessible :survey, :user
+    end
+  end
+end

data/app/models/rapidfire/question.rb

@@ -1,15 +1,15 @@
 module Rapidfire
   class Question < ActiveRecord::Base
-    belongs_to :question_group, :inverse_of => :questions
+    belongs_to :survey, :inverse_of => :questions
     has_many   :answers
 
     default_scope { order(:position) }
 
-    validates :question_group, :question_text, :presence => true
+    validates :survey, :question_text, :presence => true
     serialize :validation_rules
 
     if Rails::VERSION::MAJOR == 3
-      attr_accessible :question_group, :question_text, :validation_rules, :answer_options
+      attr_accessible :survey, :question_text, :validation_rules, :answer_options
     end
 
     def self.inherited(child)

data/app/models/rapidfire/{question_group.rb → survey.rb}

@@ -1,5 +1,5 @@
 module Rapidfire
-  class QuestionGroup < ActiveRecord::Base
+  class Survey < ActiveRecord::Base
     has_many  :questions
     validates :name, :presence => true
 

data/app/services/rapidfire/{answer_group_builder.rb → attempt_builder.rb}

@@ -1,19 +1,19 @@
 module Rapidfire
-  class AnswerGroupBuilder < Rapidfire::BaseService
-    attr_accessor :user, :question_group, :questions, :answers, :params
+  class AttemptBuilder < Rapidfire::BaseService
+    attr_accessor :user, :survey, :questions, :answers, :params
 
     def initialize(params = {})
       super(params)
-      build_answer_group
+      build_attempt
     end
 
     def to_model
-      @answer_group
+      @attempt
     end
 
     def save!(options = {})
       params.each do |question_id, answer_attributes|
-        if answer = @answer_group.answers.find { |a| a.question_id.to_s == question_id.to_s }
+        if answer = @attempt.answers.find { |a| a.question_id.to_s == question_id.to_s }
           text = answer_attributes[:answer_text]
 
           # in case of checkboxes, values are submitted as an array of
@@ -29,24 +29,24 @@ module Rapidfire
         end
       end
 
-      @answer_group.save!(options)
+      @attempt.save!(options)
     end
 
     def save(options = {})
       save!(options)
     rescue ActiveRecord::ActiveRecordError => e
       # repopulate answers here in case of failure as they are not getting updated
-      @answers = @question_group.questions.collect do |question|
-        @answer_group.answers.find { |a| a.question_id == question.id }
+      @answers = @survey.questions.collect do |question|
+        @attempt.answers.find { |a| a.question_id == question.id }
       end
       false
     end
 
     private
-    def build_answer_group
-      @answer_group = AnswerGroup.new(user: user, question_group: question_group)
-      @answers = @question_group.questions.collect do |question|
-        @answer_group.answers.build(question_id: question.id)
+    def build_attempt
+      @attempt = Attempt.new(user: user, survey: survey)
+      @answers = @survey.questions.collect do |question|
+        @attempt.answers.build(question_id: question.id)
       end
     end