testingrecord 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f6570d13d91ba9f4785d7ea4c2be9c742710339406337c0c70c2095c727aa97
-  data.tar.gz: 9e94862ed788d679feb98ad62a83c7aac84d3062931f2121bc6997f10ee86bd1
+  metadata.gz: 38eafdf3beadae05ae9138e4701d4644b3299dfa34e17ecb952d3f1cc7d2d3e0
+  data.tar.gz: beb36e06363dfaa6823f48f7b89b20502974d0d7c3f77a975991ab8e32104678
 SHA512:
-  metadata.gz: f7f46a7072f63f08f67502bc6fb4076a7eec22d2bd3942670f871ef2df267e019a8bbc0edefc28d97792ce3cb6b504c3326b81026efda330ef508dfb96856f12
-  data.tar.gz: e4c3fad3c5b588fd8a4db23bd27b106c509d7314bd34d008d4aef379cadc8c68fdc317d124862282dd9194969dc31cdacdec7968c786db1c724675055ca1a3be
+  metadata.gz: 1e2f489178b2aa12ab5a40756495d19f78d8e5d3d40deaa5c743e0e8288f278d90325a2db6f05fdfef40753360869543717cbedd00756eb0d472bd1ba142db3e
+  data.tar.gz: da06002f629a270cafba057303a3957e118b3f87f223731e1f8d9180191293abc979553da1ae4ca21570e81a0be823f905e8c11f87ac3c84ea79f20bb77b5a3e

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

@@ -0,0 +1,42 @@
+# 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
+
+        private
+
+        # Finds all entities that match specified attribute values
+        #
+        # @return [Array<TestingRecord::Model>]
+        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}")
+            pool = pool.select { |entity| entity.attributes[key] == value }
+          end
+          pool
+        end
+      end
+    end
+  end
+end

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

@@ -11,7 +11,7 @@ module TestingRecord
         # @return [Array]
         def add_helpers
           attributes.each do |attribute|
-            add_presence_helper(attribute[:name], attribute[:type])
+            add_presence_helper(attribute)
           end
         end
 
@@ -22,9 +22,10 @@ module TestingRecord
         #   For plural attributes whether the array has any values
         #
         # @return [TestingRecord::Model]
-        def add_presence_helper(name, type)
+        def add_presence_helper(name)
           define_method(:"#{name}?") do
-            type == :plural ? send(:name).any? : send(:name).empty?
+            obj = send(name)
+            !(obj.nil? || obj.empty?)
           end
         end
       end

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

@@ -10,55 +10,49 @@ 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
-
-        # Sets an attribute on the model, this should have a name and an optional type (Defaults to `:singular`)
+        # Sets an attribute on the model
         #
-        # @return [Array<Hash>]
-        def attribute(name, type: :singular)
-          raise Error, 'Invalid type option, must be :singular or :plural if specified' unless type_valid?(type)
-
+        # @return [Array<Symbol>]
+        def attribute(name)
           attr_reader name
 
-          attributes << { name:, type: }
+          attributes << name
         end
 
         def attributes
           @attributes ||= []
         end
 
-        # Set the type of model, this should be one of `:singular` or `:plural`
+        # Create a cache of the entities, named according to the classname
         #
         # @return [Symbol]
-        def type(option)
-          raise Error, 'Invalid type option, must be :singular or :plural' unless type_valid?(option)
+        def caching(option)
+          raise Error, 'Invalid caching option, must be :enabled or :disabled' unless caching_valid?(option)
+          return unless option == :enabled
+
+          instance_variable_set(:@all, [])
+          define_singleton_method(:all) { instance_variable_get(:@all) }
+        end
 
-          @type = option
+        # 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)
+          define_singleton_method(:__primary_key) { instance_variable_get(:@__primary_key) }
         end
 
         private
 
         def add_to_cache(entity)
           self.current = entity
-          send(cache_name) << entity
+          all << entity
           # TODO: Add log message (Requires adding logger)
         end
 
-        def cache_name
-          :"#{to_s.snake_case}s"
-        end
-
-        def ivar_name
-          "@#{to_s.snake_case}s"
+        def update_cache(entity)
+          # TODO: This needs implementing properly
         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/dsl/validation/input.rb

@@ -13,17 +13,9 @@ module TestingRecord
           enabled_or_disabled.include?(input)
         end
 
-        # Check whether the type setting is valid
-        #
-        # @return [Boolean]
-        def type_valid?(input)
-          singular_or_plural.include?(input)
-        end
-
         private
 
         def enabled_or_disabled = %i[enabled disabled]
-        def singular_or_plural = %i[singular plural]
       end
     end
   end

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
 
@@ -17,17 +18,16 @@ module TestingRecord
 
       # Creates an instance of the model
       #   -> Adding it to the cache if caching is enabled
-      #   -> Creating iVar values for each property that was set
-      #     -> For now these will be set to `''` or `[]`
+      #   -> Creating iVar values for each attribute that was provided
       #
       # @return [TestingRecord::Model]
       def create(attributes = self.attributes)
         new(attributes).tap do |entity|
-          attributes.each do |attribute|
-            default_value = attribute[:type] == :singular ? '' : []
-            entity.instance_variable_set("@#{attribute[:name]}", default_value)
+          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?(cache_name)
+          add_to_cache(entity) if respond_to?(:all)
         end
       end
     end
@@ -35,5 +35,22 @@ module TestingRecord
     def initialize(attributes = {})
       @attributes = attributes
     end
+
+    def inspect
+      "#<#{self.class.name} #{attributes.map { |k, v| "@#{k}=#{v.inspect}" }.join(', ')}>"
+    end
+
+    def to_s
+      inspect
+    end
+
+    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)
+      end
+    end
   end
 end

data/lib/testing_record/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestingRecord
-  VERSION = '0.4'
+  VERSION = '0.5'
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testingrecord
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Luke Hill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-12-16 00:00:00.000000000 Z
+date: 2025-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: automation_helpers
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.81.0
+        version: 1.82.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.81.0
+        version: 1.82.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -72,16 +86,17 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.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.8.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 +108,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