rail_line 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4de14fb1332b93a1f3d52d7533253f416603d806f795cd2cf0dd0ea82fefec63
+  data.tar.gz: 1697c9efe345a550eaf5adbcd7e9a44ba80669ce4e86284eeaa16528cf840e92
+SHA512:
+  metadata.gz: 59d58063448a5edfca5acdf3aa265ff055ec94701058951b0d23d19fbdf2637ca7aeef54526a560ddeddf03e1c4299e8637b043e4ab2375a3505981026640ec0
+  data.tar.gz: f4e9e38386b076faec4c88d5b1bc37efd8fefd8cb4210da2176e0b8ad4bbb0b01da8faf6e5d88e730d69283a9c040d9c3305b82338d7cbe1d3cc31f9da9f64e1

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: exception
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-04-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [2025] [Joshua Frankel <joshmfrankel@gmail.com>]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,180 @@
+# RailLine
+
+[![Ruby](https://github.com/joshmfrankel/rail_line/actions/workflows/main.yml/badge.svg)](https://github.com/joshmfrankel/rail_line/actions/workflows/main.yml)
+
+_Get your code in line_
+
+RailLine provides a simple interface for implementing Railway Oriented Programming adapted for Ruby.
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rail_line'
+```
+
+Run `bundle install` to install the gem.
+
+Profit.
+
+# Usage
+
+In order to utilize RailLine, include the `RailLine::ResultDo` module in your class and wrap your business logic with the `handle_result` method.
+
+```ruby
+class MyAwesomeService
+  include RailLine::ResultDo
+
+  def call
+    handle_result do
+      # Do something
+      # Do something else
+      # Return the result
+    end
+  end
+end
+```
+
+Now within the calling object you will always receive either `RailLine::Success` or `RailLine::Failure` object with a clean interface for handling the result.
+
+- `success?` - Returns true if the result is a success
+- `failure?` - Returns true if the result is a failure
+- `payload` - Returns the optional payload of the result
+- `message` - Returns the optional message of the result
+
+`.success?` and `.failure?` work well with conditional rendering.
+
+```ruby
+result = MyAwesomeService.new.call
+
+if result.success?
+  render json: {
+    success: true,
+    payload: result.payload
+  }
+elsif result.failure?
+  render json: {
+    success: false,
+    payload: result.payload,
+    message: result.message
+  }
+end
+```
+
+## Exception Handling
+
+Additionally, anytime `RailLine::Failure` is instantiated or a `StandardError` is raised, the failure will be raised to the top of the calling stack. This ensures that processing halts and the failure propagates to the caller.
+
+```ruby
+# StandardError Example
+class MyAwesomeService
+  include RailLine::ResultDo
+
+  def call
+    handle_result do
+      record.update!(some_attribute: "invalid value")
+
+      RailLine::Success.new(message: "MyAwesomeService worked!")
+    end
+  end
+end
+
+# OR
+
+# RailLine::Failure Example
+class MyAwesomeService
+  include RailLine::ResultDo
+
+  def call
+    handle_result do
+      RailLine::Failure.new(message: "MyAwesomeService failed!") if some_failure_condition
+
+      RailLine::Success.new(message: "MyAwesomeService worked!")
+    end
+  end
+end
+```
+
+In the above example, if `record.update!(some_attribute: "invalid value")` raises a `StandardError`, handle_result will immediately return a `RailLine::Failure` object with the error details. This avoids calling the ending `RailLine::Success.new(message: "MyAwesomeService worked!")`.
+
+### Nested Exceptions
+
+Exception handling also works for nested objects.
+
+```ruby
+class MyAwesomeService
+  include RailLine::ResultDo
+
+  def call
+    handle_result do
+      MyAwesomeNestedService.new.call
+
+      RailLine::Success.new(message: "MyAwesomeService worked!")
+    end
+  end
+end
+
+class MyAwesomeNestedService
+  include RailLine::ResultDo
+
+  def call
+    handle_result do
+      record.update!(some_attribute: "invalid value")
+
+      RailLine::Success.new(message: "MyAwesomeNestedService worked!")
+    end
+  end
+end
+```
+
+In the above scenario, the `MyAwesomeNestedService` raising a `StandardError` will immediately halt processing and bubble the failure up to the `MyAwesomeService`.
+
+### Automatic RailLine
+
+If you prefer RailLine to handle a specific method automatically, you can use the `include RailLine::ResultDo[:call]` module syntax. This is equivalent to the above example.
+
+```ruby
+class MyAwesomeService
+  include RailLine::ResultDo[:call]
+
+  def call
+    # Automatically wrapped within handle_result
+    RailLine::Success.new(message: "MyAwesomeService worked!")
+  end
+end
+```
+
+## Features
+
+- Exceptions halt execution and return a `RailLine::Failure` object with details.
+- RailLine wrapped method calls always return a RailLine result object even when not explicitly returned.
+- `RailLine::Failure` halts further execution of the calling method.
+
+## FAQs
+
+1. Will this implement fmap, bind, and other monad methods?
+
+Likely not. There are other great gems out there which implement these methods. RailLine is meant to be a simple and clean way to manage business logic and flow.
+
+2. How does this compare to other gems?
+
+There are other gems out there which more fully implement traditional Railway Oriented Programming concepts. For example, [dry-monads](https://github.com/dry-rb/dry-monads) is a popular choice. RailLine was inspired by this great gem as a simple alternative.
+
+3. How can I debug exceptions not explictly called via RailLine::Failure?
+
+RailLine::Failure objects that originate from StandardError are hydrated with a `payload` attribute which contains the underlying `exception` and `backtrace`. You can use this to debug failures by introspecting the underlying exception.
+
+## 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/joshmfrankel/rail_line. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joshmfrankel/rail_line/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the RailLine project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joshmfrankel/rail_line/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/rail_line/base_result.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RailLine
+  class BaseResult
+    attr_reader :payload, :message
+
+    # @param payload [Hash] The payload of the result
+    # @param message [String] The message of the result
+    def initialize(payload: {}, message: nil)
+      @payload = payload
+      @message = message
+
+      handle_failure
+    end
+
+    # @return [Boolean] Returns true if the result is a failure
+    def failure?
+      !success?
+    end
+
+    private
+
+    def handle_failure
+      return unless failure?
+      return unless respond_to?(:raise_error) && raise_error
+
+      raise FailureError.new(self)
+    end
+  end
+end

data/lib/rail_line/failure.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RailLine
+  # Represents a Failed result
+  class Failure < BaseResult
+    attr_reader :raise_error
+
+    # @param payload [Hash] The payload of the result
+    # @param message [String] The message of the result
+    # @param raise_error [Boolean] Raise an error when the failure is instantiated
+    def initialize(payload: {}, message: nil, raise_error: true)
+      @raise_error = raise_error
+
+      super(payload:, message:)
+    end
+
+    # @return [Boolean] Returns false
+    def success?
+      false
+    end
+  end
+end

data/lib/rail_line/failure_error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RailLine
+  # Controls flow of RailLine when encountering a RailLine::Failure
+  class FailureError < StandardError
+    attr_reader :result
+
+    # @param result [RailLine::Failure] The result that caused the error
+    def initialize(result)
+      @result = result
+
+      super(result.message)
+    end
+  end
+end

data/lib/rail_line/result_do/thread_context.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RailLine
+  module ResultDo
+    # Manages the current depth of the RailLine context for nested
+    # handle_result calls. Captured within the current thread.
+    module ThreadContext
+      # @return [Integer] The current depth of the RailLine context
+      def self.depth
+        Thread.current[:rail_line_depth] ||= 0
+      end
+
+      # @param value [Integer] The value to set the depth to
+      def self.depth=(value)
+        Thread.current[:rail_line_depth] = value
+      end
+
+      # Increments the depth of the RailLine context
+      # @return [Integer] The new depth of the RailLine context
+      def self.depth_increment
+        self.depth += 1
+      end
+
+      # Decrements the depth of the RailLine context
+      # @return [Integer] The new depth of the RailLine context
+      def self.depth_decrement
+        self.depth -= 1
+      end
+
+      # Cleans up the RailLine context by resetting the depth
+      def self.cleanup
+        Thread.current[:rail_line_depth] = nil
+      end
+
+      # @return [Boolean] Whether the RailLine context is nested
+      def self.nested_depth?
+        depth > 1
+      end
+
+      # @return [Boolean] Whether the RailLine context should be cleaned up
+      def self.cleanup?
+        depth <= 0
+      end
+    end
+  end
+end

data/lib/rail_line/result_do.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module RailLine
+  # Utilized for enabling RailLine functionality
+  #
+  # Use include RailLine::ResultDo or include RailLine::ResultDo[:method_name]
+  # to include handle_result functionality.
+  #
+  # @example
+  #   class MyService
+  #     include RailLine::ResultDo
+  #
+  #     def call
+  #       handle_result do
+  #         # Your service logic here
+  #         RailLine::Success.new(message: "It worked!")
+  #       end
+  #     end
+  #   end
+  module ResultDo
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # Enables the use of the automatic handling of results.
+    #
+    # @example
+    #   class MyAwesomeService
+    #     include RailLine::ResultDo[:call]
+    #
+    #     def call
+    #       # ...
+    #     end
+    #   end
+    #
+    # @param method_names [Array<Symbol>] The names of the methods to wrap.
+    # @return [Module] The module that wraps the methods.
+    def self.[](*method_names)
+      Module.new do
+        define_singleton_method(:included) do |base|
+          base.extend(RailLine::ResultDo::ClassMethods)
+
+          wrapped_methods = Module.new do
+            method_names.each do |method_name|
+              define_method(method_name) do |*args, **kwargs|
+                base.handle_result { super(*args, **kwargs) }
+              end
+            end
+          end
+
+          base.prepend(wrapped_methods)
+          base.singleton_class.prepend(wrapped_methods)
+        end
+      end
+    end
+
+    module ClassMethods
+      # @yield The block to execute
+      # @return [RailLine::Failure, RailLine::Success] The result of the block
+      def handle_result
+        ThreadContext.depth_increment
+
+        begin
+          handle_success(yield)
+        rescue RailLine::FailureError => exception
+          handle_failure(exception)
+        rescue StandardError => exception
+          handle_standard_error(exception)
+        ensure
+          handle_ensure
+        end
+      end
+
+      private
+
+      # @param result [RailLine::BaseResult] The result to handle
+      # @return [RailLine::Success] The result of the block
+      def handle_success(result)
+        return result if result.is_a?(RailLine::BaseResult)
+
+        RailLine::Success.new(payload: { return: result }, message: result.to_s)
+      end
+
+      # @param exception [RailLine::FailureError] The exception to handle
+      # @return [RailLine::Failure] The result of the block
+      def handle_failure(exception)
+        raise exception if ThreadContext.nested_depth?
+
+        exception.result
+      end
+
+      # @param exception [StandardError] The exception to handle
+      # @return [RailLine::Failure] The result of the block
+      def handle_standard_error(exception)
+        raise exception if ThreadContext.nested_depth?
+
+        message = if exception.message.empty? || exception.message == "StandardError"
+          "StandardError: No message"
+        else
+          exception.message
+        end
+
+        RailLine::Failure.new(
+          payload: {
+            exception:,
+            backtrace: exception.backtrace
+          },
+          message:,
+          raise_error: false
+        )
+      end
+
+      # Handles depth decrement and cleanup
+      def handle_ensure
+        ThreadContext.depth_decrement
+        ThreadContext.cleanup if ThreadContext.cleanup?
+      end
+    end
+
+    # @yield The block to execute
+    # @return [RailLine::Failure, RailLine::Success] The result of the block
+    def handle_result(&block)
+      self.class.handle_result(&block)
+    end
+  end
+end

data/lib/rail_line/success.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailLine
+  # Represents a Successful result
+  class Success < BaseResult
+    # @return [Boolean] Returns true
+    def success?
+      true
+    end
+  end
+end

data/lib/rail_line/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailLine
+  VERSION = "0.1.0"
+end

data/lib/rail_line.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "rail_line/version"
+require_relative "rail_line/failure_error"
+require_relative "rail_line/base_result"
+require_relative "rail_line/success"
+require_relative "rail_line/failure"
+require_relative "rail_line/result_do"
+require_relative "rail_line/result_do/thread_context"
+
+module RailLine
+end

data/sig/rail_line.rbs

@@ -0,0 +1,4 @@
+module RailLine
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: rail_line
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Frankel
+bindir: exe
+cert_chain: []
+date: 2025-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: Get your code in line. RailLine provides a simple interface forbasic
+  Railway Oriented Programming adapted for Ruby.
+email:
+- joshmfrankel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/rail_line.rb
+- lib/rail_line/base_result.rb
+- lib/rail_line/failure.rb
+- lib/rail_line/failure_error.rb
+- lib/rail_line/result_do.rb
+- lib/rail_line/result_do/thread_context.rb
+- lib/rail_line/success.rb
+- lib/rail_line/version.rb
+- sig/rail_line.rbs
+homepage: https://github.com/joshmfrankel/rail_line
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/joshmfrankel/rail_line
+  changelog_uri: https://github.com/joshmfrankel/rail_line/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A simple interface for basic Railway Oriented Programming in Ruby.
+test_files: []