surveyor 0.11.0 → 0.12.1

data/README.md

@@ -1,4 +1,4 @@
-# Survey On Rails
+# 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.
 
@@ -58,15 +58,23 @@ The survey above shows a couple simple question types. The first one is a "pick
 As a plugin:
 
     gem install haml
-    script/plugin install git://github.com/breakpointer/surveyor.git -r 'tag v0.10.0'
+    gem install fastercsv
+    script/plugin install git://github.com/breakpointer/surveyor.git -r 'tag v0.12.0'
 
-Or as a gem plugin:
+Or as a gem:
   
     # in environment.rb
-    config.gem "surveyor", :version => '~> 0.10.0', :source => 'http://gemcutter.org'
+    config.gem "surveyor", :version => '~> 0.12.0', :source => 'http://gemcutter.org'
   
     rake gems:install
 
+Or as a gem (with bundler):
+
+    # in environment.rb
+    gem "surveyor", '~> 0.12.0'
+
+    bundle install
+
 Generate assets, run migrations:
     
     script/generate surveyor
@@ -111,7 +119,7 @@ The initializer runs once, when the app starts. The block style is used to keep
       config['default.layout'] = nil # "surveyor_default"
       config['default.index'] =  nil # "/surveys" # or :index_path_method
       config['default.finish'] =  nil # "/surveys" # or :finish_path_method
-      config['use_restful_authentication'] = false # set to true to use restful authentication
+      #config['authentication_method'] = :login_required # set to true to use restful authentication
       config['extend'] = %w() # %w(survey surveyor_helper surveyor_controller)
     end
 
@@ -165,7 +173,7 @@ The <code>surveyor\_includes</code> helper just calls <code>surveyor\_stylsheets
     
 # Dependencices
 
-Surveyor depends on Rails 2.3 and the SASS style sheet language, part of HAML (http://haml.hamptoncatlin.com/download). For running the test suite you will need rspec and have the rspec plugin installed in your application.
+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
 
@@ -174,6 +182,16 @@ To work on the plugin code (for enhancements, and bug fixes, etc...) fork this g
 
 # Changes
 
+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

data/Rakefile

@@ -10,6 +10,7 @@ begin
     gem.homepage = "http://github.com/breakpointer/surveyor"
     gem.authors = ["Brian Chamberlain", "Mark Yoon"]
     gem.add_dependency 'haml'
+    gem.add_dependency 'fastercsv'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.11.0
+0.12.1

data/app/controllers/surveyor_controller.rb

@@ -11,9 +11,8 @@ class SurveyorController < ApplicationController
   before_filter :extend_actions
 
   # RESTful authentication
-  if Surveyor::Config['use_restful_authentication']
-    include AuthenticatedSystem
-    before_filter :login_required
+  if Surveyor::Config['authentication_method']
+    before_filter Surveyor::Config['authentication_method']
   end
 
   # Get the response set or current_user
@@ -40,11 +39,16 @@ class SurveyorController < ApplicationController
 
   def show
     @response_set = ResponseSet.find_by_access_code(params[:response_set_code], :include => {:responses => [:question, :answer]})
-    respond_to do |format|
-      format.html #{render :action => :show}
-      format.csv {
-        send_data(@response_set.to_csv, :type => 'text/csv; charset=utf-8; header=present',:filename => "#{@response_set.updated_at.strftime('%Y-%m-%d')}_#{@response_set.access_code}.csv")
-      }
+    if @response_set
+      respond_to do |format|
+        format.html #{render :action => :show}
+        format.csv {
+          send_data(@response_set.to_csv, :type => 'text/csv; charset=utf-8; header=present',:filename => "#{@response_set.updated_at.strftime('%Y-%m-%d')}_#{@response_set.access_code}.csv")
+        }
+      end
+    else
+      flash[:notice] = "Unable to find your responses to the survey"
+      redirect_to(available_surveys_path)
     end
   end
 

data/script/surveyor/base.rb

@@ -46,20 +46,27 @@ module SurveyParser
     
     # Filter out attributes that shouldn't be in fixtures, including children, parser, placeholders
     def yml_attrs
-      instance_variables.sort - self.class.children.map{|model| "@#{model.to_s}"} - %w(@id @parser @dependency @validation @question_reference @answer_reference)
+      instance_variables.sort.map(&:to_s) - self.class.children.map{|model| "@#{model.to_s}"} - %w(@id @parser @dependency @validation @question_reference @answer_reference)
     end
+    
     def to_yml
       out = [ %(#{self.parser.salt}_#{self.class.name.demodulize.underscore}_#{@id}:) ]
       yml_attrs.each{|a| out << associate_and_format(a)}
       (out << nil ).join("\r\n")
     end
+    
     def associate_and_format(a)
       if a =~ /_id$/ # a foreign key, e.g. survey_id
-        "  #{a[1..-4]}: " + (instance_variable_get(a).nil? ? "" : "#{self.parser.salt}_#{a[1..-4]}_#{instance_variable_get(a)}")
+        "  #{property_name_map(a[1..-4])}: " + (instance_variable_get(a).nil? ? "" : "#{self.parser.salt}_#{a[1..-4]}_#{instance_variable_get(a)}")
       else # quote strings
-        "  #{a[1..-1]}: #{instance_variable_get(a).is_a?(String) ? "\"#{instance_variable_get(a)}\"" : instance_variable_get(a) }"
+        "  #{property_name_map(a[1..-1])}: #{instance_variable_get(a).is_a?(String) ? "\"#{instance_variable_get(a)}\"" : instance_variable_get(a) }"
       end
     end
+    
+    def property_name_map(property)
+      return property
+    end
+    
     def to_file
       File.open(self.parser.send("#{self.class.name.demodulize.underscore.pluralize}_yml"), File::CREAT|File::APPEND|File::WRONLY) {|f| f << to_yml}
       self.class.children.each{|model| self.send(model).compact.map(&:to_file)}

data/script/surveyor/parser.rb

@@ -92,11 +92,35 @@ module SurveyParser
           raise "Error: No current question" if self.current_question.nil?
           self.current_answer = Answer.new(self.current_question, args, opts.merge(:display_order => current_question.answers.size + 1))
         end
+        
+      when "correct"
+        drop_the &block
+        raise "Error: No current question" if self.current_question.nil?
+        self.current_correct_answer = self.current_question.find_current_answers(args)
     
       when "validation", "v"
         drop_the &block
         self.current_validation = Validation.new(self.current_answer, args, opts)
 
+
+      # explicitly define a dependency condition
+      # (not really necessary as is default)
+      when "dependencycondition", "dcondition", "dc"
+        drop_the &block
+        raise "Error: No current dependency for this condition" if self.current_dependency.nil?
+        self.current_dependency.dependency_conditions << DependencyCondition.new(self.current_dependency, args, opts)
+
+      # explicitly define a validation condition
+      # (is necessary if want dependency AND validation on
+      #  same question as dependency existance would try to
+      #  make the condition a dependency condition.)
+      when "validationcondition", "vcondition", "vc"
+        drop_the &block
+        raise "Error: No current validation for this condition" if self.current_validation.nil?
+        self.current_validation.validation_conditions << ValidationCondition.new(self.current_validation, args, opts)
+      
+
+
       else
         raise "  ERROR: '#{missing_method}' not valid method"
     
@@ -135,31 +159,42 @@ module SurveyParser
       self.surveys << s
       @current_survey = s
     end
+    
     def current_survey_section=(s)
       clear_current "survey_section"
       self.current_survey.survey_sections << s
       @current_survey_section = s 
     end
+    
     def current_question_group=(g)
       clear_current "question_group"
       self.current_survey_section.question_groups << g
       @current_question_group = g
-    end  
+    end
+    
     def current_question=(q)
       clear_current "question"
       self.current_survey_section.questions << q
       @current_question = q
     end
+    
     def current_dependency=(d)
       raise "Error: No question or question group" unless (dependent = self.current_question_group || self.current_question)
       dependent.dependency = d
       @current_dependency = d
     end
+    
     def current_answer=(a)
       raise "Error: No current question" if self.current_question.nil?
       self.current_question.answers << a
       @current_answer = a
-    end  
+    end
+    
+    def current_correct_answer=(a)
+      raise "Error: No current question" if self.current_question.nil?
+      self.current_question.correct_answer = a
+    end
+    
     def current_validation=(v)
       clear_current "validation"
       self.current_answer.validation = v
@@ -185,4 +220,4 @@ module SurveyParser
     end
 
   end
-end
+end

data/script/surveyor/question.rb

@@ -1,13 +1,15 @@
 module SurveyParser
   class Question < SurveyParser::Base
+    ANSWER_ID = /\s*\w+_/ unless defined?(ANSWER_ID)
+    
     # Context, Content, Reference, Display, Children
-    attr_accessor :id, :parser, :survey_section_id, :question_group_id
-    attr_accessor :text, :short_text, :help_text, :pick
+    attr_accessor :id, :parser, :survey_section_id, :question_group_id, :correct_answer_id
+    attr_accessor :text, :short_text, :help_text, :pick, :answer_id
     attr_accessor :reference_identifier, :data_export_identifier, :common_namespace, :common_identifier
     attr_accessor :display_order, :display_type, :is_mandatory, :display_width, :custom_class, :custom_renderer
     attr_accessor :dependency
     has_children :answers
-
+    
     def default_options
       { :pick => :none,
         :display_type => :default,
@@ -15,17 +17,38 @@ module SurveyParser
         :display_order => self.id
       }
     end
+    
     def parse_opts(opts)
       (name = opts.delete(:method_name)) =~ /label|image/ ? opts.merge(:display_type => name) : opts
     end
+    
     def parse_args(args)
       text = args[0] || "Question"
       {:text => text, :short_text => text, :data_export_identifier => Surveyor.to_normalized_string(text)}.merge(args[1] || {})
     end
+    
+    def correct_answer=(a)
+      self.answer_id = a.id
+    end
   
     def find_answer_by_reference(ref_id)
       self.answers.detect{|a| a.reference_identifier == ref_id}
     end
+    
+    # currently, only one correct answer is allowed
+    def find_current_answers(args)
+      ref_ids = args[0][:answer]
+      ids = ref_ids.to_s.split(ANSWER_ID).compact
+      self.answers.select{|a| ids.include?(a.reference_identifier)}.first
+    end
+    
+    # so we can build the correct yaml structure
+    def property_name_map(property)
+      names = {
+        "answer" => "correct_answer"
+      }
+      return names.has_key?(property) ? names[property] : property
+    end
 
     def to_file
       super

data/spec/controllers/surveyor_controller_spec.rb

@@ -26,31 +26,33 @@ describe SurveyorController do
       response.should be_success
       response.should render_template('new')
     end
+
     it "should find all surveys" do
       Survey.should_receive(:find).with(:all).and_return([@survey])
       do_get
     end
+    
     it "should assign the found surveys for the view" do
       do_get
       assigns[:surveys].should == [@survey]
     end
   end
 
-  describe "take survey: POST /surveys/XYZ" do
+  describe "take survey: POST /surveys/xyz" do
 
     before(:each) do
-      @survey = Factory(:survey, :title => "XYZ", :access_code => "XYZ")
-      @response_set = Factory(:response_set, :access_code => "PDQ")
+      @survey = Factory(:survey, :title => "xyz", :access_code => "xyz")
+      @response_set = Factory(:response_set, :access_code => "pdq")
       ResponseSet.stub!(:create).and_return(@response_set)
       Survey.stub!(:find_by_access_code).and_return(@survey)
     end
     
     describe "with success" do
       def do_post
-        post :create, :survey_code => "XYZ"
+        post :create, :survey_code => "xyz"
       end
       it "should look for the survey" do
-        Survey.should_receive(:find_by_access_code).with("XYZ").and_return(@survey)
+        Survey.should_receive(:find_by_access_code).with("xyz").and_return(@survey)
         do_post
       end
       it "should create a new response_set" do
@@ -59,7 +61,7 @@ describe SurveyorController do
       end
       it "should redirect to the new response_set" do
         do_post
-        response.should redirect_to(edit_my_survey_url(:survey_code => "XYZ", :response_set_code  => "PDQ"))
+        response.should redirect_to(edit_my_survey_url(:survey_code => "xyz", :response_set_code  => "pdq"))
       end
     end
     
@@ -77,47 +79,42 @@ describe SurveyorController do
     end
   end
 
-  describe "view my survey: GET /surveys/XYZ/PDQ" do
+  describe "view my survey: GET /surveys/xyz/pdq" do
 
     before(:each) do
-      @survey = Factory(:survey, :title => "XYZ", :access_code => "XYZ", :sections => [Factory(:survey_section)])  
-      @response_set = Factory(:response_set, :access_code => "PDQ", :survey => @survey)
+      @survey = Factory(:survey, :title => "xyz", :access_code => "xyz", :sections => [Factory(:survey_section)])  
+      @response_set = Factory(:response_set, :access_code => "pdq", :survey => @survey)
     end
   
     def do_get
-      get :show, :survey_code => "XYZ", :response_set_code => "PDQ"
+      get :show, :survey_code => "xyz", :response_set_code => "pdq"
     end
 
     it "should be successful" do
       do_get
       response.should be_success
     end
+    
     it "should render show template" do
       do_get
       response.should render_template('show')
     end
+   
     it "should find the response_set requested" do
-      pending
-      ResponseSet.should_receive(:find_by_access_code).with("PDQ").and_return(@response_set)
+      ResponseSet.should_receive(:find_by_access_code).with("pdq",{:include=>{:responses=>[:question, :answer]}}).and_return(@response_set)
       do_get
     end
+
     it "should assign the found response_set and survey for the view" do
-      pending
       do_get
-      assigns[:response_set].should equal(@response_set)
-      assigns[:survey].should equal(@survey)
+      assigns[:response_set].should == @response_set
     end
+
     it "should redirect if :response_code not found" do
-      pending
-      get :show, :survey_code => "XYZ", :response_set_code => "DIFFERENT"
+      get :show, :survey_code => "xyz", :response_set_code => "DIFFERENT"
       response.should redirect_to(available_surveys_url)      
     end
-    # I'm not sure this is enterly neccessary since we look up the survey from the response_code in the url -BC
-    it "should redirect if :survey_code in url doesn't match response_set.survey.access_code" do
-      pending
-      get :show, :survey_code => "DIFFERENT", :response_set_code => "PDQ"
-      response.should redirect_to(available_surveys_url)
-    end
+
   end
 
   describe "edit my survey: GET /surveys/XYZ/PDQ/take" do

data/surveyor.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{surveyor}
-  s.version = "0.11.0"
+  s.version = "0.12.1"
 
   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-04-06}
+  s.date = %q{2010-08-19}
   s.email = %q{yoon@northwestern.edu}
   s.extra_rdoc_files = [
     "README.md"
@@ -180,7 +180,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/breakpointer/surveyor}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A rails (gem) plugin to enable surveys in your application}
   s.test_files = [
     "spec/controllers/surveyor_controller_spec.rb",
@@ -204,13 +204,16 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<haml>, [">= 0"])
+      s.add_runtime_dependency(%q<fastercsv>, [">= 0"])
     else
       s.add_dependency(%q<haml>, [">= 0"])
+      s.add_dependency(%q<fastercsv>, [">= 0"])
     end
   else
     s.add_dependency(%q<haml>, [">= 0"])
+    s.add_dependency(%q<fastercsv>, [">= 0"])
   end
 end
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: surveyor
 version: !ruby/object:Gem::Version 
+  hash: 45
   prerelease: false
   segments: 
   - 0
-  - 11
-  - 0
-  version: 0.11.0
+  - 12
+  - 1
+  version: 0.12.1
 platform: ruby
 authors: 
 - Brian Chamberlain
@@ -15,21 +16,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-06 00:00:00 -05:00
+date: 2010-08-19 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: haml
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: 
 email: yoon@northwestern.edu
 executables: []
@@ -210,23 +227,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A rails (gem) plugin to enable surveys in your application