global-registry-bindings 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fefecc675882ff5a75b69de5c5e928b41ca696e4
-  data.tar.gz: 70c7dfd4708fbb01c3824f4ad6b29cc31c5335ff
+  metadata.gz: a1070674e56cacc49d588111ed8ce212005c1d5f
+  data.tar.gz: 917c38d3b12d156eb4d7e8b059c2f750170cb581
 SHA512:
-  metadata.gz: a80c913940d88cdf05b151c75a5fbe4bf09ad41441274c9a1672c8087b42c9ffc4fe67f46fbde9859359c10745d401b32272bfbad2f1a7103028f6362c722a07
-  data.tar.gz: 6538b6af58dc790cd1b164ddc4033360a1ca50c70488c62fe6fefdffc70fe177b0ca33f2c8b4c39be992f6c00d9f7945aaa3a19d1eafe8409c341b73f989f26f
+  metadata.gz: 8995bec861df933f950a3c0267a6087a7d3622754d1b510670c07f2d09128f902dd30b2b18d76e314ce12120bffb88d1f1404baba2a13d94bc24b8c37aac5b94
+  data.tar.gz: 9fcb1a519d88e24db01fa2a234e33fa1b9597e0d4c568071a6ecbc918b5b7429218875da4f756f432fb8ff1904e9bb64ba50570d9f8ad51c7de8169d6403b322

data/README.md

@@ -64,7 +64,7 @@ is a unique name to identify the relationship. **[`:entity`, `:relationship`]**
 (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_fields. Used to create a
+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
@@ -76,7 +76,7 @@ to `:entity`, but can be set to a `:relationship` type name (ex: `:assignment`)
 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_fields. (default: `nil`)
+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
@@ -120,17 +120,17 @@ should cache this as it may be requested multiple times. (default: `nil`) **[`:r
 (default: `:primary_association.id`) **[`:relationship`]**
 
 * `:include_all_columns`: Include all model columns in the fields to push to Global Registry. If `false`, fields must
-be defined in the `:extra_fields` option. (default: `true`)
+be defined in the `:fields` option. (default: `false`)
 **[`:entity`, `:relationship`]**
 
-* `:exclude_fields`: Array, Proc or Symbol. Array of Model fields (as symbols) to exclude when pushing to Global
+* `: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`]**
 
-* `:extra_fields`: Additional fields to send to Global Registry. Hash, Proc or Symbol. As a Hash, names are the
+* `: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.
@@ -142,7 +142,7 @@ option is nil or empty. (default: `nil`) **[`:entity`]**
 * `:mdm_timeout`: Only pull mdm information at most once every `:mdm_timeout`. (default: `1.minute`)
 **[`:entity`]**
 
-## Values for `extra_fields`
+## Values for `fields`
 
 Values sent to Global Registry are calculated by sending the field `name` to the model. They can be overidden by
 aliasing an existing method, adding a new method to the model or by overriding the `entity_attributes_to_push`
@@ -151,8 +151,8 @@ method. If a model does not respond to a name or raises a `NoMethodError`, the f
 ```ruby
 class Person < ActiveRecord::Base
   # Person has first_name, last_name and guid columns
-  global_registry_bindings extra_fields: {full_name: :string, identity: :uuid, blargh: :integer},
-                           exclude_fields: %i[guid]
+  global_registry_bindings fields: {full_name: :string, identity: :uuid, blargh: :integer},
+                           exclude: %i[guid]
   
   # Person doesn't respond to 'blargh' so it is omitted from the attributes to push
  

data/lib/global_registry_bindings/global_registry_bindings.rb

@@ -35,7 +35,7 @@ module GlobalRegistry #:nodoc:
     #   (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_fields. Used to create a
+    #   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
@@ -47,7 +47,7 @@ module GlobalRegistry #:nodoc:
     #   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_fields. (default: `nil`)
+    #   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
@@ -90,21 +90,21 @@ module GlobalRegistry #:nodoc:
     # * `:client_integration_id`: Client Integration ID for relationship. Proc or Symbol.
     #   (default: `:primary_association.id`) **[`:relationship`]**
     #
-    # * `:exclude_fields`: Array, Proc or Symbol. Array of Model fields (as symbols) to exclude when pushing to Global
+    # * `: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`]**
     #
-    # * `:extra_fields`: Additional fields to send to Global Registry. Hash, Proc or Symbol. As a Hash, names are the
+    # * `: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 `:extra_fields` option. (default: `true`) **[`:entity`, `:relationship`]**
+    #   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`]**

data/lib/global_registry_bindings/model/entity.rb

@@ -10,7 +10,7 @@ module GlobalRegistry #:nodoc:
           entity_attributes = entity_columns_to_push.map do |name, type|
             value_for_global_registry(name, type)
           end.compact.to_h
-          entity_attributes[:client_integration_id] = id unless global_registry_entity.exclude_fields
+          entity_attributes[:client_integration_id] = id unless global_registry_entity.exclude
                                                                                       .include?(:client_integration_id)
           entity_attributes[:client_updated_at] = updated_at.to_s(:db) if respond_to?(:updated_at)
           if global_registry_entity.parent_is_self?
@@ -44,10 +44,10 @@ module GlobalRegistry #:nodoc:
                                    { c.name.underscore.to_sym => normalize_entity_column_type(c.type, c.name) }
                                  end # rubocop:disable Style/MultilineBlockChain
                                    .reduce(&:merge)
-                                   .reject { |k, _v| global_registry_entity.exclude_fields.include? k }
-                                   .merge(global_registry_entity.extra_fields)
+                                   .reject { |k, _v| global_registry_entity.exclude.include? k }
+                                   .merge(global_registry_entity.fields)
                                else
-                                 global_registry_entity.extra_fields
+                                 global_registry_entity.fields
                                end
         end
 

data/lib/global_registry_bindings/model/relationship.rb

@@ -10,7 +10,7 @@ module GlobalRegistry #:nodoc:
           entity_attributes = relationship_columns_to_push(type).map do |name, t|
             relationship_value_for_global_registry(name, t)
           end.compact.to_h
-          unless global_registry_relationship(type).exclude_fields.include?(:client_integration_id)
+          unless global_registry_relationship(type).exclude.include?(:client_integration_id)
             entity_attributes[:client_integration_id] = global_registry_relationship(type).client_integration_id
           end
           entity_attributes[:client_updated_at] = updated_at.to_s(:db) if respond_to?(:updated_at)
@@ -58,10 +58,10 @@ module GlobalRegistry #:nodoc:
               { c.name.underscore.to_sym => normalize_relationship_column_type(c.type, c.name) }
             end # rubocop:disable Style/MultilineBlockChain
                 .reduce(&:merge)
-                .reject { |k, _v| global_registry_relationship(type).exclude_fields.include? k }
-                .merge(global_registry_relationship(type).extra_fields)
+                .reject { |k, _v| global_registry_relationship(type).exclude.include? k }
+                .merge(global_registry_relationship(type).fields)
           else
-            global_registry_relationship(type).extra_fields || {}
+            global_registry_relationship(type).fields || {}
           end
         end
       end

data/lib/global_registry_bindings/options/entity_class_options.rb

@@ -13,8 +13,8 @@ module GlobalRegistry #:nodoc:
                  :push_on,
                  :parent_association,
                  :parent_association_class,
-                 :exclude_fields,
-                 :extra_fields, to: :@options
+                 :exclude,
+                 :fields, to: :@options
 
         def initialize(model_class)
           @model_class = model_class

data/lib/global_registry_bindings/options/entity_instance_options.rb

@@ -62,8 +62,8 @@ module GlobalRegistry #:nodoc:
           parent_association.present? && parent_class == @model.class
         end
 
-        def exclude_fields
-          option = @class_options.exclude_fields
+        def exclude
+          option = @class_options.exclude
           case option
           when Proc
             option.call(type, @model)
@@ -74,8 +74,8 @@ module GlobalRegistry #:nodoc:
           end
         end
 
-        def extra_fields
-          option = @class_options.extra_fields
+        def fields
+          option = @class_options.fields
           case option
           when Proc
             option.call(type, @model)

data/lib/global_registry_bindings/options/entity_options_parser.rb

@@ -17,9 +17,9 @@ module GlobalRegistry #:nodoc:
             parent_association: nil,
             parent_association_class: nil,
             parent_relationship_name: nil,
-            exclude_fields: %i[id created_at updated_at],
-            extra_fields: {},
-            include_all_columns: true,
+            exclude: %i[id created_at updated_at],
+            fields: {},
+            include_all_columns: false,
             mdm_timeout: 1.minute,
             ensure_entity_type: true
           }.freeze
@@ -36,7 +36,7 @@ module GlobalRegistry #:nodoc:
 
         def merge_defaults(options_hash = {})
           @options = defaults.merge(options_hash) do |key, oldval, newval|
-            if key == :exclude_fields
+            if key == :exclude
               case newval
               when Proc, Symbol
                 newval
@@ -56,12 +56,12 @@ module GlobalRegistry #:nodoc:
         end
 
         def update_excludes
-          return unless @options[:exclude_fields].is_a? Array
-          @options[:exclude_fields] << @options[:id_column]
-          @options[:exclude_fields] << @options[:mdm_id_column] if @options[:mdm_id_column].present?
+          return unless @options[:exclude].is_a? Array
+          @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]
-          @options[:exclude_fields] << parent_id_column.to_sym if parent_id_column
+          @options[:exclude] << parent_id_column.to_sym if parent_id_column
         end
 
         def association_foreign_key(name)

data/lib/global_registry_bindings/options/relationship_class_options.rb

@@ -21,8 +21,8 @@ module GlobalRegistry #:nodoc:
                  :related_association_type,
                  :related_relationship_name,
                  :related_global_registry_id,
-                 :exclude_fields,
-                 :extra_fields, to: :@options
+                 :exclude,
+                 :fields, to: :@options
 
         def initialize(type, model_class)
           @model_class = model_class

data/lib/global_registry_bindings/options/relationship_instance_options.rb

@@ -111,8 +111,8 @@ module GlobalRegistry #:nodoc:
           @class_options.related_relationship_name || related_type
         end
 
-        def exclude_fields
-          option = @class_options.exclude_fields
+        def exclude
+          option = @class_options.exclude
           case option
           when Proc
             option.call(type, @model)
@@ -123,8 +123,8 @@ module GlobalRegistry #:nodoc:
           end
         end
 
-        def extra_fields
-          option = @class_options.extra_fields
+        def fields
+          option = @class_options.fields
           case option
           when Proc
             option.call(type, @model)

data/lib/global_registry_bindings/options/relationship_options_parser.rb

@@ -20,8 +20,8 @@ module GlobalRegistry #:nodoc:
             related_association_class: nil, related_association_type: nil,
             related_relationship_name: nil,
             related_global_registry_id: nil,
-            exclude_fields: %i[id created_at updated_at], include_all_columns: true,
-            extra_fields: {}, ensure_relationship_type: true, rename_entity_type: true
+            exclude: %i[id created_at updated_at], include_all_columns: false,
+            fields: {}, ensure_relationship_type: true, rename_entity_type: true
           }.freeze
         end
 
@@ -37,7 +37,7 @@ module GlobalRegistry #:nodoc:
 
         def merge_defaults(options_hash = {})
           @options = defaults.merge(options_hash) do |key, oldval, newval|
-            if key == :exclude_fields
+            if key == :exclude
               case newval
               when Proc, Symbol
                 newval
@@ -73,15 +73,15 @@ module GlobalRegistry #:nodoc:
         end
 
         def update_excludes
-          return unless @options[:exclude_fields].is_a? Array
-          @options[:exclude_fields] << @options[:id_column]
-          @options[:exclude_fields] << @options[:mdm_id_column] if @options[:mdm_id_column].present?
+          return unless @options[:exclude].is_a? Array
+          @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_fields] << @options[:primary_association_foreign_key]
+            @options[:exclude] << @options[:primary_association_foreign_key]
           end
           if @options[:related_association_foreign_key] # rubocop:disable Style/GuardClause
-            @options[:exclude_fields] << @options[:related_association_foreign_key]
+            @options[:exclude] << @options[:related_association_foreign_key]
           end
         end
 

data/lib/global_registry_bindings/version.rb

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

data/spec/acceptance/global_registry_bindings_spec.rb

@@ -18,9 +18,9 @@ RSpec.describe 'GlobalRegistry::Bindings' do
         .to contain_exactly(:create, :update, :destroy)
       expect(Default.global_registry_entity.mdm_timeout).to eq 1.minute
       expect(Default.global_registry_entity.type).to be :default
-      expect(Default.global_registry_entity.exclude_fields)
+      expect(Default.global_registry_entity.exclude)
         .to contain_exactly(:global_registry_id, :id, :created_at, :updated_at)
-      expect(Default.global_registry_entity.extra_fields).to be_a(Hash).and be_empty
+      expect(Default.global_registry_entity.fields).to be_a(Hash).and be_empty
     end
 
     it 'should parse and set mdm options' do
@@ -28,11 +28,11 @@ RSpec.describe 'GlobalRegistry::Bindings' do
       expect(Namespaced::Person.global_registry_entity.mdm_id_column).to be :global_registry_mdm_id
       expect(Namespaced::Person.global_registry_entity.mdm_timeout).to eq 24.hours
       expect(Namespaced::Person.global_registry_entity.type).to be :person
-      expect(Namespaced::Person.global_registry_entity.exclude_fields)
+      expect(Namespaced::Person.global_registry_entity.exclude)
         .to contain_exactly(:country_of_residence_gr_id, :country_of_residence_id, :country_of_service_gr_id,
                             :country_of_service_id, :created_at, :global_registry_id, :global_registry_mdm_id,
                             :guid, :id, :updated_at)
-      expect(Namespaced::Person.global_registry_entity.extra_fields).to be_a(Hash).and be_empty
+      expect(Namespaced::Person.global_registry_entity.fields).to be_a(Hash).and be_empty
       expect(GlobalRegistry::Bindings::Workers::PullNamespacedPersonMdmIdWorker.get_sidekiq_options)
         .to include('unique' => :until_timeout, 'unique_expiration' => 24.hours)
     end
@@ -43,11 +43,11 @@ RSpec.describe 'GlobalRegistry::Bindings' do
       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.exclude_fields).to be_a Proc
-      expect(address.global_registry_entity.exclude_fields)
+      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)
-      expect(Address.global_registry_entity.extra_fields).to be_a Symbol
-      expect(address.global_registry_entity.extra_fields)
+      expect(Address.global_registry_entity.fields).to be_a Symbol
+      expect(address.global_registry_entity.fields)
         .to include(line1: :string, postal_code: :string)
     end
 
@@ -59,11 +59,11 @@ RSpec.describe 'GlobalRegistry::Bindings' do
       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.push_on).to be_an(Array).and eq(%i[create destroy])
-      expect(Organization.global_registry_entity.exclude_fields).to be_a Symbol
-      expect(org.global_registry_entity.exclude_fields)
+      expect(Organization.global_registry_entity.exclude).to be_a Symbol
+      expect(org.global_registry_entity.exclude)
         .to contain_exactly(:gr_id, :id, :created_at, :updated_at, :parent_id, :area_id, :global_registry_area_id)
-      expect(Organization.global_registry_entity.extra_fields).to be_a Proc
-      expect(org.global_registry_entity.extra_fields).to be_a(Hash).and be_empty
+      expect(Organization.global_registry_entity.fields).to be_a Proc
+      expect(org.global_registry_entity.fields).to be_a(Hash).and be_empty
     end
 
     it 'should parse and set relationship fields' do
@@ -76,10 +76,10 @@ RSpec.describe 'GlobalRegistry::Bindings' do
       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).exclude_fields)
+      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)
-      expect(assignment.global_registry_relationship(:fancy_org_assignment).extra_fields)
+      expect(assignment.global_registry_relationship(:fancy_org_assignment).fields)
         .to be_a(Hash)
     end
   end

data/spec/internal/app/models/address.rb

@@ -4,8 +4,9 @@ class Address < ApplicationRecord
   EXCLUDE_GR_FIELDS = %i[id created_at updated_at global_registry_id person_id address1].freeze
   belongs_to :person, class_name: 'Namespaced::Person', inverse_of: :addresses
   global_registry_bindings parent_association: :person,
-                           exclude_fields: proc { |_type, _model| EXCLUDE_GR_FIELDS },
-                           extra_fields: :global_registry_extra_fields
+                           exclude: proc { |_type, _model| EXCLUDE_GR_FIELDS },
+                           fields: :global_registry_extra_fields,
+                           include_all_columns: true
 
   alias_attribute :line1, :address1
   alias_attribute :postal_code, :zip

data/spec/internal/app/models/area.rb

@@ -3,6 +3,5 @@
 class Area < ApplicationRecord
   has_many :organizations
 
-  global_registry_bindings include_all_columns: false,
-                           extra_fields: { area_name: :string, area_code: :string, is_active: :boolean }
+  global_registry_bindings fields: { area_name: :string, area_code: :string, is_active: :boolean }
 end

data/spec/internal/app/models/assignment.rb

@@ -9,12 +9,12 @@ class Assignment < ApplicationRecord
                            type: :fancy_org_assignment,
                            primary_association: :person,
                            related_association: :organization,
-                           exclude_fields: %i[assigned_by_id assigned_by_gr_rel_id]
+                           include_all_columns: true,
+                           exclude: %i[assigned_by_id assigned_by_gr_rel_id]
 
   global_registry_bindings binding: :relationship,
                            type: :assigned_by,
                            id_column: :assigned_by_gr_rel_id,
-                           include_all_columns: false,
                            primary_binding: :fancy_org_assignment,
                            primary_relationship_name: :assigned_by,
                            related_association: :assigned_by

data/spec/internal/app/models/community.rb

@@ -2,7 +2,8 @@
 
 class Community < ApplicationRecord
   global_registry_bindings ensure_entity_type: false,
-                           exclude_fields: %i[infobase_id infobase_gr_id]
+                           include_all_columns: true,
+                           exclude: %i[infobase_id infobase_gr_id]
 
   global_registry_bindings binding: :relationship,
                            type: :infobase_ministry,
@@ -10,8 +11,7 @@ class Community < ApplicationRecord
                            related_relationship_name: :ministry,
                            related_association_type: :ministry,
                            related_association_foreign_key: :infobase_id,
-                           related_global_registry_id: :pull_infobase_global_registry_id,
-                           include_all_columns: false
+                           related_global_registry_id: :pull_infobase_global_registry_id
 
   def pull_infobase_global_registry_id(_type)
     '41f767fd-86f4-42e2-8d24-cbc3f697b794'