fine_print 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6538ce528adfe5224a637f721b0143e26a91565d
-  data.tar.gz: 1d9290f91f0e09774fa4f01e29e7fda7784a1b92
+SHA256:
+  metadata.gz: b85dc2f146980af79e449e2b6ddf27baf5968df56ebabf1ebf34819f5bcc3b80
+  data.tar.gz: dabc834b4c2bdfc7a18bfec22360dfef9a64c76731aa5497257642bb4d69a7eb
 SHA512:
-  metadata.gz: 2ed558aad019900366e18fcec4b5f4bda152d094acc6d548396c454b36dd89b57b99f91544c45e54bf110bbf264907c119f0a66e6d823a3c2a755c2bd512b407
-  data.tar.gz: 3bd49121ba9ebe3d38f0af95f06c7eafc618ed04999f5c21101eee474cef5586124c304c292bdaa5a19e91755840d8069f67c17148f805dbb3b23d68b8b40d4f
+  metadata.gz: 1b53d9d64e3820e6842166b21e44837a02d5d526d6b107cd4831f199b36efed791646d2158227852397d701ac722dc64ed50abffe25d23918179949d103770af
+  data.tar.gz: b3990f072bf7c6bde599019f8fdaa09e9cf43bac17559bb955bc75b6ce4455ffa3e0e8088aa87acacfb7af40de66a7b05f48f4bbb7ecaafdb97cd66da6c670ed

data/README.md

@@ -80,11 +80,11 @@ this proc to return `true` for your admins.
 ## Usage
 
 You can choose to check if users signed contracts either
-as a before_filter or inside your controller actions.
+as a before_action or inside your controller actions.
 
-### Option 1 - As a before_filter
+### Option 1 - As a before_action
 
-If you choose to have FinePrint work like a before_filter, you can user the following class methods, which are automatically added to your controllers:
+If you choose to have FinePrint work like a before_action, you can user the following class methods, which are automatically added to your controllers:
 
 ```rb
 fine_print_require(contract_names..., options_hash)
@@ -100,7 +100,7 @@ These methods take a list of contract names to check, along with an options hash
 If no contract names are provided, or if :all is passed to one of the methods,
 ALL existing contracts will be required or skipped.
 
-The options hash can include any options you could pass to a `before_filter`,
+The options hash can include any options you could pass to a `before_action`,
 e.g. `only` and `except`, plus the FinePrint-specific option
 `redirect_to_contracts_proc`, which is a proc that controls
 where users are redirected to in order to sign contracts.
@@ -142,7 +142,7 @@ fine_print_require(contract_names..., options_hash)
 fine_print_return
 ```
 
-- `fine_print_require` works just like the before_filter version and will
+- `fine_print_require` works just like the before_action version and will
   redirect the user if they haven't signed one or more of the given contracts
 - `fine_print_return` can be used to return from a redirect
   made by `fine_print_require`
@@ -177,7 +177,7 @@ If you require more explanation about these methods and their arguments, check t
 
 ### Redirecting users back
 
-Regardless if you use the class before_filter or instance methods,
+Regardless if you use the class before_action or instance methods,
 after your contract is signed you can use the `fine_print_return` controller
 instance method to send the user back to the place where they came from.
 

data/app/controllers/fine_print/application_controller.rb

@@ -4,7 +4,7 @@ module FinePrint
   class ApplicationController < ::ActionController::Base
     respond_to :html
 
-    before_filter :get_user, :can_manage
+    before_action :get_user, :can_manage
 
     layout FinePrint.config.layout
 

data/app/controllers/fine_print/contracts_controller.rb

@@ -2,7 +2,7 @@ module FinePrint
   class ContractsController < FinePrint::ApplicationController
     include FinePrint::ApplicationHelper
 
-    before_filter :get_contract, except: [:index, :new, :create]
+    before_action :get_contract, except: [:index, :new, :create]
 
     def index
       @contracts = Contract.includes(:signatures).all.to_a.group_by(&:name)

data/app/controllers/fine_print/signatures_controller.rb

@@ -2,10 +2,10 @@ module FinePrint
   class SignaturesController < FinePrint::ApplicationController
     include FinePrint::ApplicationHelper
 
-    skip_before_filter :can_manage, only: [:new, :create]
+    skip_before_action :can_manage, only: [:new, :create]
     fine_print_skip only: [:new, :create]
-    before_filter :can_sign, only: [:new, :create]
-    before_filter :get_contract, only: [:index, :new, :create]
+    before_action :can_sign, only: [:new, :create]
+    before_action :get_contract, only: [:index, :new, :create]
 
     def index
       @signatures = @contract.signatures
@@ -28,14 +28,14 @@ module FinePrint
 
       @signature.user = @user
       @signature.contract = @contract
-  
+
       if @signature.save
         fine_print_return
       else
         render action: 'new', alert: merge_errors_for(@signature)
       end
     end
-  
+
     def destroy
       @signature = Signature.find(params[:id])
 

data/app/models/fine_print/contract.rb

@@ -16,11 +16,11 @@ module FinePrint
                                       case_sensitive: false},
                         allow_nil: true
 
-    default_scope lambda { order{[name.asc, version.desc]} }
+    default_scope lambda { ordering{[name.asc, version.desc]} }
 
-    scope :published, lambda { where{version != nil} }
-    scope :latest, lambda { joins(:same_name).group{id}
-                              .having{version == max(same_name.version)} }
+    scope :published, lambda { where.has{version != nil} }
+    scope :latest, lambda { joins(:same_name).grouping{id}
+                              .when_having{version == max(same_name.version)} }
 
     def is_published?
       !version.nil?
@@ -63,6 +63,7 @@ module FinePrint
     def no_signatures
       return if signatures.empty?
       errors.add(:base, I18n.t('fine_print.contract.errors.already_signed'))
+      throw(:abort)
       false
     end
 

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

@@ -24,6 +24,7 @@
 
   <div class='actions'>
     <%= f.submit t('fine_print.signature.actions.sign'),
-                 class: 'fine_print submit' %>
+                 class: 'fine_print submit',
+                 data: { disable_with: 'Please wait...' } %>
   </div>
 <% end %>

data/config/initializers/fine_print.rb

@@ -11,8 +11,8 @@ FinePrint.configure do |config|
   config.helpers = []
 
   # Proc called with a controller as self. Returns the current user.
-  # Default: lambda { current_user }
-  config.current_user_proc = lambda { current_user }
+  # Default: -> { current_user }
+  config.current_user_proc = -> { 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.
@@ -20,8 +20,8 @@ FinePrint.configure do |config|
   # 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| head(:forbidden) }
-  config.authenticate_manager_proc = lambda { |user| head(:forbidden) }
+  # Default: ->(user) { head(:forbidden) }
+  config.authenticate_manager_proc = ->(user) { head(:forbidden) }
 
   # Proc called with a user as argument and a controller as self.
   # This proc is called before FinePrint determines if contracts need to be
@@ -29,12 +29,11 @@ FinePrint.configure do |config|
   # 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
+  # contracts, unless another before_action 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.authenticate_user_proc = lambda { |user| !user.nil? || \
-                                                  head(:unauthorized) }
+  # Default: ->(user) { !user.nil? || head(:unauthorized) }
+  config.authenticate_user_proc = ->(user) { !user.nil? || head(:unauthorized) }
 
   # Controller Configuration
   # Can be set in this initializer or passed as options to `fine_print_require`
@@ -46,19 +45,15 @@ FinePrint.configure do |config|
   # 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 this redirect.
-  # Default: lambda { |user, contracts|
-  #            redirect_to(fine_print.new_contract_signature_path(
-  #              contract_id: contracts.first.id
-  #            ))
-  #          }
-  config.redirect_to_contracts_proc = lambda { |user, contracts|
-    redirect_to(
-      fine_print.new_contract_signature_path(contract_id: contracts.first.id)
-    )
-  }
+  # Default: ->(user, contracts) do
+  #            redirect_to fine_print.new_contract_signature_path(contract_id: contracts.first.id)
+  #          end
+  config.redirect_to_contracts_proc = ->(user, contracts) do
+    redirect_to fine_print.new_contract_signature_path(contract_id: contracts.first.id)
+  end
 
   # Proc called whenever a contract is published, useful if the application
   # needs to hook into this event and take some action
-  config.contract_published_proc = lambda { |contract| }
+  config.contract_published_proc = ->(contract) { }
 
 end

data/db/migrate/0_install_fine_print.rb

@@ -1,4 +1,4 @@
-class InstallFinePrint < ActiveRecord::Migration
+class InstallFinePrint < ActiveRecord::Migration[4.2]
   def change
     create_table :fine_print_contracts do |t|
       t.string :name, null: false

data/db/migrate/1_add_implicit_signatures.rb

@@ -1,4 +1,4 @@
-class AddImplicitSignatures < ActiveRecord::Migration
+class AddImplicitSignatures < ActiveRecord::Migration[4.2]
   def change
     add_column :fine_print_signatures, :is_implicit,
                :boolean, null: false, default: false

data/lib/fine_print/action_controller/base.rb

@@ -67,10 +67,10 @@ module FinePrint
 
       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
+        # Adds a before_action 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
+        # other options are passed to the before_action
         def fine_print_require(*names)
           options = names.last.is_a?(Hash) ? names.pop : {}
           f_opts = options.except(*FinePrint::Configuration::CONTROLLER_OPTIONS)
@@ -80,7 +80,7 @@ module FinePrint
           contract_names = ['all'] if contract_names.empty?
 
           class_exec do
-            before_filter(f_opts) do |controller|
+            before_action(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}
@@ -95,7 +95,7 @@ module FinePrint
         # 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
+        # Options are passed to prepend_before_action
         def fine_print_skip(*names)
           options = names.last.is_a?(Hash) ? names.pop : {}
 
@@ -104,7 +104,7 @@ module FinePrint
           contract_names = ['all'] if contract_names.empty?
 
           class_exec do
-            prepend_before_filter(options) do |controller|
+            prepend_before_action(options) do |controller|
               controller.fine_print_skipped_contract_names.push(*contract_names)
             end
           end

data/lib/fine_print/engine.rb

@@ -1,5 +1,5 @@
 require 'action_interceptor'
-require 'squeel'
+require 'baby_squeel'
 require 'fine_print/action_controller/base'
 
 module FinePrint
@@ -7,16 +7,16 @@ module FinePrint
     isolate_namespace FinePrint
 
     initializer "fine_print.factories",
-                after: "factory_girl.set_factory_paths" do
-      FactoryGirl.definition_file_paths << File.join(
+                after: "factory_bot.set_factory_paths" do
+      FactoryBot.definition_file_paths << File.join(
         root, 'spec', 'factories', 'fine_print'
-      ) if defined?(FactoryGirl)
+      ) if defined?(FactoryBot)
     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.fixture_replacement :factory_bot, dir: 'spec/factories'
       g.assets false
       g.helper false
     end

data/lib/fine_print/version.rb

@@ -1,3 +1,3 @@
 module FinePrint
-  VERSION = '3.1.0'
+  VERSION = '4.0.0'
 end

data/lib/fine_print.rb

@@ -23,8 +23,7 @@ module FinePrint
     return Contract.find(num) if num
     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
@@ -32,13 +31,26 @@ module FinePrint
   #   - contract - can be a Contract object, its ID, or its name (String/Symbol)
   #   - is_implicit - if true, the signature is implicit/assumed/indirectly-acquired
   #                   if false, the signature was obtained directly from the user
-  def self.sign_contract(user, contract, is_implicit = SIGNATURE_IS_EXPLICIT)
-    contract = get_contract(contract)
-
-    Signature.create do |signature|
-      signature.user = user
-      signature.contract = contract
-      signature.is_implicit = is_implicit
+  def self.sign_contract(user, contract, is_implicit = SIGNATURE_IS_EXPLICIT, max_attempts = 3)
+    attempts = 0
+
+    begin
+      Signature.transaction(requires_new: true) do
+        contract = get_contract(contract)
+
+        Signature.create do |signature|
+          signature.user = user
+          signature.contract = contract
+          signature.is_implicit = is_implicit
+        end
+      end
+    rescue ActiveRecord::RecordNotUnique => exception
+      attempts += 1
+      raise exception if attempts >= max_attempts
+
+      # Simply retry as in https://apidock.com/rails/v4.0.2/ActiveRecord/Relation/find_or_create_by
+      # If it already exists, the validations should catch it this time
+      retry
     end
   end
 
@@ -50,8 +62,7 @@ module FinePrint
 
     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
@@ -63,7 +74,7 @@ module FinePrint
     contract = get_contract(contract)
 
     contract.same_name.joins(:signatures).where(
-      signatures: { user_id: user.id, user_type: user.class.name }
+      fine_print_signatures: { user_id: user.id, user_type: user.class.name }
     ).exists?
   end
 
@@ -82,7 +93,7 @@ module FinePrint
 
     contracts = latest_published_contracts(conditions)
     contracts.joins(:signatures).where(
-      signatures: { user_id: user.id, user_type: user.class.name }
+      fine_print_signatures: { user_id: user.id, user_type: user.class.name }
     )
   end
 

data/spec/controllers/contracts_controller_spec.rb

@@ -8,7 +8,7 @@ module FinePrint
       setup_controller_spec
     end
 
-    let!(:contract) { FactoryGirl.create(:fine_print_contract) }
+    let!(:contract) { FactoryBot.create(:fine_print_contract) }
 
     it "won't get index unless authorized" do
       get :index
@@ -46,12 +46,12 @@ module FinePrint
       attributes[:title] = 'Some title'
       attributes[:content] = 'Some content'
 
-      post :create, contract: :attributes
+      post :create, params: { contract: :attributes }
       expect(response.status).to eq 403
       expect(assigns(:contract)).to be_nil
       
       sign_in @user
-      post :create, contract: :attributes
+      post :create, params: { 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, params: { 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, params: { id: contract.id }
       expect(response.status).to eq 403
       
       sign_in @user
-      get :edit, id: contract.id
+      get :edit, params: { 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, params: { 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, params: { 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, params: { 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, params: { 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, params: { 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, params: { 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, params: { 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, params: { 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, params: { 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, params: { 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, params: { 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, params: { 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, params: { 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, params: { 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, params: { 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, params: { id: contract.id }
       expect(response.status).to eq 200
       expect(assigns(:contract)).not_to be_nil
     end