surveyor 0.20.0 → 0.21.0

data/.gitignore

@@ -0,0 +1,26 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+Gemfile.lock
+reports
+
+## PROJECT::SPECIFIC
+testbed
+surveys/fixtures/*.yml
+.rvmrc

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+gemspec
+
+eval(File.read File.expand_path('../Gemfile.rails_version', __FILE__))
+
+group :development do
+  # use git version for the ci:setup:rspecbase task; not there in
+  # 1.6.5, but might be in a later version.
+  gem 'ci_reporter', :git => 'git://github.com/nicksieger/ci_reporter.git'
+end

data/Gemfile.rails_version

@@ -0,0 +1,13 @@
+# For testing against different releases of Rails.  This is in a
+# separate fragment so that it can be sourced from the test
+# application's Gemfile in addition to the main development Gemfile.
+if ENV['RAILS_VERSION']
+  case ENV['RAILS_VERSION']
+  when /3.0$/
+    gem 'rails', '~> 3.0.10'
+  when /3.1$/
+    gem 'rails', '~> 3.1.0'
+  else
+    fail "Unknown Rails version #{ENV['RAILS_VERSION']}"
+  end
+end

data/README.md

@@ -1,10 +1,6 @@
 # Surveys On Rails
 
-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.
-
-The rails3 branch is functional for use with Rails 3.
+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
 
@@ -17,11 +13,11 @@ The Surveyor DSL defines questions, answers, question groups, survey sections, d
 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
-    
+
       section "Basic questions" do
         # A label is a question that accepts no answers
         label "These questions are examples of the basic supported input types"
-    
+
         # A basic question with radio buttons
         question_1 "What is your favorite color?", :pick => :one
         answer "red"
@@ -29,7 +25,7 @@ The Surveyor DSL supports a wide range of question types (too many to list here)
         answer "green"
         answer "yellow"
         answer :other
-    
+
         # A basic question with checkboxes
         # "question" and "answer" may be abbreviated as "q" and "a"
         q_2 "Choose the colors you don't like", :pick => :any
@@ -38,8 +34,8 @@ The Surveyor DSL supports a wide range of question types (too many to list here)
         a_3 "green"
         a_4 "yellow"
         a :omit
-    
-        # A dependent question, with conditions and rule to logically join them  
+
+        # A dependent question, with conditions and rule to logically join them
         # the question's reference identifier is "2a", and the answer's reference_identifier is "1"
         # question reference identifiers used in conditions need to be unique on a survey for the lookups to work
         q_2a "Please explain why you don't like this color?"
@@ -49,25 +45,28 @@ The Surveyor DSL supports a wide range of question types (too many to list here)
         condition_B :q_2, "==", :a_2
         condition_C :q_2, "==", :a_3
         condition_D :q_2, "==", :a_4
-    
+
         # ... other question, sections and such. See surveys/kitchen_sink_survey.rb for more.
-     end 
-    
+     end
+
     end
-   
+
 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
 
-1. Add it to your bundler Gemfile:
+1. Add surveyor to your Gemfile (add add haml too if you haven't already):
 
 gem "surveyor"
+gem "haml"
+
+Then run:
 
 `bundle install`
 
 2. Generate assets, run migrations:
-    
-`script/generate surveyor`
+
+`script/rails generate surveyor:install`
 `rake db:migrate`
 
 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).
@@ -89,7 +88,7 @@ There are two other useful rake tasks for removing (only surveys without respons
 
 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`
+`script/rails generate surveyor:custom`
 
 and read surveys/EXTENDING\_SURVEYOR
 
@@ -98,17 +97,36 @@ and read surveys/EXTENDING\_SURVEYOR
 Surveyor depends on:
 
 * Ruby (1.8.7 - 1.9.2)
-* Rails 2.3
+* Rails 3.x
 * HAML
 * SASS
 * fastercsv (or CSV for ruby 1.9) for csv exports
 * formtastic
 * UUID
 
-To work on the code fork this github project. Run:
+Specific versions of the gem dependencies are listed in the gemspec.
+
+# Contributing, testing
+
+To work on the code, fork this github project. Install [bundler][] if
+you don't have it, then run
+
+    $ bundle update
+
+to install all the necessary gems. Then
+
+    $ bundle exec rake testbed
+
+to generate a test app in `testbed`. Now you can run
+
+    $ bundle exec rake spec
+
+to run the specs and
+
+    $ bundle exec rake cucumber
 
-`rake -f init_testbed.rakefile`
+to run the features and start writing tests!
 
-which will generate a test app in testbed. Run rake spec and rake cucumber there, and start writing tests!
+[bundler]: http://gembundler.com/
 
 Copyright (c) 2008-2011 Brian Chamberlain and Mark Yoon, released under the MIT license

data/Rakefile

@@ -1,33 +1,96 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "surveyor"
-    gem.summary = %Q{A rails (gem) plugin to enable surveys in your application}
-    gem.email = "yoon@northwestern.edu"
-    gem.homepage = "http://github.com/NUBIC/surveyor"
-    gem.authors = ["Brian Chamberlain", "Mark Yoon"]
-    gem.add_dependency 'haml'
-    gem.add_dependency 'sass'
-    gem.add_dependency 'fastercsv'
-    gem.add_dependency 'formtastic'
-    gem.add_dependency 'uuid'
-    gem.add_development_dependency "yard", ">= 0"
-    gem.post_install_message = "Thanks for installing surveyor! The time has come to run the surveyor generator and migrate your database, even if you are upgrading."
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+require 'ci/reporter/rake/rspec'
+
+###### RSPEC
+
+RSpec::Core::RakeTask.new(:spec)
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rcov = true
+end
+
+task :default => :spec
+
+###### CUCUMBER
+
+namespace :cucumber do
+  Cucumber::Rake::Task.new(:ok, 'Run features that should pass') do |t|
+    t.profile = 'default'
+  end
+
+  Cucumber::Rake::Task.new(:wip, 'Run features that are being worked on') do |t|
+    t.profile = 'wip'
+  end
+
+  desc 'Run all features'
+  task :all => [:ok, :wip]
+end
+desc 'Alias for cucumber:ok'
+task :cucumber => 'cucumber:ok'
+
+###### TESTBED
+
+desc 'Set up the rails app that the specs and features use'
+task :testbed => 'testbed:rebuild'
+
+namespace :testbed do
+  desc 'Generate a minimal surveyor-using rails app'
+  task :generate do
+    sh 'bundle exec rails new testbed'
+    chdir('testbed') do
+      File.open('Gemfile', 'w') do |f|
+        f.puts %q{source :rubygems}
+        f.puts %q{plugin_root = File.expand_path('../..', __FILE__)}
+        f.puts %q{eval(File.read File.join(plugin_root, 'Gemfile.rails_version'))}
+        f.puts %q{gem 'sqlite3'}
+        f.puts %q{gem 'surveyor', :path => plugin_root}
+      end
+
+      Bundler.with_clean_env do
+        sh 'bundle update'
+      end
+    end
+  end
+
+  desc 'Prepare the databases for the testbed'
+  task :migrate do
+    chdir('testbed') do
+      Bundler.with_clean_env do
+        sh 'bundle exec rails generate surveyor:install'
+        sh 'bundle exec rake db:migrate db:test:prepare'
+      end
+    end
+  end
+
+  desc 'Remove the testbed entirely'
+  task :remove do
+    rm_rf 'testbed'
+  end
+
+  task :rebuild => [:remove, :generate, :migrate]
 end
 
-begin
-  require 'yard'
-  YARD::Rake::YardocTask.new
-rescue LoadError
-  task :yardoc do
-    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+###### CI
+
+namespace :ci do
+  task :all => ['rake:testbed', :spec, :cucumber, 'cucumber:wip']
+
+  task :env do
+    ENV['CI_REPORTS'] = 'reports/spec-xml'
+    ENV['SPEC_OPTS'] = "#{ENV['SPEC_OPTS']} --format nested"
+  end
+
+  Cucumber::Rake::Task.new(:cucumber, 'Run features using the CI profile') do |t|
+    t.profile = 'ci'
   end
+
+  Cucumber::Rake::Task.new('cucumber:wip', 'Run WIP features using the CI profile') do |t|
+    t.profile = 'ci_wip'
+  end
+
+  task :spec => [:env, 'ci:setup:rspecbase', 'rake:spec']
 end

data/app/helpers/survey_form_builder.rb

@@ -0,0 +1,37 @@
+class SurveyFormBuilder < ActionView::Helpers::FormBuilder 
+  def survey_check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
+    fields = @template.survey_check_box(@object_name, method, options.merge(:object => @object), checked_value, unchecked_value)
+    fields[1]
+  end
+end
+
+module ActionView
+  module Helpers
+    module FormHelper
+      def survey_check_box(object_name, method, options = {}, checked_value = "1", unchecked_value = "0")
+        if (Rails::VERSION::STRING.to_f > 2.1)
+          InstanceTag.new(object_name, method, self, options.delete(:object)).to_survey_check_box_tag(options, checked_value, unchecked_value)
+        else
+          InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_survey_check_box_tag(options, checked_value, unchecked_value)
+        end
+      end
+    end
+
+    class InstanceTag
+      def to_survey_check_box_tag(options = {}, checked_value = "1", unchecked_value = "0")
+        options = options.stringify_keys
+        options["type"]     = "checkbox"
+        options["value"]    = checked_value
+        if options.has_key?("checked")
+          cv = options.delete "checked"
+          checked = cv == true || cv == "checked"
+        else
+          checked = self.class.check_box_checked?(value(object), checked_value)
+        end
+        options["checked"] = "checked" if checked
+        add_default_name_and_id(options)
+        [tag("input", "name" => options["name"], "type" => "hidden", "value" => unchecked_value), tag("input", options)]
+      end
+    end
+  end
+end

data/app/helpers/surveyor_helper.rb

@@ -1,13 +1,13 @@
 module SurveyorHelper
   # Layout: stylsheets and javascripts
   def surveyor_includes
-    surveyor_stylsheets + surveyor_javascripts    
+    surveyor_stylsheets + surveyor_javascripts
   end
   def surveyor_stylsheets
     stylesheet_link_tag 'surveyor/reset', 'surveyor/dateinput', 'surveyor', 'custom'
   end
   def surveyor_javascripts
-    javascript_include_tag 'surveyor/jquery.tools.min', 'surveyor/jquery.surveyor'
+    javascript_include_tag 'surveyor/jquery.tools.min', 'surveyor/jquery.surveyor', 'surveyor/jquery.blockUI'
   end
   # Helper for displaying warning/notice/error flash messages
   def flash_messages(types)
@@ -28,13 +28,13 @@ module SurveyorHelper
   end
   def previous_section
     # use copy in memory instead of making extra db calls
-    submit_tag(t('surveyor.previous_section'), :name => "section[#{@sections[@sections.index(@section)-1].id}]") unless @sections.first == @section
+    submit_tag(t('surveyor.previous_section').html_safe, :name => "section[#{@sections[@sections.index(@section)-1].id}]") unless @sections.first == @section
   end
   def next_section
     # use copy in memory instead of making extra db calls
-    @sections.last == @section ? submit_tag(t('surveyor.click_here_to_finish'), :name => "finish") : submit_tag(t('surveyor.next_section'), :name => "section[#{@sections[@sections.index(@section)+1].id}]")
+    @sections.last == @section ? submit_tag(t('surveyor.click_here_to_finish').html_safe, :name => "finish") : submit_tag(t('surveyor.next_section').html_safe, :name => "section[#{@sections[@sections.index(@section)+1].id}]")
   end
-  
+
   # Questions
   def q_text(obj)
     @n ||= 0
@@ -48,12 +48,12 @@ module SurveyorHelper
   # def question_help_helper(question)
   #   question.help_text.blank? ? "" : %Q(<span class="question-help">#{question.help_text}</span>)
   # end
-  
+
   # Answers
   def a_text(obj, pos=nil)
     return image_tag(obj.text) if obj.is_a?(Answer) and obj.display_type == "image"
     obj.split_or_hidden_text(pos)
-  end  
+  end
   def rc_to_attr(type_sym)
     case type_sym.to_s
     when /^date|time$/ then :datetime_value
@@ -73,7 +73,7 @@ module SurveyorHelper
     html[:value] = default_value if response_class.blank?
     html
   end
-  
+
   # Responses
   def response_for(response_set, question, answer = nil, response_group = nil)
     return nil unless response_set && question && question.id
@@ -83,5 +83,5 @@ module SurveyorHelper
   def response_idx(increment = true)
     @rc ||= 0
     (increment ? @rc += 1 : @rc).to_s
-  end  
+  end
 end

data/app/views/partials/_answer.html.haml

@@ -2,7 +2,7 @@
 - rg ||= nil
 - r = response_for(@response_set, q, a, rg)
 - i = response_idx(q.pick != "one") # argument will be false (don't increment i) if we're on radio buttons
-- f.semantic_fields_for i, r do |ff|
+= f.semantic_fields_for i, r do |ff|
   = ff.quiet_input :question_id unless q.pick == "one" # don't repeat question_id if we're on radio buttons
   = ff.quiet_input :id unless q.pick == "one" or r.new_record?
   = ff.quiet_input :response_group, :value => rg if q.pick != "one" && g && g.display_type == "repeater"

data/app/views/partials/_question.html.haml

@@ -1,14 +1,14 @@
 -# TODO: js for slider
 - rg ||= nil
 - renderer = q.renderer(g ||= nil)
-- f.inputs q_text(q), :id => rg ? "q_#{q.id}_#{rg}" : "q_#{q.id}", :class => "q_#{renderer} #{q.css_class(@response_set)}" do
+= f.inputs q_text(q), :id => rg ? "q_#{q.id}_#{rg}" : "q_#{q.id}", :class => "q_#{renderer} #{q.css_class(@response_set)}" do
   %span.help= q.help_text
   - case renderer
   - when :image, :label
   - when :dropdown, :inline_dropdown, :slider, :repeater_dropdown
     - r = response_for(@response_set, q, nil, rg)
     - i = response_idx
-    - f.semantic_fields_for i, r do |ff|
+    = f.semantic_fields_for i, r do |ff|
       = ff.quiet_input :question_id
       = ff.quiet_input :response_group, :value => rg if g && g.display_type == "repeater"
       = ff.quiet_input :id unless r.new_record?
@@ -17,7 +17,7 @@
     - if q.pick == "one"
       - r = response_for(@response_set, q, nil, rg)
       - i = response_idx  # increment the response index since the answer partial skips for q.pick == one
-      - f.semantic_fields_for i, r do |ff|
+      = f.semantic_fields_for i, r do |ff|
         = ff.quiet_input :question_id
         = ff.quiet_input :response_group, :value => rg if g && g.display_type == "repeater"
         = ff.quiet_input :id unless r.new_record?