⚛️ Solid::Process

Write business logic for Ruby/Rails that scales.

• 💡 Introduction
• 📦 Installation
• 🏗️ The Basic Structure
• 🚀 Getting Started
• 🗂️ Documentation
• 🛠️ Development
• 🤝 Contributing
• ⚖️ License
• 💜 Code of Conduct
• 🙏 Acknowledgments
• 👤 About

This library is tested (100% coverage) against:

solid-process is a Ruby/Rails library designed to encapsulate business logic into manageable processes. It simplifies writing, testing, maintaining, and evolving your code, ensuring it remains clear and approachable as your application scales.

Features: (touch to hide/expand)

Designed to complement Ruby on Rails, this library integrates smoothly without conflicting with existing framework conventions and features.

Offers an intuitive entry point for novices while providing robust, advanced features that cater to experienced developers.

By maintaining a consistent design philosophy, solid-process reduces the learning curve for new developers, allowing them to contribute more effectively and quickly to a codebase.

Equipped with sophisticated instrumentation mechanisms, the library enables detailed logging and tracing without compromising code readability, even when processes are nested.

⬆️  back to top

Check out Solid Rails App for a complete example of how to use solid-process in a Rails application. Twelve versions (branches) show how the gem can be incrementally integrated, access it to see from simple services/form objects to implementing the ports and adapters (hexagonal) architectural pattern.

You can also check the examples directory for more simple examples of how to use the gem.

⬆️  back to top

Install the gem and add to the application's Gemfile by executing:

$ bundle add solid-process

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install solid-process

And require it in your code:

require 'solid/process'

⬆️  back to top

Every Solid::Process requires an input block (defining attributes) and a call method (returning Success or Failure):

class User::Creation < Solid::Process
  input do
    attribute :email
    attribute :password
  end

  def call(attributes)
    user = User.create(attributes)

    if user.persisted?
      Success(:user_created, user: user)
    else
      Failure(:user_not_created, user: user)
    end
  end
end

# Call the process
result = User::Creation.call(email: 'alice@example.com', password: 'password')

result.success?     # => true
result.type         # => :user_created
result[:user]       # => #<User id: 1, ...>

Note: For validation including password confirmation, see the Reference Guide.

⬆️  back to top

New to Solid::Process? The comprehensive Reference Guide covers everything you need to know:

• ✅ Step-by-step tutorial from basics to advanced
• ✅ Real-world examples (User Registration system)
• ✅ All features explained with working code
• ✅ Perfect for developers AND AI coding agents

⬆️  back to top

Quick Overview — Bite-sized guides for each topic:

⬆️  back to top

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec rake matrix to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

# Run full test suite for current Ruby version
bin/rake matrix

# Run tests for a specific Rails version
bundle exec appraisal rails-8-1 rake test

# Run a single test file
bundle exec appraisal rails-8-1 ruby -Ilib:test test/solid/process/result_test.rb

# Lint (Ruby 3.4+)
bin/rake standard

# Clean install + full test suite (useful when switching Ruby versions)
# asdf set ruby <version>
bin/matrix

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.

⬆️  back to top

Bug reports and pull requests are welcome on GitHub at https://github.com/solid-process/solid-process. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

⬆️  back to top

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

⬆️  back to top

Everyone interacting in the Solid::Process project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

⬆️  back to top

I want to thank some people who helped me by testing and giving feedback as this project took shape, they are:

• Diego Linhares and Ralf Schmitz Bongiolo they were the brave ones who worked for a few months with the first versions of the ecosystem (it was called B/CDD). Their feedback was essential for improving DX and helped me to pivot some core decisions.
• Vitor Avelino, Tomás Coêlho, Haroldo Furtado (I could repeat Ralf and Diego again) for the various feedbacks, documentation, API, support and words of encouragement.

Rodrigo Serradura created this project. He is the Solid Process creator and has already made similar gems like the u-case and kind. This gem can be used independently, but it also contains essential features that facilitate the adoption of Solid Process (the method) in code.

⬆️  back to top