0.0
The project is in a healthy, maintained state
Online polls and user voting.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Project Readme

Effective Polls

Online polls and user voting.

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.

All results are anonymized such that the user cannot be identified from the 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 gem.

Please download and install the Twitter Bootstrap4

Add to your Gemfile:

gem 'haml-rails' # or try using gem 'hamlit-rails'
gem 'effective_polls'

Run the bundle command to install it:

bundle install

Then run the generator:

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 names, manually adjust both the configuration file and the migration now.

Then migrate the database:

rake db:migrate

Render the "available polls for current_user" datatable on your user dashboard:

%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:

- if can? :admin, :effective_polls
  = link_to 'Polls', effective_polls.admin_polls_path

Set up your permissions:

# 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

  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 effective_polls:notify

Usage

You can render the results with render('effective/poll_results/results', poll: poll).

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:

# As a Proc (with CanCan)
config.authorization_method = Proc.new { |controller, action, resource| authorize!(action, resource) }
# As a Custom Method
config.authorization_method = :my_authorization_method

and then in your application_controller.rb:

def my_authorization_method(action, resource)
  current_user.is?(:admin) || EffectivePunditPolicy.new(current_user, resource).send('#{action}?')
end

or disabled entirely:

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:

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

License

MIT License. Copyright Code and Effect Inc.

Testing

Run tests by:

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