fine_print 0.0.1

data/lib/fine_print/fine_print_agreement.rb~

@@ -0,0 +1,26 @@
+require 'fine_print/agreements_helper'
+
+module FinePrint
+  module FinePrintAgreement
+    def self.included(base)
+      base.helper FinePrint::AgreementHelper
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def fine_print_agreement(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        class_eval do
+          before_filter(options.except(*FinePrint::AGREEMENT_OPTIONS)) do |controller|
+            FinePrint.require_agreements(controller, args, options.slice(*FinePrint::AGREEMENT_OPTIONS))
+          end
+        end
+      end
+
+      alias_method :fine_print_agreements, :fine_print_agreement
+    end
+  end
+end
+
+ActionController::Base.send :include, FinePrint::FinePrintAgreement
+

data/lib/fine_print/require_agreement.rb~

@@ -0,0 +1,22 @@
+module FinePrint
+  module FinePrintAgreement
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def fine_print_agreement(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        class_eval do
+          before_filter(options) { |c| FinePrint.require_agreements(c, args) }
+        end
+      end
+
+      alias_method :fine_print, :fine_print_agreement
+      alias_method :fine_print_agreements, :fine_print_agreement
+    end
+  end
+end
+
+ActionController::Base.send :include, FinePrint::RequireAgreement
+

data/lib/fine_print/security_transgression.rb

@@ -0,0 +1,4 @@
+module FinePrint
+  class SecurityTransgression < StandardError
+  end
+end

data/lib/fine_print/security_transgression.rb~

@@ -0,0 +1,3 @@
+module FinePrint
+  class SecurityTransgression < StandardError; end
+end

data/lib/fine_print/version.rb

@@ -0,0 +1,3 @@
+module FinePrint
+  VERSION = "0.0.1"
+end

data/lib/fine_print/version.rb~

@@ -0,0 +1,3 @@
+module FinePrint
+  VERSION = "0.0.0"
+end

data/lib/fine_print.rb

@@ -0,0 +1,69 @@
+require "fine_print/engine"
+require "fine_print/fine_print_agreement"
+
+module FinePrint
+  ASSET_FILES = %w(dialog.js)
+
+  # Attributes
+
+  # Can be set in initializer only
+  ENGINE_OPTIONS = [
+    :current_user_method,
+    :user_admin_proc,
+    :redirect_path,
+    :sign_in_path
+  ]
+
+  # Can be set in initializer or passed as an option to fine_print_agreement
+  AGREEMENT_OPTIONS = [
+    :agreement_notice,
+    :accept_path,
+    :cancel_path,
+    :use_referers,
+    :use_modal_dialogs
+  ]
+  
+  (ENGINE_OPTIONS + AGREEMENT_OPTIONS).each do |option|
+    mattr_accessor option
+  end
+
+  ActiveSupport.on_load(:before_initialize) do
+    Rails.configuration.assets.precompile += ASSET_FILES
+  end
+  
+  def self.configure
+    yield self
+  end
+
+  def self.get_option(options, name)
+    (!options.nil? && !options[name].nil?) ? options[name] : self.send(name)
+  end
+
+  def self.require_agreements(controller, names, options)
+    user = controller.send current_user_method
+    fine_print_dialog_agreements = []
+    names.each do |name|
+      agreement = Agreement.latest_ready(name)
+      next if agreement.nil? || agreement.accepted_by?(user)
+      if get_option(options, :use_modal_dialogs)
+        fine_print_dialog_agreements << agreement
+      else
+        controller.session[:fine_print_accept_path] = options[:accept_path]
+        controller.session[:fine_print_cancel_path] = options[:cancel_path]
+        if get_option(options, :use_referers)
+          controller.session[:fine_print_request_url] = controller.request.url
+          controller.session[:fine_print_request_ref] = controller.request.referer
+        end
+        controller.redirect_to controller.fine_print.agreement_path(agreement),
+          :notice => get_option(options, :agreement_notice)
+      end
+    end
+    controller.instance_variable_set(:@fine_print_dialog_agreements, fine_print_dialog_agreements)
+    controller.instance_variable_set(:@fine_print_user, user)
+    controller.instance_variable_set(:@fine_print_dialog_notice, get_option(options, :agreement_notice))
+  end
+
+  def self.is_admin?(user)
+    !user.nil? && user_admin_proc.call(user)
+  end
+end

data/lib/fine_print.rb~

@@ -0,0 +1,68 @@
+require "fine_print/engine"
+require "fine_print/fine_print_agreement"
+
+module FinePrint
+  ASSET_FILES = %w(dialog.js)
+
+  # Attributes
+
+  # Can be set in initializer only
+  ENGINE_OPTIONS = [
+    :current_user_method,
+    :user_admin_proc,
+    :redirect_path,
+    :sign_in_path
+  ]
+
+  # Can be set in initializer or passed as an option to fine_print_agreement
+  AGREEMENT_OPTIONS = [
+    :agreement_notice,
+    :accept_path,
+    :cancel_path,
+    :use_referers,
+    :use_modal_dialogs
+  ]
+  
+  (ENGINE_OPTIONS + AGREEMENT_OPTIONS).each do |option|
+    mattr_accessor option
+  end
+
+  ActiveSupport.on_load(:before_initialize) do
+    Rails.configuration.assets.precompile += ASSET_FILES
+  end
+  
+  def self.configure
+    yield self
+  end
+
+  def self.get_option(options, name)
+    (!options.nil? && !options[name].nil?) ? options[name] : self.send(name)
+  end
+
+  def self.require_agreements(controller, names, options)
+    user = controller.send current_user_method
+    fine_print_dialog_agreements = []
+    names.each do |name|
+      agreement = Agreement.latest_ready(name)
+      next if agreement.nil? || agreement.accepted_by?(user)
+      if get_option(options, :use_modal_dialogs)
+        fine_print_dialog_agreements << agreement
+      else
+        controller.session[:fine_print_accept_path] = options[:accept_path]
+        if get_option(options, :use_referers)
+          controller.session[:fine_print_request_url] = controller.request.url
+          controller.session[:fine_print_request_ref] = controller.request.referer
+        end
+        controller.redirect_to controller.fine_print.agreement_path(agreement),
+          :notice => get_option(options, :agreement_notice)
+      end
+    end
+    controller.instance_variable_set(:@fine_print_dialog_agreements, fine_print_dialog_agreements)
+    controller.instance_variable_set(:@fine_print_user, user)
+    controller.instance_variable_set(:@fine_print_dialog_notice, get_option(options, :agreement_notice))
+  end
+
+  def self.is_admin?(user)
+    !user.nil? && user_admin_proc.call(user)
+  end
+end

data/lib/tasks/fine_print_tasks.rake

@@ -0,0 +1,42 @@
+COPY_TASKS = ['assets/stylesheets', 'views', 'helpers', 'controllers', 'models']
+
+namespace :fine_print do
+  namespace :install do
+    desc "Copy initializers from fine_print to application"
+    task :initializers do
+      Dir.glob(File.expand_path('../../../config/initializers/*.rb', __FILE__)) do |file|
+        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
+          print "Copied initializer #{File.basename(file)} from fine_print\n"
+        end
+      end
+    end
+  end
+
+  namespace :copy do
+    COPY_TASKS.each do |path|
+      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
+        print "Copied #{name} from fine_print\n"
+      end
+    end
+  end
+  
+  desc "Copy migrations from fine_print to application"
+  task :install do
+    Rake::Task["fine_print:install:initializers"].invoke
+    Rake::Task["fine_print:install:migrations"].invoke
+  end
+  
+  desc "Copy assets, views, helpers, controllers and models from fine_print to application"
+  task :copy do
+    COPY_TASKS.each do |path|
+      Rake::Task["fine_print:copy:#{File.basename(path)}"].invoke
+    end
+  end
+end
+

data/lib/tasks/fine_print_tasks.rake~

@@ -0,0 +1,85 @@
+COPY_TASKS = ['assets/stylesheets', 'views', 'helpers', 'controllers', 'models']
+
+namespace :fine_print do
+  namespace :install do
+    desc "Copy initializers from fine_print to application"
+    task :initializers do
+      Dir.glob(File.expand_path('../../../config/initializers/*.rb', __FILE__)) do |file|
+        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
+          print "Copied initializer #{File.basename(file)} from fine_print\n"
+        end
+      end
+    end
+  end
+
+  namespace :copy do
+    COPY_TASKS.each do |path|
+      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
+        print "Copied #{name} from fine_print\n"
+      end
+    end
+  end
+  
+  desc "Copy migrations from fine_print to application"
+  task :install do
+    Rake::Task["fine_print:install:initializers"].invoke
+    Rake::Task["fine_print:install:migrations"].invoke
+  end
+  
+  desc "Copy assets, views, helpers, controllers and models from fine_print to application"
+  task :copy do
+    COPY_TASKS.each do |path|
+      Rake::Task["fine_print:copy:#{File.basename(path)}"].invoke
+    end
+  end
+end
+
+
+COPY_TASKS = ['assets/images', 'assets/stylesheets', 'views', 'mailers', 'helpers', 'controllers', 'models']
+
+namespace :commontator do
+  namespace :install do
+    desc "Copy initializers from commontator to application"
+    task :initializers do
+      Dir.glob(File.expand_path('../../../config/initializers/*.rb', __FILE__)) do |file|
+        if File.exists?(File.expand_path(File.basename(file), 'config/initializers'))
+          print "NOTE: Initializer #{File.basename(file)} from commontator has been skipped. Initializer with the same name already exists.\n"
+        else
+          cp file, 'config/initializers', :verbose => false
+          print "Copied initializer #{File.basename(file)} from commontator\n"
+        end
+      end
+    end
+  end
+  
+  namespace :copy do
+    COPY_TASKS.each do |path|
+      name = File.basename(path)
+      desc "Copy #{name} from commontator to application"
+      task name.to_sym do
+        cp_r File.expand_path("../../../app/#{path}/commontator", __FILE__), "app/#{path}", :verbose => false
+        print "Copied #{name} from commontator\n"
+      end
+    end
+  end
+  
+  desc "Copy initializers and migrations from commontator to application"
+  task :install do
+    Rake::Task["commontator:install:initializers"].invoke
+    Rake::Task["commontator:install:migrations"].invoke
+  end
+  
+  desc "Copy assets, views, mailers, helpers, controllers and models from commontator to application"
+  task :copy do
+    COPY_TASKS.each do |path|
+      Rake::Task["commontator:copy:#{File.basename(path)}"].invoke
+    end
+  end
+end
+

data/spec/dummy/README.md

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

data/spec/dummy/README.md~

@@ -0,0 +1,3 @@
+## Dummy
+
+A dummy application used for testing the fine print engine.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

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

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config/application.rb

@@ -0,0 +1,59 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "fine_print"
+
+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/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,67 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to nil and saved in location specified by config.assets.prefix
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Prepend all log lines with the following tags
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  # config.active_record.auto_explain_threshold_in_seconds = 0.5
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!