nueca_rails_interfaces 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71471580cc28c42f5997160d6e01684e081244da014e44ecd110e37e4c62db91
-  data.tar.gz: 3236fcf542d757322a14ab338330ad721089445afc4f7b1877bd45cf6dbeda65
+  metadata.gz: c0400fd054522afaa27869d22bbeb107f9c84e5f9989fd28538818ab278333cc
+  data.tar.gz: 9042cd34c04d336eb24dc8ed33df148d090b23a0ecf1f56364cfeac3133a3723
 SHA512:
-  metadata.gz: '089db05b4843a21ba0462efe9e07717a6b17f8e35117fcb096279d0f136f1f6828ed7c7d85f423e38781f325b58e678bb4a8f0808010daee14f530716d5ede3c'
-  data.tar.gz: 6061f449b9deb9130c7aeaba1d5de4a7a02542bc560333dc1995a088771a88f9f2a23e67eeb0e947b25a340e804f74b5eb8f1aef157d8900dccec7cd685136a7
+  metadata.gz: f2f1b0886cd7b2c9659533e080409a6749f50a07bcf6c365a23f49f208e6d782ff6bfab652e49fe3e21c326f258d0da35c6e2d84a978ed1c9ae5769873af7de0
+  data.tar.gz: 8256f7c51cd8ba02b7217bed745bbbeb7c5a12fec2642506c6b18660c6938f35fa8098a9314e2baa969be43c28684070c78596c34464b8c075c59c79f97ae5f8

data/.byebug_history

@@ -0,0 +1,7 @@
+exit
+defined?(Node)
+c
+exit
+defined?(Node)
+exit
+c

data/.rubocop.yml

@@ -12,3 +12,6 @@ Layout/LineLength:
 
 RSpec/NestedGroups:
   Max: 5
+
+RSpec/VerifiedDoubles:
+  Enabled: false

data/lib/nueca_rails_interfaces/version.rb

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

data/lib/nueca_rails_interfaces.rb

@@ -13,4 +13,4 @@ end
 require_relative 'nueca_rails_interfaces/util'
 
 # Require all interfaces.
-Dir["#{__dir__}/v*/*_interface.rb"].each { |file| require_relative file }
+Dir["#{__dir__}/v*/**/*_interface.rb"].each { |file| require_relative file }

data/lib/v1/data_source/base_interface.rb

@@ -0,0 +1,57 @@
+# 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

@@ -0,0 +1,24 @@
+# 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

@@ -17,6 +17,15 @@ module V1
     # @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.

data/lib/v1/service_interface.rb

@@ -13,6 +13,18 @@ module V1
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nueca_rails_interfaces
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Tien
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-06 00:00:00.000000000 Z
+date: 2024-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,6 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".byebug_history"
 - ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
@@ -54,6 +55,8 @@ files:
 - lib/nueca_rails_interfaces.rb
 - lib/nueca_rails_interfaces/util.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
@@ -80,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Interfaces for known object entities in Rails Development at Nueca.