fine_print 1.3.0 → 1.4.1

data/lib/fine_print.rb~

@@ -1,120 +0,0 @@
-require 'fine_print/engine'
-require 'fine_print/security_transgression'
-require 'fine_print/controller_additions'
-
-module FinePrint
-  # Attributes
-
-  # Can be set in initializer only
-  ENGINE_OPTIONS = [
-    :current_user_proc,
-    :user_admin_proc,
-    :can_sign_contracts_proc,
-    :pose_contracts_path,
-    :redirect_path
-  ]
-
-  # Can be set in initializer or passed as an option to fine_print_get_signatures
-  SIGNATURE_OPTIONS = [
-    :pose_contracts_path
-  ]
-  
-  (ENGINE_OPTIONS + SIGNATURE_OPTIONS).each do |option|
-    mattr_accessor option
-  end
-  
-  def self.configure
-    yield self
-  end
-
-  # Gets a contract given either the contract's 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 as a String or Symbol
-  #
-  def self.get_contract(reference)
-    ref = Integer(reference) rescue reference
-    case ref
-    when Contract
-      ref
-    when Integer
-      Contract.find(ref)
-    when String, Symbol
-      Contract.where(:name => ref.to_s).published.first
-    end
-  end
-
-  # Records that the given user has signed the given contract
-  #   - user -- the user in question
-  #   - contract -- can be a Contract object, its ID, or its name as a String or Symbol
-  #
-  def self.sign_contract(user, contract)
-    raise_unless_can_sign(user)
-    contract = get_contract(contract)
-    raise IllegalState, 'Contract not found' if contract.nil?
-
-    Signature.create do |signature|
-      signature.user = user
-      signature.contract = contract
-    end
-  end
-
-  # Returns true iff the given user has signed the given contract
-  #   - user -- the user in question
-  #   - contract -- can be a Contract object, its ID, or its name as a String or Symbol
-  #
-  def self.signed_contract?(user, contract)
-    raise_unless_can_sign(user)
-    contract = get_contract(contract)
-
-    !contract.signatures.where(:user_id => user.id,
-                               :user_type => user.class.name).first.nil?
-  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 as a String or Symbol
-  def self.signed_any_contract_version?(user, contract)
-    raise_unless_can_sign(user)
-    contract = get_contract(contract)
-    !Signature.joins(:contract)
-              .where(:fine_print_contracts => {:name => contract.name},
-                     :user_type => user.class.name,
-                     :user_id => user.id).first.nil?
-  end
-
-  # Returns an array of names for the contracts whose latest published
-  # version the given user has not signed.
-  #   - user -- the user in question
-  #   - names -- contract names to check
-  #
-  def self.get_unsigned_contract_names(user, *names)
-    raise_unless_can_sign(user)
-    names = names.flatten.collect{|name| name.to_s}
-    return [] if names.blank?
-
-    signed_contracts = Contract
-      .joins(:signatures)
-      .where({:name => names,
-              :fine_print_signatures => {:user_id => user.id,
-                                         :user_type => user.class.name}}).latest
-    signed_contract_names = signed_contracts.collect{|c| c.name}
-
-    return names - signed_contract_names
-  end
-
-  def self.can_sign?(user)
-    can_sign_contracts_proc.call(user)
-  end
-
-  def self.is_admin?(user)
-    !user.nil? && user_admin_proc.call(user)
-  end
-
-  def self.raise_unless_can_sign(user)
-    raise IllegalState, 'User not signed in' unless can_sign?(user)
-  end
-
-  def self.raise_unless_admin(user)
-    raise SecurityTransgression unless is_admin?(user)
-  end
-end

data/spec/controllers/contracts_controller_spec.rb~

@@ -1,224 +0,0 @@
-require 'spec_helper'
-
-module FinePrint
-  describe ContractsController do
-    routes { FinePrint::Engine.routes }
-
-    before do
-      setup_controller_spec
-      @contract = FactoryGirl.create(:contract)
-      @contract.reload
-    end
-
-    it "won't get index unless authorized" do
-      get :index, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      
-      sign_in @user
-      get :index, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-    end
-    
-    it 'must get index if authorized' do
-      sign_in @admin
-      get :index, :use_route => :fine_print
-      assert_response :success
-    end
-    
-    it "won't get new unless authorized" do
-      get :new, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      
-      sign_in @user
-      get :new, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-    end
-    
-    it 'must get new if authorized' do
-      sign_in @admin
-      get :new, :use_route => :fine_print
-      assert_response :success
-    end
-    
-    it "won't create unless authorized" do
-      attributes = Hash.new
-      attributes[:name] = 'some_name'
-      attributes[:title] = 'Some title'
-      attributes[:content] = 'Some content'
-      
-      post :create, :contract => attributes, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      expect(assigns(:contract)).to be_nil
-      
-      sign_in @user
-      post :create, :contract => attributes, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      expect(assigns(:contract)).to be_nil
-    end
-    
-    it 'must create if authorized' do
-      sign_in @admin
-      attributes = Hash.new
-      attributes[:name] = 'some_name'
-      attributes[:title] = 'Some title'
-      attributes[:content] = 'Some content'
-      
-      post :create, :contract => attributes, :use_route => :fine_print
-      assert_redirected_to assigns(:contract)
-      expect(assigns(:contract).errors).to be_empty
-      expect(assigns(:contract).name).to eq 'some_name'
-      expect(assigns(:contract).title).to eq 'Some title'
-      expect(assigns(:contract).content).to eq 'Some content'
-    end
-    
-    it "won't edit unless authorized" do
-      get :edit, :id => @contract.id, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      
-      sign_in @user
-      get :edit, :id => @contract.id, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-    end
-    
-    it 'must edit if authorized' do
-      sign_in @admin
-      get :edit, :id => @contract.id, :use_route => :fine_print
-      assert_response :success
-    end
-    
-    it "won't update unless authorized" do
-      attributes = Hash.new
-      attributes[:name] = 'some_name'
-      attributes[:title] = 'Some title'
-      attributes[:content] = 'Some content'
-      name = @contract.name
-      title = @contract.title
-      content = @contract.content
-      
-      put :update, :id => @contract.id, :contract => attributes, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      expect(@contract.errors).not_to be_empty
-      @contract.reload
-      expect(@contract.name).to eq name
-      expect(@contract.title).to eq title
-      expect(@contract.content).to eq content
-      
-      sign_in @user
-      put :update, :id => @contract.id, :contract => attributes, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      expect(@contract.errors).not_to be_empty
-      @contract.reload
-      expect(@contract.name).to eq name
-      expect(@contract.title).to eq title
-      expect(@contract.content).to eq content
-    end
-    
-    it 'must update if authorized' do
-      attributes = Hash.new
-      attributes[:name] = 'some_name'
-      attributes[:title] = 'Some title'
-      attributes[:content] = 'Some content'
-
-      sign_in @admin
-      put :update, :id => @contract.id, :contract => attributes, :use_route => :fine_print
-      assert_redirected_to @contract
-      @contract.reload
-      expect(@contract.errors).to be_empty
-      expect(@contract.name).to eq 'some_name'
-      expect(@contract.title).to eq 'Some title'
-      expect(@contract.content).to eq 'Some content'
-    end
-
-    it "won't destroy unless authorized" do
-      delete :destroy, :id => @contract.id, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      expect(Contract.find(@contract.id)).to eq @contract
-      
-      sign_in @user
-      delete :destroy, :id => @contract.id, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      expect(Contract.find(@contract.id)).to eq @contract
-    end
-    
-    it 'must destroy if authorized' do
-      sign_in @admin
-      delete :destroy, :id => @contract.id, :use_route => :fine_print
-      assert_redirected_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, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      @contract.reload
-      expect(@contract.is_published?).to eq false
-      
-      sign_in @user
-      put :publish, :id => @contract.id, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      @contract.reload
-      expect(@contract.is_published?).to eq false
-    end
-    
-    it 'must publish if authorized' do
-      expect(@contract.is_published?).to eq false
-      sign_in @admin
-
-      put :publish, :id => @contract.id, :use_route => :fine_print
-      assert_redirected_to contracts_path
-      @contract.reload
-      expect(@contract.is_published?).to eq true
-    end
-
-    it "won't unpublish unless authorized" do
-      @contract.publish
-      expect(@contract.is_published?).to eq true
-      put :unpublish, :id => @contract.id, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      @contract.reload
-      expect(@contract.is_published?).to eq true
-      
-      sign_in @user
-      put :unpublish, :id => @contract.id, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      @contract.reload
-      expect(@contract.is_published?).to eq true
-    end
-    
-    it 'must unpublish if authorized' do
-      @contract.publish
-      expect(@contract.is_published?).to eq true
-
-      sign_in @admin
-      put :unpublish, :id => @contract.id, :use_route => :fine_print
-      assert_redirected_to contracts_path
-      @contract.reload
-      expect(@contract.is_published?).to eq false
-    end
-
-    it "won't new_version unless authorized" do
-      @contract.publish
-      expect(@contract.is_published?).to eq true
-      
-      put :new_version, :id => @contract.id, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      expect(assigns(:contract)).to be_nil
-      
-      sign_in @user
-      put :new_version, :id => @contract.id, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      expect(assigns(:contract)).to be_nil
-    end
-    
-    it 'must new_version if authorized' do
-      @contract.publish
-      expect(@contract.is_published?).to eq true
-
-      sign_in @admin
-      put :new_version, :id => @contract.id, :use_route => :fine_print
-      assert_response :success
-      expect(assigns(:contract)).not_to be_nil
-    end
-  end
-end

data/spec/controllers/home_controller_spec.rb~

@@ -1,25 +0,0 @@
-require 'spec_helper'
-
-module FinePrint
-  describe HomeController do
-    before do
-      setup_controller_spec
-    end
-
-    it 'wont get index unless authorized' do
-      get :index, :use_route => :fine_print
-      assert_response :redirect
-      
-      sign_in @user
-      get :index, :use_route => :fine_print
-      assert_response :redirect
-    end
-    
-    it 'must get index if authorized' do
-      sign_in @user
-      @user.is_admin = true
-      get :index, :use_route => :fine_print
-      assert_response :success
-    end
-  end
-end

data/spec/controllers/signatures_controller_spec.rb~

@@ -1,46 +0,0 @@
-require 'spec_helper'
-
-module FinePrint
-  describe SignaturesController do
-    routes { FinePrint::Engine.routes }
-
-    before do
-      setup_controller_spec
-      @signature = FactoryGirl.create(:signature)
-      @signature.reload
-    end
-
-    it 'won''t get index unless authorized' do
-      get :index, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      
-      sign_in @user
-      get :index, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-    end
-    
-    it 'must get index if authorized' do
-      sign_in @admin
-      get :index, :use_route => :fine_print
-      assert_response :success
-    end
-
-    it 'won''t destroy unless authorized' do
-      delete :destroy, :id => @signature.id, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      expect(Signature.find(@signature.id)).to eq @signature
-      
-      sign_in @user
-      delete :destroy, :id => @signature.id, :use_route => :fine_print
-      assert_redirected_to FinePrint.redirect_path
-      expect(Signature.find(@signature.id)).to eq @signature
-    end
-    
-    it 'must destroy if authorized' do
-      sign_in @admin
-      delete :destroy, :id => @signature.id, :use_route => :fine_print
-      assert_redirected_to signatures_path
-      expect(Signature.find_by_id(@signature.id)).to be_nil
-    end
-  end
-end

data/spec/dummy/app/controllers/dummy_models_controller.rb~

@@ -1,29 +0,0 @@
-class DummyModelsController < ActionController::Base
-  before_filter :get_dummy
-  
-  def hide
-    render :show
-  end
-  
-  def show
-    commontator_thread_show(@dummy_model)
-  end
-  
-  def url_options
-    return Hash.new if request.nil?
-    super
-  end
-  
-  def view_context
-    view_context = view_context_class.new
-    view_context.view_paths = view_paths
-    view_context.controller = self
-    view_context
-  end
-  
-  protected
-  
-  def get_dummy
-    @dummy_model = DummyModel.find(params[:id])
-  end
-end

data/spec/dummy/app/models/dummy_user.rb~

@@ -1,4 +0,0 @@
-module FinePrint
-  class DummyUser < ActiveRecord::Base
-  end
-end

data/spec/dummy/app/models/user.rb~

@@ -1,78 +0,0 @@
-module FinePrint
-  class User < ActiveRecord::Base
-    has_many :signatures, :inverse_of => :contract
-
-    has_many :same_name, :class_name => 'Contract', :primary_key => :name, :foreign_key => :name
-
-    attr_accessible :content, :title, :name
-
-    before_validation :downcase_name
-
-    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
-      self.version = (same_name.published.first.try(:version) || 0) + 1
-      save
-    end
-
-    def unpublish
-      self.version = nil
-      save
-    end
-
-    def draft_copy
-      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
-
-    alias_method :can_be_destroyed?, :can_be_updated?
-
-    protected
-
-    def downcase_name
-      self.name = name.downcase
-    end
-  end
-end

data/spec/dummy/config/application.rb~

@@ -1,60 +0,0 @@
-require File.expand_path('../boot', __FILE__)
-
-require 'rails/all'
-
-Bundler.require
-require 'fine_print'
-require 'devise'
-
-module Dummy
-  class Application < Rails::Application
-    # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
-
-    # Custom directories with classes and modules you want to be autoloadable.
-    # config.autoload_paths += %W(#{config.root}/extras)
-
-    # Only load the plugins named here, in the order given (default is alphabetical).
-    # :all can be used as a placeholder for all plugins not explicitly named.
-    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
-
-    # Activate observers that should always be running.
-    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
-
-    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
-    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
-
-    # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = 'utf-8'
-
-    # Configure sensitive parameters which will be filtered from the log file.
-    config.filter_parameters += [:password]
-
-    # Enable escaping HTML in JSON.
-    config.active_support.escape_html_entities_in_json = true
-
-    # Use SQL instead of Active Record's schema dumper when creating the database.
-    # This is necessary if your schema can't be completely dumped by the schema dumper,
-    # like if you have constraints or database-specific column types
-    # config.active_record.schema_format = :sql
-
-    # Enforce whitelist mode for mass assignment.
-    # This will create an empty whitelist of attributes available for mass-assignment for all models
-    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
-    # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = true
-
-    # Enable the asset pipeline
-    config.assets.enabled = true
-
-    # Version of your assets, change this if you want to expire all your assets
-    config.assets.version = '1.0'
-  end
-end
-

data/spec/dummy/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| user.is_admin }
-
-  # Proc called with user as argument that returns true iif the user is logged in.
-  # 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/spec/dummy/config/initializers/session_store.rb~

@@ -1,8 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
-
-# Use the database for sessions instead of the cookie-based default,
-# which shouldn't be used to store highly confidential information
-# (create the session table with "rails generate session_migration")
-# Dummy::Application.config.session_store :active_record_store

data/spec/dummy/config/initializers/wrap_parameters.rb~

@@ -1,14 +0,0 @@
-# Be sure to restart your server when you modify this file.
-#
-# This file contains settings for ActionController::ParamsWrapper which
-# is enabled by default.
-
-# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
-ActiveSupport.on_load(:action_controller) do
-  wrap_parameters format: [:json]
-end
-
-# Disable root element in JSON by default.
-ActiveSupport.on_load(:active_record) do
-  self.include_root_in_json = false
-end

data/spec/dummy/config/routes.rb~

@@ -1,4 +0,0 @@
-Rails.application.routes.draw do
-
-  mount FinePrint::Engine => "/fine_print"
-end

data/spec/dummy/db/migrate/1_create_dummy_users.rb~

@@ -1,8 +0,0 @@
-class CreateDummyUsers < ActiveRecord::Migration
-  def change
-    create_table :dummy_users do |t|
-
-      t.timestamps
-    end
-  end
-end

data/spec/dummy/script/rails

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
-
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
-require File.expand_path('../../config/boot',  __FILE__)
-require 'rails/commands'