surveyor 0.14.5 → 0.15.0

data/README.md

@@ -84,10 +84,6 @@ Try out the "kitchen sink" survey:
 
     rake surveyor FILE=surveys/kitchen_sink_survey.rb
 
-The rake surveyor task overwrites previous surveys by default, but can append instead:
-
-    rake surveyor FILE=surveys/kitchen_sink_survey.rb APPEND=true
-
 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:
 
@@ -114,6 +110,18 @@ To work on the plugin code (for enhancements, and bug fixes, etc...) fork this g
 
 # Changes
 
+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

data/VERSION

@@ -1 +1 @@
-0.14.5
+0.15.0

data/features/step_definitions/surveyor_steps.rb

@@ -1,7 +1,67 @@
-Given /^I am a banana$/ do
-  @me = "banana"
+Given /^I parse$/ do |string|
+  Surveyor::Parser.parse(string)
 end
 
-Then /^I should be a banana$/ do
-  @me.should == "banana"
+Then /^there should be (\d+) survey(?:s?) with:$/ do |x, table|
+  Survey.count.should == x.to_i
+  table.hashes.each do |hash|
+    Survey.find(:first, :conditions => hash).should_not be_nil
+  end
+end
+
+Then /^there should be (\d+) question groups with:$/ do |x, table|
+  QuestionGroup.count.should == x.to_i
+  table.hashes.each do |hash|
+    QuestionGroup.find(:first, :conditions => hash).should_not be_nil
+  end
+end
+
+Then /^there should be (\d+) question(?:s?) with:$/ do |x, table|
+  Question.count.should == x.to_i
+  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
+  end
+end
+
+Then /^there should be (\d+) answer(?:s?) with:$/ do |x, table|
+  Answer.count.should == x.to_i
+  table.hashes.each do |hash|
+    hash["reference_identifier"] = nil if hash["reference_identifier"] == "nil"
+    Answer.find(:first, :conditions => hash).should_not be_nil
+  end
+end
+
+Then /^there should be (\d+) dependency with:$/ do |x, table|
+  Dependency.count.should == x.to_i
+  table.hashes.each do |hash|
+    Dependency.find(:first, :conditions => hash).should_not be_nil
+  end
+end
+
+Then /^there should be (\d+) resolved dependency_condition(?:s?) with:$/ do |x, table|
+  DependencyCondition.count.should == x.to_i
+  table.hashes.each do |hash|
+    d = DependencyCondition.find(:first, :conditions => hash)
+    d.should_not be_nil
+    d.question.should_not be_nil
+    d.answer.should_not be_nil
+  end
+end
+
+
+Then /^there should be (\d+) validation(?:s?) with:$/ do |x, table|
+  Validation.count.should == x.to_i
+  table.hashes.each do |hash|
+    Validation.find(:first, :conditions => hash).should_not be_nil
+  end
+end
+
+Then /^there should be (\d+) validation_condition(?:s?) with:$/ do |x, table|
+  ValidationCondition.count.should == x.to_i
+  table.hashes.each do |hash|
+    hash["integer_value"] = nil if hash["integer_value"] == "nil"
+    ValidationCondition.find(:first, :conditions => hash).should_not be_nil
+  end
 end

data/features/surveyor.feature

@@ -1,11 +1,144 @@
-Feature: Logging in
-  As an anonymous user with an account
-  I want to log in to my account
-  So that I can be myself
-
-  #
-  # Log in: get form
-  #
-  Scenario: Anonymous user can get a login form.
-    Given I am a banana
-    Then I should be a banana
+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
+    """
+      survey "Simple survey" do
+        section "Basic questions" do
+          label "These questions are examples of the basic supported input types"
+
+          question_1 "What is your favorite color?", :pick => :one
+          answer "red"
+          answer "blue"
+          answer "green"
+          answer :other
+
+          q_2b "Choose the colors you don't like", :pick => :any
+          a_1 "orange"
+          a_2 "purple"
+          a_3 "brown"
+          a :omit
+        end
+      end
+    """
+    Then there should be 1 survey with:
+      | title         |
+      | Simple survey |
+    And there should be 3 questions with:
+      | reference_identifier | text                                                            | pick | display_type |
+      | nil                  | These questions are examples of the basic supported input types | none | label        |
+      | 1                    | What is your favorite color?                                    | one  | default      |
+      | 2b                   | Choose the colors you don't like                                | any  | default      |
+    And there should be 8 answers with:
+      | reference_identifier | text   | response_class |
+      | nil                  | red    | answer         |
+      | nil                  | blue   | answer         |
+      | nil                  | green  | answer         |
+      | nil                  | Other  | answer         |
+      | 1                    | orange | answer         |
+      | 2                    | purple | answer         |
+      | 3                    | brown  | answer         |
+      | nil                  | Omit   | answer         |
+
+  Scenario: More complex questions
+    Given I parse
+    """
+      survey "Complex survey" do
+        section "Complicated questions" do
+          grid "Tell us how you feel today" do
+            a "-2"
+            a "-1"
+            a "0"
+            a "1"
+            a "2"
+            q "down|up" , :pick => :one
+            q "sad|happy", :pick => :one
+            q "limp|perky", :pick => :one
+          end
+
+          q "Choose your favorite utensils and enter frequency of use (daily, weekly, monthly, etc...)", :pick => :any
+          a "spoon", :string
+          a "fork", :string
+          a "knife", :string
+          a :other, :string
+
+          repeater "Tell us about the cars you own" do
+            q "Make", :pick => :one, :display_type => :dropdown
+            a "Toyota"
+            a "Ford"
+            a "GMChevy"
+            a "Ferrari"
+            a "Tesla"
+            a "Honda"
+            a "Other weak brand"
+            q "Model"
+            a :string
+            q "Year"
+            a :string
+          end
+        end
+      end  
+    """
+    Then there should be 1 survey with:
+      | title          |
+      | Complex survey |
+    And there should be 2 question groups with:
+      | text                           | display_type |
+      | Tell us how you feel today     | grid         |
+      | Tell us about the cars you own | repeater     |
+    And there should be 7 questions with:
+      | text    | pick | display_type |
+      | Make    | one  | dropdown     |
+    And there should be 28 answers with:
+      | text  | response_class |
+      | -2    | answer         |
+      | Other | string         |
+
+  Scenario: Dependencies and validations
+    Given I parse
+    """
+      survey "Dependency and validation survey" do
+        section "Conditionals" do
+          q_montypython3 "What... is your name? (e.g. It is 'Arthur', King of the Britons)"
+          a_1 :string
+    
+          q_montypython4 "What... is your quest? (e.g. To seek the Holy Grail)"
+          a_1 :string
+          dependency :rule => "A"
+          condition_A :q_montypython3, "==", {:string_value => "It is 'Arthur', King of the Britons", :answer_reference => "1"}
+    
+          q "How many pets do you own?"
+          a :integer
+          validation :rule => "A"
+          condition_A ">=", :integer_value => 0
+    
+          q "What is your address?", :custom_class => 'address'
+          a :text, :custom_class => 'mapper'
+          validation :rule => "AC"
+          vcondition_AC "=~", :regexp => /[0-9a-zA-z\. #]/
+        end
+      end
+    """
+    Then there should be 1 survey with:
+      | title                            |
+      | Dependency and validation survey |
+    And there should be 4 questions with:
+      | text                                                             | pick | display_type | custom_class |
+      | What... is your name? (e.g. It is 'Arthur', King of the Britons) | none | default      | nil          |
+      | What is your address?                                            | none | default      | address      |
+    And there should be 1 dependency with:
+      | rule |
+      | A    |
+    And there should be 1 resolved dependency_condition with:
+      | rule_key |
+      | A        |
+    And there should be 2 validations with:
+      | rule |
+      | A    |
+      | AC   |
+    And there should be 2 validation_conditions with:
+      | rule_key | integer_value |
+      | A        | 0             |

data/lib/surveyor.rb

@@ -1,6 +1,2 @@
 require 'surveyor/common'
 require 'surveyor/acts_as_response'
-
-# 
-# Dir.glob(File.join(File.dirname(__FILE__),'..','app','models','*.rb')).each{|f| require f}
-# Dir.glob(File.join(File.dirname(__FILE__),'..','app','helpers','*.rb')).each{|f| require f}

data/lib/surveyor/acts_as_response.rb

@@ -1,33 +1,17 @@
-require 'active_record'
-
 module Surveyor
-  module Response
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      def acts_as_response
-        include Surveyor::Response::InstanceMethods
-      end    
-    end
-    
-    module InstanceMethods
-      # Returns the response as a particular response_class type
-      def as(type_symbol)
-        return case type_symbol.to_sym
-        when :string, :text, :integer, :float, :datetime
-          self.send("#{type_symbol}_value".to_sym)
-        when :date
-          self.datetime_value.nil? ? nil : self.datetime_value.to_date
-        when :time
-          self.datetime_value.nil? ? nil : self.datetime_value.to_time
-        else # :answer_id
-          self.answer_id
-        end
+  module ActsAsResponse
+    # Returns the response as a particular response_class type
+    def as(type_symbol)
+      return case type_symbol.to_sym
+      when :string, :text, :integer, :float, :datetime
+        self.send("#{type_symbol}_value".to_sym)
+      when :date
+        self.datetime_value.nil? ? nil : self.datetime_value.to_date
+      when :time
+        self.datetime_value.nil? ? nil : self.datetime_value.to_time
+      else # :answer_id
+        self.answer_id
       end
     end
   end
-end
-
-ActiveRecord::Base.send(:include, Surveyor::Response)
+end

data/lib/surveyor/common.rb

@@ -1,7 +1,7 @@
 module Surveyor
   class Common
     RAND_CHARS = [('a'..'z'), ('A'..'Z'), (0..9)].map{|r| r.to_a}.flatten.to_s
-    OPERATORS = %w(== != < > <= >=)
+    OPERATORS = %w(== != < > <= >= =~)
     
     class << self
       def make_tiny_code(len = 10)
@@ -14,7 +14,7 @@ module Surveyor
 
       def to_normalized_string(text)
         words_to_omit = %w(a be but has have in is it of on or the to when)
-        col_text = text.gsub(/(<[^>]*>)|\n|\t/s, ' ') # Remove html tags
+        col_text = text.to_s.gsub(/(<[^>]*>)|\n|\t/s, ' ') # Remove html tags
         col_text.downcase!                            # Remove capitalization
         col_text.gsub!(/\"|\'/, '')                   # Remove potential problem characters
         col_text.gsub!(/\(.*?\)/,'')                  # Remove text inside parens

data/lib/surveyor/models/answer_methods.rb

@@ -12,10 +12,23 @@ module Surveyor
 
         # Validations
         base.send :validates_presence_of, :text
-        base.send :validates_numericality_of, :question_id, :allow_nil => false, :only_integer => true
+        # this causes issues with building and saving
+        # base.send :validates_numericality_of, :question_id, :allow_nil => false, :only_integer => true
       end
 
       # Instance Methods
+      def initialize(*args)
+        super(*args)
+        default_args
+      end
+
+      def default_args
+        self.display_order ||= self.question ? self.question.answers.count : 0
+        # self.is_exclusive ||= false
+        # self.hide_label ||= false
+        # self.response_class ||= "answer"
+      end
+      
       def renderer(q = question)  
         r = [q.pick.to_s, self.response_class].compact.map(&:downcase).join("_")
         r.blank? ? :default : r.to_sym

data/lib/surveyor/models/dependency_condition_methods.rb

@@ -9,12 +9,13 @@ module Surveyor
         base.send :belongs_to, :question
 
         # Validations
-        base.send :validates_numericality_of, :dependency_id, :question_id, :answer_id
         base.send :validates_presence_of, :operator, :rule_key
         base.send :validates_inclusion_of, :operator, :in => Surveyor::Common::OPERATORS
         base.send :validates_uniqueness_of, :rule_key, :scope => :dependency_id
-
-        base.send :acts_as_response # includes "as" instance method
+        # this causes issues with building and saving
+        # base.send :validates_numericality_of, :question_id, :answer_id, :dependency_id
+        
+        base.send :include, Surveyor::ActsAsResponse # includes "as" instance method
 
         # Class methods
         base.instance_eval do

data/lib/surveyor/models/question_methods.rb

@@ -12,7 +12,9 @@ module Surveyor
         base.send :default_scope, :order => "display_order ASC"
 
         # Validations
-        base.send :validates_presence_of, :text, :survey_section_id, :display_order
+        base.send :validates_presence_of, :text, :display_order
+        # this causes issues with building and saving
+        #, :survey_section_id
         base.send :validates_inclusion_of, :is_mandatory, :in => [true, false]
       end
 
@@ -26,6 +28,14 @@ module Surveyor
         self.is_mandatory ||= true
         self.display_type ||= "default"
         self.pick ||= "none"
+        self.display_order ||= self.survey_section ? self.survey_section.questions.count : 0
+      end
+      
+      def pick=(val)
+        write_attribute(:pick, val.nil? ? nil : val.to_s)
+      end
+      def display_type=(val)
+        write_attribute(:display_type, val.nil? ? nil : val.to_s)
       end
 
       def mandatory?

data/lib/surveyor/models/response_methods.rb

@@ -10,7 +10,8 @@ module Surveyor
         # Validations
         base.send :validates_presence_of, :response_set_id, :question_id, :answer_id
 
-        base.send :acts_as_response # includes "as" instance method
+        base.send :include, Surveyor::ActsAsResponse # includes "as" instance method
+
       end
 
       # Instance Methods

data/lib/surveyor/models/survey_methods.rb

@@ -34,8 +34,16 @@ module Surveyor
       end
 
       def title=(value)
-        self.access_code = Surveyor::Common.to_normalized_string(value)
-        super
+        adjusted_value = value
+        while Survey.find_by_access_code(Survey.to_normalized_string(adjusted_value))
+          i ||= 0
+          i += 1
+          adjusted_value = "#{value} #{i.to_s}"
+        end
+        self.access_code = Survey.to_normalized_string(adjusted_value)
+        super(adjusted_value)        
+        # self.access_code = Survey.to_normalized_string(value)
+        # super
       end
 
       def active?

data/lib/surveyor/models/survey_section_methods.rb

@@ -11,10 +11,20 @@ module Surveyor
         base.send :named_scope, :with_includes, { :include => {:questions => [:answers, :question_group, {:dependency => :dependency_conditions}]}}
 
         # Validations
-        base.send :validates_presence_of, :title, :survey, :display_order
+        base.send :validates_presence_of, :title, :display_order
+        # this causes issues with building and saving
+        #, :survey
       end
 
       # Instance Methods
+      def initialize(*args)
+        super(*args)
+        default_args
+      end
+
+      def default_args
+        self.display_order ||= self.survey ? self.survey.sections.count : 0
+      end
 
     end
   end