effective_polls 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b49f5df5989ddd470b3090d2ac28ab5974e902bd33f8a57e05487025074cf0a8
-  data.tar.gz: f3465afeb7bee7279348f24f7e85128d136cac9d47add5f3c67f8a1ee740062f
+  metadata.gz: 68d305ba395a3d2414ebca82cd907b4e15831390d406bc963f491ebb982c76d3
+  data.tar.gz: 46418fe6dc4c690c64e29800ce3cc3710ece9375e057f2fbdf2f47521b637bde
 SHA512:
-  metadata.gz: 5ea3cf981517d7d8081feae614b054114f156826b5a694410d48f3418b7cf9df2db606c290d3f89a9ca1018ff4a8c64550528b9071436d7c7c02c863217467d1
-  data.tar.gz: 76898e90f2e456e3ccbc4b24e022ce785b1375ff0afbc91cab27b31319c4bf40dab731900d77bced3788d9acb1cdceaec4b9d6483c984c0e8e0d4a20549f598c
+  metadata.gz: '0379c829ce46c31baa169a070c7023d2ae4f013770667725d14f9a309b1a940cf474afef85e1717de3ffad9cdbe114e1ed676895013ff865eee3afe4aeed8d58'
+  data.tar.gz: 8ff57a27c6baae02974c31c43d2067759b895f1f90fdf258c573b606acb6fa5ee26871f52b6ffda86713b63bc96785d1138e74d776c6f595b5264e64e649ae5c

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,56 @@ 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 :index, Effective::PollQuestion
+  can :index, Admin::EffectivePollResultsDatatable
+
+  can([:new, :create, :edit, :update, :destroy], Effective::PollQuestion) do |pq|
+    pq.poll.present? && !pq.poll.started?
+  end
+
+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 +147,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/models/effective/poll.rb

@@ -23,6 +23,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

data/app/models/effective/poll_notification.rb

@@ -1,6 +1,7 @@
 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']

data/app/models/effective/poll_question.rb

@@ -6,6 +6,7 @@ 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

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

@@ -18,3 +18,7 @@
 
       - 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

@@ -4,6 +4,9 @@
   = f.datetime_field :start_at, input_js: { minDate: [f.object.start_at.presence, Time.zone.now].compact.min.strftime('%F') }
   = f.datetime_field :end_at
 
+  .alert.alert-warning
+    Once the start date has passed, this poll will become read only and you will be unable to make changes.
+
   -# Audience
   = f.radios :audience, Effective::Poll::AUDIENCES
 

data/config/effective_polls.rb

@@ -53,7 +53,7 @@ EffectivePolls.setup do |config|
   #
   config.mailer = {
     layout: 'effective_polls_mailer_layout',
-    default_from: 'info@example.com'
+    default_from: 'no-reply@example.com'
   }
 
 end

data/lib/effective_polls/version.rb

@@ -1,3 +1,3 @@
 module EffectivePolls
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 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,8 +2,9 @@
 
 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, bccs)
   end
 
   def poll_start
@@ -12,7 +13,7 @@ class EffectivePollsMailerPreview < ActionMailer::Preview
   end
 
   def poll_reminder
-    poll_notification = build_poll_notification('This is a reminder')
+    poll_notification = build_poll_notification('The poll started already and you have not participated')
     Effective::PollsMailer.poll_reminder(poll_notification, bccs)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_polls
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails