service_core 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01d926ff29ac3ea5c0ecb4f7a754ea6531732cfe8bfe33591f17a0827132fd21
-  data.tar.gz: b79448edd6a9a4900430f246b0410362782d197a0b9318add7e6f7d63d71df1b
+  metadata.gz: f67c3782ff8c7f937074ff46819d3be8e1a292c34626d78679b3c76678b7691b
+  data.tar.gz: c7d291d06cfa2c133ced540e3a7d93c587af49237ec9623a4faaeb2aa04aff11
 SHA512:
-  metadata.gz: b192d8ca5f4439ca1d178697c70ed5ed1e288108c23c72b1aafa8ac1e7a17124f97c6b8f95978615f62e0f58e536c1a1f48cddc6b3e6ab39e5402f314ad3fa36
-  data.tar.gz: b855792ae11ac1a308004437e01374daac234ae4588416dc936eb2d5ac9cf973b03c2435a48d515e3a577cc29016dcbcdd88939d4c4b43d6d98b7b2f0cdd1109
+  metadata.gz: c0b1d2784eeeb0c9c1bb640127a4a492f702b7fc092b584f5f6f019afb13999e3cfda5a101ef1561971c543f3eb56f5e1fd677fbd832c2f0739daa2898474d3f
+  data.tar.gz: 5f069a26c2734b989cd870671d1f66e99c9a1fe3559be78ab5f1ad4a133a7677cd00c614278f138f1a656ab5f7737850f7df286d5f787f8ab5e15258acad2a3d

data/.rubocop.yml

@@ -1,5 +1,9 @@
+require:
+  - rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
+  NewCops: enable
 
 Style/StringLiterals:
   Enabled: true
@@ -16,4 +20,16 @@ Style/Documentation:
   Enabled: false
 
 Metrics/BlockLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/VerifiedDoubleReference:
   Enabled: false

data/README.md

@@ -1,6 +1,6 @@
 # ServiceCore
 
-ServiceCore provides a standardized way to define and use service objects in your Ruby and Rails applications. It includes support for defining fields, validations, responses, and logging.
+ServiceCore provides a standardized way to define and use service objects in Ruby and Rails applications. It includes support for specifying fields, validations, responses, and error logging. This approach is inspired by the DRY (Don't Repeat Yourself) principle and Rails' convention over configuration philosophy.
 
 ## Installation
 Install the gem and add to the application's Gemfile by executing:
@@ -8,19 +8,32 @@ Install the gem and add to the application's Gemfile by executing:
 ```sh
 bundle add service_core
 ```
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or in your Gemfile:
+
+```ruby
+gem "service_core"
+```
+
+If the bundler is not being used to manage dependencies, install the gem by executing:
 
 ```sh
 gem install service_core
 ```
+
+### Service Response Structure
+The idea is to define a convention that the response from a service can have only four keys:
+- status
+- data
+- message
+- errors
+
+The data type of any of the above keys is not enforced, giving the developer flexibility to return based on the use case, but should follow this response structure.
 ## Usage
 
 ### Defining a Service
 
-To define a new service, include the `ServiceCore` module in your service class and define your fields and the perform method.
+To define a new service, include the `ServiceCore` module in your service class and define your fields and the `perform` method.
 ```ruby
-# app/services/my_service.rb
-
 class MyService
   include ServiceCore
 
@@ -60,8 +73,181 @@ puts service.output
 # }
 ```
 
+The `call` method can be invoked on the service class and it too will return the object of the service.
+```ruby
+obj = MyService.call(first_name: "John", last_name: "Doe")
+puts obj.output
+# Output:
+# {
+#   status: "success",
+#   message: "Hello, World",
+#.  data: "John Doe"
+# }
+```
+
+### `field` method
+The `field` method can define primitive types and objects, like hash/array or any object. For objects, there is no need to declare the datatype.
+```ruby
+class MyService
+  include ServiceCore
+
+  field :first_name, :string
+  field :last_name, :string
+  field :payload # can be object/hash/array
+
+  def perform
+    success_response(message: "Hello, World", data: name)
+  end
+
+  def name
+    "#{first_name} #{last_name}"
+  end
+end
+```
+
+### `set_output` method
+
+The `set_output` method provides a way to set output of a specific key. It is the method used by the response_setters to set specific output value
+```ruby
+class MyService
+  include ServiceCore
+
+  field :first_name, :string
+  field :last_name, :string
+  field :payload # can be object/hash/array
+
+  def perform
+    set_output :message, "Hello, World"
+    set_output :data, name
+  end
+
+  def name
+    "#{first_name} #{last_name}"
+  end
+end
+
+obj = MyService.call(first_name: "John", last_name: "Doe")
+puts obj.output
+# Output:
+# {
+#   status: "success",
+#   message: "Hello, World",
+#.  data: "John Doe"
+# }
+```
+*NOTE:* If `:status` is not explicitly set in the perform method, the `success` status is returned if `errors` are blank else the `error` status is returned.
+
+### Response Setters
+
+#### `success_response`
+Use the `success_response` method to return the `success` status, `data` and `message`
+```ruby
+
+class MyService
+  include ServiceCore
+
+  field :first_name, :string
+  field :last_name, :string
+  field :active, :boolean, default: true
+
+  def perform
+    success_response(message: "Hello, World", data: name)
+  end
+
+  def name
+    "#{first_name} #{last_name}"
+  end
+end
+
+service = MyService.new(first_name: "John", last_name: "Doe")
+result = service.call
+puts result
+# Output:
+# {
+#   status: "success",
+#   message: "Hello, World",
+#.  data: "John Doe"
+# }
+```
+
+`success_response` accepts following arguments:
+- message
+- data
+
+#### `error_response`
+Use the `error_response` method to return the `error` status, `errors` and `message`
+```ruby
+
+class MyService
+  include ServiceCore
+
+  field :first_name, :string
+  field :last_name, :string
+  field :active, :boolean, default: true
+
+  def perform
+    error_response(message: "validation failure", errors: "last_name can't be blank")
+  end
+
+  def name
+    "#{first_name} #{last_name}"
+  end
+end
+
+service = MyService.new(first_name: "John")
+result = service.call
+puts result
+# Output:
+# {
+#   status: "error",
+#   message: "validation failure",
+#.  errors: "last_name can't be blank"
+# }
+```
+
+`error_response` accepts following arguments:
+- message
+- errors
+
+#### `formatted_response`
+Use the `formatted_response` method to return any status other than `success` or `error`.
+```ruby
+
+class MyService
+  include ServiceCore
+
+  field :first_name, :string
+  field :last_name, :string
+  field :active, :boolean, default: true
+
+  def perform
+    formatted_response(status: 'processed', message: "Hello, World", data: name)
+  end
+
+  def name
+    "#{first_name} #{last_name}"
+  end
+end
+
+service = MyService.new(first_name: "John", last_name: "Doe")
+result = service.call
+puts result
+# Output:
+# {
+#   status: "processed",
+#   message: "Hello, World",
+#.  data: "John Doe"
+# }
+```
+
+`formatted_response` accepts following arguments:
+- status
+- message
+- data
+- errors
+
 ### Validations
-You can define validation on the service and  those will be invoked before service logic is invoked
+Define validation on the service and those will be invoked before service logic is invoked.
 ```ruby
 class MyService
   include ServiceCore
@@ -86,7 +272,7 @@ puts result
 ```
 
 ### Step Validation
-You can perform validation at each step of service logic. This is helpful when result of previous step decides next logic.
+Perform validation at each step of service logic. This is helpful when the result of the previous step decides the next logic.
 ```ruby
 class MyService
   include ServiceCore
@@ -108,7 +294,8 @@ class MyService
   end
 end
 
-MyService.call(first_name: 'abc')
+obj = MyService.call(first_name: 'abc')
+obj.output
 # output:
 # {
 #   status: "error",
@@ -118,7 +305,7 @@ MyService.call(first_name: 'abc')
 ```
 
 ### Logging Errors
-You can log errors using the `log_error` method.
+Log errors using the `log_error` method.
 ```ruby
 class MyService
   include ServiceCore
@@ -148,50 +335,13 @@ puts result
 ```
 
 ### Configuring the Logger
-You can configure the logger for the ServiceCore module.
+Configure the logger for the ServiceCore module.
 ```ruby
 ServiceCore.configure do |config|
   config.logger = Logger.new(STDOUT)
 end
 ```
 
-### Custom Response
-use `formatted_response` method to return any other status other than `success` or `error`
-```ruby
-
-class MyService
-  include ServiceCore
-
-  field :first_name, :string
-  field :last_name, :string
-  field :active, :boolean, default: true
-
-  def perform
-    formatted_response(status: 'processed', message: "Hello, World", data: name)
-  end
-
-  def name
-    "#{first_name} #{last_name}"
-  end
-end
-
-service = MyService.new(first_name: "John", last_name: "Doe")
-result = service.call
-puts result
-# Output:
-# {
-#   status: "processed",
-#   message: "Hello, World",
-#.  data: "John Doe"
-# }
-```
-
-`formatted_response` accepts following arguments:
-- status
-- message
-- data
-- errors
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/sehgalmayank001/service-core. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sehgalmayank001/service-core/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -16,6 +16,6 @@ task :release do
   version = `ruby -r ./lib/service_core/version -e "puts ServiceCore::VERSION"`.strip
   # sh "git add ."
   # sh "git commit -m 'Prepare for version #{version} release'"
-  # sh "git tag v#{version}"
-  # sh "git push origin main --tags"
-end
+  sh "git tag v#{version}"
+  sh "git push origin main --tags"
+end

data/lib/service_core/base.rb

@@ -9,13 +9,12 @@ module ServiceCore
     extend ActiveSupport::Concern
 
     included do
+      # ServiceCore::Response is included first as it inherited output,
+      # which too has initialize method.
+      include ServiceCore::Response
       include ActiveModel::Model
       include ActiveModel::Attributes
       include ActiveModel::Validations
-      include ServiceCore::Response
-
-      # NOTE: output attribute will hold output of the service
-      attr_reader :output
 
       # NOTE: fields attribute will hold the fields defined and their values
       attr_reader :fields
@@ -50,7 +49,9 @@ module ServiceCore
         end
 
         def call(attributes = {})
-          new(attributes).call
+          obj = new(attributes)
+          obj.call
+          obj
         end
       end
 
@@ -62,9 +63,6 @@ module ServiceCore
         self.class.fields_defined.each_key do |name|
           @fields[name] = send(name)
         end
-
-        # default value of output
-        @output = { status: "initialized" }
       end
 
       def call
@@ -74,15 +72,15 @@ module ServiceCore
         # perform the operation
         perform
 
+        # auto assign status if output is dirty
+        auto_assign_status
+
         # return output
         output
       end
 
       private
 
-      # output writer is protected to be used inside class and sub-classes only
-      attr_writer :output
-
       def perform
         raise StandardError, "perform method not implemented"
       end

data/lib/service_core/output.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+# require "active_model/errors"
+
+module ServiceCore
+  module Output
+    extend ActiveSupport::Concern
+
+    ALLOWED_KEYS = %i[status data message errors].freeze
+
+    # NOTE: output attribute will hold output of the service
+    attr_reader :output
+
+    def initialize(_attributes = {})
+      @output_dirty = false
+      @status_dirty = false
+      @output = { status: "initialized" }
+    end
+
+    private
+
+    def set_output(key, value)
+      return unless key && value
+      raise ArgumentError, "Invalid key. Allowed keys are: #{ALLOWED_KEYS.join(", ")}" unless ALLOWED_KEYS.include?(key)
+
+      @output_dirty ||= true
+      @status_dirty = true if key == :status && !@status_dirty
+      @output[key] = value
+    end
+
+    def auto_assign_status
+      if !@output_dirty
+        set_output(:status, "success")
+      elsif @output_dirty && !@status_dirty
+        status_value = output[:errors].blank? ? "success" : "error"
+        set_output(:status, status_value)
+      elsif @output_dirty && @status_dirty
+        # ignore
+      end
+    end
+  end
+end

data/lib/service_core/response.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 require "active_support/concern"
+require_relative "output"
 # require "active_model/errors"
 
 module ServiceCore
   module Response
     extend ActiveSupport::Concern
 
+    include ServiceCore::Output
+
     protected
 
     def success_response(message: nil, data: nil)
@@ -19,11 +22,11 @@ module ServiceCore
 
     # set output response
     def formatted_response(status:, message: nil, data: nil, errors: nil)
-      @output[:status] = status
-      @output[:message] = message if message.present?
-      @output[:data] = data if data.present?
-      @output[:errors] = error_messages(errors) if errors.present?
-      @output
+      set_output(:status, status)
+      set_output(:message, message) if message.present?
+      set_output(:data, data) if data.present?
+      set_output(:errors, error_messages(errors)) if errors.present?
+      output
     end
 
     def error_messages(errors)

data/lib/service_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ServiceCore
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_core
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - mayank sehgal
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-17 00:00:00.000000000 Z
+date: 2024-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -68,15 +68,16 @@ files:
 - lib/service_core.rb
 - lib/service_core/base.rb
 - lib/service_core/logger.rb
+- lib/service_core/output.rb
 - lib/service_core/response.rb
 - lib/service_core/step_validation.rb
 - lib/service_core/version.rb
-- service_core.gemspec
 - sig/service_core.rbs
 homepage: https://github.com/sehgalmayank001/service-core
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -85,7 +86,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/service_core.gemspec

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/service_core/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "service_core"
-  spec.version = ServiceCore::VERSION
-  spec.authors = ["mayank sehgal"]
-  spec.email = ["sehgalmayank001@gmail.com"]
-
-  spec.summary       = "A Rails service pattern implementation"
-  spec.description   = "A service pattern implementation for Rails applications."
-  spec.homepage = "https://github.com/sehgalmayank001/service-core"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  # spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "activemodel", ">= 6.1", "< 8.0"
-  spec.add_runtime_dependency "activesupport", ">= 6.1", "< 8.0"
-
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end