ask 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Biola University
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,64 @@
+Ask
+===
+Ask is a Rails engine that provides tools to simplify the process of letting your app's users build forms for things like questionnaires or surveys.
+
+Requirements
+------------
+- Rails 3.1 or higher
+
+Installation
+------------
+Add to your Gemfile:
+
+    gem 'ask'
+
+In your terminal run:
+
+    bundle
+
+Usage
+-----
+Ask needs to be tied to two models in your application: an "asker" and an "answerer". The asker model should be the model that has questions, such as a Survey or Event. The answerer model should be the model that has answers to the questions such as a SurveySubmission or an EventRegistration.
+
+In your asker model add:
+
+    acts_as_asker
+
+In your answerer model add:
+
+    acts_as_answerer
+
+In your asker form views, inside an already defined `form_for` helper add:
+
+    <%= render(:partial => 'asker/form', :locals => { :f => f }) %>
+
+In your answerer form views, inside an already defined `form_for` helper add:
+
+    <%= render(:partial => 'answerer/form', :locals => { :f => f }) %>
+
+In your javascript manifest file add:
+
+    //= require ask
+
+In your stylesheet manifest file add:
+
+    /*  
+    *= require ask  
+    */
+
+In your answerer controller's `new` and `edit` methods you'll want to call `build_or_create_answers` and pass it in the appropriate questions. Such as:
+
+    @event_registration.build_or_create_answers @event_registration.event.questions
+
+
+Finally you'll need to define an `asker` method on your answerer model, like so:
+
+    class EventRegistration < ActiveRecord::Base
+      def asker  
+        return event  
+      end
+    end
+
+License
+-------
+MIT License

data/Rakefile

@@ -0,0 +1,39 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Ask'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/ask.js

@@ -0,0 +1,2 @@
+//= require jquery.handle-nesting
+//= require ask/forms

data/app/assets/javascripts/ask/forms.js

@@ -0,0 +1,100 @@
+$(document).ready(function() 
+{
+    var handleChoiceNesting = function(container) 
+    {
+        $(container).find('ul.choices').handleNesting({ 
+                                                          nameMatch:   /(.*\[)[0-9]+(\].*)/, 
+                                                          nameReplace: '$1{NEW_ID}$2',
+                                                          afterAdd:    function(added)
+                                                                       {
+                                                                           insertDeleteButtons(added.parent(), ".choice");
+                                                                       }
+                                                      });
+    }
+  
+    var updateChoiceVisibility = function(select)
+    {
+        if (select.val() == "ChooseOneQuestion" || select.val() == "ChecklistQuestion")
+            select.parents("dl").find("dd.choices:hidden").slideDown("fast");
+        else
+            select.parents("dl").find("dd.choices:visible").slideUp("fast");
+    }
+    
+    var bindTypeChange = function(select)
+    {
+        select.change(function()
+        {
+            updateChoiceVisibility($(this));
+        });
+    }
+
+    var insertDeleteButtons = function(container, selector)
+    {
+        container.find(selector).each(function()
+        {
+            // Add a delete button if there isn't one already
+            if ($(this).children("button.remove").length == 0)
+            {
+                $("<button type=\"button\" class=\"remove\">Remove</button>").click(function()
+                {
+                    $(this).parents(selector).fadeOut("fast", function() 
+                    { 
+                        $(this).remove(); 
+                        // If there's only one option left, remove the delete button
+                        if (container.find(selector).length == 1)
+                            container.find("button.remove:last").remove();
+                    });
+            
+                    return false;
+                }).appendTo($(this));
+            }
+        });
+    }
+
+    var makeSortable = function()
+    {
+        var questions = $("form ul.ask.questions");
+        questions.sortable(
+        {
+            stop: function(event, ui) 
+                  {
+                      var order = 1;
+                      questions.find(".position-wrapper").each(function()
+                      {
+                          $(this).find("input").val(order);
+                          order ++;
+                      });
+                  }
+        });
+    }
+
+    var selects = $("dd.type > select");
+    
+    bindTypeChange(selects);
+    
+    selects.each(function()
+    {
+        updateChoiceVisibility($(this));
+    });
+    
+    makeSortable();
+  
+    if(jQuery.fn.handleNesting) 
+    {
+        $('form ul.ask.questions').handleNesting({
+                                                 afterAdd: function(added) 
+                                                           {
+                                                               handleChoiceNesting(added);
+                                                               insertDeleteButtons(added.parent(), ".question");
+                                                               bindTypeChange(added.find("dd.type > select"));
+                                                               makeSortable();
+                                                           }
+                                             });
+    }
+
+    $('form ul.ask.questions').children('li').each(function(i,li) 
+    {
+        handleChoiceNesting(li);
+    });
+  
+});

data/app/assets/stylesheets/ask.css

@@ -0,0 +1,4 @@
+/*
+*= require ask/forms
+*= require ask/submissions
+*/

data/app/assets/stylesheets/ask/forms.css.sass

@@ -0,0 +1,139 @@
+ul.ask.questions
+  margin: 0
+  list-style-type: none
+  
+  button.remove:after
+    content: " this question"
+
+  >li
+    position: relative
+    margin: 10px 0
+    padding: 10px 10px 25px 10px
+    border: solid 1px #ccc
+    background-color: #eee
+    cursor: move
+    
+    dt
+      display: none
+    
+    dd.type select
+      position: absolute
+      top: 10px
+      right: 120px
+      width: 100px
+      
+    dd.choices
+      display: none
+
+      a.delete
+        float: none
+        text-indent: 400px
+        width: 16px
+        margin: 0px
+
+      a.delete:after
+        content: ""
+
+    dd.required select
+      position: absolute
+      top: 10px
+      right: 10px
+      width: 100px
+      
+    dd.instructions
+      margin-top: 10px
+    
+    textarea
+      height: 3em
+      font-family: sans-serif
+      
+    input[type=text]
+      width: 300px
+      
+    input[type=checkbox]
+      display: none
+      
+    button
+      float: right
+      clear: both
+    
+    button.remove
+      padding: 0px
+      color: #000
+      font-family: sans-serif
+      font-size: 9pt
+      font-weight: normal
+      text-shadow: none
+      border: none
+      background: image-url("delete.png") no-repeat transparent
+      display: inline-block
+      vertical-align: 1px
+      text-indent: 20px
+      margin: 5px
+      float: right
+      height: 16px
+      text-decoration: none
+      -moz-box-shadow: none
+      -webkit-box-shadow: none
+      box-shadow: none
+      
+    button.remove:after
+      content: " Question"
+
+    button.remove:active
+      top: 0px
+    
+    button.add
+      float: none
+      height: 16px
+      padding: 0 20px 0 0
+      color: #000
+      font-family: sans-serif
+      font-size: 9pt
+      font-weight: normal
+      text-shadow: none
+      border: none
+      background: image-url("add.png") left center no-repeat transparent
+      -moz-box-shadow: none
+      -webkit-box-shadow: none
+      box-shadow: none
+      text-indent: 20px
+      
+    button.add:after
+      content: " Choice"
+    
+    ul.choices
+    
+      li
+        margin: 10px 0
+        padding: 0
+        border: none
+        background: transparent
+        
+        label
+          display: none
+          
+        input[type=text]
+          width: 200px
+        
+        input[type=checkbox]
+          display: none
+        
+        button.remove
+          position: relative
+          float: none
+          margin: 0px
+          right: 0
+          bottom: 0
+          height: 16px
+          width: 16px
+          padding: 0
+          text-indent: -9999px
+          border: none
+          background: image-url("delete.png") no-repeat transparent
+          -moz-box-shadow: none
+          -webkit-box-shadow: none
+          box-shadow: none
+      
+        button.remove:after
+          content: ""

data/app/assets/stylesheets/ask/submissions.css.sass

@@ -0,0 +1,60 @@
+#page
+
+  &.submissions.show
+    dd
+      padding-left: 10px
+      
+  &.application_forms, &.reference_forms, &.interview_forms
+    &.show
+      #wrapperContent
+        #content
+          background-image: url(../images/preview.png)
+          background-position: top right
+          background-repeat: no-repeat
+
+#content
+
+  h3.section
+    margin-top: 40px
+    border-bottom: solid 1px #ccc
+
+  .instructions
+    display: block
+    font-style: italic
+    font-weight: normal
+
+  dt
+  
+    .instructions
+      margin: 5px 0
+      color: #333
+      font-size: 10pt
+    
+  
+  input[type=text], textarea
+    width: 400px
+  
+  textarea
+    height: 100px
+  
+  h2
+    border-bottom: solid 1px #ccc
+    
+  dt, dd
+    font-size: 11pt
+  
+  dt
+    padding-top: 10px
+    letter-spacing: -.05em
+
+#contentAside
+  a
+    &.csv, &.table
+      padding-left: 24px
+      font-size: 10pt
+      font-weight: bold
+      text-decoration: none
+    &.csv
+      background: url(../images/csv.png) 5px center no-repeat
+    &.table
+      background: url(../images/table.png) 5px center no-repeat

data/app/helpers/ask_helper.rb

@@ -0,0 +1,23 @@
+module AskHelper
+
+  def question_label(question, builder=nil)
+    if question.type.to_sym == :ChecklistQuestion
+      h(question.name)
+    else
+      if builder
+        builder.label(:answer, question.name)
+      else
+        label_tag(:answer, question.name)
+      end
+    end
+  end
+
+  def question_instructions(question)
+    require 'rails_autolink/helpers'
+    
+    unless question.instructions.blank?
+      content_tag(:span, auto_link(simple_format(question.instructions), :all, :target=>'_blank'), :class=>'instructions')
+    end || ''
+  end
+
+end