protected_record 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ba5e182fe0caec23566af06a804659fd64927ce
-  data.tar.gz: dd283cab9d1fef2b38b4468acc7c57f332b4af76
+  metadata.gz: 2ca5f6df32648cad9acee2ed43774965181ef3b4
+  data.tar.gz: c9f887c42afc82b5a793b3e9b689102dc1492df6
 SHA512:
-  metadata.gz: 0c8a5c244a1ca72eb8a70e9c4afe89664ff1307e5db0832192fd39faea382efd305bb6ce8d08d81bd00fd5273dbe4732d9942c12d37c7041aa9035c678c5dcb2
-  data.tar.gz: a609d10024a34d026e45203bf85179d2b188e4d3ddeb9a8595eea7dc6f0532f8cfb2db972f37eab1c3e4643e7c1a65db2da41f255e244e190e4b711dba91ea19
+  metadata.gz: c9ff4028860f759cb5a5dd2d9212d2d873b4e6e3b400343199ff37a5f93c852b7510410aa843630fbc1dcfce50979e6826c3c66b9014af8d14ecbfa4027b4518
+  data.tar.gz: 30c2e5c35108ef953ad05c1f5fa676f15f7f74e5fe11c5adeabc1cf5555a70f9a24e7257f422b9700581e84e03c7a7606b5ea7a02d94a26953c3e11d1c1ea1b2

data/README.md

@@ -1,67 +1,83 @@
 # protected_record
+
 ## 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.
 
-Add to your Rails application's Gemfile:
+I've created an engine 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](//github.com/rthbound/protected_record_manager/tree/master/db/migrate).
 
-    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.
+### Your models
 
-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:
+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
 
-1. User (for now I expect a `User` class and `current_user` method
-2. records .. these are the models you want to track
+So, in your models
 
-So in `user.rb`
 ```ruby
+# app/models/user.rb
 include ProtectedRecord::ChangeRequest::Changer
 include ProtectedRecord::ChangeLog::Changer
 ```
 
-And in any model where you want to use protection:
 ```ruby
+# app/models/any.rb
+
 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: 
+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
+   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.
 
 ```ruby
-result = ProtectedRecord::UseCase::Update.new({
-  params: record_params,
+ready = ProtectedRecord::UseCase::Update.new({
+  user:             current_user,
+  params:           record_params,
   protected_record: @record,
-  user: current_user,
-  protected_keys: %w{ do_not_resuscitate organ_donor }
-}).execute!
+  protected_keys:   %w{ do_not_resuscitate organ_donor }
+})
 
-# UseCase module will filter changes to protected_keys,
-# creating a "change request" rather than applying changes
+result = ready.execute!
 
-# UseCase module will allow other changes to be applied,
-# creating a "change log" entry for the observed changes
-update_result.successful? #=> true
+result.successful? #=> true
 ```
-and call methods like
+
+and
+
 ```ruby
+# Who changed what, and when
 @user.change_log_records
+
+# Who attempted to change what, and when
 @user.change_request_records
+
+# What changed, and when
 @record.change_log_records
+
+# What changes were attempted, and when
 @record.change_request_records
 ```
+
+## Contributing
+
+Please do. There's plenty that could be done to round out both the interface
+and the the feature set.
+
+Issues and pull requests would be most appreciated.

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

@@ -1,3 +1,5 @@
+require "json"
+
 module ProtectedRecord
   module UseCase
     module ChangeLog
@@ -28,7 +30,7 @@ module ProtectedRecord
           @record                   = @record_class.new
           @record.user              = @user
           @record.recordable        = @changed_object
-          @record.observed_changes  = ActiveSupport::JSON.encode(@changed_object.previous_changes)
+          @record.observed_changes  = JSON.generate(@changed_object.previous_changes)
         end
       end
     end

data/lib/protected_record/version.rb

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

data/test/minitest_helper.rb

@@ -1,6 +1,7 @@
 # Testing frameworks
 require "minitest/spec"
 require "minitest/autorun"
+require "minitest/mock"
 
 # Debugger
 require "pry"

data/test/protected_record/change_log/create_test.rb

@@ -1,2 +1,120 @@
 require "minitest_helper"
+require "active_record"
 
+describe ProtectedRecord::UseCase::ChangeFilter::Create do
+  describe "new" do
+    before do
+      class TestCase
+        include ActiveModel::Dirty
+
+        define_attribute_methods [:knowledge, :power]
+
+        def knowledge
+          @knowledge
+        end
+
+        def power
+          @power
+        end
+
+        def knowledge=(val)
+          knowledge_will_change! unless val == @knowledge
+          @knowledge = val
+        end
+
+        def power=(val)
+          power_will_change! unless val == @power
+          @power = val
+        end
+
+        def save
+          @previously_changed = changes
+          @changed_attributes.clear
+        end
+
+        def initialize(attributes = {})
+          attributes.each do |name, value|
+            send("#{name}=", value)
+          end
+        end
+        #####
+      end
+
+      @subject = ProtectedRecord::UseCase::ChangeLog::Create
+
+      @protected_record = TestCase.new(knowledge: "power", power: "money")
+      @protected_record.save
+
+      @mock_change_log_record_class = MiniTest::Mock.new
+      @mock_change_log_record = MiniTest::Mock.new
+      @mock_user = MiniTest::Mock.new
+      @changes = JSON.generate(@protected_record.previous_changes)
+      @mock_change_log_record_class.expect(:new, @mock_change_log_record)
+      @mock_change_log_record.expect(:user=, @mock_user, [@mock_user])
+      @mock_change_log_record.expect(:recordable=, @protected_record, [@protected_record])
+      @mock_change_log_record.expect(:observed_changes=, @changes, [@changes])
+      @mock_change_log_record.expect(:save, true)
+
+      @dependencies = {
+        record_class: @mock_change_log_record_class,
+        user: @mock_user,
+        changed_object: @protected_record
+      }
+    end
+
+    it "initializes with required options" do
+      subject = @subject.new(@dependencies)
+
+      subject.must_be_instance_of @subject
+    end
+
+    it "initializes when options with defaults are omitted" do
+      subject = @subject.new(@dependencies.reject { |k| k == :record_class })
+
+      subject.must_be_instance_of @subject
+    end
+
+    it "fails to initialize without :user" do
+      begin
+        @subject.new(@dependencies.reject { |k| k == :user })
+      rescue => e
+        e.must_be_kind_of RuntimeError
+      end
+    end
+
+    it "fails to initialize without :changed_object" do
+      begin
+        @subject.new(@dependencies.reject { |k| k == :changed_object })
+      rescue => e
+        e.must_be_kind_of RuntimeError
+      end
+    end
+
+    it "returns a result" do
+      result = @subject.new(@dependencies).execute!
+
+      @mock_change_log_record.verify
+
+      result.must_be_kind_of(PayDirt::Result)
+    end
+
+    it "does the deed" do
+      result = @subject.new(@dependencies).execute!
+
+      @mock_change_log_record.verify
+
+      result.successful?.must_equal true
+    end
+
+    it "it's not successful if #save fails" do
+      @mock_change_log_record.save
+      @mock_change_log_record.expect(:save, false)
+
+      result = @subject.new(@dependencies).execute!
+
+      @mock_change_log_record.verify
+
+      result.successful?.must_equal false
+    end
+  end
+end

metadata

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