qwester 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,12 +1,80 @@
 = Qwester
 
+A rails engine used to add questionnaires to rails applications
 
+== Installation
+
+Add this to your Gemfile
+
+    gem 'qwester'
+
+=== Migrations
+Qwester includes a set of migrations to build the database tables to match
+qwester's models. To use these migrations within the host application, run
+this rake task:
+
+    rake qwester:install:migrations
+
+This will copy the migrations to the host application's db/migrate folder.
+They will then be run next time the db:migrate task is run:
+
+    rake db:migrate
+
+If you only wish to run the qwester migrations use a scope option:
+
+    rake db:migrate SCOPE=qwester
+
+== Questionnaire
+
+To create a new questionnaire, first create a set of questions that you
+wish to appear within the questionnaire. Then create a questionnaire and
+associate the questions with that questionnaire. Questions can be used in
+multiple questionnaires, and can be ordered within each questionnaire. That
+is, the first question in one questionnaire, can be displayed as the second
+question in another questionnaire.
+
+=== Questions and Answers
+
+Each question has a number of answers associated with it. The default set of
+answers is given by:
+
+    Qwester::Answer.standard_values
+
+However, these can be modified and added to as you require. That is, each
+question has a unique set of answers that can be modified as required.
+
+=== Answer store
+
+Submitted answers are stored in an AnswerStore object. On creation, each 
+answer_store is assigned a session_id that can then be used within session,
+to identify the current user's answer_store. In this way, questionnaire 
+submissions can be tracked across multiple submissions.
+
+=== Rule set
+
+Groups of answers can be matched to rule sets using:
+
+    RuleSet.matching(answers)
+
+which will return an array of rule sets that match those answers.
+
+Each rule set has an url associated with it, and this url should lead a user
+to a resource either within or outside the app.
+
+RuleSet uses array_logic[http://github.com/reggieb/array_logic] to manage 
+the logic used to compare each rule set with the array of answers.
+
+== Dummy
+
+A test app is present within this engine, and provides an example of how
+Qwester can be used within a Rails app. See test/dummy.
 
 == Integration with ActiveAdmin
 
 Qwester contains a set of ActiveAdmin registration files, that allow Qwester
 models to be managed from within the parent app's active_admin space. Of course
-ActiveAdmin needs to be installed and working in the parent rails application
+ActiveAdmin needs to be installed and working in the parent rails application,
+for this to work.
 
 To use the Qwester ActiveAdmin registration files, add this to the active_admin 
 initializer in your application.
@@ -15,6 +83,12 @@ initializer in your application.
 
 See test/dummy/config/initializers/active_admin.rb for an example
 
+If you wish to over-ride some of Qwester's active admin registrations you will
+need to reorder the active_admin load_paths. In this case, use this form of
+the load_paths declaration:
+
+    config.load_paths = [Qwester.active_admin_load_path] + config.load_paths
+
 Links to the admin pages for Qwester models will appear in a 'Qwester' sub-menu.
 If you wish to change the name of the menu parent group, add this to an 
 initializer:
@@ -26,4 +100,4 @@ initializer:
 
     Qwester.active_admin_menu = 'none'
 
-See test/dummy/config/initializers/qwester.rb for an example
+See test/dummy/config/initializers/qwester.rb for an example

data/app/controllers/qwester/application_controller.rb

@@ -1,4 +1,6 @@
 module Qwester
   class ApplicationController < ActionController::Base
+    
+   
   end
 end

data/app/controllers/qwester/questionnaires_controller.rb

@@ -0,0 +1,25 @@
+module Qwester
+  class QuestionnairesController < ApplicationController
+
+    def index
+      @questionnaires = Qwester::Questionnaire.all
+      @rule_sets = matching_rule_sets
+    end
+
+    def show
+      @questionnaire = Qwester::Questionnaire.find(params[:id])
+    end
+
+    def update
+      @questionnaire = Qwester::Questionnaire.find(params[:id])
+      update_qwester_answer_store
+      redirect_to questionnaires_path
+    end
+
+    def reset
+      get_qwester_answer_store
+      @qwester_answer_store.reset
+      redirect_to questionnaires_path
+    end
+  end
+end

data/app/helpers/qwester/application_helper.rb

@@ -1,4 +1,5 @@
 module Qwester
   module ApplicationHelper
+
   end
 end

data/app/helpers/qwester/questionnaires_helper.rb

@@ -0,0 +1,26 @@
+module Qwester
+  module QuestionnairesHelper
+    def qwester_answers_selection_list(question, list_class = 'qwester_options')
+      button_name = "question_id[#{question.id}][answer_ids][]"
+      answers = question.answers
+      buttons = answers.collect do |answer|
+        if question.multi_answer?
+          button = check_box_tag(button_name, answer.id, answer_checked(answer))
+        else
+          button = radio_button_tag(button_name, answer.id, answer_checked(answer))
+        end
+        content_tag('li', "#{button}#{answer.value}".html_safe)
+      end
+      content_tag('ul', buttons.join.html_safe, :class => list_class)
+    end
+
+    def answer_checked(answer)
+      answer_store_answers.include? answer
+    end
+
+    def answer_store_answers
+      answer_store = get_qwester_answer_store
+      answer_store ? answer_store.answers : []
+    end
+  end
+end

data/app/models/qwester/questionnaire.rb

@@ -29,7 +29,11 @@ module Qwester
       }
     )
 
-    has_and_belongs_to_many :answer_stores, :uniq => true
+    has_and_belongs_to_many(
+      :answer_stores, 
+      :join_table => :qwester_answer_stores_questionnaires,
+      :uniq => true
+    )
 
     validates :title, :presence => true
 

data/app/views/qwester/questionnaires/index.html.erb

@@ -0,0 +1,39 @@
+<h1>Questionnaires</h1>
+<div>
+<% @questionnaires.each do |questionnaire| %>
+
+  <%= link_to(
+        image_tag(questionnaire.button_image.url(:link)), 
+        questionnaire_path(questionnaire),
+        :class => 'image_link'
+      ) 
+  %>
+  <br>
+  <%= link_to(
+        questionnaire.title, 
+        questionnaire_path(questionnaire),
+        :class => 'text_link'
+      ) 
+  %>
+
+<% end %>
+</div>
+
+<% if @rule_sets.present?  %>
+<h2>Matching rule sets</h2>
+<ul>
+<% @rule_sets.each do |rule_set| %>
+  <li>
+    <%= rule_set.title %>:
+    <%= link_to(rule_set.link_text, rule_set.url) %>
+  </li>
+<% end %>
+</ul>
+<% end %>
+
+<%= 
+  content_tag(
+    'p', 
+    link_to('Clear answers and start again', reset_questionnaires_path)
+  ) if @rule_sets.present? 
+%>

data/app/views/qwester/questionnaires/show.html.erb

@@ -0,0 +1,32 @@
+<h1><%= @questionnaire.title %></h1>
+
+<%  if @questionnaire.description.present? %>
+<%= content_tag('div', sanitize(@questionnaire.description)) %>
+<% else %> 
+<h2>Questions</h2>
+<% end %>
+
+<%= form_for(@questionnaire, :url => questionnaire_path(@questionnaire)) do |form| %>
+<ul>
+<%=   form.fields_for(@questionnaire.answers, Qwester::Answer) do |answer_form| %>
+<%      @questionnaire.questions.each do |question| %>
+  <li>
+    <%= content_tag(
+          'span', question.title,
+          :class => "label#{' tooltip' if question.description?}",
+          :title => question.description
+        )
+    %>
+
+    <%= qwester_answers_selection_list(question) %>
+
+  </li>
+<%       end %>
+<%    end %>
+</ul>
+
+<p>
+  <%= form.submit('Submit') %>
+  <%= link_to('Back to the menu', questionnaires_path) %>
+</p>
+<% end %>

data/config/routes.rb

@@ -1,2 +1,11 @@
 Qwester::Engine.routes.draw do
+  
+  root :to => 'questionnaires#index'
+  
+  resources :questionnaires, :only => [:index, :show, :update] do
+    collection do
+      get :reset
+    end
+  end
+  
 end

data/lib/qwester.rb

@@ -2,6 +2,7 @@ require "qwester/engine"
 require 'acts_as_list'
 require 'paperclip'
 require 'random_string'
+require 'rails/actionpack/lib/action_controller/base'
 
 module Qwester
   

data/lib/qwester/engine.rb

@@ -1,5 +1,13 @@
 module Qwester
   class Engine < ::Rails::Engine
     isolate_namespace Qwester
+    
+    initializer 'qwester.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        
+        helper Qwester::QuestionnairesHelper
+             
+      end
+    end
   end
 end

data/lib/qwester/version.rb

@@ -1,3 +1,3 @@
 module Qwester
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/rails/actionpack/lib/action_controller/base.rb

@@ -0,0 +1,60 @@
+module ActionController
+  class Base < Metal
+    
+    protected
+    def update_qwester_answer_store
+      get_qwester_answer_store(true)
+      add_answers_to_qwester_answer_store
+      add_questionnaire_to_qwester_answer_store
+    end
+
+    def get_qwester_answer_store(create_new = false)
+      if session[:qwester_answer_store]
+        current_qwester_answer_store
+      elsif create_new
+        new_qwester_answer_store
+      end
+    end
+    helper_method :get_qwester_answer_store
+
+    def current_qwester_answer_store
+      @qwester_answer_store = Qwester::AnswerStore.find_by_session_id(session[:qwester_answer_store])
+    end
+
+    def new_qwester_answer_store
+      set_qwester_answer_store Qwester::AnswerStore.create
+    end
+    
+    def set_qwester_answer_store(answer_store)
+      @qwester_answer_store = answer_store
+      session[:qwester_answer_store] = @qwester_answer_store.session_id
+      @qwester_answer_store
+    end
+    
+    def matching_rule_sets
+      if get_qwester_answer_store
+        Qwester::RuleSet.matching(@qwester_answer_store.answers)
+      end
+    end
+    
+#    private
+    def add_answers_to_qwester_answer_store
+      answers = params[:question_id].values.collect do |question_values|
+        question_values[:answer_ids].collect{|id| Qwester::Answer.find(id)}
+      end
+      answers.flatten!
+      remove_answers_to_questions_answered_with(answers) if answers.present?
+      @qwester_answer_store.answers = (@qwester_answer_store.answers | answers)      
+    end
+    
+    def remove_answers_to_questions_answered_with(answers)
+      question_ids = answers.collect(&:question_id).uniq
+      answers_to_delete = @qwester_answer_store.answers.collect {|a| a if question_ids.include? a.question_id.to_i}.compact
+      @qwester_answer_store.answers.delete(answers_to_delete)
+    end
+
+    def add_questionnaire_to_qwester_answer_store
+      @qwester_answer_store.questionnaires << @questionnaire
+    end
+  end
+end

data/test/dummy/app/assets/javascripts/questionnaires.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/questionnaires.css.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the questionnaires controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/test/dummy/config/routes.rb

@@ -1,9 +1,13 @@
 Rails.application.routes.draw do
+  
+  root :to => 'qwester/questionnaires#index'
 
   if defined?(ActiveAdmin)
     ActiveAdmin.routes(self)
     devise_for :admin_users, ActiveAdmin::Devise.config
   end
 
-  mount Qwester::Engine => "/qwester"
+  mount Qwester::Engine => "/questionnires"
+  
+
 end

data/test/dummy/db/seeds.rb

@@ -3,6 +3,7 @@ Seeder = Dibber::Seeder
 
 Seeder.seeds_path = "#{Rails.root}/db/seeds"
 
+##############################
 Seeder.monitor AdminUser
 admin_email = 'admin@warwickshire.gov.uk'
 password = 'changeme'
@@ -12,4 +13,35 @@ AdminUser.create!(
   :password_confirmation => password
 ) unless AdminUser.exists?(:email => admin_email)
 
+##############################
+Seeder.monitor Qwester::Questionnaire
+Seeder.monitor Qwester::Question
+Seeder.monitor Qwester::Answer
+Seeder.monitor Qwester::RuleSet
+Seeder.process_log.start('first questionnaire questions', 'Qwester::Questionnaire.count > 0 ? Qwester::Questionnaire.first.questions.length : 0')
+
+if Qwester::Questionnaire.count > 1
+  puts "**** Bypassing questionnaire, question, answer and rule set population"
+  puts "**** as there are already #{Qwester::Questionnaire.count} questionnaires in the system"
+else
+  Seeder.objects_from('questions.yml').each do |holder, data|
+    questionnaire = Qwester::Questionnaire.find_or_create_by_title(data['title'])
+
+    if data['questions']
+      data['questions'].values.each do |question_data|
+        question = Qwester::Question.find_or_create_by_title(question_data['question'])
+        question.create_standard_answers
+        answer = question.answers.find_or_create_by_value('Yes')
+        rule_set = Qwester::RuleSet.find_or_initialize_by_title(question_data['title'])
+        rule_set.url = question_data['url']
+        rule_set.answers = [answer]
+        rule_set.save
+        questionnaire.questions << question
+      end
+    end
+  end
+end
+
+
+##############################
 puts Seeder.report

data/test/dummy/db/seeds/questions.yml

@@ -0,0 +1,21 @@
+Q1: 
+  title: Blue
+  questions:
+    a:
+      title: Other blue favourites
+      question:  Is blue your favourite colour?	
+      url: https://www.google.co.uk/search?q=favourite+blue
+  
+    b:
+      title: 
+      question: Is the sky blue?
+      url: https://www.google.co.uk/search?q=sky+blue
+
+
+Q2:
+  title: Qwester
+  questions:
+    a:
+      title: As you like qwester
+      question: Do you like qwester?
+      url: https://github.com/reggieb/qwester