Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smart-rb/smart_operation
Smart implementation of the most-used programming pattern - Service Object. Powered by smart_injection, smart_container, smart_types and smart_initializer.
https://github.com/smart-rb/smart_operation
ddd ruby-ddd ruby-service-object service-object smart-rb
Last synced: about 2 months ago
JSON representation
Smart implementation of the most-used programming pattern - Service Object. Powered by smart_injection, smart_container, smart_types and smart_initializer.
- Host: GitHub
- URL: https://github.com/smart-rb/smart_operation
- Owner: smart-rb
- License: mit
- Created: 2020-01-13T21:35:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-23T11:20:16.000Z (almost 2 years ago)
- Last Synced: 2024-07-20T08:52:50.323Z (2 months ago)
- Topics: ddd, ruby-ddd, ruby-service-object, service-object, smart-rb
- Language: Ruby
- Homepage:
- Size: 54.7 KB
- Stars: 23
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SmartCore::Operation · 
· [](https://badge.fury.io/rb/smart_operation)
Smart implementation of the most-used programming pattern - Service Object. Powered by smart_injection, smart_container, smart_types and smart_initializer.
> previous generation: https://github.com/0exp/smart_core
---
---
## Main features
- multifunctional constructor DSL (powerd by [smart_initializer](https://github.com/smart-rb/smart_initializer) and [smart_types](https://github.com/smart-rb/smart_types));
- result object interface (`Success`, `Failure`, `Fatal`, `Callback`);
- `call.new.call` invocation behavior;
- support for dependency injection (powered by [smart_injection](https://github.com/smart-rb/smart_injection) and [smart_container](https://github.com/smart-rb/smart_container));
---
## Installation
```ruby
gem 'smart_operation'
```
```shell
bundle install
# --- or ---
gem install smart_types
```
```ruby
require 'smart_core/operation'
```
---
## Synopsis
```ruby
class CreateUser < SmartCore::Operation
register_container(ReposContainer)
import({ user_repo: 'business.users' }, access: :private)
option :name, 'value.string'
option :password, 'value.string'
option :age, 'value.integer'
def call
user = user_repo.create({ name: name, password: password, age: age })
Success(user: user) # or Callback { puts 'wow o.O' }
end
end
CreateUser.call(name: 'Rustam', password: 'test123', age: 28) do |result|
result.success? { puts 'success!' }
result.failure? { puts 'failure!' }
result.fatal? { puts 'fatal!' }
result.callback? { result.call } # or some_object.instance_eval(&result.callback)
end # NOTE: returns object, but invokes the correspinding block
# COMING SOON:
CreateUser.exec(name: 'Rustam', password: 'test123', age: 28) do |result|
# ...the same code as above...
end # NOTE: returns the result of the corresponding invoked block object
```
Pre-requisits:
```ruby
class UserRepo
def create(user_creds)
# ... some code
end
end
ReposContainer = SmartCore::Container.define do
namespace(:business) do
register(:users) { UserRepo.new }
end
end
```
---
## Roadmap
- method memoization logic (with abilities to refresh memoized methods);
- pattern matching for result objects (`Success`, `Failure`, `Fatal`, `Callback`);
- migrate to `Github Actions`;
- parametrized `.call` methods (`ServiceObject.with(attrs_a).call(attrs_b)` => `ServiceObject.new(attrs_b).call(attrs_a)` or something another);
- think about default exception classes and interfaces to support a basic domain-specific exception class definitioning (common practice);
- generators: an ability to invoke result block in repeatable `yield`-like style :thinking: (think about Fibers, js-like generators and similar) (for example: `.generator(call_attrs) do |result| # repeatable result block invokation for each "yield" from an inside "generator" method)`;
---
## Build
- run tests:
```shell
bundle exec rspec
```
- run code style checks:
```shell
bundle exec rubocop
```
- run code style checks with auto-correction:
```shell
bundle exec rubocop -A
```
---
## Contributing
- Fork it ( https://github.com/smart-rb/smart_operation )
- Create your feature branch (`git checkout -b feature/my-new-feature`)
- Commit your changes (`git commit -am '[feature_context] Add some feature'`)
- Push to the branch (`git push origin feature/my-new-feature`)
- Create new Pull Request
## License
Released under MIT License.
## Supporting
## Authors
[Rustam Ibragimov](https://github.com/0exp)