testingrecord 0.4.1 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cdf9a8f41b762bd4fd516fadce6f8e5afb21f5953398db4f5108ddc73e2a83a
-  data.tar.gz: c90170893784153947669a66fb7e5c806adaeb11345c1fea23aef9b310a90260
+  metadata.gz: 544af1645ff65521c916a5ab879ad49711e9ef0aa18e58360ebc175672fc22bc
+  data.tar.gz: 139ed45cbfdc8f24cd77a88538a46962457b7c3c78e94142e501633d8ce603a9
 SHA512:
-  metadata.gz: 67c56dc0c57152a7d042cd0b138b9c73dabe6daf0b453cd90c2ec3d84f0f091ae54838d2c09afea15c5221092e423d44d94ff085e71094caf0463b48dd0b994f
-  data.tar.gz: 6ae0747a2cda0681b61e66a78f918c20a7ed320c1745150078747e66cbcb4beaccf8e8f6a18f932cfb5019cd09a6ea4e7437134e63f6f2887db9981f33e7c05b
+  metadata.gz: f0f8a9a6b9a1ec1d238038ee9bd3fcae8441d4488e1328fb8bf1693015ff309613a8ffdfb70c0bf12dc2189f1aaa9f5c83ea1cc7231bdf5e2dc63641cb865d94
+  data.tar.gz: cf54b5e657d77a034e631a4b1c5bb35cd21fe88f7281c26b317f0f832b26b8dedee3b5b1015fd5f453afb33a5479736c6722fba3d703fd36dbd77c98406618b9

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module TestingRecord
+  module DSL
+    module Builder
+      # [TestingRecord::DSL::Builder::Filters]
+      # Ways in which we can filter our collection to find specific models
+      module Filters
+        # Checks to see whether an entity exists with the provided attributes
+        #
+        # @return [Boolean]
+        def exists?(attributes)
+          find_by(attributes).any?
+        end
+
+        # Finds an entity with the provided email address
+        #   If one is found, set it as the current entity
+        #
+        # @return [TestingRecord::Model, nil]
+        def with_email(email_address)
+          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
+        #
+        # @return [Array<TestingRecord::Model>]
+        def find_by(attributes)
+          pool = all
+          attributes.each do |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
+        end
+      end
+    end
+  end
+end

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

@@ -10,16 +10,7 @@ module TestingRecord
       module Settings
         include DSL::Validation::Input
 
-        # 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)
-          return unless option == :enabled
-
-          instance_variable_set(ivar_name, [])
-          define_singleton_method(cache_name) { instance_variable_get(ivar_name) }
-        end
+        attr_reader :__primary_key
 
         # Sets an attribute on the model
         #
@@ -34,20 +25,23 @@ module TestingRecord
           @attributes ||= []
         end
 
-        private
-
-        def add_to_cache(entity)
-          self.current = entity
-          send(cache_name) << entity
-          # TODO: Add log message (Requires adding logger)
-        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)
+          return unless option == :enabled
 
-        def cache_name
-          :"#{to_s.snake_case}s"
+          instance_variable_set(:@all, [])
+          define_singleton_method(:all) { instance_variable_get(:@all) }
         end
 
-        def ivar_name
-          "@#{to_s.snake_case}s"
+        # Sets the primary key value of all entities - used for deduplication
+        # TODO: Use this for deduplication proper
+        #
+        # @return [Symbol]
+        def primary_key(option)
+          instance_variable_set(:@__primary_key, option.to_sym)
         end
       end
     end

data/lib/testing_record/dsl/builder.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
+require_relative 'builder/filters'
 require_relative 'builder/helpers'
 require_relative 'builder/settings'

data/lib/testing_record/logger.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module TestingRecord
+  #
+  # @api private
+  #
+  class Logger
+    #
+    # Generate the Logger used in the gem
+    #
+    def self.create(output = $stdout)
+      logger = ::Logger.new(output)
+      logger.progname = 'Testing Record'
+      logger.level = :DEBUG
+      logger.formatter = proc do |severity, time, progname, msg|
+        "#{time.strftime('%F %T')} - #{severity} - #{progname} - #{msg}\n"
+      end
+
+      logger
+    end
+  end
+end

data/lib/testing_record/model.rb

@@ -7,6 +7,7 @@ module TestingRecord
   # The top level Model. Most of the behaviours specified here are fairly rudimentary ones that will then
   # include other behaviour(s), from the included modules
   class Model
+    extend DSL::Builder::Filters
     extend DSL::Builder::Helpers
     extend DSL::Builder::Settings
 
@@ -16,23 +17,74 @@ 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)
         new(attributes).tap do |entity|
           attributes.each do |attribute_key, attribute_value|
             entity.instance_variable_set("@#{attribute_key}", attribute_value)
-            attr_reader attribute_key
+            entity.class.attr_reader attribute_key
           end
-          add_to_cache(entity) if respond_to?(cache_name)
+
+          break entity unless respond_to?(:all)
+
+          self.current = entity
+          all << entity
+          TestingRecord.logger.debug("Entity: #{entity} added to cache")
         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
     end
 
     def initialize(attributes = {})
       @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|
+        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.4.1'
+  VERSION = '0.6'
 end

data/lib/testing_record.rb

@@ -1,10 +1,36 @@
 # frozen_string_literal: true
 
 require_relative 'testing_record/dsl'
+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
-  # Your code goes here...
+
+  class << self
+    # The Testing Record logger object - This is called automatically in several
+    # locations and will log messages according to the normal Ruby protocol
+    #
+    # This logger object can also be used to manually log messages
+    #
+    # To Manually log a message
+    #   TestingRecord.logger.info('Information')
+    #   TestingRecord.logger.debug('Input debug message')
+    #
+    # By default the logger will output all messages to $stdout, but can be
+    # altered to log to a file or another IO location by calling `.log_path=`
+    def logger
+      @logger ||= Logger.create
+    end
+
+    # This writer method allows you to configure where you want the testingrecord logs to be sent to (Default is $stdout)
+    #
+    #   Example: TestingRecord.log_path = 'testingrecord.log' would save all log messages to `./testingrecord.log`
+    def log_path=(logdev)
+      logger.reopen(logdev)
+    end
+  end
 end

metadata

@@ -1,29 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: testingrecord
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: '0.6'
 platform: ruby
 authors:
 - Luke Hill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-12-22 00:00:00.000000000 Z
+date: 2026-02-09 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: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.81.0
+        version: 1.84.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.81.0
+        version: 1.84.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -72,16 +92,17 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.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.
+        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.
 email:
 - lukehill_uk@hotmail.com
 executables: []
@@ -93,10 +114,12 @@ files:
 - lib/testing_record.rb
 - lib/testing_record/dsl.rb
 - lib/testing_record/dsl/builder.rb
+- lib/testing_record/dsl/builder/filters.rb
 - lib/testing_record/dsl/builder/helpers.rb
 - lib/testing_record/dsl/builder/settings.rb
 - lib/testing_record/dsl/validation.rb
 - lib/testing_record/dsl/validation/input.rb
+- lib/testing_record/logger.rb
 - lib/testing_record/model.rb
 - lib/testing_record/version.rb
 homepage: https://github.com/site-prism/testingrecord