disclaimer 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Rob Nichols
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,60 @@
+= Disclaimer
+
+A tool for adding disclaimers to applications.
+
+== Installation
+
+=== Gemfile  TODO - add config option
+
+=== Routing
+
+Update config/routes.rb by adding:
+
+    mount Disclaimer::Engine => "/disclaimer"
+
+See test/dummy/config/routes.rb
+
+== Usage
+
+First create a disclaimer document (see below) and give it a name. (The name is in underscore form: like_this).
+
+Then in your application controller, define the disclaimer you wish to use with 'disclaimer(:document_name)'.
+
+So for example, you have a disclaimer document with the name :our_company_disclaimer and you want to make sure that
+everyone who visits your products controller has accepted this disclaimer. Modify the controller like this:
+
+    class ProductsController < ApplicationController
+
+      disclaimer :our_company_disclaimer
+
+
+      .....(rest of controller)....
+
+    end
+
+Then when a user navigates to the products controller, they will be redirected to the disclaimer document at:
+
+  /disclaimer/documents/our_company_disclaimer
+
+If they accept the disclaimer, they will be redirected back to the page they were originally aiming for.
+
+The acceptance is stored in session and therefore will be remembered for as long as the browser is open.
+
+=== Options
+
+A before_filter is used to provide this functionality, and you can pass before_filter options through from
+the disclaimer declaration. Therefore, to only display a disclaimer for the index and show actions in a controller
+use:
+
+     disclaimer :our_company_disclaimer, :only => [:index, :show]
+
+== Documents and Segments
+
+Documents can be created at /disclaimer/documents, and Segments as /disclaimer/segments. Documents can contain
+many segments, and segments can be shared across many documents (that is, you can share common sections of a disclaimer
+across many documents). This behaviour can be overwritten in the host application.
+
+The disclaimer engine does not restrict access to these controllers. Such restriction should be configured in
+the host application. However, everyone needs access to the disclaimer documents#show action so that they can read
+and accept the disclaimer.
+

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Disclaimer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/disclaimer/application.js

@@ -0,0 +1,16 @@
+// 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 jquery-ui
+//= require_tree .

data/app/assets/javascripts/disclaimer/documents.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/disclaimer/segments.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/disclaimer/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/app/assets/stylesheets/disclaimer/documents.css

@@ -0,0 +1,9 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+.ui-icon {
+  float: left;
+  margin-right: 0.5em;
+}

data/app/assets/stylesheets/disclaimer/segments.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/disclaimer/application_controller.rb

@@ -0,0 +1,4 @@
+module Disclaimer
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/disclaimer/documents_controller.rb

@@ -0,0 +1,74 @@
+require_dependency "disclaimer/application_controller"
+
+module Disclaimer
+  class DocumentsController < ApplicationController
+    before_filter :get_document, :only => [:show, :delete, :destroy, :edit, :update, :accept]
+    
+    def index
+      @documents = Document.all
+    end
+  
+    def show
+    end
+  
+    def new
+      @document = Document.new
+    end
+    
+    def create
+      new
+      update
+    end
+    
+    def edit
+      render :new
+    end
+    
+    def update
+      params[:document][:segments] = replace_with_segments(params[:document][:segments])    
+      @document.update_attributes(params[:document])
+      redirect_to document_path(@document)      
+    end
+  
+    def delete
+    end
+    
+    def destroy
+      @document.destroy
+      redirect_to :controller => 'disclaimer/documents', :action => 'index'
+    end
+    
+    def accept
+      return_path = disclaimer_return_path
+      store_disclaimer_acceptance
+      redirect_to return_path || :root
+    end
+  
+    private
+    def get_document
+      @document = Document.find_by_name(params[:id])
+    end
+    
+    def replace_with_segments(hash_with_ids_as_keys = nil)
+      if hash_with_ids_as_keys
+        hash_with_ids_as_keys.keys.collect{|id| Segment.find(id)}
+      else
+        []
+      end
+    end
+
+    def store_disclaimer_acceptance
+      session[:disclaimer] ||= {}
+      session[:disclaimer][@document.name.to_sym] = ACCEPTED
+    end
+
+    def disclaimer_return_path
+      if session[:disclaimer]
+        return_path = session[:disclaimer][@document.name.to_sym]
+        return return_path if return_path != ACCEPTED
+      end
+
+    end
+    
+  end
+end

data/app/controllers/disclaimer/segments_controller.rb

@@ -0,0 +1,45 @@
+require_dependency "disclaimer/application_controller"
+
+module Disclaimer
+  class SegmentsController < ApplicationController
+    before_filter :get_segment, :only => [:show, :delete, :destroy, :edit, :update]
+    
+    def index
+      @segments = Segment.all
+    end
+  
+    def show
+    end
+  
+    def new
+      @segment = Segment.new
+    end
+    
+    def create
+      new
+      update
+    end
+    
+    def edit
+      render :new
+    end
+    
+    def update
+      @segment.update_attributes(params[:segment])
+      redirect_to segment_path(@segment)      
+    end
+  
+    def delete
+    end
+    
+    def destroy
+      @segment.destroy
+      redirect_to :controller => 'disclaimer/segments', :action => 'index'
+    end
+  
+    private
+    def get_segment
+      @segment = Segment.find_by_name(params[:id])
+    end
+  end
+end

data/app/helpers/disclaimer/application_helper.rb

@@ -0,0 +1,4 @@
+module Disclaimer
+  module ApplicationHelper
+  end
+end

data/app/helpers/disclaimer/documents_helper.rb

@@ -0,0 +1,4 @@
+module Disclaimer
+  module DocumentsHelper
+  end
+end

data/app/helpers/disclaimer/segments_helper.rb

@@ -0,0 +1,4 @@
+module Disclaimer
+  module SegmentsHelper
+  end
+end

data/app/models/disclaimer/document.rb

@@ -0,0 +1,57 @@
+module Disclaimer
+  class Document < ActiveRecord::Base
+    attr_accessible :footer, :header, :title, :name, :segments
+    
+    before_save :underscore_name
+    
+    has_many :segment_holders, :uniq => true
+    has_many :segments, :through => :segment_holders, :uniq => true
+    
+    validates :name, :presence => true
+    
+    def segment_holder_for(segment)
+      segment_holders.where(:segment_id => segment.id).first
+    end
+    
+    def to_param
+      name
+    end
+    
+    def title
+      ((!super || super.empty?) && name.present?) ? name.humanize : super
+    end
+    
+    private
+    def method_missing(method, *args)  
+      segment = args.first     
+      if act_as_list_methods.include?(method.to_sym) and segment.kind_of? Segment
+        modify_via_segment_holder_acts_as_list_method(method, segment)
+      else
+        super(method, *args)
+      end     
+    end
+    
+    def act_as_list_methods
+      @act_as_list_methods ||= ActiveRecord::Acts::List::InstanceMethods.instance_methods
+    end
+    
+    def modify_via_segment_holder_acts_as_list_method(method, segment)
+      segment_holder = segment_holder_for(segment)
+      raise segment_not_associated_message(method, segment) unless segment_holder     
+      segment_holder.send(method)  
+    end
+    
+    def segment_not_associated_message(method, segment)
+      <<EOF
+The segment is not associated with the document, and therefore document.#{method}(segment) is not valid: 
+#{inspect} 
+#{segment.inspect}
+EOF
+    end
+    
+    def underscore_name
+      self.name = self.name.downcase.gsub(/\s+/, '_')
+    end
+    
+  end
+end

data/app/models/disclaimer/segment.rb

@@ -0,0 +1,26 @@
+module Disclaimer
+  class Segment < ActiveRecord::Base
+    attr_accessible :body, :title, :name
+    
+    before_save :underscore_name
+    
+    has_many :segment_holders
+    has_many :documents, :through => :segment_holders
+    
+    validates :name, :presence => true
+    
+    def to_param
+      name
+    end  
+    
+    def title
+      ((!super || super.empty?) && name.present?) ? name.humanize : super
+    end
+    
+    private
+    def underscore_name
+      self.name = self.name.downcase.gsub(/\s+/, '_')
+    end
+    
+  end
+end

data/app/models/disclaimer/segment_holder.rb

@@ -0,0 +1,17 @@
+require 'acts_as_list'
+
+module Disclaimer
+  class SegmentHolder < ActiveRecord::Base
+    attr_accessible :document_id, :position, :segment_id
+    
+    belongs_to :document
+    belongs_to :segment
+    
+    acts_as_list :scope => :document
+    
+    # I needed to use default_scope to preserve ordering in through relationships.
+    # Using 'acts_as_list :scope => :document' alone does not preserve ordering
+    # in the 'has_many :segments, :through => :segment_holders' relationship.
+    default_scope :order => :position 
+  end
+end

data/app/views/disclaimer/documents/delete.html.erb

@@ -0,0 +1,8 @@
+<h1>Delete Document</h1>
+<h2><%= @document.title %></h2>
+<p>Are you sure you want to delete this document?</p>
+
+<%= form_for(@document, :url => document_path(@document), :method => :delete) do |form| %>
+<%= form.submit('Yes') %>
+<%= link_to('Cancel', url_for(:back)) %>
+<% end %>

data/app/views/disclaimer/documents/index.html.erb

@@ -0,0 +1,28 @@
+<h1>Documents</h1>
+<p><%= link_to('New Document', new_document_path) %></p>
+
+<h1>Disclaimer</h1>
+
+<% if @documents.empty? %>
+<p>There are currently no disclaimer documents</p>
+<% else %>
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Title</th>
+    <th>Segments</th>
+    <th colspan="3">Action</th>
+  </tr>
+<%   @documents.each do |document| %>
+  <tr>
+    <td><%= document.name %></td>
+    <td><%= document.title %></td>
+    <td><%= document.segments.collect{|d| d.name}.join(', ') %>
+    <td><%= link_to('Show', document_path(document)) %></td>
+    <td><%= link_to('Edit', edit_document_path(document)) %></td>
+    <td><%= link_to('Delete', delete_document_path(document)) %></td>
+  </tr>
+<%   end %>
+</table>
+<% end %>
+

data/app/views/disclaimer/documents/new.html.erb

@@ -0,0 +1,48 @@
+<h1>Disclaimer document</h1>
+
+<%= form_for(@document) do |form| %>
+
+<p>
+  <%= form.label(:name) %><br/>
+  <%= form.text_field(:name) %>
+</p>
+
+<p>
+  <%= form.label(:title) %><br/>
+  <%= form.text_field(:title) %>
+</p>
+
+<p>
+  <%= form.label(:header) %><br/>
+  <%= form.text_area(:header, :rows => 4) %>
+</p>
+
+<p>Segments</p>
+
+<ul>
+<% Disclaimer::Segment.all.each do |segment| %>
+  <li>
+   
+    <%= check_box_tag(
+          :segment_ids,  
+          nil,  
+          @document.segments.include?(segment),  
+          :name => "document[segments][#{segment.id}]" 
+        )
+    %>
+    
+    <%= segment.name %>
+  </li>
+<% end %>
+</ul>
+<p>
+  <%= form.label(:footer) %><br/>
+  <%= form.text_area(:footer, :rows => 4) %>
+</p>
+
+<p>
+  <%= form.submit %>
+</p>
+
+<% end %>
+

data/app/views/disclaimer/documents/show.html.erb

@@ -0,0 +1,19 @@
+<header>
+  <h1><%= @document.title %></h1>
+  <%= @document.header %>
+</header>
+<%= javascript_tag('$(function() {$( "#articles" ).accordion({heightStyle: "content"});});') %>
+<div id="articles">
+<% @document.segments.each do |segment| %>
+
+    <h3><%= segment.title %></h3>
+    <div><%= segment.body %></div>
+
+<% end %>
+</div>
+<footer>
+  <%= @document.footer %>
+  <%= form_for(@document, :url => accept_document_path(@document), :method => 'post') do |form| %>
+    <%= form.submit('Accept') %>
+  <% end %>
+</footer>

data/app/views/disclaimer/segments/_segment.html.erb

@@ -0,0 +1,8 @@
+<section class="segment">
+  <header>
+    <h2><%= segment.title %></h2>
+  </header>
+  <div class="content">
+    <%= segment.body %>
+  </div>
+</section>

data/app/views/disclaimer/segments/delete.html.erb

@@ -0,0 +1,8 @@
+<h1>Delete Segment</h1>
+<h2><%= @segment.title %></h2>
+<p>Are you sure you want to delete this segment?</p>
+
+<%= form_for(@segment, :url => segment_path(@segment), :method => :delete) do |form| %>
+<%= form.submit('Yes') %>
+<%= link_to('Cancel', url_for(:back)) %>
+<% end %>

data/app/views/disclaimer/segments/index.html.erb

@@ -0,0 +1,26 @@
+<h1>Segments</h1>
+<p><%= link_to('New Segment', new_segment_path) %></p>
+
+<% if @segments.empty? %>
+<p>There are currently no disclaimer segments</p>
+<% else %>
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Title</th>
+    <th>Documents</th>
+    <th colspan="3">Action</th>
+  </tr>
+<%   @segments.each do |segment| %>
+  <tr>
+    <td><%= segment.name %></td>
+    <td><%= segment.title %></td>
+    <td><%= segment.documents.collect{|d| d.name}.join(', ') %>
+    <td><%= link_to('Show', segment_path(segment)) %></td>
+    <td><%= link_to('Edit', edit_segment_path(segment)) %></td>
+    <td><%= link_to('Delete', delete_segment_path(segment)) %></td>
+  </tr>
+<%   end %>
+</table>
+<%  end %>

data/app/views/disclaimer/segments/new.html.erb

@@ -0,0 +1,24 @@
+<h1>Disclaimer segment</h1>
+
+<%= form_for(@segment) do |form| %>
+
+<p>
+  <%= form.label(:name) %><br/>
+  <%= form.text_field(:name) %>
+</p>
+
+<p>
+  <%= form.label(:title) %><br/>
+  <%= form.text_field(:title) %>
+</p>
+
+<p>
+  <%= form.label(:body) %><br/>
+  <%= form.text_area(:body, :rows => 6) %>
+</p>
+
+<p>
+  <%= form.submit %>
+</p>
+
+<% end %>

data/app/views/disclaimer/segments/show.html.erb

@@ -0,0 +1,2 @@
+<h1><%= @segment.name %></h1>
+<%= render @segment %>

data/app/views/layouts/disclaimer/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Disclaimer</title>
+  <%= stylesheet_link_tag    "disclaimer/application", :media => "all" %>
+  <%= stylesheet_link_tag "http://code.jquery.com/ui/1.9.0/themes/base/jquery-ui.css" %>
+  <%= javascript_include_tag "disclaimer/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,18 @@
+Disclaimer::Engine.routes.draw do
+  
+  root :to => "documents#index"
+  
+  resources :documents do
+    member do
+      get :delete
+      post :accept
+    end
+  end
+  
+  resources :segments do
+    member do
+      get :delete
+    end
+  end
+
+end

data/db/migrate/20121023125748_create_disclaimer_documents.rb

@@ -0,0 +1,12 @@
+class CreateDisclaimerDocuments < ActiveRecord::Migration
+  def change
+    create_table :disclaimer_documents do |t|
+      t.string :title
+      t.string :name
+      t.text :header
+      t.text :footer
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20121024074240_create_segments.rb

@@ -0,0 +1,10 @@
+class CreateSegments < ActiveRecord::Migration
+  def change
+    create_table :disclaimer_segments do |t|
+      t.string :name
+      t.string :title
+      t.text :body
+      t.timestamps
+    end
+  end
+end