acts-as-approvable 0.6.1

data/lib/generators/acts_as_approvable/acts_as_approvable_generator.rb

@@ -0,0 +1,73 @@
+require 'rails/generators/active_record'
+
+class ActsAsApprovableGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  class_option :base, :type => :string, :default => 'ApplicationController', :desc => 'Base class for the ApprovalsController'
+  class_option :owner, :type => :string, :optional => true, :desc => 'Model that can own approvals'
+
+  desc 'Generates ApprovalsController, a migration the create the Approval table, and an initializer for the plugin.'
+
+  def check_class_collisions
+    class_collisions '', 'ApprovalsController'
+  end
+
+  def create_controller_file
+    template 'approvals_controller.rb', File.join('app/controllers', 'approvals_controller.rb')
+  end
+
+  def create_migration_file
+    number = ActiveRecord::Generators::Base.next_migration_number('db/migrate')
+    template 'create_approvals.rb', "db/migrate/#{number}_create_approvals.rb"
+  end
+
+  def create_initializer_file
+    initializer('acts_as_approvable.rb') do
+      data = ''
+
+      if owner?
+        data << 'ActsAsApprovable::Ownership.configure'
+        data << "(:owner => #{options[:owner]})" if options[:owner] != 'User'
+      end
+
+      data << "\n"
+    end
+  end
+
+  hook_for :template_engine
+
+  def add_routes
+    resource = []
+    resource << 'resources :approvals, :only => [:index] do'
+    resource << '    collection do'
+    resource << '      get \'index\''
+    resource << '      get \'history\''
+    resource << '      get \'mine\'' if owner?
+    resource << '    end'
+    resource << '    member do'
+    resource << '      post \'approve\''
+    resource << '      post \'reject\''
+    resource << '      post \'assign\'' if owner?
+    resource << '    end'
+    resource << '  end'
+
+    route(resource.join("\n"))
+  end
+
+  protected
+  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
+end

data/lib/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/lib/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/lib/generators/erb/acts_as_approvable_generator.rb

@@ -0,0 +1,44 @@
+module Erb
+  module Generators
+    class ActsAsApprovableGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      class_option :owner, :type => :string, :optional => true, :desc => 'Model that can own approvals'
+
+      def copy_view_files
+        template 'index.html.erb',          'app/views/approvals/index.html.erb'
+        template '_table.html.erb',         'app/views/approvals/_table.html.erb'
+        template '_owner_select.html.erb',  'app/views/approvals/_owner_select.html.erb' if owner?
+      end
+
+      protected
+      def format
+        :html
+      end
+
+      def handler
+        :erb
+      end
+
+      def filename_with_extensions(name)
+        [name, format, handler].compact.join('.')
+      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
+    end
+  end
+end

data/lib/generators/erb/templates/_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/lib/generators/erb/templates/_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/lib/generators/erb/templates/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/lib/generators/haml/acts_as_approvable_generator.rb

@@ -0,0 +1,44 @@
+module Haml
+  module Generators
+    class ActsAsApprovableGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      class_option :owner, :type => :string, :optional => true, :desc => 'Model that can own approvals'
+
+      def copy_view_files
+        template 'index.html.haml',          'app/views/approvals/index.html.haml'
+        template '_table.html.haml',         'app/views/approvals/_table.html.haml'
+        template '_owner_select.html.haml',  'app/views/approvals/_owner_select.html.haml' if owner?
+      end
+
+      protected
+      def format
+        :html
+      end
+
+      def handler
+        :haml
+      end
+
+      def filename_with_extensions(name)
+        [name, format, handler].compact.join('.')
+      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
+    end
+  end
+end

data/lib/generators/haml/templates/_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/lib/generators/haml/templates/_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/lib/generators/haml/templates/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/lib/tasks/acts_as_approvable.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :acts_as_approvable do
+#   # Task goes here
+# end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'acts_as_approvable'