purgatory 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGU4MWYzYTMwMDA2MzBjN2U1ZDc0ZDMzMGRmMTA5YTE3ZTE0Mjg4Mw==
+  data.tar.gz: !binary |-
+    YmViZGNmYTUxNjQ0MjdhYmVkZGZkMWFlNDI3MmRiNzIzODZkMzI4Zg==
+SHA512:
+  metadata.gz: !binary |-
+    Zjc2NWM4NThhNjZiMzM4NmQ3ODFlYjAxYjRjODY2MjljYzBhYzE2NzQxMGY2
+    ZmEzNWU3Mjg2OTkzMjNjOWRlMDJkOTdjZGQ5MWE5NTNmMDdmYTBiYjEwZjBl
+    ZGY2M2NkMjc0OTIwOWU1ZGZkYzZlOGJhMzVmNjQxZTNmMjc3Y2I=
+  data.tar.gz: !binary |-
+    NjhjMjQ2MzQ0MzRhYmI1NzVhMzZkZDc5OWEwODk3ZTcwNDM4YTM2MDMzM2Y3
+    NzI2ZmI4NWM4NzM4NDM0MDgyZGU2MGIyOWE4YjBkN2YzOTRjYmFjZjZmYTU3
+    NzJhMTlhYTdlNDdiYzYyZmNhZWM0MjY1MGNjOTI2YjZlYTIyYmQ=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+end

data/Gemfile.lock

@@ -0,0 +1,72 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.14)
+    builder (3.2.2)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httpauth (0.2.0)
+    i18n (0.6.5)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.5)
+    shoulda-matchers (2.4.0)
+      activesupport (>= 3.0.0)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 1.8.7)
+  rdoc (~> 3.12)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Elan Dubrofsky
+
+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.markdown

@@ -0,0 +1,44 @@
+# Purgatory
+
+Purgatory allows you to put changes to an ActiveRecord model into purgatory until they are approved
+
+## How to Use
+
+First run the generator the create the required migrations:
+
+    $ rails generate purgatory
+
+Then migrate the database:
+
+    $ rake db:migrate
+
+To enable Purgatory functionality in a class, add the following line to the class:
+
+    use_purgatory
+
+To put your changes to an ActiveRecord class into Purgatory, simply make your changes and then call the purgatory! method, passing the requesting user as a parameter
+
+    item = Item.find(10)
+    item.price = 200
+    item.purgatory!(current_user)
+
+To apply the changes, simply call the approve! method on the associated Pergatory instance, passing in the approving user as a parameter
+
+    purgatory = Purgatory.where(soul_id: 10, soul_type: 'Item')
+    purgatory.approve!(current_user)
+
+## Contributing to Purgatory
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Elan Dubrofsky. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "purgatory"
+  gem.homepage = "http://github.com/dubroe/purgatory"
+  gem.license = "MIT"
+  gem.summary = %Q{Allow changes to a model to be put in purgatory until they are approved}
+  gem.description = %Q{Put your model changes in purgatory and allow them to remain lost souls until they are approved}
+  gem.email = "elan.dubrofsky@gmail.com"
+  gem.authors = ["Elan Dubrofsky"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "purgatory #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/init.rb

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

data/lib/generators/purgatory/purgatory_generator.rb

@@ -0,0 +1,22 @@
+# Requires
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class PurgatoryGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.new.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'create_purgatories.rb', 'db/migrate/create_purgatories.rb'
+  end
+end

data/lib/generators/purgatory/templates/create_purgatories.rb

@@ -0,0 +1,14 @@
+class CreatePurgatories < ActiveRecord::Migration
+  def change
+    create_table :purgatories do |t|
+      t.integer :soul_id
+      t.string :soul_type
+      t.integer :requester_id
+      t.integer :approver_id
+      t.datetime :approved_at
+      t.string :changes_json
+
+      t.timestamps
+    end
+  end
+end

data/lib/purgatory/purgatory.rb

@@ -0,0 +1,30 @@
+class Purgatory < ActiveRecord::Base
+  attr_accessible :requester, :soul
+
+  belongs_to :soul, polymorphic: true
+  belongs_to :requester, class_name: 'User'
+  belongs_to :approver, class_name: 'User'
+  before_create :store_changes
+
+  validates :soul, :requester, presence: true
+
+  def changes_hash
+    ActiveSupport::JSON.decode(changes_json)
+  end
+
+  def approve!(approver)
+    return if approved_at.present?
+    changes = changes_hash
+    if soul.update_attributes(changes.update(changes){|k,v| v.last}, without_protection: true)
+      self.approver = approver
+      self.approved_at = Time.now
+      save
+    end
+  end
+
+  private
+
+  def store_changes
+    self.changes_json = ActiveSupport::JSON.encode(soul.changes)
+  end
+end

data/lib/purgatory/purgatory_module.rb

@@ -0,0 +1,13 @@
+module PurgatoryModule
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def use_purgatory
+      self.has_many :purgatories, as: :soul
+    end
+  end
+
+  def purgatory!(requester)
+    Purgatory.create soul: self, requester: requester
+  end
+end

data/lib/purgatory.rb

@@ -0,0 +1,3 @@
+require 'purgatory/purgatory'
+require 'purgatory/purgatory_module'
+ActiveRecord::Base.send(:include, PurgatoryModule)

data/purgatory.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: purgatory 0.2.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "purgatory"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Elan Dubrofsky"]
+  s.date = "2013-11-21"
+  s.description = "Put your model changes in purgatory and allow them to remain lost souls until they are approved"
+  s.email = "elan.dubrofsky@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "lib/generators/purgatory/purgatory_generator.rb",
+    "lib/generators/purgatory/templates/create_purgatories.rb",
+    "lib/purgatory.rb",
+    "lib/purgatory/purgatory.rb",
+    "lib/purgatory/purgatory_module.rb",
+    "purgatory.gemspec",
+    "test/helper.rb",
+    "test/test_purgatory.rb"
+  ]
+  s.homepage = "http://github.com/dubroe/purgatory"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.1.10"
+  s.summary = "Allow changes to a model to be put in purgatory until they are approved"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'purgatory'
+
+class Test::Unit::TestCase
+end

data/test/test_purgatory.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestPurgatory < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: purgatory
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Elan Dubrofsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+description: Put your model changes in purgatory and allow them to remain lost souls
+  until they are approved
+email: elan.dubrofsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.markdown
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- lib/generators/purgatory/purgatory_generator.rb
+- lib/generators/purgatory/templates/create_purgatories.rb
+- lib/purgatory.rb
+- lib/purgatory/purgatory.rb
+- lib/purgatory/purgatory_module.rb
+- purgatory.gemspec
+- test/helper.rb
+- test/test_purgatory.rb
+homepage: http://github.com/dubroe/purgatory
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: Allow changes to a model to be put in purgatory until they are approved
+test_files: []