protected_record 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b986b59a39e95c1cf010e1d832fe5e3b113a09b
-  data.tar.gz: 9aaf2d518fb70dc521b35fee444af5b745448ab7
+  metadata.gz: 3ba5e182fe0caec23566af06a804659fd64927ce
+  data.tar.gz: dd283cab9d1fef2b38b4468acc7c57f332b4af76
 SHA512:
-  metadata.gz: e56a6564bf7007ab129daba444ff2d3e05416e0e0430203de47a6eee348ee42714bb3e0b939aaba998fef5ff48ffb9991f11d4d35e6be1709d50661440afd073
-  data.tar.gz: cc0a5f9563e9bb726611c8935d967f182136881060f28bd22604818c0150afde4eb9b828acbeecf86bbee452af3a6a4cec264a233d6b3836001e0f81713f90b3
+  metadata.gz: 0c8a5c244a1ca72eb8a70e9c4afe89664ff1307e5db0832192fd39faea382efd305bb6ce8d08d81bd00fd5273dbe4732d9942c12d37c7041aa9035c678c5dcb2
+  data.tar.gz: a609d10024a34d026e45203bf85179d2b188e4d3ddeb9a8595eea7dc6f0532f8cfb2db972f37eab1c3e4643e7c1a65db2da41f255e244e190e4b711dba91ea19

data/README.md

@@ -1,47 +1,67 @@
 # protected_record
-## Description
-protected_record will prevent changes to attributes you specify as protected. Any attempted change will be logged as a ProtectedRecord::ChangeRequest::Record. 
-If any changes are allowed through the filter, protected_record will create a ProtectedRecord::ChangeLog::Record to log who changed what, and for which record.
-ProtectedRecord is opt-in only. In order to update with protection, use the following: 
+## Setup for rails applications
+I've created an engine to provide the necessary migrations as well as a basic interface for traiging change requests.  You are free to use this gem without the engine, but you'll need to visit [protected_record_manager](https://github.com/rthbound/protected_record_manager/tree/master/db/migrate) and copy the migrations into your app manually.
 
-    result = ProtectedRecord::UseCase::Update.new({
-      params: visit_params,
-      protected_record: @patient_visit,
-      user: current_user,
-      protected_keys: %w{ visit_date do_not_resuscitate }
-    }).execute!
+Add to your Rails application's Gemfile:
 
+    gem "protected_record_manager"
+    
+And to your Rails application's `routes.rb`:
+```ruby
+mount ProtectedRecordManager::Engine, :at => "/protected_record_manager", as: "protected_record_manager"
+```
+Which will provide a user interface for triaging change requests at:
+```
+http://localhost:3000/protected_record_manager/change_requests
+```
+**Important:** Only users with `@user.protected_record_manager == true` will be able to access these resources.
 
-## Usage
-
-To get started, just include in your tracked models:
-
-    include ProtectedRecord::ChangeRequest::Changeling
-    include ProtectedRecord::ChangeLog::Changeling 
-
-and include in your user model:
+Now copy over and run the migrations:
+```
+$ rake protected_record_manager:install:migrations
+$ rake db:migrate
+```
+Lastly, you'll need to prepare your models. There's two types of models at play here:
 
-    include ProtectedRecord::ChangeRequest::Changer
-    include ProtectedRecord::ChangeLog::Changer
+1. User (for now I expect a `User` class and `current_user` method
+2. records .. these are the models you want to track
 
-then in your controller
+So in `user.rb`
+```ruby
+include ProtectedRecord::ChangeRequest::Changer
+include ProtectedRecord::ChangeLog::Changer
+```
 
-    # UseCase module will filter changes to protected_keys,
-    # creating a "change request" rather than applying changes
-
-    # UseCase module will allow other changes to be applied,
-    # creating a "change log" entry for the observed changes
+And in any model where you want to use protection:
+```ruby
+include ProtectedRecord::ChangeRequest::Changeling
+include ProtectedRecord::ChangeLog::Changeling
+```
+## Usage
+1. protected_record will prevent changes to attributes you specify as protected.
+2. Any attempted change will be logged as a `ProtectedRecord::ChangeRequest::Record`. 
+3. If any changes are allowed through the filter, protected_record will create a `ProtectedRecord::ChangeLog::Record` to log who changed what, and for which record.
+4. **Important**: ProtectedRecord is opt-in only. It does not change the way behavior of any AR methods, nor does it use any callbacks. In order to update with protection, use the following: 
 
-    update_result = ProtectedRecord::UseCase::Update.new({
-      params: visit_params,
-      protected_record: @patient_visit,
-      user: current_user,
-      protected_keys: %w{ visit_date do_not_resuscitate }
-    }).execute!
+```ruby
+result = ProtectedRecord::UseCase::Update.new({
+  params: record_params,
+  protected_record: @record,
+  user: current_user,
+  protected_keys: %w{ do_not_resuscitate organ_donor }
+}).execute!
 
-    update_result.successful?
+# UseCase module will filter changes to protected_keys,
+# creating a "change request" rather than applying changes
 
+# UseCase module will allow other changes to be applied,
+# creating a "change log" entry for the observed changes
+update_result.successful? #=> true
+```
 and call methods like
-
-    @user.change_log_records
-    @user.change_request_records
+```ruby
+@user.change_log_records
+@user.change_request_records
+@record.change_log_records
+@record.change_request_records
+```

data/lib/protected_record/use_case/change_request/create.rb

@@ -1,4 +1,3 @@
-require 'pry'
 module ProtectedRecord
   module UseCase
     module ChangeRequest

data/lib/protected_record/version.rb

@@ -1,3 +1,3 @@
 module ProtectedRecord
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/protected_record/change_filter/create_test.rb

@@ -1,6 +1,5 @@
 require "minitest_helper"
 require "active_record"
-require "pry"
 
 describe ProtectedRecord::UseCase::ChangeFilter::Create do
   describe "new" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protected_record
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tad Hosford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-23 00:00:00.000000000 Z
+date: 2013-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pay_dirt