ask_it 0.1.1

data/app/models/ask_it/option.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module AskIt
+  class Option < ActiveRecord::Base
+    self.table_name = 'survey_options'
+    # relations
+    belongs_to :question
+    has_many :answers
+
+    # rails 3 attr_accessible support
+    if Rails::VERSION::MAJOR < 4
+      attr_accessible :text, :correct, :weight, :question_id, :locale_text, :options_type_id, :head_number
+    end
+
+    # validations
+    validates :text, presence: true, allow_blank: false, if: :requires_text?
+    validates :options_type_id, presence: true
+    validates :options_type_id, inclusion: { in: AskIt::OptionsType.options_type_ids, unless: proc { |o|
+                                                                                                o.options_type_id.blank?
+                                                                                              } }
+
+    scope :correct, -> { where(correct: true) }
+    scope :incorrect, -> { where(correct: false) }
+
+    before_create :default_option_weigth
+
+    def to_s
+      text
+    end
+
+    def correct?
+      correct == true
+    end
+
+    def text
+      if I18n.locale == I18n.default_locale
+        super
+      else
+        locale_text.blank? ? super : locale_text
+      end
+    end
+
+    #######
+
+    private
+
+    #######
+
+    def default_option_weigth
+      self.weight = 1 if correct && weight.zero?
+    end
+
+    def requires_text?
+      [
+        AskIt::OptionsType.multi_choices,
+        AskIt::OptionsType.single_choice,
+        AskIt::OptionsType.single_choice_with_text,
+        AskIt::OptionsType.single_choice_with_number,
+        AskIt::OptionsType.multi_choices_with_text,
+        AskIt::OptionsType.multi_choices_with_number,
+        AskIt::OptionsType.large_text
+      ].include?(options_type_id)
+    end
+  end
+end

data/app/models/ask_it/options_type.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module AskIt
+  class 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 = {}
+      AskIt::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.to_s do
+        val
+      end
+    end
+  end
+end

data/app/models/ask_it/predefined_value.rb

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

data/app/models/ask_it/question.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# app/models/ask_it/question.rb
+
+module AskIt
+  class Question < ActiveRecord::Base
+    self.table_name = 'survey_questions'
+    # relations
+    has_many   :options
+    has_many   :predefined_values
+    has_many   :answers
+    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 :questions_type_id, inclusion: { in: AskIt::QuestionType.questions_type_ids, unless: proc { |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
+      if I18n.locale == I18n.default_locale
+        super
+      else
+        locale_text.blank? ? super : locale_text
+      end
+    end
+
+    def description
+      if I18n.locale == I18n.default_locale
+        super
+      else
+        locale_description.blank? ? super : locale_description
+      end
+    end
+
+    def head_number
+      if I18n.locale == I18n.default_locale
+        super
+      else
+        locale_head_number.blank? ? super : locale_head_number
+      end
+    end
+
+    def mandatory?
+      mandatory == true
+    end
+  end
+end

data/app/models/ask_it/question_type.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# app/models/ask_it/questions_type.rb
+module AskIt
+  class QuestionType
+    @@questions_types = { multiple_choice: 2, free_response: 9, multi_select: 1 }
+
+    def self.questions_types
+      @@questions_types
+    end
+
+    def self.questions_types_title
+      titled = {}
+      AskIt::QuestionType.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.to_s do
+        val
+      end
+    end
+  end
+end

data/app/models/ask_it/section.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module AskIt
+  class Section < ActiveRecord::Base
+    self.table_name = 'survey_sections'
+
+    # relations
+    has_many :questions
+    belongs_to :survey
+
+    # 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
+      if I18n.locale == I18n.default_locale
+        super
+      else
+        locale_name.blank? ? super : locale_name
+      end
+    end
+
+    def description
+      if I18n.locale == I18n.default_locale
+        super
+      else
+        locale_description.blank? ? super : locale_description
+      end
+    end
+
+    def head_number
+      if I18n.locale == I18n.default_locale
+        super
+      else
+        locale_head_number.blank? ? super : locale_head_number
+      end
+    end
+
+    def full_name
+      head_name = head_number.blank? ? '' : "#{head_number}: "
+      "#{head_name}#{name}"
+    end
+
+    #######
+
+    private
+
+    #######
+
+    # a section only can be saved if has one or more questions and options
+    def check_questions_requirements
+      return unless questions.empty? || questions.collect(&:options).empty?
+
+      errors.add(:base, 'Section without questions or options cannot be saved')
+    end
+  end
+end

data/app/models/ask_it/survey.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module AskIt
+  class Survey < ActiveRecord::Base
+    self.table_name = 'survey_surveys'
+
+    # relations
+    has_many :attempts, class_name: 'AskIt::Attempt'
+    has_many :sections, class_name: 'AskIt::Section'
+    has_many :questions, through: :sections, class_name: 'AskIt::Question'
+
+    # 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
+      AskIt::Question.where(section_id: section_ids).map(&:correct_options).flatten
+    end
+
+    # returns all the incorrect options for current surveys
+    def incorrect_options
+      AskIt::Question.where(section_id: sections.collect(&:id)).map(&:incorrect_options).flatten
+    end
+
+    def avaliable_for_participant?(participant)
+      current_number_of_attempts =
+        attempts.for_participant(participant).size
+      upper_bound = attempts_number
+      !(current_number_of_attempts >= upper_bound && upper_bound != 0)
+    end
+
+    def name
+      if I18n.locale == I18n.default_locale
+        super
+      else
+        locale_name.blank? ? super : locale_name
+      end
+    end
+
+    def description
+      if I18n.locale == I18n.default_locale
+        super
+      else
+        locale_description.blank? ? super : locale_description
+      end
+    end
+
+    #######
+
+    private
+
+    #######
+
+    # a surveys only can be activated if has one or more sections and questions
+    def check_active_requirements
+      return unless sections.empty? || 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/ask_it/active_record.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module AskIt
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def has_surveys
+        has_many :survey_attempts, as: :participant, class_name: 'AskIt::Attempt'
+
+        define_method('for_survey') do |survey|
+          survey_attempts.where(survey_id: survey.id)
+        end
+      end
+
+      def has_many_surveys
+        has_many :surveys, class_name: 'AskIt::Survey'
+      end
+
+      def has_one_survey
+        has_one :survey, class_name: 'AskIt::Survey'
+      end
+    end
+  end
+end

data/lib/ask_it/engine.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module AskIt
+  class Engine < Rails::Engine
+  end
+end

data/lib/ask_it/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module AskIt
+  class Railtie < ::Rails::Railtie
+    generators do
+      require 'ask_it/generators/ask_it/install_generator'
+    end
+
+    initializer 'ask_it.load_models' do |app|
+      app.config.paths.add 'app/models/ask_it', eager_load: true
+    end
+  end
+end

data/lib/ask_it/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AskIt
+  VERSION = '0.1.1'
+end

data/lib/ask_it.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# require 'app/models/ask_it/survey'
+require_relative '../app/models/ask_it/survey'
+require_relative '../app/models/ask_it/section'
+require_relative '../app/models/ask_it/question_type'
+require_relative '../app/models/ask_it/question'
+require_relative '../app/models/ask_it/predefined_value'
+require_relative '../app/models/ask_it/options_type'
+require_relative '../app/models/ask_it/option'
+require_relative '../app/models/ask_it/attempt'
+require_relative '../app/models/ask_it/answer'
+require_relative 'ask_it/active_record'
+require_relative '../app/controllers/ask_it/surveys_controller'
+require_relative '../app/controllers/ask_it/attempts_controller'
+
+module AskIt
+end
+
+ActiveRecord::Base.include AskIt::ActiveRecord

data/lib/generators/ask_it/install_generator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module AskIt
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      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|
+          next if already_exists?(migration_file[:new_file_name])
+
+          template "#{migration_file[:origin_file_name]}.rb.tt",
+                   "db/migrate/#{timestamp_number}_#{migration_file[:new_file_name]}.rb"
+          timestamp_number += 1
+        end
+      end
+
+      def migration_version
+        return unless rails5_and_up?
+
+        puts(Rails::VERSION)
+
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+
+      def rails5_and_up?
+        Rails::VERSION::MAJOR >= 5
+      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