rapidfire 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 057dce98ba358c61326f29a6b7a421f0aa50fd11abfc3fbe5ca414dd91bdaee2
-  data.tar.gz: bf897389f256d72d09e880a5d89c1791553e13a109e91ce4877ad57a4287fb74
+  metadata.gz: dabe714dbf4a6938fc95b0f9f598326f9414649515a0be018967c98a8da384f9
+  data.tar.gz: 8c801984adc0c4b902ee562e2e6d716a117b820a2ee5f377bfa580cc1f8ca3f6
 SHA512:
-  metadata.gz: 8e697ecacc4b2173e61aa88d0160b92a5d82d6180ebdaa446093d29987bb29918f10d64c67b48ff1888b126d769920ede8e67f20e21972b1150704bcda97c226
-  data.tar.gz: 04c7367d6ee40bf0c75a620403b30b6b78dd94e7cd2743c7f5c8867d52d6dfaee399d58a259a9a47be21a80fb51e600accf794ff9ea8101f3e1a01c7634430b2
+  metadata.gz: 6800183f4c4638eb513aa4b4826d5a584bf8b86cbbe99c013f6620594b26f4ce31546504aa5cf5518c4203ec6d54dd57f7d5c6892dc1277993026edcc09efa69
+  data.tar.gz: 1bff2e121df60d98f55e992b73429bc2bd252fe1a7cc306b95f240f792c8e9e6c5c9b50b0b56819e3f3c797c701278f5dea01bfffbfa9914ce60449e2f3147f1

data/README.md

@@ -1,46 +1,54 @@
 # Rapidfire
-[![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 **rails 4.2.0+**, **rails 5** and **rails 6** with **ruby 2.4** and later.
+This gem supports:
 
-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).
+- **rails**: 4.2, 5.0, 5.1, 5.2, 6.0, 6.1 and 7.0
+- **ruby**: 2.4, 2.5, 2.6, 2.7, 3.0, 3.1 and 3.2
+
+NOTE: Some combinations won't be supported. Please check CI for the ignored ones.
+
+A simple implementaiton of this gem can be found at [https://rapidfire.fly.dev](https://rapidfire.fly.dev).
+And the source code of application is [https://github.com/code-mancers/rapidfire-app](https://github.com/code-mancers/rapidfire-app).
 
 ## Installation
-Add this line to your application's Gemfile:
+
+Add this line to application's Gemfile:
 
 ```rb
-    gem 'rapidfire'
+gem 'rapidfire'
 ```
 
 And then execute:
 
 ```shell
-    $ bundle install
-    $ bundle exec rake rapidfire:install:migrations
-    $ bundle exec rake db:migrate
+$ bundle install
+$ bundle exec rake rapidfire:install:migrations
+$ bundle exec rake db:migrate
 ```
 
-And if you want to customize rapidfire views, you can do
+Rapidfire views can also be customized. This command copies the views into `app/views` directory:
 
-    $ bundle exec rails generate rapidfire:views
+```sh
+$ bundle exec rails generate rapidfire:views
+```
 
-If you want to customize rapidfire locales (i18n) files, you can do
+Rapidfire locales (i18n) files can also be customized. The command is:
 
-    $ bundle exec rails generate rapidfire:locales
+```sh
+$ bundle exec rails generate rapidfire:locales
+```
 
 ## Usage
 
-Add this line to your routes will and you will be good to go!
+Add this line to `config/routes.rb` file, thats good enough
 
 ```rb
-    mount Rapidfire::Engine => "/rapidfire"
+mount Rapidfire::Engine => "/rapidfire"
 ```
 
-And point your browser to [http://localhost:3000/rapidfire](http://localhost:3000/rapidfire)
+Please point the browser to [http://localhost:3000/rapidfire](http://localhost:3000/rapidfire)
 
 All rapidfire controllers inherit from your `ApplicationController`. So define 2
 methods `current_user` and `can_administer?` on your `ApplicationController`
@@ -52,19 +60,31 @@ methods `current_user` and `can_administer?` on your `ApplicationController`
 Typical implementation would be:
 
 ```rb
-  class ApplicationController < ActionController::Base
-    def current_user
-      @current_user ||= User.find(session[:user_id])
-    end
-
-    def can_administer?
-      current_user.try(:admin?)
-    end
+class ApplicationController < ActionController::Base
+  def current_user
+    @current_user ||= User.find(session[:user_id])
+  end
+
+  def can_administer?
+    current_user.try(:admin?)
+  end
+end
+```
+
+It also will assume that whatever `current_user` returns above will respond to a method called `survey_name`.
+
+That method should return the name that is associated with the results. For example:
+
+```rb
+class User
+  def survey_name
+    "#{last_name}, #{first_name}"
   end
+end
 ```
 
-If you are using authentication gems like devise, you get `current_user` for free
-and you don't have to define it.
+If the application is using authentication gems like Devise, Devise will automatically provide `current_user`
+helper for free. There is no need to define it
 
 ### Override
 
@@ -80,8 +100,9 @@ end
 ```
 
 ### Routes Information
+
 Once this gem is mounted on, say at 'rapidfire', it generates several routes
-You can see them by running `bundle exec rake routes`.
+They can be listed by running `bundle exec rake routes`.
 
 1. The `root_path` i.e `localhost:3000/rapidfire` always points to list of
    surveys {they are called question groups}. Admin can manage surveys, and
@@ -89,11 +110,11 @@ You can see them by running `bundle exec rake routes`.
 2. Optionally, each survey can by answered by visiting this path:
 
    ```
-     localhost:3000/rapidfire/surveys/<survey-id>/answer_groups/new
+   localhost:3000/rapidfire/surveys/<survey-id>/attempts/new
    ```
 
-   You can distribute this url so that survey takers can answer a particular survey
-   of your interest.
+   This url can be distributed so that survey takers can attempt the survey
+
 3. If you have an established application that uses route helpers and/or the
    `url_for([@model1, @model2])` style, you can include your route helpers in
    RapidFire by adding `config/initializers/rapidfire.rb` with the
@@ -117,18 +138,21 @@ You can see them by running `bundle exec rake routes`.
    ```
 
 ### Survey Results
-A new api is released which helps in seeing results for each survey. The api is:
+
+There is an API for fetching the results. This is not efficient, but is provided for the sake
+of quickly aggregating survey results
 
 ```
-  GET /rapidfire/surveys/<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
-in the format they pleased. An example can be seen [here](https://github.com/code-mancers/rapidfire-demo),
-which uses chart.js to display results.
+
+This new api supports two formats: `html` and `json`. The `json` format can be used with any
+javascript based chart solutions like Chart.js. An example can be seen
+[here](https://github.com/code-mancers/rapidfire-app).
 
 Diving into details of `json` format, all the questions can be categorized into
 one of the two categories:
+
 1. **aggregatable**: questions like checkboxes, selects, radio buttons fall into
    this category.
 2. **non-aggregatable**: questions like long answers, short answers, date, numeric
@@ -140,68 +164,60 @@ output will be like this:
 
 ```json
 [
-{
+  {
     "question_type": "Rapidfire::Questions::Radio",
     "question_text": "Who is author of Waiting for godot?",
     "results": {
-        "Sublime": 1,
-        "Emacs": 1,
-        "Vim": 1
+      "Sublime": 1,
+      "Emacs": 1,
+      "Vim": 1
     }
-},
-{
+  },
+  {
     "question_type": "Rapidfire::Questions::Checkbox",
     "question_text": "Best rock band?",
     "results": {
-        "Led Zeppelin": 2
+      "Led Zeppelin": 2
     }
-},
-{
+  },
+  {
     "question_type": "Rapidfire::Questions::Date",
     "question_text": "When is your birthday?",
-    "results": [
-        "04-02-1983",
-        "01/01/1970"
-    ]
-},
-{
+    "results": ["04-02-1983", "01/01/1970"]
+  },
+  {
     "question_type": "Rapidfire::Questions::Long",
     "question_text": "If Apple made a android phone what it will be called?",
-    "results": [
-        "Idude",
-        "apdroid"
-    ]
-},
-{
+    "results": ["Idude", "apdroid"]
+  },
+  {
     "question_type": "Rapidfire::Questions::Numeric",
     "question_text": "Answer of life, universe and everything?",
-    "results": [
-        "42",
-        "0"
-    ]
-},
-{
+    "results": ["42", "0"]
+  },
+  {
     "question_type": "Rapidfire::Questions::Select",
     "question_text": "Places you want to visit after death",
     "results": {
-        "Iran": 2
+      "Iran": 2
     }
-}
+  }
 ]
 ```
 
 ## How it works
-This gem gives you access to create questions in a groups, something similar to
-survey. Once you have created a group and add questions to it, you can pass
-around the form url where others can answer your questions.
+
+This gem gives on the fly access to create questions under a survey. Once the survey is
+created, questions can be added to the survey. Every survey will have a url which can
+be can passed around to others to take the survey.
 
 The typical flow about how to use this gem is:
 
-1. Create a question group by giving it a name.
-2. Once group is created, you can click on the group which takes you to another
-   page where you can manage questions.
-3. Create a question by clicking on add new, and you will be provided by these
-   options: Each question will have a type
+1. Create a survey by giving it a name.
+2. Once the survey is created, start adding questions to the survey
+3. Create a question by clicking on add new, and there will be several options
+   Each question will have a type
+
    - **Checkbox** Create a question which contains multiple checkboxes with the
      options that you provide in `answer options` field. Note that each option
      should be on a separate line.
@@ -211,8 +227,11 @@ The typical flow about how to use this gem is:
    - **Radio** It renders set of radio buttons by taking answer options.
    - **Select** It renders a dropdown by taking answer options.
    - **Short** It takes a string as an answer. Short answer.
+   - **File** It renders a file input which can take only 1 file.
+   - **MultiFile** It renders a file input which can take multile files.
+
+4. Once the type is filled, optionally other details can be filled:
 
-4. Once the type is filled, you can optionally fill other details like
    - **Question text** What is the question?
    - **Answer options** Give options separated by newline for questions of type
      checkbox, radio buttons or select.
@@ -222,21 +241,29 @@ The typical flow about how to use this gem is:
    - **greater than and less than** Applicable for numeric question where answer
      is validated with these values.
 
-5. Once the questions are populated, you can return to root_path ie by clicking
-   `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.
-
+5. Once the questions are populated, a url will be created which can be shared
+6. Note that answers fail to persist if the criteria provided while creating the
+   questions fail.
 
 ## Notes on upgrading
 
+##### Adding multitenancy support
+
+```shell
+$ rake rapidfire:upgrade:migrations:multitenancy
+```
+
 ##### 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.
+Some table names have changed:
+
+- `rapidfire_question_groups` to `rapidfire_surveys`, and
+- `rapidfire_answer_groups` to `rapidfire_attempts`.
+
+Run this rake task to do this change automatically
 
 ```shell
-    $ rake rapidfire:upgrade:migrations:from210to300
+$ rake rapidfire:upgrade:migrations:from210to300
 ```
 
 ##### Upgrading from 1.2.0 to 2.0.0
@@ -253,33 +280,30 @@ to make existing questions or stored answers to use new delimiter.
 NOTE: Please take database backup before running this rake task.
 
 ```rb
-  bundle exec rake rapidfire:change_delimiter_from_comma_to_srsn
-  bundle exec rake rapidfire:change_delimiter_from_comma_to_srsn
+bundle exec rake rapidfire:change_delimiter_from_comma_to_srsn
+bundle exec rake rapidfire:change_delimiter_from_comma_to_srsn
 ```
 
-
-If you dont want to make this change rightaway, and would like to use comma
+If this change is not feasible rightaway, and the application needs to use comma
 as delimiter, then please use this initializer, but be warned that in future
 delimiter will be hardcoded to `\r\n`:
 
-
 ```rb
-  # /<path-to-app>/config/initializers/rapidfire.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.
 
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
+2. Create a feature branch (`git checkout -b my-new-feature`)
+3. Commit all the changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request

data/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/app/controllers/rapidfire/application_controller.rb

@@ -14,8 +14,12 @@ module Rapidfire
 
     # Override prefixes to consider the scoped.
     # for method current_user
-    def scoped
-      :user
+    def rapidfire_scoped
+      if !defined?(super)
+        :user
+      else
+        super
+      end
     end
   end
 end

data/app/controllers/rapidfire/attempts_controller.rb

@@ -42,7 +42,7 @@ module Rapidfire
 
     def attempt_params
       answer_params = { params: (params[:attempt] || {}) }
-      answer_params.merge(user: current_user, survey: @survey, attempt_id: params[:id])
+      answer_params.merge(user: rapidfire_current_scoped, survey: @survey, attempt_id: params[:id])
     end
 
     def attempt_params_for_find
@@ -68,7 +68,7 @@ module Rapidfire
     end
 
     def rapidfire_current_scoped
-      send 'current_'+scoped.to_s
+      send 'current_' + rapidfire_scoped.to_s
     end
   end
 end

data/app/controllers/rapidfire/questions_controller.rb

@@ -55,7 +55,7 @@ module Rapidfire
     end
 
     def find_survey!
-      @survey = Survey.find(params[:survey_id])
+      @survey = Rapidfire::Survey.find(params[:survey_id])
     end
 
     def find_question!

data/app/controllers/rapidfire/surveys_controller.rb

@@ -3,19 +3,30 @@ module Rapidfire
     before_action :authenticate_administrator!, except: :index
 
     def index
-      @surveys = if defined?(Kaminari)
-        Survey.page(params[:page])
-      else
-        Survey.all
-      end
+      @surveys = Rapidfire::Survey.all
+      @surveys = @surveys.page(params[:page]) if defined?(Kaminari)
+      @surveys
     end
 
     def new
-      @survey = Survey.new
+      @survey = Rapidfire::Survey.new
     end
 
     def create
-      @survey = Survey.new(survey_params)
+      source_survey = nil
+      if params[:copy_survey_id]
+        source_survey = Rapidfire::Survey.find(params[:copy_survey_id])
+        params[:survey] = source_survey.attributes.except(*%w(created_at updated_at id))
+        params[:survey][:name] = "Copy of #{params[:survey][:name]}"
+      end
+      @survey = Rapidfire::Survey.new(survey_params)
+
+      if source_survey
+        source_survey.questions.each do |q|
+          @survey.questions << q.dup
+        end
+      end
+
       if @survey.save
         respond_to do |format|
           format.html { redirect_to surveys_path }
@@ -30,11 +41,11 @@ module Rapidfire
     end
 
     def edit
-      @survey = Survey.find(params[:id])
+      @survey = Rapidfire::Survey.find(params[:id])
     end
 
     def update
-      @survey = Survey.find(params[:id])
+      @survey = Rapidfire::Survey.find(params[:id])
       if @survey.update(survey_params)
         respond_to do |format|
           format.html { redirect_to surveys_path }
@@ -49,7 +60,7 @@ module Rapidfire
     end
 
     def destroy
-      @survey = Survey.find(params[:id])
+      @survey = Rapidfire::Survey.find(params[:id])
       @survey.destroy
 
       respond_to do |format|
@@ -59,21 +70,27 @@ module Rapidfire
     end
 
     def results
-      @survey = Survey.find(params[:id])
+      params[:filter] ||= {}
+      @survey = Rapidfire::Survey.find(params[:id])
       @survey_results =
-        SurveyResults.new(survey: @survey).extract
+        SurveyResults.new(survey: @survey).extract(filter_params)
 
       respond_to do |format|
         format.json { render json: @survey_results, root: false }
         format.html
         format.js
+        format.csv { send_data(@survey.results_to_csv(filter_params)) }
       end
     end
 
     private
 
     def survey_params
-      params.require(:survey).permit(:name, :introduction, :after_survey_content)
+      params.require(:survey).permit(:name, :introduction, :after_survey_content, :active)
+    end
+
+    def filter_params
+      params[:filter].permit({ question_ids: [], options: []})
     end
   end
 end

data/app/helpers/rapidfire/application_helper.rb

@@ -11,5 +11,30 @@ module Rapidfire
       answers.include?(option)
     end
 
+    def filter_link(question_id, option)
+      question_id = question_id.to_s
+      option = option.to_s
+
+      this_filter = {
+        question_ids: (params.dig(:filter, :question_ids) || []).map(&:to_s),
+        options: (params.dig(:filter, :options) || []).map(&:to_s)
+      }
+
+      if this_filter[:question_ids].include?(question_id) && this_filter[:options].include?(option)
+        question_index = this_filter[:question_ids].index(question_id)
+        this_filter[:question_ids].delete_at(question_index) if question_index
+
+        option_index = this_filter[:options].index(option)
+        this_filter[:options].delete_at(option_index) if option_index
+
+        action_description = "Remove from"
+      else
+        this_filter[:question_ids] << question_id
+        this_filter[:options] << option
+        action_description = "Add to"
+      end
+
+      link_to "#{action_description} Filter", filter: this_filter
+    end
   end
 end

data/app/models/rapidfire/answer.rb

@@ -1,11 +1,16 @@
 module Rapidfire
-  class Answer < ActiveRecord::Base
+  class Answer < ApplicationRecord
     belongs_to :question
     belongs_to :attempt, inverse_of: :answers
 
     validates :question, :attempt, presence: true
     validate  :verify_answer_text
 
+    if "#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}" >= "5.2"
+      has_one_attached :file
+      has_many_attached :files
+    end
+
     private
 
     def verify_answer_text

data/app/models/rapidfire/attempt.rb

@@ -1,5 +1,5 @@
 module Rapidfire
-  class Attempt < ActiveRecord::Base
+  class Attempt < ApplicationRecord
     belongs_to :survey
     has_many   :answers, inverse_of: :attempt, autosave: true
 

data/app/models/rapidfire/question.rb

@@ -1,11 +1,12 @@
 module Rapidfire
-  class Question < ActiveRecord::Base
+  class Question < ApplicationRecord
     belongs_to :survey, :inverse_of => :questions
     has_many   :answers
 
     default_scope { order(:position) }
 
     validates :survey, :question_text, :presence => true
+    validate :type_can_change
     serialize :validation_rules
 
     def self.inherited(child)
@@ -19,14 +20,37 @@ module Rapidfire
     end
 
     def rules
-      validation_rules || {}
+      validation_rules.present? ? validation_rules.symbolize_keys : {}
+    end
+
+    def validation_rules=(val)
+      super(val.stringify_keys)
     end
 
     # answer will delegate its validation to question, and question
     # will inturn add validations on answer on the fly!
     def validate_answer(answer)
       if rules[:presence] == "1"
-        answer.validates_presence_of :answer_text
+        case self
+        when Rapidfire::Questions::File
+          if Rails::VERSION::MAJOR >= 6
+            answer.validates_presence_of :file
+          else
+            if !answer.file.attached?
+              answer.errors.add(:file, :blank)
+            end
+          end
+        when Rapidfire::Questions::MultiFile
+          if Rails::VERSION::MAJOR >= 6
+            answer.validates_presence_of :files
+          else
+            if !answer.files.attached?
+              answer.errors.add(:files, :blank)
+            end
+          end
+        else
+          answer.validates_presence_of :answer_text
+        end
       end
 
       if rules[:minimum].present? || rules[:maximum].present?
@@ -36,5 +60,11 @@ module Rapidfire
         answer.validates_length_of :answer_text, min_max
       end
     end
+
+    def type_can_change
+      if type_changed? && answers.any?
+        errors.add(:type, "cannot change after answers have been added")
+      end
+    end
   end
 end

data/app/models/rapidfire/questions/checkbox.rb

@@ -14,7 +14,7 @@ module Rapidfire
         super(answer)
 
         if rules[:presence] == "1" || answer.answer_text.present?
-          answer.answer_text.split(Rapidfire.answers_delimiter).each do |value|
+          answer.answer_text.to_s.split(Rapidfire.answers_delimiter).each do |value|
             answer.errors.add(:answer_text, :invalid) unless options.include?(value)
           end
         end

data/app/models/rapidfire/questions/file.rb

@@ -0,0 +1,6 @@
+module Rapidfire
+  module Questions
+    class File < Rapidfire::Question
+    end
+  end
+end

data/app/models/rapidfire/questions/information.rb

@@ -0,0 +1,6 @@
+module Rapidfire
+  module Questions
+    class Information < Rapidfire::Question
+    end
+  end
+end

data/app/models/rapidfire/questions/multi_file.rb

@@ -0,0 +1,6 @@
+module Rapidfire
+  module Questions
+    class MultiFile < Rapidfire::Question
+    end
+  end
+end