acts_as_warnable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d197bb659d0bf521569b61ebfa66a8d062c52bdd
+  data.tar.gz: e92d4711cd67f9e4b5ef5482964381efca51c7aa
+SHA512:
+  metadata.gz: 79a8ac2bd90b660996be0ac7733cf44ccae1026a654997b493736c2d44594e4c3d5a23b217bbb0939dce48b0a8f48721645f09c6a837260d82b82d6c3ff446b1
+  data.tar.gz: e4233b6f27e12180a56a6a28a7009f3b6b4119a24566de5d0f6cd71daff4314f6c5237927d810dde521bede55189b726b46ed3302cb516cd0b4c7971c9cc9ed0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Nigel Baillie
+
+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/Rakefile

@@ -0,0 +1,27 @@
+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    = 'ActsAsWarnable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'

data/app/assets/javascripts/acts_as_warnable/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/acts_as_warnable/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/acts_as_warnable/application_controller.rb

@@ -0,0 +1,4 @@
+module ActsAsWarnable
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/acts_as_warnable/warning_emails_controller.rb

@@ -0,0 +1,35 @@
+module ActsAsWarnable
+  class WarningEmailsController < ::InheritedResources::Base
+    respond_to :html
+
+    helper do
+      def method_missing(name, *args, &block)
+        if main_app.respond_to?(name)
+          main_app.send(name, *args, &block)
+        else
+          super
+        end
+      end
+
+      def warnable_classes
+        ::ActiveRecord::Base.descendants.select do |c|
+          c.reflect_on_all_associations.any? { |a| a.name == :warnings }
+        end
+      end
+    end
+
+    def show
+      redirect_to action: :edit
+    end
+
+    protected
+
+    def permitted_params
+      params.permit(
+        warning_email: [
+          :model, :recipient, :minutes, :url
+        ]
+      )
+    end
+  end
+end

data/app/controllers/acts_as_warnable/warnings_controller.rb

@@ -0,0 +1,70 @@
+module ActsAsWarnable
+  class WarningsController < ::ApplicationController
+    before_filter :fetch_warning, only: [:update, :show]
+    respond_to :html, :js
+
+    helper do
+      def method_missing(name, *args, &block)
+        if main_app.respond_to?(name)
+          main_app.send(name, *args, &block)
+        else
+          super
+        end
+      end
+    end
+
+    def index
+      @warnings = Warning.all
+      @warnings = @warnings.active if params[:active_only]
+
+      if params.key?(:warnable_id) && params.key?(:warnable_type)
+        @warnings = @warnings.where(warnable_id: params[:warnable_id], warnable_type: params[:warnable_type])
+
+        @warnable = params[:warnable_type].constantize.find(params[:warnable_id])
+        instance_variable_set('@'+params[:warnable_type].underscore, @warnable)
+
+        warnables = params[:warnable_type].underscore.pluralize
+        if lookup_context.exists?('warnings', warnables, false)
+          render "#{warnables}/warnings"
+        end
+      end
+    end
+
+    def update
+      was_dismissed = @warning.dismissed?
+      if @warning.update_attributes(permitted_params[:warning])
+        if !was_dismissed && @warning.dismissed?
+          flash[:success] = "Warning dismissed"
+        else
+          flash[:success] = "Successfully updated warning"
+        end
+      else
+        flash[:error] = "Failed to update warning: #{@warning.errors.full_messages.join(', ')}"
+      end
+
+      if params[:redirect_to]
+        redirect_to params[:redirect_to]
+      else
+        redirect_to warnings_path
+      end
+    end
+
+    def show
+      render params[:render] if params.key?(:render)
+    end
+
+    protected
+
+    def fetch_warning
+      @warning = Warning.find(params[:id])
+    end
+
+    def permitted_params
+      params.permit(
+        warning: [
+          :warnable_id, :warnable_type, :message, :dismissed_at, :dismisser_id
+        ]
+      )
+    end
+  end
+end

data/app/helpers/acts_as_warnable/application_helper.rb

@@ -0,0 +1,15 @@
+module ActsAsWarnable
+  module ApplicationHelper
+    def current_devise_user
+      send("current_#{Devise.mappings.values.first.name.to_s.underscore.singularize}")
+    end
+
+    def button_to_dismiss_warning(warning, options = {})
+      form_for(warning, options) do |f|
+        f.hidden_field(:dismisser_id, value: current_devise_user.id) +
+          hidden_field_tag(:redirect_to, request.fullpath) +
+          f.submit('Dismiss', class: 'btn btn-warning')
+      end
+    end
+  end
+end

data/app/mailers/warning_email_mailer.rb

@@ -0,0 +1,13 @@
+class WarningEmailMailer < ActionMailer::Base
+  def send_report(warning_email, warnings)
+    @warning_email = warning_email
+    @warnings = warnings
+    @site_url = defined?(Figaro) ? Figaro.env.site_url : ENV['SITE_URL']
+
+    mail(
+      to: @warning_email.recipient,
+      from: (defined?(Figaro) ? Figaro.env.warning_email_sender : ENV['WARNING_EMAIL_SENDER']) || raise('Please set ENV["WARNING_EMAIL_SENDER"]'),
+      subject: "[#{Time.now.strftime('%D %r')}] There are outstanding warnings for #{@warning_email.model}",
+    )
+  end
+end

data/app/models/warning.rb

@@ -0,0 +1,56 @@
+class Warning < ActiveRecord::Base
+  def self.dismisser_class
+    Devise.mappings.values.first.class_name
+  end
+
+  belongs_to :warnable, polymorphic: true
+  if Devise.mappings.size > 1
+    Rails.logger.warn "acts_as_warnable does not currently support multiple Devise models. "\
+                      "Only #{dismisser_class} will be able to dismiss warnings."
+  end
+  belongs_to :dismisser, class_name: dismisser_class
+
+  validates :message, :source, presence: true
+
+  before_save :check_if_dismissed
+  after_save :fire_dismissal_activity, if: :just_dismissed?
+
+  def self.active
+    where(dismissed_at: nil)
+  end
+
+  def dismiss(user)
+    update_attributes dismissed_at: Time.now, dismisser: user
+  end
+
+  def dismissed?
+    !dismissed_at.nil? && !dismisser.nil?
+  end
+
+  def just_dismissed?
+    @just_dismissed
+  end
+
+  protected
+
+  def fire_dismissal_activity
+    return unless warnable.respond_to?(:create_activity)
+
+    warnable.create_activity(
+      key: 'warning.dismiss',
+      recipient: self,
+      owner: dismisser
+    )
+  end
+
+  def check_if_dismissed
+    if dismisser_id_changed?
+      if dismisser_id.nil?
+        self.dismissed_at = nil
+      else
+        self.dismissed_at = Time.now
+        @just_dismissed = true
+      end
+    end
+  end
+end

data/app/models/warning_email.rb

@@ -0,0 +1,55 @@
+class WarningEmail < ActiveRecord::Base
+  validates :recipient, name_and_email: true
+  validate :model_is_actually_a_model
+
+  def warnings
+    Warning.where(warnable_type: model, dismissed_at: nil)
+  end
+
+  def send_report
+    WarningEmailMailer.send_report(self, warnings).deliver
+  end
+
+  def self.spawn_sender_thread
+    Thread.main[:warning_email_sender] = Thread.new do
+      loop do
+        begin
+          warning_times = {}
+
+          min_wait_time = 600
+          WarningEmail.find_each do |warning_email|
+            next if warning_email.minutes.blank?
+
+            warning_times[warning_email.id] ||= Time.now.to_i
+            wait_time = warning_email.minutes * 60.0 - (Time.now.to_i - warning_times[warning_email.id])
+
+            if wait_time < 0
+              warning_email.send_report if warning_email.warnings.any?
+              warning_times[warning_email.id] = Time.now.to_i
+              wait_time = warning_email.minutes * 60.0
+            end
+
+            min_wait_time = wait_time if wait_time < min_wait_time
+          end
+
+          ActiveRecord::Base.clear_active_connections!
+          sleep min_wait_time.seconds + 1
+        rescue StandardError => e
+          Rails.logger.error "WARNING_EMAILS ERROR DURING LOOP #{e.class.name}: #{e.message}"
+
+          ActiveRecord::Base.clear_active_connections!
+          sleep 1.minute
+        end
+      end
+    end
+  end
+
+  private
+
+  def model_is_actually_a_model
+    model_class = model.constantize
+    unless model_class.ancestors.include?(ActiveRecord::Base)
+      errors.add 'model', 'must correspond to a valid model'
+    end
+  end
+end

data/app/validators/name_and_email_validator.rb

@@ -0,0 +1,9 @@
+unless defined?(NameAndEmailValidator)
+  class NameAndEmailValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      unless value =~ /\A(.+)?\s<([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})?>\Z/i
+        record.errors[attribute] << (options[:message] || "is not a valid email address. Proper format is 'Name First <email@second.com>' separated by commas ")
+      end
+    end
+  end
+end

data/app/views/acts_as_warnable/warning_emails/_form.html.erb

@@ -0,0 +1,19 @@
+<%= link_to 'List', ActsAsWarnable::Engine.routes.url_helpers.warning_emails_path, class: 'btn btn-sm btn-primary' %>
+
+<%= form_for warning_email do |f| %>
+  <%= f.label :model, class: 'control-label' %>
+  <%= f.select :model, options_for_select(warnable_classes.map(&:name), f.object.try(:model)), {}, class: 'form-control' %>
+
+  <%= f.label :recipient, class: 'control-label' %>
+  <%= f.text_field :recipient, class: 'form-control' %>
+
+  <%= f.label :minutes, 'Send Every', class: 'control-label' %>
+  <div class='input-group'>
+    <%= f.text_field :minutes, class: 'form-control' %>
+    <span class='input-group-addon'>
+      minutes
+    </span>
+  </div>
+
+  <%= f.submit class: 'btn btn-primary' %>
+<% end %>

data/app/views/acts_as_warnable/warning_emails/edit.html.erb

@@ -0,0 +1,2 @@
+<h1>Edit Warning Email</h1>
+<%= render 'form', warning_email: @warning_email %>

data/app/views/acts_as_warnable/warning_emails/index.html.erb

@@ -0,0 +1,37 @@
+<h1>Warning Emails</h1>
+
+<dl>
+  <dt>Dispatcher Thread Status</dt>
+  <dd><%= Thread.main[:warning_email_sender].try(:status).try(:humanize) || '<em>Not Running</em>'.html_safe %></dd>
+</dl>
+
+<%= link_to 'New Warning Email', ActsAsWarnable::Engine.routes.url_helpers.new_warning_email_path, class: 'btn btn-primary' %>
+
+<table class="table table-striped">
+  <thead>
+    <tr>
+      <th>Model</th>
+      <th>Recipient</th>
+      <th>Send Interval</th>
+      <th>Actions</th>
+    </tr>
+
+    <tbody>
+      <% @warning_emails.each do |warning_email| %>
+        <tr>
+          <td><%= warning_email.model %></td>
+          <td><%= warning_email.recipient %></td>
+          <td><%= warning_email.minutes || '<not set>' %> minutes</td>
+          <td>
+            <%= link_to(ActsAsWarnable::Engine.routes.url_helpers.edit_warning_email_path(warning_email), data: { toggle: 'tooltip' }, class: 'btn btn-xs btn-warning', title: 'Edit') do %>
+              <%= content_tag :i, '', class: 'glyphicon glyphicon-edit' %>
+            <% end %>
+            <%= link_to(warning_email, method: :delete, data: { toggle: 'tooltip' }, class: 'btn btn-xs btn-danger', title: 'Destroy') do %>
+              <%= content_tag :i, '', class: 'glyphicon glyphicon-remove-circle' %>
+            <% end %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </thead>
+</table>

data/app/views/acts_as_warnable/warning_emails/new.html.erb

@@ -0,0 +1,2 @@
+<h1>New Warning Email</h1>
+<%= render 'form', warning_email: @warning_email %>

data/app/views/acts_as_warnable/warnings/index.html.erb

@@ -0,0 +1,37 @@
+<% if params[:warnable_type] %>
+  <h1>
+    <%= link_to "#{params[:warnable_type].humanize} ##{params[:warnable_id]}", @warnable %> Warnings
+  </h1>
+<% else %>
+  <h1>Warnings</h1>
+<% end %>
+
+<% if params[:active_only] %>
+  <% if params[:warnable_type] %>
+    <%= link_to "Show dismissed", send("#{params[:warnable_type].underscore}_warnings_path", params[:warnable_id]), { class: 'btn btn-info' } %>
+  <% else %>
+    <%= link_to "Show dismissed", ActsAsWarnable::Engine.routes.url_helpers.warnings_path, { class: 'btn btn-info' } %>
+  <% end %>
+<% else %>
+  <% if params[:warnable_type] %>
+    <%= link_to "Hide dismissed", send("#{params[:warnable_type].underscore}_warnings_path", params[:warnable_id], active_only: true), { class: 'btn btn-info' } %>
+  <% else %>
+    <%= link_to "Hide dismissed", ActsAsWarnable::Engine.routes.url_helpers.warnings_path(active_only: true), { class: 'btn btn-info' } %>
+  <% end %>
+<% end %>
+
+<ul>
+  <% @warnings.each do |warning| %>
+    <li>
+      <% if warning.respond_to?(:created_at) && warning.created_at %>
+        (<%= warning.created_at %>)
+      <% end %>
+      <%= link_to "##{warning.id}: (#{warning.source}) #{warning.message.truncate(50)}", ActsAsWarnable::Engine.routes.url_helpers.warning_path(warning) %>
+      <% if warning.dismissed? %>
+        <%= "(dismissed by #{warning.dismisser.try(:full_name) || warning.dismisser.try(:email) || 'nobody'} on #{warning.dismissed_at.strftime('%c')})" if warning.dismissed? %>
+      <% else %>
+        <%= button_to_dismiss_warning(warning) %>
+      <% end %>
+    </li>
+  <% end %>
+</ul>

data/app/views/acts_as_warnable/warnings/show.html.erb

@@ -0,0 +1,17 @@
+<h1>Warning #<%= @warning.id %> (<%= @warning.source %>) from <%= link_to "#{@warning.warnable_type.underscore.humanize} ##{@warning.warnable_id}", @warning.warnable %></h1>
+<% if @warning.respond_to?(:created_at) && @warning.created_at %>
+  (<%= warning.created_at %>)
+<% end %>
+<div class='well'>
+  <% @warning.message.each_line do |line| %>
+    <p style='word-wrap: break-word'><%= line %></p>
+  <% end %>
+</div>
+<div class=''>
+  <% if @warning.dismissed? %>
+    Dismissed by <%= @warning.dismisser.try(:full_name) || @warning.dismisser.try(:email) || 'nobody' %>
+    on <%= @warning.dismissed_at.strftime('%c') %>
+  <% else %>
+    <%= button_to_dismiss_warning(@warning) %>
+  <% end %>
+</div>

data/app/views/layouts/acts_as_warnable/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ActsAsWarnable</title>
+  <%= stylesheet_link_tag    "acts_as_warnable/application", media: "all" %>
+  <%= javascript_include_tag "acts_as_warnable/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/public_activity/warning/_dismiss.html.erb

@@ -0,0 +1,11 @@
+<% if activity.recipient %>
+  <%= link_to "Warning ##{activity.recipient_id}", ActsAsWarnable::Engine.routes.url_helpers.warning_path(activity.recipient_id) %> from "<%= activity.recipient.source %>"
+  was dismissed by <%= activity.owner.try(:full_name) || activity.owner.try(:email) || 'Someone' %>
+<% else %>
+  Unknown warning was dismissed
+  <% if activity.owner %>
+    by <%= activity.owner.try(:full_name) || activity.owner.try(:email) || "Someone (#{activity.owner.inspect})" %>
+  <% else %>
+    and we don't know who did it.
+  <% end %>
+<% end %>

data/app/views/public_activity/warning/_issue.html.erb

@@ -0,0 +1,13 @@
+<% if activity.recipient %>
+  <div>
+    "<%= activity.recipient.source %>" issued
+    <%= link_to "a warning (##{activity.recipient_id})", ActsAsWarnable::Engine.routes.url_helpers.warning_path(activity.recipient) %>
+  </div>
+
+  <div>
+    "<%= activity.recipient.message.truncate(40) %>"
+  </div>
+
+<% else %>
+  Unknown warning was issued.
+<% end %>

data/app/views/warning_email_mailer/send_report.html.erb

@@ -0,0 +1,26 @@
+<h3>The following warnings have not been dismissed</h3>
+
+<% if @site_url.blank? %>
+  <p>(Set ENV["SITE_URL"] to have these list entries link to their warning page for dismissal.)</p>
+<% end %>
+
+<ul>
+  <% @warnings.each do |warning| %>
+    <li>
+      <ul>
+        <li>
+          <% if @site_url.blank? %>
+            <span>#<%= warning.id %>: (<%= warning.source %>)</span>
+          <% else %>
+            <%= link_to "##{warning.id}: (#{warning.source})", @site_url + ActsAsWarnable::Engine.routes.url_helpers.warning_path(warning.id) %>
+          <% end %>
+        </li>
+        <li>
+          <% warning.message.each_line do |line| %>
+            <p style='word-wrap: break-word'><%= line %></p>
+          <% end %>
+        </li>
+      </ul>
+    </li>
+  <% end %>
+</ul>

data/config/routes.rb

@@ -0,0 +1,4 @@
+ActsAsWarnable::Engine.routes.draw do
+  resources :warnings
+  resources :warning_emails
+end

data/lib/acts_as_warnable.rb

@@ -0,0 +1,55 @@
+require 'acts_as_warnable/version'
+require 'acts_as_warnable/engine'
+require 'acts_as_warnable/rails/routes'
+
+module ActsAsWarnable
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def acts_as_warnable(options = {})
+      has_many :warnings, as: :warnable
+      include WarnableInstanceMethods
+      extend WarnableClassMethods
+    end
+  end
+
+  module WarnableClassMethods
+    def warn_on_failure_of(*methods)
+      options = methods.last.is_a?(Hash) ? methods.pop : {}
+
+      methods.each do |method_name|
+        define_method "#{method_name}_with_warning" do |*args, &block|
+          begin
+            send("#{method_name}_without_warning", *args, &block)
+          rescue Exception => e
+            issue_warning(
+              warning_source(method_name),
+              "#{e.class.name}: #{e.message}\n\n#{e.backtrace.join("\n")}"
+            )
+            raise if options[:raise_anyway]
+          end
+        end
+        alias_method_chain method_name, :warning
+      end
+    end
+  end
+
+  module WarnableInstanceMethods
+    def warning_source(method_name)
+      "#{self.class.name}##{method_name}"
+    end
+
+    def issue_warning(source, message)
+      warning = warnings.create(source: source, message: message)
+
+      if respond_to?(:create_activity)
+        create_activity(
+          key: 'warning.issue',
+          recipient: warning
+        )
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActsAsWarnable

data/lib/acts_as_warnable/engine.rb

@@ -0,0 +1,10 @@
+module ActsAsWarnable
+  class Engine < ::Rails::Engine
+    isolate_namespace ActsAsWarnable
+    initializer 'acts_as_warnable.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper ActsAsWarnable::ApplicationHelper
+      end
+    end
+  end
+end

data/lib/acts_as_warnable/rails/routes.rb

@@ -0,0 +1,18 @@
+module ActionDispatch
+  module Routing
+    class Mapper
+      def warning_paths_for(*resources)
+        resources.map(&:to_s).each do |resource|
+          get "/#{resource.pluralize}/:warnable_id/warnings",
+              to: 'acts_as_warnable/warnings#index',
+              defaults: { warnable_type: resource.singularize.camelize },
+              as: "#{resource.singularize}_warnings"
+
+          post "/#{resource.pluralize}/:warnable_id/warnings",
+               to: 'acts_as_warnable/warnings#post',
+               defaults: { warnable_type: resource.singularize.camelize }
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_warnable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsWarnable
+  VERSION = "0.1.0"
+end

data/lib/generators/acts_as_warnable/warning_email_thread_generator.rb

@@ -0,0 +1,9 @@
+class ActsAsWarnable::WarningEmailThreadGenerator < Rails::Generators::Base
+  desc "Generates an initializer that kicks off a thread that sends warning emails on their intervals."
+
+  source_root File.expand_path("../../templates", __FILE__)
+
+  def create_initializer
+    copy_file 'email_initializer.rb', 'config/initializers/send_warning_emails.rb'
+  end
+end

data/lib/generators/acts_as_warnable/warning_generator.rb

@@ -0,0 +1,9 @@
+class ActsAsWarnable::WarningGenerator < Rails::Generators::Base
+  desc "Generates the migration for warnings"
+
+  def create_migrations
+    generate 'migration', 'CreateWarnings warnable_id:integer warnable_type:string source:string message:text dismissed_at:datetime dismisser_id:integer'
+    generate 'migration', 'AddTimestampsToWarnings created_at:datetime updated_at:datetime'
+    generate 'migration', 'CreateWarningEmails model:string minutes:decimal\\{10,2\\} recipient:string url:string'
+  end
+end

data/lib/generators/templates/email_initializer.rb

@@ -0,0 +1,15 @@
+### Here we spawn a thread that sends warning emails on their set intervals ###
+
+# You may modify this to your needs
+conditions = [
+  # Only send emails on production
+  Rails.env.production?,
+
+  # Don't send emails from rails console sessions
+  !defined?(Rails::Console),
+
+  # Don't send emails from rake tasks
+  $0 !~ /rake$/
+]
+
+WarningEmail.spawn_sender_thread if conditions.all?

data/lib/tasks/acts_as_warnable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :acts_as_warnable do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_warnable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nigel Baillie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: inherited_resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  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: Allows models to issue warnings if a task goes wrong
+email:
+- metreckk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/assets/javascripts/acts_as_warnable/application.js
+- app/assets/stylesheets/acts_as_warnable/application.css
+- app/controllers/acts_as_warnable/application_controller.rb
+- app/controllers/acts_as_warnable/warning_emails_controller.rb
+- app/controllers/acts_as_warnable/warnings_controller.rb
+- app/helpers/acts_as_warnable/application_helper.rb
+- app/mailers/warning_email_mailer.rb
+- app/models/warning.rb
+- app/models/warning_email.rb
+- app/validators/name_and_email_validator.rb
+- app/views/acts_as_warnable/warning_emails/_form.html.erb
+- app/views/acts_as_warnable/warning_emails/edit.html.erb
+- app/views/acts_as_warnable/warning_emails/index.html.erb
+- app/views/acts_as_warnable/warning_emails/new.html.erb
+- app/views/acts_as_warnable/warnings/index.html.erb
+- app/views/acts_as_warnable/warnings/show.html.erb
+- app/views/layouts/acts_as_warnable/application.html.erb
+- app/views/public_activity/warning/_dismiss.html.erb
+- app/views/public_activity/warning/_issue.html.erb
+- app/views/warning_email_mailer/send_report.html.erb
+- config/routes.rb
+- lib/acts_as_warnable.rb
+- lib/acts_as_warnable/engine.rb
+- lib/acts_as_warnable/rails/routes.rb
+- lib/acts_as_warnable/version.rb
+- lib/generators/acts_as_warnable/warning_email_thread_generator.rb
+- lib/generators/acts_as_warnable/warning_generator.rb
+- lib/generators/templates/email_initializer.rb
+- lib/tasks/acts_as_warnable_tasks.rake
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Allows models to issue warnings if a task goes wrong
+test_files: []