purgatory 0.2.0 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGU4MWYzYTMwMDA2MzBjN2U1ZDc0ZDMzMGRmMTA5YTE3ZTE0Mjg4Mw==
+    ZjNiYzA3NTg0YjQzMTQ0ZmE3ZjdmNzcyZWIwOGJiNGRjOGY1M2U3NQ==
   data.tar.gz: !binary |-
-    YmViZGNmYTUxNjQ0MjdhYmVkZGZkMWFlNDI3MmRiNzIzODZkMzI4Zg==
+    OWQ0MGZmZDg2ZjhjYmNjNGVkZjhkNTAwMzMxZmM1ZWJkNzdmMTVhYg==
 SHA512:
   metadata.gz: !binary |-
-    Zjc2NWM4NThhNjZiMzM4NmQ3ODFlYjAxYjRjODY2MjljYzBhYzE2NzQxMGY2
-    ZmEzNWU3Mjg2OTkzMjNjOWRlMDJkOTdjZGQ5MWE5NTNmMDdmYTBiYjEwZjBl
-    ZGY2M2NkMjc0OTIwOWU1ZGZkYzZlOGJhMzVmNjQxZTNmMjc3Y2I=
+    OGQ3MTIxYjgxYzZiOTNjMDhhNGZjNzRiY2Y3NjQ2NjZhMTMxZjY1ODZhMDA1
+    NzdhNzY3MzQ0MmRmNDYzMTBkMDRlMTBhOTZhZDY5MDQ0NzI1MDIzODAyMWE0
+    ZTAxMmRhNGQ0NmEyZjczNDg5ZjU0MTA5Yzc2M2M3OTg0NzhjNTU=
   data.tar.gz: !binary |-
-    NjhjMjQ2MzQ0MzRhYmI1NzVhMzZkZDc5OWEwODk3ZTcwNDM4YTM2MDMzM2Y3
-    NzI2ZmI4NWM4NzM4NDM0MDgyZGU2MGIyOWE4YjBkN2YzOTRjYmFjZjZmYTU3
-    NzJhMTlhYTdlNDdiYzYyZmNhZWM0MjY1MGNjOTI2YjZlYTIyYmQ=
+    NmM4ZDU3MjIzNDdhMTQ0MGNkNmM1YmVlM2Y4MTYzMjgwNmYyZmYzMDRlNjYw
+    ZjYzNWEzNDViZmEyMjU4YjBmMWFmOTAyZTUwM2Y1MjYwNjM5OTk5NGI4ZDE1
+    ODU5YWZiMjU3MmU0Y2U1MTIxMzdlOWEyYjQxZDA4ZmRkODNhMTQ=

data/README.markdown

@@ -24,9 +24,28 @@ To put your changes to an ActiveRecord class into Purgatory, simply make your ch
 
 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 = item.purgatories.last
     purgatory.approve!(current_user)
 
+The following are the attributes of a purgatory:
+
+    purgatory.soul # The ActiveRecord model instance whose changes are in purgatory
+    purgatory.requester # The user who created the purgatory
+    purgatory.created_at # The time when the purgatory was created
+    purgatory.approver # The user who approved the purgatory
+    purgatory.approved_at # The time when the purgatory was approved
+
+Here are some handy scopes and methods available to you:
+
+    ### Scopes
+    Purgatory.pending # Returns a relation of all pending purgatories
+    Purgatory.approved # Returns a relation of all approved purgatories
+
+    ### Methods
+    purgatory.pending? # Returns true if the purgatory is pending, false otherwise
+    purgatory.approved? # Returns true if the purgatory has been approved, false otherwise
+    purgatory.changes_hash # Returns a hash of the proposed changes. The keys are the attribute names and the values are 2-element arrays where the 1st element is the old value and the 2nd element is the new value
+
 ## 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.

data/VERSION

@@ -1 +1 @@
-0.2.0
+1.0.0

data/lib/purgatory/purgatory.rb

@@ -8,6 +8,17 @@ class Purgatory < ActiveRecord::Base
 
   validates :soul, :requester, presence: true
 
+  scope :pending, conditions: { approved_at: nil }
+  scope :approved, conditions: ["approved_at IS NOT NULL"]
+
+  def approved?
+    approved_at.present?
+  end
+
+  def pending?
+    approved_at.nil?
+  end
+
   def changes_hash
     ActiveSupport::JSON.decode(changes_json)
   end

data/purgatory.gemspec

@@ -2,11 +2,11 @@
 # 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
+# stub: purgatory 1.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "purgatory"
-  s.version = "0.2.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Elan Dubrofsky"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: purgatory
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Elan Dubrofsky