Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amiralles/service_object
Service Objects gem to reduce boilerplate code in your Rails apps.
https://github.com/amiralles/service_object
rails-api ruby ruby-gem ruby-on-rails
Last synced: 13 days ago
JSON representation
Service Objects gem to reduce boilerplate code in your Rails apps.
- Host: GitHub
- URL: https://github.com/amiralles/service_object
- Owner: amiralles
- License: mit
- Created: 2024-08-06T12:33:57.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-06T15:47:08.000Z (3 months ago)
- Last Synced: 2024-10-11T04:42:56.967Z (about 1 month ago)
- Topics: rails-api, ruby, ruby-gem, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ServiceObject
**ServiceObject** is a lightweight Ruby gem that provides a structured
approach to creating service objects in Ruby on Rails applications. This
library offers a base class with convenient methods for safely and
consistently executing business logic.
## Features
* **Base Service Class:** Provides a common structure for all service objects.
* **Safe Call Method**: Adds error handling to service object calls, ensuring a
consistent response format.
* **Convenient Class-Level Methods:** Allows calling service objects without instantiating them manually.
* **Customizable:** Easily subclass and override methods to fit your specific business logic needs.
## Installation
Not yet :)
## Usage
Create a new service object by inheriting from ServiceObject::Base:
```ruby
class MyService < ServiceObject::Base
def initialize(args = {})
@args = args
end
protected
def perform_call
# Define the service logic here
puts "Performing call with #{@args}"
"Success result"
end
end
```
Call your service object safely:
```ruby
result = MyService.call("some arguments")
if result.success?
puts "Success: #{result.value}"
else
puts "Error: #{result.error.message}"
end
```
Or use the bang method to raise errors:
```ruby
begin
result = MyService.call!("some arguments")
puts "Success: #{result}"
rescue StandardError => e
puts "Error: #{e.message}"
end
```
It supports pattern matching right out of the gate:
```ruby
case MyService.call("some arguments")
in {success?: true, value: value}
puts "Success: #{value}"
in {success?: false, error: error}
puts "Error: #{error.message}"
end
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/amiralles/service_object.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).