testingrecord 0.5 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38eafdf3beadae05ae9138e4701d4644b3299dfa34e17ecb952d3f1cc7d2d3e0
-  data.tar.gz: beb36e06363dfaa6823f48f7b89b20502974d0d7c3f77a975991ab8e32104678
+  metadata.gz: 163d454cbedadbfb903dcfd141aafe10554fb9aa6b8ef2ff8c5c44abe6d1a7b3
+  data.tar.gz: bb4fcd7db84017b1032cbf1a362cdddc9fae583b7b71146c6b4019ed7b372288
 SHA512:
-  metadata.gz: 1e2f489178b2aa12ab5a40756495d19f78d8e5d3d40deaa5c743e0e8288f278d90325a2db6f05fdfef40753360869543717cbedd00756eb0d472bd1ba142db3e
-  data.tar.gz: da06002f629a270cafba057303a3957e118b3f87f223731e1f8d9180191293abc979553da1ae4ca21570e81a0be823f905e8c11f87ac3c84ea79f20bb77b5a3e
+  metadata.gz: 1cb9024a7d5dd9cda0f15841e955ae45e4caa508d90c13433be6e70fc12aa75b7ec54cd9f9e1bb04b050e4f7e23408558106a18e67cd64403a20da57184e4057
+  data.tar.gz: 0d479648df51da1455edfa5b2b5c4a749cefc6f68e572fd3e9384a8d21b7e097a5a5e3d4a5ae2a049b8338815b07c4a389defbbdb9e0b710bdfbd3fe64c30fa7

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

@@ -21,6 +21,21 @@ module TestingRecord
           find_by({ email_address: })&.first&.tap { |entity| entity.class.current = entity }
         end
 
+        # Checks to see whether an entity exists with the provided id
+        #
+        # @return [Boolean]
+        def with_id?(id)
+          !with_id(id).nil?
+        end
+
+        # Finds an entity with the provided id
+        #   If one is found, set it as the current entity
+        #
+        # @return [TestingRecord::Model, nil]
+        def with_id(id)
+          find_by({ id: })&.first&.tap { |entity| entity.class.current = entity }
+        end
+
         private
 
         # Finds all entities that match specified attribute values
@@ -29,9 +44,8 @@ module TestingRecord
         def find_by(attributes)
           pool = all
           attributes.each do |key, value|
-            # TODO: Enable this logging once v0.5 is released with logger support
-            # AutomationLogger.debug("Current user pool size: #{pool.length}")
-            # AutomationLogger.debug("Filtering User list by #{key}: #{value}")
+            TestingRecord.logger.debug("Current user pool size: #{pool.length}")
+            TestingRecord.logger.debug("Filtering User list by #{key}: #{value}")
             pool = pool.select { |entity| entity.attributes[key] == value }
           end
           pool

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

@@ -6,17 +6,20 @@ module TestingRecord
       # [TestingRecord::DSL::Builder::Helpers]
       # Ways in which we can build in extra helper methods from building requests
       module Helpers
-        # Method to add all helpers - Should be called last in the DSL invocations in the class definition
-        #
-        # @return [Array]
-        def add_helpers
-          attributes.each do |attribute|
-            add_presence_helper(attribute)
-          end
+        # DSL signature to add all helpers - Should be procedurally called in the class definition
+        def include_helpers
+          @include_helpers = true
         end
 
         private
 
+        # Top level wrapper method that will incrementally add each helper (Currently only one)
+        def add_helpers(attributes)
+          attributes.each_key do |attribute|
+            add_presence_helper(attribute)
+          end
+        end
+
         # Add the boolean helper which will perform a check to determine whether...
         #   For singular / default categorisations, this checks if one has been set over the default empty value
         #   For plural attributes whether the array has any values

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

@@ -10,18 +10,7 @@ module TestingRecord
       module Settings
         include DSL::Validation::Input
 
-        # Sets an attribute on the model
-        #
-        # @return [Array<Symbol>]
-        def attribute(name)
-          attr_reader name
-
-          attributes << name
-        end
-
-        def attributes
-          @attributes ||= []
-        end
+        attr_reader :__primary_key
 
         # Create a cache of the entities, named according to the classname
         #
@@ -40,19 +29,6 @@ module TestingRecord
         # @return [Symbol]
         def primary_key(option)
           instance_variable_set(:@__primary_key, option.to_sym)
-          define_singleton_method(:__primary_key) { instance_variable_get(:@__primary_key) }
-        end
-
-        private
-
-        def add_to_cache(entity)
-          self.current = entity
-          all << entity
-          # TODO: Add log message (Requires adding logger)
-        end
-
-        def update_cache(entity)
-          # TODO: This needs implementing properly
         end
       end
     end

data/lib/testing_record/model.rb

@@ -17,17 +17,39 @@ module TestingRecord
       attr_accessor :current
 
       # Creates an instance of the model
-      #   -> Adding it to the cache if caching is enabled
       #   -> Creating iVar values for each attribute that was provided
+      #   -> Adding it to the cache if caching is enabled
       #
       # @return [TestingRecord::Model]
-      def create(attributes = self.attributes)
+      def create(attributes)
         new(attributes).tap do |entity|
-          attributes.each do |attribute_key, attribute_value|
-            entity.instance_variable_set("@#{attribute_key}", attribute_value)
-            attr_reader attribute_key
-          end
-          add_to_cache(entity) if respond_to?(:all)
+          configure_data(entity, attributes)
+          add_helpers(attributes) if entity.class.instance_variable_get(:@include_helpers)
+          cache_entity(entity)
+        end
+      end
+
+      # Deletes the instance of the model from the cache (Does nothing if caching is disabled)
+      #
+      # @return [TestingRecord::Model]
+      def delete(entity)
+        all.delete(entity) if respond_to?(:all)
+      end
+
+      private
+
+      def cache_entity(entity)
+        return unless respond_to?(:all)
+
+        self.current = entity
+        all << entity
+        TestingRecord.logger.debug("Entity: #{entity} added to cache")
+      end
+
+      def configure_data(entity, attributes)
+        attributes.each do |attribute_key, attribute_value|
+          entity.instance_variable_set("@#{attribute_key}", attribute_value)
+          entity.class.attr_reader attribute_key
         end
       end
     end
@@ -36,21 +58,43 @@ module TestingRecord
       @attributes = attributes
     end
 
+    # View the entity in question in a readable format. Displays all iVars and their values (Primary Key first if set)
+    #
+    # @return [String]
     def inspect
+      reorder_attributes_for_inspect!
       "#<#{self.class.name} #{attributes.map { |k, v| "@#{k}=#{v.inspect}" }.join(', ')}>"
     end
 
+    # Functionally equivalent to `inspect`
+    #
+    # @return [String]
     def to_s
       inspect
     end
 
+    # Updates an entity (instance), of a model
+    #   -> Updating iVar values for each attribute that was provided
+    #   -> It will **not** create new reader methods for new variables added
+    #
+    # @return [TestingRecord::Model]
     def update(attrs)
       attrs.each do |key, value|
-        # TODO: Once logger is implemented this needs modifying to output a log message
-        # AutomationLogger.debug("Updating '#{key}' on current User to be '#{value}'")
         attributes[key] = value
         instance_variable_set("@#{key}", value)
+        TestingRecord.logger.info("Updated '#{key}' on current #{self.class} entity to be '#{value}'")
       end
+      self
+    end
+
+    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)
+      @attributes = { self.class.__primary_key => pk_value }.merge(attributes)
     end
   end
 end

data/lib/testing_record/version.rb

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

data/lib/testing_record.rb

@@ -32,5 +32,23 @@ module TestingRecord
     def log_path=(logdev)
       logger.reopen(logdev)
     end
+
+    # To enable full logging (This uses the Ruby API, so can accept any of a
+    # Symbol / String / Integer as an input
+    #   TestingRecord.log_level = :DEBUG
+    #   TestingRecord.log_level = 'DEBUG'
+    #   TestingRecord.log_level = 0
+    #
+    # To disable all logging
+    #   TestingRecord.log_level = :UNKNOWN
+    def log_level=(value)
+      logger.level = value
+    end
+
+    # To query what level is being logged
+    #   TestingRecord.log_level # => :DEBUG # By default
+    def log_level
+      %i[DEBUG INFO WARN ERROR FATAL UNKNOWN][logger.level]
+    end
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: testingrecord
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.7'
 platform: ruby
 authors:
 - Luke Hill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-12-30 00:00:00.000000000 Z
+date: 2026-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: automation_helpers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.82.0
+        version: 1.85.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.82.0
+        version: 1.85.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
 description: |-
   Use metaprogrammed cache-models to store data you create on-the-fly. Access and retrieve references to data \
                         created from any place inside your tests.