effective_questions 0.0.2

data/app/views/admin/questions/_form.html.haml

@@ -0,0 +1,133 @@
+= effective_form_with(model: [:admin, question], engine: true) do |f|
+  - if inline_datatable?
+    = f.hidden_field :questionable_type
+    = f.hidden_field :questionable_id
+  - else
+    %P TODO
+
+  -# Follow up
+  - if inline_datatable? && (original = f.object.question).present?
+    = f.hidden_field :follow_up, value: true
+    = f.hidden_field :question_id
+
+    .mb-3.card
+      .card-body
+        %h5 Follow up Question
+        %p.text-muted This question will only appear when they answer the above question with the following value:
+
+        - if original.question_option?
+          = f.select :question_option_id, original.question_options, label: 'Answer required to display this question'
+        - else
+          = f.text_field :follow_up_value, label: 'Answer required to display this question', required: true, hint: 'Enter the exact answer value that should trigger this question to appear'
+
+  = f.text_field :title, label: 'Question Title'
+
+  - if defined?(EffectiveArticleEditor)
+    = f.article_editor :body, label: 'Body (optional)'
+  - else
+    = f.rich_text_area :body, label: 'Body (optional)'
+
+  = f.check_box :required, hint: 'A response to this question will be required'
+  = f.select :category, Effective::Question::CATEGORIES
+
+  = f.show_if :category, 'Choose one' do
+    .mt-3.card
+      .card-body
+        %h5 Choose one
+        %p Display radio buttons to select one option
+
+  = f.show_if :category, 'Select all that apply' do
+    .card
+      .card-body
+        %h5 Select all that apply
+        %p Display checkboxes to select all options that apply
+
+  = f.show_if :category, 'Select up to 1' do
+    .card
+      .card-body
+        %h5 Select up to 1 (one)
+        %p Display checkboxes to select up to 1 option
+
+  = f.show_if :category, 'Select up to 2' do
+    .card
+      .card-body
+        %h5 Select up to 2 (two)
+        %p Display checkboxes to select up to 2 options
+
+  = f.show_if :category, 'Select up to 3' do
+    .card
+      .card-body
+        %h5 Select up to 3 (three)
+        %p Display checkboxes to select up to 3 options
+
+  = f.show_if :category, 'Select up to 4' do
+    .card
+      .card-body
+        %h5 Select up to 4 (four)
+        %p Display checkboxes to select up to 4 options
+
+  = f.show_if :category, 'Select up to 5' do
+    .card
+      .card-body
+        %h5 Select up to 5 (five)
+        %p Display checkboxes to select up to 5 options
+
+  = f.show_if :category, 'Short Answer' do
+    .card
+      .card-body
+        %h5 Short Answer
+        %p Display a text field to enter a short text answer
+
+  = f.show_if :category, 'Long Answer' do
+    .card
+      .card-body
+        %h5 Long Answer
+        %p Display a textarea to enter a long text answer
+
+  = f.show_if :category, 'Date' do
+    .card
+      .card-body
+        %h5 Date
+        %p Display a date field to enter a date
+
+  = f.show_if :category, 'Email' do
+    .card
+      .card-body
+        %h5 Email
+        %p Display an email field to enter an email
+
+  = f.show_if :category, 'Number' do
+    .card
+      .card-body
+        %h5 Number
+        %p Display a number field to enter an integer number
+
+  = f.show_if :category, 'Upload File' do
+    .card
+      .card-body
+        %h5 Upload File
+        %p Display a file field to upload a file
+
+  = f.show_if_any :category, Effective::Question::WITH_OPTIONS_CATEGORIES do
+    .mt-3.card
+      .card-body
+        %h5 Options
+        %p Display the following options:
+
+        = f.has_many :question_options, class: 'tight' do |fa|
+          = fa.text_field :title, label: false
+
+  = effective_submit(f)
+
+- unless question.follow_up?
+  %h2 Follow up questions
+
+  - if Effective::Question::UNSUPPORTED_FOLLOW_UP_QUESTION_CATEGORIES.include?(question.category)
+    %p.text-muted 
+      %em Follow up questions are not supported for the #{question.category} question category
+  - elsif question.new_record?
+    %p.text-muted 
+      %em Please save this question to add follow up questions
+  - else
+    %p Display follow up question(s) based on the answer to this question:
+    = render_inline_datatable Admin::EffectiveQuestionsDatatable.new(follow_up: true, question: question)

data/app/views/effective/questionable/_result.html.haml

@@ -0,0 +1,2 @@
+- partial = 'effective/questionable/results/' + question.category_partial
+= render(partial, question: question, responses: responses)

data/app/views/effective/questionable/_results.html.haml

@@ -0,0 +1,31 @@
+- # The grouped results for an entire questionable resource
+.questionable-results
+  %table.table.table-hover
+    %thead
+      %tr
+        %th Question
+        %th Results
+
+    %tbody
+      - questionable.questions.top_level.each_with_index do |question, index|
+        - responses = questionable.completed_responses(question: question)
+
+        %tr
+          %td
+            #{index + 1}. #{question}
+            %br
+            %small.text-muted= question.category
+
+          %td= render('effective/questionable/result', question: question, responses: responses)
+
+        - question.follow_up_questions.each_with_index do |follow_up_question, index|
+          - responses = questionable.completed_responses(question: follow_up_question)
+
+          %tr
+            %td
+              .ml-4
+                #{('a'.ord + index).chr}. #{follow_up_question}
+                %br
+                %small.text-muted= follow_up_question.category
+
+            %td= render('effective/questionable/result', question: follow_up_question, responses: responses)

data/app/views/effective/questionable/results/_choose_one.html.haml

@@ -0,0 +1,2 @@
+- partial = 'effective/questionable/results/question_option'
+= render(partial, question: question, responses: responses)

data/app/views/effective/questionable/results/_date.html.haml

@@ -0,0 +1,14 @@
+- sorted = responses.sort { |a, b| (a.date || Time.zone.now.end_of_year) <=> (b.date || Time.zone.now.end_of_year) }
+
+- sorted.group_by { |br| br.response }.each do |response, selected|
+  - count = selected.length
+  - total = responses.length
+  - percent = (total.zero? ? 0 : ((count * 100.0) / total).round)
+
+  .questionable-result-option
+    .d-flex
+      .mr-auto= response.blank? ? 'None of the Above' : response.strftime('%F')
+      .text-muted #{count} (#{percent}%)
+
+    .progress.mb-3
+      .progress-bar{role: 'progressbar', 'aria-valuenow': count, 'aria-valuemin': 0, 'aria-valuemax': total, style: "width: #{percent}%"}

data/app/views/effective/questionable/results/_email.html.haml

@@ -0,0 +1,14 @@
+- sorted = responses.sort { |a, b| (a.email || '') <=> (b.email || '') }
+
+- sorted.group_by { |br| br.response }.each do |response, selected|
+  - count = selected.length
+  - total = responses.length
+  - percent = (total.zero? ? 0 : ((count * 100.0) / total).round)
+
+  .questionable-result-option
+    .d-flex
+      .mr-auto= response.blank? ? 'None of the Above' : response
+      .text-muted #{count} (#{percent}%)
+
+    .progress.mb-3
+      .progress-bar{role: 'progressbar', 'aria-valuenow': count, 'aria-valuemin': 0, 'aria-valuemax': total, style: "width: #{percent}%"}

data/app/views/effective/questionable/results/_long_answer.html.haml

@@ -0,0 +1,2 @@
+- responses.select { |br| br.long_answer.present? }.each do |response|
+  .questionable-result-long-answer= response.response

data/app/views/effective/questionable/results/_number.html.haml

@@ -0,0 +1,14 @@
+- sorted = responses.sort { |a, b| (a.number || 999999999) <=> (b.number || 999999999) }
+
+- sorted.group_by { |br| br.response }.each do |response, selected|
+  - count = selected.length
+  - total = responses.length
+  - percent = (total.zero? ? 0 : ((count * 100.0) / total).round)
+
+  .questionable-result-option
+    .d-flex
+      .mr-auto= response.blank? ? 'None of the Above' : response
+      .text-muted #{count} (#{percent}%)
+
+    .progress.mb-3
+      .progress-bar{role: 'progressbar', 'aria-valuenow': count, 'aria-valuemin': 0, 'aria-valuemax': total, style: "width: #{percent}%"}

data/app/views/effective/questionable/results/_question_option.html.haml

@@ -0,0 +1,17 @@
+- (question.question_options + [nil]).each do |question_option|
+  - selected = responses.select { |br| br.response.blank? } if question_option.blank?
+  - selected ||= responses.select { |br| Array(br.response).include?(question_option) }
+
+  - count = selected.length
+  - total = responses.length
+  - percent = (total.zero? ? 0 : ((count * 100.0) / total).round)
+
+  - next if question_option.blank? && count == 0
+
+  .questionable-result-option
+    .d-flex
+      .mr-auto= question_option.blank? ? 'None of the Above' : question_option
+      .text-muted #{count} (#{percent}%)
+
+    .progress.mb-3
+      .progress-bar{role: 'progressbar', 'aria-valuenow': count, 'aria-valuemin': 0, 'aria-valuemax': total, style: "width: #{percent}%"}

data/app/views/effective/questionable/results/_select_all_that_apply.html.haml

@@ -0,0 +1,2 @@
+- partial = 'effective/questionable/results/question_option'
+= render(partial, question: question, responses: responses)

data/app/views/effective/questionable/results/_select_up_to_1.html.haml

@@ -0,0 +1,2 @@
+- partial = 'effective/questionable/results/question_option'
+= render(partial, question: question, responses: responses)

data/app/views/effective/questionable/results/_select_up_to_2.html.haml

@@ -0,0 +1,2 @@
+- partial = 'effective/questionable/results/question_option'
+= render(partial, question: question, responses: responses)

data/app/views/effective/questionable/results/_select_up_to_3.html.haml

@@ -0,0 +1,2 @@
+- partial = 'effective/questionable/results/question_option'
+= render(partial, question: question, responses: responses)

data/app/views/effective/questionable/results/_select_up_to_4.html.haml

@@ -0,0 +1,2 @@
+- partial = 'effective/questionable/results/question_option'
+= render(partial, question: question, responses: responses)

data/app/views/effective/questionable/results/_select_up_to_5.html.haml

@@ -0,0 +1,2 @@
+- partial = 'effective/questionable/results/question_option'
+= render(partial, question: question, responses: responses)

data/app/views/effective/questionable/results/_short_answer.html.haml

@@ -0,0 +1,2 @@
+- responses.select { |br| br.short_answer.present? }.each do |response|
+  .questionable-result-short-answer= response.response

data/app/views/effective/questionable/results/_upload_file.html.haml

@@ -0,0 +1,3 @@
+- responses.select { |br| br.response&.attached? }.each do |response|
+  .questionable-result-upload-file
+    = link_to(response.response.filename, url_for(response.response), target: '_blank')

data/app/views/effective/questions/_question.html.haml

@@ -0,0 +1,6 @@
+.effective-question
+  Question ##{question.position + 1}:
+  = question
+
+  - if question.body.present?
+    .mt-4= question.body.to_s

data/app/views/effective/responsable/_fields.html.haml

@@ -0,0 +1,19 @@
+- raise("expected an acts_as_responsable resource") unless responsable.class.try(:acts_as_responsable?)
+- raise("expected an acts_as_questionable resource") unless questionable.class.try(:acts_as_questionable?)
+
+- questionable.questions.top_level.deep.each do |question|
+  - response = responsable.response(question: question)
+
+  = f.fields_for :responses, response do |fbr|
+    = render('/effective/responses/fields', f: fbr, question: question)
+
+    - question.follow_up_questions.each do |follow_up|
+      - response = responsable.response(question: follow_up)
+
+      = fbr.show_if(question.show_if_attribute, follow_up.show_if_value) do
+        = f.fields_for :responses, response do |fbr|
+          = render('/effective/responses/fields', f: fbr, question: follow_up)
+
+      = fbr.hide_if(question.show_if_attribute, follow_up.show_if_value) do
+        = f.fields_for :responses, response do |fbr|
+          = fbr.hidden_field :_destroy, value: true

data/app/views/effective/responsable/_results.html.haml

@@ -0,0 +1,23 @@
+- # The individiaual responses for one resonsable resource
+.responsable-results
+  %table.table.table-hover
+    %thead
+      %tr
+        %th Question
+        %th Response
+
+    %tbody
+      - questionable.questions.top_level.deep.each do |question|
+        - response = responsable.response(question: question)
+
+        %tr
+          %td= question
+          %td= render('effective/responses/response', response: response)
+
+        - question.follow_up_questions.deep.each do |follow_up_question|
+          - response = responsable.response(question: follow_up_question)
+
+          - if response.persisted?
+            %tr
+              %td= follow_up_question
+              %td= render('effective/responses/response', response: response)

data/app/views/effective/responses/_fields.html.haml

@@ -0,0 +1,15 @@
+.row
+  .col
+    %h3= question
+    %p.text-muted.mb-2= question.category
+
+    - if question.body.present?
+      .mb-3= question.body
+
+    = f.hidden_field :questionable_type
+    = f.hidden_field :questionable_id
+    = f.hidden_field :question_id
+
+    - response = f.object
+    - partial = 'effective/responses/fields/' + question.category_partial
+    = render(partial, f: f, response: response, question: question)

data/app/views/effective/responses/_response.html.haml

@@ -0,0 +1,2 @@
+- partial = 'effective/responses/responses/' + response.category_partial
+= render(partial, response: response)

data/app/views/effective/responses/fields/_choose_one.html.haml

@@ -0,0 +1 @@
+= f.radios :question_option_ids, question.question_options, label: false, required: question.required?

data/app/views/effective/responses/fields/_date.html.haml

@@ -0,0 +1,2 @@
+.row
+  .col-sm-6= f.date_field :date, label: false, required: question.required?

data/app/views/effective/responses/fields/_email.html.haml

@@ -0,0 +1,2 @@
+.row
+  .col-sm-6= f.email_field :email, label: false, required: question.required?

data/app/views/effective/responses/fields/_long_answer.html.haml

@@ -0,0 +1 @@
+= f.text_area :long_answer, label: false, required: question.required?

data/app/views/effective/responses/fields/_number.html.haml

@@ -0,0 +1,2 @@
+.row
+  .col-sm-6= f.number_field :number, label: false, required: question.required?

data/app/views/effective/responses/fields/_select_all_that_apply.html.haml

@@ -0,0 +1 @@
+= f.checks :question_option_ids, question.question_options, label: false, required: question.required?

data/app/views/effective/responses/fields/_select_up_to_1.html.haml

@@ -0,0 +1 @@
+= f.checks :question_option_ids, question.question_options, label: false, actions: false, required: question.required?

data/app/views/effective/responses/fields/_select_up_to_2.html.haml

@@ -0,0 +1 @@
+= f.checks :question_option_ids, question.question_options, label: false, actions: false, required: question.required?

data/app/views/effective/responses/fields/_select_up_to_3.html.haml

@@ -0,0 +1 @@
+= f.checks :question_option_ids, question.question_options, label: false, actions: false, required: question.required?

data/app/views/effective/responses/fields/_select_up_to_4.html.haml

@@ -0,0 +1 @@
+= f.checks :question_option_ids, question.question_options, label: false, actions: false, required: question.required?

data/app/views/effective/responses/fields/_select_up_to_5.html.haml

@@ -0,0 +1 @@
+= f.checks :question_option_ids, question.question_options, label: false, actions: false, required: question.required?

data/app/views/effective/responses/fields/_short_answer.html.haml

@@ -0,0 +1 @@
+= f.text_field :short_answer, label: false, required: question.required?

data/app/views/effective/responses/fields/_upload_file.html.haml

@@ -0,0 +1,2 @@
+- # Always required false here because we'll handle the logic in the response model
+= f.file_field :upload_file, label: false, required: false

data/app/views/effective/responses/responses/_choose_one.html.haml

@@ -0,0 +1 @@
+= response.response.presence || '-'

data/app/views/effective/responses/responses/_date.html.haml

@@ -0,0 +1 @@
+= response.response&.strftime('%F') || '-'

data/app/views/effective/responses/responses/_email.html.haml

@@ -0,0 +1 @@
+= response.response.present? ? mail_to(response.response) : '-'

data/app/views/effective/responses/responses/_long_answer.html.haml

@@ -0,0 +1 @@
+= response.response.presence || '-'

data/app/views/effective/responses/responses/_number.html.haml

@@ -0,0 +1 @@
+= response.response.presence || '-'

data/app/views/effective/responses/responses/_select_all_that_apply.html.haml

@@ -0,0 +1,5 @@
+- response.response.each do |question_option|
+  %div= question_option.title
+
+- if response.response.blank?
+  = '-'

data/app/views/effective/responses/responses/_select_up_to_1.html.haml

@@ -0,0 +1 @@
+= response.response&.title || '-'

data/app/views/effective/responses/responses/_select_up_to_2.html.haml

@@ -0,0 +1,5 @@
+- response.response.each do |question_option|
+  %div= question_option.title
+
+- if response.response.blank?
+  = '-'

data/app/views/effective/responses/responses/_select_up_to_3.html.haml

@@ -0,0 +1,5 @@
+- response.response.each do |question_option|
+  %div= question_option.title
+
+- if response.response.blank?
+  = '-'

data/app/views/effective/responses/responses/_select_up_to_4.html.haml

@@ -0,0 +1,5 @@
+- response.response.each do |question_option|
+  %div= question_option.title
+
+- if response.response.blank?
+  = '-'

data/app/views/effective/responses/responses/_select_up_to_5.html.haml

@@ -0,0 +1,5 @@
+- response.response.each do |question_option|
+  %div= question_option.title
+
+- if response.response.blank?
+  = '-'

data/app/views/effective/responses/responses/_short_answer.html.haml

@@ -0,0 +1 @@
+= response.response.presence || '-'

data/app/views/effective/responses/responses/_upload_file.html.haml

@@ -0,0 +1,4 @@
+- if response.response&.attached?
+  = link_to(response.response.filename, url_for(response.response), target: '_blank')
+- else
+  = '-'

data/config/effective_questions.rb

@@ -0,0 +1,5 @@
+EffectiveQuestions.setup do |config|
+  # Layout Settings
+  # Configure the Layout per controller, or all at once
+  # config.layout = { application: 'application', admin: 'admin' }
+end

data/config/locales/effective_questions.yml

@@ -0,0 +1,11 @@
+en:
+  effective_questions:
+    name: 'Questions and Responses'
+    acronym: 'Questions'
+
+  activerecord:
+    models:
+      effective/question: 'Question'
+      effective/question_option: 'Question Option'
+      effective/response: 'Response'
+      effective/response_option: 'Response Option'

data/config/routes.rb

@@ -0,0 +1,13 @@
+Rails.application.routes.draw do
+  mount EffectiveQuestions::Engine => '/', as: 'effective_questions'
+end
+
+EffectiveQuestions::Engine.routes.draw do
+  scope module: 'effective' do
+  end
+
+  namespace :admin do
+    resources :questions, except: [:show]
+  end
+
+end

data/db/migrate/101_create_effective_questions.rb

@@ -0,0 +1,60 @@
+class CreateEffectiveQuestions < ActiveRecord::Migration[6.0]
+  def change
+    create_table :questions do |t|
+      t.integer :questionable_id
+      t.string :questionable_type
+
+      t.string :title
+      t.string :category
+      t.boolean :required, default: true
+
+      t.integer :position
+
+      t.boolean :follow_up, default: false
+      t.string :follow_up_value
+
+      t.integer :question_id
+      t.integer :question_option_id
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    create_table :question_options do |t|
+      t.references :question, polymorphic: false
+
+      t.string :title
+      t.integer :position
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    create_table :responses do |t|
+      t.integer :questionable_id
+      t.string :questionable_type
+
+      t.integer :responsable_id
+      t.string :responsable_type
+
+      t.integer :question_id
+
+      t.date :date
+      t.string :email
+      t.integer :number
+      t.text :long_answer
+      t.text :short_answer
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    create_table :response_options do |t|
+      t.integer :response_id
+      t.integer :question_option_id
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,15 @@
+puts "Running effective_questions seeds"
+
+def build_question(questionable, category)
+  questions = Array(category).map.with_index do |category, index|
+    question = questionable.questions.build(title: "#{category} Question ##{index+1}", category: category)
+
+    if question.question_option?
+      question.question_options.build(title: 'Option A')
+      question.question_options.build(title: 'Option B')
+      question.question_options.build(title: 'Option C')
+    end
+  end
+
+  questions.length == 1 ? questions.first : questions
+end

data/lib/effective_questions/engine.rb

@@ -0,0 +1,19 @@
+module EffectiveQuestions
+  class Engine < ::Rails::Engine
+    engine_name 'effective_questions'
+
+    # Set up our default configuration options.
+    initializer 'effective_questions.defaults', before: :load_config_initializers do |app|
+      eval File.read("#{config.root}/config/effective_questions.rb")
+    end
+
+    # Include concerns and allow any ActiveRecord object to call it
+    initializer 'effective_questions.active_record' do |app|
+      app.config.to_prepare do
+        ActiveRecord::Base.extend(ActsAsQuestionable::Base)
+        ActiveRecord::Base.extend(ActsAsResponsable::Base)
+      end
+    end
+
+  end
+end

data/lib/effective_questions/version.rb

@@ -0,0 +1,3 @@
+module EffectiveQuestions
+  VERSION = '0.0.2'
+end

data/lib/effective_questions.rb

@@ -0,0 +1,13 @@
+require 'effective_resources'
+require 'effective_datatables'
+require 'effective_questions/engine'
+require 'effective_questions/version'
+
+module EffectiveQuestions
+
+  def self.config_keys
+    [ :layout ]
+  end
+
+  include EffectiveGem
+end

data/lib/generators/effective_questions/install_generator.rb

@@ -0,0 +1,28 @@
+module EffectiveQuestions
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc 'Creates an EffectiveQuestions initializer in your application.'
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      def self.next_migration_number(dirname)
+        if not ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          '%.3d' % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def copy_initializer
+        template ('../' * 3) + 'config/effective_questions.rb', 'config/initializers/effective_questions.rb'
+      end
+
+      def create_migration_file
+        migration_template ('../' * 3) + 'db/migrate/101_create_effective_questions.rb', 'db/migrate/create_effective_questions.rb'
+      end
+
+    end
+  end
+end