fine_print 2.3.1 → 3.0.0

data/app/models/fine_print/signature.rb

@@ -1,13 +1,13 @@
 module FinePrint
   class Signature < ActiveRecord::Base
-    belongs_to :contract, :inverse_of => :signatures
-    belongs_to :user, :polymorphic => true
+    belongs_to :contract, inverse_of: :signatures
+    belongs_to :user, polymorphic: true
 
-    validate :contract_published, :on => :create
+    validate :contract_published, on: :create
 
-    validates :contract, :presence => true
-    validates :contract_id, :uniqueness => {:scope => [:user_type, :user_id]}
-    validates :user, :presence => true
+    validates :contract, presence: true
+    validates :contract_id, uniqueness: { scope: [:user_type, :user_id] }
+    validates :user, presence: true
 
     default_scope { order(:contract_id, :user_type, :user_id) }
 
@@ -19,8 +19,9 @@ module FinePrint
 
     def contract_published
       return if contract.is_published?
-      errors.add(:contract, I18n.t(
-        'fine_print.signature.errors.contract.not_published'))
+      errors.add(
+        :contract, I18n.t('fine_print.signature.errors.contract.not_published')
+      )
       false
     end
   end

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

@@ -1,4 +1,4 @@
-<%= form_for(@contract, :html => {:class => 'fine_print'}) do |f| %>
+<%= form_for(@contract, html: { class: 'fine_print' }) do |f| %>
   <% if @contract.errors.any? %>
     <div id='error_explanation' class='fine_print errors'>
       <h4 class='fine_print heading'>
@@ -14,27 +14,27 @@
   <% end %>
 
   <div class='field'>
-    <%= f.label :name, :class => 'fine_print' %>
-    <%= f.text_field :name, :size => 40, :class => 'fine_print text_field' %>
+    <%= f.label :name, class: 'fine_print' %>
+    <%= f.text_field :name, size: 40, class: 'fine_print text_field' %>
     <div class='fine_print field_description'>
       <%= t 'fine_print.contract.descriptions.name' %>
     </div>
   </div>
   <div class='field'>
-    <%= f.label :title, :class => 'fine_print' %>
-    <%= f.text_field :title, :size => 40, :class => 'fine_print text_field' %>
+    <%= f.label :title, class: 'fine_print' %>
+    <%= f.text_field :title, size: 40, class: 'fine_print text_field' %>
     <div class='fine_print field_description'>
       <%= t 'fine_print.contract.descriptions.title' %>
     </div>
   </div>
   <div class='field'>
-    <%= f.label :content, :class => 'fine_print' %>
-    <%= f.text_area :content, :cols => 56, :class => 'fine_print text_area' %>
+    <%= f.label :content, class: 'fine_print' %>
+    <%= f.text_area :content, cols: 56, class: 'fine_print text_area' %>
   </div>
 
   <br>
 
   <div class='actions'>
-    <%= f.submit nil, :class => 'fine_print submit' %>
+    <%= f.submit nil, class: 'fine_print submit' %>
   </div>
 <% end %>

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

@@ -8,8 +8,8 @@
 
   <div class='fine_print links'>
     <%= link_to t('fine_print.contract.actions.show'), @contract,
-                :class => 'fine_print link' %> |
+                class: 'fine_print link' %> |
     <%= link_to t('fine_print.contract.actions.list'), contracts_path,
-                :class => 'fine_print link' %>
+                class: 'fine_print link' %>
   </div>
 </div>

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

@@ -12,30 +12,53 @@
       
         <ul class='fine_print'>
           <% contracts.each do |contract| %>
-            <li><%= link_to contract.title, contract, :class => 'fine_print link' %> 
-              (<%= contract.version.nil? ? t('fine_print.contract.status.draft') : \
-                   t('fine_print.contract.status.version', version: contract.version.to_s) %>)
+            <li><%= link_to contract.title, contract, class: 'fine_print link' %>
+              (<%= contract.version.nil? ? \
+                   t('fine_print.contract.status.draft') : \
+                   t('fine_print.contract.status.version',
+                     version: contract.version.to_s) %>)
               <% if contract.signatures.empty? %>
                 [<%= link_to t('fine_print.contract.actions.edit'),
-                             edit_contract_path(contract), :class => 'fine_print link' %>]
+                             edit_contract_path(contract),
+                             class: 'fine_print link' %>]
                 <% if contract.is_published? %>
-                  [<%= link_to t('fine_print.contract.actions.unpublish'),
-                               unpublish_contract_path(contract), :method => :put,
-                               :data => {:confirm => t('fine_print.contract.actions.confirm.unpublish')}, :class => 'fine_print link' %>]
+                  [<%= link_to(
+                    t('fine_print.contract.actions.unpublish'),
+                    unpublish_contract_path(contract),
+                    method: :put,
+                    data: {
+                      confirm: t('fine_print.contract.actions.confirm.unpublish')
+                    },
+                    class: 'fine_print link'
+                  ) %>]
                 <% else %>
-                  [<%= link_to t('fine_print.contract.actions.publish'),
-                               publish_contract_path(contract), :method => :put,
-                               :data => {:confirm => t('fine_print.contract.actions.confirm.publish')}, :class => 'fine_print link' %>]
+                  [<%= link_to(
+                    t('fine_print.contract.actions.publish'),
+                    publish_contract_path(contract),
+                    method: :put,
+                    data: {
+                      confirm: t('fine_print.contract.actions.confirm.publish')
+                    },
+                    class: 'fine_print link'
+                  ) %>]
                 <% end %>
-                [<%= link_to t('fine_print.contract.actions.delete'), contract,
-                             :method => :delete, :data => {:confirm => t('fine_print.contract.actions.confirm.delete')}, :class => 'fine_print link' %>]
+                [<%= link_to(
+                  t('fine_print.contract.actions.delete'),
+                  contract,
+                  method: :delete,
+                    data: {
+                      confirm: t('fine_print.contract.actions.confirm.delete')
+                    },
+                  class: 'fine_print link'
+                ) %>]
               <% else %>
                 [<%= link_to t('fine_print.contract.actions.new_version'),
-                             new_version_contract_path(contract), :method => :post,
-                             :class => 'fine_print link' %>]
+                             new_version_contract_path(contract),
+                             method: :post,
+                             class: 'fine_print link' %>]
                 [<%= link_to t('fine_print.contract.actions.signatures'),
                              contract_signatures_path(contract),
-                             :class => 'fine_print link' %>]
+                             class: 'fine_print link' %>]
               <% end %>
             </li>
           <% end %>
@@ -46,7 +69,7 @@
   <% end %>
 
   <div class='fine_print links'>
-    <%= link_to 'New Contract', new_contract_path, :class => 'fine_print link' %>
+    <%= link_to 'New Contract', new_contract_path, class: 'fine_print link' %>
   </div>
 
 </div>

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

@@ -6,6 +6,8 @@
   <br>
 
   <div class='fine_print links'>
-    <%= link_to t('fine_print.contract.actions.list'), contracts_path, :class => 'fine_print link' %>
+    <%= link_to t('fine_print.contract.actions.list'),
+                contracts_path,
+                class: 'fine_print link' %>
   </div>
 </div>

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

@@ -1,5 +1,7 @@
-<h1 class='fine_print heading'><%= t('fine_print.contract.actions.new_version_of',
-                                     contract: @contract.name) %></h1>
+<h1 class='fine_print heading'>
+  <%= t('fine_print.contract.actions.new_version_of',
+      contract: @contract.name) %>
+</h1>
 
 <div class='fine_print new_contract_version'>
   <%= render 'form' %>
@@ -7,7 +9,8 @@
   <br>
 
   <div class='fine_print links'>
-    <%= link_to t('fine_print.contract.actions.list'), contracts_path,
-                :class => 'fine_print link' %>
+    <%= link_to t('fine_print.contract.actions.list'),
+                contracts_path,
+                class: 'fine_print link' %>
   </div>
 </div>

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

@@ -2,37 +2,52 @@
 
 <br>
 
-<h4 class='fine_print heading'><%= t('fine_print.contract.status.name', name: @contract.name) %></h4>
+<h4 class='fine_print heading'><%= t('fine_print.contract.status.name',
+                                   name: @contract.name) %></h4>
 
-<%= render :partial => 'show', :locals => {:contract => @contract} %>
+<%= render partial: 'show', locals: { contract: @contract } %>
 
 <br>
 
 <div class='fine_print links'>
   <% if @contract.signatures.empty? %>
-    <%= link_to t('fine_print.contract.actions.edit'), edit_contract_path(@contract),
-                :class => 'fine_print link' %> |
+    <%= link_to t('fine_print.contract.actions.edit'),
+                edit_contract_path(@contract),
+                class: 'fine_print link' %> |
       <% if @contract.is_published? %>
         <%= link_to t('fine_print.contract.actions.unpublish'),
-                    unpublish_contract_path(@contract), :method => :put, :data => {
-                      :confirm => t('fine_print.contract.actions.confirm.unpublish')},
-                    :class => 'fine_print link' %>
+                    unpublish_contract_path(@contract),
+                    method: :put,
+                    data: {
+                      confirm: t('fine_print.contract.actions.confirm.unpublish')
+                    },
+                    class: 'fine_print link' %>
       <% else %>
         <%= link_to t('fine_print.contract.actions.publish'),
-                    publish_contract_path(@contract), :method => :put, :data => {
-                      :confirm => t('fine_print.contract.actions.confirm.publish')},
-                    :class => 'fine_print link' %> |
+                    publish_contract_path(@contract),
+                    method: :put,
+                    data: {
+                      confirm: t('fine_print.contract.actions.confirm.publish')
+                    },
+                    class: 'fine_print link' %> |
       <% end %>
-      <%= link_to t('fine_print.contract.actions.delete'), @contract, :method => :delete,
-                  :data => {:confirm => t('fine_print.contract.actions.confirm.delete')},
-                  :class => 'fine_print link' %>
+      <%= link_to t('fine_print.contract.actions.delete'),
+                  @contract,
+                  method: :delete,
+                  date: {
+                    confirm: t('fine_print.contract.actions.confirm.delete')
+                  },
+                  class: 'fine_print link' %>
   <% else %>
     <%= link_to t('fine_print.contract.actions.new_version'),
-                new_version_contract_path(@contract), :method => :post,
-                :class => 'fine_print link' %> |
+                new_version_contract_path(@contract),
+                method: :post,
+                class: 'fine_print link' %> |
     <%= link_to t('fine_print.contract.actions.signatures'),
-                contract_signatures_path(@contract), :class => 'fine_print link' %>
+                contract_signatures_path(@contract),
+                class: 'fine_print link' %>
   <% end %>
-  | <%= link_to t('fine_print.contract.actions.list'), contracts_path,
-                :class => 'fine_print link' %>
+  | <%= link_to t('fine_print.contract.actions.list'),
+                contracts_path,
+                class: 'fine_print link' %>
 </div>

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

@@ -1,4 +1,4 @@
-<%= form_for([@contract, @signature], :html => {:class => 'fine_print'}) do |f| %>
+<%= form_for([@contract, @signature], html: { class: 'fine_print' }) do |f| %>
   <% if @signature.errors.any? %>
     <div id='error_explanation' class='fine_print errors'>
       <h4 class='fine_print heading'>
@@ -14,13 +14,16 @@
   <% end %>
 
   <div class='field'>
-    <%= f.label :accept, t('fine_print.signature.actions.accept'), :class => 'fine_print' %>
-    <%= check_box_tag :signature_accept, :class => 'fine_print check_box' %>
+    <%= f.label :accept,
+                t('fine_print.signature.actions.accept'),
+                class: 'fine_print' %>
+    <%= check_box_tag :signature_accept, class: 'fine_print check_box' %>
   </div>
 
   <br>
 
   <div class='actions'>
-    <%= f.submit t('fine_print.signature.actions.sign'), :class => 'fine_print submit' %>
+    <%= f.submit t('fine_print.signature.actions.sign'),
+                 class: 'fine_print submit' %>
   </div>
 <% end %>

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

@@ -1,7 +1,11 @@
 <h1 class='fine_print heading'>
-  <%= t('fine_print.signature.status.for_contract', contract: link_to(
-        "#{@contract.title} #{t('fine_print.contract.status.version',
-                                version: @contract.version.to_s)}", @contract)).html_safe %>
+  <%= t('fine_print.signature.status.for_contract',
+        contract: link_to(
+          "#{@contract.title} #{t('fine_print.contract.status.version',
+                                version: @contract.version.to_s)}",
+          @contract
+        )
+      ).html_safe %>
 </h1>
 
 <div class='fine_print signature_index'>
@@ -19,11 +23,15 @@
       <td><%= signature.user_type %>&nbsp;</td>
       <td>&nbsp;<%= signature.user_id %>&nbsp;</td>
       <td>&nbsp;<%= l signature.created_at, format: :fine_print %>&nbsp;</td>
-      <td>&nbsp;<%= link_to t('fine_print.signature.actions.delete'), 
-                            signature, :method => :delete, 
-                            :data => { 
-                              :confirm => t('fine_print.signature.actions.confirm.delete')
-                            }, :class => 'fine_print link' %>
+      <td>&nbsp;<%= link_to(
+                      t('fine_print.signature.actions.delete'), 
+                      signature,
+                      method: :delete, 
+                      data: { 
+                        confirm: t('fine_print.signature.actions.confirm.delete')
+                      }
+                      class: 'fine_print link'
+                    ) %>
       </td>
     </tr>
   <% end %>
@@ -33,7 +41,7 @@
 
   <div class='fine_print links'>
     <%= link_to t('fine_print.contract.actions.list'), contracts_path,
-                :class => 'fine_print link' %>
+                class: 'fine_print link' %>
   </div>
   
 </div>

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

@@ -1,13 +1,15 @@
 <% if FinePrint.signed_any_version_of_contract?(@user, @contract) %>
   <div class='fine_print notice'>
-    <h4 class='fine_print heading'><%= t('fine_print.signature.status.new_version',
-                                         contract: @contract.title) %></h4>
+    <h4 class='fine_print heading'>
+      <%= t('fine_print.signature.status.new_version',
+            contract: @contract.title) %>
+    </h4>
   </div>
 <% end %>
 
 <div class='fine_print contract'>
-  <%= render :partial => 'fine_print/contracts/show',
-             :locals => {:contract => @contract} %>
+  <%= render partial: 'fine_print/contracts/show',
+             locals: { contract: @contract } %>
 </div>
 
 <div class='fine_print new_signature'>

data/config/initializers/fine_print.rb

@@ -1,57 +1,60 @@
-# Change the settings below to suit your needs
-# All options are initially set to their default values
 FinePrint.configure do |config|
 
-  # Engine Configuration
-  # Must be set in an initializer
+  # Engine Configuration: Must be set in an initializer
 
-  # Proc called with a controller as self.
-  # Returns the current user.
+  # Layout to be used for FinePrint's controllers
+  # Default: 'application'
+  config.layout = 'application'
+
+  # Array of custom helpers for FinePrint's controllers
+  # Default: [] (no custom helpers)
+  config.helpers = []
+
+  # Proc called with a controller as self. Returns the current user.
   # Default: lambda { current_user }
   config.current_user_proc = lambda { current_user }
 
   # Proc called with a user as argument and a controller as self.
   # This proc is called when a user tries to access FinePrint's controllers.
-  # Should raise and exception, render or redirect unless the user can manage contracts.
-  # Contract managers can create and edit agreements and terminate accepted agreements.
-  # The default renders 403 Forbidden for all users.
+  # Should raise and exception, render or redirect unless the user is a manager
+  # or admin. Contract managers can create and edit agreements and terminate
+  # accepted agreements. The default renders 403 Forbidden for all users.
   # Note: Proc must account for nil users, if current_user_proc returns nil.
-  # Default: lambda { |user| false || head(:forbidden) }
-  config.can_manage_proc = lambda { |user| false || head(:forbidden) }
+  # Default: lambda { |user| head(:forbidden) }
+  config.authenticate_manager_proc = lambda { |user| head(:forbidden) }
 
   # Proc called with a user as argument and a controller as self.
-  # This proc is called to check that the given user is allowed to sign contracts.
-  # Should raise and exception, render or redirect unless the user can sign contracts.
-  # You might want to redirect users to a login page if they are not signed in.
-  # The default renders 401 Unauthorized for nil users.
+  # This proc is called before FinePrint determines if contracts need to be
+  # signed. If it returns true, FinePrint will proceed with its checks and
+  # potentially call the redirect_to_contracts_proc with the user as argument.
+  # If it returns false, renders or redirects, FinePrint will stop its checks.
+  # Note that returning false will allow the user to proceed without signing
+  # contracts, unless another before_filter renders or redirects (to a login
+  # page, for example). The default renders 401 Unauthorized for nil users and
+  # checks all others for contracts to be signed.
   # Default: lambda { |user| !user.nil? || head(:unauthorized) }
-  config.can_sign_proc = lambda { |user| !user.nil? || head(:unauthorized) }
-
-  # Layout to be used for FinePrint's controllers
-  # Default: 'application'
-  config.layout = 'application'
-
-  # Array of custom helpers for FinePrint's controllers
-  # Default: [] (no custom helpers)
-  config.helpers = []
+  config.authenticate_user_proc = lambda { |user| !user.nil? || \
+                                                  head(:unauthorized) }
 
   # Controller Configuration
-  # Can be set either in an initializer or passed as options to `fine_print_require`
+  # Can be set in this initializer or passed as options to `fine_print_require`
 
-  # Proc called with a user and an array of contract ids as arguments and a controller as self.
-  # This proc is called when a user tries to access a resource protected by FinePrint,
-  # but has not signed all the required contracts.
-  # Should raise and exception, render or redirect the user.
-  # The `contract_ids` variable contains the contract ids that need to be signed.
+  # Proc called with a user and an array of contracts as arguments and a
+  # controller as self. This proc is called when a user tries to access a
+  # resource protected by FinePrint, but has not signed all the required
+  # contracts. Should redirect the user, render or raise an exception.
+  # The `contracts` argument contains the contracts that need to be signed.
   # The default redirects users to FinePrint's contract signing views.
-  # The `fine_print_return` method can be used to return from a redirect made here.
-  # Default: lambda { |user, contract_ids|
+  # The `fine_print_return` method can be used to return from this redirect.
+  # Default: lambda { |user, contracts|
   #            redirect_to(fine_print.new_contract_signature_path(
-  #              :contract_id => contract_ids.first
+  #              contract_id: contracts.first.id
   #            ))
   #          }
-  config.must_sign_proc = lambda { |user, contract_ids| redirect_to(
-    fine_print.new_contract_signature_path(:contract_id => contract_ids.first)
-  ) }
+  config.redirect_to_contracts_proc = lambda { |user, contracts|
+    redirect_to(
+      fine_print.new_contract_signature_path(contract_id: contracts.first.id)
+    )
+  }
 
 end