Merge pull request #3 from site-prism/feature/add_basic_collection_pr…

…operties

feature/collection props

.rspec

@@ -1,3 +1,4 @@
 --format documentation
 --color
+--order random
 --require spec_helper

CHANGELOG.md

@@ -1,12 +1,15 @@
 ## [Unreleased]
+### Added
+- Validator `#type_valid?` for checking the initial type of a model
+- `.caching` option for generating the iVar and reader on the class
 
 ## [0.2.0] - 2023-12-20
-
+### Changed
 - Attempt to clean up all code
 
 ## [0.1.0] - 2023-12-19
-
-- Gem created release
+### Added
+- Initial gem creation
 
 [Unreleased]: https://github.com/site-prism/testingrecord/compare/v0.2...HEAD
 [0.2.0]:      https://github.com/site-prism/testingrecord/compare/0.1...v0.2

lib/testing_record/dsl.rb

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

lib/testing_record/dsl/validation.rb

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

lib/testing_record/dsl/validation/input.rb

@@ -6,6 +6,9 @@ module Validation
       # [TestingRecord::DSL::Validation::Input]
       # Validations for direct inputs into creating models
       module Input
+        # Check whether the type is valid
+        #
+        # @return [Boolean]
         def type_valid?(input)
           type_validations.include?(input)
         end

lib/testing_record/model.rb

@@ -1,16 +1,56 @@
 # frozen_string_literal: true
 
+require 'automation_helpers/extensions/string'
+
 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
     class << self
+      # Create a cache of the entities, named according to the classname
+      #
+      # @return [Symbol]
+      def caching(option)
+        return unless option == :enabled
+
+        instance_variable_set(ivar_name, [])
+        define_singleton_method(cache_name) { instance_variable_get(ivar_name) }
+      end
+
+      def create(attributes = {})
+        new(attributes).tap do |entity|
+          add_to_cache(entity) if respond_to?(cache_name)
+        end
+      end
+
       # Set the type of model, this should be one of `:singular` or `:plural`
       #
       # @return [Symbol]
       def type(type)
         @type = type
       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

spec/spec_helper.rb

@@ -3,13 +3,5 @@
 require 'testing_record'
 
 RSpec.configure do |config|
-  # Enable flags like --only-failures and --next-failure
   config.example_status_persistence_file_path = '.rspec_status'
-
-  # Disable RSpec exposing methods globally on `Module` and `main`
-  config.disable_monkey_patching!
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
 end

spec/testing_record/model_spec.rb

@@ -1,27 +1,71 @@
 # frozen_string_literal: true
 
 RSpec.describe TestingRecord::Model do
-  context 'when classified as a singular model' do
-    let(:model) do
-      Class.new(TestingRecord::Model) do
-        type :singular
+  describe '.type' do
+    context 'when classified as a singular model' do
+      let(:model) do
+        Class.new(TestingRecord::Model) do
+          type :singular
+        end
+      end
+
+      it 'sets the singular model properties' do
+        expect(model.instance_variable_get(:@type)).to eq(:singular)
       end
     end
 
-    it 'sets the singular model properties' do
-      expect(model.instance_variable_get(:@type)).to eq(:singular)
+    context 'when classified as a plural model' do
+      let(:model) do
+        Class.new(TestingRecord::Model) do
+          type :plural
+        end
+      end
+
+      it 'sets the plural model properties' do
+        expect(model.instance_variable_get(:@type)).to eq(:plural)
+      end
     end
   end
 
-  context 'when classified as a plural model' do
-    let(:model) do
-      Class.new(TestingRecord::Model) do
-        type :plural
+  describe '.caching' do
+    before do
+      stub_const('Foo', Class.new(described_class))
+      Foo.caching :enabled
+    end
+
+    it 'generates a new reader class method for accessing the raw data' do
+      expect(Foo).to respond_to(:foos)
+    end
+
+    it 'automatically creates the cache as an empty array' do
+      expect(Foo.foos).to eq([])
+    end
+  end
+
+  describe '.create' do
+    context 'with caching enabled' do
+      before do
+        stub_const('Foo', Class.new(described_class))
+        Foo.caching :enabled
+      end
+
+      it 'generates a new instance of the model entity' do
+        expect(Foo.create({})).to be_a Foo
+      end
+
+      it 'will add the entity to the cache' do
+        expect { Foo.create({}) }.to change(Foo.foos, :length).by(1)
       end
     end
 
-    it 'sets the singular model properties' do
-      expect(model.instance_variable_get(:@type)).to eq(:plural)
+    context 'without caching enabled' do
+      before do
+        stub_const('Foo', Class.new(described_class))
+      end
+
+      it 'generates a new instance of the model entity' do
+        expect(Foo.create({})).to be_a Foo
+      end
     end
   end
 end

testingrecord.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.files = Dir.glob('lib/**/*') + %w[LICENSE.md README.md]
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'automation_helpers', '~> 5.0'
+
   spec.add_development_dependency 'rspec', '~> 3.12'
   spec.add_development_dependency 'rubocop', '~> 1.59.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.20.0'