unidom-action 1.17.7 → 1.17.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75bcb3792ea47a2cc2d82a913067499296ac7e51
-  data.tar.gz: 270fd5519f607b163141640292b60e060795aa91
+  metadata.gz: 35a1ddf1d651c7c47f46f565225f1e12077f71ab
+  data.tar.gz: 5fc152d0396f643dc51aa8e88b8233a9ebaf4272
 SHA512:
-  metadata.gz: 4bcadc922fd84aebf0eca25237372addb505701018d1c2086d91b339f8f92d580cdb9e593b5afcfc99c3c8e8fb8d710bb21a10ee9db01e6b9ab7f17feadfed49
-  data.tar.gz: 5caeedbe12357df9701117f614469e83821a7124e0ab64b13ab1bc1c7ba9fd9df2effe580eab3d24f68487842958fc62047e5d489c807289e2ba29c1bde3d466
+  metadata.gz: '09bb6ca560d99656459fac9f381356ea4711b01ea93b345ca3bb458cabaa923433793f7ca44d90972f3275bfd88b29dba67917f8f968f105aa47c3254668ad6a'
+  data.tar.gz: 39fad39e1f09aa7b2624b60756c02ebfddaa02a916f758f8634ae6a0d526e5ea0892aa90a34da8e3c5a858d316b93187f5e795d25f76d687844b1b4fcdf4c087

data/README.md

@@ -125,6 +125,14 @@ The As Actor Party concern do the following tasks for the includer automatically
 
 3. Define the #act? method as: ``act?(on: nil, due_to: nil, via: nil, at: Time.now, action_code: 'C')``
 
+### As Caused concern
+
+The As Caused concern do the following tasks for the includer automatically:
+
+1. Define the belongs_to :reason macro as: ``belongs_to :reason, class_name: 'Unidom::Action::Reason'``
+
+2. Define the caused_by scope as: ``scope :caused_by, ->(reason) { where reason_id: to_id(reason) }``
+
 ### As Obsolesced concern
 
 The As Obsolesced concern do the following tasks for the includer automatically:
@@ -216,6 +224,8 @@ end
 
 ## RSpec examples
 
+### RSpec example manifest (run automatically)
+
 ```ruby
 # spec/models/unidom_spec.rb
 require 'unidom/action/models_rspec'
@@ -226,3 +236,30 @@ require 'unidom/action/types_rspec'
 # spec/validators/unidom_spec.rb
 require 'unidom/action/validators_rspec'
 ```
+
+### RSpec shared examples (to be integrated)
+
+```ruby
+# The Unidom::Action::Acting model, the Unidom::Action::Obsolescing model, the Unidom::Action::Searching model, & the Unidom::Action::StateTransition model already include the Unidom::Action::Concerns::AsCaused concern
+
+# app/models/your_caused.rb
+class YourCaused < ApplicationRecord
+
+  include Unidom::Common::Concerns::ModelExtension
+  include Unidom::Action::Concerns::AsCaused
+
+end
+
+# spec/support/unidom_rspec_shared_examples.rb
+require 'unidom/action/rspec_shared_examples'
+
+# spec/models/your_caused_spec.rb
+describe YourCaused, type: :model do
+
+  model_attribtues = {
+  }
+
+  it_behaves_like 'Unidom::Action::Concerns::AsCaused', model_attribtues
+
+end
+```

data/app/models/unidom/action/acting.rb

@@ -10,16 +10,17 @@ class Unidom::Action::Acting < Unidom::Action::ApplicationRecord
 
   include Unidom::Common::Concerns::ModelExtension
   include ProgneTapera::EnumCode
+  include Unidom::Action::Concerns::AsCaused
 
   belongs_to :actor_visitor, polymorphic: true
   belongs_to :actor_party,   polymorphic: true
   belongs_to :acted,         polymorphic: true
-  belongs_to :reason,        class_name:  'Unidom::Action::Reason'
+  #belongs_to :reason,        class_name:  'Unidom::Action::Reason'
 
   scope :acted_via, ->(actor_visitor) { where actor_visitor: actor_visitor }
   scope :acted_by,  ->(actor_party)   { where actor_party:   actor_party   }
   scope :acted_is,  ->(acted)         { where acted:         acted         }
-  scope :caused_by, ->(reason)        { where reason_id:     to_id(reason) }
+  #scope :caused_by, ->(reason)        { where reason_id:     to_id(reason) }
 
   code :action, Unidom::Action::Action
 

data/app/models/unidom/action/concerns/as_caused.rb

@@ -0,0 +1,16 @@
+module Unidom::Action::Concerns::AsCaused
+
+  extend ActiveSupport::Concern
+
+  included do |includer|
+
+    belongs_to :reason, class_name: 'Unidom::Action::Reason'
+
+    scope :caused_by, ->(reason) { where reason_id: to_id(reason) }
+
+  end
+
+  module ClassMethods
+  end
+
+end

data/app/models/unidom/action/obsolescing.rb

@@ -10,16 +10,15 @@ class Unidom::Action::Obsolescing < Unidom::Action::ApplicationRecord
 
   include Unidom::Common::Concerns::ModelExtension
   include ProgneTapera::EnumCode
+  include Unidom::Action::Concerns::AsCaused
 
   belongs_to :obsolescer_visitor, polymorphic: true
   belongs_to :obsolescer_party,   polymorphic: true
   belongs_to :obsolesced,         polymorphic: true
-  belongs_to :reason,             class_name:  'Unidom::Action::Reason'
 
   scope :obsolesced_via, ->(obsolescer_visitor) { where obsolescer_visitor: obsolescer_visitor }
   scope :obsolesced_by,  ->(obsolescer_party)   { where obsolescer_party:   obsolescer_party   }
   scope :obsolesced_is,  ->(obsolesced)         { where obsolesced:         obsolesced         }
-  scope :caused_by,      ->(reason)             { where reason_id:          to_id(reason)      }
 
   code :obsolescence, Unidom::Action::Obsolescence
 

data/app/models/unidom/action/searching.rb

@@ -7,6 +7,7 @@ class Unidom::Action::Searching < Unidom::Action::ApplicationRecord
   self.table_name = 'unidom_searchings'
 
   include Unidom::Common::Concerns::ModelExtension
+  include Unidom::Action::Concerns::AsCaused
 
   validates :resource_name,    presence: true, length: { in: 1..self.columns_hash['resource_name'].limit }
   validates :platform_name,    presence: true, length: { in: 1..self.columns_hash['platform_name'].limit }
@@ -20,11 +21,9 @@ class Unidom::Action::Searching < Unidom::Action::ApplicationRecord
 
   belongs_to :searcher_visitor, polymorphic: true
   belongs_to :searcher_party,   polymorphic: true
-  belongs_to :reason,           class_name:  'Unidom::Action::Reason'
 
   scope :searched_by,  ->(searcher_party)   { where searcher_party:   searcher_party   }
   scope :searched_via, ->(searcher_visitor) { where searcher_visitor: searcher_visitor }
-  scope :caused_by,    ->(reason)           { where reason_id:        to_id(reason)    }
 
   scope :resource_name_is,    ->(resource_name)    { where resource_name:    resource_name    }
   scope :platform_name_is,    ->(platform_name)    { where platform_name:    platform_name    }

data/app/models/unidom/action/state_transition.rb

@@ -8,16 +8,15 @@ class Unidom::Action::StateTransition < Unidom::Action::ApplicationRecord
   self.table_name = 'unidom_state_transitions'
 
   include Unidom::Common::Concerns::ModelExtension
+  include Unidom::Action::Concerns::AsCaused
 
   belongs_to :transitor_visitor, polymorphic: true
   belongs_to :transitor_party,   polymorphic: true
   belongs_to :subject,           polymorphic: true
-  belongs_to :reason,            class_name:  'Unidom::Action::Reason'
 
   scope :transited_via, ->(transitor_visitor) { where transitor_visitor: transitor_visitor }
   scope :transited_by,  ->(transitor_party)   { where transitor_party:   transitor_party   }
   scope :subject_is,    ->(subject)           { where subject:           subject           }
-  scope :caused_by,     ->(reason)            { where reason_id:         to_id(reason)     }
 
   def self.transit!(subject: nil, from_state: nil, thru_state: nil, transitor_visitor: nil, transitor_party: nil, reason: nil, opened_at: Time.now)
     create! transitor_visitor: transitor_visitor, transitor_party: transitor_party, subject: subject, reason: reason, from_state: from_state, thru_state: thru_state, opened_at: opened_at

data/lib/rspec/models/unidom/action/acting_spec.rb

@@ -22,13 +22,10 @@ describe Unidom::Action::Acting, type: :model do
     }
 
     it_behaves_like 'Unidom::Common::Concerns::ModelExtension', model_attributes
+    it_behaves_like 'Unidom::Action::Concerns::AsCaused',       model_attributes
 
     it_behaves_like 'ProgneTapera::EnumCode', described_class.new(model_attributes), :action, Unidom::Action::Action
 
-    it_behaves_like 'belongs_to', model_attributes, :reason, Unidom::Action::Reason, { name: 'Some Reason' }
-
-    it_behaves_like 'monomorphic scope', model_attributes, :caused_by, :reason
-
   end
 
 end

data/lib/rspec/models/unidom/action/concerns/as_caused_shared_examples.rb

@@ -0,0 +1,11 @@
+shared_examples 'Unidom::Action::Concerns::AsCaused' do |model_attributes|
+
+  context do
+
+    it_behaves_like 'belongs_to', model_attributes, :reason, Unidom::Action::Reason, { name: 'Some Reason' }
+
+    it_behaves_like 'monomorphic scope', model_attributes, :caused_by, :reason
+
+  end
+
+end

data/lib/rspec/models/unidom/action/obsolescing_spec.rb

@@ -20,13 +20,10 @@ describe Unidom::Action::Obsolescing, type: :model do
     }
 
     it_behaves_like 'Unidom::Common::Concerns::ModelExtension', model_attributes
+    it_behaves_like 'Unidom::Action::Concerns::AsCaused',       model_attributes
 
     it_behaves_like 'ProgneTapera::EnumCode', described_class.new(model_attributes), :obsolescence, Unidom::Action::Obsolescence
 
-    it_behaves_like 'belongs_to', model_attributes, :reason, Unidom::Action::Reason, { name: 'Some Reason' }
-
-    it_behaves_like 'monomorphic scope', model_attributes, :caused_by, :reason
-
   end
 
 end

data/lib/rspec/models/unidom/action/searching_spec.rb

@@ -26,10 +26,7 @@ describe Unidom::Action::Searching, type: :model do
     }
 
     it_behaves_like 'Unidom::Common::Concerns::ModelExtension', model_attributes
-
-    it_behaves_like 'belongs_to', model_attributes, :reason, Unidom::Action::Reason, { name: 'Some Reason' }
-
-    it_behaves_like 'monomorphic scope', model_attributes, :caused_by, :reason
+    it_behaves_like 'Unidom::Action::Concerns::AsCaused',       model_attributes
 
     it_behaves_like 'validates text', model_attributes, :resource_name,
       length: 1..described_class.columns_hash['resource_name'].limit

data/lib/rspec/models/unidom/action/state_transition_spec.rb

@@ -21,10 +21,7 @@ describe Unidom::Action::StateTransition, type: :model do
     }
 
     it_behaves_like 'Unidom::Common::Concerns::ModelExtension', model_attributes
-
-    it_behaves_like 'belongs_to', model_attributes, :reason, Unidom::Action::Reason, { name: 'Some Reason' }
-
-    it_behaves_like 'monomorphic scope', model_attributes, :caused_by, :reason
+    it_behaves_like 'Unidom::Action::Concerns::AsCaused',       model_attributes
 
   end
 

data/lib/unidom/action/rspec_shared_examples.rb

@@ -0,0 +1 @@
+require 'rspec/models/unidom/action/concerns/as_caused_shared_examples'

data/lib/unidom/action/version.rb

@@ -1,5 +1,5 @@
 module Unidom
   module Action
-    VERSION = '1.17.7'.freeze
+    VERSION = '1.17.8'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-action
 version: !ruby/object:Gem::Version
-  version: 1.17.7
+  version: 1.17.8
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unidom-common
@@ -47,6 +47,7 @@ files:
 - app/models/unidom/action/application_record.rb
 - app/models/unidom/action/concerns/as_acted.rb
 - app/models/unidom/action/concerns/as_actor_party.rb
+- app/models/unidom/action/concerns/as_caused.rb
 - app/models/unidom/action/concerns/as_obsolesced.rb
 - app/models/unidom/action/concerns/as_obsolescer_party.rb
 - app/models/unidom/action/concerns/as_searcher_party.rb
@@ -68,6 +69,7 @@ files:
 - db/migrate/20000512000000_create_unidom_obsolescings.rb
 - db/migrate/20000513000000_create_unidom_searchings.rb
 - lib/rspec/models/unidom/action/acting_spec.rb
+- lib/rspec/models/unidom/action/concerns/as_caused_shared_examples.rb
 - lib/rspec/models/unidom/action/obsolescing_spec.rb
 - lib/rspec/models/unidom/action/reason_spec.rb
 - lib/rspec/models/unidom/action/searching_spec.rb
@@ -78,6 +80,7 @@ files:
 - lib/unidom/action.rb
 - lib/unidom/action/engine.rb
 - lib/unidom/action/models_rspec.rb
+- lib/unidom/action/rspec_shared_examples.rb
 - lib/unidom/action/types_rspec.rb
 - lib/unidom/action/validators_rspec.rb
 - lib/unidom/action/version.rb