protected_record 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b07d6ebf3ed0d4992e9ee6918d5abbea15ce1a2
-  data.tar.gz: 20bac695f688e80e68e0a286d687a51b97411ff3
+  metadata.gz: ee3db2399060139dabe4efb989ce1b857ee1e018
+  data.tar.gz: 34ff5f83cd940b7535ee3a28336295de5a4add6b
 SHA512:
-  metadata.gz: d42e0214fbf3dab9fc948bb4f6b2e742f2d6aaa98a9862ed33fba9b91e370038b4891779b57d84e2a68c4732e894a1a57c2dbaa7843caf5b320761452f4c00ab
-  data.tar.gz: 0d8fdbc2ad2c3b613c809a99956844ec7c460bd4e2086a64f99ab7ab581e1fa4e549882c91b4cc707ab5f22aea4884c6f242758a486263e9a86df89123e9ccdc
+  metadata.gz: d3f90dd864df8ae173aaeab384a2d544a3a72d5fc2f37fabea55bcbaf7dccd42824b27cb86b75e72de4c2da55b882460fa709e23c0dc8e2a8bef114ce29e7112
+  data.tar.gz: 430b1b8b46b7905d8a6179691cb51560c2d5ee931e70964cd108b4199d243d6a021e64d5f659202cb462d48ade9af35a2ec226a750e08989af12036e6f5f334a

data/README.md

@@ -2,8 +2,9 @@
 
 ## Setup for rails applications
 
-I've created an engine to provide the necessary migrations as well as a (very)
-basic interface for triaging `ProtectedRecord::ChangeRequest::Record` objects.
+I've created a gem called [protected_record_manager](https://github.com/rthbound/protected_record_manager)
+to provide the necessary migrations as well as a (very) basic interface
+for triaging `ProtectedRecord::ChangeRequest::Record` objects.
 You are free to use this gem without the engine, but you'll need to
 [grab these](https://github.com/rthbound/protected_record_manager/tree/master/db/migrate).
 
@@ -12,20 +13,18 @@ You are free to use this gem without the engine, but you'll need to
 Prepare your models.
 There's **two types** of models at play here:
 
-1. User (for now I expect a `User` class and `current_user` method
-2. Your records .. these are the models you want to track
-
-So, in your models add `require "protected_record"`
+* User (for now I expect a `User` class)
 
 ```ruby
 # app/models/user.rb
-include ProtectedRecord::User
+include ProtectedRecord::ResponsibleUser
 # includes ProtectedRecord::ChangeRequest::Changer
 #        & ProtectedRecord::ChangeLog::Changer
 ```
+* Your records .. these are the models you want to track
 
 ```ruby
-# app/models/any.rb
+# app/models/some_record.rb
 include ProtectedRecord::Record
 # includes ProtectedRecord::ChangeRequest::Changeling
 #        & ProtectedRecord::ChangeLog::Changeling
@@ -33,21 +32,25 @@ include ProtectedRecord::Record
 
 #### Protected Keys
 
-You have two options,
+You have three options,
 
-1. Inject the `:protected_keys` option when you execute the update (this will always take precedence)
-2. Include in your record class `ProtectedRecord::DirtyModel` and define them there:
+1. Inject the `:protected_keys` option when you execute the update
+(this will always take precedence over option 2).
+2. Include in your record class `ProtectedRecord::DirtyModel`
+and define protected_keys there
 
 ```ruby
+# How to define :protected_keys in your models.
 class SomeRecord < ActiveRecord::Base
   include ProtectedRecord::DirtyModel
   protected_keys :do_not_resuscitate, :organ_donor
 end
 ```
 
-If you do not specify either option, ProtectedRecord will use an empty array.
+Your third option is to omit `:protected_keys` entirely.
+If they are not specified using either method, ProtectedRecord will use an empty array.
 
-## Usage
+## Usage & Function
 
 1. protected_record will prevent changes to attributes you specify as protected.
 2. Any attempted change will be logged as a
@@ -55,20 +58,21 @@ If you do not specify either option, ProtectedRecord will use an empty array.
 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
+4. **Important!** ProtectedRecord is opt-in only. It does not change the
    behavior of any AR methods, nor does it place any callbacks in your models.
    In order to update with protection, use the following:
 
-This user can change anything but `:do_not_resuscitate`and `:organ_donor`.
-Rejected changes will create `ProtectedRecord::ChangeRequest::Record` objects.
-Permitted changes will create `ProtectedRecord::ChangeLog::Record` objects.
+In the following example, the user will be allowed to change anything
+except `:do_not_resuscitate`. Rejected changes will create
+`ProtectedRecord::ChangeRequest::Record` objects. Permitted changes
+will create `ProtectedRecord::ChangeLog::Record` objects.
 
 ```ruby
 ready = ProtectedRecord::Update.new({
   user:             current_user,
   params:           record_params,
   protected_record: @record,
-  protected_keys:   %w{ do_not_resuscitate organ_donor }
+  protected_keys:   %w{ do_not_resuscitate }
 })
 
 result = ready.execute!
@@ -79,17 +83,13 @@ result.successful? #=> true
 and
 
 ```ruby
-# Who changed what, and when
+# What changed
 @user.change_log_records
+@some_record.change_log_records
 
-# Who attempted to change what, and when
+# What changes were attempted
 @user.change_request_records
-
-# What changed, and when
-@record.change_log_records
-
-# What changes were attempted, and when
-@record.change_request_records
+@some_record.change_request_records
 ```
 
 ## Contributing

data/lib/protected_record.rb

@@ -7,6 +7,6 @@ require_relative 'protected_record/use_case/change_request/create'
 require_relative 'protected_record/update'
 require_relative 'protected_record/change_log'
 require_relative 'protected_record/change_request'
-require_relative 'protected_record/user'
 require_relative 'protected_record/record'
 require_relative 'protected_record/dirty_model'
+require_relative 'protected_record/responsible_user'

data/lib/protected_record/{user.rb → responsible_user.rb}

@@ -1,5 +1,5 @@
 module ProtectedRecord
-  module User
+  module ResponsibleUser
     def self.included(base)
       base.send :include, ProtectedRecord::ChangeLog::Changer
       base.send :include, ProtectedRecord::ChangeRequest::Changer

data/lib/protected_record/version.rb

@@ -1,3 +1,3 @@
 module ProtectedRecord
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protected_record
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tad Hosford
@@ -85,12 +85,12 @@ files:
 - lib/protected_record/change_request.rb
 - lib/protected_record/dirty_model.rb
 - lib/protected_record/record.rb
+- lib/protected_record/responsible_user.rb
 - lib/protected_record/update.rb
 - lib/protected_record/use_case/change_filter/create.rb
 - lib/protected_record/use_case/change_log/create.rb
 - lib/protected_record/use_case/change_request/create.rb
 - lib/protected_record/use_case/update.rb
-- lib/protected_record/user.rb
 - lib/protected_record/version.rb
 - protected_record.gemspec
 - test/minitest_helper.rb