rwc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce1d3bb1432f4f7649493b3375e1b4e5e324c1cabb11ea5027993352d46d13a5
+  data.tar.gz: cabc69a6e3ad53158220ed03ddbc8e3e1547df18cb23a2f2bf5322351472d169
+SHA512:
+  metadata.gz: 4deb613f2ccb4e672da2e6b92d8754f194d69712f990dba8cf7bc2f2b978116b28945a277f3fcb20b2dfdc6d52473d4c8112c265d4d0a83cfa9d44fadc811ac9
+  data.tar.gz: a735528f5941b9d0a473de7bfc6c42b29171ef822ec4bb7b4a96fb9366077591cf5a3db8e774c3c93d0371b393a793ed65f482f3dc228b1c2bb3469bcb4ce767

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-02-18
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 hasstrup.ezekiel@gmail.com. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+
+# RwC (Rails with Context!)
+
+This gem helps with generating services, inputs, decorators for Context-Based Rails Applications - A hexagonal way to build rails applications. Wrote about this [here](https://medium.com/@HasstrupEzekiel/context-based-programming-in-rails-0ce951a59c36). 
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rwc'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rwc
+
+## Usage
+
+```bash
+  # generating services
+  rails generate rwc:service AnExampleService
+
+  # generating inputs
+  rails generate rwc:input AnExampleInput::WithNameSpace
+
+  # generating decorators
+  rails generate rwc:decorator AnExampleDecorator::WithDecorators
+```
+
+## 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](https://github.com/hasstrup/rwc). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RwC project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](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/generators/rwc/decorator/decorator_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Rwc
+  class DecoratorGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("../templates", __dir__)
+
+    def create_decorator_file
+      template "decorator.rb.tt", "app/decorators/#{class_name.underscore}.rb"
+    end
+  end
+end

data/lib/generators/rwc/input/input_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Rwc
+  class InputGenerator < Rails::Generators::NamedBase
+    QUERY_TYPE = "query"
+    source_root File.expand_path("../templates", __dir__)
+
+    class_option :input_type, type: :string, default: "base",
+                              desc: "One of query/create"
+
+    def create_input_file
+      source = query_input? ? "query_input.rb.tt" : "create_input.rb.tt"
+      template(source, "app/inputs/#{class_name.underscore}.rb")
+    end
+
+    private
+
+    def query_input?
+      class_name.downcase.include?(QUERY_TYPE) || options[:input_type] == QUERY_TYPE
+    end
+  end
+end

data/lib/generators/rwc/service/service_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Rwc
+  class ServiceGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path("../templates", __dir__)
+
+    def create_service_file
+      template "service.rb.tt", "app/services/#{class_name.underscore}.rb"
+    end
+  end
+end
+
+# end

data/lib/generators/rwc/templates/create_input.rb.tt

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class <%= class_name %> < Rwc::Core::BaseInput
+  # define service body here
+  REQUIRED_KEYS = []
+  attributes()
+  
+  def validate!
+   # define validation rules here
+  end
+end

data/lib/generators/rwc/templates/decorator.rb.tt

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class <%= class_name %> < Rwc::Core::BaseDecorator
+  delegate_all
+end

data/lib/generators/rwc/templates/query_input.rb.tt

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class <%= class_name %> < Rwc::Core::Queries::SimpleInput
+  # uncomment next line
+  # input_for #SampleClass
+end

data/lib/generators/rwc/templates/service.rb.tt

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class <%= class_name %> < Rwc::Core::BaseService
+  performs_checks
+
+  def initialize(input:)
+    @input = input
+  end
+
+  def call
+    safely_execute do
+      # logic goes in here
+    end
+  end
+
+  private
+
+  attr_reader :input
+end

data/lib/rwc/concerns/error_handling.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "active_record"
+
+# The ErrorHandling module provides mechanisms for managing errors
+# within service classes. It includes methods for safely executing
+# blocks of code and handling known error classes.
+module Rwc
+  module Concerns
+    module ErrorHandling
+      class InvalidInputError < StandardError; end
+      class ServiceError < StandardError; end
+
+      module Core
+        # A list of error classes that can be rescued during safe execution.
+        ERROR_CLASSES = [
+          ActiveRecord::RecordNotFound,
+          ActiveRecord::RecordInvalid,
+          ActiveModel::UnknownAttributeError,
+          ActiveRecord::StatementInvalid,
+          InvalidInputError,
+          ServiceError
+        ].freeze
+
+        # Safely executes a block of code, running checks if needed.
+        #
+        # @yield [void] The block of code to execute.
+        # @return [Context] The context after execution.
+        def safely_execute(&block)
+          run_checks! if should_run_checks?
+          block.call
+          context
+        rescue *ERROR_CLASSES => e
+          fail!(error: e)
+        end
+
+        # Runs input validation checks. Must be implemented by the including class.
+        #
+        # @raise [NotImplementedError] When not implemented in a subclass.
+        def run_checks!
+          raise InvalidInputError, input.errors.flat_map(&:message) unless input.valid?
+        end
+      end
+
+      module Validatable
+        module ClassMethods
+          # Indicates that checks should be performed on input validation.
+          #
+          # @return [void]
+          def performs_checks
+            @should_run_checks = true
+          end
+
+          attr_reader :should_run_checks
+        end
+
+        # Checks if validation checks should be performed.
+        #
+        # @return [Boolean] True if checks should be performed; otherwise, false.
+        def should_run_checks?
+          self.class.should_run_checks
+        end
+
+        # Includes core error handling functionality and class methods.
+        #
+        # @param [Class] base The class to include the module in.
+        def self.included(base)
+          base.include(Core)
+          base.extend(ClassMethods)
+        end
+
+        # Raises a service error with the specified message.
+        #
+        # @param [String] message The error message to raise.
+        # @raise [BaseService::ServiceError] The raised error.
+        def raise_error!(message)
+          raise ServiceError, message
+        end
+      end
+    end
+  end
+end

data/lib/rwc/concerns/validation.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Rwc
+  module Concerns
+      # Provides validation methods for input classes.
+module Validation
+  # Checks if the input is valid by running validations.
+  #
+  # @return [Boolean] True if valid; otherwise, false.
+  def valid?
+    validate!
+    errors.empty?
+  end
+
+  # Validates the input. Must be implemented by including class.
+  #
+  # @raise [NotImplementedError] If not implemented.
+  def validate!
+    raise NotImplementedError
+  end
+
+  private
+
+  # Pipes an error into the errors array.
+  #
+  # @param [StandardError] error The error to be added.
+  def pipe_error(error)
+    @errors << error
+  end
+
+  # Validates the presence of a given key in the input.
+  #
+  # @param [Symbol] key The key to validate.
+  def validate_presence_of(key)
+    pipe_error(BaseInput::InputValidationError.new("#{key} is missing")) if input.send(key).blank?
+  end
+
+  # Creates an error with a specified message.
+  #
+  # @param [String] message The error message.
+  # @return [BaseInput::InputValidationError] The generated error.
+  def error(message)
+    BaseInput::InputValidationError.new(message)
+  end
+
+  # Validates polymorphic associations based on type and ID.
+  #
+  # @param [String] type The type of the association.
+  # @param [Integer] id The ID of the associated record.
+  # @param [Boolean] conditional Optional. If true, skips validation if id is blank.
+  def validate_polymorphic_association!(type, id, conditional: false)
+    within_error_context do
+      return if conditional && id.blank?
+
+      pipe_error(relation_not_found_error(type, id)) unless type.constantize.find_by(id:)
+    rescue NameError
+      pipe_error(invalid_type_error(type))
+    end
+  end
+
+  # Validates an association by checking its existence.
+  #
+  # @param [Integer] id The ID of the associated record.
+  # @param [Class] klass The class of the association.
+  # @param [Boolean] conditional Optional. If true, skips validation if id is blank.
+  def validate_association!(id, klass, conditional: false)
+    within_error_context do
+      return if conditional && id.blank?
+
+      pipe_error(relation_not_found_error(klass.to_s, id)) unless klass.exists?(id:)
+    end
+  end
+
+  # Validates the existence of a record associated with the input.
+  #
+  # @raise [BaseInput::InputValidationError] If validation fails.
+  def validate_record!
+    within_error_context do
+      validate_association!(id, self.class.target) if id
+    end
+  end
+
+  # Validates required keys for the input.
+  #
+  # @raise [BaseInput::InputValidationError] If any required keys are missing.
+  def validate_required_keys!
+    within_error_context do
+      self.class::REQUIRED_KEYS.each do |key|
+        validate_presence_of(key)
+      end
+    end
+  end
+
+  # Validates the ownership of a record by a user.
+  #
+  # @param [ActiveRecord::Base] record The record to check ownership against.
+  # @param [Integer] user_id The ID of the user to validate ownership.
+  def validate_ownership!(record, user_id)
+    within_error_context do
+      pipe_error(restricted_access_error) unless owner_for(record)&.id == user_id
+    end
+  end
+
+  # Executes a block if there are no errors.
+  #
+  # @yield The block to execute.
+  def within_error_context(&block)
+    block.call if errors.empty?
+  end
+
+  # Collates errors from specified keys into the errors array.
+  #
+  # @param [Array<Symbol>] keys The keys to collate errors for.
+  def collate_errors_for(*keys)
+    keys.each do |key|
+      within_error_context do
+        target = send(key)
+        next @errors += target.errors if target.respond_to?(:valid?) && !target.valid?
+
+        target.each do |node|
+          within_error_context do
+            @errors += node.errors unless node.valid?
+          end
+        end
+      end
+    end
+  end
+
+  # Generates an error for an invalid association type.
+  #
+  # @param [String] type The invalid type.
+  # @return [BaseInput::InputValidationError] The generated error.
+  def invalid_type_error(type)
+    BaseInput::InputValidationError.new("Invalid association type: #{type.capitalize}")
+  end
+
+  # Generates an error when a relation cannot be found.
+  #
+  # @param [String] type The type of the relation.
+  # @param [Integer] id The ID of the relation.
+  # @return [BaseInput::InputValidationError] The generated error.
+  def relation_not_found_error(type, id)
+    BaseInput::InputValidationError.new("Could not find any '#{type.capitalize}' with id: #{id}")
+  end
+
+  # Generates an error for restricted access.
+  #
+  # @return [BaseInput::InputValidationError] The generated error.
+  def restricted_access_error
+    BaseInput::InputValidationError.new('Unauthorized access')
+  end
+
+  # Generates an error for a missing field.
+  #
+  # @param [Symbol] field The missing field.
+  # @return [BaseInput::InputValidationError] The generated error.
+  def missing_field_error(field)
+    BaseInput::InputValidationError.new("#{field} is missing")
+  end
+  end
+    end
+  end
+

data/lib/rwc/core/base_decorator.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module Rwc
+  module Core
+    class BaseDecorator
+      attr_accessor :context
+      attr_reader :object
+
+      def initialize(object, opts = {})
+        @object = object
+        @context = OpenStruct.new(**opts)
+      end
+
+      protected
+
+      attr_reader :extra
+
+      class << self
+        def decorate_collection(collection:, opts: {})
+          collection.map { |object| new(object, opts) }
+        end
+
+        def delegate_all
+          define_method(:method_missing) do |method_name, *args|
+            return object.send(method_name, *args) if object.respond_to?(method_name)
+
+            super(method_name, *args)
+          end
+        end
+
+        def include_in_json(*methods)
+          define_method(:as_json) do |*args|
+            included_hash = methods.index_with do |method|
+              send(method)
+            end
+            object.send(:as_json, *args).merge(included_hash)
+          end
+        end
+
+        def decorate(relation, context: {})
+          new(relation, context)
+        end
+
+        protected
+
+        def auto_delegate(*methods)
+          delegate(*methods, to: :object)
+        end
+      end
+    end
+  end
+end

data/lib/rwc/core/base_input.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative "concerns/validation"
+require "ostruct"
+
+module Rwc
+  module Core
+    # Represents a base input class for handling and validating input data.
+    class BaseInput
+      class InputValidationError < StandardError; end
+
+      include Concerns::Validation
+
+      class << self
+        attr_reader :fields, :target
+
+        # Defines the attributes that the input class can accept.
+        #
+        # @param [Symbol] args The attributes to be defined for the input.
+        def attributes(*args)
+          @fields = args
+        end
+
+        # Specifies the target class for polymorphic associations.
+        #
+        # @param [Class] target_klass The target class for validation.
+        def input_for(target_klass)
+          @target = target_klass
+        end
+      end
+
+      attr_reader :errors
+
+      # Initializes a new BaseInput instance.
+      #
+      # @param [Hash] kwargs The keyword arguments for the input.
+      # @option kwargs [Object] :context Additional context for the input validation.
+      def initialize(**kwargs)
+        @input = OpenStruct.new(**kwargs.except(:context))
+        @context = kwargs[:context]
+        @valid = false
+        @errors = []
+      end
+
+      # Returns human-readable error messages from the errors array.
+      #
+      # @return [String] The humanized error messages.
+      def humanized_error_messages
+        errors.map(&:message).join(", ")
+      end
+
+      # Delegates method calls to the input object.
+      #
+      # @param [Symbol] name The method name to be called.
+      # @param [Array] _args The arguments to be passed to the method.
+      # @return [Object] The result of the method call on the input object.
+      def method_missing(name, *_args)
+        input.send(name)
+      end
+
+      # Checks if the method is respondable based on defined attributes.
+      #
+      # @param [Symbol] name The method name.
+      # @param [Boolean] _include_private Whether to include private methods.
+      # @return [Boolean] True if the method is respondable; otherwise, false.
+      def respond_to_missing?(name, _include_private = false)
+        self.class.attributes.include?(name)
+      end
+
+      # Fetches a value from the input as a hash.
+      #
+      # @param [Array] args The keys to fetch values for.
+      # @return [Object] The fetched value.
+      def fetch(*args)
+        to_h.fetch(*args)
+      end
+
+      # Slices the input to return only specified keys.
+      #
+      # @param [Array] args The keys to slice from the input.
+      # @return [Hash] A hash containing only the specified keys.
+      def slice(*args)
+        to_h.slice(*args)
+      end
+
+      def to_h(*args)
+        input.to_h(*args)
+      end
+
+      private
+
+      attr_reader :input, :valid, :context
+    end
+  end
+end

data/lib/rwc/core/base_service.rb

@@ -0,0 +1,41 @@
+require_relative "context"
+require_relative "concerns/error_handling"
+
+# BaseService serves as a foundational class for creating service objects
+# in the application. It provides a standardized interface for service calls
+# and integrates error handling mechanisms.
+module Rwc
+  module Core
+    class BaseService
+      include Concerns::ErrorHandling::Validatable
+
+      # Calls the service with the provided keyword arguments.
+      #
+      # @param [Hash] kwargs The keyword arguments to be passed to the service.
+      # @return [Object] The result of the service call.
+      def self.call(**kwargs)
+        new(**kwargs).call
+      end
+
+      # Executes the service logic. Must be implemented in subclasses.
+      #
+      # @raise [NotImplementedError] When not implemented in a subclass.
+      def call
+        raise NotImplementedError
+      end
+
+      delegate :fail!, :succeed, to: :context
+
+      private
+
+      attr_reader :input
+
+      # Initializes the context for the service.
+      #
+      # @return [Context] The service context.
+      def context
+        @context ||= Context.new
+      end
+    end
+  end
+end

data/lib/rwc/core/concerns/error_handling.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "active_record"
+
+# The ErrorHandling module provides mechanisms for managing errors
+# within service classes. It includes methods for safely executing
+# blocks of code and handling known error classes.
+module Rwc
+  module Core
+    module Concerns
+      module ErrorHandling
+        class InvalidInputError < StandardError; end
+        class ServiceError < StandardError; end
+
+        module Core
+          # A list of error classes that can be rescued during safe execution.
+          ERROR_CLASSES = [
+            ActiveRecord::RecordNotFound,
+            ActiveRecord::RecordInvalid,
+            ActiveModel::UnknownAttributeError,
+            ActiveRecord::StatementInvalid,
+            InvalidInputError,
+            ServiceError
+          ].freeze
+
+          # Safely executes a block of code, running checks if needed.
+          #
+          # @yield [void] The block of code to execute.
+          # @return [Context] The context after execution.
+          def safely_execute(&block)
+            run_checks! if should_run_checks?
+            block.call
+            context
+          rescue *ERROR_CLASSES => e
+            fail!(error: e)
+          end
+
+          # Runs input validation checks. Must be implemented by the including class.
+          #
+          # @raise [NotImplementedError] When not implemented in a subclass.
+          def run_checks!
+            raise InvalidInputError, input.errors.flat_map(&:message) unless input.valid?
+          end
+        end
+
+        module Validatable
+          module ClassMethods
+            # Indicates that checks should be performed on input validation.
+            #
+            # @return [void]
+            def performs_checks
+              @should_run_checks = true
+            end
+
+            attr_reader :should_run_checks
+          end
+
+          # Checks if validation checks should be performed.
+          #
+          # @return [Boolean] True if checks should be performed; otherwise, false.
+          def should_run_checks?
+            self.class.should_run_checks
+          end
+
+          # Includes core error handling functionality and class methods.
+          #
+          # @param [Class] base The class to include the module in.
+          def self.included(base)
+            base.include(Core)
+            base.extend(ClassMethods)
+          end
+
+          # Raises a service error with the specified message.
+          #
+          # @param [String] message The error message to raise.
+          # @raise [BaseService::ServiceError] The raised error.
+          def raise_error!(message)
+            raise ServiceError, message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rwc/core/concerns/validation.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module Rwc
+  module Core
+    module Concerns
+      # Provides validation methods for input classes.
+      module Validation
+        # Checks if the input is valid by running validations.
+        #
+        # @return [Boolean] True if valid; otherwise, false.
+        def valid?
+          validate!
+          errors.empty?
+        end
+
+        # Validates the input. Must be implemented by including class.
+        #
+        # @raise [NotImplementedError] If not implemented.
+        def validate!
+          raise NotImplementedError
+        end
+
+        private
+
+        # Pipes an error into the errors array.
+        #
+        # @param [StandardError] error The error to be added.
+        def pipe_error(error)
+          @errors << error
+        end
+
+        # Validates the presence of a given key in the input.
+        #
+        # @param [Symbol] key The key to validate.
+        def validate_presence_of(key)
+          pipe_error(BaseInput::InputValidationError.new("#{key} is missing")) if input.send(key).blank?
+        end
+
+        # Creates an error with a specified message.
+        #
+        # @param [String] message The error message.
+        # @return [BaseInput::InputValidationError] The generated error.
+        def error(message)
+          BaseInput::InputValidationError.new(message)
+        end
+
+        # Validates polymorphic associations based on type and ID.
+        #
+        # @param [String] type The type of the association.
+        # @param [Integer] id The ID of the associated record.
+        # @param [Boolean] conditional Optional. If true, skips validation if id is blank.
+        def validate_polymorphic_association!(type, id, conditional: false)
+          within_error_context do
+            return if conditional && id.blank?
+
+            pipe_error(relation_not_found_error(type, id)) unless type.constantize.find_by(id: id)
+          rescue NameError
+            pipe_error(invalid_type_error(type))
+          end
+        end
+
+        # Validates an association by checking its existence.
+        #
+        # @param [Integer] id The ID of the associated record.
+        # @param [Class] klass The class of the association.
+        # @param [Boolean] conditional Optional. If true, skips validation if id is blank.
+        def validate_association!(id, klass, conditional: false)
+          within_error_context do
+            return if conditional && id.blank?
+
+            pipe_error(relation_not_found_error(klass.to_s, id)) unless klass.exists?(id: id)
+          end
+        end
+
+        # Validates the existence of a record associated with the input.
+        #
+        # @raise [BaseInput::InputValidationError] If validation fails.
+        def validate_record!
+          within_error_context do
+            validate_association!(id, self.class.target) if id
+          end
+        end
+
+        # Validates required keys for the input.
+        #
+        # @raise [BaseInput::InputValidationError] If any required keys are missing.
+        def validate_required_keys!
+          within_error_context do
+            self.class::REQUIRED_KEYS.each do |key|
+              validate_presence_of(key)
+            end
+          end
+        end
+
+        # Validates the ownership of a record by a user.
+        #
+        # @param [ActiveRecord::Base] record The record to check ownership against.
+        # @param [Integer] user_id The ID of the user to validate ownership.
+        def validate_ownership!(record, user_id)
+          within_error_context do
+            pipe_error(restricted_access_error) unless owner_for(record)&.id == user_id
+          end
+        end
+
+        # Executes a block if there are no errors.
+        #
+        # @yield The block to execute.
+        def within_error_context(&block)
+          block.call if errors.empty?
+        end
+
+        # Collates errors from specified keys into the errors array.
+        #
+        # @param [Array<Symbol>] keys The keys to collate errors for.
+        def collate_errors_for(*keys)
+          keys.each do |key|
+            within_error_context do
+              target = send(key)
+              next @errors += target.errors if target.respond_to?(:valid?) && !target.valid?
+
+              target.each do |node|
+                within_error_context do
+                  @errors += node.errors unless node.valid?
+                end
+              end
+            end
+          end
+        end
+
+        # Generates an error for an invalid association type.
+        #
+        # @param [String] type The invalid type.
+        # @return [BaseInput::InputValidationError] The generated error.
+        def invalid_type_error(type)
+          BaseInput::InputValidationError.new("Invalid association type: #{type.capitalize}")
+        end
+
+        # Generates an error when a relation cannot be found.
+        #
+        # @param [String] type The type of the relation.
+        # @param [Integer] id The ID of the relation.
+        # @return [BaseInput::InputValidationError] The generated error.
+        def relation_not_found_error(type, id)
+          BaseInput::InputValidationError.new("Could not find any '#{type.capitalize}' with id: #{id}")
+        end
+
+        # Generates an error for restricted access.
+        #
+        # @return [BaseInput::InputValidationError] The generated error.
+        def restricted_access_error
+          BaseInput::InputValidationError.new("Unauthorized access")
+        end
+
+        # Generates an error for a missing field.
+        #
+        # @param [Symbol] field The missing field.
+        # @return [BaseInput::InputValidationError] The generated error.
+        def missing_field_error(field)
+          BaseInput::InputValidationError.new("#{field} is missing")
+        end
+      end
+    end
+  end
+end

data/lib/rwc/core/context.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Rwc
+  # The Context class is used to encapsulate the result of a service operation,
+  # holding information about success, errors, messages, and any relevant payload.
+  module Core
+    class Context
+      attr_reader :success, :errors, :messages, :payload
+
+      # Initializes a new Context instance.
+      #
+      # @return [void]
+      def initialize
+        @success = true
+        @errors = []
+        @messages = []
+      end
+
+      # Marks the context as failed, recording the provided error.
+      #
+      # @param [StandardError] error The error that caused the failure.
+      # @return [Context] The current context instance.
+      def fail!(error:)
+        @success = false
+        @errors = [error]
+
+        self
+      end
+
+      # Marks the context as successful, optionally providing a payload.
+      #
+      # @param [Object] payload The payload to be returned on success (default is nil).
+      # @return [Context] The current context instance.
+      def succeed(payload = nil)
+        clear_errors
+        @success = true
+        @payload = payload
+
+        self
+      end
+
+      # Sets the payload and clears any errors.
+      #
+      # @param [Object] payload The payload to set.
+      # @return [Context] The current context instance.
+      def payload!(payload:)
+        @errors = []
+        @payload = payload
+      end
+
+      # Checks if the operation was successful.
+      #
+      # @return [Boolean] True if the operation was successful; otherwise, false.
+      def success?
+        @success
+      end
+
+      # Returns a message string, combining messages or errors based on success state.
+      #
+      # @return [String] The combined success messages or error messages.
+      def message
+        success ? messages.join(", ") : errors.map(&:message).join(", ")
+      end
+
+      private
+
+      # Clears the recorded errors in the context.
+      #
+      # @return [void]
+      def clear_errors
+        @errors = []
+      end
+    end
+  end
+end

data/lib/rwc/core/queries/simple_input.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Rwc
+  module Queries
+    class SimpleInput
+      attr_reader :params
+
+      class << self
+        attr_reader :target_klass
+
+        def input_for(klass)
+          @target_klass = klass
+        end
+      end
+
+      def initialize(fields:, type: :group, **context)
+        @params = fields
+        @type = type
+        @_context = context || {}
+      end
+
+      def conditions
+        params.slice(*valid_fields)
+      end
+
+      def includes
+        params.dig(:includes)&.map(&:to_sym) & valid_includes
+      end
+
+      def context
+        @context ||= OpenStruct.new(**@_context)
+      end
+
+      def sanitize!
+        # for now just remove nil keys
+        params.compact!
+        self
+      end
+
+      def single?
+        type == :single
+      end
+
+      def __raw__
+        OpenStruct.new(**params)
+      end
+
+      private
+
+      attr_reader :type
+
+      def valid_fields
+        self.class.target_klass.attribute_names.map(&:to_sym)
+      end
+
+      def valid_includes
+        self.class.target_klass.reflect_on_all_associations.map(&:name)
+      end
+    end
+  end
+end

data/lib/rwc/version.rb

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

data/lib/rwc.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "rwc/version"
+require_relative "rwc/core/base_decorator"
+require_relative "rwc/core/base_input"
+require_relative "rwc/core/base_service"
+module Rwc
+  # Your code goes here...
+end

data/rwc.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/rwc/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rwc"
+  spec.version = Rwc::VERSION
+  spec.authors = ["Haldane Engineering"]
+  spec.email = ["hasstrup.ezekiel@gmail.com"]
+
+  spec.summary = "A gem for scaffolding Context-based rails application components."
+  spec.description = "https://medium.com/@HasstrupEzekiel/context-based-programming-in-rails-0ce951a59c36"
+  spec.homepage = "https://haldaneengineering.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+
+  spec.add_dependency "rails", ">= 6.0"
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/rwc.rbs

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

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: rwc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Haldane Engineering
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: https://medium.com/@HasstrupEzekiel/context-based-programming-in-rails-0ce951a59c36
+email:
+- hasstrup.ezekiel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/rwc/decorator/decorator_generator.rb
+- lib/generators/rwc/input/input_generator.rb
+- lib/generators/rwc/service/service_generator.rb
+- lib/generators/rwc/templates/create_input.rb.tt
+- lib/generators/rwc/templates/decorator.rb.tt
+- lib/generators/rwc/templates/query_input.rb.tt
+- lib/generators/rwc/templates/service.rb.tt
+- lib/rwc.rb
+- lib/rwc/concerns/error_handling.rb
+- lib/rwc/concerns/validation.rb
+- lib/rwc/core/base_decorator.rb
+- lib/rwc/core/base_input.rb
+- lib/rwc/core/base_service.rb
+- lib/rwc/core/concerns/error_handling.rb
+- lib/rwc/core/concerns/validation.rb
+- lib/rwc/core/context.rb
+- lib/rwc/core/queries/simple_input.rb
+- lib/rwc/version.rb
+- rwc.gemspec
+- sig/rwc.rbs
+homepage: https://haldaneengineering.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://haldaneengineering.com
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: A gem for scaffolding Context-based rails application components.
+test_files: []