acts_as_approvable 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jay Hayes
+
+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,38 @@
+= ActsAsApprovable
+
++acts_as_approvable+ is an ActiveRecord extension that allows you to flag models as pending 
+approval. One use of this would be so that changes would not show up in your views until the 
+model has been "approved".
+
+== Installation
+In +Gemfile+:
+
+    gem 'acts_as_approvable', :git => 'https://github.com/iamvery/acts_as_approvable.git'
+
+In your application root, run:
+
+    $ bundle install
+
+Generate the migration (warning: will overwrite any table named +Approvals+):
+
+    $ rails g acts_as_approvable:install
+
+== Usage
+Declare +acts_as_approvable+ on your models:
+
+	class Thing < ActiveRecord::Base
+		acts_as_approvable
+	end
+	
+Doing so will add the following methods to your model:
+
+* thing.pending?
+* thing.approved? 
+* thing.approve!
+* thing.disapprove!
+
+Both +pending?+ and +approved?+ exist as convenience methods. +approve!+ and +disapprove!+ 
+will modify the +Approval+ model that your +acts_as_approvable+ model has.
+
+== Compatibility
+This gem is designed to work with Rails 3.x.

data/Rakefile

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+task :default => :spec

data/lib/acts_as_approvable.rb

@@ -0,0 +1,4 @@
+require 'active_record'
+require 'acts_as_approvable/approver'
+require 'acts_as_approvable/version'
+ActiveRecord::Base.send :include, ActsAsApprovable::Approver

data/lib/acts_as_approvable/approval.rb

@@ -0,0 +1,12 @@
+class Approval < ActiveRecord::Base
+  belongs_to :approvable, :polymorphic => true
+  belongs_to :approver, :polymorphic => true
+  
+  validates :approvable_id, :approvable_type, :presence => true
+  validates :approvable_id, :uniqueness => {:scope => :approvable_type}
+  
+  # Scoped wrapped in lambdas because ActiveRecord's connection hasn't been established at the
+  # time of this classes' load.
+  scope :pending, lambda{ where(:approved => false) }
+  scope :approved_today, lambda{ where(:approved => true).where(arel_table[:updated_at].eq(Date.today)) }
+end

data/lib/acts_as_approvable/approver.rb

@@ -0,0 +1,58 @@
+require 'acts_as_approvable/approval'
+
+module ActsAsApprovable
+  module Approver
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      # Creates associations with +Approvals+ and add instance methods for getting approval status
+      def acts_as_approvable
+        # don't allow multiple calls
+        return if included_modules.include?(ActsAsApprovable::Approver::InstanceMethods)
+        
+        # association with approval
+        has_one :approval, :as => :approvable
+        
+        # access to all models that have been approved
+        scope :approved, joins(:approval).where(Approval.arel_table[:approved].eq(true))
+        
+        # make sure every approvable model has an associated approval
+        after_create :create_pending_approval
+        
+        include ActsAsApprovable::Approver::InstanceMethods
+      end
+    end
+    
+    module InstanceMethods
+      def approved?
+        !!approval.try(:approved?)
+      end
+      
+      def pending?
+        !approved?
+      end
+      
+      def approve!(who = nil)
+        create_pending_approval if approval.nil?
+        approval.update_attributes :approved => true, :approver => who || nil if pending?
+      end
+      
+      def disapprove!(who = nil)
+        create_pending_approval if approval.nil?
+        approval.update_attributes :approved => false, :approver => who || nil if approved?
+      end
+      
+      def approver
+        approval.try :approver
+      end
+      
+      private
+      
+      def create_pending_approval
+        self.approval = Approval.create :approvable => self
+      end
+    end
+  end
+end

data/lib/acts_as_approvable/version.rb

@@ -0,0 +1,10 @@
+module ActsAsApprovable
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    TINY = 0
+    PRE = nil
+    
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/lib/generators/acts_as_approvable/install_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'active_record'
+require 'rails/generators/active_record'
+
+module ActsAsApprovable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+      
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def copy_migration
+        migration_template 'install.rb', 'db/migrate/install_acts_as_approvable.rb'
+      end
+    end
+  end
+end

data/lib/generators/acts_as_approvable/templates/install.rb

@@ -0,0 +1,16 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :approvals, :force => true do |t|
+      t.references :approvable, :polymorphic => true, :null => false
+      t.references :approver, :polymorphic => true
+      t.boolean :approved, :default => false
+      t.timestamps
+    end
+    add_index :approvals, [:approvable_id, :approvable_type], :unique => true
+  end
+
+  def self.down
+    remove_index :approvals, :column => [:approvable_id, :approvable_type]
+    drop_table :approvals
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_approvable
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jay Hayes
+- Christoph Lupprich
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-02 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Make an ActiveRecord model approvable.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/acts_as_approvable/approval.rb
+- lib/acts_as_approvable/approver.rb
+- lib/acts_as_approvable/version.rb
+- lib/acts_as_approvable.rb
+- lib/generators/acts_as_approvable/install_generator.rb
+- lib/generators/acts_as_approvable/templates/install.rb
+- lib/generators/acts_as_approvable/USAGE
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: https://github.com/iamvery/acts_as_approvable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Make an ActiveRecord model approvable.
+test_files: []
+