effective_polls 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57df19aaa933dd133ba655525265e129ca1c2bd7a60a78a5a8f2fe89ec1aa5cc
-  data.tar.gz: 86fe4a6defeef051e4ff9c8543480fd6db703e213d80cf100781f4c71cc60e4b
+  metadata.gz: 637320f25a72489ada773806629e70590bb5c8435e871a6de40497e2eb6300ed
+  data.tar.gz: e797d1afdad6be66099b291ec7a809cbb65ef32d7963ca04f03d3ac3d91fe2a9
 SHA512:
-  metadata.gz: 1b6f6ace193a55d55b49184f8a2b9a1a0766b0e1249c5c3daa65bfac034a7bb7b8ae1920b66ed04d1605137a88798d749951f0f714e2289774f63dfc5d820ca4
-  data.tar.gz: e0b94cefd83a9af17f232cedc37369615ed0042543b886a496174fd807a3117cab3a876bcb6eb34d61f2ca50a70ede2c2c92d965df67d4b0619dc9a3fd05f052
+  metadata.gz: 7317013d4063bdd11eaf4a72b6d5ca964c7acb2c35ac29653e9c7043c4e4c40de4e1b4b55079ed023b758f08982a51ca17926e37c5abafbca2462cf0b4a9e657
+  data.tar.gz: d3fe9a3b04a9ca98c5a27fa956fb82d536db6b9662b6d61a0e8fd954f603673384f6d70c3ec33e51fabde548063b126892508e858be72e616d2c9ff30318e732

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2021 Code and Effect Inc.
+Copyright 2023 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

@@ -10,7 +10,7 @@ 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.
+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.
 
@@ -19,7 +19,7 @@ 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 'haml'
 gem 'effective_polls'
 ```
 

data/Rakefile

@@ -1,27 +1,13 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'EffectivePolls'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require "bundler/setup"
 
 APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load 'rails/tasks/engine.rake'
+load "rails/tasks/engine.rake"
 
-load 'rails/tasks/statistics.rake'
+load "rails/tasks/statistics.rake"
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'

data/app/controllers/admin/polls_controller.rb

@@ -5,13 +5,7 @@ module Admin
 
     include Effective::CrudController
 
-    def results
-      @poll = Effective::Poll.find(params[:id])
-      EffectiveResources.authorize!(self, :results, @poll)
-
-      @datatable = Admin::EffectivePollResultsDatatable.new(poll_token: @poll.token)
-      @page_title = "#{@poll} Results"
-    end
+    on :save, only: :create, redirect: :edit
 
     def permitted_params
       params.require(:effective_poll).permit!

data/app/controllers/effective/ballots_controller.rb

@@ -1,6 +1,9 @@
 module Effective
   class BallotsController < ApplicationController
-    before_action(:authenticate_user!) if defined?(Devise)
+
+    if defined?(Devise)
+      before_action :authenticate_user!, unless: -> { action_name == 'new' || (action_name == 'show' && params[:id] == 'start') }
+    end
 
     include Effective::WizardController
 

data/app/datatables/admin/effective_poll_notifications_datatable.rb

@@ -31,7 +31,10 @@ class Admin::EffectivePollNotificationsDatatable < Effective::Datatable
     end
 
     col :subject
-    col :body
+
+    col :body do |notification|
+      simple_format(notification.body.to_s)
+    end
 
     col :started_at, visible: false
     col :completed_at

data/app/datatables/admin/effective_poll_results_datatable.rb

@@ -41,10 +41,7 @@ class Admin::EffectivePollResultsDatatable < Effective::Datatable
   end
 
   def poll
-    @poll ||= begin
-      raise('expected datatable poll_token attribute') unless attributes[:poll_token]
-      Effective::Poll.deep_results.find(attributes[:poll_token])
-    end
+    @poll ||= Effective::Poll.deep_results.where(id: attributes[:poll_id]).first!
   end
 
 end

data/app/datatables/admin/effective_polls_datatable.rb

@@ -18,6 +18,7 @@ class Admin::EffectivePollsDatatable < Effective::Datatable
     col :end_at
     col :audience
 
+    col :poll_notifications
     col :poll_questions, visible: false
 
     actions_col

data/app/datatables/{effective_polls_datatable.rb → effective_polls_available_polls_datatable.rb}

@@ -1,13 +1,14 @@
+# Dashboard available polls
 # Displays available polls that the current_user may complete
 
-class EffectivePollsDatatable < Effective::Datatable
+class EffectivePollsAvailablePollsDatatable < Effective::Datatable
   datatable do
     order :start_at
 
     col :start_at, visible: false
 
     col :title
-    col :available_date, label: 'Date'
+    col :available_date
 
     actions_col(actions: []) do |poll|
       ballot = poll.ballots.where(user: current_user).first
@@ -15,16 +16,17 @@ class EffectivePollsDatatable < Effective::Datatable
       if ballot.blank?
         dropdown_link_to('Start', effective_polls.poll_ballot_build_path(poll, :new, :start))
       elsif ballot.completed?
+        #dropdown_link_to('Show', effective_polls.poll_ballot_path(poll, ballot))
         'Complete'
       else
         dropdown_link_to('Continue', effective_polls.poll_ballot_build_path(poll, ballot, ballot.next_step))
+        dropdown_link_to('Delete', effective_polls.poll_ballot_path(poll, ballot), 'data-confirm': "Really delete #{ballot}?", 'data-method': :delete)
       end
     end
   end
 
   collection do
-    raise('expected a current_user') unless current_user.present?
-    Effective::Poll.available.select { |poll| poll.available_for?(current_user) }
+    Effective::Poll.where(id: current_user.available_polls)
   end
 
 end

data/app/helpers/effective_polls_helper.rb

@@ -1,22 +1,26 @@
 module EffectivePollsHelper
 
+  # Used on dashboard
+  def polls_name_label
+    et('effective_polls.name')
+  end
+
   # Used by admin/polls form
-  def effective_polls_audience_scope_collection
-    # Normalize the collection into [[label, value], [label, value]]
-    scopes = Array(EffectivePolls.audience_user_scopes).map do |key, value|
-      (key.present? && value.present?) ? [key, value] : [key.to_s.titleize, key]
-    end
+  def effective_polls_audience_scope_collection(poll)
+    klass = poll.try(:audience_class)
+    raise('expected a poll with an audience_class') unless klass.try(:effective_polls_user?)
 
-    # Makes sure the User model responds to all values
-    scopes.each do |_, scope|
-      unless defined?(User) && User.respond_to?(scope)
-        raise("invalid effective_polls config.audience_user_scopes value. The user model must respond to the scope User.#{scope}")
-      end
-    end
+    resource = klass.new
+
+    scopes = resource.poll_audience_scopes
+    raise('expected poll audience scopes') unless scopes.kind_of?(Array)
 
     # Append the number of users in this scope
-    scopes.map! do |label, scope|
-      ["#{label} (#{pluralize(User.send(scope).count, 'user')})", scope]
+    scopes.map do |label, scope|
+      relation = resource.poll_audience_scope(scope)
+      raise("invalid poll_audience_scope for #{scope}") unless relation.kind_of?(ActiveRecord::Relation)
+
+      ["#{label} (#{pluralize(relation.count, 'user')})", scope]
     end
   end
 

data/app/mailers/effective/polls_mailer.rb

@@ -75,7 +75,9 @@ module Effective
         title: poll.title,
         url: effective_polls.poll_url(poll),
         user: {
-          name: user.to_s,
+          name: (user.try(:email_to_s) || user.to_s),
+          first_name: user.try(:first_name).to_s,
+          last_name: user.try(:last_name).to_s,
           email: user.email
         }
       }

data/app/models/concerns/effective_polls_user.rb

@@ -0,0 +1,67 @@
+# EffectivePollsUser
+#
+# Mark your user model with effective_polls_user to get all the includes
+
+module EffectivePollsUser
+  extend ActiveSupport::Concern
+
+  module Base
+    def effective_polls_user
+      include ::EffectivePollsUser
+    end
+  end
+
+  module ClassMethods
+    def effective_polls_user?; true; end
+  end
+
+  included do
+    has_many :ballots, -> { Effective::Ballot.sorted }, inverse_of: :user, as: :user, class_name: 'Effective::Ballot'
+  end
+
+  # The list of all available audience scopes for the Poll Selected Users
+  def poll_audience_scopes
+    scopes = [
+      ['All Users', :all]
+    ]
+
+    if self.class.try(:effective_memberships_user?)
+      scopes += [
+        ['All members', :members],
+        ['All removed members', :membership_removed],
+        ['All members in good standing', :membership_in_good_standing],
+        ['All members not in good standing', :membership_not_in_good_standing],
+        ['All members renewed this period', :membership_renewed_this_period],
+      ] 
+
+      scopes += EffectiveMemberships.Category.sorted.map do |category|
+        ["All #{category} members", "members_with_category_id_#{category.id}"]
+      end
+    end
+
+    scopes
+  end
+
+  # Turns the given audience_scope value into the actual ActiveRecord::Relation scope
+  def poll_audience_scope(value)
+    collection = self.class.respond_to?(:unarchived) ? self.class.unarchived : self.class
+
+    # If we respond to the fill value, call it
+    return collection.send(value) if collection.respond_to?(value)
+
+    # Parse the value
+    name, id = value.to_s.split('_id_')
+
+    case name.try(:to_sym)
+    when :members_with_category
+      collection.members_with_category(EffectiveMemberships.Category.find(id))
+    else
+      raise("unknown poll_audience_scope for #{value}")
+    end
+  end
+
+  def available_polls
+    Effective::Poll.available.select { |poll| poll.available_for?(self) }
+  end
+
+end

data/app/models/effective/ballot.rb

@@ -3,14 +3,19 @@ module Effective
     attr_accessor :current_user
     attr_accessor :current_step
 
+    # Application namespace
+    belongs_to :user, polymorphic: true
+
+    # Effective namespace
     belongs_to :poll
-    belongs_to :user
 
     has_many :ballot_responses, dependent: :destroy
     accepts_nested_attributes_for :ballot_responses
 
     acts_as_tokened
 
+    log_changes(to: :poll) if respond_to?(:log_changes)
+
     acts_as_wizard(
       start: 'Start',
       vote: 'Ballot',
@@ -34,6 +39,10 @@ module Effective
 
     scope :deep, -> { includes(:poll, :user, ballot_responses: [:poll, :poll_question, :poll_question_options]) }
     scope :sorted, -> { order(:id) }
+
+    scope :in_progress, -> { where(completed_at: nil) }
+    scope :done, -> { where.not(completed_at: nil) }
+
     scope :completed, -> { where.not(completed_at: nil) }
 
     before_validation(if: -> { new_record? }) do
@@ -48,7 +57,7 @@ module Effective
     validates :ballot_responses, associated: true
 
     def to_s
-      'ballot'
+      model_name.human
     end
 
     # Find or build

data/app/models/effective/ballot_response.rb

@@ -64,7 +64,7 @@ module Effective
       length: { maximum: 5, message: 'please select 5 options or fewer' }
 
     def to_s
-      'ballot reponse'
+      model_name.human
     end
 
     def response

data/app/models/effective/poll.rb

@@ -1,10 +1,6 @@
 module Effective
   class Poll < ActiveRecord::Base
-    has_rich_text :all_steps_content
-    has_rich_text :start_content
-    has_rich_text :vote_content
-    has_rich_text :submit_content
-    has_rich_text :complete_content
+    acts_as_tokened
 
     has_many :poll_notifications, -> { order(:id) }, inverse_of: :poll, dependent: :destroy
     accepts_nested_attributes_for :poll_notifications, allow_destroy: true
@@ -19,7 +15,12 @@ module Effective
     has_many :completed_ballots, -> { Effective::Ballot.completed }, class_name: 'Effective::Ballot'
     has_many :completed_ballot_responses, -> { where(ballot: Effective::Ballot.completed) }, class_name: 'Effective::BallotResponse'
 
-    acts_as_tokened
+    has_many_rich_texts
+    # rich_text_all_steps_content
+    # rich_text_start_content
+    # rich_text_vote_content
+    # rich_text_submit_content
+    # rich_text_complete_content
 
     if respond_to?(:log_changes)
       log_changes(except: [:ballots, :ballot_responses, :completed_ballots, :completed_ballot_responses])
@@ -29,29 +30,23 @@ module Effective
 
     effective_resource do
       # Acts as tokened
-      token                  :string, permitted: false
+      token         :string, permitted: false
 
       title         :string
 
       start_at      :datetime
       end_at        :datetime
 
-      audience            :string
-      audience_scope      :text       # An Array of user_ids or named scopes on the User model
+      audience              :string
+      audience_class_name   :string
+      audience_scope        :text       # An Array of user_ids or named scopes on the User model
 
       timestamps
     end
 
     serialize :audience_scope, Array
 
-    scope :deep, -> {
-      includes(poll_questions: :poll_question_options)
-      .with_rich_text_all_steps_content
-      .with_rich_text_start_content
-      .with_rich_text_vote_content
-      .with_rich_text_submit_content
-      .with_rich_text_complete_content
-    }
+    scope :deep, -> { includes(poll_questions: :poll_question_options) }
 
     scope :deep_results, -> {
       includes(poll_questions: :poll_question_options)
@@ -68,6 +63,8 @@ module Effective
     validates :start_at, presence: true
 
     validates :audience, inclusion: { in: AUDIENCES }
+    validates :audience_class_name, presence: true
+
     validates :audience_scope, presence: true, unless: -> { audience == 'All Users' }
 
     validate(if: -> { start_at.present? && end_at.present? }) do
@@ -75,33 +72,49 @@ module Effective
     end
 
     def to_s
-      title.presence || 'New Poll'
+      title.presence || model_name.human
     end
 
     def available_for?(user)
-      raise('expected a user') unless user.kind_of?(User)
+      raise('expected an effective_polls_user') unless user.class.try(:effective_polls_user?)
       available? && users.include?(user)
     end
 
+    def audience_class
+      klass = audience_class_name.safe_constantize
+      raise('expected an effective_polls_user klass') unless klass.try(:effective_polls_user?)
+      klass
+    end
+
     def users(except_completed: false)
+      klass = audience_class()
+      resource = klass.new
+
       users = case audience
       when 'All Users'
-        User.all
+        klass.try(:unarchived) || klass.all
       when 'Individual Users'
-        User.where(id: audience_scope)
+        (klass.try(:unarchived) || klass.all).where(id: audience_scope)
       when 'Selected Users'
-        collection = User.none
-        audience_scope.each { |scope| collection = collection.or(User.send(scope)) }
+        collection = klass.none
+
+        audience_scope.each do |scope| 
+          relation = resource.poll_audience_scope(scope)
+          raise("invalid poll_audience_scope for #{scope}") unless relation.kind_of?(ActiveRecord::Relation)
+
+          collection = collection.or(relation)
+        end
+
         collection
       else
         raise('unexpected audience')
       end
 
       if except_completed
-        users.where.not(id: completed_ballots.select('user_id as id'))
-      else
-        users
+        users = users.where.not(id: completed_ballots.select('user_id as id'))
       end
+
+      users
     end
 
     def available?

data/app/models/effective/poll_notification.rb

@@ -72,7 +72,7 @@ module Effective
     validates :subject, presence: true
     validates :body, presence: true
 
-    if EffectivePolls.use_effective_email_templates
+    with_options(if: -> { EffectivePolls.use_effective_email_templates }) do
       validates :body, liquid: true
       validates :subject, liquid: true
     end
@@ -81,7 +81,7 @@ module Effective
       presence: true, uniqueness: { scope: [:poll_id, :category], message: 'already exists' }
 
     def to_s
-      'poll notification'
+      [category.presence, subject.presence].compact.join(' - ') || model_name.human
     end
 
     def email_template

data/app/models/effective/poll_question.rb

@@ -62,7 +62,7 @@ module Effective
     end
 
     def to_s
-      title.presence || 'New Poll Question'
+      title.presence || model_name.human
     end
 
     def poll_question_option?

data/app/models/effective/poll_question_option.rb

@@ -19,7 +19,7 @@ module Effective
     validates :position, presence: true
 
     def to_s
-      title.presence || 'New Poll Question Option'
+      title.presence || model_name.human
     end
 
   end

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

@@ -12,22 +12,20 @@
     - template = 'poll_' + category.parameterize.underscore
 
     = f.show_if :category, category do
-      = render "/admin/poll_notifications/form_#{template}", f: f
+      .my-3= render "/admin/poll_notifications/form_#{template}", f: f
+      
+      = f.select :from, EffectivePolls.mailer_froms
 
       - if f.object.category == category
-        = f.email_field :from
         = f.text_field :subject
         = f.text_area :body, rows: 10
 
       - 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: ''
 
       - else
         - email_template = Effective::EmailTemplate.where(template_name: template).first!
-
-        = 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
 

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

@@ -2,19 +2,26 @@
   - if inline_datatable?
     = f.hidden_field :poll_id
   - else
-    = f.select :poll_id, Effective::Poll.sorted.editable.all
+    = f.select :poll_id, Effective::Poll.all
 
   = f.text_field :title, label: 'Question Title'
-  = f.rich_text_area :body, label: 'Body (optional)'
+
+  - if defined?(EffectiveArticleEditor)
+    = f.article_editor :body, label: 'Body (optional)'
+  - else
+    = 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
+    .mt-3.card
       .card-body
-        %h5 Choose one
-        %p Display radio buttons to choose one option
+        %h5 Options
+        %p Display the following options:
+
+        = f.has_many :poll_question_options, build: true do |fa|
+          = fa.text_field :title, label: false
 
   = f.show_if :category, 'Select all that apply' do
     .card

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

@@ -7,18 +7,23 @@
       = render 'admin/polls/form_content', poll: poll
 
     = tab 'Questions' do
-      - datatable = Admin::EffectivePollQuestionsDatatable.new(poll_id: poll.id)
+      - datatable = Admin::EffectivePollQuestionsDatatable.new(poll: poll)
       = render_datatable(datatable, inline: true, simple: true)
 
     = tab 'Notifications' do
       %p
         The following email notifications will be sent to
-        = pluralize(poll.users.count, 'users')
+        = pluralize(poll.users.count, 'user')
         in the audience.
 
-      - datatable = Admin::EffectivePollNotificationsDatatable.new(poll_id: poll.id)
+      %p 
+        The url for this #{et(poll)} is:
+        - url = effective_polls.poll_url(poll)
+        = link_to(url, url, target: '_blank')
+
+      - datatable = Admin::EffectivePollNotificationsDatatable.new(poll: poll)
       = render_datatable(datatable, inline: true, simple: true)
 
-    - if poll.respond_to?(:log_changes_datatable)
+    - if poll.respond_to?(:logs_datatable)
       = tab 'Logs' do
-        = render_datatable(poll.log_changes_datatable)
+        = render_datatable(poll.logs_datatable)

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

@@ -1,27 +1,23 @@
+%p Each of the following content areas will be displayed on the ballot wizard.
+
 = 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("All Steps") do
+    - if defined?(EffectiveArticleEditor)
+      = f.article_editor "rich_text_all_steps_content", label: false, hint: "displayed on all steps"
+    - else
+      = f.rich_text_area "rich_text_all_steps_content", label: false, hint: "displayed on all 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'
+  %hr
 
-  .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'
+  - enabled = Effective::Ballot.all_wizard_steps
 
-  .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'
+  - Effective::Ballot::WIZARD_STEPS.each do |step, title|
+    - next unless enabled.include?(step)
 
-  .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'
+    = card("#{title}") do
+      - if defined?(EffectiveArticleEditor)
+        = f.article_editor "rich_text_#{step}_content", label: false, hint: "displayed on the ballot #{step} wizard step only"
+      - else
+        = f.rich_text_area "rich_text_#{step}_content", label: false, hint: "displayed on the ballot #{step} wizard step only"
 
   = f.submit