effective_polls 0.0.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b49f5df5989ddd470b3090d2ac28ab5974e902bd33f8a57e05487025074cf0a8
-  data.tar.gz: f3465afeb7bee7279348f24f7e85128d136cac9d47add5f3c67f8a1ee740062f
+  metadata.gz: aebcfa6f3efd89aa11a576d324f53b5d1438b94c8f71d2253c307898f600abef
+  data.tar.gz: c93f89535c8d5938d1025cf106f0a914b395e8b45c6992d48a02b9dd4a4465af
 SHA512:
-  metadata.gz: 5ea3cf981517d7d8081feae614b054114f156826b5a694410d48f3418b7cf9df2db606c290d3f89a9ca1018ff4a8c64550528b9071436d7c7c02c863217467d1
-  data.tar.gz: 76898e90f2e456e3ccbc4b24e022ce785b1375ff0afbc91cab27b31319c4bf40dab731900d77bced3788d9acb1cdceaec4b9d6483c984c0e8e0d4a20549f598c
+  metadata.gz: 787542d8c6ef91a83f68eded3aaf00455b36342e5e54a0572869d3d31588d307d2e2c0c96520560b77487227925b41927404b8622bf891bb422c89ca187c6ed7
+  data.tar.gz: 48a308bcaa45d2a478f918c5fa714aa870581a6ec572a5f08489550ce30740272ac1386668e0c3500b4567e789bc987790f46504a666700cc668ae7053e65059

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2020 Code and Effect Inc.
+Copyright 2021 Code and Effect Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,21 +2,24 @@
 
 Online polls and user voting.
 
-An admin creates polls with one or more poll_questions. The poll can be assigned to users through a poll_ballot.
+An admin creates polls with one or more poll_questions. The poll can be assigned to all users, individual users or selected users (a scope) and those users complete a 4-step wizard to submit a poll.
 
-The user can complete the poll_ballot and anonymously vote for each option.
+All results are anonymized such that the user cannot be identified from the results.
 
-Some reports to display results.
+Works with action_text for content bodies, and active_storage for file uploads.
 
 ## Getting Started
 
+This requires Rails 6+ and Twitter Bootstrap 4 and just works with Devise.
+
 Please first install the [effective_datatables](https://github.com/code-and-effect/effective_datatables) gem.
 
-Please download and install [Twitter Bootstrap4](http://getbootstrap.com)
+Please download and install the [Twitter Bootstrap4](http://getbootstrap.com)
 
 Add to your Gemfile:
 
 ```ruby
+gem 'haml-rails' # or try using gem 'hamlit-rails'
 gem 'effective_polls'
 ```
 
@@ -34,7 +37,7 @@ rails generate effective_polls:install
 
 The generator will install an initializer which describes all configuration options and creates a database migration.
 
-If you want to tweak the table name (to use something other than the default 'polls'), manually adjust both the configuration file and the migration now.
+If you want to tweak the table names, manually adjust both the configuration file and the migration now.
 
 Then migrate the database:
 
@@ -42,9 +45,50 @@ Then migrate the database:
 rake db:migrate
 ```
 
-## Polls
+Render the "available polls for current_user" datatable on your user dashboard:
+
+```haml
+%h2 Polls
+%p You may submit a ballot for the following polls.
+= render_datatable(EffectivePollsDatatable.new, simple: true)
+```
+
+Add a link to the admin menu:
+
+```haml
+- if can? :admin, :effective_polls
+  = link_to 'Polls', effective_polls.admin_polls_path
+```
+
+Set up your permissions:
+
+```ruby
+# Regular signed up user. Guest users not supported.
+if user.persisted?
+  can [:show, :update], Effective::Ballot, user_id: user.id
+  can :show, Effective::Poll
+  can :index, EffectivePollsDatatable
+end
+
+if user.admin?
+  can :admin, :effective_polls
 
-TODO
+  can :manage, Effective::Poll
+  can :manage, Effective::PollNotification
+  can :manage, Effective::PollQuestion
+  can :index, Admin::EffectivePollResultsDatatable
+end
+```
+
+And, if you want to use poll notifications, schedule the rake task to run every 10 minutes, or faster:
+
+```rake
+rake effective_polls:notify
+```
+
+## Usage
+
+You can render the results with `render('effective/poll_results/results', poll: poll)`.
 
 ## Authorization
 
@@ -97,19 +141,6 @@ rescue_from Effective::AccessDenied do |exception|
 end
 ```
 
-### Permissions
-
-The permissions you actually want to define are as follows (using CanCan):
-
-```ruby
-can [:index, :show], Effective::Poll
-
-if user.admin?
-  can :manage, Effective::Poll
-  can :admin, :effective_polls
-end
-```
-
 ## License
 
 MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)

data/app/controllers/admin/poll_notifications_controller.rb

@@ -1,6 +1,6 @@
 module Admin
   class PollNotificationsController < ApplicationController
-    layout (EffectivePolls.layout.kind_of?(Hash) ? EffectivePolls.layout[:admin] : EffectivePolls.layout)
+    layout EffectivePolls.layout[:admin]
 
     before_action(:authenticate_user!) if defined?(Devise)
     before_action { EffectivePolls.authorize!(self, :admin, :effective_polls) }

data/app/controllers/admin/poll_questions_controller.rb

@@ -1,6 +1,6 @@
 module Admin
   class PollQuestionsController < ApplicationController
-    layout (EffectivePolls.layout.kind_of?(Hash) ? EffectivePolls.layout[:admin] : EffectivePolls.layout)
+    layout EffectivePolls.layout[:admin]
 
     before_action(:authenticate_user!) if defined?(Devise)
     before_action { EffectivePolls.authorize!(self, :admin, :effective_polls) }

data/app/controllers/admin/polls_controller.rb

@@ -1,6 +1,6 @@
 module Admin
   class PollsController < ApplicationController
-    layout (EffectivePolls.layout.kind_of?(Hash) ? EffectivePolls.layout[:admin] : EffectivePolls.layout)
+    layout EffectivePolls.layout[:admin]
 
     before_action(:authenticate_user!) if defined?(Devise)
     before_action { EffectivePolls.authorize!(self, :admin, :effective_polls) }

data/app/controllers/effective/ballots_controller.rb

@@ -1,6 +1,6 @@
 module Effective
   class BallotsController < ApplicationController
-    layout (EffectivePolls.layout.kind_of?(Hash) ? EffectivePolls.layout[:polls] : EffectivePolls.layout)
+    layout EffectivePolls.layout[:polls]
 
     before_action(:authenticate_user!) if defined?(Devise)
     include Effective::WizardController

data/app/datatables/admin/effective_polls_datatable.rb

@@ -1,15 +1,15 @@
 class Admin::EffectivePollsDatatable < Effective::Datatable
   filters do
+    scope :all
     scope :upcoming
     scope :available
     scope :completed
-    scope :all
   end
 
   datatable do
     order :start_at, :desc
 
-    col :id, visible: false
+    col :token, visible: false
     col :created_at, visible: false
     col :updated_at, visible: false
 

data/app/mailers/effective/polls_mailer.rb

@@ -1,22 +1,70 @@
 module Effective
-  class PollsMailer < ActionMailer::Base
-    default from: EffectivePolls.mailer[:default_from]
+  class PollsMailer < EffectivePolls.mailer_class
     layout EffectivePolls.mailer[:layout].presence || 'effective_polls_mailer_layout'
 
-    def poll_upcoming_reminder(poll_notification, bcc)
-      mail(bcc: bcc, body: poll_notification.body, subject: poll_notification.subject)
+    def poll_upcoming_reminder(poll_notification, user)
+      @assigns = effective_email_templates_assigns(poll_notification, user)
+
+      mail(
+        to: user.email,
+        from: poll_notification.from,
+        body: poll_notification.body,
+        subject: poll_notification.subject
+      )
     end
 
-    def poll_start(poll_notification, bcc)
-      mail(bcc: bcc, body: poll_notification.body, subject: poll_notification.subject)
+    def poll_when_poll_starts(poll_notification, user)
+      @assigns = effective_email_templates_assigns(poll_notification, user)
+
+      mail(
+        to: user.email,
+        from: poll_notification.from,
+        body: poll_notification.body,
+        subject: poll_notification.subject
+      )
     end
 
-    def poll_reminder(poll_notification, bcc)
-      mail(bcc: bcc, body: poll_notification.body, subject: poll_notification.subject)
+    def poll_reminder(poll_notification, user)
+      @assigns = effective_email_templates_assigns(poll_notification, user)
+
+      mail(
+        to: user.email,
+        from: poll_notification.from,
+        body: poll_notification.body,
+        subject: poll_notification.subject
+      )
     end
 
-    def poll_end(poll_notification, bcc)
-      mail(bcc: bcc, body: poll_notification.body, subject: poll_notification.subject)
+    def poll_when_poll_ends(poll_notification, user)
+      @assigns = effective_email_templates_assigns(poll_notification, user)
+
+      mail(
+        to: user.email,
+        from: poll_notification.from,
+        body: poll_notification.body,
+        subject: poll_notification.subject
+      )
+    end
+
+    private
+
+    # Only relevant if the effective_email_templates gem is present
+    def effective_email_templates_assigns(poll_notification, user)
+      raise('expected an Effective::PollNotification') unless poll_notification.kind_of?(Effective::PollNotification)
+      raise('expected a User') unless user.kind_of?(User)
+
+      poll = poll_notification.poll
+      raise('expected poll to be persisted') unless poll&.persisted?
+
+      {
+        available_date: poll.available_date,
+        title: poll.title,
+        url: effective_polls.new_poll_ballot_url(poll),
+        user: {
+          name: user.to_s,
+          email: user.email
+        }
+      }
     end
 
   end

data/app/models/effective/ballot_response.rb

@@ -48,19 +48,19 @@ module Effective
     validates :poll_question_option_ids, if: -> { poll_question&.choose_one? },
       length: { maximum: 1, message: 'please choose 1 option only' }
 
-    validates :poll_question_option_ids, if: -> { poll_question&.select_upto_1? },
+    validates :poll_question_option_ids, if: -> { poll_question&.select_up_to_1? },
       length: { maximum: 1, message: 'please select 1 option or fewer' }
 
-    validates :poll_question_option_ids, if: -> { poll_question&.select_upto_2? },
+    validates :poll_question_option_ids, if: -> { poll_question&.select_up_to_2? },
       length: { maximum: 2, message: 'please select 2 options or fewer' }
 
-    validates :poll_question_option_ids, if: -> { poll_question&.select_upto_3? },
+    validates :poll_question_option_ids, if: -> { poll_question&.select_up_to_3? },
       length: { maximum: 3, message: 'please select 3 options or fewer' }
 
-    validates :poll_question_option_ids, if: -> { poll_question&.select_upto_4? },
+    validates :poll_question_option_ids, if: -> { poll_question&.select_up_to_4? },
       length: { maximum: 4, message: 'please select 4 options or fewer' }
 
-    validates :poll_question_option_ids, if: -> { poll_question&.select_upto_5? },
+    validates :poll_question_option_ids, if: -> { poll_question&.select_up_to_5? },
       length: { maximum: 5, message: 'please select 5 options or fewer' }
 
     def to_s
@@ -78,7 +78,7 @@ module Effective
       return upload_file if poll_question.upload_file?
 
       return poll_question_options.first if poll_question.choose_one?
-      return poll_question_options.first if poll_question.select_upto_1?
+      return poll_question_options.first if poll_question.select_up_to_1?
       return poll_question_options if poll_question.poll_question_option?
 
       raise('unknown response for unexpected poll question category')

data/app/models/effective/poll.rb

@@ -1,7 +1,5 @@
 module Effective
   class Poll < ActiveRecord::Base
-    attr_accessor :skip_started_validation
-
     has_rich_text :all_steps_content
     has_rich_text :start_content
     has_rich_text :vote_content
@@ -23,6 +21,10 @@ module Effective
 
     acts_as_tokened
 
+    if respond_to?(:log_changes)
+      log_changes(except: [:ballots, :ballot_responses, :completed_ballots, :completed_ballot_responses])
+    end
+
     AUDIENCES = ['All Users', 'Individual Users', 'Selected Users']
 
     effective_resource do
@@ -57,7 +59,6 @@ module Effective
     }
 
     scope :sorted, -> { order(:start_at) }
-    scope :editable, -> { upcoming }
 
     scope :upcoming, -> { where('start_at > ?', Time.zone.now) }
     scope :available, -> { where('start_at <= ? AND (end_at > ? OR end_at IS NULL)', Time.zone.now, Time.zone.now) }
@@ -69,14 +70,6 @@ module Effective
     validates :audience, inclusion: { in: AUDIENCES }
     validates :audience_scope, presence: true, unless: -> { audience == 'All Users' }
 
-    validate(if: -> { started? }, unless: -> { skip_started_validation }) do
-      self.errors.add(:base, 'has already started. a poll cannot be changed after it has started.')
-    end
-
-    validate(if: -> { start_at.present? && !started? }, unless: -> { skip_started_validation }) do
-      self.errors.add(:start_at, 'must be a future date') if start_at < Time.zone.now
-    end
-
     validate(if: -> { start_at.present? && end_at.present? }) do
       self.errors.add(:end_at, 'must be after the start date') unless end_at > start_at
     end
@@ -90,8 +83,8 @@ module Effective
       available? && users.include?(user)
     end
 
-    def users
-      case audience
+    def users(except_completed: false)
+      users = case audience
       when 'All Users'
         User.all
       when 'Individual Users'
@@ -103,13 +96,11 @@ module Effective
       else
         raise('unexpected audience')
       end
-    end
 
-    def emails(exclude_completed: false)
-      if exclude_completed
-        users.where.not(id: completed_ballots.select('user_id as id')).pluck(:email)
+      if except_completed
+        users.where.not(id: completed_ballots.select('user_id as id'))
       else
-        users.pluck(:email)
+        users
       end
     end
 

data/app/models/effective/poll_notification.rb

@@ -1,9 +1,10 @@
 module Effective
   class PollNotification < ActiveRecord::Base
     belongs_to :poll
+    log_changes(to: :poll) if respond_to?(:log_changes)
 
-    BATCHSIZE = (Rails.env.test? ? 3 : 250)
     CATEGORIES = ['Upcoming reminder', 'When poll starts', 'Reminder', 'When poll ends']
+    EMAIL_TEMPLATE_VARIABLES = ['available_date', 'title', 'url', 'user.name', 'user.email']
 
     UPCOMING_REMINDERS = {
       '1 hour before' => 1.hours.to_i,
@@ -44,6 +45,7 @@ module Effective
       reminder          :integer  # Number of seconds before poll.start_at
 
       # Email
+      from              :string
       subject           :string
       body              :text
 
@@ -65,9 +67,16 @@ module Effective
 
     validates :poll, presence: true
     validates :category, presence: true, inclusion: { in: CATEGORIES }
+
+    validates :from, presence: true
     validates :subject, presence: true
     validates :body, presence: true
 
+    if EffectivePolls.use_effective_email_templates
+      validates :body, liquid: true
+      validates :subject, liquid: true
+    end
+
     validates :reminder, if: -> { reminder? || upcoming_reminder? },
       presence: true, uniqueness: { scope: [:poll_id, :category], message: 'already exists' }
 
@@ -75,6 +84,10 @@ module Effective
       'poll notification'
     end
 
+    def email_template
+      'poll_' + category.to_s.parameterize.underscore
+    end
+
     def upcoming_reminder?
       category == 'Upcoming reminder'
     end
@@ -115,26 +128,13 @@ module Effective
     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'))
+      # We send to all users, except for the 'Reminder' that exclude completed users
+      users = poll.users(except_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
+      users.find_each do |user|
+        Effective::PollsMailer.public_send(email_template, self, user).deliver_now
       end
 
       update_column(:completed_at, Time.zone.now)

data/app/models/effective/poll_question.rb

@@ -6,15 +6,16 @@ module Effective
     accepts_nested_attributes_for :poll_question_options, reject_if: :all_blank, allow_destroy: true
 
     has_rich_text :body
+    log_changes(to: :poll) if respond_to?(:log_changes)
 
     CATEGORIES = [
       'Choose one',   # Radios
       'Select all that apply', # Checks
-      'Select upto 1',
-      'Select upto 2',
-      'Select upto 3',
-      'Select upto 4',
-      'Select upto 5',
+      'Select up to 1',
+      'Select up to 2',
+      'Select up to 3',
+      'Select up to 4',
+      'Select up to 5',
       'Date',         # Date Field
       'Email',        # Email Field
       'Number',       # Numeric Field
@@ -26,11 +27,11 @@ module Effective
     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'
+      'Select up to 1',
+      'Select up to 2',
+      'Select up to 3',
+      'Select up to 4',
+      'Select up to 5'
     ]
 
     effective_resource do

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

@@ -2,54 +2,41 @@
   - if inline_datatable?
     = f.hidden_field :poll_id
   - else
-    = f.select :poll_id, Effective::Poll.sorted.editable.all
+    = f.select :poll_id, Effective::Poll.sorted.all
 
   = f.select :category, Effective::PollNotification::CATEGORIES,
     label: 'Send an email notification'
 
-  = f.show_if :category, 'Upcoming reminder' do
+  - # Render email templates
+  - Effective::PollNotification::CATEGORIES.each do |category|
+    - template = 'poll_' + category.parameterize.underscore
 
-    = f.select :reminder, Effective::PollNotification::UPCOMING_REMINDERS, label: false,
-      hint: "before the poll starts on #{f.object.poll&.start_at&.strftime('%F')}."
+    = f.show_if :category, category do
+      = render "/admin/poll_notifications/form_#{template}", f: 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.
+      - if f.object.category == category
+        = f.email_field :from
+        = f.text_field :subject
+        = f.text_area :body, rows: 10
 
-  = 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.
+      - elsif EffectivePolls.use_effective_email_templates == false
+        = f.email_field :from, value: EffectivePolls.mailer[:default_from]
+        = f.text_field :subject, value: ''
+        = f.text_area :body, rows: 10, value: ''
 
-  = f.show_if :category, 'Reminder' do
+      - else
+        - email_template = Effective::EmailTemplate.where(template_name: template).first!
 
-    = f.select :reminder, Effective::PollNotification::REMINDERS, label: false,
-      hint: "after the poll starts on #{f.object.poll&.start_at&.strftime('%F')}."
+        = f.email_field :from, value: email_template.from
+        = f.text_field :subject, value: email_template.subject
+        = f.text_area :body, rows: 10, value: email_template.body
 
-    .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.
+        %p The available variables are:
 
-  = 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.
+        %ul
+          - Effective::PollNotification::EMAIL_TEMPLATE_VARIABLES.each do |variable|
+            %li {{ #{variable} }}
 
-  = 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)
+        %small.text-muted Only a developer can add additional variables
 
   = effective_submit(f)

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

@@ -0,0 +1,8 @@
+= 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.

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

@@ -0,0 +1,8 @@
+= 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.

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

@@ -0,0 +1,3 @@
+.alert.alert-warning
+  %strong When poll ends
+  notifications will be sent within 10 minutes of the poll end time.

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

@@ -0,0 +1,3 @@
+.alert.alert-warning
+  %strong When poll starts
+  notifications will be sent within 10 minutes of the poll start time.

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

@@ -22,35 +22,35 @@
         %h5 Select all that apply
         %p Display checkboxes to select all options that apply
 
-  = f.show_if :category, 'Select upto 1' do
+  = f.show_if :category, 'Select up to 1' do
     .card
       .card-body
-        %h5 Select upto 1 (one)
-        %p Display checkboxes to select upto 1 option
+        %h5 Select up to 1 (one)
+        %p Display checkboxes to select up to 1 option
 
-  = f.show_if :category, 'Select upto 2' do
+  = f.show_if :category, 'Select up to 2' do
     .card
       .card-body
-        %h5 Select upto 2 (two)
-        %p Display checkboxes to select upto 2 options
+        %h5 Select up to 2 (two)
+        %p Display checkboxes to select up to 2 options
 
-  = f.show_if :category, 'Select upto 3' do
+  = f.show_if :category, 'Select up to 3' do
     .card
       .card-body
-        %h5 Select upto 3 (three)
-        %p Display checkboxes to select upto 3 options
+        %h5 Select up to 3 (three)
+        %p Display checkboxes to select up to 3 options
 
-  = f.show_if :category, 'Select upto 4' do
+  = f.show_if :category, 'Select up to 4' do
     .card
       .card-body
-        %h5 Select upto 4 (four)
-        %p Display checkboxes to select upto 4 options
+        %h5 Select up to 4 (four)
+        %p Display checkboxes to select up to 4 options
 
-  = f.show_if :category, 'Select upto 5' do
+  = f.show_if :category, 'Select up to 5' do
     .card
       .card-body
-        %h5 Select upto 5 (five)
-        %p Display checkboxes to select upto 5 options
+        %h5 Select up to 5 (five)
+        %p Display checkboxes to select up to 5 options
 
   = f.show_if :category, 'Short Answer' do
     .card

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

@@ -12,9 +12,13 @@
 
     = tab 'Notifications' do
       %p
-        The following email notification will be sent to all
+        The following email notifications will be sent to
         = pluralize(poll.users.count, 'users')
         in the audience.
 
       - datatable = Admin::EffectivePollNotificationsDatatable.new(poll_id: poll.id)
       = render_datatable(datatable, inline: true, simple: true)
+
+    - if poll.respond_to?(:log_changes_datatable)
+      = tab 'Logs' do
+        = render_datatable(poll.log_changes_datatable)

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

@@ -1,7 +1,7 @@
 = effective_form_with(model: [:admin, poll], engine: true) do |f|
-  = f.text_field :title, hint: 'The title of your poll.'
+  = f.text_field :title, hint: 'The title of your poll or election.'
 
-  = f.datetime_field :start_at, input_js: { minDate: [f.object.start_at.presence, Time.zone.now].compact.min.strftime('%F') }
+  = f.datetime_field :start_at, input_js: { minDate: Time.zone.now.beginning_of_day.strftime('%F') }
   = f.datetime_field :end_at
 
   -# Audience

data/app/views/effective/ballot_responses/fields/_date.html.haml

@@ -1 +1,2 @@
-= f.date_field :date, label: false, required: poll_question.required?
+.row
+  .col-sm-6= f.date_field :date, label: false, required: poll_question.required?

data/app/views/effective/ballot_responses/fields/_email.html.haml

@@ -1 +1,2 @@
-= f.email_field :email, label: false, required: poll_question.required?
+.row
+  .col-sm-6= f.email_field :email, label: false, required: poll_question.required?

data/app/views/effective/ballot_responses/fields/_number.html.haml

@@ -1 +1,2 @@
-= f.number_field :number, label: false, required: poll_question.required?
+.row
+  .col-sm-6= f.number_field :number, label: false, required: poll_question.required?

data/app/views/effective/ballots/_ballot.html.haml

@@ -2,8 +2,8 @@
   %table.table.table-hover
     %thead
       %tr
-        %th Poll Question
-        %th Ballot Response
+        %th Question
+        %th Response
 
     %tbody
       - ballot.poll.poll_questions.each_with_index do |poll_question, index|

data/app/views/effective/ballots/start.html.haml

@@ -1,5 +1,5 @@
 = render_wizard_sidebar(resource) do
-  %h1 Poll: #{resource.poll}
+  %h1= resource.poll
 
   .alert.alert-warning
     This is a <strong>Secret Ballot</strong>.

data/app/views/effective/ballots/submit.html.haml

@@ -1,5 +1,5 @@
 = render_wizard_sidebar(resource) do
-  %h1 Review: #{resource.poll}
+  %h1= resource.poll
 
   - if resource.poll.all_steps_content.present?
     .mb-2= resource.poll.all_steps_content

data/app/views/effective/ballots/vote.html.haml

@@ -1,5 +1,5 @@
 = render_wizard_sidebar(resource) do
-  %h1 Ballot: #{resource.poll}
+  %h1= resource.poll
 
   - if resource.poll.all_steps_content.present?
     .mb-2= resource.poll.all_steps_content

data/app/views/effective/poll_results/_results.html.haml

@@ -20,7 +20,7 @@
       %table.table.table-hover
         %thead
           %tr
-            %th Poll Question
+            %th Question
             %th Results
 
         %tbody

data/app/views/effective/polls_mailer/poll_reminder.liquid

@@ -0,0 +1,13 @@
+---
+subject: 'Reminder - Please submit your ballot for {{ title }}'
+from: 'admin@example.com'
+---
+Hello {{ user.name }},
+
+The {{ title }} poll has already started.
+
+Please remember to submit your ballot.
+
+{{ url }}
+
+Thank you

data/app/views/effective/polls_mailer/poll_upcoming_reminder.liquid

@@ -0,0 +1,11 @@
+---
+subject: '{{ title }} is upcoming'
+from: 'admin@example.com'
+---
+Hello {{ user.name }},
+
+The {{ title }} poll is upcoming.
+
+It will be available {{ available_date }}.
+
+Thank you

data/app/views/effective/polls_mailer/poll_when_poll_ends.liquid

@@ -0,0 +1,9 @@
+---
+subject: '{{ title }} has ended'
+from: 'admin@example.com'
+---
+Hello {{ user.name }},
+
+The {{ title }} poll has ended.
+
+Thank you

data/app/views/effective/polls_mailer/poll_when_poll_starts.liquid

@@ -0,0 +1,13 @@
+---
+subject: '{{ title }} has started'
+from: 'admin@example.com'
+---
+Hello {{ user.name }},
+
+The {{ title }} poll has started.
+
+Please click below to submit your ballot.
+
+{{ url }}
+
+Thank you

data/config/effective_polls.rb

@@ -53,7 +53,12 @@ EffectivePolls.setup do |config|
   #
   config.mailer = {
     layout: 'effective_polls_mailer_layout',
-    default_from: 'info@example.com'
+    default_from: 'no-reply@example.com'
   }
 
+  # Will work with effective_email_templates gem:
+  # - The poll notifications email content will be preopulated based off the template
+  # - Uses a EmailTemplatesMailer mailer instead of ActionMailer::Base
+  config.use_effective_email_templates = false
+
 end

data/db/migrate/01_create_effective_polls.rb.erb

@@ -20,6 +20,7 @@ class CreateEffectivePolls < ActiveRecord::Migration[6.0]
       t.string :category
       t.integer :reminder
 
+      t.string :from
       t.string :subject
       t.text :body
 

data/lib/effective_polls.rb

@@ -13,13 +13,13 @@ module EffectivePolls
   mattr_accessor :ballot_response_options_table_name
 
   mattr_accessor :authorization_method
-  mattr_accessor :permitted_params
 
   mattr_accessor :layout
 
   mattr_accessor :audience_user_scopes
 
   # Hashes of configs
+  mattr_accessor :use_effective_email_templates
   mattr_accessor :mailer
 
   def self.setup
@@ -43,8 +43,13 @@ module EffectivePolls
     raise Effective::AccessDenied.new('Access Denied', action, resource) unless authorized?(controller, action, resource)
   end
 
-  def self.permitted_params
-    raise('todo')
+  def self.mailer_class
+    if use_effective_email_templates
+      require 'effective_email_templates'
+      Effective::EmailTemplatesMailer
+    else
+      ActionMailer::Base
+    end
   end
 
 end

data/lib/effective_polls/version.rb

@@ -1,3 +1,3 @@
 module EffectivePolls
-  VERSION = '0.0.1'
+  VERSION = '0.1.3'
 end

data/lib/generators/effective_polls/install_generator.rb

@@ -26,7 +26,7 @@ module EffectivePolls
         @poll_question_options_table_name = ':' + EffectivePolls.poll_question_options_table_name.to_s
         @ballots_table_name = ':' + EffectivePolls.ballots_table_name.to_s
         @ballot_responses_table_name  = ':' + EffectivePolls.ballot_responses_table_name.to_s
-        @ballot_response_options_table_name  = ':' + EffectivePolls.ballot_responses_table_name.to_s
+        @ballot_response_options_table_name  = ':' + EffectivePolls.ballot_response_options_table_name.to_s
 
         migration_template ('../' * 3) + 'db/migrate/01_create_effective_polls.rb.erb', 'db/migrate/create_effective_polls.rb'
       end

data/lib/generators/templates/effective_polls_mailer_preview.rb

@@ -2,29 +2,38 @@
 
 class EffectivePollsMailerPreview < ActionMailer::Preview
 
-  def poll_upcoming_reminder(poll_notification, bcc)
-    mail(bcc: bcc, body: poll_notification.body, subject: poll_notification.subject)
+  def poll_upcoming_reminder
+    poll_notification = build_poll_notification('The poll will start soon')
+    Effective::PollsMailer.poll_upcoming_reminder(poll_notification, build_user)
   end
 
   def poll_start
     poll_notification = build_poll_notification('The poll has started')
-    Effective::PollsMailer.poll_start(poll_notification, bccs)
+    Effective::PollsMailer.poll_start(poll_notification, build_user)
   end
 
   def poll_reminder
-    poll_notification = build_poll_notification('This is a reminder')
-    Effective::PollsMailer.poll_reminder(poll_notification, bccs)
+    poll_notification = build_poll_notification('The poll started already and you have not participated')
+    Effective::PollsMailer.poll_reminder(poll_notification, build_user)
   end
 
   def poll_end
     poll_notification = build_poll_notification('The poll has ended')
-    Effective::PollsMailer.poll_end(poll_notification, bccs)
+    Effective::PollsMailer.poll_end(poll_notification, build_user)
   end
 
   protected
 
-  def bccs
-    ['one@example.com', 'two@example.com', 'three@example.com', 'two-hundred-fifty@example.com']
+  def build_user
+    User.new(email: 'buyer@website.com').tap do |user|
+      user.name = 'Valued Customer' if user.respond_to?(:name=)
+      user.full_name = 'Valued Customer' if user.respond_to?(:full_name=)
+
+      if user.respond_to?(:first_name=) && user.respond_to?(:last_name=)
+        user.first_name = 'Valued'
+        user.last_name = 'Customer'
+      end
+    end
   end
 
   def build_poll_notification(text)

data/lib/tasks/effective_polls_tasks.rake

@@ -5,17 +5,16 @@ namespace :effective_polls do
   task notify: :environment do
     poll_notifications = Effective::PollNotification.all.deep.notifiable
 
-    poll_notifications.find_each do |poll_notification|
+    poll_notifications.find_each do |notification|
       begin
-        notified = poll_notification.notify!
-        puts "Sent #{poll_notification.category} for #{poll_notification.poll}" if notified
+        notified = notification.notify!
+        puts "Sent #{notification.category} for #{notification.poll}" if notified
       rescue => e
         if defined?(ExceptionNotifier)
-          data = { poll_notification_id: poll_notification.id, poll_id: poll_notification.poll_id }
-          ExceptionNotifier.notify_exception(e, data: data)
+          ExceptionNotifier.notify_exception(e, data: { poll_notification_id: notification.id, poll_id: notification.poll_id })
         end
 
-        puts "Error with effective poll_notification #{poll_notification.id}: #{e.errors.inspect}"
+        puts "Error with effective poll_notification #{notification.id}: #{e.errors.inspect}"
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_polls
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,76 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: devise
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: haml-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: wicked
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Online polls and user voting.
 email:
 - info@codeandeffect.com
@@ -183,11 +113,14 @@ files:
 - app/models/effective/poll_question.rb
 - app/models/effective/poll_question_option.rb
 - app/views/admin/poll_notifications/_form.html.haml
+- app/views/admin/poll_notifications/_form_poll_reminder.html.haml
+- app/views/admin/poll_notifications/_form_poll_upcoming_reminder.html.haml
+- app/views/admin/poll_notifications/_form_poll_when_poll_ends.html.haml
+- app/views/admin/poll_notifications/_form_poll_when_poll_starts.html.haml
 - app/views/admin/poll_questions/_form.html.haml
 - app/views/admin/polls/_form.html.haml
 - app/views/admin/polls/_form_content.html.haml
 - app/views/admin/polls/_form_poll.html.haml
-- app/views/admin/polls/_poll.html.haml
 - app/views/admin/polls/results.html.haml
 - app/views/effective/ballot_responses/_ballot_response.html.haml
 - app/views/effective/ballot_responses/_fields.html.haml
@@ -197,11 +130,11 @@ files:
 - app/views/effective/ballot_responses/fields/_long_answer.html.haml
 - app/views/effective/ballot_responses/fields/_number.html.haml
 - app/views/effective/ballot_responses/fields/_select_all_that_apply.html.haml
-- app/views/effective/ballot_responses/fields/_select_upto_1.html.haml
-- app/views/effective/ballot_responses/fields/_select_upto_2.html.haml
-- app/views/effective/ballot_responses/fields/_select_upto_3.html.haml
-- app/views/effective/ballot_responses/fields/_select_upto_4.html.haml
-- app/views/effective/ballot_responses/fields/_select_upto_5.html.haml
+- app/views/effective/ballot_responses/fields/_select_up_to_1.html.haml
+- app/views/effective/ballot_responses/fields/_select_up_to_2.html.haml
+- app/views/effective/ballot_responses/fields/_select_up_to_3.html.haml
+- app/views/effective/ballot_responses/fields/_select_up_to_4.html.haml
+- app/views/effective/ballot_responses/fields/_select_up_to_5.html.haml
 - app/views/effective/ballot_responses/fields/_short_answer.html.haml
 - app/views/effective/ballot_responses/fields/_upload_file.html.haml
 - app/views/effective/ballot_responses/responses/_choose_one.html.haml
@@ -210,11 +143,11 @@ files:
 - app/views/effective/ballot_responses/responses/_long_answer.html.haml
 - app/views/effective/ballot_responses/responses/_number.html.haml
 - app/views/effective/ballot_responses/responses/_select_all_that_apply.html.haml
-- app/views/effective/ballot_responses/responses/_select_upto_1.html.haml
-- app/views/effective/ballot_responses/responses/_select_upto_2.html.haml
-- app/views/effective/ballot_responses/responses/_select_upto_3.html.haml
-- app/views/effective/ballot_responses/responses/_select_upto_4.html.haml
-- app/views/effective/ballot_responses/responses/_select_upto_5.html.haml
+- app/views/effective/ballot_responses/responses/_select_up_to_1.html.haml
+- app/views/effective/ballot_responses/responses/_select_up_to_2.html.haml
+- app/views/effective/ballot_responses/responses/_select_up_to_3.html.haml
+- app/views/effective/ballot_responses/responses/_select_up_to_4.html.haml
+- app/views/effective/ballot_responses/responses/_select_up_to_5.html.haml
 - app/views/effective/ballot_responses/responses/_short_answer.html.haml
 - app/views/effective/ballot_responses/responses/_upload_file.html.haml
 - app/views/effective/ballots/_ballot.html.haml
@@ -231,15 +164,17 @@ files:
 - app/views/effective/poll_results/results/_number.html.haml
 - app/views/effective/poll_results/results/_poll_question_option.html.haml
 - app/views/effective/poll_results/results/_select_all_that_apply.html.haml
-- app/views/effective/poll_results/results/_select_upto_1.html.haml
-- app/views/effective/poll_results/results/_select_upto_2.html.haml
-- app/views/effective/poll_results/results/_select_upto_3.html.haml
-- app/views/effective/poll_results/results/_select_upto_4.html.haml
-- app/views/effective/poll_results/results/_select_upto_5.html.haml
+- app/views/effective/poll_results/results/_select_up_to_1.html.haml
+- app/views/effective/poll_results/results/_select_up_to_2.html.haml
+- app/views/effective/poll_results/results/_select_up_to_3.html.haml
+- app/views/effective/poll_results/results/_select_up_to_4.html.haml
+- app/views/effective/poll_results/results/_select_up_to_5.html.haml
 - app/views/effective/poll_results/results/_short_answer.html.haml
 - app/views/effective/poll_results/results/_upload_file.html.haml
-- app/views/effective/polls/_form.html.haml
-- app/views/effective/polls/_poll.html.haml
+- app/views/effective/polls_mailer/poll_reminder.liquid
+- app/views/effective/polls_mailer/poll_upcoming_reminder.liquid
+- app/views/effective/polls_mailer/poll_when_poll_ends.liquid
+- app/views/effective/polls_mailer/poll_when_poll_starts.liquid
 - app/views/layouts/effective_polls_mailer_layout.html.haml
 - config/effective_polls.rb
 - config/routes.rb

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

@@ -1,2 +0,0 @@
-%p= poll.title
-%p= poll.body

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

@@ -1,10 +0,0 @@
-= effective_form_with(model: poll, engine: true) do |f|
-  = f.text_field :title, hint: 'The title of your poll.'
-  = f.text_area :body
-
-  = f.datetime_field :start_at
-  = f.datetime_field :end_at
-
-  = f.check_box :draft, hint: 'Save this poll as a draft. It will not be accessible on the website.'
-
-  = effective_submit(f)

data/app/views/effective/polls/_poll.html.haml

@@ -1,2 +0,0 @@
-%p= poll.title
-%p= poll.body