questionnaire_engine 0.1

data/app/models/survey/options_type.rb

@@ -0,0 +1,35 @@
+class Survey::OptionsType
+  @@options_types = {:multi_choices => 1, 
+                     :single_choice => 2, 
+                     :number => 3, 
+                     :text => 4, 
+                     :multi_choices_with_text => 5, 
+                     :single_choice_with_text => 6,
+                     :multi_choices_with_number => 7, 
+                     :single_choice_with_number => 8,
+                     :large_text => 9}
+  
+  def self.options_types
+    @@options_types
+  end
+  
+  def self.options_types_title
+    titled = {}
+    Survey::OptionsType.options_types.each{|k, v| titled[k.to_s.titleize] = v}
+    titled
+  end
+  
+  def self.options_type_ids
+    @@options_types.values
+  end
+  
+  def self.options_type_keys
+    @@options_types.keys
+  end
+  
+  @@options_types.each do |key, val|
+    define_singleton_method "#{key}" do
+        val
+    end
+  end
+end

data/app/models/survey/predefined_value.rb

@@ -0,0 +1,23 @@
+class Survey::PredefinedValue < ActiveRecord::Base
+
+  self.table_name = "survey_predefined_values"
+  
+  #relations
+  belongs_to :question
+  
+  #rails 3 attr_accessible support
+  if Rails::VERSION::MAJOR < 4
+    attr_accessible :head_number, :name, :locale_name, :question_id
+  end
+  
+  # validations
+  validates :name, :presence => true
+  
+  def to_s
+    self.name
+  end
+  
+  def name
+    I18n.locale == I18n.default_locale ? super : locale_name || super
+  end
+end

data/app/models/survey/question.rb

@@ -0,0 +1,52 @@
+class Survey::Question < ActiveRecord::Base
+
+  self.table_name = "survey_questions"
+  # relations
+  has_many   :options
+  has_many   :predefined_values
+  belongs_to :section
+  
+  #rails 3 attr_accessible support
+  if Rails::VERSION::MAJOR < 4
+    attr_accessible :options_attributes, :predefined_values_attributes, :text, :section_id, :head_number, :description, :locale_text, :locale_head_number, :locale_description, :questions_type_id
+  end
+  
+  accepts_nested_attributes_for :options,
+    :reject_if => ->(a) { a[:options_type_id].blank? },
+      :allow_destroy => true
+  
+  accepts_nested_attributes_for :predefined_values,
+    :reject_if => ->(a) { a[:name].blank? },
+      :allow_destroy => true
+
+  # validations
+  validates :text, :presence => true, :allow_blank => false
+  validates :questions_type_id, :presence => true
+  validates_inclusion_of :questions_type_id, :in => Survey::QuestionsType.questions_type_ids, :unless => Proc.new{|q| q.questions_type_id.blank?}
+  
+  scope :mandatory_only, -> { where(:mandatory => true) }
+  
+  def correct_options
+    options.correct
+  end
+
+  def incorrect_options
+    options.incorrect
+  end
+  
+  def text
+    I18n.locale == I18n.default_locale ? super : locale_text.blank? ? super : locale_text
+  end
+  
+  def description
+    I18n.locale == I18n.default_locale ? super : locale_description.blank? ? super : locale_description
+  end
+  
+  def head_number
+    I18n.locale == I18n.default_locale ? super : locale_head_number.blank? ? super : locale_head_number
+  end
+  
+  def mandatory?
+    self.mandatory == true
+  end
+end

data/app/models/survey/questions_type.rb

@@ -0,0 +1,27 @@
+class Survey::QuestionsType
+  @@questions_types = {:general => 1}
+  
+  def self.questions_types
+    @@questions_types
+  end
+  
+  def self.questions_types_title
+    titled = {}
+    Survey::QuestionsType.questions_types.each{|k, v| titled[k.to_s.titleize] = v}
+    titled
+  end
+  
+  def self.questions_type_ids
+    @@questions_types.values
+  end
+  
+  def self.questions_type_keys
+    @@questions_types.keys
+  end
+  
+  @@questions_types.each do |key, val|
+    define_singleton_method "#{key}" do
+        val
+    end
+  end
+end

data/app/models/survey/section.rb

@@ -0,0 +1,47 @@
+class Survey::Section < ActiveRecord::Base
+
+  self.table_name = "survey_sections"
+  
+  # relations
+  has_many :questions
+  
+  #rails 3 attr_accessible support
+  if Rails::VERSION::MAJOR < 4
+    attr_accessible :questions_attributes, :head_number, :name, :description , :survey_id, :locale_head_number, :locale_name, :locale_description
+  end
+  
+  accepts_nested_attributes_for :questions,
+    :reject_if => ->(q) { q[:text].blank? }, :allow_destroy => true
+  
+  # validations
+  validates :name, :presence => true, :allow_blank => false
+  validate  :check_questions_requirements
+  
+  def name
+    I18n.locale == I18n.default_locale ? super : locale_name.blank? ? super : locale_name
+  end
+  
+  def description
+    I18n.locale == I18n.default_locale ? super : locale_description.blank? ? super : locale_description
+  end
+  
+  def head_number
+    I18n.locale == I18n.default_locale ? super : locale_head_number.blank? ? super : locale_head_number
+  end
+  
+  def full_name
+    head_name = self.head_number.blank? ? "" : "#{self.head_number}: "
+    "#{head_name}#{self.name}"
+  end
+  
+  #######
+  private
+  #######
+  
+  # a section only can be saved if has one or more questions and options
+  def check_questions_requirements
+    if self.questions.empty? || self.questions.collect(&:options).empty?
+      errors.add(:base, "Section without questions or options cannot be saved")
+    end
+  end
+end

data/app/models/survey/survey.rb

@@ -0,0 +1,63 @@
+class Survey::Survey < ActiveRecord::Base
+
+  self.table_name = "survey_surveys"
+  
+  # relations
+  has_many :attempts
+  has_many :sections
+  
+  #rails 3 attr_accessible support
+  if Rails::VERSION::MAJOR < 4
+    attr_accessible :name, :description, :finished, :active, :sections_attributes, :attempts_number, :locale_name, :locale_description
+  end
+  
+  accepts_nested_attributes_for :sections,
+    :reject_if => ->(q) { q[:name].blank? }, :allow_destroy => true
+    
+  scope :active, -> { where(:active => true) }
+  scope :inactive, -> { where(:active => false) }
+
+
+  validates :attempts_number,
+    :numericality => { :only_integer => true, :greater_than => -1 }
+
+  # validations
+  validates :description, :name, :presence => true, :allow_blank => false
+  validate  :check_active_requirements
+
+  # returns all the correct options for current surveys
+  def correct_options
+    Survey::Question.where(:section_id => self.sections.collect(&:id)).map { |question| question.correct_options }.flatten
+  end
+
+  # returns all the incorrect options for current surveys
+  def incorrect_options
+    Survey::Question.where(:section_id => self.sections.collect(&:id)).map { |question| question.incorrect_options }.flatten
+  end
+
+  def avaliable_for_participant?(participant)
+    current_number_of_attempts =
+      self.attempts.for_participant(participant).size
+    upper_bound = self.attempts_number
+    not(current_number_of_attempts >= upper_bound and upper_bound != 0)
+  end
+  
+  def name
+    I18n.locale == I18n.default_locale ? super : locale_name.blank? ? super : locale_name
+  end
+  
+  def description
+    I18n.locale == I18n.default_locale ? super : locale_description.blank? ? super : locale_description
+  end
+  
+  #######
+  private
+  #######
+  
+  # a surveys only can be activated if has one or more sections and questions
+  def check_active_requirements
+    if self.sections.empty? || self.sections.collect(&:questions).empty?
+      errors.add(:base, "Survey without sections or questions cannot be saved")
+    end
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,54 @@
+en:
+  surveys_controller:
+    create: Your Survey has been successfull created
+    update: Your Survey has been successfull updated
+  attempts_controller:
+    create: "Congratulations, you have responded to Survey."
+  surveys: Surveys
+  survey_details: Survey Details
+  questions: Questions
+  sections: Sections
+  predefined_values: Predefined Values
+  activerecord:
+    models:
+      survey:
+        survey: Survey
+        other: Surveys
+    attributes:
+      survey:
+        name: Name
+        locale_name: Localized name
+        finished: Finished
+        description: Short description
+        locale_description: Localized short description
+        active: "Activated?"
+        attempts_number: Number of Maximum Attempts
+        sections_attributes: Sections
+      section:
+        head_number: Head Number
+        name: Name
+        description: Description
+        locale_head_number: Localized head number
+        locale_name: Localized name
+        locale_description: Localized Description
+      question:
+        head_number: Head Number
+        text: Question Text
+        description: Description
+        locale_head_number: Localized head number
+        locale_text: Localized Question Text
+        locale_description: Localized Description
+        options_attributes: Options
+        predefined_values_attributes: Predefined Values
+      options:
+        text: Option Text
+        locale_text: Localized Option Text
+        correct: Correct
+      attempt:
+        answers_attributes: Answers
+        survey: Survey
+      answer:
+        attempt: Attempt
+        question: Question
+        option: Option
+        correct: Answer Correct?

data/config/locales/pt-PT.yml

@@ -0,0 +1,48 @@
+pt-PT:
+  questions: Perguntas
+  survey_details: Detalhes do Questionário
+  surveys_controller:
+    create: O questionário foi criado com sucesso
+    update: O questionário foi atualizado com sucesso
+  attempts_controller:
+      create: "A sua resposta foi efetuada com sucesso."
+  surveys: Questionários
+  survey_details: Detalhes do Questionário
+  questions: Perguntas
+  activerecord:
+    models:
+      survey:
+        survey: Questionário
+        other: Questionários
+      question:
+        question: Pergunta
+        other: Perguntas
+      option:
+        option: Opção
+        other: Opções
+      attempt:
+        option: Resposta
+        other: Respostas
+    attributes:
+      survey:
+        name: Nome
+        finished: Acabado
+        description: Pequena Descrição
+        active: "Ativo?"
+        attempts_number: Número máximo de tentativas
+        questions_attributes: Perguntas
+      question:
+        text: Corpo da Pergunta
+        options_attributes: Opções
+      options:
+        text: Corpo da Opção
+        correct: Correta
+      attempt:
+        answers_attributes: Respostas
+        survey: Questionário
+        winner: Vencedor
+      answer:
+        attempt: Tentativa
+        question: Pergunta
+        option: Opção
+        correct: Resposta Correta?

data/config/locales/pt.yml

@@ -0,0 +1,48 @@
+pt:
+  questions: Perguntas
+  survey_details: Detalhes do Questionário
+  surveys_controller:
+    create: O questionário foi criado com sucesso
+    update: O questionário foi atualizado com sucesso
+  attempts_controller:
+      create: "A sua resposta foi efetuada com sucesso."
+  surveys: Questionários
+  survey_details: Detalhes do Questionário
+  questions: Perguntas
+  activerecord:
+    models:
+      survey:
+        survey: Questionário
+        other: Questionários
+      question:
+        question: Pergunta
+        other: Perguntas
+      option:
+        option: Opção
+        other: Opções
+      attempt:
+        option: Resposta
+        other: Respostas
+    attributes:
+      survey:
+        name: Nome
+        finished: Acabado
+        description: Pequena Descrição
+        active: "Ativo?"
+        attempts_number: Número máximo de tentativas
+        questions_attributes: Perguntas
+      question:
+        text: Corpo da Pergunta
+        options_attributes: Opções
+      options:
+        text: Corpo da Opção
+        correct: Correta
+      attempt:
+        answers_attributes: Respostas
+        survey: Questionário
+        winner: Vencedor
+      answer:
+        attempt: Tentativa
+        question: Pergunta
+        option: Opção
+        correct: Resposta Correta?

data/lib/generators/survey/install_generator.rb

@@ -0,0 +1,35 @@
+module Survey
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def copy_migration
+        timestamp_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        
+        migration_files = [{new_file_name: "create_survey", origin_file_name: "migration"},
+                           {new_file_name: "create_sections", origin_file_name: "migration_section"},
+                           {new_file_name: "update_survey_tables", origin_file_name: "migration_update_survey_tables"},
+                           {new_file_name: "add_types_to_questions_and_options", origin_file_name: "migration_add_types_to_questions_and_options"},
+                           {new_file_name: "add_head_number_to_options_table", origin_file_name: "migration_add_head_number_to_options_table"},
+                           {new_file_name: "create_predefined_values_table", origin_file_name: "migration_create_predefined_values_table"},
+                           {new_file_name: "add_mandatory_to_questions_table", origin_file_name: "migration_add_mandatory_to_questions_table"}
+                          ]
+        
+        migration_files.each do |migration_file|
+          unless already_exists?(migration_file[:new_file_name])
+            copy_file "#{migration_file[:origin_file_name]}.rb", "db/migrate/#{timestamp_number}_#{migration_file[:new_file_name]}.rb"
+            timestamp_number += 1
+          end
+        end
+      end
+
+      #######
+      private
+      #######
+      
+      def already_exists?(file_name)
+        Dir.glob("#{File.join(destination_root, File.join("db", "migrate"))}/[0-9]*_*.rb").grep(Regexp.new('\d+_' + file_name + '.rb$')).first
+      end
+    end
+  end
+end