nueca_rails_interfaces 0.2.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31ae17c6c4a1bc6e73e1e0cf9804c160d3cf5faf685b49c594c47c4be6a6e168
-  data.tar.gz: 1fd912144144b1c8a5ee9431dd58f5c416216da361adf8f20d80646597d6f4cf
+  metadata.gz: 375e0a33491c00461a59c058bc16531aa7297fb5974420baecc7d5bdf095984e
+  data.tar.gz: 70fdf20fd30f3ac098c871bcb41470f5705e6b4a616d753ee6c362f7d8271589
 SHA512:
-  metadata.gz: 2a3fb6374aebdfe04125d0a37b2dbdbc7397bebbe9ca9801bec2991c5355f5b2ee2b649cb24a676ffecf4f4eb7155cb343a0f3047a5836ba1bc837b6b56e4d84
-  data.tar.gz: f1a29e95b7fee07b6a7bef84e34791c0e7f7177eb2ea0336f359dc34b24c893084c4c030cb226632051f3dbff9c72fcea0b704a076eca00e87777d75f9902933
+  metadata.gz: 8bf069562ba00aaeba977893057fbfad0e6c5e5f4ef8ed1d4208e343e90174824eead398f7ba7ae952597a5c5ce0c8c7a705bc6a087a60eded76d1715d372508
+  data.tar.gz: 756f5471261a09504b020119056f884f89a264ea29ae6c38d4402eb24876b1eed8751e1b561d67998ae8814d4ba86110060703eb830b47de6f92b7f094b822d8

data/.rubocop.yml

@@ -1,6 +1,8 @@
-require:
+plugins:
   - rubocop-rails
   - rubocop-rake
+
+require:
   - rubocop-rspec
 
 AllCops:

data/README.md

@@ -14,6 +14,14 @@ gem 'nueca_rails_interfaces'
 
 Simply include the interfaces in classes and they will be enforced.
 
+```ruby
+class MyForm
+  include NuecaRailsInterfaces::V2::FormInterface
+
+  # ...
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/nueca_rails_interfaces/util.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+NRI = NuecaRailsInterfaces
+
 module NuecaRailsInterfaces
   # Utility module helper.
   module Util

data/lib/nueca_rails_interfaces/v1/data_source/base_interface.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module NuecaRailsInterfaces
+  module V1
+    module DataSource
+      # Error class for when the data source class is not found. Only use this for the context of data sources.
+      class NotFound < StandardError; end
+
+      # The data source base. Extend this module to create a data source base.
+      # It is used to invoke the data source so that it automatically searches for data source nodes
+      # based on the type of the record.
+      module BaseInterface
+        # Creates a new data source instance for the given record.
+        # It will return the data source node class instance instead of itself.
+        # Do not override.
+        def new(record)
+          record = modify_record(record)
+          data_source = data_source_class(record).new(record)
+          modify_data_source(data_source)
+        end
+
+        private
+
+        # Hook for easily altering the record for processing. Override this instead of new.
+        # Make sure this returns the record.
+        def modify_record(record)
+          record
+        end
+
+        # Hook for easily altering the detected data source for processing. Override this instead of new.
+        # Make sure this returns an object that includes DataSource::Node.
+        def modify_data_source(data_source)
+          data_source
+        end
+
+        # Method responsible for finding the data source node for the given record. Do not override.
+        # It raises a DataSouce::NotFound error if the node is not found.
+        def data_source_class(record)
+          resolver_logic(record)
+        rescue NameError
+          raise NotFound, 'Data Source node not found. Please check the namespace and class ' \
+                          "name for #{record.class.name}#{" in #{namespace}" if namespace.present?}."
+        end
+
+        # Contains the logic on how to resolve the constants toward the data source node classes.
+        # Override this instead of data_source_class.
+        def resolver_logic(record)
+          "#{namespace}::#{record.class.name}Ds".constantize
+        end
+
+        # Returns the namespace of the data source base automatically.
+        # Override if needed when there is a different file stucture and different namespace.
+        def namespace
+          name.split('::')[0...-1].join('::')
+        end
+      end
+    end
+  end
+end

data/lib/nueca_rails_interfaces/v1/data_source/node_interface.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module NuecaRailsInterfaces
+  module V1
+    module DataSource
+      # Data source node. They are used as actual sources of data for records,
+      # may it be in terms of presentation or multiple sources of basis for data.
+      # Include this module to create a data source node.
+      module NodeInterface
+        class << self
+          # Automatically delegate missing methods to the record.
+          def included(subclass)
+            subclass.delegate_missing_to(:record)
+          end
+        end
+
+        attr_reader :record
+
+        # The record itself!
+        def initialize(record)
+          @record = record
+        end
+      end
+    end
+  end
+end

data/lib/nueca_rails_interfaces/v1/form_interface.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module NuecaRailsInterfaces
+  module V1
+    # Form Interface. Include this module to create a new form.
+    # In this version, a form is defined as a data verifier, mainly coming from parameters
+    # to shoulder off validation from processors such as services and interactors, or action controllers.
+    # A form should be treated like a custom model without the need for a database.
+    # Forms are responsible for validating data and returning the data in a format that is ready for processing.
+    # Forms are responsible for handling bad data, returning errors provided by ActiveModel.
+    # Forms should implement the `attributes` method to define the attributes of the form.
+    # Forms should not override methods from ActiveModel for customization.
+    # The `attributes` method should return a hash of the attributes of the form (strictly not an array).
+    # It is up to the developer what `attributes` method will contain if there is an error. Treat as such like an API.
+    module FormInterface
+      # Allows the form mixin to include ActiveModel::Model powers.
+      # @param [self] base Instance of the base form that would include this module.
+      # @return [void]
+      def self.included(_base)
+        raise NuecaRailsInterfaces::DeprecatedError
+
+        # base.include(ActiveModel::Model)
+        # Rails.logger&.warn(
+        #   <<~MSG
+        #     ##############################################
+        #     #            DEPRECATION WARNING             #
+        #     # V1::FormInterface will be deprecated soon. #
+        #     #    Please use V2::FormInterface instead.   #
+        #     ##############################################
+        #   MSG
+        # )
+      end
+
+      # Final attributes to be returned by the form after validation.
+      # This is the data that is expected of the form to produce for processing.
+      # @raise [NotImplementedError] If the method is not overridden.
+      def attributes
+        raise NotImplementedError, 'Requires implementation of attributes.'
+      end
+    end
+  end
+end

data/lib/nueca_rails_interfaces/v1/query_interface.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module NuecaRailsInterfaces
+  module V1
+    # Query Mixin Interface. Include this module to a class that will be used as a query object.
+    # Query objects are eaily identified as helpers for querying with filters and sorting with complex algorithms.
+    # Thanks to ActiveRecord's inner workings, Ruby alone can handle the avdanced filtering
+    # before firing the query in the database. In this version, all query objects will be paginated.
+    # This is to avoid really heavy queries from hitting the database, either be it intentnional or malicious.
+    # In this version, pagination is enforced but only lightly encouraged.
+    # There will be a deprecation warning when no_pagination is used.
+    # However, the implementation of no_pagination is still a 1 page result;
+    # just that it supports a large number of queries in a single page.
+    # Developers will be required to move away from V1 of Query Interface soon to enforce strict pagination.
+    module QueryInterface
+      # The basis for validity of pagination settings. It also contains default values.
+      VALID_PAGINATION_HASH = {
+        max: 20, # Absolute maximum number of records per page, even if the query requests for more.
+        min: 1, # Absolute minimum number of records per page, even if the query requests for less.
+        per_page: 20, # Default number of records per page if not specified in the query.
+        page: 1 # Default page number if not specified in the query.
+      }.freeze
+
+      # Basis for considering a non-paging result even when the query is being processed for pagination.
+      # This number states the invalidity of pagination, but it exists for legacy support.
+      NO_PAGING_THRESHOLD = 1_000_000
+
+      class << self
+        def included(base)
+          # This is the method to call outside this object to apply the query filters, sortings and paginations.
+          # @param [Hash] query The query parameters.
+          # @param [ActiveRecord::Relation] collection The collection to be queried.
+          base.define_singleton_method(:call) do |query, collection|
+            new(query, collection).call
+          end
+        end
+      end
+
+      attr_reader :query, :collection
+
+      # Do not override! This is how we will always initialize our query objects.
+      # No processing should be done in the initialize method.
+      # @param [Hash] query The query parameters.
+      # @param [ActiveRecord::Relation] collection The collection to be queried.
+      def initialize(query, collection, pagination: true)
+        @query = query
+        @collection = collection
+        @pagination_flag = pagination
+        query_aliases
+      end
+
+      # Do not override. This is the method to call outside this object
+      # to apply the query filters, sortings and paginations.
+      def call
+        apply_filters!
+        apply_sorting!
+        apply_pagination!
+        collection
+      end
+
+      private
+
+      # Place here filters. Be sure to assign @collection to override the original collection. Be sure it is private!
+      def filters; end
+
+      # Place here sorting logic. Be sure to assign @collection to override the original collection.
+      # Be sure it is private!
+      def sorts; end
+
+      # Pagination settings to modify the default behavior of a query object.
+      # Default values are in VALID_PAGINATION_HASH constant.
+      # Override the method to change the default values.
+      def pagination_settings
+        {}
+      end
+
+      # Always updated alias of filters.
+      def apply_filters!
+        filters
+      end
+
+      # Always updated alias of sorts.
+      def apply_sorting!
+        sorts
+      end
+
+      # Paginates the collection based on query or settings.
+      def apply_pagination!
+        raise 'Invalid pagination settings.' unless correct_pagination_settings?
+        return unless @pagination_flag
+
+        @collection = collection.paginate(page: fetch_page_value, per_page: fetch_per_page_value)
+      end
+
+      # Logic for fetching the page value from the query or settings.
+      def fetch_page_value
+        query&.key?(:page) ? query[:page].to_i : merged_pagination_settings[:page]
+      end
+
+      # Logic for fetching the per page value from the query or settings.
+      def fetch_per_page_value
+        per_page = query&.key?(:per_page) ? query[:per_page].to_i : merged_pagination_settings[:per_page]
+        per_page.clamp(merged_pagination_settings[:min], merged_pagination_settings[:max])
+      end
+
+      # Checks if the pagination settings are correct.
+      # The app crashes on misconfiguration.
+      def correct_pagination_settings?
+        return false unless pagination_settings.is_a?(Hash)
+
+        detected_keys = []
+        merged_pagination_settings.each_key do |key|
+          return false unless VALID_PAGINATION_HASH.key?(key)
+
+          detected_keys << key
+        end
+
+        detected_keys.sort == VALID_PAGINATION_HASH.keys.sort
+      end
+
+      # The final result of pagination settings, and thus the used one.
+      def merged_pagination_settings
+        @merged_pagination_settings ||= VALID_PAGINATION_HASH.merge(pagination_settings)
+      end
+
+      # Aliases for query parameters for legacy support.
+      # No need to override this in children. Directly modify this method in this interface if need be.
+      def query_aliases
+        query[:per_page] = query[:limit] if query[:limit].present? && query[:per_page].blank?
+      end
+
+      # For deprecation. Use this for queries that do not need pagination.
+      # Queries will still be paginated as a result, but with the use of the threshold,
+      # the result is as good as a non-paginated result,
+      # and it will be treated as such.
+      def no_pagination
+        Rails.logger.warn 'Querying without paging is deprecated. Enforce paging in queries!'
+        { max: NO_PAGING_THRESHOLD, min: NO_PAGING_THRESHOLD }
+      end
+    end
+  end
+end

data/lib/nueca_rails_interfaces/v1/service_interface.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module NuecaRailsInterfaces
+  module V1
+    # Service Mixin Interface. Include from this module when creating a new service.
+    # In this version, a service is defined as an absolute reusable piece of code.
+    # They should not be related to views and presentation of data; they are instead processors.
+    # Because of this, errors encountered should be raised as exceptions naturally.
+    # Errors here are treated as bad data. Services are not responsible for handling bad data.
+    # Services assume all data passed is correct and valid. Services should no longer validate these data.
+    # Services can still store warnings; these warnings are sent to Sentry, although not yet implemented.
+    # All services will have a `perform` method that will call the `action` method. This is the invoker of the service.
+    # All services will have an `action` method that will contain the main logic of the service.
+    # All services will have a `data` method that will contain the resulting data that the service produced.
+    # Developers will mainly override `action` method and `data method`.
+    module ServiceInterface
+      def self.included(_)
+        raise NuecaRailsInterfaces::DeprecatedError
+
+        # Rails.logger&.warn(
+        #   <<~MSG
+        #     #################################################
+        #     #              DEPRECATION WARNING              #
+        #     # V1::ServiceInterface will be deprecated soon. #
+        #     #   Please use V2::ServiceInterface instead.    #
+        #     #################################################
+        #   MSG
+        # )
+      end
+
+      # This is the main method of the service. This is the method that should be called to perform the service.
+      # Do not override this method. Instead, override the `action` method.
+      # @return [self] Instance of the service.
+      def perform
+        unless performed?
+          action
+          @performed = true
+          process_warnings
+        end
+
+        self
+      end
+
+      # Override this method and put the main logic of the service here.
+      # @raise [NotImplementedError] If the method is not overridden.
+      def action
+        raise NotImplementedError, 'Requires implementation of action.'
+      end
+
+      # Override this method and put the resulting data of the service here.
+      # If blank, then return an empty hash manually.
+      # Reason being is for readability's sake in the services.
+      # @raise [NotImplementedError] If the method is not overridden.
+      def data
+        raise NotImplementedError, 'Requires implementation of data.'
+      end
+
+      # Method used to add a warning. Do not override.
+      # @param [String] warning_message Descriptive sentence of the warning.
+      # @return [Array<String>] Array of all warnings.
+      def add_warning(warning_message)
+        _warnings << warning_message
+        warnings
+      end
+
+      # Checks if the service has been performed. Do not override.
+      # @return [Boolean] True or False
+      def performed?
+        performed
+      end
+
+      # Used to check if the service has encountered any warnings. Do not override.
+      # @return [Boolean] True or False
+      def warnings?
+        _warnings.any?
+      end
+
+      # This should contain all the warnings that the service has encountered.
+      # Intentionally made to be frozen to avoid free modification.
+      # Do not override this method.
+      # @return [Array<String>] Array of all warnings.
+      def warnings
+        _warnings.dup.freeze
+      end
+
+      private
+
+      # Status of the service. If the service has been performed, this should be true.
+      # Do not override this method.
+      # @return [Boolean] True or False
+      def performed
+        @performed ||= false
+      end
+
+      # The real warnings array. Do not override this method. Use `add_warning` method to add warnings.
+      # @return [Array<String>] Array of all warnings.
+      def _warnings
+        @warnings ||= []
+      end
+
+      # Iterates through the warnings and sends them to Sentry, supposedly. Unimplemented so far.
+      # Do not override the method.
+      # @return [void]
+      def process_warnings; end
+    end
+  end
+end

data/lib/nueca_rails_interfaces/v2/form_interface.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module NuecaRailsInterfaces
+  module V2
+    # V2 Form Interface is the same as V1 Form Interface,
+    # except forces an exception on the attributes method when intializing a form.
+    module FormInterface
+      class << self
+        # Allows the form mixin to include ActiveModel::Model powers.
+        def included(base)
+          base.include(ActiveModel::Model)
+
+          # Initializes the form in a class context with the options passed in.
+          base.define_singleton_method(:check) do |*arguments|
+            instance = NuecaRailsInterfaces::Util.process_class_arguments(self, *arguments)
+            instance.valid?
+            instance
+          end
+        end
+      end
+
+      # Initializes the form with the options passed in.
+      # It also calls the attributes method to ensure it is implemented.
+      def initialize(options = {})
+        super(**options)
+        attributes
+      end
+
+      # Final attributes to be returned by the form after validation.
+      # This is the data that is expected of the form to produce for processing.
+      # @raise [NotImplementedError] If the method is not overridden.
+      def attributes
+        raise NotImplementedError, 'Requires implementation of attributes.'
+      end
+    end
+  end
+end

data/lib/nueca_rails_interfaces/v2/service_interface.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module NuecaRailsInterfaces
+  module V2
+    # V2 Service Interface is the same as V1 Service Interface, except it is more straightforward.
+    # When performing the service, it will immediately return the data
+    module ServiceInterface
+      class << self
+        def included(base)
+          # This is the main method of the service in a class context.
+          # This is the method that should be called to perform the service statically.
+          # Use this instead if the service instance is not needed.
+          # Do not override this method. Instead, override the `action` method. Returns the data immediately.
+          # @return [Object] Data of the service.
+          base.define_singleton_method(:perform) do |*arguments|
+            instance = NuecaRailsInterfaces::Util.process_class_arguments(self, *arguments)
+            instance.perform
+          end
+        end
+      end
+
+      # This is the main method of the service. This is the method that should be called to perform the service.
+      # Do not override this method. Instead, override the `action` method. Returns the data immediately.
+      # @return [Object] Data of the service.
+      def perform
+        unless performed?
+          action
+          @performed = true
+          process_warnings
+        end
+
+        data
+      end
+
+      # Override this method and put the main logic of the service here.
+      # @raise [NotImplementedError] If the method is not overridden.
+      # @return [void]
+      def action
+        raise NotImplementedError, 'Requires implementation of action.'
+      end
+
+      # Override this method and put the resulting data of the service here.
+      # If blank, then return an empty hash manually.
+      # Reason being is for readability's sake in the services.
+      # @raise [NotImplementedError] If the method is not overridden.
+      # @return [Object] Data of the service.
+      def data
+        raise NotImplementedError, 'Requires implementation of data.'
+      end
+
+      # Method used to add a warning. Do not override.
+      # @param [String] warning_message Descriptive sentence of the warning.
+      # @return [Array<String>] Array of all warnings.
+      def add_warning(warning_message)
+        _warnings << warning_message
+        warnings
+      end
+
+      # Checks if the service has been performed. Do not override.
+      # @return [Boolean] True or False
+      def performed?
+        performed
+      end
+
+      # Used to check if the service has encountered any warnings. Do not override.
+      # @return [Boolean] True or False
+      def warnings?
+        _warnings.any?
+      end
+
+      # This should contain all the warnings that the service has encountered.
+      # Intentionally made to be frozen to avoid free modification.
+      # Do not override this method.
+      # @return [Array<String>] Array of all warnings.
+      def warnings
+        _warnings.dup.freeze
+      end
+
+      private
+
+      # Status of the service. If the service has been performed, this should be true.
+      # Do not override this method.
+      # @return [Boolean] True or False
+      def performed
+        @performed ||= false
+      end
+
+      # The real warnings array. Do not override this method. Use `add_warning` method to add warnings.
+      # @return [Array<String>] Array of all warnings.
+      def _warnings
+        @warnings ||= []
+      end
+
+      # Iterates through the warnings and sends them to Sentry, supposedly. Unimplemented so far.
+      # Do not override the method.
+      # @return [void]
+      def process_warnings; end
+    end
+  end
+end

data/lib/nueca_rails_interfaces/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NuecaRailsInterfaces
-  VERSION = '0.2.6'
+  VERSION = '1.0.0'
 end

data/lib/nueca_rails_interfaces.rb

@@ -8,9 +8,15 @@ require_relative 'nueca_rails_interfaces/version'
 
 # This module is a namespace for the gem.
 module NuecaRailsInterfaces
+  # Class that forces an error due to being deprecated.
+  class DeprecatedError < StandardError
+    def initialize
+      super('This feature is deprecated.')
+    end
+  end
 end
 
 require_relative 'nueca_rails_interfaces/util'
 
 # Require all interfaces.
-Dir["#{__dir__}/v*/**/*_interface.rb"].each { |file| require_relative file }
+Dir["#{__dir__}/nueca_rails_interfaces/v*/**/*_interface.rb"].each { |file| require_relative file }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: nueca_rails_interfaces
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Tien
 bindir: exe
 cert_chain: []
-date: 2025-03-03 00:00:00.000000000 Z
+date: 2025-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,14 +58,14 @@ files:
 - Rakefile
 - lib/nueca_rails_interfaces.rb
 - lib/nueca_rails_interfaces/util.rb
+- lib/nueca_rails_interfaces/v1/data_source/base_interface.rb
+- lib/nueca_rails_interfaces/v1/data_source/node_interface.rb
+- lib/nueca_rails_interfaces/v1/form_interface.rb
+- lib/nueca_rails_interfaces/v1/query_interface.rb
+- lib/nueca_rails_interfaces/v1/service_interface.rb
+- lib/nueca_rails_interfaces/v2/form_interface.rb
+- lib/nueca_rails_interfaces/v2/service_interface.rb
 - lib/nueca_rails_interfaces/version.rb
-- lib/v1/data_source/base_interface.rb
-- lib/v1/data_source/node_interface.rb
-- lib/v1/form_interface.rb
-- lib/v1/query_interface.rb
-- lib/v1/service_interface.rb
-- lib/v2/form_interface.rb
-- lib/v2/service_interface.rb
 - nueca_rails_interfaces.gemspec
 homepage: https://github.com/tieeeeen1994/nueca-rails-interfaces
 licenses:
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Interfaces for known object entities in Rails Development at Nueca.
 test_files: []

data/lib/v1/data_source/base_interface.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module V1
-  module DataSource
-    # Error class for when the data source class is not found. Only use this for the context of data sources.
-    class NotFound < StandardError; end
-
-    # The data source base. Extend this module to create a data source base.
-    # It is used to invoke the data source so that it automatically searches for data source nodes
-    # based on the type of the record.
-    module BaseInterface
-      # Creates a new data source instance for the given record.
-      # It will return the data source node class instance instead of itself.
-      # Do not override.
-      def new(record)
-        record = modify_record(record)
-        data_source = data_source_class(record).new(record)
-        modify_data_source(data_source)
-      end
-
-      private
-
-      # Hook for easily altering the record for processing. Override this instead of new.
-      # Make sure this returns the record.
-      def modify_record(record)
-        record
-      end
-
-      # Hook for easily altering the detected data source for processing. Override this instead of new.
-      # Make sure this returns an object that includes DataSource::Node.
-      def modify_data_source(data_source)
-        data_source
-      end
-
-      # Method responsible for finding the data source node for the given record. Do not override.
-      # It raises a DataSouce::NotFound error if the node is not found.
-      def data_source_class(record)
-        resolver_logic(record)
-      rescue NameError
-        raise NotFound, 'Data Source node not found. Please check the namespace and class ' \
-                        "name for #{record.class.name}#{" in #{namespace}" if namespace.present?}."
-      end
-
-      # Contains the logic on how to resolve the constants toward the data source node classes.
-      # Override this instead of data_source_class.
-      def resolver_logic(record)
-        "#{namespace}::#{record.class.name}Ds".constantize
-      end
-
-      # Returns the namespace of the data source base automatically.
-      # Override if needed when there is a different file stucture and different namespace.
-      def namespace
-        name.split('::')[0...-1].join('::')
-      end
-    end
-  end
-end

data/lib/v1/data_source/node_interface.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module V1
-  module DataSource
-    # Data source node. They are used as actual sources of data for records,
-    # may it be in terms of presentation or multiple sources of basis for data.
-    # Include this module to create a data source node.
-    module NodeInterface
-      class << self
-        # Automatically delegate missing methods to the record.
-        def included(subclass)
-          subclass.delegate_missing_to(:record)
-        end
-      end
-
-      attr_reader :record
-
-      # The record itself!
-      def initialize(record)
-        @record = record
-      end
-    end
-  end
-end

data/lib/v1/form_interface.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module V1
-  # Form Interface. Include this module to create a new form.
-  # In this version, a form is defined as a data verifier, mainly coming from parameters
-  # to shoulder off validation from processors such as services and interactors, or action controllers.
-  # A form should be treated like a custom model without the need for a database.
-  # Forms are responsible for validating data and returning the data in a format that is ready for processing.
-  # Forms are responsible for handling bad data, returning errors provided by ActiveModel.
-  # Forms should implement the `attributes` method to define the attributes of the form.
-  # Forms should not override methods from ActiveModel for customization.
-  # The `attributes` method should return a hash of the attributes of the form (strictly not an array).
-  # It is up to the developer what `attributes` method will contain if there is an error. Treat as such like an API.
-  module FormInterface
-    # Allows the form mixin to include ActiveModel::Model powers.
-    # @param [self] base Instance of the base form that would include this module.
-    # @return [void]
-    def self.included(base)
-      base.include(ActiveModel::Model)
-      Rails.logger&.warn(
-        <<~MSG
-          ##############################################
-          #            DEPRECATION WARNING             #
-          # V1::FormInterface will be deprecated soon. #
-          #    Please use V2::FormInterface instead.   #
-          ##############################################
-        MSG
-      )
-    end
-
-    # Final attributes to be returned by the form after validation.
-    # This is the data that is expected of the form to produce for processing.
-    # @raise [NotImplementedError] If the method is not overridden.
-    def attributes
-      raise NotImplementedError, 'Requires implementation of attributes.'
-    end
-  end
-end

data/lib/v1/query_interface.rb

@@ -1,140 +0,0 @@
-# frozen_string_literal: true
-
-module V1
-  # Query Mixin Interface. Include this module to a class that will be used as a query object.
-  # Query objects are eaily identified as helpers for querying with filters and sorting with complex algorithms.
-  # Thanks to ActiveRecord's inner workings, Ruby alone can handle the avdanced filtering
-  # before firing the query in the database. In this version, all query objects will be paginated.
-  # This is to avoid really heavy queries from hitting the database, either be it intentnional or malicious.
-  # In this version, pagination is enforced but only lightly encouraged.
-  # There will be a deprecation warning when no_pagination is used.
-  # However, the implementation of no_pagination is still a 1 page result;
-  # just that it supports a large number of queries in a single page.
-  # Developers will be required to move away from V1 of Query Interface soon to enforce strict pagination.
-  module QueryInterface
-    # The basis for validity of pagination settings. It also contains default values.
-    VALID_PAGINATION_HASH = {
-      max: 20, # Absolute maximum number of records per page, even if the query requests for more.
-      min: 1, # Absolute minimum number of records per page, even if the query requests for less.
-      per_page: 20, # Default number of records per page if not specified in the query.
-      page: 1 # Default page number if not specified in the query.
-    }.freeze
-
-    # Basis for considering a non-paging result even when the query is being processed for pagination.
-    # This number states the invalidity of pagination, but it exists for legacy support.
-    NO_PAGING_THRESHOLD = 1_000_000
-
-    class << self
-      def included(base)
-        # This is the method to call outside this object to apply the query filters, sortings and paginations.
-        # @param [Hash] query The query parameters.
-        # @param [ActiveRecord::Relation] collection The collection to be queried.
-        base.define_singleton_method(:call) do |query, collection|
-          new(query, collection).call
-        end
-      end
-    end
-
-    attr_reader :query, :collection
-
-    # Do not override! This is how we will always initialize our query objects.
-    # No processing should be done in the initialize method.
-    # @param [Hash] query The query parameters.
-    # @param [ActiveRecord::Relation] collection The collection to be queried.
-    def initialize(query, collection, pagination: true)
-      @query = query
-      @collection = collection
-      @pagination_flag = pagination
-      query_aliases
-    end
-
-    # Do not override. This is the method to call outside this object
-    # to apply the query filters, sortings and paginations.
-    def call
-      apply_filters!
-      apply_sorting!
-      apply_pagination!
-      collection
-    end
-
-    private
-
-    # Place here filters. Be sure to assign @collection to override the original collection. Be sure it is private!
-    def filters; end
-
-    # Place here sorting logic. Be sure to assign @collection to override the original collection.
-    # Be sure it is private!
-    def sorts; end
-
-    # Pagination settings to modify the default behavior of a query object.
-    # Default values are in VALID_PAGINATION_HASH constant.
-    # Override the method to change the default values.
-    def pagination_settings
-      {}
-    end
-
-    # Always updated alias of filters.
-    def apply_filters!
-      filters
-    end
-
-    # Always updated alias of sorts.
-    def apply_sorting!
-      sorts
-    end
-
-    # Paginates the collection based on query or settings.
-    def apply_pagination!
-      raise 'Invalid pagination settings.' unless correct_pagination_settings?
-      return unless @pagination_flag
-
-      @collection = collection.paginate(page: fetch_page_value, per_page: fetch_per_page_value)
-    end
-
-    # Logic for fetching the page value from the query or settings.
-    def fetch_page_value
-      query&.key?(:page) ? query[:page].to_i : merged_pagination_settings[:page]
-    end
-
-    # Logic for fetching the per page value from the query or settings.
-    def fetch_per_page_value
-      per_page = query&.key?(:per_page) ? query[:per_page].to_i : merged_pagination_settings[:per_page]
-      per_page.clamp(merged_pagination_settings[:min], merged_pagination_settings[:max])
-    end
-
-    # Checks if the pagination settings are correct.
-    # The app crashes on misconfiguration.
-    def correct_pagination_settings?
-      return false unless pagination_settings.is_a?(Hash)
-
-      detected_keys = []
-      merged_pagination_settings.each_key do |key|
-        return false unless VALID_PAGINATION_HASH.key?(key)
-
-        detected_keys << key
-      end
-
-      detected_keys.sort == VALID_PAGINATION_HASH.keys.sort
-    end
-
-    # The final result of pagination settings, and thus the used one.
-    def merged_pagination_settings
-      @merged_pagination_settings ||= VALID_PAGINATION_HASH.merge(pagination_settings)
-    end
-
-    # Aliases for query parameters for legacy support.
-    # No need to override this in children. Directly modify this method in this interface if need be.
-    def query_aliases
-      query[:per_page] = query[:limit] if query[:limit].present? && query[:per_page].blank?
-    end
-
-    # For deprecation. Use this for queries that do not need pagination.
-    # Queries will still be paginated as a result, but with the use of the threshold,
-    # the result is as good as a non-paginated result,
-    # and it will be treated as such.
-    def no_pagination
-      Rails.logger.warn 'Querying without paging is deprecated. Enforce paging in queries!'
-      { max: NO_PAGING_THRESHOLD, min: NO_PAGING_THRESHOLD }
-    end
-  end
-end

data/lib/v1/service_interface.rb

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-module V1
-  # Service Mixin Interface. Include from this module when creating a new service.
-  # In this version, a service is defined as an absolute reusable piece of code.
-  # They should not be related to views and presentation of data; they are instead processors.
-  # Because of this, errors encountered should be raised as exceptions naturally.
-  # Errors here are treated as bad data. Services are not responsible for handling bad data.
-  # Services assume all data passed is correct and valid. Services should no longer validate these data.
-  # Services can still store warnings; these warnings are sent to Sentry, although not yet implemented.
-  # All services will have a `perform` method that will call the `action` method. This is the invoker of the service.
-  # All services will have an `action` method that will contain the main logic of the service.
-  # All services will have a `data` method that will contain the resulting data that the service produced.
-  # Developers will mainly override `action` method and `data method`.
-  module ServiceInterface
-    def self.included(_)
-      Rails.logger&.warn(
-        <<~MSG
-          #################################################
-          #              DEPRECATION WARNING              #
-          # V1::ServiceInterface will be deprecated soon. #
-          #   Please use V2::ServiceInterface instead.    #
-          #################################################
-        MSG
-      )
-    end
-
-    # This is the main method of the service. This is the method that should be called to perform the service.
-    # Do not override this method. Instead, override the `action` method.
-    # @return [self] Instance of the service.
-    def perform
-      unless performed?
-        action
-        @performed = true
-        process_warnings
-      end
-
-      self
-    end
-
-    # Override this method and put the main logic of the service here.
-    # @raise [NotImplementedError] If the method is not overridden.
-    def action
-      raise NotImplementedError, 'Requires implementation of action.'
-    end
-
-    # Override this method and put the resulting data of the service here.
-    # If blank, then return an empty hash manually.
-    # Reason being is for readability's sake in the services.
-    # @raise [NotImplementedError] If the method is not overridden.
-    def data
-      raise NotImplementedError, 'Requires implementation of data.'
-    end
-
-    # Method used to add a warning. Do not override.
-    # @param [String] warning_message Descriptive sentence of the warning.
-    # @return [Array<String>] Array of all warnings.
-    def add_warning(warning_message)
-      _warnings << warning_message
-      warnings
-    end
-
-    # Checks if the service has been performed. Do not override.
-    # @return [Boolean] True or False
-    def performed?
-      performed
-    end
-
-    # Used to check if the service has encountered any warnings. Do not override.
-    # @return [Boolean] True or False
-    def warnings?
-      _warnings.any?
-    end
-
-    # This should contain all the warnings that the service has encountered.
-    # Intentionally made to be frozen to avoid free modification.
-    # Do not override this method.
-    # @return [Array<String>] Array of all warnings.
-    def warnings
-      _warnings.dup.freeze
-    end
-
-    private
-
-    # Status of the service. If the service has been performed, this should be true.
-    # Do not override this method.
-    # @return [Boolean] True or False
-    def performed
-      @performed ||= false
-    end
-
-    # The real warnings array. Do not override this method. Use `add_warning` method to add warnings.
-    # @return [Array<String>] Array of all warnings.
-    def _warnings
-      @warnings ||= []
-    end
-
-    # Iterates through the warnings and sends them to Sentry, supposedly. Unimplemented so far.
-    # Do not override the method.
-    # @return [void]
-    def process_warnings; end
-  end
-end

data/lib/v2/form_interface.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module V2
-  # V2 Form Interface is the same as V1 Form Interface,
-  # except forces an exception on the attributes method when intializing a form.
-  module FormInterface
-    class << self
-      # Allows the form mixin to include ActiveModel::Model powers.
-      def included(base)
-        base.include(ActiveModel::Model)
-
-        # Initializes the form in a class context with the options passed in.
-        base.define_singleton_method(:check) do |*arguments|
-          instance = NuecaRailsInterfaces::Util.process_class_arguments(self, *arguments)
-          instance.valid?
-          instance
-        end
-      end
-    end
-
-    # Initializes the form with the options passed in.
-    # It also calls the attributes method to ensure it is implemented.
-    def initialize(options = {})
-      super(**options)
-      attributes
-    end
-
-    # Final attributes to be returned by the form after validation.
-    # This is the data that is expected of the form to produce for processing.
-    # @raise [NotImplementedError] If the method is not overridden.
-    def attributes
-      raise NotImplementedError, 'Requires implementation of attributes.'
-    end
-  end
-end

data/lib/v2/service_interface.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-module V2
-  # V2 Service Interface is the same as V1 Service Interface, except it is more straightforward.
-  # When performing the service, it will immediately return the data
-  module ServiceInterface
-    class << self
-      def included(base)
-        # This is the main method of the service in a class context.
-        # This is the method that should be called to perform the service statically.
-        # Use this instead if the service instance is not needed.
-        # Do not override this method. Instead, override the `action` method. Returns the data immediately.
-        # @return [Object] Data of the service.
-        base.define_singleton_method(:perform) do |*arguments|
-          instance = NuecaRailsInterfaces::Util.process_class_arguments(self, *arguments)
-          instance.perform
-        end
-      end
-    end
-
-    # This is the main method of the service. This is the method that should be called to perform the service.
-    # Do not override this method. Instead, override the `action` method. Returns the data immediately.
-    # @return [Object] Data of the service.
-    def perform
-      unless performed?
-        action
-        @performed = true
-        process_warnings
-      end
-
-      data
-    end
-
-    # Override this method and put the main logic of the service here.
-    # @raise [NotImplementedError] If the method is not overridden.
-    # @return [void]
-    def action
-      raise NotImplementedError, 'Requires implementation of action.'
-    end
-
-    # Override this method and put the resulting data of the service here.
-    # If blank, then return an empty hash manually.
-    # Reason being is for readability's sake in the services.
-    # @raise [NotImplementedError] If the method is not overridden.
-    # @return [Object] Data of the service.
-    def data
-      raise NotImplementedError, 'Requires implementation of data.'
-    end
-
-    # Method used to add a warning. Do not override.
-    # @param [String] warning_message Descriptive sentence of the warning.
-    # @return [Array<String>] Array of all warnings.
-    def add_warning(warning_message)
-      _warnings << warning_message
-      warnings
-    end
-
-    # Checks if the service has been performed. Do not override.
-    # @return [Boolean] True or False
-    def performed?
-      performed
-    end
-
-    # Used to check if the service has encountered any warnings. Do not override.
-    # @return [Boolean] True or False
-    def warnings?
-      _warnings.any?
-    end
-
-    # This should contain all the warnings that the service has encountered.
-    # Intentionally made to be frozen to avoid free modification.
-    # Do not override this method.
-    # @return [Array<String>] Array of all warnings.
-    def warnings
-      _warnings.dup.freeze
-    end
-
-    private
-
-    # Status of the service. If the service has been performed, this should be true.
-    # Do not override this method.
-    # @return [Boolean] True or False
-    def performed
-      @performed ||= false
-    end
-
-    # The real warnings array. Do not override this method. Use `add_warning` method to add warnings.
-    # @return [Array<String>] Array of all warnings.
-    def _warnings
-      @warnings ||= []
-    end
-
-    # Iterates through the warnings and sends them to Sentry, supposedly. Unimplemented so far.
-    # Do not override the method.
-    # @return [void]
-    def process_warnings; end
-  end
-end