surveillance 0.1.1

data/db/migrate/20130626115136_create_surveillance_surveys.rb

@@ -0,0 +1,13 @@
+class CreateSurveillanceSurveys < ActiveRecord::Migration
+  def change
+    create_table :surveillance_surveys do |t|
+      t.string :title
+      t.text :description
+      t.text :last_page_description
+      t.date :end_date
+      t.boolean :published, default: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130626115805_create_surveillance_sections.rb

@@ -0,0 +1,12 @@
+class CreateSurveillanceSections < ActiveRecord::Migration
+  def change
+    create_table :surveillance_sections do |t|
+      t.string :title
+      t.text :description
+      t.integer :position, default: 0
+      t.integer :survey_id
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130626130351_create_surveillance_questions.rb

@@ -0,0 +1,14 @@
+class CreateSurveillanceQuestions < ActiveRecord::Migration
+  def change
+    create_table :surveillance_questions do |t|
+      t.text :title
+      t.text :description
+      t.belongs_to :parent, polymorphic: true
+      t.string :field_type
+      t.boolean :mandatory, default: true
+      t.integer :position, default: 0
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130702111125_create_surveillance_options.rb

@@ -0,0 +1,11 @@
+class CreateSurveillanceOptions < ActiveRecord::Migration
+  def change
+    create_table :surveillance_options do |t|
+      t.string :title
+      t.integer :question_id
+      t.integer :position, default: 0
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130703113456_create_surveillance_attempts.rb

@@ -0,0 +1,11 @@
+class CreateSurveillanceAttempts < ActiveRecord::Migration
+  def change
+    create_table :surveillance_attempts do |t|
+      t.belongs_to :user, polymorphic: true
+      t.integer :survey_id
+      t.string :ip_address
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130703115649_create_surveillance_answers.rb

@@ -0,0 +1,11 @@
+class CreateSurveillanceAnswers < ActiveRecord::Migration
+  def change
+    create_table :surveillance_answers do |t|
+      t.integer :attempt_id
+      t.integer :question_id
+      t.boolean :other_choosed, default: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130703115723_create_surveillance_answer_contents.rb

@@ -0,0 +1,10 @@
+class CreateSurveillanceAnswerContents < ActiveRecord::Migration
+  def change
+    create_table :surveillance_answer_contents do |t|
+      t.text :value
+      t.integer :answer_id
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130710151627_create_surveillance_field_settings.rb

@@ -0,0 +1,11 @@
+class CreateSurveillanceFieldSettings < ActiveRecord::Migration
+  def change
+    create_table :surveillance_field_settings do |t|
+      t.string :key
+      t.text :value
+      t.integer :question_id
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130711100032_create_surveillance_answers_options_join_table.rb

@@ -0,0 +1,7 @@
+class CreateSurveillanceAnswersOptionsJoinTable < ActiveRecord::Migration
+  def change
+    create_table :surveillance_answers_options do |t|
+      t.references :answer, :option
+    end
+  end
+end

data/db/migrate/20130729143002_create_surveillance_branch_rules.rb

@@ -0,0 +1,14 @@
+class CreateSurveillanceBranchRules < ActiveRecord::Migration
+  def change
+    create_table :surveillance_branch_rules do |t|
+      t.integer :question_id
+      t.integer :sub_question_id
+      t.integer :option_id
+      t.integer :section_id
+      t.string :condition
+      t.string :action
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140212153506_add_state_to_surveillance_attempts.rb

@@ -0,0 +1,6 @@
+class AddStateToSurveillanceAttempts < ActiveRecord::Migration
+  def change
+    add_column :surveillance_attempts, :state, :string
+    add_column :surveillance_attempts, :last_answered_section, :integer
+  end
+end

data/db/migrate/20140213101147_add_access_token_to_surveillance_attempts.rb

@@ -0,0 +1,5 @@
+class AddAccessTokenToSurveillanceAttempts < ActiveRecord::Migration
+  def change
+    add_column :surveillance_attempts, :access_token, :string
+  end
+end

data/db/migrate/20140213133036_add_partial_to_surveillance_questions.rb

@@ -0,0 +1,5 @@
+class AddPartialToSurveillanceQuestions < ActiveRecord::Migration
+  def change
+    add_column :surveillance_questions, :partial, :string
+  end
+end

data/lib/generators/surveillance/install/install_generator.rb

@@ -0,0 +1,34 @@
+module Surveillance
+  class InstallGenerator < Rails::Generators::Base
+    # Copied files come from templates folder
+    source_root File.expand_path('../templates', __FILE__)
+
+    # Generator desc
+    desc "Surveillance installation generator"
+
+    def welcome
+      say "Installing surveillance files ..."
+    end
+
+    def copy_initializer_file
+      say "Copying Surveillance initializer template"
+      copy_file "initializer.rb", "config/initializers/surveillance.rb"
+    end
+
+    def copy_migrations
+      say "Installing migrations, don't forget to `rake db:migrate`"
+      rake "surveillance:install:migrations"
+    end
+
+    def mount_engine
+      mount_path = ask(
+        "Where would you like to mount the Surveillance engine ? [/surveillance]"
+      ).presence || '/surveillance'
+
+      gsub_file "config/routes.rb", /mount Surveillance::Engine.*\'/, ''
+
+      path = mount_path.match(/^\//) ? mount_path : "/#{ mount_path }"
+      route "mount Surveillance::Engine => '#{ path }'"
+    end
+  end
+end

data/lib/generators/surveillance/install/templates/initializer.rb

@@ -0,0 +1,51 @@
+Surveillance.config do |config|
+  # Choose a controller class method to be called before admin controllers
+  # actions to authenticate admins
+  # Setting it to nil, will let everybody access the admin panel
+  #
+  # Default : nil
+  #
+  # config.admin_authorization_method = :authenticate_user!
+
+  # Define a layout to be used in Surveillance views
+  # Setting it to nil will let the default layout
+  #
+  # Default : nil
+  #
+  # config.views_layout = "survey"
+
+  # Change Admin base controller
+  #
+  # config.admin_base_controller = 'AdminController'
+
+  # Register field partials to allow overriding field rendering from admin
+  #
+  # Don't forget to add the registered partial view in :
+  #   "app/views/surveillance/field/customer/<partial_path>"
+  #
+  # config.partials.register "Partial Name", "partial_path"
+
+  # Register a callback to be called when an attempt has already be registered
+  # for an anonymous user.
+  # The callback will be executed in the context of the controller, allowing you
+  # to use controller methods
+  # Setting it to nil will keep the default behaviour of adding a flash[:error]
+  # message and redirecting to the surveys list
+  #
+  # Default : nil
+  #
+  # config.attempt_already_registered_callback = ->(attempt) {
+  #   flash[:error] = "You already completed this survey"
+  #   redirect_to(root_path)
+  # }
+
+  # Surveys root path used when redirecting from a survey
+  # Executed in the context of the controller / view where it is called
+  # Note that the controller is inside the Surveillance Engine, you need
+  # to call the root on the `main_app` object if you need to redirect to
+  # your app
+  #
+  # Default : nil
+  #
+  # config.surveys_root_path = -> { main_app.root_path }
+end

data/lib/surveillance.rb

@@ -0,0 +1,61 @@
+require "decent_exposure"
+require "haml-rails"
+require "jquery-rails"
+require "simple_form"
+require "spreadsheet_on_rails"
+require 'aasm'
+
+require "surveillance/engine"
+
+module Surveillance
+  extend ActiveSupport::Autoload
+
+  autoload :Field, "surveillance/field"
+  autoload :PartialsCollection, "surveillance/partials_collection"
+  autoload :SettingsCollection, "surveillance/settings_collection"
+  autoload :Setting, "surveillance/setting"
+  autoload :Validators, "surveillance/validators"
+
+  # Defines an autorization method to be called before actions in admin
+  # controllers to authenticate admin users
+  #
+  mattr_accessor :admin_authorization_method
+  @@admin_authorization_method = nil
+
+  mattr_accessor :admin_base_controller
+  @@admin_base_controller = 'Surveillance::ApplicationController'
+
+  mattr_accessor :views_layout
+  @@views_layout = nil
+
+  mattr_accessor :partials
+  @@partials = Surveillance::PartialsCollection.new
+
+  mattr_accessor :attempt_already_registered_callback
+  @@attempt_already_registered_callback = nil
+
+  mattr_accessor :surveys_root_path
+  @@surveys_root_path = nil
+
+  class << self
+    def table_name_prefix
+      'surveillance_'
+    end
+
+    def options_for ary, key
+      ary.map do |item|
+        str = item.to_s
+        [I18n.t("surveillance.#{ key }.#{ str }"), str]
+      end
+    end
+
+    def config &block
+      yield self
+    end
+
+    def unique_token
+      (Time.now.to_f * (100 ** 10)).to_i.to_s(36) +
+        (rand * 10 ** 10).to_i.to_s(36)
+    end
+  end
+end

data/lib/surveillance/branch_action.rb

@@ -0,0 +1,5 @@
+module Surveillance
+  module BranchAction
+    ACTIONS = %w(goto_section finalize_survey)
+  end
+end

data/lib/surveillance/branch_condition.rb

@@ -0,0 +1,5 @@
+module Surveillance
+  module BranchCondition
+    CONDITIONS = %w(answers doesnt_answer answers_option doesnt_answer_option)
+  end
+end

data/lib/surveillance/engine.rb

@@ -0,0 +1,13 @@
+module Surveillance
+  class Engine < ::Rails::Engine
+    isolate_namespace Surveillance
+
+    config.to_prepare do
+      path = Rails.root.join('lib', 'decorators', 'surveillance', '**', '*.rb')
+
+      Dir[path].each do |file|
+        load file
+      end
+    end
+  end
+end

data/lib/surveillance/field.rb

@@ -0,0 +1,58 @@
+module Surveillance
+  module Field
+    extend ActiveSupport::Autoload
+    extend ActiveSupport::Concern
+
+    autoload :Base, "surveillance/field/base"
+    autoload :Text, "surveillance/field/text"
+    autoload :TextArea, "surveillance/field/text_area"
+    autoload :Number, "surveillance/field/number"
+    autoload :Date, "surveillance/field/date"
+    autoload :SingleChoice, "surveillance/field/single_choice"
+    autoload :MultipleChoices, "surveillance/field/multiple_choices"
+    autoload :SingleSelect, "surveillance/field/single_select"
+    autoload :Matrix, "surveillance/field/matrix"
+    autoload :MultipleChoicesMatrix, "surveillance/field/multiple_choices_matrix"
+    autoload :SelectMatrix, "surveillance/field/select_matrix"
+    autoload :MatrixChoice, "surveillance/field/matrix_choice"
+    autoload :MatrixQuestion, "surveillance/field/matrix_question"
+    autoload :Order, "surveillance/field/order"
+    autoload :OrderQuestion, "surveillance/field/order_question"
+
+    autoload :OtherChoice, "surveillance/field/other_choice"
+
+    mattr_accessor :available_field_types
+    @@available_field_types = %w(
+      text text_area number date single_choice multiple_choices single_select
+      matrix multiple_choices_matrix select_matrix order
+    )
+
+    def field(options = {})
+      attempt = options.fetch(:attempt, nil)
+      answer = options.fetch(:answer, nil)
+      rebuild = options.fetch(:rebuild, false)
+
+      return @field if !rebuild && @field
+      @field = (field_class).new(self, attempt: attempt, answer: answer)
+    end
+
+    def field_class
+      Field.const_get(field_type.camelize)
+    end
+
+    def self.field_types_enum
+      Surveillance.options_for(@@available_field_types, "field_types")
+    end
+
+    included do
+      validates_presence_of :field_type
+
+      after_initialize do
+        self.field_type ||= "text"
+      end
+
+      before_validation :before_validation_callback
+      delegate :before_validation_callback, to: :field
+    end
+  end
+end

data/lib/surveillance/field/base.rb

@@ -0,0 +1,149 @@
+module Surveillance
+  module Field
+    class Base
+      include ActionView::Helpers::FormOptionsHelper
+
+      attr_accessor :question
+      attr_writer :answer, :attempt
+
+      def initialize question, options = {}
+        self.question = question
+        self.attempt = options.fetch(:attempt, nil)
+        self.answer = options.fetch(:answer, nil)
+      end
+
+      def attempt
+        @attempt || (@answer && @answer.attempt)
+      end
+
+      def answer
+        @answer ||= attempt && attempt.answer_to(question)
+      end
+
+      def answer_or_initialize
+        answer || Surveillance::Answer.new
+      end
+
+      def answer_or_initialize_for attempt
+        self.attempt = attempt
+        answer = answer_or_initialize
+        answer.question = question
+        answer
+      end
+
+      def choosable?
+        false
+      end
+
+      def mandatory_content?
+        false
+      end
+
+      def matrix?
+        false
+      end
+
+      def has_sub_questions?
+        false
+      end
+
+      def view_name
+        "question"
+      end
+
+      def setting_value key
+        setting = question.settings.find { |s| s.key == key.to_s }
+        setting && setting.value
+      end
+
+      def settings
+        @settings ||= self.class.settings.freeze
+      end
+
+      def settings?
+        settings.length > 0
+      end
+
+      def answer_string
+        answer.content ? answer.content.value : ""
+      end
+
+      # Defines following partial view path methods :
+      %w(show settings overview export).each do |view|
+        define_method(:"#{ view }_path") do
+          "#{ self.class.name.underscore }/#{ view }"
+        end
+      end
+
+      def form_path
+        if question.partial.presence
+          "surveillance/field/custom/#{ question.partial }"
+        else
+          "#{ self.class.name.underscore }/form"
+        end
+
+      end
+
+      def rules_form_path
+        "surveillance/field/shared/rules_form"
+      end
+
+      def validate_answer answer
+        self.answer = answer
+
+        if question.mandatory && empty?
+          answer.errors[:present] << I18n.t("errors.messages.empty")
+        end
+      end
+
+      def empty?
+        !present?
+      end
+
+      def present?
+        raise NoMethodError, "Each field type must override present? to " +
+          "implement custom presence logic. " +
+          "Raised from #{ self.class.name }"
+      end
+
+      def available_branch_conditions
+        conditions = %w(answers doesnt_answer)
+        conditions += %w(answers_option doesnt_answer_option) if choosable?
+        conditions
+      end
+
+      def available_branch_actions
+        %w(goto_section finalize_survey)
+      end
+
+      def options_list
+        @options_list ||= question.options.each_with_index.map do |option, index|
+          ["#{ index } - #{ option.title }", option.id]
+        end
+      end
+
+      # Override this method to define custom before_validation callbacks to
+      # be executed on the referer question model
+      #
+      def before_validation_callback
+      end
+
+      class << self
+        attr_writer :settings
+
+        def setting key, options = {}
+          settings[key] = Surveillance::Setting.new(self, options.merge(key: key))
+        end
+
+        def settings
+          @settings ||= Surveillance::SettingsCollection.new
+        end
+
+        def inherited subclass
+          # Ensure settings are inherited
+          subclass.settings.reverse_merge! settings
+        end
+      end
+    end
+  end
+end