surveyor_gui 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01ff64c99fbe1b160d2a285be9d7542b78ae1475
-  data.tar.gz: 5446a1b7ec3ed1a52075fe7581f303930c61b518
+  metadata.gz: 289785dc295cf459338fa764ccab75b77eb5a5f5
+  data.tar.gz: 856577a30296bc7a4db424363578859d95667e64
 SHA512:
-  metadata.gz: 7483d8876d1d10aa8b685ae2f554443d5c3912b7af468a086f260adf0fc6de5d4579c1ed9799140b04bfd8a9c7e5d96223a575e2353640d2e21562d9c5142db0
-  data.tar.gz: 8d7b4471e2a80f408842d765bc1421c233a0bc6ea6180f4fa66dac81e2bd5b21fc0f0ce839046e1fd10e11736f0c0c513ae94ff1eda8b5a4b13ec715eaf198bf
+  metadata.gz: 2fcbec126c907ee557bcca03d509f218631c185aa5bfecfeb778203f15051eff8432cf0bf23b6dbd87fdf3d68dee88d262519eac27dd8f2cb9ef90ae666e7163
+  data.tar.gz: 213a50cc096022c92529a88e6f50e00e1d1dc85a843f066330dd793955e1b1e4008b711cb1c5746b7d6ffe2176e5b0efbe4ee0765444f974c7215c01f7547d20

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+History for Surveyor
+====================
+
+0.1.0
+------
+
+### Features
+
+- This gem is now a mountable engine and uses isolate_namespace.
+
+### Fixes
+
+- Fixes error on preview report in which no users are shown and report data is empty.  Will now show fake user names.
+- Fixes error on preview response and show response when dependencies are set. Also shows correct user name on reponse
+  index.
+
+0.0.3
+------
+
+### Features
+
+- Official support for Rails 4.0.  Will work generally work with 4.1 but, Surveyor, a critical dependency, is not officially supported on 4.1.
+
+- Supports survey creation and reporting.
+
+- Provides preview of how surveys and reports will look as you are building a survey.
+
+### Fixes
+
+
+### Infrastructure
+

data/README.md

@@ -11,7 +11,9 @@ Surveyor_gui meets this need by providing a gui to create surveys from scratch.
 
 Surveyor is feature-rich and can create very complex surveys.  Surveyor-gui supports most of the features in Surveyor.
 
-This gem will also provide a reporting capability for Surveyor.
+This gem also provides a reporting capability for Surveyor.
+
+Surveyor_gui is a mountable engine.
 
 ## Requirements
 
@@ -86,6 +88,9 @@ This gem enforces locking on surveys.  A survey may be modified up until a user
 can no longer be edited for structural changes (i.e., /surveyform/edit will not permit any changes).  This protects the
 data integrity of the survey response data.
 
+If you want to unlock a survey, you will need to manually delete all of the child ResponseSet records (e.g.,
+Survey.find(1).response_set.all.each{|r| r.destroy} ). Use appropriate caution!
+
 ## Templates
 
 Surveys may be saved as templates.  This allows them to be cloned when creating a new survey (cloning is a pending feature).  It is
@@ -156,4 +161,19 @@ If you wanted the users full name, you could add something like this:
 
     @user ? @user.last_name + ', ' + @user.first_name : nil
 
-Note that SurveyorGui controllers expect to use surveyor_gui's own layout view, surveyor_gui_default.rb.  A copy will be placed in your application's app/views/layouts directory.  You may need edit it for various reasons, such as adding a Devise login/logout link.
+Note that SurveyorGui controllers expect to use surveyor_gui's own layout view, surveyor_gui_default.rb.  A copy will be placed in your application's app/views/layouts directory.  You may need edit it for various reasons, such as adding a Devise login/logout link.  Keep in mind that surveyor_gui works in an isolated namespace, so devise helpers need to be namespaced to the main app. That means that any view local to surveyor_gui would need to refer to Devise's new_user_registration_path as main_app.new_user_registration_path.  If you wanted to add a login/logout link to the surveyor_gui_default layout, you might add something like this:
+
+    <% if user_signed_in? %>
+      Logged in as <strong><%= current_user.email %></strong>.
+      <%= link_to 'Edit profile', main_app.edit_user_registration_path %> |
+      <%= link_to "Logout", main_app.destroy_user_session_path, method: :delete %>
+    <% else %>
+      <%= link_to "Sign up", main_app.new_user_registration_path %> |
+      <%= link_to "Login", main_app.new_user_session_path %>
+    <% end %>
+
+
+## Surveyor
+
+Please take a look at the NUBIC/surveyor on github.  The README.doc file will help you to understand how the surveyor engine works.  Also, the wiki has a very useful data diagram that will help you to grasp the data
+structure of the surveys and responses.

data/app/controllers/surveyor_gui/answers_controller.rb

@@ -0,0 +1,3 @@
+class SurveyorGui::AnswersController < ApplicationController
+  layout 'surveyor_gui/surveyor_gui_blank'
+end

data/app/controllers/surveyor_gui/application_controller.rb

@@ -0,0 +1,3 @@
+class SurveyorGui::ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/app/controllers/{dependencys_controller.rb → surveyor_gui/dependencys_controller.rb}

@@ -1,5 +1,5 @@
-class DependencysController < ApplicationController
-  layout 'surveyor_gui_blank'
+class SurveyorGui::DependencysController < ApplicationController
+  layout 'surveyor_gui/surveyor_gui_blank'
 
   def new
     prep_variables
@@ -21,7 +21,7 @@ class DependencysController < ApplicationController
     if @question.save
       redirect_to :back
     else
-      render :action => 'new', :layout => 'surveyor_gui_blank'
+      render :action => 'new', :layout => 'surveyor_gui/surveyor_gui_blank'
     end
   end
 
@@ -37,10 +37,10 @@ class DependencysController < ApplicationController
     end
     if update_object.update_attributes(update_params)
       update_object.dependency.destroy if update_object.dependency.dependency_conditions.blank?
-      render :blank, :layout => 'surveyor_gui_blank'
+      render :blank, :layout => 'surveyor_gui/surveyor_gui_blank'
     else
       prep_variables
-      render :action => 'edit', :layout => 'surveyor_gui_blank'
+      render :action => 'edit', :layout => 'surveyor_gui/surveyor_gui_blank'
     end
   end
 

data/app/controllers/{question_groups_controller.rb → surveyor_gui/question_groups_controller.rb}

@@ -1,8 +1,9 @@
-class QuestionGroupsController < ApplicationController
+class SurveyorGui::QuestionGroupsController < ApplicationController
+  layout 'surveyor_gui/surveyor_gui_blank'
 
   def new
     @title = "Add Question"
-    @survey_section_id = params[:survey_section_id]
+    @survey_section_id = question_params[:survey_section_id]
     @question_group = QuestionGroup.new(
       text: params[:text], 
       question_type_id: params[:question_type_id])
@@ -25,7 +26,8 @@ class QuestionGroupsController < ApplicationController
     @title = "Edit Question Group"
     @question_group = QuestionGroup.includes(:questions).find(params[:id])
     @question_group.question_type_id = params[:question_type_id]
-    @survey_section_id = @question_group.questions.first.survey_section_id
+    @survey_section_id = question_params[:survey_section_id]
+    p "edit survey sect id #{@survey_section_id}"
   end
 
   def create
@@ -34,11 +36,11 @@ class QuestionGroupsController < ApplicationController
       #@question_group.questions.update_attributes(survey_section_id: question_group_params[])
       original_question = Question.find(question_group_params[:question_id]) if !question_group_params[:question_id].blank?
       original_question.destroy if original_question
-      render :inline => '<div id="cboxQuestionId">'+@question_group.questions.first.id.to_s+'</div>', :layout => 'surveyor_gui_blank'
+      render :inline => '<div id="cboxQuestionId">'+@question_group.questions.first.id.to_s+'</div>', :layout => 'surveyor_gui/surveyor_gui_blank'
     else
       @title = "Add Question"
       survey_section_id = question_group_params[:survey_section_id]
-      redirect_to :action => 'new', :controller => 'questions', :layout => 'surveyor_gui_blank', :survey_section_id => survey_section_id
+      redirect_to :action => 'new', :controller => 'questions', :layout => 'surveyor_gui/surveyor_gui_blank', :survey_section_id => survey_section_id
     end
   end
 
@@ -46,7 +48,7 @@ class QuestionGroupsController < ApplicationController
     @title = "Update Question"
     @question_group = QuestionGroup.includes(:questions).find(params[:id])
     if @question_group.update_attributes(question_group_params)
-      render :blank, :layout => 'surveyor_gui_blank'
+      render :blank, :layout => 'surveyor_gui/surveyor_gui_blank'
       #If a nested question is destroyed, the Question model performs a cascade delete
       #on the parent QuestionGroup (stuck with this behaviour as it is a Surveyor default).
       #Need to check for this and restore question group.
@@ -58,7 +60,7 @@ class QuestionGroupsController < ApplicationController
         QuestionGroup.create!(scrubbed_params)
       end     
     else
-      render :action => 'edit', :layout => 'surveyor_gui_blank'
+      render :action => 'edit', :layout => 'surveyor_gui/surveyor_gui_blank'
     end
   end
 
@@ -81,4 +83,8 @@ class QuestionGroupsController < ApplicationController
   def question_group_params
     ::PermittedParams.new(params[:question_group]).question_group
   end
+  def question_params
+    params.permit(:survey_section_id, :id, :text, :question_id, :question_type_id, :display_order, :pick, :display_type) 
+  end
+
 end

data/app/controllers/{questions_controller.rb → surveyor_gui/questions_controller.rb}

@@ -1,5 +1,5 @@
-class QuestionsController < ApplicationController
-  layout 'surveyor_gui_blank'
+class SurveyorGui::QuestionsController < ApplicationController
+  layout 'surveyor_gui/surveyor_gui_blank'
 
   def new
     @title = "Add Question"
@@ -49,10 +49,10 @@ class QuestionsController < ApplicationController
     if @question.save
       @question.answers.each_with_index {|a, index| a.destroy if index > 0} if @question.pick == 'none'
       #load any page - if it has no flash errors, the colorbox that contains it will be closed immediately after the page loads
-      render :inline => '<div id="cboxQuestionId">'+@question.id.to_s+'</div>', :layout => 'surveyor_gui_blank'
+      render :inline => '<div id="cboxQuestionId">'+@question.id.to_s+'</div>', :layout => 'surveyor_gui/surveyor_gui_blank'
     else
       @title = "Add Question"
-      render :action => 'new', :layout => 'surveyor_gui_blank'
+      render :action => 'new', :layout => 'surveyor_gui/surveyor_gui_blank'
     end
   end
 
@@ -62,9 +62,9 @@ class QuestionsController < ApplicationController
     if @question.update_attributes(question_params)
       @question.answers.each_with_index {|a, index| a.destroy if index > 0} if @question.pick == 'none'
       #load any page - if it has no flash errors, the colorbox that contains it will be closed immediately after the page loads
-      render :blank, :layout => 'surveyor_gui_blank'
+      render :blank, :layout => 'surveyor_gui/surveyor_gui_blank'
     else
-      render :action => 'edit', :layout => 'surveyor_gui_blank'
+      render :action => 'edit', :layout => 'surveyor_gui/surveyor_gui_blank'
     end
   end
 

data/app/controllers/surveyor_gui/reports_controller.rb

@@ -6,19 +6,19 @@ class SurveyorGui::ReportsController < ApplicationController
 
   # ReportPreviewWrapper wraps preview in a database transaction so test data is not permanently saved.
   around_action :wrap_in_transaction, only: :preview
-  layout 'surveyor_gui_default'
+  layout 'surveyor_gui/surveyor_gui_default'
 
   def preview
     response_qty = 5 
+    user_ids = response_qty.times.map{|i| -1*i}
     @title = "Preview Report for "+response_qty.to_s+" randomized responses"
     @survey = Survey.find(params[:survey_id])
-    user_id = defined?(current_user) && current_user ? current_user.id : nil
-    response_qty.times.each {
+    user_ids.each do |user_id|
       @response_set = ResponseSet.create(survey: @survey, user_id: user_id, test_data: true)
       ReportResponseGenerator.new(@survey).generate_1_result_set(@response_set)
-    }
-    @response_sets = ResponseSet.where(survey_id: @survey.id, test_data: true, user_id: user_id)
-    @responses = Response.joins(:response_set, :answer).where('user_id = ? and survey_id = ? and test_data = ? and answers.is_comment = ?',user_id,params[:survey_id],true, false)
+    end
+    @response_sets = ResponseSet.where(survey_id: @survey.id, test_data: true).where('user_id in (?)', user_ids)
+    @responses = Response.joins(:response_set, :answer).where('user_id in (?) and survey_id = ? and test_data = ? and answers.is_comment = ?',user_ids,params[:survey_id],true, false)
     if (!@survey)
       flash[:notice] = "Survey/Questionnnaire not found."
       redirect_to :back

data/app/controllers/surveyor_gui/responses_controller.rb

@@ -2,7 +2,7 @@ class SurveyorGui::ResponsesController < ApplicationController
   include ReportPreviewWrapper
   # ReportPreviewWrapper wraps preview in a database transaction so test data is not permanently saved.
   around_action :wrap_in_transaction, only: :preview
-  layout 'surveyor_gui_default'
+  layout 'surveyor_gui/surveyor_gui_default'
 
   def index
     @title = "Survey Responses"
@@ -16,6 +16,7 @@ class SurveyorGui::ResponsesController < ApplicationController
     @response_set = ResponseSet.create(:survey => @survey, :user_id => user_id, :test_data => true)
     ReportResponseGenerator.new(@survey).generate_1_result_set(@response_set)
     @responses = @response_set.responses
+    @response_sets = [@response_set]
     if (!@survey)
       flash[:notice] = "Survey/Questionnnaire not found."
       redirect_to :back
@@ -28,6 +29,7 @@ class SurveyorGui::ResponsesController < ApplicationController
     @response_set = ResponseSet.find(params[:id])
     @survey = @response_set.survey
     @responses = @response_set.responses
+    @response_sets = [@response_set]
     if (!@response_set)
       flash[:error] = "Response not found"
       redirect_to :back

data/app/controllers/surveyor_gui/survey_controller.rb

@@ -2,7 +2,7 @@ class SurveyorGui::SurveyController < ApplicationController
   def show
     @title = "User Will See this Survey"
     @survey = Survey.find(params[:survey_id])
-    user_id = defined?(current_user) ? current_user.id : 1 
+    user_id = defined?(current_user) && current_user ? current_user.id : 1 
     ResponseSet.where('survey_id = ? and test_data = ? and user_id = ?',params[:survey_id],true, user_id).each {|r| r.destroy}
     @response_set = ResponseSet.create(:survey => @survey, :user_id => user_id, :test_data => true)
     if (@survey)

data/app/controllers/{survey_sections_controller.rb → surveyor_gui/survey_sections_controller.rb}

@@ -1,5 +1,5 @@
-class SurveySectionsController < ApplicationController
-  layout 'surveyor_gui_blank'
+class SurveyorGui::SurveySectionsController < ApplicationController
+  layout 'surveyor_gui/surveyor_gui_blank'
 
   def new
     @title = "Add Survey Section"
@@ -28,7 +28,7 @@ class SurveySectionsController < ApplicationController
     if @survey_section.save
       redirect_to :back
     else
-      render :action => 'new', :layout => 'surveyor_gui_blank'
+      render :action => 'new', :layout => 'surveyor_gui/surveyor_gui_blank'
     end
   end
 
@@ -36,9 +36,9 @@ class SurveySectionsController < ApplicationController
     @title = "Update Survey Section"
     @survey_section = SurveySection.find(params[:id])
     if @survey_section.update_attributes(survey_section_params)
-      render :blank, :layout => 'surveyor_gui_blank'
+      render :blank, :layout => 'surveyor_gui/surveyor_gui_blank'
     else
-      render :action => 'edit', :layout => 'surveyor_gui_blank'
+      render :action => 'edit', :layout => 'surveyor_gui/surveyor_gui_blank'
     end
   end
 

data/app/controllers/{surveyforms_controller.rb → surveyor_gui/surveyforms_controller.rb}

@@ -1,4 +1,4 @@
-class SurveyformsController < ApplicationController
+class SurveyorGui::SurveyformsController < ApplicationController
   include Surveyor::SurveyorControllerMethods
   include SurveyorGui::SurveyformsControllerMethods
 end

data/app/controllers/{surveyor_controller.rb → surveyor_gui/surveyor_controller.rb}

@@ -1,6 +1,6 @@
 module SurveyorControllerCustomMethods
   def self.included(base)
-    base.send :layout, 'surveyor_modified'
+    base.send :layout, 'surveyor_gui/surveyor_modified'
   end
 
   def edit
@@ -83,7 +83,7 @@ module SurveyorControllerCustomMethods
 
   end
 end
-class SurveyorController < ApplicationController
+class SurveyorGui::SurveyorController < ApplicationController
   include Surveyor::SurveyorControllerMethods
   include SurveyorControllerCustomMethods
 end

data/app/helpers/surveyor_gui/application_helper.rb

@@ -0,0 +1,2 @@
+module SurveyorGui::ApplicationHelper
+end

data/app/helpers/{dependency_helper.rb → surveyor_gui/dependencys_helper.rb}

@@ -1,4 +1,4 @@
-module DependencyHelper
+module SurveyorGui::DependencysHelper
   def link_to_remove_tbody (name, f)
     f.hidden_field(:_destroy) + link_to(image_tag("delete.png",:border => 0, :margin=>'-1em'), "#", onclick: "remove_dependency_condition(this);")
   end

data/app/helpers/surveyor_gui/question_groups_helper.rb

@@ -0,0 +1,3 @@
+module SurveyorGui::QuestionGroupsHelper
+  include SurveyorGui::QuestionsHelper
+end

data/app/helpers/{question_helper.rb → surveyor_gui/questions_helper.rb}

@@ -1,4 +1,4 @@
-module QuestionHelper
+module SurveyorGui::QuestionsHelper
   def link_to_remove_fields (name, f, dom_to_hide=nil)
     f.hidden_field(:_destroy) + link_to(image_tag("delete.png",:border => 0, :margin=>'-1em'), "#", onclick: "remove_fields(this, \"#{dom_to_hide}\");")
   end

data/app/helpers/surveyor_gui/{report_helper.rb → reports_helper.rb}

@@ -1,4 +1,4 @@
-module SurveyorGui::ReportHelper
+module SurveyorGui::ReportsHelper
 
   def question_should_display(q)
     display=true

data/app/helpers/surveyor_gui/surveyforms_helper.rb

@@ -0,0 +1,160 @@
+module SurveyorGui
+  module SurveyformsHelper
+    require 'deep_cloneable'
+  
+    def list_dependencies(o)
+      controlling_questions = o.controlling_questions
+  
+      controlling_question_ids = controlling_questions.map{|q| q.question_number.to_s+')'}.uniq
+      count = controlling_question_ids.count
+      retstr ='This question is shown depending on the '
+      retstr += 'answer'.pluralize(count)
+      retstr += ' to '
+      retstr += 'question'.pluralize(count) + ' '
+      retstr + list_phrase(controlling_question_ids)
+    end
+  
+    def list_phrase(args)
+      ## given a list of word parameters, return a syntactically correct phrase
+      ## [dog] = "dog"
+      ## [dog, cat] = "dog and cat"
+      ## [dog, cat, bird] = "dog, cat and bird"
+      case args.count
+      when 0
+        ''
+      when 1
+        args[0]
+      when 2
+        args[0] + ' and ' + args[1]
+      else
+        last = args.count
+        args.take(last - 2).join(', ') + ', ' + args[last - 2] + ' and ' + args[last - 1]
+      end
+    end  
+    
+    def render_questions_and_groups_helper(q, ss)
+      #this method will render either a question or a complete question group.
+      #we always iterate through questions, and if we happen to notice a question
+      #belongs to a group, we process the group at that time.
+      #note that questions carry a question_group_id, and this is how we know
+      #that a question is part of a group, and that it should not be rendered individually,
+      #but as part of a group.  
+      if q.object.part_of_group?
+        _render_initial_group(q, ss)  ||  _respond_to_a_change_in_group_id(q, ss)
+      else
+        render "question_wrapper", f: q
+      end  
+    end
+    
+    def render_one_group(qg)
+      qg.simple_fields_for :questions, @current_group.questions do |f|
+        if f.object.is_comment != true
+          render "question_group_fields", f: f
+        elsif f.object.is_comment == true
+          "</div>".html_safe+(render "question_field", f: f)+"<div>".html_safe
+        end 
+      end
+    end  
+    
+    def question_group_heading(f)
+      if f.object.question_type_id == :grid_dropdown
+        heading = f.object.question_group.columns
+      elsif f.object.question_group.display_type == "grid"
+        heading = f.object.answers
+      else
+        heading = []
+      end  
+      heading.map {|a| "<span class=\"question_group_heading #{f.object.question_type_id.to_s}\" >#{a.text}<\/span>"}.join().html_safe
+    end  
+    
+    def row_label_if_question_group(question)
+      if question.part_of_group? 
+        "<span class=\"row_name\">#{question.text}: </span>".html_safe
+      end
+    end
+    
+    def question_group_class(question)
+      if @current_group.question_group.display_type == "inline"
+        "inline"
+      elsif @current_group.question_group.display_type == "default"
+        "default"
+      else
+        if question.question_type_id == :grid_dropdown
+          "dropdown"
+        else
+          "grid"
+        end
+      end
+    end
+    
+    private
+    def _render_initial_group(q, ss)
+      if @current_group.nil?
+        @current_group = QuestionGroupTracker.new(q.object.question_group_id)
+        render "question_group", :ss => ss, :f => q 
+      end
+    end
+    
+    def _respond_to_a_change_in_group_id(q, ss)
+      if @current_group.question_group_id != q.object.question_group_id
+        @current_group = QuestionGroupTracker.new(q.object.question_group_id)
+        render "question_group", :ss => ss, :f => q 
+      end
+    end
+  
+  end
+  
+  class SurveyCloneFactory
+    def initialize(id, as_template=false)
+      @survey = Surveyform.find(id.to_i)
+      @as_template = as_template
+    end
+  
+    def clone
+      cloned_survey = _deep_clone 
+      _set_api_keys(cloned_survey)
+      if cloned_survey.save!
+        return cloned_survey 
+      else
+        raise cloned_survey.errors.messages.map{|m| m}.join(',')
+        return nil
+      end
+    end
+    
+    private
+    
+    def _initial_clone
+      initial_clone = @survey
+      initial_clone.api_id = Surveyor::Common.generate_api_id                                                       
+      initial_clone.survey_version = Survey.where(access_code: @survey.access_code).maximum(:survey_version) + 1  
+      return initial_clone
+    end 
+  
+    def _deep_clone
+      _initial_clone.deep_clone include: { 
+        sections:   
+          {
+            questions: [
+              :answers,
+              {dependency: :dependency_conditions},
+              {question_group: :columns}
+            ]
+          }
+      }, 
+      use_dictionary: true
+    end 
+  
+    def _set_api_keys(cloned_survey)
+      cloned_survey.sections.each do |section|
+        section.questions.each do |question|
+          question.api_id = Surveyor::Common.generate_api_id
+          question.question_group.api_id = Surveyor::Common.generate_api_id if question.part_of_group?
+          question.answers.each do |answer|
+            answer.api_id = Surveyor::Common.generate_api_id
+          end
+        end
+      end
+    end
+  end
+end
+