surveyor_gui 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01ff64c99fbe1b160d2a285be9d7542b78ae1475
+  data.tar.gz: 5446a1b7ec3ed1a52075fe7581f303930c61b518
+SHA512:
+  metadata.gz: 7483d8876d1d10aa8b685ae2f554443d5c3912b7af468a086f260adf0fc6de5d4579c1ed9799140b04bfd8a9c7e5d96223a575e2353640d2e21562d9c5142db0
+  data.tar.gz: 8d7b4471e2a80f408842d765bc1421c233a0bc6ea6180f4fa66dac81e2bd5b21fc0f0ce839046e1fd10e11736f0c0c513ae94ff1eda8b5a4b13ec715eaf198bf

data/.gitignore

@@ -0,0 +1,44 @@
+*~
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+.rvmrc
+/vendor/bundle
+/log/*
+log/*
+/tmp/*
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+**.swp
+rerun.txt
+pickle-email-*.html
+.project
+config/initializers/secret_token.rb
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+
+# Ignore testbed
+testbed
+
+# Ignore RVM directives
+.ruby-version
+.ruby-gemset
+
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+- 2.0.0
+- 2.1.1
+env:
+- "RAILS_VERSION=4.0.8"
+- "RAILS_VERSION=4.1.4"
+script:
+- bundle exec rake gui_testbed
+- bundle exec rspec 
+notifications:
+email:
+recipients:
+- kjayma@gmail.com 
+on_success: change # [always|never|change] # default: change
+on_failure: always # [always|never|change] # default: always
+

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem 'surveyor', github: 'NUBIC/surveyor'
+
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,159 @@
+surveyor_gui
+============
+
+Surveyor_gui complements the surveyor gem.
+
+The surveyor gem is used to create surveys by parsing a file written in the Surveyor DSL.  It does not include a gui for creating surveys, although it does provide a gui for taking surveys.
+
+The lack of a gui front-end limits the utility of surveyor for certain applications.
+
+Surveyor_gui meets this need by providing a gui to create surveys from scratch.  Surveyor_gui bypasses the need to create a Surveyor DSL file, and directly updates the Surveyor tables to build a survey.
+
+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.
+
+## Requirements
+
+SurveyorGui works with:
+
+* Ruby 1.9.3
+* Rails 4, 4.1
+
+
+Some key dependencies are:
+
+* Surveyor
+* HAML
+* Sass
+* Formtastic
+
+A more exhaustive list can be found in the gemspecs for Surveyor [surveyor] and Surveyor_gui [surveyor-gui][].
+
+[surveyor]: https://github.com/NUBIC/surveyor/blob/master/surveyor.gemspec
+[surveyor-gui]: https://github.com/kjayma/surveyor_gui/blob/master/surveyor_gui.gemspec
+[policy]: http://weblog.rubyonrails.org/2013/2/24/maintenance-policy-for-ruby-on-rails/
+
+## Install
+
+Add surveyor and surveyor-gui to your Gemfile:
+
+    gem 'surveyor', github: 'NUBIC/surveyor'
+    gem 'surveyor_gui'
+
+You will also need a javascript runtime, like node.js or therubyracer.  If you
+have not yet installed one, add
+
+    gem "therubyracer"
+
+to your Gemfile.
+
+Bundle, install, and migrate:
+
+    bundle install
+    rails g surveyor_gui:install
+
+Note that the installer will run db:migrate (so any un-applied migrations you have in your project will be pulled in).
+The survey editor can be found at '/surveyforms'.  Users can take surveys at the '/surveys' url.
+
+## Limitations
+
+This gem provides support for a subset of the Surveyor functionality.  It supports all of the basic question types, and
+most of the complicated question types, but does not currently support the following:
+
+  - Questions with multiple entries (e.g., the "Get me started on an improv sketch" question in the kitchen_sink_survey.rb that comes
+    with the Surveyor gem.
+  - Input masks
+  - Quizzes
+
+It adds some new question types:
+
+  - Star rating (1-5 stars)
+  - File upload
+  - Grid dropdown (a grid of dropdowns with up to ten columns.)
+
+Dependencies are partially supported.  The following are not currently supported:
+
+- counts (count the number of answers checked or entered)
+- Regexp validations
+
+You can open the kitchen_sink survey that comes with Surveyor, but a few of the questions will not behave as expected
+because of the discrepancies noted above.
+
+## Locking
+
+This gem enforces locking on surveys.  A survey may be modified up until a user submits a response.  At that point, the survey
+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.
+
+## 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
+possible to mark certain parts of a survey as unmodifiable so that they will always be present when a survey is cloned.
+  
+A template library feature is pending.
+
+## Test environment
+
+If you want to try out surveyor-gui before incorporating it into an application, or contribute, clone the repository.
+Then run
+
+    bundle install
+    bundle exec rake gui_testbed
+    cd testbed
+
+Start the rails server and go to /surveyforms
+
+Before contributing, please run the tests:
+    bundle exec rspec spec
+
+## Taking surveys
+
+Go to /surveys (or click the link at the bottom of the surveyforms home page) to see the surveys and take one.
+
+## Reports
+
+Surveyor_gui now provides reports!  
+
+You can see a report of all survey responses, or view an individual response.
+
+Highcharts.js is used for graphics, and must be licensed for commercial use.  Future development will replace Highcharts with Rickshawgraphs.
+
+To see reports, try using the "Preview Reports" button on the survey editor, or take the survey and try
+"localhost:3000/surveyor_gui/reports/:id/show" where :id is the survey id.  Preview reports will create some dummy
+responses using randomized answers.  
+
+You can also view an individual response at "localhost:3000/surveyor_gui/results/:id/show".
+
+## Devise etc.
+
+Surveyor_Gui will work with Devise or like gems.
+
+Surveyor_gui adds a user_id attribute to the Survey model.  It will try to set user_id to current_user when a new survey
+is defined.  The gem does not provide any access control over survey creation and update, but you can add that to your
+application using the user_id attribute.
+
+In addition, the underlying Surveyor gem provides a user_id attribute in the ResponseSet model.  When responses are created, it will
+try to set the user_id to current_user.
+
+Surveyor_gui reports assume there will be a unique user for eash Survey response, and reports on results by user.
+If the response set has a user id, (which will be the case if you've setup Devise in the typical way) it will identify the response by user_id.  If no user_id is available, it will
+default to the response_set.id.
+
+You may want to identify users by something other than id on reports.  This can be done easily.  
+
+Surveyor_gui creates a response_set_user.rb file in your app/models directory.  Edit it to define the identifier you would like to use for users in reports.  For instance, if your user model is User, and you would like to see the user's email address on reports, edit the file as follows...
+
+In the initialize method, add the following line:
+
+    @user = User.find(user_id)
+
+In the report_user_name method, add the following line:
+
+    @user ? @user.email : nil
+
+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.

data/Rakefile

@@ -0,0 +1,66 @@
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+###### RSPEC
+
+RSpec::Core::RakeTask.new(:spec)
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rcov = true
+end
+
+task :default => :spec
+
+
+###### TESTBED
+
+desc 'Set up the rails app that the specs and features use'
+task :gui_testbed => 'gui_testbed:rebuild'
+
+namespace :gui_testbed do
+  desc 'Generate a minimal surveyor_gui/surveyor rails app'
+  task :generate do
+    sh "bundle exec rails new testbed --skip-bundle" # don't run bundle install until the Gemfile modifications
+
+    chdir('testbed') do
+      gem_file_contents = File.read('Gemfile')
+      gem_file_contents.sub!(/^(gem 'rails'.*)$/, %Q{ \\1\nplugin_root = File.expand_path('../..', __FILE__)\ngem 'surveyor_gui', :path => plugin_root\ngem 'therubyracer'\ngem 'surveyor', github: 'NUBIC/surveyor'})
+
+      File.open('Gemfile', 'w'){|f| f.write(gem_file_contents) }
+
+      # not sure why turbolinks gives test problems, anyway better to avoid it?
+      js_file_contents = File.read('app/assets/javascripts/application.js')
+      js_file_contents.sub!('//= require turbolinks', '')
+      File.open('app/assets/javascripts/application.js', 'w'){|f| f.write(js_file_contents) }
+
+      Bundler.with_clean_env do
+        sh 'bundle install' # run bundle install after Gemfile modifications
+      end
+    end
+  end
+
+  desc 'Remove the testbed entirely'
+  task :remove do
+    rm_rf 'testbed'
+  end
+
+  desc 'Prepare the databases for the testbed'
+  task :migrate do
+    chdir('testbed') do
+      Bundler.with_clean_env do
+        sh 'bundle exec rails generate simple_form:install'
+        sh 'bundle exec rake highcharts:update'
+        sh 'bundle exec rails generate surveyor:install'
+        sh 'bundle exec rake db:migrate db:test:prepare'
+        sh 'bundle exec rails generate surveyor_gui:install'
+        sh 'bundle exec rake db:migrate db:test:prepare'
+        sh 'bundle exec rake surveyor FILE=surveys/kitchen_sink_survey.rb'
+      end
+    end
+  end
+
+  task :rebuild => [:remove, :generate, :migrate]
+end

data/app/controllers/answers_controller.rb

@@ -0,0 +1,3 @@
+class AnswersController < ApplicationController
+  layout 'surveyor_gui_blank'
+end

data/app/controllers/application_controller.rb

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

data/app/controllers/dependencys_controller.rb

@@ -0,0 +1,286 @@
+class DependencysController < ApplicationController
+  layout 'surveyor_gui_blank'
+
+  def new
+    prep_variables
+    @title = "Add Logic for "+@this_question
+    if @question.part_of_group?
+      @question.question_group.build_dependency(:rule=>'A')
+    else
+      @question.build_dependency(:rule=>'A')
+    end
+  end
+
+  def edit
+    prep_variables
+    @title = "Edit Logic for Question "+@this_question
+  end
+
+  def create
+    @question = Question.new(question_params)
+    if @question.save
+      redirect_to :back
+    else
+      render :action => 'new', :layout => 'surveyor_gui_blank'
+    end
+  end
+
+  def update
+    @title = "Update Question"
+    @question = Question.includes(:answers).find(params[:id])
+    if @question.part_of_group?
+      update_object = @question.question_group
+      update_params = question_group_params
+    else
+      update_object = @question
+      update_params = question_params
+    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'
+    else
+      prep_variables
+      render :action => 'edit', :layout => 'surveyor_gui_blank'
+    end
+  end
+
+  def destroy
+    question = Question.find(params[:id])
+    if question.part_of_group?
+      question.question_group.dependency.destroy
+    else
+      question.dependency.destroy
+    end
+    render :nothing=>true
+  end
+
+  def render_dependency_conditions_partial
+    prep_variables
+    @question_or_group = @question.part_of_group? ? @question.question_group : @question
+    @dependency = Dependency.find(params[:dependency_id]) if !params[:dependency_id].blank?
+    if @dependency.nil?
+      @question_or_group.build_dependency(:rule=>'A').dependency_conditions.build()
+    end
+    if @question_or_group.dependency.dependency_conditions.empty?
+      @question_or_group.dependency.dependency_conditions.build()
+    else
+      if params[:add_row]
+        @question_or_group = eval(@question_or_group.class.name).new
+        @question_or_group.build_dependency.dependency_conditions.build()
+      end
+    end
+    render :partial => 'dependency_condition_fields'
+  end
+
+  def get_answers    
+    options=""
+    question_id               = params[:question_id]
+    question                  = Question.find(question_id)
+    column_id                 = params[:column_id].blank? ? _default_column_id(question) : params[:column_id]
+    dependency_condition_id   = params[:dependency_condition_id]
+    dependency_condition      = dependency_condition_id.blank? ? nil : DependencyCondition.find(dependency_condition_id)
+    if question && question.answers
+      question.answers.where('column_id = ? OR column_id IS NULL',column_id.to_i).each_with_index do |a, index|
+        options += '<option ' + _get_selected_answer(index, dependency_condition, a, column_id) +
+         'value="' + a.id.to_s + '"' +
+         '>'+a.text.to_s+"</option>"
+      end
+    end
+    render :inline=>options
+  end
+  
+  def get_columns
+    options=""
+    question_id               = params[:question_id]
+    dependency_condition_id   = params[:dependency_condition_id]
+    dependency_condition      = dependency_condition_id.blank? ? nil : DependencyCondition.find(dependency_condition_id)
+    question = Question.find(question_id)
+    if question && question.question_group
+      question.question_group.columns.each_with_index do |c, index|
+        options += '<option ' +
+         _get_selected_column(index, dependency_condition, c) +
+         'value="' + c.id.to_s + '"' +
+         '>'+c.text.to_s+"</option>"
+      end
+    end
+    render :inline=>options
+  end
+
+  def get_question_type
+    question_id =  params[:question_id]
+    question = Question.find(question_id)
+    response=question.pick
+    response += ','+question.question_type_id.to_s
+    response += ','+question_id
+    render :inline=>response
+  end
+
+private
+
+  def prep_variables
+    @question = Question.includes(:dependency).find(params[:id]) unless @question
+    controlling_questions = get_controlling_question_collection(@question)
+    @controlling_questions = controlling_questions.collection
+    @this_question = @question.part_of_group? ? @question.question_group.text : @question.question_description
+    @operators = get_operators
+  end
+
+  def get_controlling_question_collection(dependent_question)
+    all_questions_in_survey = _get_all_questions_in_survey(dependent_question)
+    _get_question_collection(all_questions_in_survey, dependent_question)
+  end
+
+  def _get_all_questions_in_survey(question)
+    PossibleControllingQuestion.unscoped
+      .joins(:survey_section)
+      .where('survey_id = ?', question.survey_section.survey_id)
+      .order('survey_sections.display_order','survey_sections.id','questions.display_order')
+  end
+
+  def _get_question_collection(all_questions, dependent_question)
+    return QuestionCollection.new(dependent_question).add_questions(all_questions)
+  end
+
+  def get_operators
+    return [
+      ['equal to (=)','=='],
+      ['not equal to','!='],
+      ['less than (<)','<'],
+      ['less than or equal to (<=)','<='],
+      ['greater than or equal to (>=)','>='],
+      ['greater than','>']
+    ]
+  end
+
+  def question_params
+    ::PermittedParams.new(params[:question]).question
+  end
+
+  def question_group_params
+    ::PermittedParams.new(params[:question_group]).question_group
+  end  
+  
+  def _default_column_id(question)
+    if question.part_of_group?
+      columns = question.question_group.columns
+      columns.first ? columns.first.id.to_s : ""
+    else
+      ""
+    end
+  end
+  
+  def _get_selected_answer(index, dependency_condition, a, column_id)
+    if _matches_dependency_condition(dependency_condition, a, column_id) 
+      'selected="selected" ' 
+    else 
+      ''
+    end  
+  end
+  
+  def _get_selected_column(index, dependency_condition, column)
+    if _matches_dependency_condition_column(dependency_condition, column) 
+      'selected="selected"'
+    else
+      ''
+    end
+  end
+  
+  def _matches_dependency_condition (dependency_condition, a, column_id)
+    if dependency_condition.nil?  
+      false
+    else
+      (dependency_condition.answer_id == a.id && (column_id.blank? || dependency_condition.column_id == column_id.to_i ))
+    end
+  end
+  
+  def _matches_dependency_condition_column(dependency_condition, column)
+    if dependency_condition.nil?
+      false
+    else
+      dependency_condition.column_id == column.id
+    end
+  end
+  
+end
+
+class QuestionCollection
+  ## QuestionCollection provides a 2 dimensional array consisting of a question id
+  ## and a question description.  The collection may be used in a view's select field.
+  ##
+  ## Its membership is determined by a base question.
+  ## The base question is the one from which other questions in the collection are derived.
+  ## E.g., in a dependency, the question that is shown or hidden based on the answers to others
+  ## is the base question.  It shouldn't show up in the collection.
+  ##
+  ## Other questions may or may not show up in the collection depending on their eligibility.
+  ##
+  ## Some questions should have a question number and
+  ## some should not. The QuestionCollection numbers questions that should be numbered
+  ## and keeps track of the numbering.  If a question is numbered, the question number
+  ## is included in the description, e.g. "3) What is your name?".  Otherwise,
+  ## the description is just the question text, e.g. "Don't forget to use your middle initial".
+  ##
+  ## Incoming questions may be duck typed, but should respond to is_numbered? and is_eligible?
+  ## messages.
+
+  attr_accessor :collection, :dependency_question_description
+
+  def initialize(base_question)
+    @collection = []
+    @question_number = 1
+    @base_question = base_question
+    @dependency_question_description = nil
+  end
+
+  def collection
+    @collection
+  end
+
+  def add_questions(questions)
+    questions.each {|q| add_question(q)}
+    return self
+  end
+
+  def add_question(question)
+    _add_to_collection_if_eligible(question)
+    if question.is_numbered?
+      _increment_question_number
+    end 
+    return self
+  end
+
+  private
+
+  def _get_description(question)
+    @question_number.to_s + ') ' + (question.part_of_group? ? question.question_group.text + ": " : "") +question.text
+  end
+
+  def _add_to_collection(question)
+    description = _get_description(question)
+    @collection.push([description, question.id])
+  end
+
+  def _add_to_collection_if_eligible(question)
+    _add_to_collection(question) if question.is_eligible? && _this_is_not_the_base_question?(question)
+  end
+
+  def _this_is_not_the_base_question?(question)
+    if question.part_of_group?
+      question.question_group_id != @base_question.question_group_id
+    else
+      question.id != @base_question.id
+    end
+  end
+
+  def _increment_question_number
+    @question_number += 1
+  end
+end
+
+## This shouldn't be here but breaks saving nested attributes on question when put
+## in QuestionMethods.  Not sure why, but leave for now and revisit later.
+class PossibleControllingQuestion < Question
+  def is_eligible?
+    question_type_id!=:label && question_type_id!=:file
+  end
+end