testingrecord 0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a976787fabb7a7f44edd0023cccee5c2885aab6ae6712762682984564b61a241
+  data.tar.gz: 1844f8b3fccd0ef7346826ab10cddd346d79e35f7832e6f406ee7103c89d8422
+SHA512:
+  metadata.gz: a7a5bea3abcdebf53465684ad24cfa5c101a64a921486873bc68675854a42994d6f80b102c91b753747444e57713479827ec2b11231a6ae9108a973806938aef
+  data.tar.gz: 0b7919a99e0bbd4a7f6e37e4530259fc6a83b51935edae3ff83e2f1f6c6133d6ef4308e81abc7837e5b91c5dc7b88873123dcc8779518ce0ffe62b49fc28ed8c

data/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, SitePrism
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,42 @@
+# testingrecord
+
+TestingRecord - a lightweight drop-in metaprogramming framework that allows you to keep track of what
+you've created on websites
+
+- [History](#history)
+- [Usage](#usage)
+- [Development](#development)
+- [Enabling gem methods](#enabling-gem-methods)
+
+## History
+
+This in a new gem I've made to facilitate testing on websites where you want to track all data being created
+
+This gem was made to try solve the problem where I had been caching models each time at new jobs,
+hopefully some of the stuff here will be useful
+
+The gem is currently version unstable
+
+## Usage
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add testingrecord
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install testingrecord
+
+## Development
+
+After checking out the repo, run `bundle exec rspec` to run the tests
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/site-prism/testingrecord
+
+## Enabling gem methods
+
+The gem methods TODO.....
+
+## Usage
+
+TODO...

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module TestingRecord
+  module DSL
+    module Builder
+      # [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 [TestingRecord::Model]
+        def add_helpers
+          properties.each do |hash|
+            if hash[:type] == :singular
+              add_any_helper(hash[:name])
+            else
+              add_any_helper("#{hash[:name]}s")
+            end
+          end
+        end
+
+        # Add the boolean helper which will perform the `#any?` check on your instance
+        #
+        # @return [TestingRecord::Model]
+        def add_any_helper(name)
+          define_method(:"#{name}?") do
+            instance_variable_get(:"@#{name}").any?
+          end
+        end
+
+        # Check whether the type setting is valid
+        #
+        # @return [Boolean]
+        def type_valid?(input)
+          type_validations.include?(input)
+        end
+
+        private
+
+        def caching_validations = %i[enabled disabled]
+        def type_validations = %i[singular plural]
+      end
+    end
+  end
+end

data/lib/testing_record/dsl/builder.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'builder/helpers'

data/lib/testing_record/dsl/validation/input.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module TestingRecord
+  module DSL
+    module Validation
+      # [TestingRecord::DSL::Validation::Input]
+      # Validations for direct inputs into creating models
+      module Input
+        # Check whether the caching setting is valid
+        #
+        # @return [Boolean]
+        def caching_valid?(input)
+          caching_validations.include?(input)
+        end
+
+        # Check whether the type setting is valid
+        #
+        # @return [Boolean]
+        def type_valid?(input)
+          type_validations.include?(input)
+        end
+
+        private
+
+        def caching_validations = %i[enabled disabled]
+        def type_validations = %i[singular plural]
+      end
+    end
+  end
+end

data/lib/testing_record/dsl/validation.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'validation/input'

data/lib/testing_record/dsl.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'dsl/builder'
+require_relative 'dsl/validation'

data/lib/testing_record/model.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'automation_helpers/extensions/string'
+require_relative 'dsl'
+
+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::Validation::Input
+    extend DSL::Builder::Helpers
+
+    class << self
+      # 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
+
+      # Creates an instance of the model, adding it to the cache if caching is enabled
+      #
+      # @return [TestingRecord::Model]
+      def create(attributes = {})
+        new(attributes).tap do |entity|
+          add_to_cache(entity) if respond_to?(cache_name)
+        end
+      end
+
+      # Sets a property on the model, this should have a name and an optional type (Defaults to `:singular`)
+      #
+      # @return [Array<Hash>]
+      def property(name, type: :singular)
+        raise Error, 'Invalid type option, must be :singular or :plural' unless type_valid?(type)
+
+        if type == :plural
+          attr_reader :"#{name}s"
+        else
+          attr_reader name
+        end
+
+        properties << { name:, type: }
+      end
+
+      def properties
+        @properties ||= []
+      end
+
+      # Set the type of model, this should be one of `:singular` or `:plural`
+      #
+      # @return [Symbol]
+      def type(option)
+        raise Error, 'Invalid type option, must be :singular or :plural' unless type_valid?(option)
+
+        @type = option
+      end
+
+      private
+
+      def add_to_cache(entity)
+        # TODO: Cache entity as the current entity for model class
+        send(cache_name) << 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"
+      end
+    end
+
+    attr_reader :attributes
+
+    def initialize(attributes = {})
+      @attributes = attributes
+    end
+  end
+end

data/lib/testing_record/version.rb

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

data/lib/testing_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'testing_record/dsl'
+require_relative 'testing_record/model'
+require_relative 'testing_record/version'
+
+module TestingRecord
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: testingrecord
+version: !ruby/object:Gem::Version
+  version: '0.3'
+platform: ruby
+authors:
+- Luke Hill
+bindir: bin
+cert_chain: []
+date: 2025-09-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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.59.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.59.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.25.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.25.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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/testing_record.rb
+- lib/testing_record/dsl.rb
+- lib/testing_record/dsl/builder.rb
+- lib/testing_record/dsl/builder/helpers.rb
+- lib/testing_record/dsl/validation.rb
+- lib/testing_record/dsl/validation/input.rb
+- lib/testing_record/model.rb
+- lib/testing_record/version.rb
+homepage: https://github.com/site-prism/testingrecord
+licenses: []
+metadata:
+  bug_tracker_uri: https://github.com/site-prism/testingrecord/issues
+  changelog_uri: https://github.com/site-prism/testingrecord/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/site-prism/testingrecord
+  source_code_uri: https://github.com/site-prism/testingrecord
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Thread based caching system to store and edit records
+test_files: []