surveyor 0.21.0 → 0.22.0

data/lib/surveyor/models/response_set_methods.rb

@@ -76,15 +76,18 @@ module Surveyor
 
       def default_args
         self.started_at ||= Time.now
-        self.access_code = Surveyor::Common.make_tiny_code
+        self.access_code ||= random_unique_access_code
+        self.api_id ||= Surveyor::Common.generate_api_id
       end
-
-      def access_code=(val)
+      
+      def random_unique_access_code
+        val = Surveyor::Common.make_tiny_code
         while ResponseSet.find_by_access_code(val)
           val = Surveyor::Common.make_tiny_code
         end
-        super
+        val
       end
+      private :random_unique_access_code
 
       def to_csv(access_code = false, print_header = true)
         qcols = Question.content_columns.map(&:name) - %w(created_at updated_at)
@@ -99,6 +102,13 @@ module Surveyor
         end
         result
       end
+      
+      def to_json
+        template_path = ActionController::Base.view_paths.find("show", ["surveyor"], false, {:handlers=>[:rabl], :locale=>[:en], :formats=>[:json]}, [], []).inspect
+        engine = Rabl::Engine.new(File.read(template_path))
+        engine.render(nil, {:object => self})
+      end
+      
       def complete!
         self.completed_at = Time.now
       end

data/lib/surveyor/models/survey_methods.rb

@@ -1,4 +1,4 @@
-require 'uuid'
+require 'surveyor/common'
 
 module Surveyor
   module Models
@@ -38,7 +38,7 @@ module Surveyor
 
       def default_args
         self.inactive_at ||= DateTime.now
-        self.api_id ||= UUID.generate
+        self.api_id ||= Surveyor::Common.generate_api_id
         self.display_order ||= Survey.count
       end
 
@@ -76,6 +76,12 @@ module Surveyor
         self.active_at = nil if !datetime.nil? and !self.active_at.nil? and self.active_at > datetime
         super(datetime)
       end
+      def to_json
+        template_path = ActionController::Base.view_paths.find("export", ["surveyor"], false, {:handlers=>[:rabl], :locale=>[:en], :formats=>[:json]}, [], []).inspect
+        engine = Rabl::Engine.new(File.read(template_path))
+        engine.render(nil, {:object => self})
+      end
+      
     end
   end
 end

data/lib/surveyor/models/survey_section_methods.rb

@@ -30,7 +30,19 @@ module Surveyor
       def default_args
         self.data_export_identifier ||= Surveyor::Common.normalize(title)
       end
-
+      
+      def questions_and_groups
+        qs = []
+        questions.each_with_index.map do |q,i|
+          if q.part_of_group?
+            if (i+1 >= questions.size) or (q.question_group_id != questions[i+1].question_group_id)
+              q.question_group
+            end
+          else
+            q
+          end
+        end.compact
+      end
     end
   end
 end

data/lib/surveyor/parser.rb

@@ -1,16 +1,23 @@
 %w(survey survey_section question_group question dependency dependency_condition answer validation validation_condition).each {|model| require model }
 module Surveyor
   class Parser
+    class << self; attr_accessor :options end
+    
     # Attributes
     attr_accessor :context
 
     # Class methods
-    def self.parse(str)
-      puts
+    def self.parse(str, options={})
+      self.options = options
+      Surveyor::Parser.rake_trace "\n"
       Surveyor::Parser.new.parse(str)
-      puts
+      Surveyor::Parser.rake_trace "\n"
     end
-
+    def self.rake_trace(str)
+      self.options ||= {}
+      print str if self.options[:trace] == true
+    end
+    
     # Instance methods
     def initialize
       self.context = {}
@@ -24,7 +31,7 @@ module Surveyor
       method_name, reference_identifier = missing_method.to_s.split("_", 2)
       type = full(method_name)
       
-      print reference_identifier.blank? ? "#{type} " : "#{type}_#{reference_identifier} "
+      Surveyor::Parser.rake_trace reference_identifier.blank? ? "#{type} " : "#{type}_#{reference_identifier} "
       
       # check for blocks
       raise "Error: A #{type.humanize} cannot be empty" if block_models.include?(type) && !block_given?
@@ -37,8 +44,8 @@ module Surveyor
       if block_models.include?(type)
         self.instance_eval(&block) 
         if type == 'survey'
-          puts
-          print context[type.to_sym].save ? "saved. " : " not saved! #{context[type.to_sym].errors.each_full{|x| x }.join(", ")} "
+          Surveyor::Parser.rake_trace "\n"
+          Surveyor::Parser.rake_trace context[type.to_sym].save ? "saved. " : " not saved! #{context[type.to_sym].errors.each_full{|x| x }.join(", ")} "
         end
         context[type.to_sym].clear(context) unless type == 'survey'
       end
@@ -158,7 +165,7 @@ class Question < ActiveRecord::Base
     unless correct.blank? or reference_identifier.blank? or context_reference.blank?
       # Looking up references for quiz answers
       context_reference[:answer_references][reference_identifier] ||= {}
-      print (self.correct_answer = context_reference[:answer_references][reference_identifier][correct]) ? "found correct answer:#{correct} " : "lost! correct answer:#{correct} "
+      Surveyor::Parser.rake_trace( (self.correct_answer = context_reference[:answer_references][reference_identifier][correct]) ? "found correct answer:#{correct} " : "lost! correct answer:#{correct} ")
     end
   end
 end
@@ -206,9 +213,9 @@ class DependencyCondition < ActiveRecord::Base
   def resolve_references
     if context_reference
       # Looking up references to questions and answers for linking the dependency objects
-      print (self.question = context_reference[:question_references][question_reference]) ? "found question:#{question_reference} " : "lost! question:#{question_reference} "
+      Surveyor::Parser.rake_trace( (self.question = context_reference[:question_references][question_reference]) ? "found question:#{question_reference} " : "lost! question:#{question_reference} ")
       context_reference[:answer_references][question_reference] ||= {}
-      print (self.answer = context_reference[:answer_references][question_reference][answer_reference]) ? "found answer:#{answer_reference} " : "lost! answer:#{answer_reference} "
+      Surveyor::Parser.rake_trace( (self.answer = context_reference[:answer_references][question_reference][answer_reference]) ? "found answer:#{answer_reference} " : "lost! answer:#{answer_reference} ")
     end
   end
 end
@@ -259,7 +266,7 @@ class Answer < ActiveRecord::Base
       self.text_args("Other").merge({:response_class => "string"})
     when :none, :omit # is_exclusive erases and disables other checkboxes and input elements
       self.text_args(arg.to_s.humanize).merge({:is_exclusive => true})
-    when :integer, :date, :time, :datetime, :text, :datetime, :string
+    when :integer, :float, :date, :time, :datetime, :text, :datetime, :string
       self.text_args(arg.to_s.humanize).merge({:response_class => arg.to_s, :display_type => "hidden_label"})
     end
   end

data/lib/surveyor/render_text.rb

@@ -0,0 +1,19 @@
+module Surveyor
+  module RenderText
+    def render_question_text(context = nil)
+      render_text(text, context)
+    end
+    
+    def render_help_text(context = nil)
+      render_text(help_text, context)
+    end
+    
+    def render_answer_text(text, context = nil)
+      render_text(text, context)
+    end
+    
+    def render_text(text, context = nil)
+      context ? context.render(text) : text
+    end
+  end
+end

data/lib/surveyor/surveyor_controller_methods.rb

@@ -1,8 +1,12 @@
+require 'rabl'
+Rabl.register!
+Rabl.configure {|config| config.include_json_root = false }
 module Surveyor
   module SurveyorControllerMethods
     def self.included(base)
       base.send :before_filter, :get_current_user, :only => [:new, :create]
       base.send :before_filter, :determine_if_javascript_is_enabled, :only => [:create, :update]
+      base.send :before_filter, :set_render_context, :only => [:edit]
       base.send :layout, 'surveyor_default'
     end
 
@@ -25,6 +29,7 @@ module Surveyor
       end
     end
 
+
     def show
       @response_set = ResponseSet.find_by_access_code(params[:response_set_code], :include => {:responses => [:question, :answer]})
       if @response_set
@@ -34,6 +39,7 @@ module Surveyor
           format.csv {
             send_data(@response_set.to_csv, :type => 'text/csv; charset=utf-8; header=present',:filename => "#{@response_set.updated_at.strftime('%Y-%m-%d')}_#{@response_set.access_code}.csv")
           }
+          format.json
         end
       else
         flash[:notice] = t('surveyor.unable_to_find_your_responses')
@@ -91,14 +97,26 @@ module Surveyor
         end
       end
     end
-
+    
+    def export
+      @survey = Survey.find_by_access_code(params[:survey_code])
+    end
     private
 
+    # This is a hoock method for surveyor-using applications to override and provide the context object
+    def render_context
+      nil
+    end
+
     # Filters
     def get_current_user
       @current_user = self.respond_to?(:current_user) ? self.current_user : nil
     end
 
+    def set_render_context
+      @render_context = render_context
+    end
+
     # Params: the name of some submit buttons store the section we'd like to go to. for repeater questions, an anchor to the repeater group is also stored
     # e.g. params[:section] = {"1"=>{"question_group_1"=>"<= add row"}}
     def section_id_from(p)

data/lib/surveyor/unparser.rb

@@ -48,7 +48,7 @@ class QuestionGroup < ActiveRecord::Base
   # block
 
   def unparse(dsl)
-    attrs = (self.attributes.diff QuestionGroup.new(:text => text).attributes).delete_if{|k,v| %w(created_at updated_at id).include?(k) or (k == "display_type" && %w(grid repeater default).include?(v))}.symbolize_keys!
+    attrs = (self.attributes.diff QuestionGroup.new(:text => text).attributes).delete_if{|k,v| %w(created_at updated_at id api_id).include?(k) or (k == "display_type" && %w(grid repeater default).include?(v))}.symbolize_keys!
     method = (%w(grid repeater).include?(display_type) ? display_type : "group")
     dsl << "\n"
     dsl << "    #{method} \"#{text}\""

data/lib/surveyor/version.rb

@@ -1,3 +1,3 @@
 module Surveyor
-  VERSION = '0.21.0'
+  VERSION = '0.22.0'
 end

data/lib/tasks/surveyor_tasks.rake

@@ -7,7 +7,7 @@ namespace :surveyor do
     file = File.join(Rails.root, ENV["FILE"])
     raise "File does not exist: #{file}" unless FileTest.exists?(file)
     puts "--- Parsing #{file} ---"
-    Surveyor::Parser.parse File.read(file)
+    Surveyor::Parser.parse(File.read(file), {:trace => Rake.application.options.trace})
     puts "--- Done #{file} ---"
   end
   desc "generate and load survey from REDCap Data Dictionary (specify FILE=surveys/redcap.csv)"

data/spec/controllers/surveyor_controller_spec.rb

@@ -234,11 +234,15 @@ describe SurveyorController do
 
     it "should return an id for new responses" do
       do_ajax_put({
-         "2"=>{"question_id"=>"4", "answer_id"=>"14"}, #check
-         "4"=>{"question_id"=>"4", "answer_id"=>"15"} #check
+         "2"=>{"question_id"=>"4", "answer_id"=>"14"}
       })
       JSON.parse(response.body).
-        should == {"ids" => {"2" => 1, "4" => 2}, "remove" => {}, "show" => [], "hide" => []}
+        should == {"ids" => {"2" => 1}, "remove" => {}, "show" => [], "hide" => []}
+      do_ajax_put({
+         "4"=>{"question_id"=>"4", "answer_id"=>"15"}
+      })
+      JSON.parse(response.body).
+        should == {"ids" => {"4" => 2}, "remove" => {}, "show" => [], "hide" => []}
     end
 
     it "should return a delete for when responses are removed" do

data/spec/helpers/surveyor_helper_spec.rb

@@ -1,8 +1,9 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe SurveyorHelper do
+
   before(:each) do
-    
+
   end
   it "should return the question text with number" do
     q1 = Factory(:question)
@@ -13,19 +14,58 @@ describe SurveyorHelper do
     helper.q_text(q1).should == "1) #{q1.text}"
     helper.q_text(q2).should == q2.text
     helper.q_text(q3).should == q3.text
-    
+
     dir = "images"
     if Rails.application.config.respond_to?(:assets) && Rails.application.config.assets
       dir = "assets"
     end
-    
+
     helper.q_text(q4).should == %Q(<img alt="Something" src="/#{dir}/something.jpg" />)
     helper.q_text(q5).should == q5.text
   end
+  require 'mustache'
+  class FakeMustacheContext < ::Mustache
+    def site
+      "Northwestern"
+    end
+    def somethingElse
+      "something new"
+    end
+
+    def group
+      "NUBIC"
+    end
+  end
+  it "should return text with with substituted value" do
+    q1 = Factory(:question, :text => "You are in {{site}}")
+    label = Factory(:question, :display_type => "label", :text => "Testing {{somethingElse}}")
+    helper.q_text(q1, FakeMustacheContext).should == "1) You are in Northwestern"
+    helper.q_text(label, FakeMustacheContext).should == "Testing something new"
+  end
+  it "should return help_text for question with substituted value" do
+    q2 = Factory(:question, :display_type => "label", :text => "Is you site Northwestern?", :help_text => "If your site is not {{site}}, pick 'no' for the answer")
+    helper.render_help_text(q2, FakeMustacheContext).should == "If your site is not Northwestern, pick 'no' for the answer"
+  end
+  it "should return help_text for group text with number" do
+    g1 = Factory(:question_group, :text => "You are part of the {{group}}")
+    helper.q_text(g1, FakeMustacheContext).should == "1) You are part of the NUBIC"
+  end
+  it "should return help_text for group text" do
+    g1 = Factory(:question_group, :text => "You are part of the {{group}}", :help_text => "Make sure you know what the {{group}} stands for")
+    helper.render_help_text(g1, FakeMustacheContext).should == "Make sure you know what the NUBIC stands for"
+  end
+
+  it "should return rendered text for answer" do
+    q1 = Factory(:question, :text => "Do you work for {{site}}", :answers => [a1 = Factory(:answer, :text => "No, I don't work for {{site}}"), a2 = Factory(:answer, :text => "Yes, I do work for {{site}}") ])
+    helper.a_text(a1, nil, FakeMustacheContext).should == "No, I don't work for Northwestern"
+    helper.a_text(a2, nil, FakeMustacheContext).should == "Yes, I do work for Northwestern"
+  end
+
   it "should return the group text with number" do
     g1 = Factory(:question_group)
-    helper.q_text(g1).should == "1) #{g1.text}"
+    helper.q_text(g1, FakeMustacheContext).should == "1) #{g1.text}"
   end
+
   it "should find or create responses, with index" do
     q1 = Factory(:question, :answers => [a = Factory(:answer, :text => "different")])
     q2 = Factory(:question, :answers => [b = Factory(:answer, :text => "strokes")])
@@ -36,10 +76,10 @@ describe SurveyorHelper do
     helper.response_for(nil, q1).should == nil
     helper.response_for(rs, q1).should == r1
     helper.response_for(rs, q1, a).should == r1
-    helper.response_for(rs, q2).attributes.should == Response.new(:question => q2, :response_set => rs).attributes
-    helper.response_for(rs, q2, b).attributes.should == Response.new(:question => q2, :response_set => rs).attributes
+    helper.response_for(rs, q2).attributes.reject{|k,v| k == "api_id"}.should == Response.new(:question => q2, :response_set => rs).attributes.reject{|k,v| k == "api_id"}
+    helper.response_for(rs, q2, b).attributes.reject{|k,v| k == "api_id"}.should == Response.new(:question => q2, :response_set => rs).attributes.reject{|k,v| k == "api_id"}
     helper.response_for(rs, q3, c, "1").should == r3
-    
+
   end
   it "should keep an index of responses" do
     helper.response_idx.should == "1"
@@ -53,7 +93,62 @@ describe SurveyorHelper do
     helper.rc_to_attr(:integer).should == :integer_value
     helper.rc_to_attr(:float).should == :float_value
     helper.rc_to_attr(:datetime).should == :datetime_value
-    helper.rc_to_attr(:date).should == :datetime_value
-    helper.rc_to_attr(:time).should == :datetime_value
+    helper.rc_to_attr(:date).should == :date_value
+    helper.rc_to_attr(:time).should == :time_value
+  end
+
+  it "should translate response class into as" do
+    helper.rc_to_as(:string).should == :string
+    helper.rc_to_as(:text).should == :text
+    helper.rc_to_as(:integer).should == :string
+    helper.rc_to_as(:float).should == :string
+    helper.rc_to_as(:datetime).should == :string
+    helper.rc_to_as(:date).should == :string
+    helper.rc_to_as(:time).should == :string
   end
+
+  context "overriding methods" do
+    before do
+      module SurveyorHelper
+        include Surveyor::Helpers::SurveyorHelperMethods
+        alias :old_rc_to_as :rc_to_as
+        def rc_to_as(type_sym)
+          case type_sym.to_s
+          when /(integer|float)/ then :string
+          when /(datetime)/ then :datetime
+          else type_sym
+          end
+        end
+      end
+    end
+
+    it "should translate response class into as" do
+      helper.rc_to_as(:string).should == :string
+      helper.rc_to_as(:text).should == :text
+      helper.rc_to_as(:integer).should == :string
+      helper.rc_to_as(:float).should == :string
+      helper.rc_to_as(:datetime).should == :datetime  # not string
+      helper.rc_to_as(:date).should == :date          # not string
+      helper.rc_to_as(:time).should == :time
+    end
+
+    after do
+      module SurveyorHelper
+        include Surveyor::Helpers::SurveyorHelperMethods
+        def rc_to_as(type_sym)
+          old_rc_to_as(type_sym)
+        end
+      end
+    end
+  end
+
+  # Make sure that this context runs after the previous context 'overriding methods'
+  context "post override test" do
+    # Sanity check
+    it "should translate response class into as after override" do
+      helper.rc_to_as(:datetime).should == :string  # back to string
+      helper.rc_to_as(:date).should == :string      # back to string
+    end
+  end
+
 end

data/spec/lib/chinese_survey.rb

@@ -0,0 +1,14 @@
+survey "青少年人际关系问卷", :access_code => "青少年人际关系问卷" do
+  section "Basic questions" do
+    grid "第二部分：以下列出了一些描述。请您根据自己的实际情况作答。如果“非常不像我”，请选“1”，如果“非常像我”，请选“5”，以此类推。" do
+      a "1"
+      a "2"
+      a "3"
+      a "4"
+      a "5"
+      q "我常常想出新的有趣的点子", :pick => :one
+      q "我比同龄的其他孩子更有想象力", :pick => :one
+      q "即使一个人独处，我也不会觉得无聊", :pick => :one
+    end
+  end
+end