protected_record 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ca5f6df32648cad9acee2ed43774965181ef3b4
-  data.tar.gz: c9f887c42afc82b5a793b3e9b689102dc1492df6
+  metadata.gz: f77ce95c22273bab1bf96d5c3955ec8c0866ea72
+  data.tar.gz: cc5c1b24cda6552940a9b86a7fa466f7a56519ee
 SHA512:
-  metadata.gz: c9ff4028860f759cb5a5dd2d9212d2d873b4e6e3b400343199ff37a5f93c852b7510410aa843630fbc1dcfce50979e6826c3c66b9014af8d14ecbfa4027b4518
-  data.tar.gz: 30c2e5c35108ef953ad05c1f5fa676f15f7f74e5fe11c5adeabc1cf5555a70f9a24e7257f422b9700581e84e03c7a7606b5ea7a02d94a26953c3e11d1c1ea1b2
+  metadata.gz: c65da5f7063befa647fbd49a7ee8d6e13d582d79dbb74d3d760f264e0ec96c8f4022988f0bfc5709a7ec985443454fcacdddfea1675cd739e2f1d9e10ddfc6dd
+  data.tar.gz: 0bc2f938d78f5a4cd364c07082ed77da4a1504f15d361161c4c104ced43e5d1a508949ca2c64b0876f46d68d5b1c61bfdb40ba3bdcc865b9d20e3c2f0894b98e

data/README.md

@@ -5,17 +5,17 @@
 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).
+[grab these](https://github.com/rthbound/protected_record_manager/tree/master/db/migrate).
 
 ### Your models
 
 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
+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
+So, in your models add `require "protected_record"`
 
 ```ruby
 # app/models/user.rb
@@ -30,6 +30,22 @@ include ProtectedRecord::ChangeRequest::Changeling
 include ProtectedRecord::ChangeLog::Changeling
 ```
 
+#### Protected Keys
+
+You have two 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:
+
+```ruby
+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.
+
 ## Usage
 
 1. protected_record will prevent changes to attributes you specify as protected.

data/lib/protected_record/dirty_model.rb

@@ -0,0 +1,17 @@
+module ProtectedRecord
+  module DirtyModel
+    def self.included(base)
+      base.extend(ClassMethods)
+
+      def protected_keys
+        self.class.send(:protected_keys)
+      end
+    end
+
+    module ClassMethods
+      def protected_keys(*args)
+        @@protected_keys ||= args.to_a
+      end
+    end
+  end
+end

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

@@ -3,7 +3,8 @@ module ProtectedRecord
     module ChangeFilter
       class Create < PayDirt::Base
         def initialize(options)
-          load_options(:protected_keys, :protected_record, options)
+          load_options(:protected_record, options)
+          validate_state
         end
 
         def execute!
@@ -22,6 +23,17 @@ module ProtectedRecord
             end
           end
         end
+
+        protected
+        def validate_state
+          if !@protected_keys.kind_of?(Array)
+            if @protected_record.respond_to? :protected_keys
+              @protected_keys = @protected_record.protected_keys
+            else
+              @protected_keys = []
+            end
+          end
+        end
       end
     end
   end

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

@@ -7,7 +7,8 @@ module ProtectedRecord
             record_class: ::ProtectedRecord::ChangeRequest::Record
           }.merge!(options) if !options.has_key?(:record_class)
 
-          load_options(:protected_keys, :record_class, :user, :protected_record, options)
+          load_options(:record_class, :user, :protected_record, options)
+          validate_state
         end
 
         def execute!
@@ -45,6 +46,17 @@ module ProtectedRecord
 
           raise if @protected_keys.any? { |key| @protected_record.send("#{key}_changed?") }
         end
+
+        protected
+        def validate_state
+          if !@protected_keys.kind_of?(Array)
+            if @protected_record.respond_to? :protected_keys
+              @protected_keys = @protected_record.protected_keys
+            else
+              @protected_keys = []
+            end
+          end
+        end
       end
     end
   end

data/lib/protected_record/use_case/update.rb

@@ -9,7 +9,7 @@ module ProtectedRecord
           change_log:     UseCase::ChangeLog::Create
         }.merge!(options)
 
-        load_options(:params, :protected_record, :change_request, :change_log, :change_filter, :protected_keys, :user, options)
+        load_options(:params, :protected_record, :change_request, :change_log, :change_filter, :user, options)
         validate_state
       end
 
@@ -70,7 +70,11 @@ module ProtectedRecord
       def validate_state
         # We expect some keys
         if !@protected_keys.kind_of?(Array)
-          raise TypeError.new(':protected_keys not kind of Array')
+          if @protected_record.respond_to? :protected_keys
+            @protected_keys = @protected_record.protected_keys
+          else
+            @protected_keys = []
+          end
         end
 
         # The keys should respond to to_s

data/lib/protected_record/version.rb

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

data/test/minitest_helper.rb

@@ -11,3 +11,90 @@ $: << File.dirname(__FILE__) + "/../lib"
 $: << File.dirname(__FILE__)
 
 require "protected_record"
+
+class TestCase
+  include ActiveModel::Dirty
+  include ProtectedRecord::DirtyModel
+
+  protected_keys :knowledge, :power
+
+  define_attribute_methods [:knowledge, :power]
+
+  def knowledge
+    @knowledge
+  end
+
+  def attributes=(args)
+  end
+
+  def id_was
+    1
+  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
+
+class UnprotectedTestCase
+  include ActiveModel::Dirty
+
+  define_attribute_methods [:knowledge, :power]
+
+  def knowledge
+    @knowledge
+  end
+
+  def attributes=(args)
+  end
+
+  def id_was
+    1
+  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

data/test/protected_record/change_filter/create_test.rb

@@ -1,45 +1,8 @@
 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::ChangeFilter::Create
 
       @protected_record = TestCase.new(knowledge: "power", power: "money")
@@ -129,5 +92,36 @@ describe ProtectedRecord::UseCase::ChangeFilter::Create do
       ret_obj.knowledge.must_equal "growth"
       ret_obj.power.must_equal "money"
     end
+
+    it "it will read protected_keys from your model" do
+      @protected_record.knowledge="growth"
+      @protected_record.power="knowledge"
+
+      result = @subject.new({
+        protected_record: @protected_record,
+      }).execute!
+
+      ret_obj = result.data[:change_request_record]
+
+      ret_obj.knowledge.must_equal "power"
+      ret_obj.power.must_equal "money"
+    end
+
+    it "will allow any changes when no protected_keys are provided" do
+      @protected_record = UnprotectedTestCase.new(knowledge: "power", power: "money")
+      @protected_record.save
+
+      @protected_record.knowledge="growth"
+      @protected_record.power="knowledge"
+
+      result = @subject.new({
+        protected_record: @protected_record,
+      }).execute!
+
+      ret_obj = result.data[:change_request_record]
+
+      ret_obj.knowledge.must_equal "growth"
+      ret_obj.power.must_equal "knowledge"
+    end
   end
 end

data/test/protected_record/change_log/create_test.rb

@@ -1,82 +1,45 @@
 require "minitest_helper"
-require "active_record"
 
-describe ProtectedRecord::UseCase::ChangeFilter::Create do
+describe ProtectedRecord::UseCase::ChangeLog::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)
+      @subject =   ProtectedRecord::UseCase::ChangeLog::Create
+      @test_case = TestCase.new({
+        knowledge: "power",
+        power:     "money"
+      })
+      @test_case.save
+
+      @change_log_record_class = MiniTest::Mock.new
+      @change_log_record       = MiniTest::Mock.new
+      @user                    = MiniTest::Mock.new
+      @changes                 = JSON.generate(@test_case.previous_changes)
+      @change_log_record_class.expect :new,         @change_log_record
+      @change_log_record.expect       :user=,       @user, [@user]
+      @change_log_record.expect       :recordable=, @test_case, [@test_case]
+      @change_log_record.expect       :observed_changes=, @changes, [@changes]
+      @change_log_record.expect       :save, true
 
       @dependencies = {
-        record_class: @mock_change_log_record_class,
-        user: @mock_user,
-        changed_object: @protected_record
+        user:           @user,
+        record_class:   @change_log_record_class,
+        changed_object: @test_case
       }
     end
 
     it "initializes with required options" do
-      subject = @subject.new(@dependencies)
-
+      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 = @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 })
+        @subject.new @dependencies.reject { |k| k == :user }
       rescue => e
         e.must_be_kind_of RuntimeError
       end
@@ -84,7 +47,7 @@ describe ProtectedRecord::UseCase::ChangeFilter::Create do
 
     it "fails to initialize without :changed_object" do
       begin
-        @subject.new(@dependencies.reject { |k| k == :changed_object })
+        @subject.new @dependencies.reject { |k| k == :changed_object }
       rescue => e
         e.must_be_kind_of RuntimeError
       end
@@ -93,7 +56,7 @@ describe ProtectedRecord::UseCase::ChangeFilter::Create do
     it "returns a result" do
       result = @subject.new(@dependencies).execute!
 
-      @mock_change_log_record.verify
+      @change_log_record.verify
 
       result.must_be_kind_of(PayDirt::Result)
     end
@@ -101,18 +64,18 @@ describe ProtectedRecord::UseCase::ChangeFilter::Create do
     it "does the deed" do
       result = @subject.new(@dependencies).execute!
 
-      @mock_change_log_record.verify
+      @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)
+      @change_log_record.save
+      @change_log_record.expect(:save, false)
 
       result = @subject.new(@dependencies).execute!
 
-      @mock_change_log_record.verify
+      @change_log_record.verify
 
       result.successful?.must_equal false
     end

data/test/protected_record/change_request/create_test.rb

@@ -1,2 +1,94 @@
 require "minitest_helper"
 
+describe ProtectedRecord::UseCase::ChangeRequest::Create do
+  describe "new" do
+    before do
+      @subject = ProtectedRecord::UseCase::ChangeRequest::Create
+
+      @protected_record = TestCase.new(knowledge: "power", power: "money")
+      @protected_record.save
+
+      @mock_change_request_record_class = MiniTest::Mock.new
+      @mock_change_request_record       = MiniTest::Mock.new
+      @mock_user                        = MiniTest::Mock.new
+      @mock_change_request_record_class.expect(:new, @mock_change_request_record)
+      @mock_change_request_record.expect(:user=, @mock_user, [@mock_user])
+      @mock_change_request_record.expect(:recordable=, @protected_record, [@protected_record])
+      @mock_change_request_record.expect(:save, true)
+
+      @protected_record.power= "trivial knowledge"
+      @changes = JSON.generate(@protected_record.changes)
+      @mock_change_request_record.expect(:requested_changes=, @changes, [@changes])
+
+      @dependencies = {
+        protected_keys:   %w{ power },
+        protected_record: @protected_record,
+        record_class:     @mock_change_request_record_class,
+        user:             @mock_user
+      }
+    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 == :protected_record })
+      rescue => e
+        e.must_be_kind_of RuntimeError
+      end
+    end
+
+    it "returns a result" do
+      result = @subject.new(@dependencies).execute!
+
+      result.must_be_kind_of(PayDirt::Result)
+    end
+    it "does the deed" do
+      result = @subject.new(@dependencies).execute!
+
+      @mock_change_request_record.verify
+
+      result.successful?.must_equal true
+    end
+
+    it "can read protected_keys from your model" do
+      so = @subject.new @dependencies.reject { |k| k.to_s == "protected_keys" }
+      result = so.execute!
+
+
+      @mock_change_request_record.verify
+
+      result.successful?.must_equal true
+    end
+
+    it "it's not successful if #save fails" do
+      @mock_change_request_record.save
+      @mock_change_request_record.expect(:save, false)
+
+      result = @subject.new(@dependencies).execute!
+
+      @mock_change_request_record.verify
+
+      result.successful?.must_equal false
+    end
+  end
+end
+

data/test/protected_record/update_test.rb

@@ -1 +1,44 @@
 require "minitest_helper"
+
+describe ProtectedRecord::UseCase::Update do
+  before do
+    @subject = ProtectedRecord::UseCase::Update
+
+    @params = { params: {
+      knowledge: "bad",
+      power:     "money"
+    }}
+
+    @test_case = TestCase.new( knowledge: :power )
+
+    @dependencies = {
+      user:              MiniTest::Mock.new,
+      protected_record: @test_case,
+      protected_keys:   [:knowledge],
+    }
+    @dependencies.merge! @params
+  end
+
+  it "can be initialized" do
+    @subject.must_respond_to :new
+  end
+
+  it "fails without required dependencies" do
+    %w{ user params protected_record }.each do |dep|
+      begin
+        @subject.new @dependencies.reject { |k| k.to_s == dep }
+      rescue => e
+        e.must_be_kind_of RuntimeError
+      end
+    end
+  end
+
+  it "initializes without :protected_keys" do
+    so = @subject.new @dependencies.reject { |k| k.to_s == "protected_keys" }
+    so.must_respond_to :execute!
+  end
+
+  it "can be executed" do
+    @subject.new(@dependencies).must_respond_to :execute!
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protected_record
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Tad Hosford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-25 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pay_dirt
@@ -98,6 +98,7 @@ files:
 - lib/protected_record.rb
 - lib/protected_record/change_log.rb
 - lib/protected_record/change_request.rb
+- lib/protected_record/dirty_model.rb
 - lib/protected_record/use_case.rb
 - lib/protected_record/use_case/change_filter/create.rb
 - lib/protected_record/use_case/change_log/create.rb