global-registry-bindings 0.1.3 → 0.1.4

data/lib/global_registry_bindings/global_registry_bindings.rb

@@ -16,103 +16,6 @@ require 'global_registry_bindings/worker'
 
 module GlobalRegistry #:nodoc:
   module Bindings #:nodoc:
-    # Call this in your model to enable and configure Global Registry bindings.
-    #
-    # Options:
-    #
-    # * `:binding`: Type of Global Registry binding. Either `:entity` or `:relationship`.
-    #   (default: `:entity`)
-    #
-    # * `:id_column`: Column used to track the Global Registry ID for the model instance or relationship entity.
-    #    Can be a :string or :uuid column. (default: `:global_registry_id`) **[`:entity`, `:relationship`]**
-    #
-    # * `:type`: Global Registry entity type. Accepts a Symbol or a Proc. Symbol is the name of the entity type, Proc
-    #   is passed the model instance and must return a symbol which is the entity type. Default value is underscored
-    #   name of the model. Ex: ```type: proc { |model| model.name.to_sym }```. When used in a `:relationship`, `:type`
-    #   is a unique name to identify the relationship. **[`:entity`, `:relationship`]**
-    #
-    # * `:push_on`: Array of Active Record lifecycle events used to push changes to Global Registry.
-    #   (default: `[:create, :update, :destroy]`) **[`:entity`]**
-    #
-    # * `:parent_association`: Name of the Active Record parent association. Must be defined before calling
-    #   global_registry_bindings in order to determine foreign_key for use in exclude. Used to create a
-    #   hierarchy or to push child entity types. (Ex: person -> address) (default: `nil`) **[`:entity`]**
-    #
-    # * `:parent_association_class`: Class name of the parent model. Required if `:parent_association` can not be used
-    #   to determine the parent class. This can happen if parent is defined by another gem, like `ancestry`.
-    #   (default: `nil`) **[`:entity`]**
-    #
-    # * `:primary_binding`: Determines what type of global-registry-binding the primary association points to. Defaults
-    #   to `:entity`, but can be set to a `:relationship` type name (ex: `:assignment`) to create a relationship_type
-    #   between a relationship and an entity. (default: `:entity`) **[`:relationship`]**
-    #
-    # * `:primary_association`: Name of the Active Record primary association. Must be defined before calling
-    #   global_registry_bindings in order to determine foreign_key for use in exclude. (default: `nil`)
-    #   **[`:relationship`]**
-    #
-    # * `:primary_association_class`: Class name of the primary model. Required if `:primary_association` can not be
-    #   used to determine the parent class. This can happen if parent is defined by another gem, like `ancestry`.
-    #   (default: `self.class`) **[`:relationship`]**
-    #
-    # * `:primary_association_foreign_key`: Foreign Key column for the primary association. Used if foreign_key can
-    #   not be determined from `:primary_association`. (default: `:primary_association.foreign_key`)
-    #   **[`:relationship`]**
-    #
-    # * `:related_association`: Name of the Active Record related association. Active Record association must be
-    #   defined before calling global_registry_bindings in order to determine the foreign key.
-    #   (default: `nil`) **[`:relationship`]**
-    #
-    # * `:related_association_class`: Class name of the related model. Required if `:related_association` can not be
-    #    used to determine the related class. (default: `nil`) **[`:relationship`]**
-    #
-    # * `:related_association_foreign_key`: Foreign Key column for the related association. Used if foreign_key can
-    #   not be determined from `:primary_association`. (default: `:primary_association.foreign_key`)
-    #   **[`:relationship`]**
-    #
-    # * `:primary_relationship_name`: **Required** Name of primary relationship. Should be unique to prevent
-    #   ambiguous relationship names. (default: `nil`) **[`:relationship`]**
-    #
-    # * `:related_relationship_name`: **Required** Name of the related relationship. Should be unique to prevent
-    #   ambiguous relationship names (default: `nil`) **[`:relationship`]**
-    #
-    # * `:related_association_type`: Name of the related association entity_type. Required if unable to determined
-    #   `:type` from related. (default: `nil`) **[`:relationship`]**
-    #
-    # * `:related_global_registry_id`: Global Registry ID of a remote related entity. Proc or Symbol. Implementation
-    #   should cache this as it may be requested multiple times. (default: `nil`) **[`:relationship`]**
-    #
-    # * `:ensure_relationship_type`: Ensure Global Registry RelationshipType exists and is up to date.
-    #   (default: `true`) **[`:relationship`]**
-    #
-    # * `:ensure_entity_type`: Ensure Global Registry Entity Type exists and is up to date.
-    #   (default: `true`) **[`:entity`]**
-    #
-    # * `:client_integration_id`: Client Integration ID for relationship. Proc or Symbol.
-    #   (default: `:primary_association.id`) **[`:relationship`]**
-    #
-    # * `:exclude`: Array, Proc or Symbol. Array of Model fields (as symbols) to exclude when pushing to Global
-    #   Registry. Array Will additionally include `:mdm_id_column` and `:parent_association` foreign key when defined.
-    #   If Proc, is passed type and model instance and should return an Array of the fields to exclude. If Symbol,
-    #   this should be a method name the Model instance responds to. It is passed the type and should return an Array
-    #   of fields to exclude. When Proc or Symbol are used, you must explicitly return the standard defaults.
-    #   (default:  `[:id, :created_at, :updated_at, :global_registry_id]`) **[`:entity`, `:relationship`]**
-    #
-    # * `:fields`: Additional fields to send to Global Registry. Hash, Proc or Symbol. As a Hash, names are the
-    #   keys and :type attributes are the values. Ex: `{language: :string}`. Name is a symbol and type is an
-    #   ActiveRecord column type. As a Proc, it is passed the type and model instance, and should return a Hash.
-    #   As a Symbol, the model should respond to this method, is passed the type, and should return a Hash.
-    #   **[`:entity`, `:relationship`]**
-    #
-    # * `:include_all_columns`: Include all model columns in the fields to push to Global Registry. If `false`, fields
-    #   must be defined in the `:fields` option. (default: `false`) **[`:entity`, `:relationship`]**
-    #
-    # * `:mdm_id_column`: Column used to enable MDM tracking and set the name of the column. MDM is disabled when this
-    #   option is nil or empty. (default: `nil`) **[`:entity`]**
-    #
-    # * `:mdm_timeout`: Only pull mdm information at most once every `:mdm_timeout`. (default: `1.minute`)
-    #   **[`:entity`]**
-    #
-    # @api public
     def global_registry_bindings(options = {})
       options[:binding] ||= :entity
       unless method_defined? :_global_registry_bindings_options

data/lib/global_registry_bindings/model/push_relationship.rb

@@ -61,8 +61,8 @@ module GlobalRegistry #:nodoc:
         # rubocop:disable Metrics/PerceivedComplexity
         # rubocop:disable Metrics/AbcSize
         def global_registry_relationship_change_action(type)
-          [global_registry_relationship(type).primary_association_foreign_key,
-           global_registry_relationship(type).related_association_foreign_key].each do |key|
+          [global_registry_relationship(type).primary_foreign_key,
+           global_registry_relationship(type).related_foreign_key].each do |key|
             if previous_changes.key?(key)
               # Delete if changed from anything to nil
               return :delete if previous_changes[key].last.nil?

data/lib/global_registry_bindings/options/entity_class_options.rb

@@ -11,8 +11,8 @@ module GlobalRegistry #:nodoc:
                  :type,
                  :mdm_timeout,
                  :push_on,
-                 :parent_association,
-                 :parent_association_class,
+                 :parent,
+                 :parent_class,
                  :exclude,
                  :fields, to: :@options
 
@@ -21,8 +21,8 @@ module GlobalRegistry #:nodoc:
           @options = OpenStruct.new model_class._global_registry_bindings_options[:entity]
         end
 
-        def ensure_entity_type?
-          @options.ensure_entity_type.present?
+        def ensure_type?
+          @options.ensure_type.present?
         end
 
         def include_all_columns?

data/lib/global_registry_bindings/options/entity_instance_options.rb

@@ -8,10 +8,8 @@ module GlobalRegistry #:nodoc:
                  :mdm_id_column,
                  :mdm_timeout,
                  :push_on,
-                 :parent_association,
-                 :parent_association_class,
                  :mdm_worker_class_name,
-                 :ensure_entity_type?,
+                 :ensure_type?,
                  :include_all_columns?,
                  to: :@class_options
 
@@ -38,12 +36,12 @@ module GlobalRegistry #:nodoc:
         end
 
         def parent
-          @model.send(parent_association) if parent_association.present?
+          @model.send(@class_options.parent) if @class_options.parent.present?
         end
 
         def parent_class
-          return if parent_association.blank?
-          parent_association_class
+          return if @class_options.parent.blank?
+          @class_options.parent_class
         end
 
         def parent_type
@@ -55,11 +53,11 @@ module GlobalRegistry #:nodoc:
         end
 
         def parent_required?
-          parent_association.present? && !parent_is_self?
+          @class_options.parent.present? && !parent_is_self?
         end
 
         def parent_is_self?
-          parent_association.present? && parent_class == @model.class
+          @class_options.parent.present? && parent_class == @model.class
         end
 
         def exclude

data/lib/global_registry_bindings/options/entity_options_parser.rb

@@ -10,22 +10,23 @@ module GlobalRegistry #:nodoc:
 
         def defaults
           {
+            binding: :entity,
             id_column: :global_registry_id,
             mdm_id_column: nil,
             type: @model_class.name.demodulize.underscore.to_sym,
             push_on: %i[create update destroy],
-            parent_association: nil,
-            parent_association_class: nil,
-            parent_relationship_name: nil,
+            parent: nil,
+            parent_class: nil,
             exclude: %i[id created_at updated_at],
             fields: {},
             include_all_columns: false,
             mdm_timeout: 1.minute,
-            ensure_entity_type: true
+            ensure_type: true
           }.freeze
         end
 
         def parse(options_hash = {})
+          validate_options! options_hash
           merge_defaults options_hash
           update_association_classes
           update_excludes
@@ -34,6 +35,11 @@ module GlobalRegistry #:nodoc:
 
         private
 
+        def validate_options!(options = {})
+          unknown = options.keys - defaults.keys
+          raise ArgumentError, "global-registry-bindings: Unknown options (#{unknown.join ', '})" unless unknown.empty?
+        end
+
         def merge_defaults(options_hash = {})
           @options = defaults.merge(options_hash) do |key, oldval, newval|
             if key == :exclude
@@ -50,8 +56,8 @@ module GlobalRegistry #:nodoc:
         end
 
         def update_association_classes
-          unless @options[:parent_association_class] # rubocop:disable Style/GuardClause
-            @options[:parent_association_class] = association_class @options[:parent_association]
+          unless @options[:parent_class] # rubocop:disable Style/GuardClause
+            @options[:parent_class] = association_class @options[:parent]
           end
         end
 
@@ -60,7 +66,7 @@ module GlobalRegistry #:nodoc:
           @options[:exclude] << @options[:id_column]
           @options[:exclude] << @options[:mdm_id_column] if @options[:mdm_id_column].present?
 
-          parent_id_column = association_foreign_key @options[:parent_association]
+          parent_id_column = association_foreign_key @options[:parent]
           @options[:exclude] << parent_id_column.to_sym if parent_id_column
         end
 

data/lib/global_registry_bindings/options/relationship_class_options.rb

@@ -11,15 +11,15 @@ module GlobalRegistry #:nodoc:
                  :push_on,
                  :client_integration_id,
                  :primary_binding,
-                 :primary_association,
-                 :primary_association_class,
-                 :primary_association_foreign_key,
-                 :primary_relationship_name,
-                 :related_association,
-                 :related_association_class,
-                 :related_association_foreign_key,
-                 :related_association_type,
-                 :related_relationship_name,
+                 :primary,
+                 :primary_class,
+                 :primary_foreign_key,
+                 :primary_name,
+                 :related,
+                 :related_class,
+                 :related_foreign_key,
+                 :related_type,
+                 :related_name,
                  :related_global_registry_id,
                  :exclude,
                  :fields, to: :@options
@@ -29,8 +29,8 @@ module GlobalRegistry #:nodoc:
           @options = OpenStruct.new model_class._global_registry_bindings_options[:relationships][type]
         end
 
-        def ensure_relationship_type?
-          @options.ensure_relationship_type.present?
+        def ensure_type?
+          @options.ensure_type.present?
         end
 
         def rename_entity_type?

data/lib/global_registry_bindings/options/relationship_instance_options.rb

@@ -7,13 +7,9 @@ module GlobalRegistry #:nodoc:
         delegate :id_column,
                  :push_on,
                  :primary_binding,
-                 :primary_association,
-                 :primary_association_class,
-                 :primary_association_foreign_key,
-                 :related_association,
-                 :related_association_class,
-                 :related_association_foreign_key,
-                 :ensure_relationship_type?,
+                 :primary_foreign_key,
+                 :related_foreign_key,
+                 :ensure_type?,
                  :rename_entity_type?,
                  :include_all_columns?,
                  to: :@class_options
@@ -53,12 +49,12 @@ module GlobalRegistry #:nodoc:
         end
 
         def primary
-          return @model.send(primary_association) if primary_association.present?
+          return @model.send(@class_options.primary) if @class_options.primary.present?
           @model
         end
 
         def primary_class
-          primary_association_class || primary.class
+          @class_options.primary_class || primary.class
         end
 
         def primary_type
@@ -83,16 +79,16 @@ module GlobalRegistry #:nodoc:
           primary_class == @model.class
         end
 
-        def primary_relationship_name
-          @class_options.primary_relationship_name || primary_type
+        def primary_name
+          @class_options.primary_name || primary_type
         end
 
         def related
-          @model.send(related_association) if related_association.present?
+          @model.send(@class_options.related) if @class_options.related.present?
         end
 
         def related_type
-          @class_options.related_association_type || related&.global_registry_entity&.type
+          @class_options.related_type || related&.global_registry_entity&.type
         end
 
         def related_id_value
@@ -107,8 +103,8 @@ module GlobalRegistry #:nodoc:
           end
         end
 
-        def related_relationship_name
-          @class_options.related_relationship_name || related_type
+        def related_name
+          @class_options.related_name || related_type
         end
 
         def exclude

data/lib/global_registry_bindings/options/relationship_options_parser.rb

@@ -10,22 +10,19 @@ module GlobalRegistry #:nodoc:
 
         def defaults
           {
-            id_column: :global_registry_id,
+            binding: :relationship, id_column: :global_registry_id,
             type: @model_class.name.demodulize.underscore.to_sym,
-            client_integration_id: :id, primary_binding: :entity,
-            primary_association: nil,
-            primary_association_class: nil,
-            primary_relationship_name: nil,
-            related_association: nil,
-            related_association_class: nil, related_association_type: nil,
-            related_relationship_name: nil,
+            client_integration_id: :id,
+            primary_binding: :entity, primary: nil, primary_class: nil, primary_name: nil, primary_foreign_key: nil,
+            related: nil, related_class: nil, related_type: nil, related_name: nil, related_foreign_key: nil,
             related_global_registry_id: nil,
             exclude: %i[id created_at updated_at], include_all_columns: false,
-            fields: {}, ensure_relationship_type: true, rename_entity_type: true
+            fields: {}, ensure_type: true, rename_entity_type: true
           }.freeze
         end
 
         def parse(options_hash = {})
+          validate_options! options_hash
           merge_defaults(options_hash)
           update_association_classes
           update_foreign_keys
@@ -35,6 +32,11 @@ module GlobalRegistry #:nodoc:
 
         private
 
+        def validate_options!(options = {})
+          unknown = options.keys - defaults.keys
+          raise ArgumentError, "global-registry-bindings: Unknown options (#{unknown.join ', '})" unless unknown.empty?
+        end
+
         def merge_defaults(options_hash = {})
           @options = defaults.merge(options_hash) do |key, oldval, newval|
             if key == :exclude
@@ -51,24 +53,24 @@ module GlobalRegistry #:nodoc:
         end
 
         def update_association_classes
-          unless @options[:primary_association_class]
-            @options[:primary_association_class] = if @options[:primary_association]
-                                                     association_class @options[:primary_association]
-                                                   else
-                                                     @model_class
-                                                   end
+          unless @options[:primary_class]
+            @options[:primary_class] = if @options[:primary]
+                                         association_class @options[:primary]
+                                       else
+                                         @model_class
+                                       end
           end
-          unless @options[:related_association_class] # rubocop:disable Style/GuardClause
-            @options[:related_association_class] = association_class @options[:related_association]
+          unless @options[:related_class] # rubocop:disable Style/GuardClause
+            @options[:related_class] = association_class @options[:related]
           end
         end
 
         def update_foreign_keys
-          unless @options[:primary_association_foreign_key]
-            @options[:primary_association_foreign_key] = association_foreign_key @options[:primary_association]
+          unless @options[:primary_foreign_key]
+            @options[:primary_foreign_key] = association_foreign_key @options[:primary]
           end
-          unless @options[:related_association_foreign_key] # rubocop:disable Style/GuardClause
-            @options[:related_association_foreign_key] = association_foreign_key @options[:related_association]
+          unless @options[:related_foreign_key] # rubocop:disable Style/GuardClause
+            @options[:related_foreign_key] = association_foreign_key @options[:related]
           end
         end
 
@@ -77,11 +79,11 @@ module GlobalRegistry #:nodoc:
           @options[:exclude] << @options[:id_column]
           @options[:exclude] << @options[:mdm_id_column] if @options[:mdm_id_column].present?
 
-          if @options[:primary_association_foreign_key]
-            @options[:exclude] << @options[:primary_association_foreign_key]
+          if @options[:primary_foreign_key]
+            @options[:exclude] << @options[:primary_foreign_key]
           end
-          if @options[:related_association_foreign_key] # rubocop:disable Style/GuardClause
-            @options[:exclude] << @options[:related_association_foreign_key]
+          if @options[:related_foreign_key] # rubocop:disable Style/GuardClause
+            @options[:exclude] << @options[:related_foreign_key]
           end
         end
 

data/lib/global_registry_bindings/version.rb

@@ -2,6 +2,6 @@
 
 module GlobalRegistry #:nodoc:
   module Bindings #:nodoc:
-    VERSION = '0.1.3'
+    VERSION = '0.1.4'
   end
 end

data/spec/acceptance/global_registry_bindings_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe 'GlobalRegistry::Bindings' do
     it 'should have default values for all options' do
       expect(Default.global_registry_entity.id_column).to be :global_registry_id
       expect(Default.global_registry_entity.mdm_id_column).to be nil
-      expect(Default.global_registry_entity.parent_association).to be nil
+      expect(Default.global_registry_entity.parent).to be nil
       expect(Default.global_registry_entity.push_on)
         .to contain_exactly(:create, :update, :destroy)
       expect(Default.global_registry_entity.mdm_timeout).to eq 1.minute
@@ -42,7 +42,7 @@ RSpec.describe 'GlobalRegistry::Bindings' do
       expect(Address.global_registry_entity.id_column).to be :global_registry_id
       expect(Address.global_registry_entity.mdm_id_column).to be nil
       expect(Address.global_registry_entity.type).to be :address
-      expect(Address.global_registry_entity.parent_association).to be :person
+      expect(Address.global_registry_entity.parent).to be :person
       expect(Address.global_registry_entity.exclude).to be_a Proc
       expect(address.global_registry_entity.exclude)
         .to contain_exactly(:global_registry_id, :id, :created_at, :updated_at, :person_id, :address1)
@@ -57,7 +57,7 @@ RSpec.describe 'GlobalRegistry::Bindings' do
       expect(Organization.global_registry_entity.mdm_id_column).to be nil
       expect(Organization.global_registry_entity.type).to be_a Proc
       expect(org.global_registry_entity.type).to be :fancy_org
-      expect(Organization.global_registry_entity.parent_association).to be :parent
+      expect(Organization.global_registry_entity.parent).to be :parent
       expect(Organization.global_registry_entity.push_on).to be_an(Array).and eq(%i[create destroy])
       expect(Organization.global_registry_entity.exclude).to be_a Symbol
       expect(org.global_registry_entity.exclude)
@@ -72,10 +72,10 @@ RSpec.describe 'GlobalRegistry::Bindings' do
       assignment = build(:assignment, person: person, organization: org)
       expect(Assignment.global_registry_relationship(:fancy_org_assignment).id_column).to be :global_registry_id
       expect(Assignment.global_registry_relationship(:fancy_org_assignment).type).to be :fancy_org_assignment
-      expect(Assignment.global_registry_relationship(:fancy_org_assignment).primary_association).to be :person
-      expect(Assignment.global_registry_relationship(:fancy_org_assignment).related_association).to be :organization
-      expect(assignment.global_registry_relationship(:fancy_org_assignment).primary_relationship_name).to be :person
-      expect(assignment.global_registry_relationship(:fancy_org_assignment).related_relationship_name).to be :fancy_org
+      expect(Assignment.global_registry_relationship(:fancy_org_assignment).primary).to be :person
+      expect(Assignment.global_registry_relationship(:fancy_org_assignment).related).to be :organization
+      expect(assignment.global_registry_relationship(:fancy_org_assignment).primary_name).to be :person
+      expect(assignment.global_registry_relationship(:fancy_org_assignment).related_name).to be :fancy_org
       expect(assignment.global_registry_relationship(:fancy_org_assignment).exclude)
         .to contain_exactly(:global_registry_id, :id, :created_at, :updated_at, :person_id, :organization_id,
                             :assigned_by_gr_rel_id, :assigned_by_id)