Project

ucasy

0.0
The project is in a healthy, maintained state
ucasylavendasoftware/ucasyHomepageDocumentationSource CodeBug TrackerWiki
Ucasy is just a quick test suite setup for Rails application
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Popularity
Downloads
4,868
Stars
0
Forks
0
Watchers
2
 Releases
Current version
0.3.3
Total releases
14
First release
2024-05-05
Latest release
2025-05-25
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
13
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2024-10-27
Reverse Dependencies
0

 Dependencies

Runtime

ostruct
>= 0
 Project Readme

Ucasy

Description soon!

Installation

As gem dependence

Add this line to your application's Gemfile:

gem "ucasy", "~> 0.3.3"

And then execute:

bin/bundle install

Or install it yourself as:

bin/bundle add ucasy

Copying files

Add this line to your application's Gemfile:

group :development do
  gem "ucasy", "~> 0.3.3", require: false
end

And then execute:

bin/bundle install

Or install it yourself as:

bin/bundle add ucasy --require false --group development

Create base file

You can use a Rails generator to create setup UseCaseBase file:

As gem dependence

bin/rails g ucasy:install

This will only create app/use_cases/use_case_base.rb

class UseCaseBase < Ucasy::Base
  class Flow < Ucasy::Flow
  end
end

And you need use ucasy gem as production dependence

Copying files

bin/rails g ucasy:copy

This will copy all needed code to your rails application:

  create  app/use_cases/use_case_base.rb
  create  app/use_cases/ucasy
  create  app/use_cases/ucasy/base.rb
  create  app/use_cases/ucasy/callable.rb
  create  app/use_cases/ucasy/context.rb
  create  app/use_cases/ucasy/failure.rb
  create  app/use_cases/ucasy/flow.rb
  create  app/use_cases/ucasy/validators/required_attributes.rb
  create  app/use_cases/ucasy/validators/validate.rb
  create  app/use_cases/ucasy/version.rb

Basic usage

You can create a simple use case to app/use_cases/authenticate_user.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

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

class AuthenticateUser < UseCaseBase
  validate(AuthenticateUserValidation)

  def call
    context.login
    context.password
  end
end

You can filter attributes. Only context.login and context.password will be validated in example below:

class AuthenticateUser < UseCaseBase
  validate(AuthenticateUserValidation, :login, :password)
  ...
end

Adds a validation

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:

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.

License

The gem is available as open source under the terms of the MIT License.