nueca_rails_interfaces 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 375e0a33491c00461a59c058bc16531aa7297fb5974420baecc7d5bdf095984e
-  data.tar.gz: 70fdf20fd30f3ac098c871bcb41470f5705e6b4a616d753ee6c362f7d8271589
+  metadata.gz: 42dd2f02e795aef50698e9a70249e3e0105c8a8e53a9208f1e75df110401a9ec
+  data.tar.gz: 10239f791667be7b7787ea03536c8d19f202ad0dae67eff292ba5688d3a1fd13
 SHA512:
-  metadata.gz: 8bf069562ba00aaeba977893057fbfad0e6c5e5f4ef8ed1d4208e343e90174824eead398f7ba7ae952597a5c5ce0c8c7a705bc6a087a60eded76d1715d372508
-  data.tar.gz: 756f5471261a09504b020119056f884f89a264ea29ae6c38d4402eb24876b1eed8751e1b561d67998ae8814d4ba86110060703eb830b47de6f92b7f094b822d8
+  metadata.gz: e4ea8b27bd401d4a0dbfeb111f82529f8b12ce0a79d11c0bc43b413130715964ad1416f08a27d42008b370e05f178b452646100988a85717b7af3b128042ae6e
+  data.tar.gz: 1baca017fc4728ca09f4e855ac186ea55b17a5ea9f62f7382faa67d740614a34db61cb67cce6fc47f44a5f09784f5f3d5d80b787986c5a5d4c81407cad8411ea

data/.rubocop.yml

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

data/lib/nueca_rails_interfaces/util.rb

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

data/lib/nueca_rails_interfaces/v2/service_interface.rb

@@ -7,12 +7,14 @@ module NuecaRailsInterfaces
     module ServiceInterface
       class << self
         def included(base)
+          raise NuecaRailsInterfaces::DeprecatedError
+
           # 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|
+          base.define_singleton_method(:perform) do |*arguments| # rubocop:disable Lint/UnreachableCode
             instance = NuecaRailsInterfaces::Util.process_class_arguments(self, *arguments)
             instance.perform
           end

data/lib/nueca_rails_interfaces/v3/service_interface.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module NuecaRailsInterfaces
+  module V3
+    # V3 Service Interface adds a way for developers to determine if it was ran successfully or not.
+    # When performing the service, it will immediately return the data.
+    # It will also assign the success? attribute of the class.
+    # The action method should return a boolean value.
+    # Warnings feature is now also removed.
+    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?
+          @success = action.present?
+          @performed = true
+        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
+
+      # Checks if the service has been performed. Do not override.
+      # @return [Boolean] True or False
+      def performed?
+        performed
+      end
+
+      # Returns the service's status if it performed successfully or not.
+      # Nil return means that the service is still not performed.
+      # @return [Boolean, nil] True or False or nil
+      def success?
+        @success
+      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
+    end
+  end
+end

data/lib/nueca_rails_interfaces/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: nueca_rails_interfaces
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Tien
 bindir: exe
 cert_chain: []
-date: 2025-06-23 00:00:00.000000000 Z
+date: 2025-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -49,7 +49,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".byebug_history"
 - ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
@@ -65,6 +64,7 @@ files:
 - 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/v3/service_interface.rb
 - lib/nueca_rails_interfaces/version.rb
 - nueca_rails_interfaces.gemspec
 homepage: https://github.com/tieeeeen1994/nueca-rails-interfaces

data/.byebug_history

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