fine_print 2.3.1 → 3.0.0

data/config/routes.rb

@@ -1,8 +1,9 @@
 FinePrint::Engine.routes.draw do
-  root :to => 'home#index'
+  root to: 'home#index'
 
   resources :contracts do
-    resources :signatures, :only => [:index, :new, :create, :destroy], :shallow => true
+    resources :signatures, only: [:index, :new, :create, :destroy],
+                           shallow: true
 
     member do
       post :new_version

data/db/migrate/0_install_fine_print.rb

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

data/lib/fine_print.rb

@@ -1,42 +1,27 @@
+require 'fine_print/configuration'
 require 'fine_print/engine'
-require 'fine_print/controller_includes'
 
 module FinePrint
-  # Attributes
-
-  # Can be set in initializer only
-  ENGINE_OPTIONS = [
-    :current_user_proc,
-    :can_manage_proc,
-    :can_sign_proc,
-    :layout,
-    :helpers
-  ]
-
-  # Can be set in initializer or passed as an argument
-  # to FinePrint controller methods
-  CONTROLLER_OPTIONS = [
-    :must_sign_proc
-  ]
-  
-  (ENGINE_OPTIONS + CONTROLLER_OPTIONS).each do |option|
-    mattr_accessor option
+
+  def self.config
+    @config ||= Configuration.new
   end
-  
+
   def self.configure
-    yield self
+    yield config
   end
 
   # Gets a contract, given either the contract object, ID or name
-  # If given a name, it returns the latest published version of that contract
-  #   - contract - can be a Contract object, its ID, or its name (String/Symbol)
+  # If given a name, returns the latest published version of that contract
+  #   - contract - can be a Contract object, its ID, or its name
   def self.get_contract(reference)
     return reference if reference.is_a? Contract
     num = Integer(reference) rescue nil
     return Contract.find(num) if num
-    contract = Contract.where(:name => reference.to_s).published.first
+    contract = Contract.where(name: reference.to_s).published.first
     return contract if contract
-    raise ActiveRecord::RecordNotFound, "Couldn't find Contract with 'name'=#{reference.to_s}"
+    raise ActiveRecord::RecordNotFound,
+          "Couldn't find Contract with 'name'=#{reference.to_s}"
   end
 
   # Records that the given user has signed the given contract
@@ -55,55 +40,55 @@ module FinePrint
   #   - user - the user in question
   #   - contract - can be a Contract object, its ID, or its name (String/Symbol)
   def self.signed_contract?(user, contract)
+    return false if user.nil?
+
     contract = get_contract(contract)
 
-    contract.signatures.where(:user_id => user.id,
-                              :user_type => user.class.name).exists?
+    contract.signatures.where(user_id: user.id,
+                              user_type: user.class.name).exists?
   end
 
   # Returns true iff the given user has signed any version of the given contract
   #   - user - the user in question
   #   - contract - can be a Contract object, its ID, or its name (String/Symbol)
   def self.signed_any_version_of_contract?(user, contract)
+    return false if user.nil?
+
     contract = get_contract(contract)
 
-    contract.same_name.includes(:signatures).any? do |c|
-      c.signatures.where(:user_id => user.id,
-                         :user_type => user.class.name).exists?
-    end
+    contract.same_name.joins(:signatures).where(
+      signatures: { user_id: user.id, user_type: user.class.name }
+    ).exists?
   end
 
-  # Converts an array of contract names into an array containing
-  # the latest contract id for each given name.
-  def self.contract_names_to_ids(*contract_names)
-    names = contract_names.flatten
-    Contract.latest.where(:name => names).pluck(:id)
+  # Returns all the latest published contracts that match the given conditions.
+  def self.latest_published_contracts(conditions = {})
+    Contract.published.latest.where(conditions)
   end
 
-  # Returns an array of ids for the contracts among those given
+  # Returns all contracts matching the given conditions
   # whose latest published version the user has signed.
   #   - user - the user in question
-  #   - contract_ids - contract ids to check
-  # If no contract ids are provided, all latest contracts are checked
-  def self.get_signed_contract_ids(user, *contract_ids)
-    ids = contract_ids.flatten
-    ids = Contract.published.latest.pluck(:id) if ids.blank?
-
-    Signature.where(:user_id => user.id,
-                    :user_type => user.class.name,
-                    :contract_id => ids).pluck(:contract_id)
+  #   - conditions - filters the list of contracts to check
+  # If no conditions are provided, all latest contracts are checked.
+  def self.signed_contracts_for(user, conditions = {})
+    return [] if user.nil?
+
+    contracts = latest_published_contracts(conditions)
+    contracts.joins(:signatures).where(
+      signatures: { user_id: user.id, user_type: user.class.name }
+    )
   end
 
-  # Returns an array of ids for the contracts among those given
+  # Returns all contracts matching the given conditions
   # whose latest published version the user has not signed.
   #   - user - the user in question
-  #   - contract_ids - contract ids to check
-  # If no contract ids are provided, all latest contracts are checked
-  def self.get_unsigned_contract_ids(user, *contract_ids)
-    ids = contract_ids.flatten
-    ids = Contract.published.latest.pluck(:id) if ids.blank?
-
-    ids - get_signed_contract_ids(user, ids)
+  #   - conditions - filters the list of contracts to check
+  # If no conditions are provided, all latest contracts are checked.
+  def self.unsigned_contracts_for(user, conditions = {})
+    contracts = latest_published_contracts(conditions)
+    signed_contracts = signed_contracts_for(user, conditions)
+    contracts - signed_contracts
   end
 
 end

data/lib/fine_print/action_controller/base.rb

@@ -0,0 +1,118 @@
+module FinePrint
+  module ActionController
+    module Base
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      # Accepts an array of contract names and an options hash
+      # Checks if the current user has signed the given contracts
+      # and calls fine_print_redirect if not
+      # Options relevant to FinePrint are passed to fine_print_redirect
+      # If no names are given, requires all contracts
+      def fine_print_require(*names)
+        options = names.last.is_a?(Hash) ? names.pop : {}
+        fp_opts = options.slice(*FinePrint::Configuration::CONTROLLER_OPTIONS)
+
+        # Convert names to an array of Strings
+        contract_names = names.flatten.collect{|c| c.to_s}
+        contract_names = ['all'] if contract_names.empty?
+        contract_names = FinePrint::Contract.all.to_a.collect{|c| c.name}
+                           .uniq if contract_names.include?('all')
+
+        user = instance_exec &FinePrint.config.current_user_proc
+
+        can_sign = instance_exec(user, &FinePrint.config.authenticate_user_proc)
+
+        return if !can_sign || performed?
+
+        unsigned_contracts = FinePrint.unsigned_contracts_for(
+          user, name: contract_names
+        )
+
+        # Return quietly if all contracts signed
+        return if unsigned_contracts.blank?
+
+        fine_print_redirect(user, unsigned_contracts, fp_opts)
+      end
+
+      # Accepts a user, an array of contract ids to be signed and an options hash
+      # Calls the `redirect_to_contracts_proc` with the given parameters
+      def fine_print_redirect(user, *contracts)
+        options = contracts.last.is_a?(Hash) ? contracts.pop : {}
+        contracts = contracts.flatten
+
+        blk = options[:redirect_to_contracts_proc] || \
+              FinePrint.config.redirect_to_contracts_proc
+
+        # Use action_interceptor to save the current url
+        store_url key: :fine_print_return_to
+
+        instance_exec user, contracts, &blk
+      end
+
+      # Accepts no arguments
+      # Redirects the user back to the url they were at before
+      # `fine_print_redirect` redirected them
+      def fine_print_return
+        redirect_back key: :fine_print_return_to
+      end
+
+      protected
+
+      def fine_print_skipped_contract_names
+        @fine_print_skipped_contract_names ||= []
+      end
+
+      module ClassMethods
+        # Accepts an array of contract names and an options hash
+        # Adds a before_filter to the current controller that will check if the
+        # current user has signed the given contracts and call the sign_proc if appropriate
+        # Options relevant to FinePrint are passed to fine_print_sign, while
+        # other options are passed to the before_filter
+        def fine_print_require(*names)
+          options = names.last.is_a?(Hash) ? names.pop : {}
+          f_opts = options.except(*FinePrint::Configuration::CONTROLLER_OPTIONS)
+
+          # Convert names to an array of Strings
+          contract_names = names.flatten.collect{|c| c.to_s}
+          contract_names = ['all'] if contract_names.empty?
+
+          class_exec do
+            before_filter(f_opts) do |controller|
+              skipped_contract_names = fine_print_skipped_contract_names
+              next if skipped_contract_names.include?('all')
+              contract_names = FinePrint::Contract.all.to_a.collect{|c| c.name}
+                                 .uniq if contract_names.include?('all')
+              unskipped_contract_names = contract_names - skipped_contract_names
+              controller.fine_print_require(unskipped_contract_names, options) \
+                unless unskipped_contract_names.empty?
+            end
+          end
+        end
+
+        # Accepts an array of contract names and an options hash
+        # Excludes the given contracts from the `fine_print_require`
+        # check for this controller and subclasses
+        # Options are passed to prepend_before_filter
+        def fine_print_skip(*names)
+          options = names.last.is_a?(Hash) ? names.pop : {}
+
+          # Convert names to an array of Strings
+          contract_names = names.flatten.collect{|c| c.to_s}
+          contract_names = ['all'] if contract_names.empty?
+
+          class_exec do
+            prepend_before_filter(options) do |controller|
+              controller.fine_print_skipped_contract_names.push(*contract_names)
+            end
+          end
+        end
+      end
+
+    end
+  end
+end
+
+::ActionController::Base.send :include, FinePrint::ActionController::Base

data/lib/fine_print/configuration.rb

@@ -0,0 +1,24 @@
+module FinePrint
+  class Configuration
+    # Attributes
+
+    # Can be set in initializer only
+    ENGINE_OPTIONS = [
+      :helpers,
+      :layout,
+      :authenticate_user_proc,
+      :authenticate_manager_proc,
+      :current_user_proc
+    ]
+
+    # Can be set in initializer or passed as an argument
+    # to FinePrint controller methods
+    CONTROLLER_OPTIONS = [
+      :redirect_to_contracts_proc
+    ]
+    
+    (ENGINE_OPTIONS + CONTROLLER_OPTIONS).each do |option|
+      attr_accessor option
+    end
+  end
+end

data/lib/fine_print/engine.rb

@@ -1,24 +1,28 @@
 require 'action_interceptor'
 require 'squeel'
+require 'fine_print/action_controller/base'
 
 module FinePrint
   class Engine < ::Rails::Engine
     isolate_namespace FinePrint
 
-    initializer "fine_print.factories", :after => "factory_girl.set_factory_paths" do
-      FactoryGirl.definition_file_paths << File.join(root, 'spec', 'factories', 'fine_print') \
-        if defined?(FactoryGirl)
+    initializer "fine_print.factories",
+                after: "factory_girl.set_factory_paths" do
+      FactoryGirl.definition_file_paths << File.join(
+        root, 'spec', 'factories', 'fine_print'
+      ) if defined?(FactoryGirl)
     end
 
     # http://viget.com/extend/rails-engine-testing-with-rspec-capybara-and-factorygirl
     config.generators do |g|
-      g.test_framework      :rspec,        :fixture => false
-      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.test_framework      :rspec,        fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
       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}')]
+    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.3.1'
+  VERSION = '3.0.0'
 end

data/lib/tasks/fine_print_tasks.rake

@@ -10,7 +10,7 @@ namespace :fine_print do
         if File.exists?(File.expand_path(File.basename(file), 'config/initializers'))
           print "NOTE: Initializer #{File.basename(file)} from fine_print has been skipped. Initializer with the same name already exists.\n"
         else
-          cp file, 'config/initializers', :verbose => false
+          cp file, 'config/initializers', verbose: false
           print "Copied initializer #{File.basename(file)} from fine_print\n"
         end
       end
@@ -22,7 +22,9 @@ namespace :fine_print do
       name = File.basename(path)
       desc "Copy #{name} from fine_print to application"
       task name.to_sym do
-        cp_r File.expand_path("../../../app/#{path}/fine_print", __FILE__), "app/#{path}", :verbose => false
+        cp_r File.expand_path("../../../app/#{path}/fine_print", __FILE__),
+             "app/#{path}",
+             verbose: false
         print "Copied #{name} from fine_print\n"
       end
     end

data/spec/controllers/contracts_controller_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 module FinePrint
-  describe ContractsController, :type => :controller do
+  describe ContractsController, type: :controller do
     routes { FinePrint::Engine.routes }
 
     before(:each) do
@@ -46,12 +46,12 @@ module FinePrint
       attributes[:title] = 'Some title'
       attributes[:content] = 'Some content'
 
-      post :create, :contract => :attributes
+      post :create, contract: :attributes
       expect(response.status).to eq 403
       expect(assigns(:contract)).to be_nil
       
       sign_in @user
-      post :create, :contract => :attributes
+      post :create, contract: :attributes
       expect(response.status).to eq 403
       expect(assigns(:contract)).to be_nil
     end
@@ -63,7 +63,7 @@ module FinePrint
       attributes[:title] = 'Some title'
       attributes[:content] = 'Some content'
       
-      post :create, :contract => attributes
+      post :create, contract: attributes
       expect(response).to redirect_to assigns(:contract)
       expect(assigns(:contract).errors).to be_empty
       expect(assigns(:contract).name).to eq 'some_name'
@@ -72,17 +72,17 @@ module FinePrint
     end
     
     it "won't edit unless authorized" do
-      get :edit, :id => contract.id
+      get :edit, id: contract.id
       expect(response.status).to eq 403
       
       sign_in @user
-      get :edit, :id => contract.id
+      get :edit, id: contract.id
       expect(response.status).to eq 403
     end
     
     it 'must edit if authorized' do
       sign_in @admin
-      get :edit, :id => contract.id
+      get :edit, id: contract.id
       expect(response.status).to eq 200
     end
     
@@ -95,7 +95,7 @@ module FinePrint
       title = contract.title
       content = contract.content
       
-      put :update, :id => contract.id, :contract => attributes
+      put :update, id: contract.id, contract: attributes
       expect(response.status).to eq 403
       contract.reload
       expect(contract.name).to eq name
@@ -103,7 +103,7 @@ module FinePrint
       expect(contract.content).to eq content
       
       sign_in @user
-      put :update, :id => contract.id, :contract => attributes
+      put :update, id: contract.id, contract: attributes
       expect(response.status).to eq 403
       contract.reload
       expect(contract.name).to eq name
@@ -118,7 +118,7 @@ module FinePrint
       attributes[:content] = 'Another content'
 
       sign_in @admin
-      put :update, :id => contract.id, :contract => attributes
+      put :update, id: contract.id, contract: attributes
       expect(response).to redirect_to contract
       contract.reload
       expect(contract.errors).to be_empty
@@ -128,32 +128,32 @@ module FinePrint
     end
 
     it "won't destroy unless authorized" do
-      delete :destroy, :id => contract.id
+      delete :destroy, id: contract.id
       expect(response.status).to eq 403
       expect(Contract.find(contract.id)).to eq contract
       
       sign_in @user
-      delete :destroy, :id => contract.id
+      delete :destroy, id: contract.id
       expect(response.status).to eq 403
       expect(Contract.find(contract.id)).to eq contract
     end
     
     it 'must destroy if authorized' do
       sign_in @admin
-      delete :destroy, :id => contract.id
+      delete :destroy, id: contract.id
       expect(response).to redirect_to contracts_path
       expect(Contract.find_by_id(contract.id)).to be_nil
     end
 
     it "won't publish unless authorized" do
       expect(contract.is_published?).to eq false
-      put :publish, :id => contract.id
+      put :publish, id: contract.id
       expect(response.status).to eq 403
       contract.reload
       expect(contract.is_published?).to eq false
       
       sign_in @user
-      put :publish, :id => contract.id
+      put :publish, id: contract.id
       expect(response.status).to eq 403
       contract.reload
       expect(contract.is_published?).to eq false
@@ -163,7 +163,7 @@ module FinePrint
       expect(contract.is_published?).to eq false
       sign_in @admin
 
-      put :publish, :id => contract.id
+      put :publish, id: contract.id
       expect(response).to redirect_to contracts_path
       contract.reload
       expect(contract.is_published?).to eq true
@@ -172,13 +172,13 @@ module FinePrint
     it "won't unpublish unless authorized" do
       contract.publish
       expect(contract.is_published?).to eq true
-      put :unpublish, :id => contract.id
+      put :unpublish, id: contract.id
       expect(response.status).to eq 403
       contract.reload
       expect(contract.is_published?).to eq true
       
       sign_in @user
-      put :unpublish, :id => contract.id
+      put :unpublish, id: contract.id
       expect(response.status).to eq 403
       contract.reload
       expect(contract.is_published?).to eq true
@@ -189,7 +189,7 @@ module FinePrint
       expect(contract.is_published?).to eq true
 
       sign_in @admin
-      put :unpublish, :id => contract.id
+      put :unpublish, id: contract.id
       expect(response).to redirect_to contracts_path
       contract.reload
       expect(contract.is_published?).to eq false
@@ -199,12 +199,12 @@ module FinePrint
       contract.publish
       expect(contract.is_published?).to eq true
       
-      post :new_version, :id => contract.id
+      post :new_version, id: contract.id
       expect(response.status).to eq 403
       expect(assigns(:contract)).to be_nil
       
       sign_in @user
-      post :new_version, :id => contract.id
+      post :new_version, id: contract.id
       expect(response.status).to eq 403
       expect(assigns(:contract)).to be_nil
     end
@@ -214,7 +214,7 @@ module FinePrint
       expect(contract.is_published?).to eq true
 
       sign_in @admin
-      post :new_version, :id => contract.id
+      post :new_version, id: contract.id
       expect(response.status).to eq 200
       expect(assigns(:contract)).not_to be_nil
     end