https://github.com/light-ruby/light-services
Robust service architecture for Ruby frameworks
https://github.com/light-ruby/light-services
ruby ruby-on-rails service-objects
Last synced: 4 months ago
JSON representation
Robust service architecture for Ruby frameworks
- Host: GitHub
- URL: https://github.com/light-ruby/light-services
- Owner: light-ruby
- License: mit
- Created: 2016-11-28T17:17:59.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T15:32:28.000Z (over 1 year ago)
- Last Synced: 2025-10-05T19:52:50.139Z (5 months ago)
- Topics: ruby, ruby-on-rails, service-objects
- Language: Ruby
- Homepage: https://light-services.kodkod.me
- Size: 186 KB
- Stars: 71
- Watchers: 4
- Forks: 5
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🚀 Light Services
Light Services is a simple yet powerful way to organize your business logic. This Ruby gem helps you build services that are easy to test, maintain, and understand.
[](https://codecov.io/gh/light-ruby/light-services)
## Features
- 🧩 **Simple**: Define your service as a class with `arguments`, `steps`, and `outputs`
- 🎢 **Transactions**: Automatically rollback database changes if any step fails
- 👵 **Inheritance**: Inherit from other services to reuse logic seamlessly
- 🚨 **Error Handling**: Collect errors from steps and handle them your way
- ⛓️ **Context**: Run multiple services sequentially within the same context
- 🤔 **Framework Agnostic**: Compatible with Rails, Hanami, or any Ruby framework
- 🏗️ **Modularity**: Isolate and test your services with ease
- 🐛 **100% Test Coverage**: Bugs are not welcome here!
- 🛡️ **Battle-Tested**: In production use since 2017
## Simple Example
```ruby
class GreetService < Light::Services::Base
# Arguments
arg :name
arg :age
# Steps
step :build_message
step :send_message
# Outputs
output :message
private
def build_message
self.message = "Hello, #{name}! You are #{age} years old."
end
def send_message
# Send logic goes here
end
end
```
## Advanced Example
```ruby
class User::ResetPassword < Light::Services::Base
# Arguments
arg :user, type: User, optional: true
arg :email, type: :string, optional: true
arg :send_email, type: :boolean, default: true
# Steps
step :validate
step :find_user, unless: :user?
step :generate_reset_token
step :save_reset_token
step :send_reset_email, if: :send_email?
# Outputs
output :user, type: User
output :reset_token, type: :string
private
def validate
errors.add(:base, "user or email is required") if !user? && !email?
end
def find_user
self.user = User.find_by("LOWER(email) = ?", email.downcase)
errors.add(:email, "not found") unless user
end
def generate_reset_token
self.reset_token = SecureRandom.hex(32)
end
def save_reset_token
user.update!(
reset_password_token: reset_token,
reset_password_sent_at: Time.current,
)
rescue ActiveRecord::RecordInvalid => e
errors.from_record(e.record)
end
def send_reset_email
Mailer::SendEmail
.with(self) # Call sub-service with the same context
.run(template: :reset_password, user:, reset_token:)
end
end
```
## Documentation
You can find the full documentation at [light-services.kodkod.me](https://light-services.kodkod.me).
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).