protected_record 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f77ce95c22273bab1bf96d5c3955ec8c0866ea72
-  data.tar.gz: cc5c1b24cda6552940a9b86a7fa466f7a56519ee
+  metadata.gz: 3b07d6ebf3ed0d4992e9ee6918d5abbea15ce1a2
+  data.tar.gz: 20bac695f688e80e68e0a286d687a51b97411ff3
 SHA512:
-  metadata.gz: c65da5f7063befa647fbd49a7ee8d6e13d582d79dbb74d3d760f264e0ec96c8f4022988f0bfc5709a7ec985443454fcacdddfea1675cd739e2f1d9e10ddfc6dd
-  data.tar.gz: 0bc2f938d78f5a4cd364c07082ed77da4a1504f15d361161c4c104ced43e5d1a508949ca2c64b0876f46d68d5b1c61bfdb40ba3bdcc865b9d20e3c2f0894b98e
+  metadata.gz: d42e0214fbf3dab9fc948bb4f6b2e742f2d6aaa98a9862ed33fba9b91e370038b4891779b57d84e2a68c4732e894a1a57c2dbaa7843caf5b320761452f4c00ab
+  data.tar.gz: 0d8fdbc2ad2c3b613c809a99956844ec7c460bd4e2086a64f99ab7ab581e1fa4e549882c91b4cc707ab5f22aea4884c6f242758a486263e9a86df89123e9ccdc

data/README.md

@@ -19,15 +19,16 @@ So, in your models add `require "protected_record"`
 
 ```ruby
 # app/models/user.rb
-include ProtectedRecord::ChangeRequest::Changer
-include ProtectedRecord::ChangeLog::Changer
+include ProtectedRecord::User
+# includes ProtectedRecord::ChangeRequest::Changer
+#        & ProtectedRecord::ChangeLog::Changer
 ```
 
 ```ruby
 # app/models/any.rb
-
-include ProtectedRecord::ChangeRequest::Changeling
-include ProtectedRecord::ChangeLog::Changeling
+include ProtectedRecord::Record
+# includes ProtectedRecord::ChangeRequest::Changeling
+#        & ProtectedRecord::ChangeLog::Changeling
 ```
 
 #### Protected Keys
@@ -63,7 +64,7 @@ Rejected changes will create `ProtectedRecord::ChangeRequest::Record` objects.
 Permitted changes will create `ProtectedRecord::ChangeLog::Record` objects.
 
 ```ruby
-ready = ProtectedRecord::UseCase::Update.new({
+ready = ProtectedRecord::Update.new({
   user:             current_user,
   params:           record_params,
   protected_record: @record,

data/lib/protected_record/record.rb

@@ -0,0 +1,8 @@
+module ProtectedRecord
+  module Record
+    def self.included(base)
+      base.send :include, ProtectedRecord::ChangeLog::Changer
+      base.send :include, ProtectedRecord::ChangeRequest::Changer
+    end
+  end
+end

data/lib/protected_record/update.rb

@@ -0,0 +1,3 @@
+module ProtectedRecord
+  class Update < ProtectedRecord::UseCase::Update; end
+end

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

@@ -1,7 +1,8 @@
 module ProtectedRecord
   module UseCase
     module ChangeFilter
-      class Create < PayDirt::Base
+      class Create
+        include PayDirt::UseCase
         def initialize(options)
           load_options(:protected_record, options)
           validate_state

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

@@ -3,7 +3,8 @@ require "json"
 module ProtectedRecord
   module UseCase
     module ChangeLog
-      class Create < PayDirt::Base
+      class Create
+        include PayDirt::UseCase
         def initialize(options)
           options = {
             record_class: ::ProtectedRecord::ChangeLog::Record

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

@@ -1,7 +1,8 @@
 module ProtectedRecord
   module UseCase
     module ChangeRequest
-      class Create < PayDirt::Base
+      class Create
+        include PayDirt::UseCase
         def initialize(options)
           options = {
             record_class: ::ProtectedRecord::ChangeRequest::Record

data/lib/protected_record/use_case/update.rb

@@ -1,6 +1,7 @@
 module ProtectedRecord
   module UseCase
-    class Update < PayDirt::Base
+    class Update
+      include PayDirt::UseCase
       def initialize(options)
         # Defaults
         options = {
@@ -18,11 +19,14 @@ module ProtectedRecord
 
         # We are successful if all changes have been applied
         if !@protected_record.changes.present?
-          return PayDirt::Result.new(data: { updated: @protected_record }, success: true)
+          return PayDirt::Result.new({
+            data:    { updated: @protected_record },
+            success:   true
+          })
         else
           return PayDirt::Result.new({
-            data: { remaining_changes: @protected_record.changes },
-            success: false
+            data:    { failed: @protected_record.changes },
+            success:   false
           })
         end
       end
@@ -31,18 +35,15 @@ module ProtectedRecord
       def form_change_request
         @protected_record.attributes = @params
 
-        # We allow any changes on creation
-        unless @protected_record.id_was.nil?
-          request_result = @change_request.new({
-            protected_keys: @protected_keys,
-            protected_record: @protected_record,
-            user: @user
-          }).execute!
+        request_result = @change_request.new({
+          protected_keys:   @protected_keys,
+          protected_record: @protected_record,
+          user:             @user
+        }).execute!
 
-          if request_result.successful?
-            revert_protected_attributes ||
-            save_protected_record
-          end
+        if request_result.successful?
+          revert_protected_attributes ||
+          save_protected_record
         end
       end
 

data/lib/protected_record/user.rb

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

data/lib/protected_record/version.rb

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

data/lib/protected_record.rb

@@ -1,3 +1,12 @@
-Dir.glob(File.join(File.dirname(__FILE__), '/**/*.rb')) do |c|
-  require(c)
-end
+require "pay_dirt"
+
+require_relative 'protected_record/use_case/update'
+require_relative 'protected_record/use_case/change_filter/create'
+require_relative 'protected_record/use_case/change_log/create/'
+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'

data/protected_record.gemspec

@@ -9,18 +9,24 @@ Gem::Specification.new do |s|
   s.email       = ["tad.hosford@gmail.com"]
   s.homepage    = "http://github.com/rthbound/protected_record"
   s.description = %q{
-                      Filters changes & logs changes to protected records.
-                      Creates change requests when changes are attempted on protected attrs
+                      Change filter, change log, and change request system. No callbacks.
+                    }
+  s.summary     = %q{
+                      Opt in to use #attributes= and ActiveModel::Dirty
+                      to filter changes to certain keys, to log change requests,
+                      ant to log changes to any protected record.
+
+                      Built modularly so you can use the pieces independently
+                      if you like.
                     }
-  s.summary     = %q{  }
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency     "pay_dirt"
-  s.add_runtime_dependency "activerecord"
+  s.add_runtime_dependency     "pay_dirt",     "~> 0.0.5"
+
   s.add_development_dependency "minitest"
   s.add_development_dependency "rake"
   s.add_development_dependency "pry"

data/test/protected_record/update_test.rb

@@ -1,8 +1,8 @@
 require "minitest_helper"
 
-describe ProtectedRecord::UseCase::Update do
+describe ProtectedRecord::Update do
   before do
-    @subject = ProtectedRecord::UseCase::Update
+    @subject = ProtectedRecord::Update
 
     @params = { params: {
       knowledge: "bad",

data/test/protected_record/use_case/update_test.rb

@@ -0,0 +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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protected_record
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Tad Hosford
@@ -14,30 +14,16 @@ dependencies:
   name: pay_dirt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -80,9 +66,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: "\n                      Filters changes & logs changes to protected
-  records.\n                      Creates change requests when changes are attempted
-  on protected attrs\n                    "
+description: "\n                      Change filter, change log, and change request
+  system. No callbacks.\n                    "
 email:
 - tad.hosford@gmail.com
 executables: []
@@ -99,11 +84,13 @@ files:
 - 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/record.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
@@ -111,6 +98,7 @@ files:
 - test/protected_record/change_log/create_test.rb
 - test/protected_record/change_request/create_test.rb
 - test/protected_record/update_test.rb
+- test/protected_record/use_case/update_test.rb
 homepage: http://github.com/rthbound/protected_record
 licenses: []
 metadata: {}
@@ -133,5 +121,7 @@ rubyforge_project:
 rubygems_version: 2.0.0.rc.2
 signing_key: 
 specification_version: 4
-summary: ''
+summary: 'Opt in to use #attributes= and ActiveModel::Dirty to filter changes to certain
+  keys, to log change requests, ant to log changes to any protected record.  Built
+  modularly so you can use the pieces independently if you like.'
 test_files: []

data/lib/protected_record/use_case.rb

@@ -1,5 +0,0 @@
-module ProtectedRecord
-  module UseCase
-    require "pay_dirt"
-  end
-end