ask 0.4.1 → 0.5.0

data/README.markdown

@@ -7,6 +7,10 @@ Requirements
 - Rails 3.1 or higher
 - jQuery
 - jQuery UI
+- Uses Carrierwave for uploads
+
+More information will be on the [wiki](https://github.com/biola/ask/wiki).
+
 
 Installation
 ------------
@@ -76,6 +80,16 @@ Finally you'll need to define an `asker` method on your answerer model, like so:
       end
     end
 
+
+Configuration
+-------------
+If you want to changed the default whitelisted file types for upload questions, just drop this into an initializer file.
+
+    Ask.configure do |config|
+      @upload_whitelist = %w(jpg jpeg gif png doc docx txt pdf xls xlsx zip)
+    end
+
+
 License
 -------
 MIT License

data/Rakefile

@@ -20,7 +20,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
 

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

@@ -34,9 +34,10 @@ jQuery ->
       question.find('.required-option').hide()
   
   # Update preview type whenever the user changes the type of this question
+  $('form').on "change", ".select-question-type select", ->
+    updateChoiceVisibility $(this)
+  
   bindTypeChange = (select) ->
-    select.live "change", ->
-      updateChoiceVisibility $(this)
 
   # Update once when the DOM first loads
   selects = $(".select-question-type select")
@@ -82,6 +83,9 @@ jQuery ->
         when "EssayQuestion"
           preview_section.append(q_label).append("<textarea></textarea>")
           preview_section.append(q_help_text) if q_help_text
+        when "UploadQuestion"
+          preview_section.append(q_label).append("<input type='file'>")
+          preview_section.append(q_help_text) if q_help_text
         when "ChooseOneQuestion"
           preview_section.append(q_label)
           preview_section.append(q_help_text) if q_help_text
@@ -122,7 +126,7 @@ jQuery ->
   $('fieldset.question').each ->
     createQuestionPreview $(this)
 
-  $('a.edit-question-link').live "click", (e) ->
+  $('form').on "click", "a.edit-question-link", (e) ->
     toggleEditMode($(this).closest('fieldset.question'))
     e.preventDefault()
 

data/app/assets/stylesheets/ask.css.scss

@@ -17,7 +17,7 @@
     &.preview {   // hide edit fields when in preview mode
       .edit-question-fields { display: none; }
       input[type="checkbox"], input[type="radio"] { margin: 0 8px 4px; }
-      label.preview-question-name { font-weight: bold; }
+      label.preview-question-name { font-weight: bold; display: block; }
       h3 { margin-bottom: 0; }
       hr { margin-bottom: 0; border-top: 1px solid #EEE; border-bottom: none; }
       .help-block { color: #595959; }

data/app/models/answer.rb

@@ -1,6 +1,6 @@
 class Answer < ActiveRecord::Base
 
-  attr_accessible :question_id, :answer, :choice_id
+  attr_accessible :question_id, :answer, :choice_id, :uploaded_file, :uploaded_file_cache
   
   belongs_to :answerer, :polymorphic => true
   belongs_to :question
@@ -8,12 +8,30 @@ class Answer < ActiveRecord::Base
 
   validates_presence_of :question_id
 
+  mount_uploader :uploaded_file, UploadedFileUploader
+
   default_scope joins(:question).order('questions.position')
   scope :for_answerer, lambda{|answerer| where(:answerer_type => answerer.class.to_s, :answerer_id => answerer.id)}
   scope :for_question, lambda{|question| where(:question_id => question.id)}
 
   def to_s
-    self.answer.to_s
+    if question.supports_uploads?
+      self.uploaded_file.url
+    else
+      self.answer.to_s
+    end
+  end
+
+  # This method is used to see if the answer fails to meat "required" status if the question is required.
+  #   should return true on fail and nil/false on success.
+  def fails_required?
+    if question.required
+      if question.supports_uploads?
+        uploaded_file.blank?
+      else
+        answer.blank?
+      end
+    end
   end
 
 end

data/app/models/question.rb

@@ -2,7 +2,7 @@ class Question < ActiveRecord::Base
 
   require 'acts_as_list'
 
-  TYPES = ['TextQuestion', 'EssayQuestion', 'ChooseOneQuestion', 'ChecklistQuestion', 'FormSection']  
+  TYPES = ['TextQuestion', 'EssayQuestion', 'ChooseOneQuestion', 'ChecklistQuestion', 'UploadQuestion', 'FormSection']  
   
   belongs_to :asker, :polymorphic => true
   has_many :choices, :dependent => :destroy
@@ -25,6 +25,7 @@ class Question < ActiveRecord::Base
     default
   end
 
+  # This just means it doesn't expect an answer, such as a form_section question
   def rhetorical?
     false
   end
@@ -42,4 +43,8 @@ class Question < ActiveRecord::Base
     false
   end
 
+  def supports_uploads?
+    false
+  end
+
 end

data/app/models/upload_question.rb

@@ -0,0 +1,7 @@
+class UploadQuestion < Question
+
+  def supports_uploads?
+    true
+  end
+
+end

data/app/uploaders/uploaded_file_uploader.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+class UploadedFileUploader < CarrierWave::Uploader::Base
+
+  # Include RMagick or MiniMagick support:
+  # include CarrierWave::RMagick
+  # include CarrierWave::MiniMagick
+
+  # Include the Sprockets helpers for Rails 3.1+ asset pipeline compatibility:
+  # include Sprockets::Helpers::RailsHelper
+  # include Sprockets::Helpers::IsolatedHelper
+
+  # Choose what kind of storage to use for this uploader:
+  storage :file
+  # storage :fog
+
+  # Override the directory where uploaded files will be stored.
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+    "file_uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+  # Provide a default URL as a default if there hasn't been a file uploaded:
+  # def default_url
+  #   # For Rails 3.1+ asset pipeline compatibility:
+  #   # asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
+  #
+  #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
+  # end
+
+  # Process files as they are uploaded:
+  # process :scale => [200, 300]
+  #
+  # def scale(width, height)
+  #   # do something
+  # end
+
+  # Create different versions of your uploaded files:
+  # version :thumb do
+  #   process :scale => [50, 50]
+  # end
+
+  # Add a white list of extensions which are allowed to be uploaded.
+  # For images you might use something like this:
+  def extension_white_list
+    Ask.config.upload_whitelist
+  end
+
+  # Override the filename of the uploaded files:
+  # Avoid using model.id or version_name here, see uploader/store.rb for details.
+  # def filename
+  #   "something.jpg" if original_filename
+  # end
+
+end

data/app/views/answerer/_answers.html.erb

@@ -0,0 +1,22 @@
+<% raise 'You must pass in an "answerer" to use this partial' unless defined?(answerer) %>
+
+<% answerer.questions_by_section.each do |section, questions| %>
+  <% unless section.nil? %>
+    <h3><%= section.name %></h3>
+    <p><%= section.instructions %></p>
+  <% end %>
+  <dl>
+    <% questions.each do |question| %>
+      <dt><%= question.name %></dt>
+      <% answerer.answers_to(question).each do |answer| %>
+        <dd>
+          <% if answer.is_a?(Answer) && answer.question.supports_uploads? && !answer.uploaded_file.blank? %>
+            <%= link_to answer.to_s, answer.uploaded_file.url, target: "_blank" %>
+          <% else %>
+            <%= simple_format(answer.to_s) %>
+          <% end %>
+        </dd>
+      <% end %>
+    <% end %>
+  </dl>
+<% end %>

data/app/views/answerer/_form.html.erb

@@ -0,0 +1,34 @@
+<% @prev_question_id == nil %>
+<%= f.fields_for(:answers) do |answer| %>
+  
+  <% question = answer.object.question %>
+  <%= answer.hidden_field(:question_id, value: question.id) %>
+
+  <% if question.rhetorical?  # aka, it does not need to be answered %>
+    <% case(question.type.to_sym) %>
+    <% when :FormSection %>
+      <%= render 'questions/form_section', answer: answer, question: question %>
+    <% end %>
+
+  <% else %>
+    <% if question.supports_multiple_answers? && (@prev_question_id == question.id) %>
+      <% # Don't redisplay the label again for each checklist choice, just display it the first time %>
+    <% else %>
+      <%= render 'questions/label', answer: answer, question: question %>
+      <% @prev_question_id = question.id %>
+    <% end %>
+
+    <% case(question.type.to_sym) %>
+    <% when :TextQuestion %>
+      <%= render 'questions/text_question', answer: answer, question: question %>
+    <% when :EssayQuestion %>
+      <%= render 'questions/essay_question', answer: answer, question: question %>
+    <% when :UploadQuestion %>
+      <%= render 'questions/upload_question', answer: answer, question: question %>
+    <% when :ChooseOneQuestion %>
+      <%= render 'questions/choose_one_question', answer: answer, question: question %>
+    <% when :ChecklistQuestion %>
+      <%= render 'questions/checklist_question', answer: answer, question: question %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/asker/_choice_fields.html.erb

@@ -0,0 +1,7 @@
+<fieldset class = "choice">
+  <input type = "radio" disabled = "disabled" class = "radio-preview"></input>
+  <input type = "checkbox" disabled = "disabled" class = "checkbox-preview"></input>
+  <%= f.text_field :name, :placeholder=>'Choice' %>
+  <%= f.hidden_field :_destroy %>
+  <%= link_to "remove", '#', class: "remove_fields" %>
+</fieldset>

data/app/views/asker/_choices.html.erb

@@ -0,0 +1,27 @@
+<div class = "question-type TextQuestion">
+  <input type = "text" disabled = "disabled" name = "undefined" value = "Their answer" class = "askwidget-disabledpreview"></input>
+</div>
+
+<div class = "question-type EssayQuestion start-hidden">
+  <textarea disabled = "disabled" name = "undefined" type = "text" value = "Their answer" class = "askwidget-disabledpreview"></textarea>
+</div>
+
+<div class = "question-type UploadQuestion">
+  <input type = "file" disabled = "disabled" name = "undefined" value = "Their answer" class = "askwidget-disabledpreview"></input>
+</div>
+
+<div class = "question-type ChooseOneQuestion ChecklistQuestion start-hidden">
+  <%= f.fields_for(:choices) do |choice| %>
+    <%= render 'asker/choice_fields', f: choice %>
+  <% end %>
+
+  <%= link_to_add_fields "Add Choice", f, :choices %>
+</div>
+
+<div class = "question-type FormSection start-hidden">
+  <h4> Name of section </h4>
+  <p>
+    This will provide a divider between form sections
+  </p>
+</div>
+

data/app/views/asker/_form.html.erb

@@ -0,0 +1,7 @@
+<div class = "ask questions">
+  <%= f.fields_for(:questions) do |f| %>
+    <%= render 'asker/question_fields', f: f %>
+  <% end %>
+
+  <%= link_to_add_fields "Add Question", f, :questions %>
+</div>

data/app/views/asker/_form_preview.html.erb

@@ -0,0 +1,11 @@
+<% raise 'You must pass in a "answerer" to use this partial' unless defined?(answerer) %>
+
+<%= form_for answerer, url: "#", html: {class: "form-horizontal form-preview"} do |f| %>
+  <fieldset>
+    <% # This partial is loaded from the ask gem %>
+    <%= render(partial: 'answerer/form', locals: { f: f }) %>
+  </fieldset>
+  <div class="form-actions">
+    <%= f.submit 'Submit Form', class: "btn btn-primary disabled", disabled: :disabled %>
+  </div>
+<% end %>

data/app/views/asker/_question_fields.html.erb

@@ -0,0 +1,46 @@
+<fieldset class = "question preview">
+  <div class = "question-action-links">
+    <%= link_to 'Edit', '#', class: 'edit-question-link' %>
+    |
+    <%= f.hidden_field :_destroy %>
+    <%= link_to "Remove", '#', class: "remove_fields" %>
+  </div>
+  <div class = "hidden position-wrapper">
+    <%= f.hidden_field(:position) %>
+  </div>
+  <div class = "edit-question-fields">
+    <table class = "question-details">
+      <tbody>
+        <tr>
+          <th>
+            <span class = "askwidget-fieldlabel"><%= f.label(:name) %></span>
+          </th>
+          <td><%= f.text_field :name, class: 'askwidget-inputfield' %></td>
+        </tr>
+        <tr>
+          <th>
+            <span class = "askwidget-fieldlabel"><%= f.label(:instructions, 'Help Text') %></span>
+          </th>
+          <td><%= f.text_field :instructions, class: 'askwidget-inputfield' %></td>
+        </tr>
+        <tr class = "select-question-type">
+          <th>
+            <span class = "askwidget-fieldlabel"><%= f.label(:type) %></span>
+          </th>
+          <td><%= f.collection_select :type, Question::TYPES, :to_s, :titleize, class: 'askwidget-inputfield' %></td>
+    </table>
+
+
+    <div class = "edit-question-choices">
+      <%= render 'asker/choices', f: f %>
+    </div>
+
+    <div class = "askwidget-buttons">
+      <%= link_to "Done", "#", class: 'edit-question-link btn' %>
+      <div class = "required-option">
+        <%= f.check_box :required, class: 'askwidget-inputfield' %>
+        <span class = "askwidget-fieldlabel"><%= f.label(:required, "Make this a required question") %></span>
+      </div>
+    </div>
+  </div>
+</fieldset>

data/app/views/questions/_checklist_question.html.erb

@@ -0,0 +1,5 @@
+<dd>
+  <%= answer.hidden_field(:choice_id, :value=>answer.object.choice_id) %>
+  <%= answer.check_box(:answer, {}, answer.object.choice.try(:name), '') %>
+  <%= answer.label(:answer, answer.object.choice.try(:name)) %>
+</dd>

data/app/views/questions/_choose_one_question.html.erb

@@ -0,0 +1,10 @@
+<% if question.choices.count > 5 %>
+  <dd><%= answer.collection_select(:answer, question.choice_names, :to_s, :to_s, :include_blank=>!question.required)%></dd>
+<% else %>
+  <% question.choices.each do |choice| %>
+    <dd>
+      <%=answer.radio_button(:answer, choice.name) %>
+      <%=answer.label(:answer, choice.name, :value=>choice.name) %>
+    </dd>
+  <% end %>
+<% end %>

data/app/views/questions/_essay_question.html.erb

@@ -0,0 +1 @@
+<dd><%= answer.text_area(:answer) %></dd>

data/app/views/questions/_form_section.erb

@@ -0,0 +1,4 @@
+<h3 class="section"><%= question.name %></h3>
+<% unless question.instructions.blank? %>
+  <p class="section instructions"><%= question.instructions %></p>
+<% end %>

data/app/views/questions/_label.html.erb

@@ -0,0 +1,4 @@
+<dt class="<%= question.required?? 'required' : nil %>">
+  <%= question_label(question, answer) %>
+  <%= question_instructions(question) %>
+</dt>

data/app/views/questions/_text_question.html.erb

@@ -0,0 +1 @@
+<dd><%= answer.text_field(:answer) %></dd>

data/app/views/questions/_upload_question.html.erb

@@ -0,0 +1,6 @@
+<dd>
+  <%= answer.file_field(:uploaded_file) %>
+  <%= answer.hidden_field :uploaded_file_cache %>
+  <br>
+  <%= answer.object.uploaded_file.to_s unless answer.object.uploaded_file.nil? %>
+</dd>

data/db/migrate/20130202010401_add_upload_field_to_answers.rb

@@ -0,0 +1,5 @@
+class AddUploadFieldToAnswers < ActiveRecord::Migration
+  def change
+    add_column :answers, :uploaded_file, :string
+  end
+end

data/lib/ask.rb

@@ -1,6 +1,16 @@
 require "ask/engine"
 require "ask/acts_as_asker"
 require "ask/acts_as_answerer"
+require "carrierwave"
 
 module Ask
+  require 'ask/configuration'
+
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
 end

data/lib/ask/acts_as_answerer.rb

@@ -76,11 +76,11 @@ module Ask
         
         # Set the correct order and make sure we have all the questions
         all_questions.each do |q|
-          qa[q.name] = []
+          qa[q.id] = []
         end
         
         answers.each do |a|
-          qa[a.question.name] << a.answer.to_s.strip unless a.answer.blank?
+          qa[a.question.id] << a.answer.to_s.strip unless a.answer.blank?
         end
         
         qa
@@ -89,8 +89,9 @@ module Ask
       private
       
       def validate_required_questions
+        return if asker.blank?
         asker.questions.required.each do |question|
-          if answers.select{|a| a.question_id == question.id}.all?{|a| a.answer.blank?}
+          if answers.select{|a| a.question_id == question.id}.all?{|a| a.fails_required?}
             errors[:base] << "\"#{question.name}\" is required"
           end
         end