acts_as_approvable 0.1.1 → 0.7.0

data/.gitignore

@@ -0,0 +1,4 @@
+debug.log
+spec/*.db
+coverage/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format doc
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+gemfile: gemfiles/Gemfile.ci

data/Appraisals

@@ -0,0 +1,22 @@
+appraise 'rails2' do
+  gem 'activerecord', '~> 2.3'
+  gem 'sqlite3'
+end
+
+if RUBY_VERSION =~ /^1\.9/
+  appraise 'rails30' do
+    gem 'activerecord', '~> 3.0.0'
+    gem 'railties',     '~> 3.0.0'
+    gem 'sqlite3'
+  end
+
+  appraise 'rails31' do
+    gem 'activerecord', '~> 3.1.0'
+    gem 'railties',     '~> 3.1.0'
+    gem 'sqlite3'
+  end
+end
+
+appraise 'mysql2' do
+  gem 'mysql2',       '~> 0.2.18'
+end

data/CHANGELOG

@@ -0,0 +1,76 @@
+== 0.7.0
+
+ * Support approvals for record deletions.
+ * Only check `#stale?` if the approval is for an update.
+ * Configuration option for disabling the stale check.
+
+== 0.6.9
+
+ * Fix generator templates using `select` instead of `select_tag`
+ * `reset!` to push a create approval back to a valid pending state
+ * Refactor Ownership setup to use a source class instead of monkey-patching
+ to override owner retrieval methods. Fixes an issue with rails development
+ mode.
+ * General cleanup
+
+== 0.6.8.1
+
+ * Bad gem push...
+
+== 0.6.8
+
+ * Fixed issue where approval state would be checked if the local state field
+ was present but not the value being checked.
+ * Reorganized `ActsAsApprovable::Model` into seperate files.
+ * `.acts_as_approvable` is the only method that should be available until
+ called. Moved other class methods into a module that is included on
+ configuration.
+ * Moved from Test::Unit to RSpec
+ * Renamed `can_save?` to `able_to_save?`
+ * Specify larger field size for original and object columns (16MB)
+
+== 0.6.6
+
+ * `#pending_changes?` should not be true if there are no pending update
+ approvals.
+
+== 0.6.5
+
+ * Copy javascripts if `--scripts` is passed to the generator. AJAXifies the
+ views.
+
+== 0.6.4
+
+ * around_filters cannot render content
+
+== 0.6.3.3
+
+ * Don't call #state on nil objects
+
+== 0.6.3.2
+
+ * Fix the Rails 2 initializer
+
+== 0.6.3.1
+
+ * Update rails 2 generator with previous fix
+ * Fix test helper
+
+== 0.6.3
+
+ * Correct state parameter validation for negative numbers
+
+== 0.6.2
+
+ * Rename main file to match gem name
+
+== 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,84 @@
+PATH
+  remote: .
+  specs:
+    acts_as_approvable (0.7.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
+    binding_of_caller (0.6.7)
+    builder (3.0.0)
+    coderay (1.0.5)
+    cucumber (1.1.9)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.9.0)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.6)
+    diff-lcs (1.1.3)
+    gherkin (2.9.0)
+      json (>= 1.4.6)
+    json (1.6.5)
+    method_source (0.7.1)
+    multi_json (1.1.0)
+    plymouth (0.3.2)
+      pry-exception_explorer (>= 0.1.7)
+    pry (0.9.8.4)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    pry-exception_explorer (0.1.9)
+      pry-stack_explorer (>= 0.3.9)
+    pry-nav (0.1.0)
+      pry (~> 0.9.8.1)
+    pry-stack_explorer (0.4.1)
+      binding_of_caller (~> 0.6.2)
+      pry (~> 0.9.8.2)
+    pry-syntax-hacks (0.0.6)
+      pry (>= 0.9.8)
+    rake (0.9.2.2)
+    redcarpet (2.1.0)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    shoulda (2.11.3)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    slop (2.4.4)
+    term-ansicolor (1.0.7)
+    timecop (0.3.5)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 2.3)
+  acts_as_approvable!
+  appraisal (~> 0.4.1)
+  cucumber (~> 1.1.0)
+  plymouth
+  pry (~> 0.9.8.1)
+  pry-nav (~> 0.1.0)
+  pry-stack_explorer
+  pry-syntax-hacks
+  rake (~> 0.9.2)
+  redcarpet (~> 2.1.0)
+  rspec (~> 2.8.0)
+  shoulda (~> 2.0)
+  simplecov
+  timecop (~> 0.3.5)
+  yard

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Jay Hayes
+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
@@ -17,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,146 @@
+# Acts as Approvable  [![Build Status](https://secure.travis-ci.org/jlogsdon/acts_as_approvable.png)](http://travis-ci.org/jlogsdon/acts_as_approvable?branch=master)
+
+This plugin provides a workflow for approving new records and changes to existing
+records.
+
+Installation
+============
+
+Rails 3
+-------
+
+Add the gem to your Gemfile:
+
+    gem 'acts-as-approvable'
+
+Then run the generator:
+
+    rails g acts_as_approvable
+
+Rails 2
+-------
+
+Add the gem to `config/environment.rb`
+
+    config.gem 'acts-as-approvable'
+
+Then run `rake gems:install`. After the gem is installed, 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.
+    --scripts       Copy javascripts for ApprovalsController and its views.
+
+\* This option is not available in Rails 3. You should configure your template engine in `config/application.rb`
+
+API Documentation
+=================
+
+API Documentation is [available online](http://rubydoc.info/gems/acts-as-approvable/frames).
+
+Configuration
+=============
+
+The generator creates an initializor at `config/initializers/acts_as_approvable.rb`. A sample
+initializer might look like this:
+
+```ruby
+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:
+
+```ruby
+ActsAsApprovable.view_language = 'haml'
+ActsAsApprovable::Ownership.configure(:source => ApprovalSources)
+```
+
+The `ApprovalSources` class should be created by you if you wish to override how available owners
+are selected or the option arrays for `select_tag` are created. Below is an example:
+
+```ruby
+class ApprovalSources
+  def self.available_owners
+    User.all(:conditions => ['role', 'admin'])
+  end
+
+  def self.option_for_owner(owner)
+    # default is [owner.to_str, owner.id]
+    [owner.email, owner.id]
+  end
+end
+```
+
+Examples
+========
+
+Require approval for new Users, but not modifications...
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_approvable :on => :create, :state_field => :state
+
+  # Let the user know they've been approved (ApprovalMailer is your creation)
+  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_rejected(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...
+
+```ruby
+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`)...
+
+```ruby
+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`, `:update` or `:destroy`) 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

@@ -1,10 +1,93 @@
-# encoding: UTF-8
 require 'rubygems'
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+require 'bundler/setup'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+require 'cucumber'
+require 'cucumber/rake/task'
+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 './spec/spec_helper'
+
+  Support::Database.setup_log(STDOUT)
+  Support::Database.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.'
+RSpec::Core::RakeTask.new(:test)
+
+if RUBY_VERSION =~ /^1\.8/
+  begin
+    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
+  rescue LoadError
+  end
+elsif RUBY_VERSION =~ /^1\.9/
+  namespace :test do
+    task :coverage do
+      ENV['COVERAGE'] = 'true'
+      Rake::Task['test'].invoke
+    end
+  end
 end
 
-require 'rake'
-task :default => :spec
+namespace :test do
+  desc 'Setup appraisals and install gems for the gambit run'
+  task :setup do
+    start = Time.now
+    Kernel.system('rbenv each -v bundle install')
+    Kernel.system('rbenv each -v bundle exec rake appraisal:install')
+    elapsed = Time.now - start
+
+    puts "\nRan everything in #{elapsed} seconds"
+  end
+
+  desc 'Run all specs and features across all installed rubies'
+  task :gambit do
+    start = Time.now
+    Kernel.system('rbenv each -v bundle exec rake appraisal test')
+    Kernel.system('rbenv each -v bundle exec rake appraisal features')
+    elapsed = Time.now - start
+
+    puts "\nRan everything in #{elapsed} seconds"
+  end
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+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