ucasy 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 527b41741e56f37168fedca4c4a8f715d0028442c683a0307d663a66674e21d7
-  data.tar.gz: 1add4fd86b293082a53b227b637c8d67ec3d43272971700ef489c0cf6f5c1634
+  metadata.gz: 36d451f98af67ec26170e55b1ad2799192ae80d852b5cf1436f3858b8d4718ad
+  data.tar.gz: 06e1bf635c4d2fa3a7a31b7d304f13029a37bab989e6bc32429d264cd324d2dc
 SHA512:
-  metadata.gz: aa60ed7eb4a8974bff5b00f8edc0fdd4108ba01da21244015bafbc463323c3e5efa20480c6512dadac7029cf2c3daa15205931b0aa5f9a71999cf36d3d03e4be
-  data.tar.gz: c59dbe9298d800901cc4a24cfccc444bb032a98addd36209da4d5c1aa654d1096de5d42aeaf41a5e2ad9a0c05a97283e08d428c094563e8c64ee265aafff3376
+  metadata.gz: 43cdad21e2a991eaa28285905828ba6bec0fe52ef5a1a22bdf8b3969490af67945c56bbfd2b3ba29bf640f170fa5fdb03ba3781fdcff08fbee060602af296aaa
+  data.tar.gz: 6e7fd420a5b4f4d46fbf79afd9797f24ee590025b3dc84830740ada4d2b8fd7c14a27beb05119a32841115817e1d238ee29d1293b36885db0de229493542811e

data/README.md

@@ -7,7 +7,7 @@ Description soon!
 Add this line to your application's Gemfile:
 
 ```ru
-gem "ucasy", "~> 0.0.1"
+gem "ucasy", "~> 0.2.0"
 ```
 
 And then execute:
@@ -22,14 +22,117 @@ Or install it yourself as:
 bundle add ucasy
 ```
 
-## Usage
+## Create base file
 
-You can use a Rails generator to create setup files:
+You can use a Rails generator to create setup `UseCaseBase` file:
 
 ```sh
 rails g ucasy:install
 ```
 
+This will create `app/use_cases/use_case_base.rb`
+
+```rb
+class UseCaseBase < Ucasy::Base
+  class Flow < Ucasy::Flow
+  end
+end
+```
+
+## Basic usage
+
+You can create a simple use case to `app/use_cases/authenticate_user.rb`:
+
+```rb
+class AuthenticateUser < UseCaseBase
+  def before
+    context.user = User.find_by(login: context.login)
+  end
+
+  def call
+    return if context.user.valid_password?(context.password)
+
+    context.fail!(
+      status: :unprocessable_entity,
+      message: "User not found",
+      errors: context.user.errors
+    )
+  end
+
+  def after
+    UserMailer.with(user: context.user).login_warning.perform_later
+  end
+end
+```
+
+## Using methods
+
+There is some methods to ensure arguments for each use case:
+
+### required_attributes
+
+```rb
+class AuthenticateUser < UseCaseBase
+  required_attributes(:login, :password)
+
+  def call
+    context.login
+    context.password
+  end
+end
+```
+
+The method `required_attributes` raises an error if `login` or `password` is blank
+
+
+### validate
+
+You can use ActiveModel or any class that respond to `valid?`, `errors`, `present?` and accepts a hash as arguments to validate you payload.
+
+Create a class
+
+```rb
+class AuthenticateUser < UseCaseBase
+  validate(AuthenticateUserValidation)
+
+  def call
+    context.login
+    context.password
+  end
+end
+```
+
+Adds a validation
+
+```rb
+class AuthenticateUserValidation
+  include ActiveModel::Model
+
+  attr_accessor :login, :password
+
+  validates :login, presence: true
+  validates :password, presence: true
+
+  def to_context
+    {login:, :password} # this hash will be injected in use cases context
+  end
+end
+```
+
+## Using Flow
+
+You can also create a flow to organize your use cases:
+
+```rb
+class PlaceOrder < UseCaseBase::Flow
+  transactional # if any use case fails ActiveRecord will rollback transaction
+
+  validate(PlaceOrderValidation)
+
+  flow(ChargeCard, SendThankYou, FulfillOrder)
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ucasy.

data/lib/ucasy/flow.rb

@@ -1,22 +1,43 @@
 module Ucasy
   class Flow < Base
     class << self
-      def service_classes(*service_classes)
-        @service_classes = service_classes
+      def flow(*ucases)
+        @ucases = ucases
       end
-      alias_method :flow, :service_classes
 
-      def _service_classes
-        @service_classes || []
+      def ucases
+        @ucases || []
+      end
+
+      def transactional
+        @transactional = true
+      end
+
+      def transactional?
+        @transactional || false
       end
     end
 
     def call
-      self.class._service_classes.each do |service_class|
-        service_class.call(context)
+      if self.class.transactional?
+        ActiveRecord::Base.transaction { execute }
+      else
+        execute
       end
 
       self
     end
+
+    private
+
+    def execute
+      self.class.ucases.each do |ucase|
+        service_class.call(context)
+
+        next unless self.class.transactional?
+
+        raise ActiveRecord::Rollback if failure?
+      end
+    end
   end
 end

data/lib/ucasy/version.rb

@@ -1,3 +1,3 @@
 module Ucasy
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ucasy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lavenda Software
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-07 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: Ucasy is just a quick test suite setup for Rails application