surveyor 1.0.1 → 1.1.0

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 History for Surveyor
 ====================
 
+1.1.0
+-----
+
+### Features
+
+- Breaking change: Question#is_mandatory => false by default. For those who found it useful to have 
+  all questions mandatory, the parser accepts `:default_mandatory => true` as an argument to the survey.
+
+### Fixes
+
+- fixing and documenting count operators on dependency conditions
+
+### Infrastructure
+
+- basic spec for the surveyor task
+
 1.0.1
 ------
 
@@ -10,12 +26,15 @@ History for Surveyor
   now exclude the question or question group from the DOM. These display types are
   used to inject data (responses) into surveys. Note, custom_class => "hidden" doesn't
   have any effect until a custom css rule is created by the end user. (#197)
+
 - more readable parser and more strict parser method aliases (#278)
 
 ### Fixes
 
 - Replaced deprecated ActiveRecord::Errors#each_full with ActiveRecord::Errors#full_messages. (#363)
+
 - fixing dependency condition evaluation where #Response.*_value is nil. (#297)
+
 - fixing grid answers leak, introduced in 5baa7ac3. thanks @jsurrett (#375, #377)
 
 1.0.0

data/features/step_definitions/parser_steps.rb

@@ -20,7 +20,7 @@ Given /^the questions?$/ do |q_string|
   SURVEY
 end
 
-Given /^I parse redcap file "([^"]*)"$/ do |name|
+Given /^I parse redcap file "(.*)"$/ do |name|
   Surveyor::RedcapParser.parse File.read(File.join(Rails.root, '..', 'features', 'support', name)), name
 end
 
@@ -50,7 +50,9 @@ Then /^there should be (\d+) question(?:s?) with:$/ do |x, table|
   table.hashes.each do |hash|
     hash["reference_identifier"] = nil if hash["reference_identifier"] == "nil"
     hash["custom_class"] = nil if hash["custom_class"] == "nil"
-    Question.find(:first, :conditions => hash).should_not be_nil
+    hash["is_mandatory"] = (hash["is_mandatory"] == "true" ? true : (hash["is_mandatory"] == "false" ? false : hash["is_mandatory"]))
+    result = Question.find(:first, :conditions => hash)
+    result.should_not be_nil
   end
 end
 

data/features/surveyor_dependencies.feature

@@ -328,3 +328,36 @@ Feature: Survey dependencies
     Then the question "How much does it cost to run your non-passive heating solutions?" should be hidden
     And I choose "Oven"
     Then the question "How much does it cost to run your non-passive heating solutions?" should be triggered
+
+  @javascript
+  Scenario: Count== dependencies
+    Given I parse
+    """
+      survey "Counting" do
+        section "First" do
+          q_counts "How many times do you count a day", :pick => :any
+          a_1 "Once for me"
+          a_2 "Once for you"
+          a_3 "Once for everyone"
+
+          label "Good!"
+          dependency :rule => "A"
+          condition_A :q_counts, "count==1"
+
+          label "Twice as good!"
+          dependency :rule => "A"
+          condition_A :q_counts, "count==2"
+        end
+      end
+    """
+    When I go to the surveys page
+    And I start the "Counting" survey
+    Then I should see "How many times do you count a day"
+      And the element "#q_2" should be hidden
+      And the element "#q_3" should be hidden
+    When I check "Once for me"
+    Then the element "#q_2" should not be hidden
+      And the element "#q_3" should be hidden
+    When I check "Once for you"
+    Then the element "#q_3" should not be hidden
+      And the element "#q_2" should be hidden

data/features/surveyor_parser.feature

@@ -449,3 +449,27 @@ Feature: Survey parser
       | sad         | 0             |
       | indifferent | 1             |
       | happy       | 2             |
+
+  Scenario: Parsing mandatory questions
+    Given I parse
+    """
+      survey "Chores", :default_mandatory => true do
+        section "Morning" do
+          q "Did you take out the trash", :pick => :one
+          a "Yes"
+          a "No"
+
+          q "Did you do the laundry", :pick => :one
+          a "Yes"
+          a "No"
+
+          q "Optional comments", :is_mandatory => false
+          a :string
+        end
+      end
+    """
+    And there should be 3 questions with:
+      | text                       | is_mandatory |
+      | Did you take out the trash | true         |
+      | Did you do the laundry     | true         |
+      | Optional comments          | false        |

data/lib/generators/surveyor/templates/surveys/kitchen_sink_survey.rb

@@ -1,12 +1,14 @@
 # encoding: UTF-8
-survey "Kitchen Sink survey" do
+# Question#is_mandatory is now false by default. The default_mandatory option allows you to set
+#   is_mandatory for all questions in a survey.
+survey "Kitchen Sink survey", :default_mandatory => false do
 
   section "Basic questions" do
     # A label is a question that accepts no answers
     label "These questions are examples of the basic supported input types"
 
     # A basic question with radio buttons
-    question_1 "What is your favorite color?", :pick => :one
+    question "What is your favorite color?", :pick => :one
     answer "red"
     answer "blue"
     answer "green"
@@ -14,7 +16,10 @@ survey "Kitchen Sink survey" do
     answer :other
 
     # A basic question with checkboxes
-    # "question" and "answer" may be abbreviated as "q" and "a"
+    # The "question" and "answer" methods may be abbreviated as "q" and "a".
+    # Append a reference identifier (a short string used for dependencies and validations) using the "_" underscore.
+    # Question reference identifiers must be unique within a survey.
+    # Answer reference identifiers must be unique within a question
     q_2 "Choose the colors you don't like", :pick => :any
     a_1 "red"
     a_2 "blue"
@@ -23,8 +28,7 @@ survey "Kitchen Sink survey" do
     a :omit
 
     # A dependent question, with conditions and rule to logically join them
-    # the question's reference identifier is "2a", and the answer's reference_identifier is "1"
-    # question reference identifiers used in conditions need to be unique on a survey for the lookups to work
+    # If the conditions, logically joined into the rule, are met, then the question will be shown.
     q_2a "Please explain why you don't like this color?"
     a_1 "explanation", :text, :help_text => "Please give an explanation for each color you don't like"
     dependency :rule => "A or B or C or D"
@@ -33,10 +37,8 @@ survey "Kitchen Sink survey" do
     condition_C :q_2, "==", :a_3
     condition_D :q_2, "==", :a_4
 
-    # A dependant question demonstrating the count operator. The
-    # dependency condition checks the answer count for the referenced question.
-    # It understands conditions of the form count> count< count>= count<=
-    # count!=
+    # The count operator checks how many responses exist for the referenced question.
+    # It understands conditions of the form: count== count!= count> count< count>= count<=
     q_2b "Please explain why you dislike so many colors?"
     a_1 "explanation", :text
     dependency :rule => "Z"
@@ -81,10 +83,10 @@ survey "Kitchen Sink survey" do
     condition_A :q_cooling_1, "!=", :a_4
 
     # Surveys, sections, questions, groups, and answers all take the following reference arguments
-    # :reference_identifier   # usually from paper
-    # :data_export_identifier # data export
-    # :common_namespace       # maping to a common vocab
-    # :common_identifier      # maping to a common vocab
+    # :reference_identifier   # used for parsing references, usually derived from the paper version
+    # :data_export_identifier # used for data export
+    # :common_namespace       # maping to a common vocabulary - the namespace
+    # :common_identifier      # maping to a common vocabulary - the identifier within the namespace
     q "Get me started on an improv sketch", :reference_identifier => "improv_start", :data_export_identifier => "i_s", :common_namespace => "sketch comedy questions", :common_identifier => "get me started"
     a "who", :string
     a "what", :string

data/lib/surveyor/models/dependency_condition_methods.rb

@@ -37,8 +37,8 @@ module Surveyor
       def to_hash(response_set)
         # all responses to associated question
         responses = question.blank? ? [] : response_set.responses.where("responses.answer_id in (?)", question.answer_ids).all
-        if self.operator.match /^count(>|>=|<|<=|=|!=)\d+$/
-          op, i = self.operator.scan(/^count(>|>=|<|<=|=|!=)(\d+)$/).flatten
+        if self.operator.match /^count(>|>=|<|<=|==|!=)\d+$/
+          op, i = self.operator.scan(/^count(>|>=|<|<=|==|!=)(\d+)$/).flatten
           # logger.warn({rule_key.to_sym => responses.count.send(op, i.to_i)})
           return {rule_key.to_sym => (op == "!=" ? !responses.count.send("==", i.to_i) : responses.count.send(op, i.to_i))}
         elsif operator == "!=" and (responses.blank? or responses.none?{|r| r.answer.id == self.answer.id})

data/lib/surveyor/models/question_methods.rb

@@ -39,7 +39,7 @@ module Surveyor
       end
 
       def default_args
-        self.is_mandatory ||= true
+        self.is_mandatory ||= false
         self.display_type ||= "default"
         self.pick ||= "none"
         self.data_export_identifier ||= Surveyor::Common.normalize(text)

data/lib/surveyor/parser.rb

@@ -152,9 +152,11 @@ module SurveyorParserSurveyMethods
 
     # build and set context
     title = args[0]
+    args[1] ||= {}
+    context[:default_mandatory] = args[1].delete(:default_mandatory) || false
     self.attributes = ({
       :title => title,
-      :reference_identifier => reference_identifier }.merge(args[1] || {}))
+      :reference_identifier => reference_identifier }.merge(args[1]))
     context[:survey] = self
   end
   def clear(context)
@@ -165,7 +167,8 @@ module SurveyorParserSurveyMethods
       :bad_references => [],
       :duplicate_references => [],
       :dependency_conditions => [],
-      :questions_with_correct_answers => {}
+      :questions_with_correct_answers => {},
+      :default_mandatory => false
     })
   end
 end
@@ -239,6 +242,7 @@ module SurveyorParserQuestionMethods
     self.attributes = ({
       :question_group => context[:question_group],
       :reference_identifier => reference_identifier,
+      :is_mandatory => context[:default_mandatory],
       :text => text,
       :display_type => (original_method =~ /label|image/ ? original_method : "default"),
       :display_order => context[:survey_section].questions.size }.merge(hash_args))

data/lib/surveyor/version.rb

@@ -1,3 +1,3 @@
 module Surveyor
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/lib/tasks_spec.rake

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require "rake"
+
+describe "app rake tasks" do
+  before(:all) do # do this only once before all tests
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    Rake.application.rake_require "lib/tasks/surveyor_tasks"
+    Rake::Task.define_task(:environment)
+  end
+  after do # after every test
+    @rake[@task_name].reenable if @task_name
+  end
+
+  it "should have 'environment' as a prereq" do
+    @task_name = "surveyor:parse"
+    @rake[@task_name].prerequisites.should include("environment")
+  end
+  it "should should trace" do
+    ENV["FILE"]="surveys/kitchen_sink_survey.rb"
+    @task_name = "surveyor:parse"
+    @rake.options.trace = true
+    Surveyor::Parser.should_receive(:parse).with(File.read(File.join(Rails.root, ENV["FILE"])), {:trace => true})
+    @rake[@task_name].invoke
+  end
+end

data/spec/models/dependency_condition_spec.rb

@@ -58,6 +58,24 @@ describe DependencyCondition do
       @dependency_condition.operator = "#"
       @dependency_condition.should have(1).error_on(:operator)
     end
+    it "should have a properly formed count operator" do
+      %w(count>1 count<1 count>=1 count<=1 count==1 count!=1).each do |o|
+        @dependency_condition.operator = o
+        @dependency_condition.should have(0).errors_on(:operator)
+      end
+      %w(count> count< count>= count<= count== count!=).each do |o|
+        @dependency_condition.operator = o
+        @dependency_condition.should have(1).errors_on(:operator)
+      end
+      %w(count=1 count><1 count<>1 count!1 count!!1 count=>1 count=<1).each do |o|
+        @dependency_condition.operator = o
+        @dependency_condition.should have(1).errors_on(:operator)
+      end
+      %w(count= count>< count<> count! count!! count=> count=< count> count< count>= count<= count== count!=).each do |o|
+        @dependency_condition.operator = o
+        @dependency_condition.should have(1).errors_on(:operator)
+      end
+    end
 
     it "should protect timestamps" do
       saved_attrs = @dependency_condition.attributes

data/spec/models/question_spec.rb

@@ -3,24 +3,24 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Question, "when creating a new question" do
   before(:each) do
     @ss = mock_model(SurveySection)
-    @question = Question.new(:text => "What is your favorite color?", :survey_section => @ss, :is_mandatory => true, :display_order => 1)
+    @question = Question.new(:text => "What is your favorite color?", :survey_section => @ss, :is_mandatory => false, :display_order => 1)
   end
 
   it "should be invalid without text" do
     @question.text = nil
     @question.should have(1).error_on(:text)
   end
-    
+
   it "should have a parent survey section" do
     # this causes issues with building and saving
     # @question.survey_section = nil
     # @question.should have(1).error_on(:survey_section_id)
   end
-    
-  it "should be mandatory by default" do
-    @question.mandatory?.should be_true
+
+  it "should not be mandatory by default" do
+    @question.mandatory?.should be_false
   end
-  
+
   it "should convert pick attribute to string" do
     @question.pick.should == "none"
     @question.pick = :one
@@ -28,7 +28,7 @@ describe Question, "when creating a new question" do
     @question.pick = nil
     @question.pick.should == nil
   end
-  
+
   it "should split the text" do
     @question.split_text.should == "What is your favorite color?"
     @question.split_text(:pre).should == "What is your favorite color?"
@@ -38,11 +38,11 @@ describe Question, "when creating a new question" do
     @question.split_text(:pre).should == "before"
     @question.split_text(:post).should == "after|extra"
   end
-  
+
   it "should have an api_id" do
     @question.api_id.length.should == 36
   end
-  
+
   it "should protect api_id, timestamps" do
     saved_attrs = @question.attributes
     if defined? ActiveModel::MassAssignmentSecurity::Error
@@ -63,11 +63,11 @@ describe Question, "that has answers" do
     Factory(:answer, :question => @question, :display_order => 1, :text => "red")
     Factory(:answer, :question => @question, :display_order => 2, :text => "green")
   end
-  
+
   it "should have answers" do
     @question.answers.should have(3).answers
   end
-  
+
   it "should retrieve those answers in display_order" do
     @question.answers.map(&:display_order).should == [1,2,3]
   end
@@ -79,7 +79,7 @@ describe Question, "that has answers" do
 end
 
 describe Question, "when interacting with an instance" do
-  
+
   before(:each) do
     @question = Factory(:question)
   end
@@ -88,7 +88,7 @@ describe Question, "when interacting with an instance" do
     @question.display_type = nil
     @question.renderer.should == :default
   end
-  
+
   it "should let you know if it is part of a group" do
     @question.question_group = Factory(:question_group)
     @question.solo?.should be_false
@@ -97,7 +97,7 @@ describe Question, "when interacting with an instance" do
     @question.solo?.should be_true
     @question.part_of_group?.should be_false
   end
-  
+
   require 'mustache'
   class FakeMustacheContext < ::Mustache
     def site
@@ -111,7 +111,7 @@ describe Question, "when interacting with an instance" do
       @question.text = "You are in {{site}}"
       @question.render_question_text(FakeMustacheContext).should == "You are in Northwestern"
   end
-        
+
 end
 
 describe Question, "with dependencies" do
@@ -131,5 +131,5 @@ describe Question, "with dependencies" do
     @question.destroy
     Dependency.find_by_id(dep_id).should be_nil
   end
-  
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: surveyor
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-30 00:00:00.000000000 Z
+date: 2012-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -521,6 +521,7 @@ files:
 - spec/lib/parser_spec.rb
 - spec/lib/rake_kitchen_sink.rb
 - spec/lib/redcap_parser_spec.rb
+- spec/lib/tasks_spec.rake
 - spec/lib/unparser_spec.rb
 - spec/models/answer_spec.rb
 - spec/models/dependency_condition_spec.rb
@@ -596,6 +597,7 @@ test_files:
 - spec/lib/parser_spec.rb
 - spec/lib/rake_kitchen_sink.rb
 - spec/lib/redcap_parser_spec.rb
+- spec/lib/tasks_spec.rake
 - spec/lib/unparser_spec.rb
 - spec/models/answer_spec.rb
 - spec/models/dependency_condition_spec.rb