acts-as-approvable 0.6.1

data/.gitignore

@@ -0,0 +1,6 @@
+test/*.db
+test/debug.log
+coverage/
+rdoc/
+yardoc/
+.yardoc

data/Appraisals

@@ -0,0 +1,18 @@
+appraise 'rails2' do
+  gem 'activerecord', '~> 2.3'
+end
+
+appraise 'rails30' do
+  gem 'activerecord', '~> 3.0.0'
+  gem 'railties',     '~> 3.0.0'
+end
+
+appraise 'rails31' do
+  gem 'activerecord', '~> 3.1.0'
+  gem 'railties',     '~> 3.1.0'
+end
+
+appraise 'rails32' do
+  gem 'activerecord', '~> 3.2.0'
+  gem 'railties',     '~> 3.2.0'
+end

data/CHANGELOG

@@ -0,0 +1,10 @@
+== 0.6.1
+
+ * Change gem name to 'acts-as-approvable'
+
+== 0.6
+
+ * Convert to a gem
+ * Support for Rails 3.x
+ * Validate state parameter is an integer before using
+ * Correct spelling of `current_user` in controller templates

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    acts-as-approvable (0.6.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
+    appraisal (0.4.1)
+      bundler
+      rake
+    coderay (1.0.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)
+    rake (0.9.2.2)
+    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)
+    sqlite3 (1.3.5)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 2.3)
+  acts-as-approvable!
+  appraisal
+  mocha
+  pry
+  rake
+  redcarpet
+  shoulda
+  simplecov
+  sqlite3
+  yard

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 James Logsdon
+
+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.md

@@ -0,0 +1,108 @@
+Acts as Approvable
+==================
+
+This plugin provides a workflow for approving new records and changes to existing
+records.
+
+Installation
+============
+
+Install the plugin as you would any other Rails plugin:
+
+    $ script/plugin install git://github.com/jlogsdon/acts_as_approvable.git
+
+After installing the plugin you should run the generator:
+
+    $ script/generate acts_as_approvable
+
+Generator Options
+=================
+
+These options are also available by passing `--help` as an option to the generator.
+
+    --base BASE     Base class for ApprovableController.
+    --haml          Generate HAML views instead of ERB.
+    --owner [User]  Enable and, optionally, set the model for approval ownerships.
+
+API Documentation
+=================
+
+API Documentation is [available online](http://jlogsdon.github.com/acts_as_approvable).
+
+Configuration
+=============
+
+The generator creates an initializor at `config/initializers/acts_as_approvable.rb`. A sample
+initializer might look like this:
+
+    ActsAsApprovable.view_language = 'haml'
+    ActsAsApprovable::Ownership.configure
+
+The `Ownership` functionality expects a `User` model in your project by default, but by providing
+an `:owner` option you can change the expected model to whatever you wish. `.configure` also
+accepts a block which it applies to the `Approval` model, allowing you to override methods as
+you see fit.
+
+For example, to only allow Users with the "admin" role to 'own' an Approval, change your initializer
+to something like this:
+
+    ActsAsApprovable.view_language = 'haml'
+    ActsAsApprovable::Ownership.configure do
+      def self.available_owners
+        owner_class.all(:conditions => ['role', 'admin'])
+      end
+    end
+
+Examples
+========
+
+Require approval for new Users, but not modifications...
+
+    class User < ActiveRecord::Base
+      acts_as_approvable :on => :create, :state_field => :state
+
+      # Let the user know they've been approved
+      def after_approve(approval)
+        ApprovalMailer.deliver_user_approved(self.email)
+      end
+
+      # Let the user know they were rejected
+      def after_reject(approval)
+        ApprovalMailer.deliver_user_approved(self.email, approval.reason)
+      end
+    end
+
+Require approval when a Game's title or description is changed, but not when view or installation count is changed...
+
+    class Game < ActiveRecord::Base
+        acts_as_approvable :on => :update, :ignore => [:views, :installs]
+    end
+
+Require approval for all changes, except the standard ignored fields (`created_at`, `updated_at` and `:state_field`)...
+
+    class Advertisement < ActiveRecord::Base
+        acts_as_approvable :state_field => :state
+    end
+
+Options
+=======
+
+The following options may be used to configure the workflow on a per-model
+basis:
+
+ * `:on`            The type of events (`:create` or `:update`) to require approval on.
+ * `:ignore`        A list of fields to ignore for `:update` approvals.
+ * `:only`          A list of fields that should be approved. All other fields are
+                    ignored. If set, the `:ignore` option is... ignored.
+ * `:state_field`   A local model field to save the `:create` approvals state. Useful
+                    for selecting approved models without joining the approvals table.
+
+The fields `:created_at`, `:updated_at` and whatever is set for the `:state_field`
+are automatically ignored.
+
+Contributors
+============
+
+ * [James Logsdon](http://github.com/jlogsdon) (Lead developer)
+ * [Hwan-Joon Choi](http://github.com/hc5duke) (Performance enhancements, bug fixes)
+ * [Neal Wiggins](http://github.com/nwigginsTJ) (Enumeration of states)

data/Rakefile

@@ -0,0 +1,81 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rake/testtask'
+require 'yard'
+require 'appraisal'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Start a pry session with a database connection open'
+task :pry do |t|
+  $LOAD_PATH << './lib'
+  require 'pry'
+  require './test/test_helper'
+
+  ActiveRecord::Base.logger = Logger.new(STDOUT)
+  load_schema
+
+  ActsAsApprovable::Ownership.configure
+  Pry.start(TOPLEVEL_BINDING)
+end
+
+desc 'Copy templates from Rails 3 generators to the Rails 2 generators'
+task :copy do |t|
+  ['erb', 'haml'].each do |lang|
+    Dir["lib/generators/#{lang}/templates/*"].each do |file|
+      FileUtils.cp(file, "generators/acts_as_approvable/templates/views/#{lang}/#{File.basename(file)}")
+    end
+  end
+  Dir["lib/generators/acts_as_approvable/templates/*"].each do |file|
+    FileUtils.cp(file, "generators/acts_as_approvable/templates/#{File.basename(file)}")
+  end
+end
+
+desc 'Test the acts_as_approvable plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs    << 'test' << 'lib'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+if RUBY_VERSION =~ /^1\.8/
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs        << 'test' << 'lib'
+    t.rcov_opts   << '--exclude' << '"Library/Ruby/*"' << '--sort' << 'coverage'
+    t.pattern     = 'test/*_test.rb'
+    t.output_dir  = 'coverage/'
+    t.verbose     = true
+  end
+elsif RUBY_VERSION =~ /^1\.9/
+  namespace :test do
+    task :coverage do
+      ENV['COVERAGE'] = true
+      Rake::Task['test'].invoke
+    end
+  end
+end
+
+desc 'Generate documentation for the acts_as_approvable plugin.'
+YARD::Rake::YardocTask.new do |t|
+  yard_dir = (ENV['YARD_DIR'] || 'yardoc')
+  t.files   = ['lib/**/*.rb', 'README.md']
+  t.options = ['-r', 'README.md', '-o', yard_dir, '--markup', 'markdown']
+end
+
+desc 'Generate documentation and update the gh-pages branch'
+task :site => :yard do |t|
+  def run_or_quit(cmd)
+    puts "Running #{cmd}"
+    `#{cmd}`
+    raise "Command failed!" if $? != 0
+  end
+
+  run_or_quit('git checkout gh-pages')
+  run_or_quit('rsync -rv --delete --exclude yardoc/ --exclude .git/ --exclude .gitignore yardoc/ ./')
+  run_or_quit('git add .')
+  run_or_quit('git commit -m "Updating documentation"')
+  run_or_quit('git push origin gh-pages')
+  run_or_quit('git checkout master')
+end

data/VERSION

@@ -0,0 +1 @@
+0.6.1

data/acts-as-approvable.gemspec

@@ -0,0 +1,31 @@
+$:.push File.expand_path('../lib', __FILE__)
+require "acts-as-approvable/version"
+
+Gem::Specification.new do |s|
+  s.name    = %q(acts-as-approvable)
+  s.version = ActsAsApprovable::VERSION
+
+  s.summary     = %q(Generic approval queues for record creation and updates)
+  s.description = %q(Generic approval queues for record creation and updates)
+
+  s.authors   = ['James Logsdon', 'Hwan-Joon Choi', 'Neal Wiggins']
+  s.email     = %q(dwarf@girsbrain.org)
+  s.homepage  = %q(http://github.com/jlogsdon/acts_as_approvable)
+  s.date      = %q(2012-02-14)
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_development_dependency %q<activerecord>, '~> 2.3'
+  s.add_development_dependency %q<appraisal>
+  s.add_development_dependency %q<redcarpet>
+  s.add_development_dependency %q<shoulda>
+  s.add_development_dependency %q<sqlite3>
+  s.add_development_dependency %q<mocha>
+  s.add_development_dependency %q<rake>
+  s.add_development_dependency %q<rcov> if RUBY_VERSION =~ /^1\.8/
+  s.add_development_dependency %q<simplecov> if RUBY_VERSION =~ /^1\.9/
+  s.add_development_dependency %q<yard>
+  s.add_development_dependency %q<pry>
+end

data/gemfiles/rails2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 2.3"
+
+gemspec :path=>"../"

data/gemfiles/rails2.gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: /Users/jlogsdon/Code/acts_as_approvable/acts_as_approvable
+  specs:
+    acts-as-approvable (0.6.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
+    appraisal (0.4.1)
+      bundler
+      rake
+    coderay (1.0.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)
+    rake (0.9.2.2)
+    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)
+    sqlite3 (1.3.5)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 2.3)
+  acts-as-approvable!
+  appraisal
+  mocha
+  pry
+  rake
+  redcarpet
+  shoulda
+  simplecov
+  sqlite3
+  yard

data/gemfiles/rails30.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 3.0.0"
+gem "railties", "~> 3.0.0"
+
+gemspec :path=>"../"

data/gemfiles/rails30.gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: /Users/jlogsdon/Code/acts_as_approvable/acts_as_approvable
+  specs:
+    acts-as-approvable (0.6.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.11)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (2.0.10)
+    builder (2.1.2)
+    coderay (1.0.5)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    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.2.5)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    railties (3.0.11)
+      actionpack (= 3.0.11)
+      activesupport (= 3.0.11)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    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)
+    sqlite3 (1.3.5)
+    thor (0.14.6)
+    tzinfo (0.3.31)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.0)
+  acts-as-approvable!
+  appraisal
+  mocha
+  pry
+  railties (~> 3.0.0)
+  rake
+  redcarpet
+  shoulda
+  simplecov
+  sqlite3
+  yard

data/gemfiles/rails31.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 3.1.0"
+gem "railties", "~> 3.1.0"
+
+gemspec :path=>"../"

data/gemfiles/rails31.gemfile.lock

@@ -0,0 +1,101 @@
+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.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.5)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (2.2.1)
+    builder (3.0.0)
+    coderay (1.0.5)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    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.3.6)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    railties (3.1.3)
+      actionpack (= 3.1.3)
+      activesupport (= 3.1.3)
+      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.0.3)
+      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.1.0)
+  acts-as-approvable!
+  appraisal
+  mocha
+  pry
+  railties (~> 3.1.0)
+  rake
+  redcarpet
+  shoulda
+  simplecov
+  sqlite3
+  yard

data/gemfiles/rails32.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 3.2.0"
+gem "railties", "~> 3.2.0"
+
+gemspec :path=>"../"