qwester 0.0.9 → 0.1.0

data/README.rdoc

@@ -133,6 +133,57 @@ 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.
 
+== Presentation
+
+Questionnaires can be grouped into Presentations, and these are used to
+control which questionnaires are displayed (presented to the user) at
+any time. 
+
+All questionnaires are display at the engine root unless:
+
+* A presentation is set as 'default'
+
+* An existing presentation's name is added to session[:presentations] 
+(an array)
+
+=== Restricting the questionnaires displayed
+
+If you do not want to display all the available questionnaires, create
+a presentation, set it as 'default' and add to it the questionnaires you
+wish to display.
+
+=== Using a questionnaire to control access to other questionnaires
+
+Say you have three presentations of questionnaires, and you want to display
+one initially. Then you want to use the answers submitted from that 
+questionnaire, to control which of the other two sets of questionnaires are
+displayed next.
+
+To do this set the initial presentation as default. Then create two rule
+sets, one for each of the other presentations. Update each rule set to
+match the answer pattern that should be submitted for the associated
+pattern to be displayed, and set rule_set#presentation to the name of
+the presentation you wish displayed when the rule is matched.
+
+Then when the first set of questionnaires are submitted, the rules will be
+checked, and if one of the two rules sets matches the submitted answers, 
+the associated presentation's questionnaires will be displayed.
+
+=== Simple rule matching for presentations
+
+The rule matching is simple and if two presentation rules match, the system
+will not try to work out which one it should display. It will just show the
+last one it finds. So some care is required when setting up presentations
+with matching rule sets to avoid overlaps and clashes.
+
+=== Once only match
+
+Once a presentation has been matched, it cannot be returned to later. That
+is if there are two presentations: 'one' and 'two', you cannot have a work
+flow that goes from one to two and then back to one, unless you reset or
+otherwise manipulate session[:presentations]. Instead you should clone 'one'
+as a new presentation e.g. 'three', and then go from one to two to three.
+
 == Dummy
 
 A test app is present within this engine, and provides an example of how

data/app/controllers/qwester/application_controller.rb

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

data/app/controllers/qwester/questionnaires_controller.rb

@@ -2,8 +2,7 @@ module Qwester
   class QuestionnairesController < ApplicationController
 
     def index
-      @questionnaires = Qwester::Questionnaire.all
-      @rule_sets = matching_rule_sets
+      @questionnaires = current_questionnaires
     end
 
     def show

data/app/models/qwester/presentation.rb

@@ -0,0 +1,45 @@
+module Qwester
+  class Presentation < ActiveRecord::Base
+    attr_accessible :description, :name, :title, :questionnaire_ids, :default
+    
+    has_many :presentation_questionnaires
+    
+    has_many(
+      :questionnaires,
+      :through => :presentation_questionnaires
+    )
+    accepts_nested_attributes_for :questionnaires
+    
+    before_save :before_save_tasks
+    after_save :after_save_tasks
+    
+    validates(
+      :name, 
+      :format => { 
+        :with => /^\w+$/, 
+        :message => "must comprise letters or numbers with underscores separating words"
+      },
+      :presence => true,
+      :uniqueness => true
+    )
+    
+    private
+    def before_save_tasks
+      update_title_from_name
+    end
+    
+    def after_save_tasks
+      undefault_others if self.default?
+    end
+    
+    def undefault_others
+      current_defaults = self.class.find_all_by_default(true)
+      current_defaults.each{|p| p.update_attribute(:default, false) unless p == self}
+    end
+    
+    def update_title_from_name
+      self.title = self.name.humanize unless self.title.present?
+    end
+    
+  end
+end

data/app/models/qwester/presentation_questionnaire.rb

@@ -0,0 +1,8 @@
+module Qwester
+  class PresentationQuestionnaire < ActiveRecord::Base
+    attr_accessible :presentation_id, :questionnaire_id
+    
+    belongs_to :presentation
+    belongs_to :questionnaire
+  end
+end

data/app/models/qwester/questionnaire.rb

@@ -34,6 +34,13 @@ module Qwester
       :join_table => :qwester_answer_stores_questionnaires,
       :uniq => true
     )
+    
+    has_many :presentation_questionnaires
+    
+    has_many(
+      :presentations,
+      :through => :presentation_questionnaires
+    )
 
     validates :title, :presence => true
 

data/app/models/qwester/rule_set.rb

@@ -1,7 +1,7 @@
 require 'array_logic'
 module Qwester
   class RuleSet < ActiveRecord::Base
-    attr_accessible :title, :description, :answers, :url, :rule, :answer_ids, :link_text, :warning_id
+    attr_accessible :title, :description, :answers, :url, :rule, :answer_ids, :link_text, :warning_id, :presentation
 
     before_save :keep_answers_in_step_with_rule
 
@@ -23,7 +23,7 @@ module Qwester
     validate :check_rule_is_valid
 
     validates :title, :presence => true
-    validates :url, :presence => true
+    validates :url, :presence => {:unless => :presentation?}
 
 
     def self.matching(answers)

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

@@ -19,10 +19,10 @@
 <% end %>
 </div>
 
-<% if @rule_sets.present?  %>
+<% if @qwester_rule_sets.present?  %>
 <h2>Matching rule sets</h2>
 <ul>
-<% @rule_sets.each do |rule_set| %>
+<% @qwester_rule_sets.each do |rule_set| %>
   <li>
     <%= rule_set.title %>:
     <%= link_to(rule_set.link_text, rule_set.url) %>
@@ -35,5 +35,5 @@
   content_tag(
     'p', 
     link_to('Clear answers and start again', reset_questionnaires_path)
-  ) if @rule_sets.present? 
+  ) if @qwester_rule_sets.present? 
 %>

data/db/migrate/20130315112847_create_qwester_presentations.rb

@@ -0,0 +1,11 @@
+class CreateQwesterPresentations < ActiveRecord::Migration
+  def change
+    create_table :qwester_presentations do |t|
+      t.string :name
+      t.string :title
+      t.text :description
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130315113027_create_qwester_presentation_questionnaires.rb

@@ -0,0 +1,10 @@
+class CreateQwesterPresentationQuestionnaires < ActiveRecord::Migration
+  def change
+    create_table :qwester_presentation_questionnaires do |t|
+      t.integer :questionnaire_id
+      t.integer :presentation_id
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130318102537_add_presentation_to_rule_sets.rb

@@ -0,0 +1,6 @@
+class AddPresentationToRuleSets < ActiveRecord::Migration
+  def change
+    add_column :qwester_rule_sets, :presentation, :string
+    add_column :qwester_presentations, :default, :boolean
+  end
+end

data/lib/active_admin/admin/answers.rb

@@ -7,6 +7,7 @@ module Qwester
     menu :parent => Qwester.active_admin_menu, :label => menu_label
 
     actions :all, :except => [:edit]
+    config.batch_actions = false
 
     index do
       column :id
@@ -15,7 +16,6 @@ module Qwester
         link_to(answer.question.title, edit_admin_qwester_question_path(answer.question)) if answer.question
       end
       column :position
-      column :cope_index
       default_actions
     end
     

data/lib/active_admin/admin/presentations.rb

@@ -0,0 +1,51 @@
+module Qwester
+  ActiveAdmin.register Presentation do
+
+    menu_label = 'Presentations'
+    menu_label = "Qwester #{menu_label}" unless Qwester.active_admin_menu
+    menu :parent => Qwester.active_admin_menu, :label => menu_label  
+    
+    config.batch_actions = false
+    
+    index do
+      column :name do |presentation| 
+        link_to presentation.name, admin_qwester_presentation_path(presentation)
+      end
+      column :title
+      column :default do |presentation|
+        'default' if presentation.default?
+      end
+      column :questionnaires do |presentation|
+        presentation.questionnaires.collect(&:title).join(', ')
+      end
+      default_actions
+    end
+    
+    show do
+      h2 qwester_presentation.title
+      qwester_presentation.questionnaires.each do |questionnaire|
+        div(:style => 'display:inline-block;margin-right:20px;') do
+          para image_tag(questionnaire.button_image.url(:thumbnail))
+          para questionnaire.title
+        end
+      end
+      para "Default: Will be inital presentation of quesitonnaires" if qwester_presentation.default?
+    end
+    
+    form do |f|
+      f.inputs "Details" do
+        f.input :name
+        f.input :title, :label => "Title (or create from name)"
+        f.input :default, :label => 'Set as default (that is, the first presentation displayed to a user). If no default, all questionnaires will be displayed'
+        if defined?(Ckeditor)
+          f.input :description, :as => :ckeditor, :input_html => { :height => 100, :toolbar => 'Basic' }
+        else
+          f.input :description, :input_html => { :rows => 3}
+        end
+        f.input :questionnaires, :as => :check_boxes, :collection => Questionnaire.all
+      end
+      f.buttons
+    end
+    
+  end
+end

data/lib/active_admin/admin/questionnaires.rb

@@ -6,6 +6,8 @@ module Qwester
     menu_label = "Qwester #{menu_label}" unless Qwester.active_admin_menu
     menu :parent => Qwester.active_admin_menu, :label => menu_label
 
+    config.batch_actions = false
+    
     index do
       column :image do |questionnaire|
         image_tag(questionnaire.button_image.url(:thumbnail))

data/lib/active_admin/admin/questions.rb

@@ -6,6 +6,8 @@ module Qwester
     menu_label = "Qwester #{menu_label}" unless Qwester.active_admin_menu
     menu :parent => Qwester.active_admin_menu, :label => menu_label
 
+    config.batch_actions = false
+    
     index do
       column :ref
       column :title do |qwester_question|

data/lib/active_admin/admin/rule_sets.rb

@@ -6,8 +6,11 @@ module Qwester
     menu_label = "Qwester #{menu_label}" unless Qwester.active_admin_menu
     menu :parent => Qwester.active_admin_menu, :label => menu_label
 
+    config.batch_actions = false
+    
     index do
       column :title
+      column :presentation
       column :answers do |rule_set|
         rule_set.answers.count
       end
@@ -57,6 +60,25 @@ module Qwester
 
     end
     
+    sidebar :presentations do
+      para <<EOF
+If a rule is assigned a presentation, that presentation's questionnaires will
+be displayed when the rule is matched.
+EOF
+      
+      para <<EOF
+There is no mechanism to handle multiple rules with presentations, being trigged 
+at the same time. The app will just display the questionnaires assigned to the 
+last rule_set.presentation it finds. So some care should be taken to avoid 
+clashes.
+EOF
+      
+      para <<EOF
+A rule set with a presentation, will change the display. It will not display
+an output tab, any url associated with the rule will be ignored.     
+EOF
+    end
+    
     form do |f|
       f.inputs "Details" do
         f.input :title
@@ -72,6 +94,10 @@ module Qwester
         f.input :link_text        
       end
       
+      f.inputs "Change Presentation of Questionnaires" do
+        f.input :presentation, :as => :select, :collection => Presentation.all.collect(&:name), :include_blank => 'No effect on presentation'
+      end
+      
       f.inputs "Logic" do
         f.input :rule, :input_html => { :rows => 3}
       end
@@ -123,6 +149,15 @@ module Qwester
         para qwester_rule_set.link_text? ? qwester_rule_set.link_text : 'No link text specified'
       end
       
+      div do
+        h3 'Presentation'
+        if qwester_rule_set.presentation?
+          para "The presentations of questionnaires should change to: #{qwester_rule_set.presentation}"
+        else
+          para "The presentations of questionnaires should be unaffected by this rule"
+        end
+      end
+      
       div do
         h3 'The rule'
         para qwester_rule_set.rule

data/lib/qwester/version.rb

@@ -1,10 +1,16 @@
 module Qwester
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end
 
 # History
 # =======
 # 
+# 0.1.0 - Add presentations as a way of controlling the display of questionnaires
+#   Allows admin to define groups of questionnaires as presentation views
+#   and rule sets that will display a presentation when triggered. In that way 
+#   the list of questionnaires being displayed can change as questionnaires are
+#   submitted.
+# 
 # 0.0.9 - maintenance update
 #   Removes cope_index from migrations.
 #   Ensures answer_store#session_id is unique

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

@@ -33,13 +33,46 @@ module ActionController
       @qwester_answer_store
     end
     
-    def matching_rule_sets
+    def match_rule_sets
       if get_qwester_answer_store
-        Qwester::RuleSet.matching(@qwester_answer_store.answers)
+        @qwester_rule_sets = Qwester::RuleSet.matching(@qwester_answer_store.answers)
+        get_presentation_from_rule_sets
+        return @qwester_rule_sets
+      end
+    end
+    alias_method :matching_rule_sets, :match_rule_sets
+        
+    def current_questionnaires
+      match_rule_sets
+      presentation_questionnaires || default_presentation_questionnaires || Qwester::Questionnaire.all
+    end
+    
+    def presentation_questionnaires
+      presentation = Qwester::Presentation.find_by_name(session[:presentations].last) if session[:presentations]
+      presentation.questionnaires if presentation
+    end
+    
+    def default_presentation_questionnaires
+      presentation = Qwester::Presentation.find_by_default(true)
+      presentation.questionnaires if presentation
+    end
+    
+    def get_presentation_from_rule_sets
+      @qwester_rule_sets.clone.each do |rule_set|
+        next unless rule_set.presentation?
+        add_presentation_to_session rule_set.presentation
+        @qwester_rule_sets.delete(rule_set)
+      end
+    end
+    
+    def add_presentation_to_session(presentation)
+      session_presentations = session[:presentations] || []
+      unless session_presentations.include? presentation
+        session_presentations << presentation
+        session[:presentations] = session_presentations
       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)}

data/test/dummy/db/migrate/20130315113346_create_qwester_presentations.qwester.rb

@@ -0,0 +1,12 @@
+# This migration comes from qwester (originally 20130315112847)
+class CreateQwesterPresentations < ActiveRecord::Migration
+  def change
+    create_table :qwester_presentations do |t|
+      t.string :name
+      t.string :title
+      t.text :description
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20130315113347_create_qwester_presentation_questionnaires.qwester.rb

@@ -0,0 +1,11 @@
+# This migration comes from qwester (originally 20130315113027)
+class CreateQwesterPresentationQuestionnaires < ActiveRecord::Migration
+  def change
+    create_table :qwester_presentation_questionnaires do |t|
+      t.integer :questionnaire_id
+      t.integer :presentation_id
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20130318123540_add_presentation_to_rule_sets.qwester.rb

@@ -0,0 +1,7 @@
+# This migration comes from qwester (originally 20130318102537)
+class AddPresentationToRuleSets < ActiveRecord::Migration
+  def change
+    add_column :qwester_rule_sets, :presentation, :string
+    add_column :qwester_presentations, :default, :boolean
+  end
+end

data/test/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20130314103662) do
+ActiveRecord::Schema.define(:version => 20130318123540) do
 
   create_table "active_admin_comments", :force => true do |t|
     t.string   "resource_id",   :null => false
@@ -91,6 +91,22 @@ ActiveRecord::Schema.define(:version => 20130314103662) do
   add_index "qwester_ckeditor_assets", ["assetable_type", "assetable_id"], :name => "qwester_idx_ckeditor_assetable"
   add_index "qwester_ckeditor_assets", ["assetable_type", "type", "assetable_id"], :name => "qwester_idx_ckeditor_assetable_type"
 
+  create_table "qwester_presentation_questionnaires", :force => true do |t|
+    t.integer  "questionnaire_id"
+    t.integer  "presentation_id"
+    t.datetime "created_at",       :null => false
+    t.datetime "updated_at",       :null => false
+  end
+
+  create_table "qwester_presentations", :force => true do |t|
+    t.string   "name"
+    t.string   "title"
+    t.text     "description"
+    t.datetime "created_at",  :null => false
+    t.datetime "updated_at",  :null => false
+    t.boolean  "default"
+  end
+
   create_table "qwester_questionnaires", :force => true do |t|
     t.string   "title"
     t.text     "description"
@@ -127,10 +143,11 @@ ActiveRecord::Schema.define(:version => 20130314103662) do
     t.string   "title"
     t.text     "description"
     t.string   "url"
-    t.datetime "created_at",  :null => false
-    t.datetime "updated_at",  :null => false
+    t.datetime "created_at",   :null => false
+    t.datetime "updated_at",   :null => false
     t.text     "rule"
     t.string   "link_text"
+    t.string   "presentation"
   end
 
 end