effective_polls 0.0.1

data/app/models/effective/poll_notification.rb

@@ -0,0 +1,144 @@
+module Effective
+  class PollNotification < ActiveRecord::Base
+    belongs_to :poll
+
+    BATCHSIZE = (Rails.env.test? ? 3 : 250)
+    CATEGORIES = ['Upcoming reminder', 'When poll starts', 'Reminder', 'When poll ends']
+
+    UPCOMING_REMINDERS = {
+      '1 hour before' => 1.hours.to_i,
+      '3 hours before' => 3.hours.to_i,
+      '6 hours before' => 6.hours.to_i,
+      '12 hours before' => 12.hours.to_i,
+      '1 day before' => 1.days.to_i,
+      '2 days before' => 2.days.to_i,
+      '3 days before' => 3.days.to_i,
+      '4 days before' => 4.days.to_i,
+      '5 days before' => 5.days.to_i,
+      '6 days before' => 6.days.to_i,
+      '1 week before' => 1.weeks.to_i,
+      '2 weeks before' => 2.weeks.to_i,
+      '3 weeks before' => 3.weeks.to_i,
+      '1 month before' => 1.month.to_i
+    }
+
+    REMINDERS = {
+      '1 hour after' => 1.hours.to_i,
+      '3 hours after' => 3.hours.to_i,
+      '6 hours after' => 6.hours.to_i,
+      '12 hours after' => 12.hours.to_i,
+      '1 day after' => 1.days.to_i,
+      '2 days after' => 2.days.to_i,
+      '3 days after' => 3.days.to_i,
+      '4 days after' => 4.days.to_i,
+      '5 days after' => 5.days.to_i,
+      '6 days after' => 6.days.to_i,
+      '1 week after' => 1.weeks.to_i,
+      '2 weeks after' => 2.weeks.to_i,
+      '3 weeks after' => 3.weeks.to_i,
+      '1 month after' => 1.month.to_i
+    }
+
+    effective_resource do
+      category          :string
+      reminder          :integer  # Number of seconds before poll.start_at
+
+      # Email
+      subject           :string
+      body              :text
+
+      # Tracking background jobs email send out
+      started_at        :datetime
+      completed_at      :datetime
+
+      timestamps
+    end
+
+    scope :sorted, -> { order(:id) }
+    scope :deep, -> { includes(:poll) }
+
+    scope :started, -> { where.not(started_at: nil) }
+    scope :completed, -> { where.not(completed_at: nil) }
+
+    # Called by the poll_notifier rake task
+    scope :notifiable, -> { where(started_at: nil, completed_at: nil) }
+
+    validates :poll, presence: true
+    validates :category, presence: true, inclusion: { in: CATEGORIES }
+    validates :subject, presence: true
+    validates :body, presence: true
+
+    validates :reminder, if: -> { reminder? || upcoming_reminder? },
+      presence: true, uniqueness: { scope: [:poll_id, :category], message: 'already exists' }
+
+    def to_s
+      'poll notification'
+    end
+
+    def upcoming_reminder?
+      category == 'Upcoming reminder'
+    end
+
+    def poll_start?
+      category == 'When poll starts'
+    end
+
+    def reminder?
+      category == 'Reminder'
+    end
+
+    def poll_end?
+      category == 'When poll ends'
+    end
+
+    def notifiable?
+      started_at.blank? && completed_at.blank?
+    end
+
+    def notify_now?
+      return false unless notifiable?
+
+      case category
+      when 'When poll starts'
+        poll.available?
+      when 'When poll ends'
+        poll.ended?
+      when 'Upcoming reminder'
+        !poll.started? && poll.start_at < (Time.zone.now + reminder)
+      when 'Reminder'
+        !poll.ended? && poll.start_at < (Time.zone.now - reminder)
+      else
+        raise('unexpected category')
+      end
+    end
+
+    def notify!
+      return false unless notify_now?
+
+      # We send to all email addresses, except for the 'Reminder' that exclude completed users
+      emails = poll.emails(exclude_completed: (category == 'Reminder'))
+
+      update_column(:started_at, Time.zone.now)
+
+      emails.in_groups_of(BATCHSIZE, false).each do |emails|
+        mail = case category
+        when 'When poll starts'
+          Effective::PollsMailer.poll_start(self, emails)
+        when 'When poll ends'
+          Effective::PollsMailer.poll_end(self, emails)
+        when 'Upcoming reminder'
+          Effective::PollsMailer.poll_upcoming_reminder(self, emails)
+        when 'Reminder'
+          Effective::PollsMailer.poll_reminder(self, emails)
+        else
+          raise('unexpected category')
+        end
+
+        mail.deliver_now
+      end
+
+      update_column(:completed_at, Time.zone.now)
+    end
+
+  end
+end

data/app/models/effective/poll_question.rb

@@ -0,0 +1,76 @@
+module Effective
+  class PollQuestion < ActiveRecord::Base
+    belongs_to :poll
+
+    has_many :poll_question_options, -> { order(:position) }, inverse_of: :poll_question, dependent: :delete_all
+    accepts_nested_attributes_for :poll_question_options, reject_if: :all_blank, allow_destroy: true
+
+    has_rich_text :body
+
+    CATEGORIES = [
+      'Choose one',   # Radios
+      'Select all that apply', # Checks
+      'Select upto 1',
+      'Select upto 2',
+      'Select upto 3',
+      'Select upto 4',
+      'Select upto 5',
+      'Date',         # Date Field
+      'Email',        # Email Field
+      'Number',       # Numeric Field
+      'Long Answer',  # Text Area
+      'Short Answer', # Text Field
+      'Upload File'   # File field
+    ]
+
+    WITH_OPTIONS_CATEGORIES = [
+      'Choose one',   # Radios
+      'Select all that apply', # Checks
+      'Select upto 1',
+      'Select upto 2',
+      'Select upto 3',
+      'Select upto 4',
+      'Select upto 5'
+    ]
+
+    effective_resource do
+      title         :string
+      category      :string
+      required      :boolean
+
+      position      :integer
+
+      timestamps
+    end
+
+    before_validation(if: -> { poll.present? }) do
+      self.position ||= (poll.poll_questions.map { |obj| obj.position }.compact.max || -1) + 1
+    end
+
+    scope :deep, -> { with_rich_text_body_and_embeds.includes(:poll_question_options) }
+    scope :sorted, -> { order(:position) }
+
+    validates :title, presence: true
+    validates :category, presence: true, inclusion: { in: CATEGORIES }
+    validates :position, presence: true
+    validates :poll_question_options, presence: true, if: -> { poll_question_option? }
+
+    # Create choose_one? and select_all_that_apply? methods for each category
+    CATEGORIES.each do |category|
+      define_method(category.parameterize.underscore + '?') { self.category == category }
+    end
+
+    def to_s
+      title.presence || 'New Poll Question'
+    end
+
+    def poll_question_option?
+      WITH_OPTIONS_CATEGORIES.include?(category)
+    end
+
+    def category_partial
+      category.to_s.parameterize.underscore
+    end
+
+  end
+end

data/app/models/effective/poll_question_option.rb

@@ -0,0 +1,26 @@
+module Effective
+  class PollQuestionOption < ActiveRecord::Base
+    belongs_to :poll_question
+
+    effective_resource do
+      title         :text
+      position      :integer
+
+      timestamps
+    end
+
+    before_validation(if: -> { poll_question.present? }) do
+      self.position ||= (poll_question.poll_question_options.map { |obj| obj.position }.compact.max || -1) + 1
+    end
+
+    scope :sorted, -> { order(:position) }
+
+    validates :title, presence: true
+    validates :position, presence: true
+
+    def to_s
+      title.presence || 'New Poll Question Option'
+    end
+
+  end
+end

data/app/views/admin/poll_notifications/_form.html.haml

@@ -0,0 +1,55 @@
+= effective_form_with(model: [:admin, poll_notification], engine: true) do |f|
+  - if inline_datatable?
+    = f.hidden_field :poll_id
+  - else
+    = f.select :poll_id, Effective::Poll.sorted.editable.all
+
+  = f.select :category, Effective::PollNotification::CATEGORIES,
+    label: 'Send an email notification'
+
+  = f.show_if :category, 'Upcoming reminder' do
+
+    = f.select :reminder, Effective::PollNotification::UPCOMING_REMINDERS, label: false,
+      hint: "before the poll starts on #{f.object.poll&.start_at&.strftime('%F')}."
+
+    .alert.alert-warning
+      %strong Upcoming Reminders
+      are sent to the entire audience before the poll starts.
+      %br
+      Use upcoming reminders to advertise, prepare, or communicate to your audience before the poll begins.
+
+  = f.show_if :category, 'When poll starts' do
+    .alert.alert-warning
+      %strong When poll starts
+      notifications will be sent within 10 minutes of the poll start time.
+
+  = f.show_if :category, 'Reminder' do
+
+    = f.select :reminder, Effective::PollNotification::REMINDERS, label: false,
+      hint: "after the poll starts on #{f.object.poll&.start_at&.strftime('%F')}."
+
+    .alert.alert-warning
+      %strong Reminders
+      are sent to users in the audience who have not yet completed their ballot.
+      %br
+      Use reminders to boost your audience participation and remind people to vote.
+
+  = f.show_if :category, 'When poll ends' do
+    .alert.alert-warning
+      %strong When poll ends
+      notifications will be sent within 10 minutes of the poll end time.
+
+  = f.text_field :subject, label: 'Email Subject'
+  = f.text_area :body, label: 'Email Body'
+
+  .alert.alert-warning
+    Email content must not contain any personal details.
+    %br
+    This content will be sent in a mass email with hundreds of bcc'd recipients.
+
+    - if poll_notification.poll.present?
+      %br
+      The url for this poll will be:
+      = effective_polls.poll_url(poll_notification.poll)
+
+  = effective_submit(f)

data/app/views/admin/poll_questions/_form.html.haml

@@ -0,0 +1,100 @@
+= effective_form_with(model: [:admin, poll_question], engine: true) do |f|
+  - if inline_datatable?
+    = f.hidden_field :poll_id
+  - else
+    = f.select :poll_id, Effective::Poll.sorted.editable.all
+
+  = f.text_field :title, label: 'Question Title'
+  = f.rich_text_area :body, label: 'Body (optional)'
+
+  = f.check_box :required, hint: 'A response to this question will be required'
+  = f.select :category, Effective::PollQuestion::CATEGORIES
+
+  = f.show_if :category, 'Choose one' do
+    .card
+      .card-body
+        %h5 Choose one
+        %p Display radio buttons to choose one option
+
+  = f.show_if :category, 'Select all that apply' do
+    .card
+      .card-body
+        %h5 Select all that apply
+        %p Display checkboxes to select all options that apply
+
+  = f.show_if :category, 'Select upto 1' do
+    .card
+      .card-body
+        %h5 Select upto 1 (one)
+        %p Display checkboxes to select upto 1 option
+
+  = f.show_if :category, 'Select upto 2' do
+    .card
+      .card-body
+        %h5 Select upto 2 (two)
+        %p Display checkboxes to select upto 2 options
+
+  = f.show_if :category, 'Select upto 3' do
+    .card
+      .card-body
+        %h5 Select upto 3 (three)
+        %p Display checkboxes to select upto 3 options
+
+  = f.show_if :category, 'Select upto 4' do
+    .card
+      .card-body
+        %h5 Select upto 4 (four)
+        %p Display checkboxes to select upto 4 options
+
+  = f.show_if :category, 'Select upto 5' do
+    .card
+      .card-body
+        %h5 Select upto 5 (five)
+        %p Display checkboxes to select upto 5 options
+
+  = f.show_if :category, 'Short Answer' do
+    .card
+      .card-body
+        %h5 Short Answer
+        %p Display a text field to enter a short text answer
+
+  = f.show_if :category, 'Long Answer' do
+    .card
+      .card-body
+        %h5 Long Answer
+        %p Display a textarea to enter a long text answer
+
+  = f.show_if :category, 'Date' do
+    .card
+      .card-body
+        %h5 Date
+        %p Display a date field to enter a date
+
+  = f.show_if :category, 'Email' do
+    .card
+      .card-body
+        %h5 Email
+        %p Display an email field to enter an email
+
+  = f.show_if :category, 'Number' do
+    .card
+      .card-body
+        %h5 Number
+        %p Display a number field to enter an integer number
+
+  = f.show_if :category, 'Upload File' do
+    .card
+      .card-body
+        %h5 Upload File
+        %p Display a file field to upload a file
+
+  = f.show_if_any :category, Effective::PollQuestion::WITH_OPTIONS_CATEGORIES do
+    .mt-3.card
+      .card-body
+        %h5 Options
+        %p Display the following options:
+
+        = f.has_many :poll_question_options, class: 'tight' do |fa|
+          = fa.text_field :title, label: false
+
+  = effective_submit(f)

data/app/views/admin/polls/_form.html.haml

@@ -0,0 +1,20 @@
+= tabs do
+  = tab 'Poll' do
+    = render 'admin/polls/form_poll', poll: poll
+
+  - if poll.persisted?
+    = tab 'Content' do
+      = render 'admin/polls/form_content', poll: poll
+
+    = tab 'Questions' do
+      - datatable = Admin::EffectivePollQuestionsDatatable.new(poll_id: poll.id)
+      = render_datatable(datatable, inline: true, simple: true)
+
+    = tab 'Notifications' do
+      %p
+        The following email notification will be sent to all
+        = pluralize(poll.users.count, 'users')
+        in the audience.
+
+      - datatable = Admin::EffectivePollNotificationsDatatable.new(poll_id: poll.id)
+      = render_datatable(datatable, inline: true, simple: true)

data/app/views/admin/polls/_form_content.html.haml

@@ -0,0 +1,27 @@
+= effective_form_with(model: [:admin, poll], engine: true) do |f|
+  .card.mb-4
+    .card-body
+      %h5.card-title All Steps Content
+      = f.rich_text_area :all_steps_content, label: false, hint: 'displayed on all ballot steps'
+
+  .card.mb-4
+    .card-body
+      %h5.card-title Start Step
+      = f.rich_text_area :start_content, label: false, hint: 'displayed on the start step only'
+
+  .card.mb-4
+    .card-body
+      %h5.card-title Vote Step
+      = f.rich_text_area :vote_content, label: false, hint: 'displayed on the vote step only'
+
+  .card.mb-4
+    .card-body
+      %h5.card-title Review and Submit Step
+      = f.rich_text_area :submit_content, label: false, hint: 'displayed on the review and submit step only'
+
+  .card.mb-4
+    .card-body
+      %h5.card-title Complete Step
+      = f.rich_text_area :complete_content, label: false, hint: 'displayed on the complete step only'
+
+  = f.submit