effective_polls 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b49f5df5989ddd470b3090d2ac28ab5974e902bd33f8a57e05487025074cf0a8
+  data.tar.gz: f3465afeb7bee7279348f24f7e85128d136cac9d47add5f3c67f8a1ee740062f
+SHA512:
+  metadata.gz: 5ea3cf981517d7d8081feae614b054114f156826b5a694410d48f3418b7cf9df2db606c290d3f89a9ca1018ff4a8c64550528b9071436d7c7c02c863217467d1
+  data.tar.gz: 76898e90f2e456e3ccbc4b24e022ce785b1375ff0afbc91cab27b31319c4bf40dab731900d77bced3788d9acb1cdceaec4b9d6483c984c0e8e0d4a20549f598c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 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
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,132 @@
+# Effective Polls
+
+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.
+
+The user can complete the poll_ballot and anonymously vote for each option.
+
+Some reports to display results.
+
+## Getting Started
+
+Please first install the [effective_datatables](https://github.com/code-and-effect/effective_datatables) gem.
+
+Please download and install [Twitter Bootstrap4](http://getbootstrap.com)
+
+Add to your Gemfile:
+
+```ruby
+gem 'effective_polls'
+```
+
+Run the bundle command to install it:
+
+```console
+bundle install
+```
+
+Then run the generator:
+
+```ruby
+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.
+
+Then migrate the database:
+
+```ruby
+rake db:migrate
+```
+
+## Polls
+
+TODO
+
+## Authorization
+
+All authorization checks are handled via the config.authorization_method found in the `app/config/initializers/effective_polls.rb` file.
+
+It is intended for flow through to CanCan or Pundit, but neither of those gems are required.
+
+This method is called by all controller actions with the appropriate action and resource
+
+Action will be one of [:index, :show, :new, :create, :edit, :update, :destroy]
+
+Resource will the appropriate Effective::Poll object or class
+
+The authorization method is defined in the initializer file:
+
+```ruby
+# As a Proc (with CanCan)
+config.authorization_method = Proc.new { |controller, action, resource| authorize!(action, resource) }
+```
+
+```ruby
+# As a Custom Method
+config.authorization_method = :my_authorization_method
+```
+
+and then in your application_controller.rb:
+
+```ruby
+def my_authorization_method(action, resource)
+  current_user.is?(:admin) || EffectivePunditPolicy.new(current_user, resource).send('#{action}?')
+end
+```
+
+or disabled entirely:
+
+```ruby
+config.authorization_method = false
+```
+
+If the method or proc returns false (user is not authorized) an Effective::AccessDenied exception will be raised
+
+You can rescue from this exception by adding the following to your application_controller.rb:
+
+```ruby
+rescue_from Effective::AccessDenied do |exception|
+  respond_to do |format|
+    format.html { render 'static_pages/access_denied', status: 403 }
+    format.any { render text: 'Access Denied', status: 403 }
+  end
+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/)
+
+## Testing
+
+Run tests by:
+
+```ruby
+rails test
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Bonus points for test coverage
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,32 @@
+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
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/effective_polls_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets .css

data/app/controllers/admin/poll_notifications_controller.rb

@@ -0,0 +1,15 @@
+module Admin
+  class PollNotificationsController < ApplicationController
+    layout (EffectivePolls.layout.kind_of?(Hash) ? EffectivePolls.layout[:admin] : EffectivePolls.layout)
+
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectivePolls.authorize!(self, :admin, :effective_polls) }
+
+    include Effective::CrudController
+
+    def permitted_params
+      params.require(:effective_poll_notification).permit!
+    end
+
+  end
+end

data/app/controllers/admin/poll_questions_controller.rb

@@ -0,0 +1,15 @@
+module Admin
+  class PollQuestionsController < ApplicationController
+    layout (EffectivePolls.layout.kind_of?(Hash) ? EffectivePolls.layout[:admin] : EffectivePolls.layout)
+
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectivePolls.authorize!(self, :admin, :effective_polls) }
+
+    include Effective::CrudController
+
+    def permitted_params
+      params.require(:effective_poll_question).permit!
+    end
+
+  end
+end

data/app/controllers/admin/polls_controller.rb

@@ -0,0 +1,23 @@
+module Admin
+  class PollsController < ApplicationController
+    layout (EffectivePolls.layout.kind_of?(Hash) ? EffectivePolls.layout[:admin] : EffectivePolls.layout)
+
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectivePolls.authorize!(self, :admin, :effective_polls) }
+
+    include Effective::CrudController
+
+    def results
+      @poll = Effective::Poll.find(params[:id])
+      EffectivePolls.authorize!(self, :results, @poll)
+
+      @datatable = Admin::EffectivePollResultsDatatable.new(poll_token: @poll.token)
+      @page_title = "#{@poll} Results"
+    end
+
+    def permitted_params
+      params.require(:effective_poll).permit!
+    end
+
+  end
+end

data/app/controllers/effective/ballots_controller.rb

@@ -0,0 +1,70 @@
+module Effective
+  class BallotsController < ApplicationController
+    layout (EffectivePolls.layout.kind_of?(Hash) ? EffectivePolls.layout[:polls] : EffectivePolls.layout)
+
+    before_action(:authenticate_user!) if defined?(Devise)
+    include Effective::WizardController
+
+    resource_scope do
+      poll = Effective::Poll.find(params[:poll_id])
+      Effective::Ballot.deep.where(poll: poll, user: current_user)
+    end
+
+    # Enforce one ballot per user. Redirect them to an existing ballot for this poll.
+    before_action(only: [:new, :show]) do
+      poll = Effective::Poll.find(params[:poll_id])
+      existing = Effective::Ballot.where(poll: poll, user: current_user).where.not(id: resource).first
+
+      if existing&.completed?
+        flash[:danger] = 'You have already completed a ballot for this poll.'
+        redirect_to(root_path)
+      elsif existing.present?
+        flash[:success] = "You have been redirected to the #{resource_wizard_step_title(existing.next_step)} step."
+        redirect_to effective_polls.poll_ballot_build_path(existing.poll, existing, existing.next_step)
+      end
+    end
+
+    # Enforce poll availability
+    before_action(only: [:show, :update]) do
+      poll = resource.poll
+
+      unless poll.available_for?(current_user)
+        flash[:danger] = begin
+          if poll.ended?
+            'This poll has ended'
+          elsif !poll.started?
+            'This poll has not yet started'
+          elsif !poll.users.include?(current_user)
+            'This poll is not available to you'
+          else
+            'This poll is unavailable'
+          end
+        end
+
+        redirect_to(root_path)
+      end
+    end
+
+    private
+
+    def permitted_params
+      case step
+      when :start
+        params.require(:effective_ballot).permit(:current_step)
+      when :vote
+        params.require(:effective_ballot).permit(:current_step, ballot_responses_attributes: [
+          :id, :poll_id, :poll_question_id,
+          :date, :email, :number, :long_answer, :short_answer, :upload_file,
+          :poll_question_option_ids, poll_question_option_ids: []
+        ])
+      when :submit
+        params.require(:effective_ballot).permit(:current_step)
+      when :complete
+        raise('unexpected post to complete')
+      else
+        raise('unexpected step')
+      end
+    end
+
+  end
+end

data/app/controllers/effective/polls_controller.rb

@@ -0,0 +1,19 @@
+module Effective
+  class PollsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+
+    def show
+      poll = Effective::Poll.find(params[:id])
+      EffectivePolls.authorize!(self, :show, poll)
+
+      ballot = Effective::Ballot.where(poll: poll, user: current_user).first
+
+      if ballot.present?
+        redirect_to effective_polls.poll_ballot_build_path(poll, ballot, ballot.next_step)
+      else
+        redirect_to effective_polls.poll_ballot_build_path(poll, :new, :start)
+      end
+    end
+  end
+
+end

data/app/datatables/admin/effective_poll_notifications_datatable.rb

@@ -0,0 +1,43 @@
+class Admin::EffectivePollNotificationsDatatable < Effective::Datatable
+  filters do
+    scope :all
+    scope :started
+    scope :completed
+  end
+
+  datatable do
+    col :updated_at, visible: false
+    col :created_at, visible: false
+    col :id, visible: false
+
+    col :poll
+    col :category
+
+    col :reminder do |poll_notification|
+      case poll_notification.category
+      when 'When poll starts'
+        poll_notification.poll.start_at&.strftime('%F %H:%M')
+      when 'When poll ends'
+        poll_notification.poll.end_at&.strftime('%F %H:%M')
+      when 'Upcoming reminder'
+        Effective::PollNotification::UPCOMING_REMINDERS.invert[poll_notification.reminder]
+      when 'Reminder'
+        Effective::PollNotification::REMINDERS.invert[poll_notification.reminder]
+      else
+        raise('unexpected category')
+      end
+    end
+
+    col :subject
+    col :body
+
+    col :started_at, visible: false
+    col :completed_at
+
+    actions_col
+  end
+
+  collection do
+    Effective::PollNotification.all.deep
+  end
+end

data/app/datatables/admin/effective_poll_questions_datatable.rb

@@ -0,0 +1,28 @@
+class Admin::EffectivePollQuestionsDatatable < Effective::Datatable
+  datatable do
+    reorder :position
+
+    col :updated_at, visible: false
+    col :created_at, visible: false
+    col :id, visible: false
+
+    col :poll
+
+    col :position do |poll_question|
+      poll_question.position.to_i + 1
+    end
+
+    col :title
+    col :body
+    col :required
+
+    col :category, label: 'Type'
+    col :poll_question_options, label: 'Options'
+
+    actions_col
+  end
+
+  collection do
+    Effective::PollQuestion.all.deep
+  end
+end

data/app/datatables/admin/effective_poll_results_datatable.rb

@@ -0,0 +1,50 @@
+class Admin::EffectivePollResultsDatatable < Effective::Datatable
+  datatable do
+    col :ballot, search: poll.completed_ballots.order(:token).pluck(:token)
+
+    col :position, visible: false
+    col :category, search: Effective::PollQuestion::CATEGORIES, visible: false
+
+    col :question, search: poll.poll_questions.pluck(:title)
+    col :responses
+  end
+
+  collection do
+    ballot_responses = Effective::BallotResponse.completed.deep.where(poll: poll)
+
+    ballot_responses.flat_map do |br|
+      rows = if br.poll_question.poll_question_option?
+        br.poll_question_options.map do |response|
+          [
+            br.ballot.token,
+            br.poll_question.position,
+            br.poll_question.category,
+            br.poll_question.to_s,
+            response.to_s
+          ]
+        end
+      elsif br.response.present?
+        [
+          [
+            br.ballot.token,
+            br.poll_question.position,
+            br.poll_question.category,
+            br.poll_question.to_s,
+            br.response.to_s
+          ]
+        ]
+      else
+        []
+      end
+    end
+
+  end
+
+  def poll
+    @poll ||= begin
+      raise('expected datatable poll_token attribute') unless attributes[:poll_token]
+      Effective::Poll.deep_results.find(attributes[:poll_token])
+    end
+  end
+
+end