testingrecord 0.7 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 163d454cbedadbfb903dcfd141aafe10554fb9aa6b8ef2ff8c5c44abe6d1a7b3
-  data.tar.gz: bb4fcd7db84017b1032cbf1a362cdddc9fae583b7b71146c6b4019ed7b372288
+  metadata.gz: fd979c6e6979b672916851b0be5603d6a4dabbc43855b596c5272fbd93dfdadc
+  data.tar.gz: 9ff521bdd86bff0ed97c43f055b5add594296376dca665005271a320e44518d3
 SHA512:
-  metadata.gz: 1cb9024a7d5dd9cda0f15841e955ae45e4caa508d90c13433be6e70fc12aa75b7ec54cd9f9e1bb04b050e4f7e23408558106a18e67cd64403a20da57184e4057
-  data.tar.gz: 0d479648df51da1455edfa5b2b5c4a749cefc6f68e572fd3e9384a8d21b7e097a5a5e3d4a5ae2a049b8338815b07c4a389defbbdb9e0b710bdfbd3fe64c30fa7
+  metadata.gz: f922ea85183b6c28646ac42a9325d509d85c12bf3d447056defd626b01760b16b0d049749bc02ccc50be4fa7036e59be5973f16a7649400d1fd978398df04d0b
+  data.tar.gz: 87ceaea89ae230ecf0d760cfda87bf5de91953ea6584fd364986dc770b90369725680b8a63404d147262bbaccc8a9fd252941a6803ebef1efe024fcef1248b12

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

@@ -14,33 +14,74 @@ module TestingRecord
     attr_reader :attributes
 
     class << self
-      attr_accessor :current
+      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
+      #   -> 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).tap do |entity|
-          configure_data(entity, attributes)
-          add_helpers(attributes) if entity.class.instance_variable_get(:@include_helpers)
-          cache_entity(entity)
+        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}")
+        else
+          TestingRecord.logger.info("Purging current user: #{@current}")
+        end
+        @current = 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(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, 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.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)
+        end
+      end
+
+      def create_without_caching(attributes)
+        ensure_primary_key_presence(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)
+        end
+      end
 
+      def cache_entity(entity)
         self.current = entity
         all << entity
         TestingRecord.logger.debug("Entity: #{entity} added to cache")
@@ -52,6 +93,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 = {})
@@ -74,15 +129,15 @@ module TestingRecord
     end
 
     # Updates an entity (instance), of a model
-    #   -> Updating iVar values for each attribute that was provided
+    #   -> Updating iVar values for each attribute that was provided (Converting to symbolized format)
     #   -> It will **not** create new reader methods for new variables added
     #
     # @return [TestingRecord::Model]
     def update(attrs)
-      attrs.each do |key, value|
+      attrs.transform_keys(&:to_sym).each do |key, value|
         attributes[key] = value
         instance_variable_set("@#{key}", value)
-        TestingRecord.logger.info("Updated '#{key}' on current #{self.class} entity to be '#{value}'")
+        TestingRecord.logger.info("Updated '#{key}' on the #{self.class} entity to be '#{value}'")
       end
       self
     end
@@ -90,7 +145,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.7'
+  VERSION = '1.0'
 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.7'
+  version: '1.0'
 platform: ruby
 authors:
 - Luke Hill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-03-03 00:00:00.000000000 Z
+date: 2026-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: automation_helpers
@@ -19,7 +19,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -64,28 +64,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.85.0
+        version: 1.86.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.85.0
+        version: 1.86.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.0
+        version: 1.26.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.0
+        version: 1.26.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   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