fine_print 0.0.1

data/app/views/fine_print/agreements/_form.html.erb

@@ -0,0 +1,51 @@
+<%= form_for(@agreement) do |f| %>
+  <% if @agreement.errors.any? %>
+    <div id="error_explanation" class="fine_print errors">
+      <h2 class="fine_print heading"><%= pluralize(@agreement.errors.count, "error") %> prohibited this agreement from being saved:</h2>
+
+      <ul>
+      <% @agreement.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :name, :class => "fine_print label" %><br/>
+    <%= f.text_field :name, :size => 40, :class => "fine_print text_field" %><br/>
+    (e.g., "Terms of Use"; changing this will reset the version count)<br/><br/>
+  </div>
+  <div class="field">
+    <%= f.label :content, :class => "fine_print label" %><br/>
+    <%= f.text_area :content, :cols => 56, :class => "fine_print text_area" %><br/><br/>
+  </div>
+  <div class="field">
+    <%= f.label :confirmation_text, :class => "fine_print label" %><br/>
+    <%= f.text_field :confirmation_text, :size => 40, :class => "fine_print text_field" %><br/>
+    (e.g., "I have read and agree to the terms and conditions above")<br/><br/>
+  </div>
+  <div class="field">
+    <%= f.label :ready, "Display the agreement's name to users as a heading?", :class => "fine_print label" %>
+    <%= f.check_box :display_name, :class => "fine_print checkbox" %><br/><br/>
+  </div>
+  <div class="field">
+    <%= f.label :ready, "Display the agreement's version to users?", :class => "fine_print label" %>
+    <%= f.check_box :display_version, :class => "fine_print checkbox" %><br/><br/>
+  </div>
+  <div class="field">
+    <%= f.label :ready, "Display the agreement's last updated date to users?", :class => "fine_print label" %>
+    <%= f.check_box :display_updated, :class => "fine_print checkbox" %><br/><br/>
+  </div>
+  <div class="field">
+    <%= f.label :ready, "Display a confirmation checkbox that users have to click?", :class => "fine_print label" %>
+    <%= f.check_box :display_confirmation, :class => "fine_print checkbox" %><br/><br/>
+  </div>
+  <div class="field">
+    <%= f.label :ready, "Ready to be used?", :class => "fine_print label" %>
+    <%= f.check_box :ready, :class => "fine_print checkbox" %><br/><br/>
+  </div>
+  <div class="actions">
+    <%= f.submit nil, :class => "fine_print submit" %>
+  </div>
+<% end %>

data/app/views/fine_print/agreements/_form.html.erb~

@@ -0,0 +1,51 @@
+<%= form_for(@agreement) do |f| %>
+  <% if @agreement.errors.any? %>
+    <div id="error_explanation" class="fine_print errors">
+      <h2 class="fine_print heading"><%= pluralize(@agreement.errors.count, "error") %> prohibited this agreement from being saved:</h2>
+
+      <ul>
+      <% @agreement.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :name, :class => "fine_print label" %><br/>
+    <%= f.text_field :name, :size => 40, :class => "fine_print text_field" %><br/>
+    (e.g., "Terms of Use"; changing this will reset the version count)<br/><br/>
+  </div>
+  <div class="field">
+    <%= f.label :content, :class => "fine_print label" %><br/>
+    <%= f.text_area :content, :cols => 56, :class => "fine_print text_area" %><br/><br/>
+  </div>
+  <div class="field">
+    <%= f.label :confirmation_text, :class => "fine_print label" %><br/>
+    <%= f.text_field :confirmation_text, :size => 40, :class => "fine_print text_field" %><br/>
+    (e.g., "I have read and agree to the terms and conditions above")<br/><br/>
+  </div>
+  <div class="field">
+    <%= f.label :ready, "Display the agreement's name to users (as a heading)?", :class => "fine_print label" %>
+    <%= f.check_box :display_name, :class => "fine_print checkbox" %><br/><br/>
+  </div>
+  <div class="field">
+    <%= f.label :ready, "Display the agreement's version to users?", :class => "fine_print label" %>
+    <%= f.check_box :display_version, :class => "fine_print checkbox" %><br/><br/>
+  </div>
+  <div class="field">
+    <%= f.label :ready, "Display the agreement's last updated date to users?", :class => "fine_print label" %>
+    <%= f.check_box :display_updated, :class => "fine_print checkbox" %><br/><br/>
+  </div>
+  <div class="field">
+    <%= f.label :ready, "Display a confirmation checkbox that users have to click?", :class => "fine_print label" %>
+    <%= f.check_box :display_confirmation, :class => "fine_print checkbox" %><br/><br/>
+  </div>
+  <div class="field">
+    <%= f.label :ready, "Ready to be used?", :class => "fine_print label" %>
+    <%= f.check_box :ready, :class => "fine_print checkbox" %><br/><br/>
+  </div>
+  <div class="actions">
+    <%= f.submit nil, :class => "fine_print submit" %>
+  </div>
+<% end %>

data/app/views/fine_print/agreements/edit.html.erb

@@ -0,0 +1,8 @@
+<h1 class="fine_print heading">Editing agreement</h1>
+
+<%= render 'form' %>
+
+<br/>
+
+<%= link_to 'Show', @agreement, :class => "fine_print link" %> |
+<%= link_to 'Back', agreements_path, :class => "fine_print link" %>

data/app/views/fine_print/agreements/edit.html.erb~

@@ -0,0 +1,8 @@
+<h1 class="fine_print heading">Editing agreement</h1>
+
+<%= render 'form' %>
+
+<br/>
+
+<%= link_to 'Show', @agreement, :class => fine_print link" %> |
+<%= link_to 'Back', agreements_path, :class => fine_print link" %>

data/app/views/fine_print/agreements/index.html.erb

@@ -0,0 +1,32 @@
+<h1 class="fine_print heading">FinePrint agreements</h1>
+
+<table class="fine_print index">
+  <tr>
+    <th>Name</th>
+    <th>Version</th>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+
+<% @agreements.each do |agreement| %>
+  <tr>
+    <td><%= agreement.name %></td>
+    <td><%= agreement.version %></td>
+    <td><%= link_to 'Show', agreement, :class => "fine_print link" %></td>
+    <td><% if agreement.can_be_edited_by?(@user) %>
+          <%= link_to 'Edit', edit_agreement_path(agreement), :class => "fine_print link" %>
+        <% else %>
+          <%= link_to 'New version', agreement_new_version_path(agreement), :class => "fine_print link" %>
+        <% end %></td>
+    <td><% if agreement.can_be_destroyed_by?(@user) %>
+          <%= link_to 'Delete', agreement, method: :delete, data: { confirm: 'Are you sure you wish to delete this agreement?' }, :class => "fine_print link" %>
+        <% end %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New Agreement', new_agreement_path, :class => "fine_print link" %> |
+<%= link_to 'Back', root_path, :class => "fine_print link" %>

data/app/views/fine_print/agreements/index.html.erb~

@@ -0,0 +1,32 @@
+<h1 class="fine_print heading">FinePrint agreements</h1>
+
+<table class="fine_print index">
+  <tr>
+    <th>Name</th>
+    <th>Version</th>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+
+<% @agreements.each do |agreement| %>
+  <tr>
+    <td><%= agreement.name %></td>
+    <td><%= agreement.version %></td>
+    <td><%= link_to 'Show', agreement, :class => "fine_print link" %></td>
+    <td><% if agreement.can_be_edited_by?(@user) %>
+          <%= link_to 'Edit', edit_agreement_path(agreement), :class => "fine_print link" %>
+        <% else %>
+          <%= link_to 'New version', agreement_new_version_path(agreement), :class => "fine_print link" %>
+        <% end %></td>
+    <td><% if agreement.can_be_destroyed_by?(@user) %>
+          <%= link_to 'Delete', agreement, method: :delete, data: { confirm: 'Are you sure?' }, :class => "fine_print link" %>
+        <% end %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New Agreement', new_agreement_path, :class => "fine_print link" %> |
+<%= link_to 'Back', root_path, :class => "fine_print link" %>

data/app/views/fine_print/agreements/new.html.erb

@@ -0,0 +1,7 @@
+<h1 class="fine_print heading">New agreement</h1>
+
+<%= render 'form' %>
+
+<br/>
+
+<%= link_to 'Back', agreements_path, :class => "fine_print link" %>

data/app/views/fine_print/agreements/new.html.erb~

@@ -0,0 +1,7 @@
+<h1 class="fine_print heading">New agreement</h1>
+
+<%= render 'form' %>
+
+<br/>
+
+<%= link_to 'Back', agreements_path, :class => fine_print link" %>

data/app/views/fine_print/agreements/new_version.html.erb

@@ -0,0 +1,7 @@
+<h1 class="fine_print heading">New version of <%= @agreement.name %></h1>
+
+<%= render 'form' %>
+
+<br/>
+
+<%= link_to 'Back', agreements_path, :class => "fine_print link" %>

data/app/views/fine_print/agreements/new_version.html.erb~

@@ -0,0 +1,7 @@
+<h1 class="fine_print heading"><%= @agreement.name %> version <%= @agreement.version + 1 %></h1>
+
+<%= render 'form' %>
+
+<br/>
+
+<%= link_to 'Back', agreements_path, :class => "fine_print link" %>

data/app/views/fine_print/agreements/show.html.erb

@@ -0,0 +1,15 @@
+<%= render :partial => 'agreement', :locals => {
+      :agreement => @agreement,
+      :user => @user,
+      :notice => @notice,
+      :accept_path => @accept_path,
+      :cancel_path => @cancel_path,
+      :url => @url,
+      :ref => @ref } %>
+
+<br/>
+
+<% if @agreement.can_be_edited_by?(@user) %>
+  <%= link_to 'Edit', edit_agreement_path(@agreement), :class => "fine_print link" %> |
+  <%= link_to 'Back', agreements_path, :class => "fine_print link" %>
+<% end %>

data/app/views/fine_print/agreements/show.html.erb~

@@ -0,0 +1,14 @@
+<%= render :partial => 'agreement', :locals => {
+      :agreement => @agreement,
+      :user => @user,
+      :notice => @notice,
+      :accept_path => @accept_path,
+      :url => @url,
+      :ref => @ref } %>
+
+<br/>
+
+<% if @agreement.can_be_edited_by?(@user) %>
+  <%= link_to 'Edit', edit_agreement_path(@agreement), :class => "fine_print link" %> |
+  <%= link_to 'Back', agreements_path, :class => "fine_print link" %>
+<% end %>

data/app/views/fine_print/home/index.html.erb

@@ -0,0 +1,7 @@
+<h1 class="fine_print heading">FinePrint</h1>
+
+<ul>
+  <li><%= link_to 'Manage agreements', agreements_path, :class => "fine_print link" %></li>
+  <li><%= link_to 'View accepted agreements', user_agreements_path, :class => "fine_print link" %></li>
+</ul>
+

data/app/views/fine_print/home/index.html.erb~

@@ -0,0 +1,7 @@
+<h1 class="fine_print heading">FinePrint</h1>
+
+<ul>
+  <li><%= link_to 'Manage agreements', agreements_path, :class => "fine_print link" %></li>
+  <li><%= link_to 'Accepted agreements', user_agreements_path, :class => "fine_print link" %></li>
+</ul>
+

data/app/views/fine_print/user_agreements/cancel.js.erb

@@ -0,0 +1 @@
+window.history.back();

data/app/views/fine_print/user_agreements/cancel.js.erb~

@@ -0,0 +1,2 @@
+$("<%= "#fine_print_dialog_#{@index}" %>").off("dialogbeforeclose").dialog("close");
+$("<%= "#fine_print_dialog_#{@index + 1}" %>").dialog("open");

data/app/views/fine_print/user_agreements/create.js.erb

@@ -0,0 +1,2 @@
+$("<%= "#fine_print_dialog_#{@index}" %>").off("dialogbeforeclose").dialog("close");
+$("<%= "#fine_print_dialog_#{@index + 1}" %>").dialog("open");

data/app/views/fine_print/user_agreements/create.js.erb~

@@ -0,0 +1,2 @@
+$("<%= "#fine_print_dialog_#{@index}" %>").off("dialogbeforeclose").dialog("close");
+$("<%= "#fine_print_dialog_#{@next_index}" %>").dialog("open");

data/app/views/fine_print/user_agreements/index.html.erb

@@ -0,0 +1,25 @@
+<h1 class="fine_print heading">Accepted FinePrint agreements</h1>
+
+<table class="fine_print index">
+  <tr>
+    <th>User ID</th>
+    <th>Agreement name</th>
+    <th>Agreement version</th>
+    <th>Date accepted</th>
+    <th></th>
+  </tr>
+
+<% @user_agreements.each do |user_agreement| %>
+  <tr>
+    <td><%= user_agreement.user.id %></td>
+    <td><%= user_agreement.agreement.name %></td>
+    <td><%= user_agreement.agreement.version %></td>
+    <td><%= user_agreement.created_at %></td>
+    <td><%= link_to 'Terminate', user_agreement, method: :delete, data: { confirm: 'User will be asked to accept the agreement again. Are you sure?' }, :class => "fine_print link" %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'Back', root_path, :class => "fine_print link" %>

data/app/views/fine_print/user_agreements/index.html.erb~

@@ -0,0 +1,25 @@
+<h1 class="fine_print heading">Accepted FinePrint agreements</h1>
+
+<table class="fine_print index">
+  <tr>
+    <th>User ID</th>
+    <th>Agreement name</th>
+    <th>Agreement version</th>
+    <th>Date accepted</th>
+    <th></th>
+  </tr>
+
+<% @user_agreements.each do |user_agreement| %>
+  <tr>
+    <td><%= user_agreement.user.id %></td>
+    <td><%= user_agreement.agreement.name %></td>
+    <td><%= user_agreement.agreement.version %></td>
+    <td><%= user_agreement.created_at %></td>
+    <td><%= link_to 'Terminate', user_agreement, method: :delete, data: { confirm: 'Are you sure? User will be asked to accept the agreement again.' }, :class => "fine_print link" %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'Back', root_path, :class => "fine_print link" %>

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

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

data/config/initializers/fine_print.rb

@@ -0,0 +1,53 @@
+# Change the settings below to suit your needs
+# All settings are initially set to their default values
+FinePrint.configure do |config|
+
+  # Engine Options (initializer only)
+
+  # Name of the ApplicationController helper method that returns the current user
+  # Default: "current_user"
+  config.current_user_method = "current_user"
+
+  # Proc called with user as argument that should return true if and only if the user is an admin
+  # Admins can create and edit agreements and terminate accepted agreements
+  # Default: lambda { |user| false } (no admins)
+  config.user_admin_proc = lambda { |user| false }
+
+  # Path to redirect users to when an error occurs (e.g. permission denied on admin pages)
+  # Default: "/"
+  config.redirect_path = "/"
+
+  # Path to link users to if they need to sign in
+  # Set to nil to disable the link
+  # Default: "/"
+  config.sign_in_path = "/"
+
+
+
+  # Agreement Options (initializer or inline)
+
+  # Message to be displayed to the user explaining that they need to accept an agreement
+  # Set to nil to disable
+  # Default: "You must accept the following agreement to proceed."
+  config.agreement_notice = "You must accept the following agreement to proceed."
+
+  # Path to redirect users to when an agreement is accepted and referer information is unavailable
+  # Default: "/"
+  config.accept_path = "/"
+
+  # Path to redirect users to when an agreement is not accepted and referer information is unavailable
+  # Default: "/"
+  config.cancel_path = "/"
+
+  # Whether to use referer information to redirect users after (not) accepting an agreement
+  # Default: true
+  config.use_referers = true
+
+  # If set to true, modal jQuery UI dialogs will be used instead of redirecting the user to the agreement page
+  # Note: users with javascript disabled will not even see the agreement and will be able to proceed without accepting it
+  #       if users are not supposed to ever see or interact with a certain page without accepting the agreement,
+  #       disable this option for that particular controller action
+  # Default: false
+  config.use_modal_dialogs = false
+  
+end

data/config/initializers/fine_print.rb~

@@ -0,0 +1,53 @@
+# Change the settings below to suit your needs
+# All settings are initially set to their default values
+FinePrint.configure do |config|
+
+  # Engine Options (initializer only)
+
+  # Name of the ApplicationController helper method that returns the current user
+  # Default: "current_user"
+  config.current_user_method = "current_user"
+
+  # Proc called with user as argument that should return true if and only if the user is an admin
+  # Admins can create and edit agreements and terminate accepted agreements
+  # Default: lambda { |user| false } (no admins)
+  config.user_admin_proc = lambda { |user| false }
+
+  # Path to redirect users to when an error occurs (e.g. permission denied on admin pages)
+  # Default: "/"
+  config.redirect_path = "/"
+
+  # Path to link users to if they need to sign in
+  # Set to nil to disable the link
+  # Default: "/"
+  config.sign_in_path = "/"
+
+
+
+  # Agreement Options (initializer or inline)
+
+  # Message to be displayed to the user explaining that they need to accept an agreement
+  # Set to nil to disable
+  # Default: "You must accept the following agreement to proceed."
+  config.agreement_notice = "You must accept the following agreement to proceed."
+
+  # Path to redirect users to when an agreement is accepted and referer information is unavailable
+  # Default: "/"
+  config.accept_path = "/"
+
+  # Path to redirect users to when an agreement is not accepted and referer information is unavailable
+  # Default: "/"
+  config.cancel_path = "/"
+
+  # Whether to use referer information to redirect users after (not) accepting an agreement
+  # Default: true
+  config.use_referers = true
+
+  # If set to true, modal jQuery UI dialogs will be used instead of redirecting the user to the agreement page
+  # Note: users with javascript disabled will not even see the agreement and will be able to proceed without accepting it
+  #       if users are not supposed to ever see or interact with a certain page without accepting the agreement,
+  #       disable this option for that particular controller action
+  # Default: false
+  config.use_modal_dialogs = false
+  
+end

data/config/routes.rb

@@ -0,0 +1,7 @@
+FinePrint::Engine.routes.draw do
+  resources :agreements do
+    get :new_version
+  end
+  resources :user_agreements, :only => [:index, :create, :destroy]
+  root :to => 'home#index'
+end

data/config/routes.rb~

@@ -0,0 +1,7 @@
+FinePrint::Engine.routes.draw do
+  resources :agreements do
+    get :new_version
+  end
+  resources :user_agreements, :only => [:index, :create, :destroy]
+  root :to => 'agreements#index'
+end

data/db/migrate/0_create_fine_print_agreements.rb~

@@ -0,0 +1,22 @@
+class CreateFinePrintAgreements < ActiveRecord::Migration
+  def change
+    create_table :fine_print_agreements do |t|
+      t.string :name
+      t.text :content
+      t.integer :version
+
+      t.timestamps
+    end
+
+    create_table :fine_print_user_agreements do |t|
+      t.integer :user_id
+      t.integer :agreement_id
+
+      t.timestamps
+    end
+
+    add_index :fine_print_agreements, [:name, :version]
+    add_index :fine_print_user_agreements, [:user_id, :agreement_id]
+    add_index :fine_print_user_agreements, :agreement_id
+  end
+end

data/db/migrate/0_install.rb

@@ -0,0 +1,28 @@
+class Install < ActiveRecord::Migration
+  def change
+    create_table :fine_print_agreements do |t|
+      t.string :name, :null => false
+      t.integer :version, :null => false
+      t.text :content, :null => false
+      t.string :confirmation_text, :default => 'I have read and agree to the terms and conditions above', :null => false
+      t.boolean :display_name, :default => true
+      t.boolean :display_version, :default => false
+      t.boolean :display_updated, :default => false
+      t.boolean :display_confirmation, :default => true
+      t.boolean :ready, :default => false
+
+      t.timestamps
+    end
+
+    create_table :fine_print_user_agreements do |t|
+      t.integer :agreement_id, :null => false
+      t.references :user, :polymorphic => true, :null => false
+
+      t.timestamps
+    end
+
+    add_index :fine_print_agreements, [:name, :version]
+    add_index :fine_print_user_agreements, :agreement_id
+    add_index :fine_print_user_agreements, [:user_id, :user_type, :agreement_id], :name => 'index_fine_print_u_a_on_u_id_and_u_type_and_a_id'
+  end
+end

data/db/migrate/0_install.rb~

@@ -0,0 +1,28 @@
+class Install < ActiveRecord::Migration
+  def change
+    create_table :fine_print_agreements do |t|
+      t.string :name, :null => false
+      t.integer :version, :null => false
+      t.text :content, :null => false
+      t.string :confirmation_text, :default => 'I have read and agree to the terms and conditions above', :null => false
+      t.boolean :display_name, :default => true
+      t.boolean :display_version, :default => false
+      t.boolean :display_updated, :default => false
+      t.boolean :display_confirmation, :default => true
+      t.boolean :ready, :default => false
+
+      t.timestamps
+    end
+
+    create_table :fine_print_user_agreements do |t|
+      t.integer :agreement_id, :null => false
+      t.references :user, :polymorphic => true
+
+      t.timestamps
+    end
+
+    add_index :fine_print_agreements, [:name, :version]
+    add_index :fine_print_user_agreements, :agreement_id
+    add_index :fine_print_user_agreements, [:user_id, :user_type, :agreement_id], :name => 'index_fine_print_u_a_on_u_id_and_u_type_and_a_id'
+  end
+end

data/lib/fine_print/agreements_helper.rb

@@ -0,0 +1,13 @@
+module FinePrint
+  module AgreementsHelper
+    def fine_print_dialog(options = {})
+      render :partial => 'fine_print/agreements/dialog',
+             :locals => {:agreements => @fine_print_dialog_agreements,
+                         :user => @fine_print_user,
+                         :notice => @fine_print_dialog_notice,
+                         :width => options[:width],
+                         :height => options[:height]} \
+      unless @fine_print_dialog_agreements.blank?
+    end
+  end
+end

data/lib/fine_print/agreements_helper.rb~

@@ -0,0 +1,11 @@
+module FinePrint
+  module AgreementsHelper
+    def fine_print_dialog(options = {})
+      render :partial => 'fine_print/agreements/dialog',
+             :locals => {:agreements => @fine_print_dialog_agreements,
+                         :user => @fine_print_user,
+                         :notice => @fine_print_dialog_notice} \
+      unless @fine_print_dialog_agreements.blank?
+    end
+  end
+end

data/lib/fine_print/engine.rb

@@ -0,0 +1,5 @@
+module FinePrint
+  class Engine < ::Rails::Engine
+    isolate_namespace FinePrint
+  end
+end

data/lib/fine_print/fine_print_agreement.rb

@@ -0,0 +1,26 @@
+require 'fine_print/agreements_helper'
+
+module FinePrint
+  module FinePrintAgreement
+    def self.included(base)
+      base.helper FinePrint::AgreementsHelper
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def fine_print_agreement(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        class_eval do
+          before_filter(options.except(*FinePrint::AGREEMENT_OPTIONS)) do |controller|
+            FinePrint.require_agreements(controller, args, options.slice(*FinePrint::AGREEMENT_OPTIONS))
+          end
+        end
+      end
+
+      alias_method :fine_print_agreements, :fine_print_agreement
+    end
+  end
+end
+
+ActionController::Base.send :include, FinePrint::FinePrintAgreement
+