surveyor 0.17.0 → 0.18.0

data/CHANGELOG

@@ -0,0 +1,210 @@
+0.18.0
+
+* finalizing redcap feature. parse dependencies. closes #93
+* finished decomposing redcap branching logic rules
+* working on redcap parser spec, question/answer reference lookup table
+* skipping calcuated answers for now
+* validations
+* more progress on redcap parser
+* working on redcap parser
+
+0.17.0
+
+* cucumber tests now work
+* correction to post install notes in rakefile
+* fix to rakefile instructions
+* un-dryed the gemfile to try to fix a gem location problem
+* added test boot file for test app usage, modified the rake task to copy in this file as well
+* removed unparser from specs, it was breakin a bunch of them. deferred investigation
+* got specs running and passing by adding internal rails app
+* added rvmrc to create default gemset and added bundler
+* Plugin installation is no longer supported
+* wrong information in readme
+* Merge branch 'master' into issue87
+* Add count operator example to kitchen sink survey
+* Generalize count operator to handle < <= >= !=
+* Parse/unparse surveys w/ count> DC operator
+* Add custom validation to handle count operator
+* Remove count> "operator."
+
+0.16.1
+
+* fixed surveyor.sections translation line
+* changed map resources order to access results survey success
+* add translations for Sections title
+* Add I18n to Sections title
+* updated date on license
+* updating results views and controller for new paths
+* new results routes
+
+0.16.0
+
+* minor fixes to unparsing
+* refining unparser. added rake task to unparse survey. closes #79
+* unparsing for groups, dependencies, validations
+* starting work on unparser for basic survey, section and question.
+
+0.15.0
+
+* prevent duplicate survey titles by appending incrementing numbers
+* rake task to remove a survey. closes #64
+* cleanup of old parsing strategy
+* features and specs and new parser. closes #62
+* first test driven work on parser
+* moving parser and common specs so they run automatically. fixing some spec errors
+* first shot a surveyor parser. some parts untested, but coded to determine style. references #62
+* refactoring counters
+* fixing failing specs. fixes acts\_as\_response issues
+
+0.14.5
+
+* use modules to include model methods. re-closes #77
+* rails init. destroy dependent models
+
+0.14.4
+
+* explicitly require surveyor models and helper. update sweeper syntax. closes #77
+* cleanup and requires
+* fixing instructions for extending surveyor. closes #76
+
+0.14.3
+
+* remove manual numbering until it works. refactoring to use common methods.
+
+0.14.2
+
+* lowercase localization. feature instead of story in cucumber feature
+* add results section
+* add simple admin section for displaying survey result set
+* Added manual numbering to labels as well
+
+0.14.1
+
+* typo in repeaters - use survey\_section\_id instead of section\_id
+
+0.14.0
+
+* view my survey specs fixed, fragment caching for surveyor#edit, localization. thanks bnadav
+
+0.13.0
+
+* simpler customization of surveyor.
+* spec plugins task
+* Feature instead of Story for cucumber. http://wiki.github.com/aslakhellesoy/cucumber/upgrading
+
+0.12.0
+
+* fix parser error in ruby 1.9, where instance_variables are symbols. closes #61
+* added fastercsv as dependency. closes #59
+* typo fix and test
+* fixed broken spec for survey urls, made pending surveyor_controller specs pass
+* Added explicit dependencycondition and validationcondition to DSL
+* have authentication work with authlogic
+* added "correct_answer" to parser, so you can specify one correct answer per question
+
+0.11.0
+
+* basic csv export. closes #21
+* add unique indicies. closes #45
+* add one_integer renderer. closes #51
+* constrain surveys to have unique access_codes. closes #45. closes #42
+* covering the extremely unlikely case that response_sets may have a non-unique access_code. closes #46. thanks jakewendt.
+* current user id not needed in the view, set in SurveyorController. closes #48. thanks jakewendt
+
+0.10.0
+
+* surveyor config['extend'] is now an array. custom modules (e.g. SurveyExtensions are now included from within surveyor models, allowing 
+the customizations to work on every request in development. closes #39. thanks to mgurley and jakewendt for the suggestions.
+* remove comment from surveyor_includes
+* css tweak
+* automatically add backslashes and eliminate multiple backslashes in relative root for routes
+* readme spelling and line breaks
+* fixing a failing spec with factory instead of mock parent model
+* upgrading cucumber to 0.6
+
+0.9.11
+
+* adding rails init.rb to make gem loading work. thanks mike gurley. closes #52.
+* Repeater changed to only have +1, not +3 as previous
+* added locking and transaction to surveyor update action. Prevents bug that caused duplicated answers
+* some light re-factoring and code readability changes
+* some code formatting changes
+* added require statement to specs so the factory_girl test dependency was more clear
+* spiced up the readme... may have some typos
+* readme update
+
+0.9.10
+
+* styles, adding labels for dates, correcting labels for radio buttons
+
+0.9.9
+
+* count label and image questions complete when mandatory. closes #38
+* validate by other responses. closes #35
+
+0.9.8
+
+* @current\_user.id if @current\_user isn't nil. Closes #37
+
+0.9.7
+
+* fixing typos
+* remove surveyor controller from load\_once\_paths. fixes issue with dependencies and unloading in development. closes #36
+
+0.9.6
+
+* response set reports progress and mandatory questions completeness. closes #33
+* adding correctness to response sets
+* adding correctness to responses
+
+0.9.5
+
+* allow append for survey parser. closes #32
+
+0.9.4
+
+* making tinycode compatible with ruby 1.8.6
+
+0.9.3
+
+* fix for survey parser require
+
+0.9.2
+
+* fixing specs for namespacing and move of tinycode
+* namespacing SurveyParser models to avoid conflict with model extensions
+
+0.9.1
+
+* fix for tinycode, more descriptive missing method
+
+0.9.0
+
+* validations in dsl and surveyor models
+* preserve underscores in reference identifiers
+* dsl specs, refactoring into base class
+* adding display order to surveys
+* moving columnizer and tiny column functionality to surveyor module
+* columnizer (and tiny code) refactoring, columnizer spec extracted from answer spec
+* cleanup of scopes with joins
+* refactoring dependency
+
+0.8.0
+
+* question group dependencies
+* expanded examples in kitchen sink survey
+* specs
+
+0.7.1
+
+* custom index page
+* custom classes and renderers
+* fixing typo in kitchen sink survey
+
+0.7.0
+
+* new kitchen sink survey with better documentation of DSL
+* migration misspelling
+* fixing ordering, dependency conditions evaluation, and changing named scopes for now
+* DRYing up surveyor DSL models
+* working on adding dependencies for question groups

data/README.md

@@ -1,18 +1,18 @@
 # Surveys On Rails
 
-Surveyor is a rails (gem) plugin, that brings surveys to your rails app. Before Rails 2.3, it was implemented as a Rails Engine. Surveys are written in a DSL (Domain Specific Language), with examples available in the "kitchen sink" survey.
+Surveyor is a ruby gem and developer tool that brings surveys into Rails applications. Surveys are written in the Surveyor DSL (Domain Specific Language). Before Rails 2.3, it was implemented as a Rails Engine. It also existed previously as a plugin. Today it is a gem only.
 
 ## Why you might want to use Surveyor
 
-If you have to have a part of your Rails app that asks users questions as part of a survey, quiz, or questionnaire then you should consider using Surveyor. This plugin was designed out of the need to deliver clinical research surveys to large populations of people but it can be used for any type of survey. It has an easy to use DSL to define the questions, response dependencies (if user answers 'A' to question 1 then show question 1a, etc...), and structure (different sections of longer questionnaires).
+If your Rails app needs to asks users questions as part of a survey, quiz, or questionnaire then you should consider using Surveyor. This gem was designed to deliver clinical research surveys to large populations, but it can be used for any type of survey.
 
-To build your questionnaire you define it using a custom DSL. Having a DSL instead of a GUI makes it significantly easier to import long surveys (no more endless clicking and typing into tiny text boxes). It also means that you can let your customer write out the survey, edit, re-edit, tweak, throw out and start over, any number of surveys without having to change a single line of code in your app. 
+The Surveyor DSL defines questions, answers, question groups, survey sections, dependencies (e.g. if response to question 4 is A, then show question 5), and validations. Answers are the options available for each question - user input is called "responses" and are grouped into "response sets". A DSL makes it significantly easier to import long surveys (no more click/copy/paste). It also enables non-programmers to write out, edit, re-edit... any number of surveys.
 
 ## DSL example
 
-Our DSL supports a wide range of question types (too many to list here) and varying dependency logic. Here are the first few questions of the "kitchen_sink" survey which should give you and idea of how the DSL works. The full example with all the types of questions is in the plugin and available if you run the installation instructions below.
+The Surveyor DSL supports a wide range of question types (too many to list here) and complex dependency logic. Here are the first few questions of the "kitchen sink" survey which should give you and idea of how it works. The full example with all the types of questions available if you follow the installation instructions below.
 
-    survey "“Kitchen Sink” survey" do
+    survey "Kitchen Sink survey" do
     
       section "Basic questions" do
         # A label is a question that accepts no answers
@@ -46,268 +46,60 @@ Our DSL supports a wide range of question types (too many to list here) and vary
         condition_C :q_2, "==", :a_3
         condition_D :q_2, "==", :a_4
     
-        # ... other question, sections and such. See kitchen_sink_survey.rb for more.
+        # ... other question, sections and such. See surveys/kitchen_sink_survey.rb for more.
      end 
     
     end
    
-The survey above shows a couple simple question types. The first one is a "pick one" type with the "other" custom entry. The second question is a "pick any" type with the option to "omit". It also has a dependency where you can ask a follow up question based on how the user answered the previous question. Notice the way the dependency is defined as a string. This implementation supports any number of complex dependency rules so not just "A or B or C or D" but "A and (B or C) and D" or "!A or ((B and !C) or D)". The conditions are the letters used they are evaluated separately using the operators defined for "==","<>", ">=","<", (the usual stuff) the plugged in to the dependency rule and evaluated. See the example survey for more details.
+The first question is "pick one" (radio buttons) with "other". The second question is "pick any" (checkboxes) with the option to "omit". It also features a dependency with a follow up question. Notice the dependency rule is defined as a string. We support complex dependency such as "A and (B or C) and D" or "A or ((B and C) or D)". The conditions are evaluated separately using the operators "==","!=","<>", ">=","<" the substituted by letter into to the dependency rule and evaluated.
 
 # Installation
 
-As a gem:
-  
-    # in environment.rb
-    config.gem "surveyor", :source => 'http://gemcutter.org'
-  
-    rake gems:install
+1. Add it to your bundler Gemfile:
 
-Or as a gem (with bundler):
+gem "surveyor"
 
-    # in Gemfile
-    gem "surveyor"
+`bundle install`
 
-    bundle install
-
-Generate assets, run migrations:
+2. Generate assets, run migrations:
     
-    script/generate surveyor
-    rake db:migrate
+`script/generate surveyor`
+`rake db:migrate`
 
-Try out the "kitchen sink" survey:
+3. Try out the "kitchen sink" survey. The rake task above generates surveys from our custom survey DSL (a good format for end users and stakeholders).
 
-    rake surveyor FILE=surveys/kitchen_sink_survey.rb
+`rake surveyor FILE=surveys/kitchen_sink_survey.rb`
 
-The rake tasks above generate surveys in our custom survey DSL (which is a great format for end users and stakeholders to use). 
-After you have run them start up your app and go to:
+4. Start up your app and visit:
 
-    http://localhost:3000/surveys
+http://localhost:3000/surveys
 
-Try taking the survey and compare it to the contents of the DSL file kitchen\_sink\_survey.rb. See how each type of DSL question maps to the resulting rendered view of the question.
+Try taking the survey and compare it to the contents of the DSL file kitchen\_sink\_survey.rb. See how the DSL maps to what you see.
 
 There are two other useful rake tasks for removing (only surveys without responses) and un-parsing (from db to DSL file) surveys:
 
-    rake surveyor:remove
-    rake surveyor:unparse
+`rake surveyor:remove`
+`rake surveyor:unparse`
 
 # Customizing surveyor
 
 Surveyor's controller, models, and views may be customized via classes in your app/models, app/helpers and app/controllers directories. To generate a sample custom controller and layout, run:
 
-    script/generate extend_surveyor
-
-and check out surveys/EXTENDING\_SURVEYOR
-
-# Dependencices
-
-Surveyor depends on Ruby (1.8.7 - 1.9.1), Rails 2.3 and the SASS style sheet language, part of HAML (http://haml.hamptoncatlin.com/download). It also depends on fastercsv for csv exports. For running the test suite you will need rspec and have the rspec plugin installed in your application.
-
-# Test Suite and Development
-
-To work on the plugin code (for enhancements, and bug fixes, etc...) fork this github project. Then clone the project under the vendor/plugins directory in a Rails app used only for development:
-
-# Changes
-
-0.17.0
-
-* cucumber tests now work
-* correction to post install notes in rakefile
-* fix to rakefile instructions
-* un-dryed the gemfile to try to fix a gem location problem
-* added test boot file for test app usage, modified the rake task to copy in this file as well
-* removed unparser from specs, it was breakin a bunch of them. deferred investigation
-* got specs running and passing by adding internal rails app
-* added rvmrc to create default gemset and added bundler
-* Plugin installation is no longer supported
-* wrong information in readme
-* Merge branch 'master' into issue87
-* Add count operator example to kitchen sink survey
-* Generalize count operator to handle < <= >= !=
-* Parse/unparse surveys w/ count> DC operator
-* Add custom validation to handle count operator
-* Remove count> "operator."
-
-0.16.1
-
-* fixed surveyor.sections translation line
-* changed map resources order to access results survey success
-* add translations for Sections title
-* Add I18n to Sections title
-* updated date on license
-* updating results views and controller for new paths
-* new results routes
-
-0.16.0
-
-* minor fixes to unparsing
-* refining unparser. added rake task to unparse survey. closes #79
-* unparsing for groups, dependencies, validations
-* starting work on unparser for basic survey, section and question.
-
-0.15.0
-
-* prevent duplicate survey titles by appending incrementing numbers
-* rake task to remove a survey. closes #64
-* cleanup of old parsing strategy
-* features and specs and new parser. closes #62
-* first test driven work on parser
-* moving parser and common specs so they run automatically. fixing some spec errors
-* first shot a surveyor parser. some parts untested, but coded to determine style. references #62
-* refactoring counters
-* fixing failing specs. fixes acts\_as\_response issues
-
-0.14.5
-
-* use modules to include model methods. re-closes #77
-* rails init. destroy dependent models
-
-0.14.4
-
-* explicitly require surveyor models and helper. update sweeper syntax. closes #77
-* cleanup and requires
-* fixing instructions for extending surveyor. closes #76
-
-0.14.3
-
-* remove manual numbering until it works. refactoring to use common methods.
-
-0.14.2
-
-* lowercase localization. feature instead of story in cucumber feature
-* add results section
-* add simple admin section for displaying survey result set
-* Added manual numbering to labels as well
-
-0.14.1
-
-* typo in repeaters - use survey\_section\_id instead of section\_id
-
-0.14.0
-
-* view my survey specs fixed, fragment caching for surveyor#edit, localization. thanks bnadav
-
-0.13.0
-
-* simpler customization of surveyor.
-* spec plugins task
-* Feature instead of Story for cucumber. http://wiki.github.com/aslakhellesoy/cucumber/upgrading
-
-0.12.0
-
-* fix parser error in ruby 1.9, where instance_variables are symbols. closes #61
-* added fastercsv as dependency. closes #59
-* typo fix and test
-* fixed broken spec for survey urls, made pending surveyor_controller specs pass
-* Added explicit dependencycondition and validationcondition to DSL
-* have authentication work with authlogic
-* added "correct_answer" to parser, so you can specify one correct answer per question
-
-0.11.0
-
-* basic csv export. closes #21
-* add unique indicies. closes #45
-* add one_integer renderer. closes #51
-* constrain surveys to have unique access_codes. closes #45. closes #42
-* covering the extremely unlikely case that response_sets may have a non-unique access_code. closes #46. thanks jakewendt.
-* current user id not needed in the view, set in SurveyorController. closes #48. thanks jakewendt
-
-0.10.0
-
-* surveyor config['extend'] is now an array. custom modules (e.g. SurveyExtensions are now included from within surveyor models, allowing 
-the customizations to work on every request in development. closes #39. thanks to mgurley and jakewendt for the suggestions.
-* remove comment from surveyor_includes
-* css tweak
-* automatically add backslashes and eliminate multiple backslashes in relative root for routes
-* readme spelling and line breaks
-* fixing a failing spec with factory instead of mock parent model
-* upgrading cucumber to 0.6
-
-0.9.11
-
-* adding rails init.rb to make gem loading work. thanks mike gurley. closes #52.
-* Repeater changed to only have +1, not +3 as previous
-* added locking and transaction to surveyor update action. Prevents bug that caused duplicated answers
-* some light re-factoring and code readability changes
-* some code formatting changes
-* added require statement to specs so the factory_girl test dependency was more clear
-* spiced up the readme... may have some typos
-* readme update
-
-0.9.10
-
-* styles, adding labels for dates, correcting labels for radio buttons
-
-0.9.9
-
-* count label and image questions complete when mandatory. closes #38
-* validate by other responses. closes #35
-
-0.9.8
-
-* @current\_user.id if @current\_user isn't nil. Closes #37
-
-0.9.7
-
-* fixing typos
-* remove surveyor controller from load\_once\_paths. fixes issue with dependencies and unloading in development. closes #36
-
-0.9.6
-
-* response set reports progress and mandatory questions completeness. closes #33
-* adding correctness to response sets
-* adding correctness to responses
-
-0.9.5
-
-* allow append for survey parser. closes #32
-
-0.9.4
-
-* making tinycode compatible with ruby 1.8.6
-
-0.9.3
-
-* fix for survey parser require
-
-0.9.2
-
-* fixing specs for namespacing and move of tinycode
-* namespacing SurveyParser models to avoid conflict with model extensions
-
-0.9.1
-
-* fix for tinycode, more descriptive missing method
-
-0.9.0
-
-* validations in dsl and surveyor models
-* preserve underscores in reference identifiers
-* dsl specs, refactoring into base class
-* adding display order to surveys
-* moving columnizer and tiny column functionality to surveyor module
-* columnizer (and tiny code) refactoring, columnizer spec extracted from answer spec
-* cleanup of scopes with joins
-* refactoring dependency
+`script/generate extend_surveyor`
 
-0.8.0
+and read surveys/EXTENDING\_SURVEYOR
 
-* question group dependencies
-* expanded examples in kitchen sink survey
-* specs
+# Requirements
 
-0.7.1
+Surveyor depends on Ruby (1.8.7 - 1.9.1), Rails 2.3 and HAML/SASS http://haml.hamptoncatlin.com/. It also depends on fastercsv for csv exports.
 
-* custom index page
-* custom classes and renderers
-* fixing typo in kitchen sink survey
+# Contributing, testing
 
-0.7.0
+To work on the code fork this github project. Run:
 
-* new kitchen sink survey with better documentation of DSL
-* migration misspelling
-* fixing ordering, dependency conditions evaluation, and changing named scopes for now
-* DRYing up surveyor DSL models
-* working on adding dependencies for question groups
+`bundler install`
+`rake testbed`
 
+and start writing tests!
 
-Copyright (c) 2008-2009 Brian Chamberlain and Mark Yoon, released under the MIT license
+Copyright (c) 2008-2010 Brian Chamberlain and Mark Yoon, released under the MIT license

data/Rakefile

@@ -30,12 +30,13 @@ rescue LoadError
   end
 end
 
+desc "Set up a rails app for testing in the spec dir"
+task :testbed => [:"testbed:build_app", :"testbed:copy_files", :"testbed:install_surveyor"]
 
 namespace "testbed" do
-
   RAPPNAME = "test_app" #This is also hardcoded in the spec/spec_helper.rb and gitignore file. Change it there too...
-
-  desc "Install rails base app in spec dir"
+  
+  "Generate rails app in spec dir"
   task :build_app do
     directory "spec"
     chdir("spec") do
@@ -60,7 +61,7 @@ namespace "testbed" do
     end
   end
 
-  desc "Install surveyor in rails base app, runs migrations, preps for testing"
+  desc "Install surveyor in test app, run migrations, prep test db"
   task :install_surveyor do
     sh "gem install surveyor"
     chdir("spec/#{RAPPNAME}") do
@@ -73,17 +74,11 @@ namespace "testbed" do
     puts "NOTE: We installed the surveyor gem using 'gem install surveyor' to fix a problem where RVM (or bundler or both) don't let Rails see generators in a gem. ('script/generate surveyor' for example). To remove the gem run `gem uninstall surveyor` to remove the gem version of surveyor leaving the dev version" # Getting around a bug/problem in bundler. see: http://bit.ly/9NZOEz
   end
 
-  desc "Remove rails base app in spec dir"
-  task :remove_app do
+  desc "Remove rails test app from spec dir"
+  task :remove do
     puts "Removing the test_app in the spec folder"
     sh "rm -rf spec/#{RAPPNAME}"
   end
-
-  desc "Setup for the test app (create)"
-  task :setup => [:build_app, :copy_files, :install_surveyor]
-  desc "Teardown for the test app (remove)"
-  task :teardown => [:remove_app]
-
 end # namespace
 
 require 'spec/rake/spectask'

data/VERSION

@@ -1 +1 @@
-0.17.0
+0.18.0

data/features/redcap.feature

@@ -0,0 +1,19 @@
+Feature: Survey creation
+  As a 
+  I want to write out the survey in the DSL
+  So that I can give it to survey participants
+
+  Scenario: Basic questions
+    Given I parse redcap file "REDCapDemoDatabase_DataDictionary.csv"
+    Then there should be 1 survey with:
+      ||
+    And there should be 143 questions with:
+      ||
+    And there should be 161 answers with:
+      ||
+    And there should be 3 resolved dependency_conditions with:
+      ||
+    And there should be 2 dependencies with:
+      | rule    |
+      | A       |
+      | A and B |

data/features/step_definitions/surveyor_steps.rb

@@ -2,6 +2,10 @@ Given /^I parse$/ do |string|
   Surveyor::Parser.parse(string)
 end
 
+Given /^I parse redcap file "([^"]*)"$/ do |name|
+  Surveyor::RedcapParser.parse File.read(File.join(RAILS_ROOT, '..', '..', 'features', 'support', name)), name
+end
+
 Then /^there should be (\d+) survey(?:s?) with:$/ do |x, table|
   Survey.count.should == x.to_i
   table.hashes.each do |hash|
@@ -33,7 +37,7 @@ Then /^there should be (\d+) answer(?:s?) with:$/ do |x, table|
   end
 end
 
-Then /^there should be (\d+) dependency with:$/ do |x, table|
+Then /^there should be (\d+) dependenc(?:y|ies) with:$/ do |x, table|
   Dependency.count.should == x.to_i
   table.hashes.each do |hash|
     Dependency.find(:first, :conditions => hash).should_not be_nil

data/features/support/REDCapDemoDatabase_DataDictionary.csv

@@ -0,0 +1,127 @@
+"Variable / Field Name","Form Name","Field Units","Section Header","Field Type","Field Label","Choices OR Calculations","Field Note","Text Validation Type","Text Validation Min","Text Validation Max",Identifier?,"Branching Logic (Show field only if...)","Required Field?"
+study_id,demographics,,,text,"Study ID",,,,,,,,
+date_enrolled,demographics,,"Demographic Characteristics",text,"Date subject signed consent",,YYYY-MM-DD,date,,,,,
+first_name,demographics,,,text,"First Name",,,,,,y,,
+last_name,demographics,,,text,"Last Name",,,,,,y,,
+address,demographics,,"Contact Information",notes,"Street, City, State, ZIP",,,,,,y,,
+telephone_1,demographics,,,text,"Phone number",,"Include Area Code",phone,,,y,,
+telephone_2,demographics,,,text,"Second phone number",,"Include Area Code",phone,,,y,,
+email,demographics,,,text,E-mail,,,email,,,y,,
+sex,demographics,,,dropdown,Gender,"0, Female | 1, Male",,,,,,,y
+given_birth,demographics,,,dropdown,"Has the subject given birth before?","0, No | 1, Yes",,,,,,"[sex] = ""0""",
+num_children,demographics,,,text,"How many times has the subject given birth?",,,integer,0,,,"[sex] = ""0"" and [given_birth] = ""1""",
+ethnicity,demographics,,,radio,Ethnicity,"0, Hispanic or Latino | 1, NOT Hispanic or Latino | 2, Unknown / Not Reported",,,,,,,
+race,demographics,,,radio,Race,"0, American Indian/Alaska Native | 1, Asian | 2, Native Hawaiian or Other Pacific Islander | 3, Black or African American | 4, White | 5, More Than One Race | 6, Unknown / Not Reported",,,,,,,
+dob,demographics,,,text,"Date of birth",,,date,,,y,,
+age,demographics,,,calc,"Age (years)","round(datediff([dob],'today','y'),1)",,,,,,,
+height,demographics,cm,,text,"Height (cm)",,,number,130,215,,,
+weight,demographics,kilograms,,text,"Weight (kilograms)",,,integer,35,200,,,
+bmi,demographics,kilograms,,calc,BMI,"round(([weight]*10000)/(([height])^(2)),1)",,,,,,,
+patient_document,demographics,,,file,"Patient document",,,,,,,,
+meds,demographics,,,checkbox,"Is patient taking any of the following medications? (check all that apply)","1, Lexapro | 2, Celexa | 3, Prozac | 4, Paxil | 5, Zoloft",,,,,,,
+diabetes,demographics,,,dropdown,"Patient has a diagnosis of diabetes mellitus?","0, No | 1, Yes",,,,,,,
+diabetes_type,demographics,,,dropdown,"Type of Diabetes Mellitus","0, Type 1 insulin-dependent | 1, Type 2 insulin-dependent | 2, Type 2 non insulin-dependent",,,,,,,
+dialysis_initiation,demographics,,"Dialysis Information",text,"Date of first outpatient dialysis treatment",,,date,,,,,
+access_type,demographics,,,dropdown,"Type of vascular access","0, Graft | 1, Fistula | 2, Catheter with maturing graft | 3, Catheter with maturing fistula",,,,,,,
+access_location,demographics,,,dropdown,"Location of currently used vascular access","0, Forearm | 1, Upper arm | 2, Internal jugular vein | 3, Subclavian vein | 4, Other",,,,,,,
+dialysis_unit_name,demographics,,,text,"Name of dialysis unit",,,,,,,,
+dialysis_unit_phone,demographics,,,text,"Phone number",,"Include Area Code",phone,,,,,
+dialysis_schedule_days,demographics,,,radio,"Days of the week patient is dialyzed","0, Monday-Wednesday-Friday | 1, Tuesday-Thursday-Saturday | 2, Other",,,,,,,
+dialysis_schedule_time,demographics,,,dropdown,"Shift patient is dialyzed","0, First shift | 1, Second shift | 2, Third shift | 3, Fourth shift",,,,,,,
+etiology_esrd,demographics,,,dropdown,"Etiology of ESRD","0, Diabetes | 1, Hypertension | 2, Glomerulonephritis | 3, Polycystic Kidney Disease | 4, Interstitial Nephritis | 5, Hereditary Nephritis | 6, Other",,,,,,,
+subject_comments,demographics,,"General Comments",notes,Comments,,,,,,,,
+date_visit_b,baseline_data,,"Baseline Measurements",text,"Date of baseline visit",,,date,,,,,
+date_blood_b,baseline_data,,,text,"Date blood was drawn",,,date,,,,,
+alb_b,baseline_data,g/dL,,text,"Serum Albumin (g/dL)",,,integer,3,5,,,
+prealb_b,baseline_data,mg/dL,,text,"Serum Prealbumin (mg/dL)",,,number,10,40,,,
+creat_b,baseline_data,mg/dL,,text,"Creatinine (mg/dL)",,,number,0.5,20,,,
+npcr_b,baseline_data,g/kg/d,,text,"Normalized Protein Catabolic Rate (g/kg/d)",,,number,0.5,2,,,
+chol_b,baseline_data,mg/dL,,text,"Cholesterol (mg/dL)",,,number,100,300,,,
+transferrin_b,baseline_data,mg/dL,,text,"Transferrin (mg/dL)",,,number,100,300,,,
+kt_v_b,baseline_data,,,text,Kt/V,,,number,0.9,3,,,
+drywt_b,baseline_data,kilograms,,text,"Dry weight (kilograms)",,,number,35,200,,,
+plasma1_b,baseline_data,,,dropdown,"Collected Plasma 1?","0, No | 1, Yes",,,,,,,
+plasma2_b,baseline_data,,,dropdown,"Collected Plasma 2?","0, No | 1, Yes",,,,,,,
+plasma3_b,baseline_data,,,dropdown,"Collected Plasma 3?","0, No | 1, Yes",,,,,,,
+serum1_b,baseline_data,,,dropdown,"Collected Serum 1?","0, No | 1, Yes",,,,,,,
+serum2_b,baseline_data,,,dropdown,"Collected Serum 2?","0, No | 1, Yes",,,,,,,
+serum3_b,baseline_data,,,dropdown,"Collected Serum 3?","0, No | 1, Yes",,,,,,,
+sga_b,baseline_data,,,text,"Subject Global Assessment (score = 1-7)",,,number,0.9,7.1,,,
+date_supplement_dispensed,baseline_data,,,text,"Date patient begins supplement",,,date,,,,,
+date_visit_1,month_1_data,,"Month 1",text,"Date of Month 1 visit",,,date,,,,,
+alb_1,month_1_data,g/dL,,text,"Serum Albumin (g/dL)",,,number,3,5,,,
+prealb_1,month_1_data,mg/dL,,text,"Serum Prealbumin (mg/dL)",,,number,10,40,,,
+creat_1,month_1_data,mg/dL,,text,"Creatinine (mg/dL)",,,number,0.5,20,,,
+npcr_1,month_1_data,g/kg/d,,text,"Normalized Protein Catabolic Rate (g/kg/d)",,,number,0.5,2,,,
+chol_1,month_1_data,mg/dL,,text,"Cholesterol (mg/dL)",,,number,100,300,,,
+transferrin_1,month_1_data,mg/dL,,text,"Transferrin (mg/dL)",,,number,100,300,,,
+kt_v_1,month_1_data,,,text,Kt/V,,,number,0.9,3,,,
+drywt_1,month_1_data,kilograms,,text,"Dry weight (kilograms)",,,number,35,200,,,
+no_show_1,month_1_data,,,text,"Number of treatments missed",,,number,0,7,,,
+compliance_1,month_1_data,,,dropdown,"How compliant was the patient in drinking the supplement?","0, 100 percent | 1, 99-75 percent | 2, 74-50 percent | 3, 49-25 percent | 4, 0-24 percent",,,,,,,
+hospit_1,month_1_data,,"Hospitalization Data",dropdown,"Was patient hospitalized since last visit?","0, No | 1, Yes",,,,,,,
+cause_hosp_1,month_1_data,,,dropdown,"What was the cause of hospitalization?","1, Vascular access related events | 2, CVD events | 3, Other",,,,,,,
+admission_date_1,month_1_data,,,text,"Date of hospital admission",,,date,,,,,
+discharge_date_1,month_1_data,,,text,"Date of hospital discharge",,,date,,,,,
+discharge_summary_1,month_1_data,,,dropdown,"Discharge summary in patients binder?","0, No | 1, Yes",,,,,,,
+death_1,month_1_data,,"Mortality Data",dropdown,"Has patient died since last visit?","0, No | 1, Yes",,,,,,,
+date_death_1,month_1_data,,,text,"Date of death",,,date,,,,,
+cause_death_1,month_1_data,,,dropdown,"What was the cause of death?","1, All-cause | 2, Cardiovascular",,,,,,,
+date_visit_2,month_2_data,,"Month 2",text,"Date of Month 2 visit",,,date,,,,,
+alb_2,month_2_data,g/dL,,text,"Serum Albumin (g/dL)",,,number,3,5,,,
+prealb_2,month_2_data,mg/dL,,text,"Serum Prealbumin (mg/dL)",,,number,10,40,,,
+creat_2,month_2_data,mg/dL,,text,"Creatinine (mg/dL)",,,number,0.5,20,,,
+npcr_2,month_2_data,g/kg/d,,text,"Normalized Protein Catabolic Rate (g/kg/d)",,,number,0.5,2,,,
+chol_2,month_2_data,mg/dL,,text,"Cholesterol (mg/dL)",,,number,100,300,,,
+transferrin_2,month_2_data,mg/dL,,text,"Transferrin (mg/dL)",,,number,100,300,,,
+kt_v_2,month_2_data,,,text,Kt/V,,,number,0.9,3,,,
+drywt_2,month_2_data,kilograms,,text,"Dry weight (kilograms)",,,number,35,200,,,
+no_show_2,month_2_data,,,text,"Number of treatments missed",,,number,0,7,,,
+compliance_2,month_2_data,,,dropdown,"How compliant was the patient in drinking the supplement?","0, 100 percent | 1, 99-75 percent | 2, 74-50 percent | 3, 49-25 percent | 4, 0-24 percent",,,,,,,
+hospit_2,month_2_data,,"Hospitalization Data",dropdown,"Was patient hospitalized since last visit?","0, No | 1, Yes",,,,,,,
+cause_hosp_2,month_2_data,,,dropdown,"What was the cause of hospitalization?","1, Vascular access related events | 2, CVD events | 3, Other",,,,,,,
+admission_date_2,month_2_data,,,text,"Date of hospital admission",,,date,,,,,
+discharge_date_2,month_2_data,,,text,"Date of hospital discharge",,,date,,,,,
+discharge_summary_2,month_2_data,,,dropdown,"Discharge summary in patients binder?","0, No | 1, Yes",,,,,,,
+death_2,month_2_data,,"Mortality Data",dropdown,"Has patient died since last visit?","0, No | 1, Yes",,,,,,,
+date_death_2,month_2_data,,,text,"Date of death",,,date,,,,,
+cause_death_2,month_2_data,,,dropdown,"What was the cause of death?","1, All-cause | 2, Cardiovascular",,,,,,,
+date_visit_3,month_3_data,,"Month 3",text,"Date of Month 3 visit",,,date,,,,,
+date_blood_3,month_3_data,,,text,"Date blood was drawn",,,date,,,,,
+alb_3,month_3_data,g/dL,,text,"Serum Albumin (g/dL)",,,number,3,5,,,
+prealb_3,month_3_data,mg/dL,,text,"Serum Prealbumin (mg/dL)",,,number,10,40,,,
+creat_3,month_3_data,mg/dL,,text,"Creatinine (mg/dL)",,,number,0.5,20,,,
+npcr_3,month_3_data,g/kg/d,,text,"Normalized Protein Catabolic Rate (g/kg/d)",,,number,0.5,2,,,
+chol_3,month_3_data,mg/dL,,text,"Cholesterol (mg/dL)",,,number,100,300,,,
+transferrin_3,month_3_data,mg/dL,,text,"Transferrin (mg/dL)",,,number,100,300,,,
+kt_v_3,month_3_data,,,text,Kt/V,,,number,0.9,3,,,
+drywt_3,month_3_data,kilograms,,text,"Dry weight (kilograms)",,,number,35,200,,,
+plasma1_3,month_3_data,,,dropdown,"Collected Plasma 1?","0, No | 1, Yes",,,,,,,
+plasma2_3,month_3_data,,,dropdown,"Collected Plasma 2?","0, No | 1, Yes",,,,,,,
+plasma3_3,month_3_data,,,dropdown,"Collected Plasma 3?","0, No | 1, Yes",,,,,,,
+serum1_3,month_3_data,,,dropdown,"Collected Serum 1?","0, No | 1, Yes",,,,,,,
+serum2_3,month_3_data,,,dropdown,"Collected Serum 2?","0, No | 1, Yes",,,,,,,
+serum3_3,month_3_data,,,dropdown,"Collected Serum 3?","0, No | 1, Yes",,,,,,,
+sga_3,month_3_data,,,text,"Subject Global Assessment (score = 1-7)",,,number,0.9,7.1,,,
+no_show_3,month_3_data,,,text,"Number of treatments missed",,,number,0,7,,,
+compliance_3,month_3_data,,,dropdown,"How compliant was the patient in drinking the supplement?","0, 100 percent | 1, 99-75 percent | 2, 74-50 percent | 3, 49-25 percent | 4, 0-24 percent",,,,,,,
+hospit_3,month_3_data,,"Hospitalization Data",dropdown,"Was patient hospitalized since last visit?","0, No | 1, Yes",,,,,,,
+cause_hosp_3,month_3_data,,,dropdown,"What was the cause of hospitalization?","1, Vascular access related events | 2, CVD events | 3, Other",,,,,,,
+admission_date_3,month_3_data,,,text,"Date of hospital admission",,,date,,,,,
+discharge_date_3,month_3_data,,,text,"Date of hospital discharge",,,date,,,,,
+discharge_summary_3,month_3_data,,,dropdown,"Discharge summary in patients binder?","0, No | 1, Yes",,,,,,,
+death_3,month_3_data,,"Mortality Data",dropdown,"Has patient died since last visit?","0, No | 1, Yes",,,,,,,
+date_death_3,month_3_data,,,text,"Date of death",,,date,,,,,
+cause_death_3,month_3_data,,,dropdown,"What was the cause of death?","1, All-cause | 2, Cardiovascular",,,,,,,
+complete_study,completion_data,,"Study Completion Information",dropdown,"Has patient completed study?","0, No | 1, Yes",,,,,,,
+withdraw_date,completion_data,,,text,"Put a date if patient withdrew study",,,date,,,,,
+withdraw_reason,completion_data,,,dropdown,"Reason patient withdrew from study","0, Non-compliance | 1, Did not wish to continue in study | 2, Could not tolerate the supplement | 3, Hospitalization | 4, Other",,,,,,,
+complete_study_date,completion_data,,,text,"Date of study completion",,,date,,,,,
+study_comments,completion_data,,"General Comments",notes,Comments,,,,,,,,
+fatexp20_0d31d8,promis_fatigue__short_form_7a,,"Please respond to each item by marking one answer per question.<br><br>In the past 7 days...",radio,"How often did you feel tired?...","1, 1 Never | 2, 2 Rarely | 3, 3 Sometimes | 4, 4 Often | 5, 5 Always",,,,,,,
+fatexp5_d80a4c,promis_fatigue__short_form_7a,,,radio,"How often did you experience extreme exhaustion?...","1, 1 Never | 2, 2 Rarely | 3, 3 Sometimes | 4, 4 Often | 5, 5 Always",,,,,,,
+fatexp18_396fe5,promis_fatigue__short_form_7a,,,radio,"How often did you run out of energy?...","1, 1 Never | 2, 2 Rarely | 3, 3 Sometimes | 4, 4 Often | 5, 5 Always",,,,,,,
+fatimp33_a9e236,promis_fatigue__short_form_7a,,,radio,"How often did your fatigue limit you at work (include work at home)?...","1, 1 Never | 2, 2 Rarely | 3, 3 Sometimes | 4, 4 Often | 5, 5 Always",,,,,,,
+fatimp30_5f4d82,promis_fatigue__short_form_7a,,,radio,"How often were you too tired to think clearly?...","1, 1 Never | 2, 2 Rarely | 3, 3 Sometimes | 4, 4 Often | 5, 5 Always",,,,,,,
+fatimp21_de19f3,promis_fatigue__short_form_7a,,,radio,"How often were you too tired to take a bath or shower?...","1, 1 Never | 2, 2 Rarely | 3, 3 Sometimes | 4, 4 Often | 5, 5 Always",,,,,,,
+fatimp40_f7e5db,promis_fatigue__short_form_7a,,,radio,"How often did you have enough energy to exercise strenuously?...","5, 5 Never | 4, 4 Rarely | 3, 3 Sometimes | 2, 2 Often | 1, 1 Always",,,,,,,

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

@@ -1,4 +1,4 @@
-survey "“Kitchen Sink” survey" do
+survey "Kitchen Sink survey" do
 
   section "Basic questions" do
     # A label is a question that accepts no answers

data/lib/surveyor/redcap_parser.rb

@@ -0,0 +1,233 @@
+require 'fastercsv'
+require 'active_support' # for humanize
+module Surveyor
+  class RedcapParser
+    # Attributes
+    attr_accessor :context
+
+    # Class methods
+    def self.parse(str, filename)
+      puts
+      Surveyor::RedcapParser.new.parse(str, filename)
+      puts
+      puts
+    end
+    
+    # Instance methods
+    def initialize
+      self.context = {}
+    end
+    def parse(str, filename)
+      begin
+        FasterCSV.parse(str, :headers => :first_row, :return_headers => true, :header_converters => :symbol) do |r|
+          if r.header_row? # header row
+            return puts "Missing headers: #{missing_columns(r).inspect}\n\n" unless missing_columns(r).blank?
+            context[:survey] = Survey.new(:title => filename)
+            print "survey_#{context[:survey].access_code} "
+          else # non-header rows
+            SurveySection.build_or_set(context, r)
+            Question.build_and_set(context, r)
+            Answer.build_and_set(context, r)
+            Validation.build_and_set(context, r)
+            Dependency.build_and_set(context, r)
+          end
+        end
+        print context[:survey].save ? "saved. " : " not saved! #{context[:survey].errors.each_full{|x| x }.join(", ")} "
+        # print context[:survey].sections.map(&:questions).flatten.map(&:answers).flatten.map{|x| x.errors.each_full{|y| y}.join}.join
+      rescue FasterCSV::MalformedCSVError
+        puts = "Oops. Not a valid CSV file."
+      # ensure
+      end
+    end
+    def missing_columns(r)
+      required_columns - r.headers.map(&:to_s)
+    end
+    def required_columns
+      %w(variable__field_name form_name field_units section_header field_type field_label choices_or_calculations field_note text_validation_type text_validation_min text_validation_max identifier branching_logic_show_field_only_if required_field)
+    end
+  end
+end
+
+# Surveyor models with extra parsing methods
+class Survey < ActiveRecord::Base
+  include Surveyor::Models::SurveyMethods
+end
+class SurveySection < ActiveRecord::Base
+  include Surveyor::Models::SurveySectionMethods
+  def self.build_or_set(context, r)
+    unless context[:survey_section] && context[:survey_section].reference_identifier == r[:form_name]
+      if match = context[:survey].sections.detect{|ss| ss.reference_identifier == r[:form_name]}
+        context[:current_survey_section] = match
+      else
+        context[:survey_section] = context[:survey].sections.build({:title => r[:form_name].to_s.humanize, :reference_identifier => r[:form_name]})
+        print "survey_section_#{context[:survey_section].reference_identifier} "
+      end
+    end
+  end
+end
+class QuestionGroup < ActiveRecord::Base
+  include Surveyor::Models::QuestionGroupMethods
+end
+class Question < ActiveRecord::Base
+  include Surveyor::Models::QuestionMethods
+  def self.build_and_set(context, r)
+    if !r[:section_header].blank?
+      context[:survey_section].questions.build({:display_type => "label", :text => r[:section_header]})
+      print "label_ "
+    end
+    context[:question] = context[:survey_section].questions.build({
+      :reference_identifier => r[:variable__field_name],
+      :text => r[:field_label],
+      :help_text => r[:field_note],
+      :is_mandatory => (/^y/i.match r[:required_field]) ? true : false,
+      :pick => pick_from_field_type(r[:field_type]),
+      :display_type => display_type_from_field_type(r[:field_type])
+    })
+    print "question_#{context[:question].reference_identifier} "
+  end
+  def self.pick_from_field_type(ft)
+    {"checkbox" => :any, "radio" => :one}[ft] || :none
+  end
+  def self.display_type_from_field_type(ft)
+    {"text" => :string, "dropdown" => :dropdown, "notes" => :text}[ft]
+  end
+end
+class Dependency < ActiveRecord::Base
+  include Surveyor::Models::DependencyMethods
+  def self.build_and_set(context, r)
+    unless (bl = r[:branching_logic_show_field_only_if]).blank?
+      # TODO: forgot to tie rule key to component, counting on the sequence of components
+      letters = ('A'..'Z').to_a
+      hash = decompose_rule(bl)
+      context[:dependency] = context[:question].build_dependency(:rule => hash[:rule])
+      hash[:components].each do |component|
+        context[:dependency].dependency_conditions.build(decompose_component(component).merge(:lookup_reference => context[:lookup], :rule_key => letters.shift))
+      end
+      print "dependency(#{hash[:rule]}) "
+    end
+  end
+  def self.decompose_component(str)
+     # [initial_52] = "1"
+    if match = str.match(/^\[(\w+)\] ?([!=><]+) ?"(\w+)"$/)
+      {:question_reference => match[1], :operator => match[2].gsub(/^=$/, "=="), :answer_reference => match[3]}
+    # [initial_119(2)] = "1"
+    elsif match = str.match(/^\[(\w+)\((\w+)\)\] ?([!=><]+) ?"1"$/)
+      {:question_reference => match[1], :operator => match[3].gsub(/^=$/, "=="), :answer_reference => match[2]}
+    # [f1_q15] >= 21
+    elsif match = str.match(/^\[(\w+)\] ?([!=><]+) ?(\d+)$/)
+      {:question_reference => match[1], :operator => match[2].gsub(/^=$/, "=="), :integer_value => match[3]}
+    # uhoh
+    else
+      puts "\n!!! skipping dependency_condition #{str}"
+    end
+  end
+  def self.decompose_rule(str)
+    # see spec/lib/redcap_parser_spec.rb for examples
+    letters = ('A'..'Z').to_a
+    rule = str
+    components = str.split(/\band\b|\bor\b|\((?!\d)|\)(?!\(|\])/).reject(&:blank?).map(&:strip)
+    components.each_with_index do |part, i|
+      # internal commas on the right side of the operator e.g. '[initial_189] = "1, 2, 3"'
+      if match = part.match(/^(\[[^\]]+\][^\"]+)"([0-9 ]+,[0-9 ,]+)"$/)
+        nums = match[2].split(",").map(&:strip)
+        components[i] = nums.map{|x| "#{match[1]}\"#{x}\""}
+        # sub in rule key
+        rule = rule.gsub(part, "(#{nums.map{letters.shift}.join(' and ')})")
+      # multiple internal parenthesis on the left  e.g. '[initial_119(1)(2)(3)(4)(6)] = "1"'
+      elsif match = part.match(/^\[(\w+)(\(\d+\)\([\d\(\)]+)\]([^\"]+"\d+")$/)
+        nums = match[2].split(/\(|\)/).reject(&:blank?).map(&:strip)
+        components[i] = nums.map{|x| "[#{match[1]}(#{x})]#{match[3]}"}
+        # sub in rule key
+        rule = rule.gsub(part, "(#{nums.map{letters.shift}.join(' and ')})")
+      else
+        # 'or' on the right of the operator        
+        components[i] = components[i-1].gsub(/"(\d+)"/, part) if part.match(/^"(\d+)"$/) && i != 0
+        # sub in rule key
+        rule = rule.gsub(part){letters.shift}
+      end
+    end
+    {:rule => rule, :components => components.flatten}
+  end
+end
+class DependencyCondition < ActiveRecord::Base
+  include Surveyor::Models::DependencyConditionMethods
+  attr_accessor :question_reference, :answer_reference, :lookup_reference
+  before_save :resolve_references
+  def resolve_references
+    print "resolve(#{question_reference},#{answer_reference})"
+    if row = lookup_reference.find{|r| r[0] == question_reference and r[1] == answer_reference}
+      print "...found "
+      self.answer = row[2]
+      self.question = self.answer.question
+    else
+      puts "\n!!! failed lookup for dependency_condition q: #{question_reference} a: #{question_reference}"
+    end
+  end
+end
+class Answer < ActiveRecord::Base
+  include Surveyor::Models::AnswerMethods
+  def self.build_and_set(context, r)
+    r[:choices_or_calculations].to_s.split("|").each do |pair|
+      aref, atext = pair.strip.split(", ")
+      if aref.blank? or atext.blank?
+        puts "\n!!! skipping answer #{pair}"
+      else
+        context[:answer] = context[:question].answers.build(:reference_identifier => aref, :text => atext)
+        unless context[:question].reference_identifier.blank? or aref.blank? or !context[:answer].valid?
+          context[:lookup] ||= []
+          context[:lookup] << [context[:question].reference_identifier, aref, context[:answer]]
+        end
+        puts "#{context[:answer].errors.full_messages}, #{context[:answer].inspect}" unless context[:answer].valid?
+        print "answer_#{context[:answer].reference_identifier} "
+      end
+    end
+  end
+end
+class Validation < ActiveRecord::Base
+  include Surveyor::Models::ValidationMethods
+  def self.build_and_set(context, r)
+    # text_validation_type text_validation_min text_validation_max
+    min = r[:text_validation_min].to_s.blank? ? nil : r[:text_validation_min].to_s
+    max = r[:text_validation_max].to_s.blank? ? nil : r[:text_validation_max].to_s
+    type = r[:text_validation_type].to_s.blank? ? nil : r[:text_validation_type].to_s
+    if min or max
+      context[:question].answers.each do |a|
+        context[:validation] = a.validations.build(:rule => min ? max ? "A and B" : "A" : "B")
+        context[:validation].validation_conditions.build(:rule_key => "A", :operator => ">=", :integer_value => min) if min
+        context[:validation].validation_conditions.build(:rule_key => "B", :operator => "<=", :integer_value => max) if max
+      end
+    elsif type
+      # date email integer number phone
+      case r[:text_validation_type]
+      when "date"
+        context[:question].display_type = :date if context[:question].display_type == :string
+      when "email"
+        context[:question].answers.each do |a|
+          context[:validation] = a.validations.build(:rule => "A")
+          context[:validation].validation_conditions.build(:rule_key => "A", :operator => "=~", :regexp_value => "^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$")
+        end
+      when "integer"
+        context[:question].display_type = :integer if context[:question].display_type == :string
+        context[:question].answers.each do |a|
+          context[:validation] = a.validations.build(:rule => "A")
+          context[:validation].validation_conditions.build(:rule_key => "A", :operator => "=~", :regexp_value => "\d+")
+        end
+      when "number"
+        context[:question].display_type = :float if context[:question].display_type == :string
+        context[:question].answers.each do |a|
+          context[:validation] = a.validations.build(:rule => "A")
+          context[:validation].validation_conditions.build(:rule_key => "A", :operator => "=~", :regexp_value => "^\d*(,\d{3})*(\.\d*)?$")
+        end
+      when "phone"
+        context[:question].answers.each do |a|
+          context[:validation] = a.validations.build(:rule => "A")
+          context[:validation].validation_conditions.build(:rule_key => "A", :operator => "=~", :regexp_value => "\d{3}.*\d{4}")
+        end
+      end
+    end
+  end
+  
+end
+class ValidationCondition < ActiveRecord::Base
+  include Surveyor::Models::ValidationConditionMethods
+end

data/lib/tasks/surveyor_tasks.rake

@@ -10,6 +10,15 @@ namespace :surveyor do
     Surveyor::Parser.parse File.read(file)
     puts "--- Done #{file} ---"
   end
+  desc "generate and load survey from REDCap Data Dictionary (specify FILE=surveys/redcap.csv)"
+  task :redcap => :environment do
+    raise "USAGE: file name required e.g. 'FILE=surveys/redcap_demo_survey.csv'" if ENV["FILE"].blank?
+    file = File.join(RAILS_ROOT, ENV["FILE"])
+    raise "File does not exist: #{file}" unless FileTest.exists?(file)
+    puts "--- Parsing #{file} ---"
+    Surveyor::RedcapParser.parse File.read(file), File.basename(file, ".csv")
+    puts "--- Done #{file} ---"
+  end
   desc "generate a surveyor DSL file from a survey"
   task :unparse => :environment do
     surveys = Survey.all

data/spec/lib/redcap_parser_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Surveyor::RedcapParser do
+  before(:each) do
+    # @parser = Surveyor::Parser.new
+  end
+  it "should decompose dependency rules" do
+    # basic
+    Dependency.decompose_rule('[f1_q12]="1"').should == {:rule => "A", :components => ['[f1_q12]="1"']}
+    # spacing
+    Dependency.decompose_rule('[f1_q9] = "1"').should == {:rule => "A", :components => ['[f1_q9] = "1"']}
+    # and
+    Dependency.decompose_rule('[pre_q88]="1" and [pre_q90]="1"').should == {:rule => "A and B", :components => ['[pre_q88]="1"', '[pre_q90]="1"']}
+    # or
+    Dependency.decompose_rule('[second_q111]="1" or [second_q111]="3"').should == {:rule => "A or B", :components => ['[second_q111]="1"', '[second_q111]="3"']}
+    # or and
+    Dependency.decompose_rule('[second_q100]="1" or [second_q100]="3" and [second_q101]="1"').should == {:rule => "A or B and C", :components => ['[second_q100]="1"', '[second_q100]="3"', '[second_q101]="1"']}
+    # and or
+    Dependency.decompose_rule('[second_q4]="1" and [second_q11]="1" or [second_q11]="98"').should == {:rule => "A and B or C", :components => ['[second_q4]="1"', '[second_q11]="1"', '[second_q11]="98"']}
+    # or or or
+    Dependency.decompose_rule('[pre_q74]="1" or [pre_q74]="2" or [pre_q74]="4" or [pre_q74]="5"').should == {:rule => "A or B or C or D", :components => ['[pre_q74]="1"', '[pre_q74]="2"', '[pre_q74]="4"', '[pre_q74]="5"']}
+    # and with different operator
+    Dependency.decompose_rule('[f1_q15] >= 21 and [f1_q28] ="1"').should == {:rule => "A and B", :components => ['[f1_q15] >= 21', '[f1_q28] ="1"']}
+  end
+  it "should decompose nested dependency rules" do
+    # external parenthesis
+    Dependency.decompose_rule('([pre_q74]="1" or [pre_q74]="2" or [pre_q74]="4" or [pre_q74]="5") and [pre_q76]="2"').should == {:rule => "(A or B or C or D) and E", :components => ['[pre_q74]="1"', '[pre_q74]="2"', '[pre_q74]="4"', '[pre_q74]="5"', '[pre_q76]="2"']}
+    # internal parenthesis
+    Dependency.decompose_rule('[f1_q10(4)]="1"').should == {:rule => "A", :components => ['[f1_q10(4)]="1"']}
+    # internal and external parenthesis
+    Dependency.decompose_rule('([f1_q7(11)] = "1" or [initial_52] = "1") and [pre_q76]="2"').should == {:rule => "(A or B) and C", :components => ['[f1_q7(11)] = "1"', '[initial_52] = "1"', '[pre_q76]="2"']}
+  end
+  it "should decompose shortcut dependency rules" do
+    # 'or' on the right of the operator
+    Dependency.decompose_rule('[initial_108] = "1" or "2"').should == {:rule => "A or B", :components => ['[initial_108] = "1"', '[initial_108] = "2"']}
+    # multiple 'or' on the right
+    Dependency.decompose_rule('[initial_52] = "1" or "2" or "3"').should == {:rule => "A or B or C", :components => ['[initial_52] = "1"', '[initial_52] = "2"', '[initial_52] = "3"']}
+    # commas on the right
+    Dependency.decompose_rule('[initial_189] = "1, 2, 3"').should == {:rule => "(A and B and C)", :components => ['[initial_189] = "1"', '[initial_189] = "2"', '[initial_189] = "3"']}
+    # multiple internal parenthesis on the left
+    Dependency.decompose_rule('[initial_119(1)(2)(3)(4)(5)] = "1"').should == {:rule => "(A and B and C and D and E)", :components => ['[initial_119(1)] = "1"', '[initial_119(2)] = "1"', '[initial_119(3)] = "1"', '[initial_119(4)] = "1"', '[initial_119(5)] = "1"']}
+  end
+  it "should decompose components" do
+    Dependency.decompose_component('[initial_52] = "1"').should == {:question_reference => 'initial_52', :operator => '==', :answer_reference => '1'}
+    Dependency.decompose_component('[initial_119(2)] = "1"').should == {:question_reference => 'initial_119', :operator => '==', :answer_reference => '2'}
+    Dependency.decompose_component('[f1_q15] >= 21').should == {:question_reference => 'f1_q15', :operator => '>=', :integer_value => '21'}
+  end
+end

data/surveyor.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{surveyor}
-  s.version = "0.17.0"
+  s.version = "0.18.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Chamberlain", "Mark Yoon"]
-  s.date = %q{2010-11-30}
+  s.date = %q{2010-12-01}
   s.email = %q{yoon@northwestern.edu}
   s.extra_rdoc_files = [
     "README.md"
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".gitignore",
      ".rvmrc",
+     "CHANGELOG",
      "Gemfile",
      "Gemfile.lock",
      "MIT-LICENSE",
@@ -52,8 +53,10 @@ Gem::Specification.new do |s|
      "app/views/surveyor/new.html.haml",
      "app/views/surveyor/show.html.haml",
      "config/routes.rb",
+     "features/redcap.feature",
      "features/step_definitions/surveyor_steps.rb",
      "features/step_definitions/web_steps.rb",
+     "features/support/REDCapDemoDatabase_DataDictionary.csv",
      "features/support/env.rb",
      "features/support/paths.rb",
      "features/surveyor.feature",
@@ -137,9 +140,6 @@ Gem::Specification.new do |s|
      "generators/surveyor/templates/migrate/create_validations.rb",
      "generators/surveyor/templates/surveys/kitchen_sink_survey.rb",
      "generators/surveyor/templates/tasks/surveyor.rb",
-     "generators/test_surveyor/templates/TESTING_SURVEYOR",
-     "generators/test_surveyor/templates/environments/cucumber.rb",
-     "generators/test_surveyor/test_surveyor_generator.rb",
      "init.rb",
      "install.rb",
      "lib/surveyor.rb",
@@ -157,6 +157,7 @@ Gem::Specification.new do |s|
      "lib/surveyor/models/validation_condition_methods.rb",
      "lib/surveyor/models/validation_methods.rb",
      "lib/surveyor/parser.rb",
+     "lib/surveyor/redcap_parser.rb",
      "lib/surveyor/surveyor_controller_methods.rb",
      "lib/surveyor/unparser.rb",
      "lib/tasks/surveyor_tasks.rake",
@@ -165,6 +166,7 @@ Gem::Specification.new do |s|
      "spec/factories.rb",
      "spec/lib/common_spec.rb",
      "spec/lib/parser_spec.rb",
+     "spec/lib/redcap_parser_spec.rb",
      "spec/lib/unparser_spec.rb",
      "spec/models/answer_spec.rb",
      "spec/models/dependency_condition_spec.rb",
@@ -197,6 +199,7 @@ Gem::Specification.new do |s|
      "spec/factories.rb",
      "spec/lib/common_spec.rb",
      "spec/lib/parser_spec.rb",
+     "spec/lib/redcap_parser_spec.rb",
      "spec/lib/unparser_spec.rb",
      "spec/models/answer_spec.rb",
      "spec/models/dependency_condition_spec.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: surveyor
 version: !ruby/object:Gem::Version 
-  hash: 91
+  hash: 87
   prerelease: false
   segments: 
   - 0
-  - 17
+  - 18
   - 0
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors: 
 - Brian Chamberlain
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-30 00:00:00 -06:00
+date: 2010-12-01 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,6 +58,7 @@ extra_rdoc_files:
 files: 
 - .gitignore
 - .rvmrc
+- CHANGELOG
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -93,8 +94,10 @@ files:
 - app/views/surveyor/new.html.haml
 - app/views/surveyor/show.html.haml
 - config/routes.rb
+- features/redcap.feature
 - features/step_definitions/surveyor_steps.rb
 - features/step_definitions/web_steps.rb
+- features/support/REDCapDemoDatabase_DataDictionary.csv
 - features/support/env.rb
 - features/support/paths.rb
 - features/surveyor.feature
@@ -178,9 +181,6 @@ files:
 - generators/surveyor/templates/migrate/create_validations.rb
 - generators/surveyor/templates/surveys/kitchen_sink_survey.rb
 - generators/surveyor/templates/tasks/surveyor.rb
-- generators/test_surveyor/templates/TESTING_SURVEYOR
-- generators/test_surveyor/templates/environments/cucumber.rb
-- generators/test_surveyor/test_surveyor_generator.rb
 - init.rb
 - install.rb
 - lib/surveyor.rb
@@ -198,6 +198,7 @@ files:
 - lib/surveyor/models/validation_condition_methods.rb
 - lib/surveyor/models/validation_methods.rb
 - lib/surveyor/parser.rb
+- lib/surveyor/redcap_parser.rb
 - lib/surveyor/surveyor_controller_methods.rb
 - lib/surveyor/unparser.rb
 - lib/tasks/surveyor_tasks.rake
@@ -206,6 +207,7 @@ files:
 - spec/factories.rb
 - spec/lib/common_spec.rb
 - spec/lib/parser_spec.rb
+- spec/lib/redcap_parser_spec.rb
 - spec/lib/unparser_spec.rb
 - spec/models/answer_spec.rb
 - spec/models/dependency_condition_spec.rb
@@ -309,6 +311,7 @@ test_files:
 - spec/factories.rb
 - spec/lib/common_spec.rb
 - spec/lib/parser_spec.rb
+- spec/lib/redcap_parser_spec.rb
 - spec/lib/unparser_spec.rb
 - spec/models/answer_spec.rb
 - spec/models/dependency_condition_spec.rb

data/generators/test_surveyor/templates/environments/cucumber.rb

@@ -1,21 +0,0 @@
-config.cache_classes = true # This must be true for Cucumber to operate correctly!
-
-# Log error messages when you accidentally call methods on nil.
-config.whiny_nils = true
-
-# Show full error reports and disable caching
-config.action_controller.consider_all_requests_local = true
-config.action_controller.perform_caching             = false
-
-# Disable request forgery protection in test environment
-config.action_controller.allow_forgery_protection    = false
-
-# Tell Action Mailer not to deliver emails to the real world.
-# The :test delivery method accumulates sent emails in the
-# ActionMailer::Base.deliveries array.
-config.action_mailer.delivery_method = :test
-
-config.gem "cucumber",    :lib => false,        :version => ">=0.3.11" unless File.directory?(File.join(Rails.root, 'vendor/plugins/cucumber'))
-config.gem "webrat",      :lib => false,        :version => ">=0.4.4" unless File.directory?(File.join(Rails.root, 'vendor/plugins/webrat'))
-config.gem "rspec",       :lib => false,        :version => ">=1.2.6" unless File.directory?(File.join(Rails.root, 'vendor/plugins/rspec'))
-config.gem "rspec-rails", :lib => 'spec/rails', :version => ">=1.2.6" unless File.directory?(File.join(Rails.root, 'vendor/plugins/rspec-rails'))

data/generators/test_surveyor/test_surveyor_generator.rb

@@ -1,15 +0,0 @@
-class TestSurveyorGenerator < Rails::Generator::Base
-  def manifest
-    record do |m|
-      
-      m.directory "surveys"
-      
-      # Copy README to your app
-      m.file "TESTING_SURVEYOR", "surveys/TESTING_SURVEYOR"
-        
-      m.file "environments/cucumber.rb", "config/environments/cucumber.rb"
-      m.readme "TESTING_SURVEYOR"
-      
-    end
-  end
-end