fine_print 2.0.3 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28b2452c298f159a6bd4b338f64ab80d1dd0a4ed
-  data.tar.gz: 9b97e5a3483c1924278b704f7313b5d20ae99128
+  metadata.gz: 3c2040f491481de447b7827441b7521ede77b90d
+  data.tar.gz: 56a00a531867d1199de81bfab77331df64741f0b
 SHA512:
-  metadata.gz: 463b5c7a4c522fb7bff295d9d088a89aae45f8b1799b6f5eeb40f6e2963c37298d115c275ca0bed4c114c99bbeacb759b1214b91565447e1f0f4f0cab96420ae
-  data.tar.gz: c239a71ca6ee4a8c6495cd2bab5dbb9ac34ac50c74e58daaaf7c197629c5f00a89a55377c9010414f804829993c54dffbf3062568af543cd9f941dbe0c0f5e08
+  metadata.gz: f5ee1434ceb9b7c449b05eda5e926fdebb689b2451f60b43f0a36e9e42522e5b5853867b1da6bbaeafe3a8ed389d0d8d4d8677e1522304215e440ea5b76b1215
+  data.tar.gz: 1f782cd57f57cd7a7c5f7d1079024a3bb9aa982db5e6fb25d9f203af41af0269356c1437c7ba500a164449436eb653e7993e096940f94719faed16616ca7e792

data/app/controllers/fine_print/application_controller.rb

@@ -4,6 +4,10 @@ module FinePrint
 
     before_filter :get_user, :can_manage
 
+    layout FinePrint.layout
+
+    helper FinePrint.helpers
+
     protected
 
     def get_user

data/app/controllers/fine_print/contracts_controller.rb

@@ -19,7 +19,7 @@ module FinePrint
       @contract.content = params[:contract][:content]
   
       if @contract.save
-        redirect_to @contract, :notice => 'Contract was successfully created.'
+        redirect_to @contract, :notice => t('fine_print.contract.notices.created')
       else
         render :action => 'new', :alert => merge_errors_for(@contract)
       end
@@ -40,7 +40,7 @@ module FinePrint
       @contract.content = params[:contract][:content]
 
       if @contract.save
-        redirect_to @contract, :notice => 'Contract was successfully updated.'
+        redirect_to @contract, :notice => t('fine_print.contract.notices.updated')
       else
         render :action => 'edit', :alert => merge_errors_for(@contract)
       end
@@ -48,7 +48,7 @@ module FinePrint
 
     def destroy
       if @contract.destroy
-        redirect_to contracts_path, :notice => 'Contract was successfully deleted.'
+        redirect_to contracts_path, :notice => t('fine_print.contract.notices.deleted')
       else
         redirect_to contracts_path, :alert => merge_errors_for(@contract)
       end
@@ -56,7 +56,7 @@ module FinePrint
 
     def publish
       if @contract.publish
-        redirect_to contracts_path, :notice => 'Contract was successfully published.'
+        redirect_to contracts_path, :notice => t('fine_print.contract.notices.published')
       else
         redirect_to contracts_path, :alert => merge_errors_for(@contract)
       end
@@ -64,7 +64,7 @@ module FinePrint
 
     def unpublish
       if @contract.unpublish
-        redirect_to contracts_path, :notice => 'Contract was successfully unpublished.'
+        redirect_to contracts_path, :notice => t('fine_print.contract.notices.unpublished')
       else
         redirect_to contracts_path, :alert => merge_errors_for(@contract)
       end

data/app/controllers/fine_print/signatures_controller.rb

@@ -20,7 +20,7 @@ module FinePrint
       @signature = Signature.new
 
       unless params[:signature_accept]
-        @signature.errors.add(:contract, 'must be accepted to proceed')
+        @signature.errors.add(:contract, t('fine_print.signature.errors.contract.must_agree'))
         render :action => 'new'
         return
       end
@@ -40,7 +40,7 @@ module FinePrint
 
       @signature.destroy
       redirect_to contract_signatures_path(@signature.contract),
-                  :notice => 'Signature was successfully deleted.'
+                  :notice => t('fine_print.signature.notices.deleted')
     end
 
     protected

data/app/models/fine_print/contract.rb

@@ -30,7 +30,8 @@ module FinePrint
     end
 
     def publish
-      errors.add(:base, 'Contract is already published') if is_published?
+      errors.add(:base, I18n.t('fine_print.contract.errors.already_published')) \
+        if is_published?
       return false unless errors.empty?
 
       self.version = (same_name.published.first.try(:version) || 0) + 1
@@ -38,7 +39,8 @@ module FinePrint
     end
 
     def unpublish
-      errors.add(:base, 'Contract is not the latest published version') unless is_latest?
+      errors.add(:base, I18n.t('fine_print.contract.errors.not_latest')) \
+        unless is_latest?
       return false unless errors.empty?
 
       self.version = nil
@@ -56,7 +58,7 @@ module FinePrint
 
     def no_signatures
       return if signatures.empty?
-      errors.add(:base, 'Contract cannot be modified because users have signed it')
+      errors.add(:base, I18n.t('fine_print.contract.errors.already_signed'))
       false
     end
 

data/app/models/fine_print/signature.rb

@@ -19,7 +19,8 @@ module FinePrint
 
     def contract_published
       return if contract.is_published?
-      errors.add(:contract, 'needs to be published before it can be signed')
+      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,7 +1,9 @@
 <%= form_for(@contract, :html => {:class => 'fine_print'}) do |f| %>
   <% if @contract.errors.any? %>
     <div id='error_explanation' class='fine_print errors'>
-      <h2 class='fine_print heading'><%= pluralize(@contract.errors.count, 'error') %> prohibited this contract from being saved:</h2>
+      <h4 class='fine_print heading'>
+        <%= t 'fine_print.error', count: @contract.errors.count %>
+      </h4>
 
       <ul>
       <% @contract.errors.full_messages.each do |msg| %>
@@ -14,21 +16,24 @@
   <div class='field'>
     <%= f.label :name, :class => 'fine_print' %>
     <%= f.text_field :name, :size => 40, :class => 'fine_print text_field' %>
-    <div class='fine_print field_help'>
-      used internally by your code, only letters, numbers, underscores; changing this will start a new contract with new version counts
+    <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' %>
-    <div class='fine_print field_help'>
-      e.g., 'Terms of Use'
+    <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' %>
   </div>
+
+  <br>
+
   <div class='actions'>
     <%= f.submit nil, :class => 'fine_print submit' %>
   </div>

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

@@ -1,10 +1,12 @@
 <%# Clients of this partial must provide the following variable:
     contract %>
 
-<h2 class='fine_print heading'><%= contract.title %> <%= @contract.version ? \
-  "(v.#{@contract.version})" : 'Draft' %></h2>
+<h2 class='fine_print heading'><%= contract.title %> (<%= contract.version ? \
+  t('fine_print.contract.status.version', version: contract.version.to_s) : \
+  t('fine_print.contract.status.draft') %>)</h2>
 
-<h4 class='fine_print heading'>Last updated: <%= contract.updated_at %></h4>
+<h4 class='fine_print heading'><%= t('fine_print.contract.status.updated_at', \
+  updated_at: l(contract.updated_at, format: :fine_print)) %></h4>
 
 <div class='fine_print contract'>
   <pre><%= @contract.content.html_safe %></pre>

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

@@ -1,10 +1,15 @@
-<h1 class='fine_print heading'>Editing Contract</h1>
+<h1 class='fine_print heading'><%= t 'fine_print.contract.actions.editing',
+                                     contract: @contract.title.to_s %></h1>
 
 <div class='fine_print edit_contract'>
   <%= render 'form' %>
 
+  <br>
+
   <div class='fine_print links'>
-    <%= link_to 'Show', @contract, :class => 'fine_print link' %> |
-    <%= link_to 'List', contracts_path, :class => 'fine_print link' %>
+    <%= link_to t('fine_print.contract.actions.show'), @contract,
+                :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/index.html.erb

@@ -1,4 +1,4 @@
-<h1 class='fine_print heading'>FinePrint Contracts</h1>
+<h1 class='fine_print heading'><%= t 'fine_print.contract.status.index' %></h1>
 
 <div class='fine_print contract_index'>
 
@@ -12,19 +12,30 @@
       
         <ul class='fine_print'>
           <% contracts.each do |contract| %>
-            <li><%= link_to contract.title, contract %> 
-              (<%= contract.version.nil? ? 'draft' : "v.#{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 '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 'Unpublish', unpublish_contract_path(contract), :method => :put, :data => {:confirm => 'Are you sure you want to unpublish this contract?'} %>]
+                  [<%= 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 'Publish', publish_contract_path(contract), :method => :put, :data => {:confirm => 'Are you sure you want to publish this contract?'} %>]
+                  [<%= 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 'Delete', contract, :method => :delete, :data => {:confirm => 'Are you sure you wish to delete this contract?'}, :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 'New version', new_version_contract_path(contract), :method => :post %>]
-                [<%= link_to 'Signatures', contract_signatures_path(contract) %>]
+                [<%= link_to t('fine_print.contract.actions.new_version'),
+                             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' %>]
               <% end %>
             </li>
           <% end %>

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

@@ -1,9 +1,11 @@
-<h1 class='fine_print heading'>New Contract</h1>
+<h1 class='fine_print heading'><%= t('fine_print.contract.actions.new') %></h1>
 
 <div class='fine_print new_contract'>
   <%= render 'form' %>
 
+  <br>
+
   <div class='fine_print links'>
-    <%= link_to '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,9 +1,13 @@
-<h1 class='fine_print heading'>New Version of <%= @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' %>
 
+  <br>
+
   <div class='fine_print links'>
-    <%= link_to '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

@@ -1,22 +1,38 @@
-<h1 class='fine_print heading'>Contract Details</h1>
+<h1 class='fine_print heading'><%= t('fine_print.contract.actions.show') %></h1>
 
-<h4 class='fine_print heading'>Name: <%= @contract.name %></h4>
+<br>
+
+<h4 class='fine_print heading'><%= t('fine_print.contract.status.name', name: @contract.name) %></h4>
 
 <%= render :partial => 'show', :locals => {:contract => @contract} %>
 
+<br>
+
 <div class='fine_print links'>
   <% if @contract.signatures.empty? %>
-    <%= link_to '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 'Unpublish', unpublish_contract_path(@contract), :method => :put, :data => {:confirm => 'Are you sure you want to unpublish this contract?'} %>
+        <%= 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 'Publish', publish_contract_path(@contract), :method => :put, :data => {:confirm => 'Are you sure you want to publish this contract?'} %> |
+        <%= 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 'Delete', @contract, :method => :delete, :data => {:confirm => 'Are you sure you wish to delete this contract?'}, :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 'New version', new_version_contract_path(@contract), :method => :post %> |
-    <%= link_to 'Signatures', contract_signatures_path(@contract),
-                              :class => 'fine_print link' %>
+    <%= link_to t('fine_print.contract.actions.new_version'),
+                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' %>
   <% end %>
-  | <%= link_to '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,7 +1,9 @@
 <%= 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'>Error:</h4>
+      <h4 class='fine_print heading'>
+        <%= t 'fine_print.error', count: @signature.errors.count %>
+      </h4>
 
       <ul>
         <% @signature.errors.full_messages.each do |msg| %>
@@ -12,10 +14,13 @@
   <% end %>
 
   <div class='field'>
-    <%= f.label :accept, 'I have read and accept the terms above.', :class => 'fine_print' %>
+    <%= 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 'I agree', :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,32 +1,39 @@
-<h1 class='fine_print heading'>Signatures for <%= link_to "#{@contract.title} (v.#{@contract.version})", @contract %></h1>
+<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 %>
+</h1>
 
 <div class='fine_print signature_index'>
 
   <table class='fine_print top_heading index'>
     <tr class='fine_print heading-row'>
-      <th>User ID</th>
-      <th>Date accepted</th>
-      <th></th>
+      <th><%= t 'activerecord.attributes.fine_print/signature.user_type' %>&nbsp;</th>
+      <th>&nbsp;<%= t 'activerecord.attributes.fine_print/signature.user_id' %>&nbsp;</th>
+      <th>&nbsp;<%= t 'activerecord.attributes.fine_print/signature.created_at' %>&nbsp;</th>
+      <th>&nbsp;</th>
     </tr>
 
   <% @signatures.each do |signature| %>
     <tr class='fine_print data-row <%= cycle('even', 'odd') %>'>
-      <td><%= signature.user.id %></td>
-      <td><%= signature.created_at %></td>
-      <td><%= link_to 'Terminate', 
-                      signature, 
-                      :method => :delete, 
-                      :data => { 
-                        :confirm => 'User will be asked to accept the contract again. Are you sure?' 
-                      }, 
-                      :class => 'fine_print link' %>
+      <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>
     </tr>
   <% end %>
   </table>
 
+  <br>
+
   <div class='fine_print links'>
-    <%= link_to '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/signatures/new.html.erb

@@ -1,3 +1,10 @@
+<% 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>
+  </div>
+<% end %>
+
 <div class='fine_print contract'>
   <%= render :partial => 'fine_print/contracts/show',
              :locals => {:contract => @contract} %>

data/config/initializers/fine_print.rb

@@ -3,6 +3,7 @@
 FinePrint.configure do |config|
 
   # Engine Configuration
+  # Must be set in an initializer
 
   # Proc called with a controller as self.
   # Returns the current user.
@@ -26,7 +27,16 @@ FinePrint.configure do |config|
   # 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 = []
+
   # Controller Configuration
+  # Can be set either in an 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,

data/config/locales/fine_print/en.yml

@@ -0,0 +1,89 @@
+--- 
+en: 
+  activerecord: 
+    attributes: 
+      fine_print/contract: 
+        name: Name
+        version: Version
+        title: Title
+        content: Content
+      fine_print/signature: 
+        contract: Contract
+        user: User
+        user_id: "User ID"
+        user_type: "User Class"
+        created_at: "Signed on"
+    errors:
+      models:
+        fine_print/signature:
+          attributes:
+            contract:
+              taken: "has already been signed"
+    models: 
+      fine_print/contract: 
+        one: contract
+        other: contracts
+      fine_print/signature: 
+        one: signature
+        other: signatures
+  fine_print: 
+    contract: 
+      actions: 
+        delete: Delete
+        edit: Edit
+        editing: "Editing %{contract}"
+        list: List
+        new: New Contract
+        new_version: "New Version"
+        new_version_of: "New version of %{contract}"
+        publish: Publish
+        signatures: Signatures
+        show: Details
+        unpublish: Unpublish
+        update: Update
+        confirm:
+          delete: "Are you sure you want to delete this contract?"
+          publish: "Are you sure you want to publish this contract?"
+          unpublish: "Are you sure you want to unpublish this contract?"
+      descriptions: 
+        name: "Used internally by your code; only letters, numbers, underscores allowed; changing this will start a new contract at version 1"
+        title: 'e.g., "Terms of Use"'
+      errors:
+        already_published: "cannot be published because it is already published"
+        already_signed: "cannot be modified because it has already been signed"
+        not_latest: "cannot be unpublished because it is not the latest version"
+      notices:
+        created: "Contract created."
+        deleted: "Contract deleted."
+        published: "Contract published."
+        unpublished: "Contract unpublished."
+        updated: "Contract updated."
+      status: 
+        draft: draft
+        index: Contracts
+        name: "Name: %{name}"
+        updated_at: "Last updated on %{updated_at}."
+        version: "v.%{version}"
+    signature: 
+      actions: 
+        accept: "I have read and accept the terms above."
+        delete: Terminate
+        sign: "I agree"
+        confirm:
+          delete: "User will be asked to accept the contract again. Are you sure?"
+      errors: 
+        contract: 
+          must_agree: "must be accepted to proceed"
+          not_published: "must be published before it can be signed"
+      notices:
+        deleted: "Signature deleted."
+      status:
+        for_contract: "Signatures for %{contract}"
+        new_version: "Please review and accept the newest version of the %{contract}:"
+    error:
+      one: "Error:"
+      other: "Errors:"
+  time: 
+    formats: 
+      fine_print: "%b %d %Y at %I:%M%p %Z"
+

data/lib/fine_print/engine.rb

@@ -17,5 +17,8 @@ module FinePrint
       g.assets false
       g.helper false
     end
+
+    # Load subfolders of config/locales as well
+    config.i18n.load_path += Dir[root.join('config', 'locales', '**', '*.{rb,yml}')]
   end
 end

data/lib/fine_print/version.rb

@@ -1,3 +1,3 @@
 module FinePrint
-  VERSION = '2.0.3'
+  VERSION = '2.1.1'
 end

data/lib/fine_print.rb

@@ -8,7 +8,9 @@ module FinePrint
   ENGINE_OPTIONS = [
     :current_user_proc,
     :can_manage_proc,
-    :can_sign_proc
+    :can_sign_proc,
+    :layout,
+    :helpers
   ]
 
   # Can be set in initializer or passed as an argument

data/lib/tasks/fine_print_tasks.rake

@@ -1,5 +1,4 @@
-FINE_PRINT_COPY_TASKS = ['assets/stylesheets',
-                         'views/layouts',
+FINE_PRINT_COPY_TASKS = ['config/locales',
                          'views',
                          'controllers']