acts-as-approvable 0.6.1

data/gemfiles/rails32.gemfile.lock

@@ -0,0 +1,99 @@
+PATH
+  remote: /Users/jlogsdon/Code/acts_as_approvable/acts_as_approvable
+  specs:
+    acts-as-approvable (0.6.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+    activerecord (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      arel (~> 3.0.0)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.0)
+    builder (3.0.0)
+    coderay (1.0.5)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.1)
+    json (1.6.5)
+    metaclass (0.0.1)
+    method_source (0.7.0)
+    mocha (0.10.4)
+      metaclass (~> 0.0.1)
+    multi_json (1.0.4)
+    pry (0.9.8)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7)
+      slop (>= 2.4.3, < 3)
+    rack (1.4.1)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    railties (3.2.1)
+      actionpack (= 3.2.1)
+      activesupport (= 3.2.1)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redcarpet (2.1.0)
+    shoulda (2.11.3)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    slop (2.4.3)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
+    thor (0.14.6)
+    tilt (1.3.3)
+    tzinfo (0.3.31)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.2.0)
+  acts-as-approvable!
+  appraisal
+  mocha
+  pry
+  railties (~> 3.2.0)
+  rake
+  redcarpet
+  shoulda
+  simplecov
+  sqlite3
+  yard

data/generators/acts_as_approvable/USAGE

@@ -0,0 +1,3 @@
+Description:
+  Generates (but does not run) a migration to add an approvals table as well as a controller
+  and views for handling the approval queue.

data/generators/acts_as_approvable/acts_as_approvable_generator.rb

@@ -0,0 +1,86 @@
+class ActsAsApprovableGenerator < Rails::Generator::Base
+  default_options :base => 'ApplicationController'
+
+  def manifest
+    record do |m|
+      m.migration_template 'create_approvals.rb', 'db/migrate', :migration_file_name => 'create_approvals'
+
+      m.directory 'app/controllers'
+      m.template 'approvals_controller.rb', 'app/controllers/approvals_controller.rb'
+
+      m.directory 'app/views/approvals'
+      m.template "views/#{view_language}/index.html.#{view_language}", "app/views/approvals/index.html.#{view_language}"
+      m.template "views/#{view_language}/_table.html.#{view_language}", "app/views/approvals/_table.html.#{view_language}"
+
+      m.directory 'config/initializers'
+      m.template 'initializer.rb', 'config/initializers/acts_as_approvable.rb'
+
+      m.route route
+    end
+  end
+
+  protected
+  def view_language
+    options[:haml] ? 'haml' : 'erb'
+  end
+
+  def owner?
+    options[:owner].present?
+  end
+
+  def collection_actions
+    actions = [:index, :history]
+    actions << :mine if owner?
+    actions.map { |a| ":#{a}" }
+  end
+
+  def member_actions
+    actions = [:approve, :reject]
+    actions << :assign if owner?
+    actions.map { |a| ":#{a}" }
+  end
+
+  def route
+    route = 'map.resources :approvals, :only => [:index], :collection => ['
+    route << collection_actions.reject { |a| a == ':index' }.join(', ')
+    route << '], :member => ['
+    route << member_actions.join(', ')
+    route << ']'
+  end
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on('--base BASE', 'Base class for ApprovableController.') { |v| options[:base] = v }
+    opt.on('--haml', 'Generate HAML views instead of ERB.') { |v| options[:haml] = v }
+    opt.on('--owner [User]', 'Enable and, optionally, set the model for approval ownerships.') { |v| options[:owner] = v || 'User' }
+  end
+end
+
+# Gross! But Rails 2 only allows us to define resources with no options.
+module Rails
+  module Generator
+    module Commands
+      class Create
+        def route(route)
+          sentinel = 'ActionController::Routing::Routes.draw do |map|'
+
+          logger.route route
+          unless options[:pretend]
+            gsub_file 'config/routes.rb', /#{Regexp.escape(sentinel)}/mi do |match|
+              "#{match}\n  #{route}\n"
+            end
+          end
+        end
+      end
+
+      class Destroy
+        def route(route)
+          look_for = "\n  #{Regexp.escape(route)}\n"
+          logger.route route
+          gsub_file 'config/routes.rb', /#{look_for}/mi, ''
+        end
+      end
+    end
+  end
+end

data/generators/acts_as_approvable/templates/approvals_controller.rb

@@ -0,0 +1,97 @@
+class ApprovalsController < <%= options[:base] %>
+  before_filter :setup_conditions, :only => [<%= collection_actions.join(', ') %>]
+  before_filter :setup_partial, :only => [<%= collection_actions.join(', ') %>]
+  before_filter :find_approval, :only => [<%= member_actions.join(', ') %>]
+  around_filter :json_wrapper, :only => [<%= member_actions.join(', ') %>]
+
+  def index
+    state = params[:state] =~ /^\d+$/ ? params[:state].to_i : Approval.enumerate_state('pending')
+    @conditions[:state] = state if state > -1
+
+    @approvals = Approval.all(:conditions => @conditions, :order => 'created_at ASC')
+  end
+
+  def history
+    @conditions[:state] = Approval.enumerate_states('approved', 'rejected')
+
+    @approvals = Approval.all(:conditions => @conditions, :order => 'created_at DESC')
+    render :index
+  end
+
+<% if owner? %>  def mine
+    @conditions[:owner_id] = current_user.id
+
+    @approvals = Approval.all(:conditions => @conditions, :order => 'created_at ASC')
+    render :index
+  end
+
+  def assign
+    if params[:approval][:owner_id].empty?
+      @approval.unassign
+    else
+      user = <%= options[:owner] %>.find(params[:approval][:owner_id])
+      @approval.assign(user)
+    end
+  end
+
+<% end %>  def approve
+<% if owner? %>    @approval.owner = current_user if respond_to?(:current_user)
+<% end %>    @approval.approve!
+  end
+
+  def reject
+<% if owner? %>    @approval.owner = current_user if respond_to?(:current_user)
+<% end %>    @approval.reject!(params[:reason])
+  end
+
+  private
+  def json_wrapper
+    json = {:success => false}
+
+    begin
+      json[:success] = yield
+    rescue ActsAsApprovable::Error => e
+      json[:message] = e.message
+    rescue
+      json[:message] = 'An unknown error occured'
+    end
+
+    respond_to do |format|
+      format.html do
+        flash[:error] = json[:message] if json[:message]
+        redirect_to :action => :index
+      end
+      format.json { render :json => json }
+    end
+  end
+
+  def setup_conditions
+    @conditions ||= {}
+
+<% if owner? %>    if params[:owner_id]
+      @conditions[:owner_id] = params[:owner_id]
+      @conditions[:owner_id] = nil if params[:owner_id] == 0
+    end
+<% end %>    if params[:item_type]
+      @conditions[:item_type] = params[:item_type]
+    end
+  end
+
+  # Check for the selected models partial, use the generic one if it doesn't exist
+  def setup_partial
+    @table_partial = @conditions.fetch(:item_type) { 'table' }
+
+    if @table_partial != 'table'
+      partial_path = Rails.root.join('app', 'views', 'approvals', "_#{@table_partial}.html.#{view_language}")
+      @table_partial = 'table' unless File.exist?(partial_path)
+    end
+  end
+
+  def find_approval
+    @approval = Approval.find(params[:id])
+  end
+
+  def view_language
+    ActsAsApprovable.view_language
+  end
+end

data/generators/acts_as_approvable/templates/create_approvals.rb

@@ -0,0 +1,26 @@
+class CreateApprovals < ActiveRecord::Migration
+  def self.up
+    create_table :approvals do |t|
+      t.string   :item_type, :null => false
+      t.integer  :item_id,   :null => false
+      t.string   :event,     :null => false
+      t.integer  :state,     :null => false, :default => 0
+<% if options[:owner] %>      t.integer  :owner_id
+<% end %>      t.text     :object
+      t.text     :reason
+
+      t.timestamps
+    end
+
+    add_index :approvals, [:state, :event]
+    add_index :approvals, [:item_type, :item_id]
+<% if options[:owner] %>    add_index :approvals, [:owner_id]
+<% end %>  end
+
+  def self.down
+    remove_index :approvals, [:state, :event]
+    remove_index :approvals, [:item_type, :item_id]
+<% if options[:owner] %>    remove_index :approvals, [:owner_id]
+<% end %>    drop_table :approvals
+  end
+end

data/generators/acts_as_approvable/templates/initializer.rb

@@ -0,0 +1,3 @@
+ActsAsApprovable.view_language = '<%= view_language %>'
+<% if owner? %>ActsAsApprovable::Ownership.configure<% if options[:owner] != 'User' %>(:owner => <%= options[:owner].constantize %>)<% end %>
+<% end %>

data/generators/acts_as_approvable/templates/views/erb/_owner_select.html.erb

@@ -0,0 +1,4 @@
+<%% form_for(approval, :url => assign_approval_path(approval.id), :html => {:class => 'assignment'}) do |f| %>
+  <%%= f.select(:owner_id, options_for_select(Approval.options_for_available_owners(true), approval.owner_id)) %>
+  <%%= f.submit('Set') %>
+<%% end %>

data/generators/acts_as_approvable/templates/views/erb/_table.html.erb

@@ -0,0 +1,26 @@
+<table>
+  <thead>
+    <tr>
+      <th>Type</th>
+      <th>Record</th>
+<% if owner? %>      <th>Owner</th>
+<% end %>      <th>State</th>
+      <th>&nbsp;</th>
+    </tr>
+  </thead>
+  <tbody>
+    <%% @approvals.each do |approval| %>
+      <tr>
+        <td><%%= approval.item_type.classify %></td>
+        <td><%%= approval.item.try(:to_s) || approval.item.id %></td>
+<% if owner? %>        <td><%%= render :partial => 'owner_select', :locals => {:approval => approval} %></td>
+<% end %>        <td><%%= approval.state %></td>
+        <td class='actions'>
+          <%%= link_to('Approve', approve_approval_path(approval)) %>
+          <%%= link_to('Reject', reject_approval_path(approval)) %>
+        </td>
+      </tr>
+    <%% end %>
+  </tbody>
+</table>
+

data/generators/acts_as_approvable/templates/views/erb/index.html.erb

@@ -0,0 +1,15 @@
+<h1>Approval Queue</h1>
+
+<%% form_for(:approval, :url => approvals_path, :html => {:method => :get}) do |f| %>
+  <%% unless @conditions[:state].is_a?(Array) # History page shouldn't allow selecting different states %>
+    <%%= f.label(:state) %>
+    <%%= f.select(:state, options_for_select(Approval.options_for_state, @conditions[:state])) %>
+  <%% end %>
+<% if owner? %>  <%%= f.label(:owner_id) %>
+  <%%= f.select(:owner_id, options_for_select(Approval.options_for_assigned_owners, @conditions[:owner_id]), :prompt => 'All Users') %>
+<% end %>  <%%= f.label(:item_type) %>
+  <%%= f.select(:item_type, options_for_select(Approval.options_for_type, @conditions[:item_type]), :prompt => 'All Types') %>
+  <%%= f.submit('Filter') %>
+<%% end %>
+
+<%%= render :partial => @table_partial %>

data/generators/acts_as_approvable/templates/views/haml/_owner_select.html.haml

@@ -0,0 +1,3 @@
+- form_for(approval, :url => assign_approval_path(approval.id), :html => {:class => 'assignment'}) do |f|
+  = f.select(:owner_id, options_for_select(Approval.options_for_available_owners(true), approval.owner_id))
+  = f.submit('Set')

data/generators/acts_as_approvable/templates/views/haml/_table.html.haml

@@ -0,0 +1,19 @@
+%table
+  %thead
+    %tr
+      %th Type
+      %th Record
+<% if owner? %>      %th Owner
+<% end %>      %th State
+      %th
+  %tbody
+    - @approvals.each do |approval|
+      %tr
+        %td= approval.item_type.classify
+        %td= approval.item.try(:to_s) || approval.item.id
+<% if owner? %>        %td= render :partial => 'owner_select', :locals => {:approval => approval}
+<% end %>        %td= approval.state
+        %td.actions
+          = link_to('Approve', approve_approval_path(approval))
+          = link_to('Reject', reject_approval_path(approval))
+

data/generators/acts_as_approvable/templates/views/haml/index.html.haml

@@ -0,0 +1,13 @@
+%h1 Approval Queue
+
+- form_for(:approval, :url => approvals_path, :html => {:method => :get}) do |f|
+  - unless @conditions[:state].is_a?(Array) # History page shouldn't allow selecting different states
+    = label_tag('state', 'State')
+    = select_tag('state', options_for_select(Approval.options_for_state, @conditions[:state]))
+<% if owner? %>  = label_tag('owner_id', 'Owner')
+  = select('owner_id', options_for_select(Approval.options_for_assigned_owners(true), @conditions[:owner_id]))
+<% end %>  = label_tag('item_type', 'Type')
+  = select_tag('item_type', options_for_select(Approval.options_for_type(true), @conditions[:item_type]))
+  %button{:type => 'Submit'} Filter
+
+= render :partial => @table_partial

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/rails/init'

data/lib/acts-as-approvable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsApprovable
+  VERSION = File.read(File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'VERSION'))).chomp
+end