fine_print 1.3.0 → 1.4.1

data/app/models/fine_print/contract.rb~

@@ -1,100 +0,0 @@
-module FinePrint
-  class Contract < ActiveRecord::Base
-    has_many :signatures, :inverse_of => :contract
-
-    has_many :same_name, :class_name => 'Contract', :primary_key => :name, :foreign_key => :name
-
-    before_validation :downcase_name
-    before_update :no_signatures
-    before_destroy :no_signatures
-
-    validates_presence_of :name, :title, :content
-    validates_format_of :name, :with => /\A\w+\z/
-    validates_uniqueness_of :version, :scope => :name, :case_sensitive => false
-
-    default_scope order(:name, 'version DESC')
-
-    scope :published, where(arel_table[:version].not_eq(nil))
-    scope :latest, published
-      .joins(:same_name)
-      .group(:id)
-      .having(:version => arel_table.alias(:same_names_fine_print_contracts)[:version]
-                          .maximum.tap{|mvq| mvq.alias = nil})
-
-    def is_published?
-      !version.nil?
-    end
-
-    def is_latest?
-      is_published? && version == same_name.maximum(:version)
-    end
-
-    def sign(user)
-      FinePrint.sign_contract(self, user)
-    end
-
-    def signed_by?(user)
-      FinePrint.signed_contract?(self, user)
-    end
-
-    def publish
-      no_signatures
-      errors.add(:base, 'Contract is already published') if is_published?
-      return false unless errors.empty?
-
-      self.version = (same_name.published.first.try(:version) || 0) + 1
-      save
-    end
-
-    def unpublish
-      no_signatures
-      errors.add(:base, 'Contract is not the latest published version') unless is_latest?
-      return false unless errors.empty?
-
-      self.version = nil
-      save
-    end
-
-    def draft_copy
-      Contract.where(:name => name, :version => nil).first || dup.tap{|contract| contract.version = nil}
-    end
-
-    ##################
-    # Access Control #
-    ##################
-
-    def can_be_updated?
-      signatures.empty?
-    end
-
-    def can_be_published?
-      signatures.empty? && !is_published?
-    end
-
-    def can_be_unpublished?
-      signatures.empty? && is_latest?
-    end
-
-    def can_be_new_versioned?
-      is_published?
-    end
-
-    alias_method :can_be_destroyed?, :can_be_updated?
-
-    ##############
-    # Validation #
-    ##############
-
-    def no_signatures
-      return if signatures.empty?
-      errors.add(:base, 'Contract cannot be modified because users have signed it')
-      false
-    end
-
-    protected
-
-    def downcase_name
-      self.name = name.downcase
-    end
-  end
-end

data/app/models/fine_print/signature.rb~

@@ -1,25 +0,0 @@
-module FinePrint
-  class Signature < ActiveRecord::Base
-    belongs_to :contract, :inverse_of => :signatures
-    belongs_to :user, :polymorphic => true
-
-    before_save :contract_published
-
-    validates_presence_of :contract, :user_type, :user_id
-    validates_uniqueness_of :contract_id, :scope => [:user_type, :user_id]
-
-    default_scope order(:contract_id, :user_type, :user_id)
-
-    protected
-
-    ##############
-    # Validation #
-    ##############
-
-    def contract_published
-      return if contract.is_published?
-      errors.add(:contract, 'needs to be published before it can be signed')
-      false
-    end
-  end
-end

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

@@ -1,35 +0,0 @@
-<%= 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>
-
-      <ul>
-      <% @contract.errors.full_messages.each do |msg| %>
-        <li><%= msg %></li>
-      <% end %>
-      </ul>
-    </div>
-  <% end %>
-
-  <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>
-  </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>
-  </div>
-  <div class='field'>
-    <%= f.label :content, :class => 'fine_print' %>
-    <%= f.text_area :content, :cols => 56, :class => 'fine_print text_area' %>
-  </div>
-  <div class='actions'>
-    <%= f.submit nil, :class => 'fine_print submit' %>
-  </div>
-<% end %>

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

@@ -1,43 +0,0 @@
-<h1 class='fine_print heading'>FinePrint Contracts</h1>
-
-<div class='fine_print contract_index'>
-
-  <% @contracts.group_by(&:name).each do |name, contracts| %>
-
-    <%# Sort contracts by version number; unpublished contracts go at end by creation date %>
-    <% contracts = contracts.sort_by {|cc| cc.version || cc.created_at.to_i} %>
-
-    <ul class='fine_print'>
-      <li><%= name %></li>
-      
-        <ul class='fine_print'>
-          <% contracts.each do |contract| %>
-            <li><%= link_to contract.title, contract %> 
-              (<%= contract.version.nil? ? 'draft' : "v.#{contract.version.to_s}" %>)
-              <% if contract.can_be_updated? %>
-                [<%= link_to 'Edit', edit_contract_path(contract), :class => 'fine_print link' %>]
-              <% else %>
-                [<%= link_to 'New version', new_version_contract_path(contract), :class => 'fine_print link' %>]
-              <% end %>
-              <% if contract.can_be_published? %>
-                [<%= link_to 'Publish', publish_contract_path(contract), :method => :put, :data => {:confirm => 'Are you sure you want to publish this contract?'} %>]
-              <% elsif contract.can_be_unpublished? %>
-                [<%= link_to 'Unpublish', unpublish_contract_path(contract), :method => :put, :data => {:confirm => 'Are you sure you want to unpublish this contract?'} %>]
-              <% end %>
-              <% if contract.can_be_destroyed? %>
-                [<%= link_to 'Delete', contract, :method => :delete, :data => {:confirm => 'Are you sure you wish to delete this contract?'}, :class => 'fine_print link' %>]
-              <% end %>
-            </li>
-          <% end %>
-        </ul>
-      
-    </ul>
-
-  <% end %>
-
-  <div class='fine_print links'>
-    <%= link_to 'New Contract', new_contract_path, :class => 'fine_print link' %> |
-    <%= link_to 'Overview', root_path, :class => 'fine_print link' %>
-  </div>
-
-</div>

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

@@ -1,35 +0,0 @@
-<h1 class='fine_print heading'>Contract Details</h1>
-
-<div class='fine_print show_contract'>
-
-  <table class='fine_print left_heading'>
-    <tr>
-      <th>Name</th>
-      <td><%= @contract.name %></td>
-    </tr>
-    <tr>
-      <th>Title</th>
-      <td><%= @contract.title %></td>
-    </tr>
-    <tr>
-      <th>Version</th>
-      <td><%= @contract.version.nil? ? 'Draft' : @contract.version %></td>
-    </tr>
-    <tr>
-      <th>Updated at</th>
-      <td><%= @contract.updated_at %></td>
-    </tr>
-    <tr>
-      <th>Content</th>
-      <td><%= @contract.content.html_safe %></td>
-    </tr>
-  </table>
-
-  <div class='fine_print links'>
-    <% if @contract.can_be_updated? %>
-      <%= link_to 'Edit', edit_contract_path(@contract), :class => 'fine_print link' %> |
-    <% end %>
-    <%= link_to 'List', contracts_path, :class => 'fine_print link' %>
-  </div>
-
-</div>

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

@@ -1,15 +0,0 @@
-<h1 class='fine_print heading'>FinePrint</h1>
-
-<ul class='fine_print'>
-  <li>
-    <%= link_to 'Manage contracts', 
-                contracts_path, 
-                :class => 'fine_print link' %>
-  </li>
-  <li>
-    <%= link_to 'View signatures', 
-                signatures_path, 
-                :class => 'fine_print link' %>
-  </li>
-</ul>
-

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

@@ -1,32 +0,0 @@
-<h1 class='fine_print heading'>Contract Signatures</h1>
-
-<table class='fine_print index'>
-  <tr class='fine_print heading-row'>
-    <th>User ID</th>
-    <th>Contract name</th>
-    <th>Contract version</th>
-    <th>Date accepted</th>
-    <th></th>
-  </tr>
-
-<% @signatures.each do |signature| %>
-  <tr class='fine_print data-row <%= cycle('even', 'odd') %>'>
-    <td><%= signature.user.id %></td>
-    <td><%= signature.contract.name %></td>
-    <td><%= signature.contract.version %></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>
-  </tr>
-<% end %>
-</table>
-
-<br />
-
-<%= link_to 'Overview', root_path, :class => 'fine_print link' %>

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

@@ -1,20 +0,0 @@
-<!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>
-
-<% if flash[:notice] %>
-  <div class="notice"><%= flash[:notice] %></div>
-<% elsif flash[:notice] %>
-  <div class="notice"><%= flash[:notice] %></div>
-<% end %>
-
-<%= yield %>
-
-</body>
-</html>

data/config/initializers/fine_print.rb~

@@ -1,36 +0,0 @@
-# Change the settings below to suit your needs
-# All settings are initially set to their default values
-FinePrint.configure do |config|
-  # Engine Configuration
-
-  # Proc called with controller as argument that returns the current user.
-  # Default: lambda { |controller| controller.current_user }
-  config.current_user_proc = lambda { |controller| controller.current_user }
-
-  # Proc called with user as argument that returns true iif 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 }
-
-  # Proc called with user as argument that returns true iif the argument is a user
-  # who can sign a contract.  In many systems, a non-logged-in user is represented by nil.
-  # However, some systems use something like an AnonymousUser class to represent this state.
-  # This proc is mostly used to help the developer realize that they should only be asking
-  # signed in users to sign contracts; without this, developers would get a cryptic SQL error.
-  # Default: lambda { |user| user }
-  config.can_sign_contracts_proc = lambda { |user| user }
-
-  # Path to redirect users to when an error occurs (e.g. permission denied on admin pages).
-  # Default: '/'
-  config.redirect_path = '/'
-
-  # Signature (fine_print_get_signatures) Configuration
-
-  # Path to redirect users to when they need to agree to contract(s).
-  # A list of contract names that must be agreed to will be available in the 'contracts' parameter.
-  # Your code doesn't have to deal with all of them at once, e.g. you can get
-  # the user to agree to the first one and then they'll just eventually be
-  # redirected back to this page with the remaining contract names.
-  # Default: '/'
-  config.pose_contracts_path = '/'
-end

data/config/routes.rb~

@@ -1,12 +0,0 @@
-FinePrint::Engine.routes.draw do
-  resources :contracts do
-    member do
-    get :new_version, :on => :member
-    put :publish, :on => :member
-    put :unpublish, :on => :member
-  end
-
-  resources :signatures, :only => [:index, :destroy]
-
-  root :to => 'home#index'
-end

data/db/migrate/0_install_fine_print.rb~

@@ -1,26 +0,0 @@
-class InstallFinePrint < ActiveRecord::Migration
-  def change
-    create_table :fine_print_contracts do |t|
-      t.string :name, :null => false
-      t.integer :version
-      t.string :title, :null => false, :default => ''
-      t.text :content, :null => false, :default => ''
-
-      t.timestamps
-    end
-
-    add_index :fine_print_contracts, [:name, :version], :unique => true
-
-    create_table :fine_print_signatures do |t|
-      t.belongs_to :contract, :null => false
-      t.belongs_to :user, :polymorphic => true, :null => false
-
-      t.timestamps
-    end
-
-    add_index :fine_print_signatures, :contract_id
-    add_index :fine_print_signatures, [:user_id, :user_type, :contract_id], 
-                                      :name => 'index_fine_print_s_on_u_id_and_u_type_and_c_id',
-                                      :unique => true
-  end
-end

data/lib/fine_print/controller_additions.rb

@@ -1,80 +0,0 @@
-module FinePrint
-  module ControllerAdditions
-    #
-    # Internally these methods think of contract names as strings, not symbols.
-    # Any names passed in as symbols are converted to strings.
-    #
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    def fine_print_skipped_contract_names
-      @fine_print_skipped_contract_names ||= []
-    end
-
-    # See the README
-    def fine_print_return
-      redirect_to session.delete(:fine_print_return_to) || root_path
-    end
-
-    module ClassMethods
-      # See the README
-      def fine_print_get_signatures(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-
-        filter_options = options.except(*FinePrint::SIGNATURE_OPTIONS)
-        fine_print_options = options.slice(*FinePrint::SIGNATURE_OPTIONS)
-
-        # Convert all names to string
-        names = args.flatten.collect{|n| n.to_s}
-
-        class_eval do
-          before_filter(filter_options) do |controller|
-            # If the user isn't signed in, they can't sign a contract.  Since there 
-            # may be some pages that logged in and non-logged in users can visit,
-            # just return quietly instead of raising an exception.
-            user = FinePrint.current_user_proc.call(self)
-            return true unless FinePrint.can_sign?(user)
-
-            contract_names = names - fine_print_skipped_contract_names
-
-            # Bail if nothing to do
-            return true if contract_names.blank?
-
-            unsigned_contract_names = 
-              FinePrint.get_unsigned_contract_names(user, contract_names)
-
-            # Ignore contracts that don't yet exist or aren't yet published (happens 
-            # when adding code that requires a new contract but before that contract 
-            # has been added and published)
-            unsigned_contract_names.reject!{|name| FinePrint.get_contract(name).blank?}
-
-            return true if unsigned_contract_names.empty?
-
-            # http://stackoverflow.com/a/2165727/1664216
-            session[:fine_print_return_to] = "#{request.protocol}#{request.host_with_port}#{request.fullpath}"
-            # http://stackoverflow.com/a/6561953
-            path = fine_print_options[:pose_contracts_path] || FinePrint.pose_contracts_path
-            redirect_to path + (path.include?('?') ? '&' : '?') + {:terms => unsigned_contract_names}.to_query
-          end
-        end
-      end
-
-      # See the README
-      def fine_print_skip_signatures(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-
-        # Convert all names to string
-        names = args.flatten.collect{|n| n.to_s}
-
-        class_eval do
-          prepend_before_filter(options) do |controller|
-            fine_print_skipped_contract_names.push(*names)
-          end
-        end
-      end
-    end
-  end
-end
-
-ActionController::Base.send :include, FinePrint::ControllerAdditions

data/lib/fine_print/controller_additions.rb~

@@ -1,86 +0,0 @@
-module FinePrint
-  module ControllerAdditions
-    #
-    # Internally these methods think of contract names as strings, not symbols.
-    # Any names passed in as symbols are converted to strings.
-    #
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    def fine_print_skipped_contract_names
-      @fine_print_skipped_contract_names ||= []
-    end
-
-    # See the README
-    def fine_print_return
-      redirect_to session.delete(:fine_print_return_to) || root_path
-    end
-
-    module ClassMethods
-      # See the README
-      def fine_print_get_signatures(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-
-        filter_options = options.except(*FinePrint::SIGNATURE_OPTIONS)
-        fine_print_options = options.slice(*FinePrint::SIGNATURE_OPTIONS)
-
-        # Convert all names to string
-        names = args.flatten.collect{|n| n.to_s}
-
-        class_eval do
-          before_filter(filter_options) do |controller|
-            # If the user isn't signed in, they can't sign a contract.  Since there 
-            # may be some pages that logged in and non-logged in users can visit,
-            # just return quietly instead of raising an exception.
-            user = FinePrint.current_user_proc.call(self)
-            return true unless FinePrint.can_sign?(user)
-
-            contract_names = names - fine_print_skipped_contract_names
-
-            # Bail if nothing to do
-            return true if contract_names.blank?
-
-<<<<<<< HEAD
-=======
-            user = FinePrint.current_user_proc.call(self)
-            FinePrint.raise_unless_can_sign(user)
-
->>>>>>> a0cf8254c527fa9f44b9dae47c2a157221aa14ab
-            unsigned_contract_names = 
-              FinePrint.get_unsigned_contract_names(user, contract_names)
-
-            # Ignore contracts that don't yet exist or aren't yet published (happens 
-            # when adding code that requires a new contract but before that contract 
-            # has been added and published)
-            unsigned_contract_names.reject!{|name| FinePrint.get_contract(name).blank?}
-
-            return true if unsigned_contract_names.empty?
-
-            # http://stackoverflow.com/a/2165727/1664216
-            session[:fine_print_return_to] = "#{request.protocol}#{request.host_with_port}#{request.fullpath}"
-            # http://stackoverflow.com/a/6561953
-            path = fine_print_options[:pose_contracts_path] || FinePrint.pose_contracts_path
-            redirect_to path + (path.include?('?') ? '&' : '?') + {:terms => unsigned_contract_names}.to_query
-          end
-        end
-      end
-
-      # See the README
-      def fine_print_skip_signatures(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-
-        # Convert all names to string
-        names = args.flatten.collect{|n| n.to_s}
-
-        class_eval do
-          prepend_before_filter(options) do |controller|
-            fine_print_skipped_contract_names.push(*names)
-          end
-        end
-      end
-    end
-  end
-end
-
-ActionController::Base.send :include, FinePrint::ControllerAdditions

data/lib/fine_print/utilities.rb~

@@ -1,26 +0,0 @@
-module FinePrint
-  module Utilities
-    # Returns true iff the given user has signed any version of the given contract.
-    #   contract -- can be a Contract object, its ID, or its name as a String or Symbol
-    def self.any_signed_contract_version?(contract, user)
-      contract = FinePrint::get_contract(contract)
-      !user.nil? && 
-      !Signature.joins(:contract)
-                .where(:contract => {:name => contract.name},
-                       :user_type => user.class.name,
-                       :user_id => user.id).first.nil?
-    end
-
-    # Returns the latest version of the named contract (since contracts don't have
-    # versions until they are published this only returns published contracts).
-    # If no such contract exists, returns nil.  
-    #   name -- can be a String or a Symbol
-    def self.latest_contract_named(name)
-      name = name.to_s
-      contract = Contract.where(:name => name).published.first
-      raise IllegalState, "Published version of #{name} not found" \
-        if contract.nil?
-      contract
-    end
-  end
-end

data/lib/fine_print/version.rb~

@@ -1,3 +0,0 @@
-module FinePrint
-  VERSION = '1.2.0'
-end