fine_print 0.1.1 → 1.0.0

data/spec/controllers/signatures_controller_spec.rb

@@ -0,0 +1,46 @@
+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/controllers/signatures_controller_spec.rb~

@@ -0,0 +1,46 @@
+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/README.md

@@ -1,3 +1,3 @@
 ## Dummy
 
-A dummy application used to test the Fine Print engine.
+A dummy application used to test the FinePrint engine.

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

@@ -0,0 +1,2 @@
+class DummyModelsController < ActionController::Base
+end

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

@@ -0,0 +1,29 @@
+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/helpers/application_helper.rb

@@ -1,2 +1,15 @@
 module ApplicationHelper
+  @@user = nil
+  
+  def current_user
+    @@user
+  end
+  
+  def sign_in(user)
+    @@user = user
+  end
+  
+  def sign_out
+    @@user = nil
+  end
 end

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

@@ -0,0 +1,3 @@
+class DummyUser < ActiveRecord::Base
+  # attr_accessible :title, :body
+end

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

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

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

@@ -0,0 +1,78 @@
+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

@@ -3,7 +3,7 @@ require File.expand_path('../boot', __FILE__)
 require 'rails/all'
 
 Bundler.require
-require "fine_print"
+require 'fine_print'
 
 module Dummy
   class Application < Rails::Application
@@ -30,7 +30,7 @@ module Dummy
     # config.i18n.default_locale = :de
 
     # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
+    config.encoding = 'utf-8'
 
     # Configure sensitive parameters which will be filtered from the log file.
     config.filter_parameters += [:password]

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

@@ -0,0 +1,60 @@
+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

@@ -0,0 +1,36 @@
+# Change the settings below to suit your needs
+# All settings are initially set to their default values
+FinePrint.configure do |config|
+  # Engine Configuration
+
+  # Name of the ApplicationController helper method that returns the current user.
+  # Default: 'current_user'
+  config.current_user_method = 'current_user'
+
+  # Proc called with user as argument that should return true if and only if 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 that returns true if and only if the provided 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.nil? }
+  config.user_signed_in_proc = lambda { |user| !user.nil? }
+
+  # 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/fine_print.rb~

@@ -0,0 +1,36 @@
+# Change the settings below to suit your needs
+# All settings are initially set to their default values
+FinePrint.configure do |config|
+  # Engine Configuration
+
+  # Name of the ApplicationController helper method that returns the current user.
+  # Default: 'current_user'
+  config.current_user_method = 'current_user'
+
+  # Proc called with user as argument that should return true if and only if 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 that returns true if and only if the provided 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.nil? }
+  config.user_signed_in_proc = lambda { |user| !user.nil? }
+
+  # 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,6 +1,6 @@
 # Be sure to restart your server when you modify this file.
 
-Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+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

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

@@ -0,0 +1,8 @@
+# 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

@@ -5,7 +5,7 @@
 
 # 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]
+  wrap_parameters :format => [:json]
 end
 
 # Disable root element in JSON by default.

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

@@ -0,0 +1,14 @@
+# 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 +1,3 @@
 Rails.application.routes.draw do
-
-  mount FinePrint::Engine => "/fine_print"
+  mount FinePrint::Engine => '/fine_print'
 end

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

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

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

@@ -0,0 +1,9 @@
+class CreateDummyUsers < ActiveRecord::Migration
+  def change
+    create_table :dummy_users do |t|
+      t.boolean :is_admin, :null => false, :default => false
+
+      t.timestamps
+    end
+  end
+end

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

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

data/spec/dummy/db/schema.rb

@@ -11,26 +11,34 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 0) do
+ActiveRecord::Schema.define(:version => 1) do
 
-  create_table "fine_print_agreements", :force => true do |t|
-    t.string   "name"
-    t.text     "content"
+  create_table "dummy_users", :force => true do |t|
+    t.boolean  "is_admin",   :default => false, :null => false
+    t.datetime "created_at",                    :null => false
+    t.datetime "updated_at",                    :null => false
+  end
+
+  create_table "fine_print_contracts", :force => true do |t|
+    t.string   "name",       :null => false
     t.integer  "version"
+    t.string   "title",      :null => false
+    t.text     "content",    :null => false
     t.datetime "created_at", :null => false
     t.datetime "updated_at", :null => false
   end
 
-  add_index "fine_print_agreements", ["name", "version"], :name => "index_fine_print_agreements_on_name_and_version"
+  add_index "fine_print_contracts", ["name", "version"], :name => "index_fine_print_contracts_on_name_and_version", :unique => true
 
-  create_table "fine_print_user_agreements", :force => true do |t|
-    t.integer  "user_id"
-    t.integer  "agreement_id"
-    t.datetime "created_at",   :null => false
-    t.datetime "updated_at",   :null => false
+  create_table "fine_print_signatures", :force => true do |t|
+    t.integer  "contract_id", :null => false
+    t.integer  "user_id",     :null => false
+    t.string   "user_type",   :null => false
+    t.datetime "created_at",  :null => false
+    t.datetime "updated_at",  :null => false
   end
 
-  add_index "fine_print_user_agreements", ["agreement_id"], :name => "index_fine_print_user_agreements_on_agreement_id"
-  add_index "fine_print_user_agreements", ["user_id", "agreement_id"], :name => "index_fine_print_user_agreements_on_user_id_and_agreement_id"
+  add_index "fine_print_signatures", ["contract_id"], :name => "index_fine_print_signatures_on_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