testingrecord 0.8 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63ee9271871c1194e05e12d7f4d5d23bc744f703461b8519d45300f180f5432c
-  data.tar.gz: 251d286e38df1ed55a6e25f40c615ca7ccc1673c50758ab0bec861eabc354da7
+  metadata.gz: 228079a525e184348661a215f33fcae6daf628c54592793343f41525b15ea717
+  data.tar.gz: f95a3e63f583936668b4ccebe7eae1186605f47e53895fd2e72e1019955b05e1
 SHA512:
-  metadata.gz: 45cc639fbc3e7d7ca82c4d08ad4a867f7ff550a78738de717ca07ae7b3fa5e6bf7b9991f07bc745690eab33db0e2a39a58cb8f1fb61f259567280651941630bb
-  data.tar.gz: 68975a0f8c4efbe1ed14aab9e47f0809c6f58377c5f587aa20c5192847869ff15becb145356d06a1a8fd78c1a3257e43ee85184806f91a40ed71eda331ba978c
+  metadata.gz: b8c1e5f2a892e41ee591422a9febeca1e52c8a6043f3010b564496f072bb0cb5183f67d16f5afcc58d16655f8a179f00271ccf168124d7c3d0bddec3471a0823
+  data.tar.gz: 2d1ffd7be42bed6f2a483d5adb46cf1cfec4c465f0b62ff805ca0a1a0280248e7984c1a3220609d13c686c307fcf020c466c2ce087164451c8eede24a471d006

data/lib/testing_record/dsl/builder/filters.rb

@@ -36,6 +36,21 @@ module TestingRecord
           find_by({ id: })&.first&.tap { |entity| entity.class.current = entity }
         end
 
+        # Checks to see whether an entity exists with the provided primary_key
+        #
+        # @return [Boolean]
+        def with_primary_key?(primary_key)
+          !with_primary_key(primary_key).nil?
+        end
+
+        # Finds an entity with the provided primary_key
+        #   If one is found, set it as the current entity
+        #
+        # @return [TestingRecord::Model, nil]
+        def with_primary_key(primary_key)
+          find_by({ __primary_key => primary_key })&.first&.tap { |entity| entity.class.current = entity }
+        end
+
         private
 
         # Finds all entities that match specified attribute values

data/lib/testing_record/dsl/builder/settings.rb

@@ -10,13 +10,21 @@ module TestingRecord
       module Settings
         include DSL::Validation::Input
 
-        attr_reader :__primary_key
+        def __primary_key
+          if instance_variable_defined?(:@__primary_key)
+            @__primary_key
+          elsif superclass.respond_to?(:__primary_key)
+            superclass.__primary_key
+          else
+            TestingRecord.default_primary_key
+          end
+        end
 
         # Create a cache of the entities, named according to the classname
         #
         # @return [Symbol]
         def caching(option)
-          raise Error, 'Invalid caching option, must be :enabled or :disabled' unless caching_valid?(option)
+          raise Error::InvalidConfigurationError, 'Invalid caching option, must be :enabled or :disabled' unless caching_valid?(option)
           return unless option == :enabled
 
           instance_variable_set(:@all, [])
@@ -28,7 +36,9 @@ module TestingRecord
         #
         # @return [Symbol]
         def primary_key(option)
-          instance_variable_set(:@__primary_key, option.to_sym)
+          raise Error::InvalidConfigurationError, 'Invalid primary key value, must be a Symbol' unless option.is_a?(Symbol)
+
+          instance_variable_set(:@__primary_key, option)
         end
       end
     end

data/lib/testing_record/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module TestingRecord
+  module Error
+    class AttributeError < StandardError; end
+    class EntityError < StandardError; end
+    class InvalidConfigurationError < StandardError; end
+  end
+end

data/lib/testing_record/model.rb

@@ -17,19 +17,25 @@ module TestingRecord
       attr_reader :current
 
       # Creates an instance of the model
-      #   -> Creating iVar values for each attribute that was provided
-      #   -> Adding it to the cache if caching is enabled
-      #   -> Keeping a track of all originally supplied attributes in symbolized format in the `attributes` iVar
+      #   -> Ensures that the primary key is specified in the attribute payload
+      #   -> Validates that a duplicate entity has not been made (If caching is enabled)
+      #   -> Creates iVar values (Symbol format) and attr_reader's for each attribute that was provided
+      #   -> Adds helper methods (If the model has been configured to include helpers)
+      #   -> Adds it to the cache (If caching is enabled)
       #
       # @return [TestingRecord::Model]
       def create(attributes)
-        new(attributes.transform_keys(&:to_sym)).tap do |entity|
-          configure_data(entity, attributes)
-          add_helpers(attributes) if entity.class.instance_variable_get(:@include_helpers)
-          cache_entity(entity)
+        attributes.transform_keys!(&:to_sym)
+        if respond_to?(:all)
+          create_with_caching(attributes)
+        else
+          create_without_caching(attributes)
         end
       end
 
+      # Sets the current entity instance to the one supplied (Or removes it if supplied `nil`)
+      #
+      # @return [TestingRecord::Model, nil]
       def current=(entity)
         if entity
           TestingRecord.logger.info("Switching current user from #{@current} to #{entity}")
@@ -41,23 +47,42 @@ module TestingRecord
 
       # Deletes the instance of the model from the cache (Does nothing if caching is disabled)
       #
-      # @return [TestingRecord::Model]
+      # @return [TestingRecord::Model, nil]
       def delete(entity)
-        all.delete(entity) if respond_to?(:all)
+        return unless respond_to?(:all)
+
+        self.current = nil if entity == current
+        all.delete(entity)
       end
 
       # Deletes the instance of the model from the cache (Does nothing if caching is disabled)
       #
-      # @return [TestingRecord::Model]
+      # @return [TestingRecord::Model, nil]
       def delete_by_id(id)
         delete(with_id(id)) if respond_to?(:all)
       end
 
       private
 
-      def cache_entity(entity)
-        return unless respond_to?(:all)
+      def create_with_caching(attributes)
+        ensure_primary_key_presence(attributes)
+        ensure_deduplication(attributes)
+        new(attributes).tap do |entity|
+          configure_data(entity, attributes)
+          add_helpers(attributes) if entity.class.instance_variable_get(:@include_helpers)
+          cache_entity(entity)
+        end
+      end
+
+      def create_without_caching(attributes)
+        ensure_primary_key_presence(attributes)
+        new(attributes).tap do |entity|
+          configure_data(entity, attributes)
+          add_helpers(attributes) if entity.class.instance_variable_get(:@include_helpers)
+        end
+      end
 
+      def cache_entity(entity)
         self.current = entity
         all << entity
         TestingRecord.logger.debug("Entity: #{entity} added to cache")
@@ -69,6 +94,20 @@ module TestingRecord
           entity.class.attr_reader attribute_key
         end
       end
+
+      def ensure_deduplication(attributes)
+        pk_value = attributes[__primary_key]
+        return unless with_primary_key?(pk_value)
+
+        TestingRecord.logger.error("#{name} entity already exists with primary key: #{pk_value}")
+        raise Error::EntityError, "#{name} entity already exists with primary key: #{pk_value}"
+      end
+
+      def ensure_primary_key_presence(attributes)
+        return if attributes.key?(__primary_key)
+
+        raise Error::AttributeError, "#{name} entity has not been supplied with the primary key: #{__primary_key}"
+      end
     end
 
     def initialize(attributes = {})
@@ -107,7 +146,6 @@ module TestingRecord
     private
 
     def reorder_attributes_for_inspect!
-      return unless self.class.__primary_key
       return if attributes.keys.first == self.class.__primary_key
 
       pk_value = attributes.delete(self.class.__primary_key)

data/lib/testing_record/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestingRecord
-  VERSION = '0.8'
+  VERSION = '1.0.1'
 end

data/lib/testing_record.rb

@@ -1,16 +1,31 @@
 # frozen_string_literal: true
 
 require_relative 'testing_record/dsl'
+require_relative 'testing_record/error'
 require_relative 'testing_record/logger'
 require_relative 'testing_record/model'
 require_relative 'testing_record/version'
 
 # {TestingRecord} namespace
 module TestingRecord
-  # Generic TestingRecord error. Will be extended in the future
-  class Error < StandardError; end
-
   class << self
+    attr_reader :default_primary_key
+
+    def configure
+      yield self
+    end
+
+    # Configure a default primary key for all TestingRecord models
+    def default_primary_key=(value)
+      raise InvalidConfigurationError, 'Invalid primary key value, must be a Symbol' unless value.is_a?(Symbol)
+
+      @default_primary_key = value
+      TestingRecord::Model.primary_key value
+    end
+
+    # Specify the default primary key to `:id` (This is procedural so will be overwritten at runtime if config defined)
+    TestingRecord.default_primary_key = :id
+
     # The Testing Record logger object - This is called automatically in several
     # locations and will log messages according to the normal Ruby protocol
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testingrecord
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: 1.0.1
 platform: ruby
 authors:
 - Luke Hill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-03-10 00:00:00.000000000 Z
+date: 2026-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: automation_helpers
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.85.1
+        version: 1.86.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.85.1
+        version: 1.86.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +119,7 @@ files:
 - lib/testing_record/dsl/builder/settings.rb
 - lib/testing_record/dsl/validation.rb
 - lib/testing_record/dsl/validation/input.rb
+- lib/testing_record/error.rb
 - lib/testing_record/logger.rb
 - lib/testing_record/model.rb
 - lib/testing_record/version.rb