yabi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1cfbcf34e0863ca1a9587e29490380dd2d29c684a798a93c7472b17ae23d3f65
+  data.tar.gz: eaa224344ee120279edec5a06c8c79ebf3ef8c2ee697199b7b03b36f14413bb1
+SHA512:
+  metadata.gz: 2f131d23e479a08122ef412c5187efa93878db7f5d78300e7239fdff3a52ac4637523438d419729f5ea8cf56ad0691e8250c1bbb9223f78fe50ebfe53d0950c9
+  data.tar.gz: 836db8ee15f1839b6d4644a9d74fa4a0896b5e34257153344abcc2718c87a4d64fd095a3b2d339f7e7c4ac383b5a4da985cc7be133daa85b5f5ea5c5821238fb

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.1.0 - 2026-02-05
+- Extracted BaseInteractor (formerly BaseService) into the YABI gem.
+- Added BaseContract wrapper and global shims (BaseInteractor/BaseService/BaseContract).
+- Switched contract attribute capture to `dry_initializer.attributes` with instance-variable fallback.
+- Removed bundled HTTP interactor (to drop Faraday dependency); README now includes an optional copy/paste example.
+- BaseContract now defaults to the I18n message backend and loads dry-validation translations.
+- Removed ActiveSupport dependency; internal helpers now handle symbolization and class-level contract accessors, reducing runtime deps.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Fortune Teller Team
+
+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,140 @@
+# YABI — Yet Another Base Interactor
+
+A tiny base class for service objects/interactors built on `dry-monads`, `dry-initializer`, and `dry-validation`, plus a minimal base contract.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'yabi', git: 'https://example.com/yabi.git'
+```
+
+Require the gem (Rails autoloading works too):
+
+```ruby
+require 'yabi'
+```
+
+By default the gem exposes `Yabi::BaseInteractor` plus shims `BaseInteractor` and `BaseService` (only defined if missing) to ease migration of existing code.
+
+## Usage
+
+```ruby
+class Users::Questions::Create < BaseInteractor
+  option :question_text
+
+  class ValidationContract < BaseContract
+    params { required(:question_text).filled(:string) }
+  end
+
+  def call
+    Success(question_text.upcase)
+  end
+end
+
+Users::Questions::Create.call(question_text: 'hello')
+# => Success(\"HELLO\")
+```
+
+### Contracts
+
+Pass a contract via the `contract:` keyword when calling, or define an inner `ValidationContract` constant. Validation runs before `call`; failures return `Failure(errors)`.
+
+YABI ships with `Yabi::BaseContract` (also available as `BaseContract`) which is a light wrapper around `Dry::Validation::Contract`. It uses the `:i18n` messages backend by default and loads the built‑in dry-validation translations. Customize it in your app if you want different load paths or locales:
+
+```ruby
+class ApplicationContract < Yabi::BaseContract
+  config.messages.default_locale = :es
+  config.messages.load_paths << Rails.root.join('config/locales/es.yml')
+end
+```
+
+### Error messages & I18n
+
+The gem ships an English locale file at `config/locales/en.yml` and loads it automatically. Errors raised inside YABI (e.g., for unexpected positional arguments) are translated via `I18n.t('yabi.errors.*')`. Override translations by adding your own locale files earlier in `I18n.load_path` or by setting `I18n.locale`.
+
+### Helpers
+
+- `safe_call { ... }` wraps a block into `Try` and returns a Result.
+- `in_transaction { ... }` delegates to `ActiveRecord::Base.transaction` when ActiveRecord is available.
+
+### Attribute capture
+
+`Yabi::BaseInteractor` uses `dry_initializer.attributes(self)` to collect declared options/params for validation instead of scraping every instance variable. This avoids leaking internal state while keeping compatibility with dry-initializer defaults. A fallback to the previous instance-variable scan remains for non-dry objects.
+
+## Example: HTTP request interactor (not included in the gem)
+
+The gem no longer ships an HTTP interactor to avoid adding Faraday as a runtime
+dependency. If you want one, you can copy/paste or adapt the example below.
+Remember to add Faraday (or your preferred adapter) to your own Gemfile.
+
+```ruby
+require 'faraday'
+require 'uri'
+
+class Integrations::Http::Requests::Make < BaseInteractor
+  option :http_method
+  option :url
+  option :request_params, default: -> { {} }
+  option :request_headers, default: -> { {} }
+  option :options, default: -> { {} }
+
+  class ValidationContract < BaseContract
+    params do
+      required(:http_method).filled(:string)
+      required(:url).filled(:string)
+      optional(:request_params)
+      optional(:request_headers)
+      optional(:options)
+    end
+
+    rule(:http_method) do
+      key.failure('is not a supported HTTP method') unless %w[get post put patch delete].include?(value.to_s.downcase)
+    end
+
+    rule(:url) do
+      key.failure('is not a valid URL') unless value.to_s.match?(URI::DEFAULT_PARSER.make_regexp)
+    end
+  end
+
+  def call
+    response = yield safe_call { faraday_client.public_send(http_method.to_sym, '', prepared_request_params) }
+    Success(response)
+  end
+
+  private
+
+  def faraday_client
+    Faraday.new(url:, headers: request_headers, **options) do |faraday|
+      faraday.request :url_encoded
+      faraday.adapter Faraday.default_adapter
+    end
+  end
+
+  def prepared_request_params
+    request_params.respond_to?(:to_h) ? request_params.to_h : request_params
+  end
+end
+
+Integrations::Http::Requests::Make.call(
+  http_method: 'get',
+  url: 'https://jsonplaceholder.typicode.com/posts/1'
+).either(
+  ->(response) { puts \"Success: #{response.status}\" },
+  ->(error)    { puts \"Error: #{error}\" }
+)
+```
+This interactor is only an example; include it in your own app if desired and add
+Faraday (or another HTTP client) to your dependencies.
+
+## Development
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+## License
+
+MIT

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  yabi:
+    errors:
+      unexpected_positional_arguments: "unexpected positional arguments: %{args}"

data/lib/yabi/base_contract.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'dry/validation'
+require 'i18n'
+
+module Yabi
+  # Opinionated base contract to share common Dry::Validation config.
+  # Adjust load paths / message backends in your host app initializer if needed.
+  class BaseContract < Dry::Validation::Contract
+    # example defaults; host app can override via subclassing
+    config.messages.backend = :i18n
+    config.messages.default_locale = :en
+    if defined?(Gem) && Gem.loaded_specs['dry-validation']
+      default_messages_path = File.join(Gem.loaded_specs['dry-validation'].full_gem_path, 'config', 'errors.yml')
+      config.messages.load_paths << default_messages_path if File.exist?(default_messages_path)
+    end
+  end
+end
+
+# Provide a global constant for easy migration.
+BaseContract = Yabi::BaseContract unless defined?(BaseContract)

data/lib/yabi/base_interactor.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'dry/monads/all'
+require 'dry/validation'
+require 'dry/initializer'
+require 'dry/matcher/result_matcher'
+module Yabi
+  # Base object for building service objects / interactors backed by dry-rb.
+  class BaseInteractor
+    include Dry::Monads[:result, :do, :try, :maybe]
+    extend Dry::Initializer
+
+    # Optional Dry::Validation::Contract subclass to run before #call.
+    class << self
+      attr_writer :contract
+
+      def inherited(subclass)
+        super
+        subclass.contract = contract
+      end
+
+      def contract
+        return @contract if defined?(@contract) && @contract
+
+        const_get(:ValidationContract) if const_defined?(:ValidationContract)
+      end
+    end
+
+    class << self
+      # Entrypoint. Instantiates, runs validation, then #call.
+      def call(*positional_args, contract: nil, **args, &block)
+        merged_args =
+          if positional_args.first.is_a?(Hash)
+            args.merge(positional_args.first)
+          elsif positional_args.any?
+            raise ArgumentError,
+                  I18n.t('yabi.errors.unexpected_positional_arguments', args: positional_args.inspect)
+          else
+            args
+          end
+
+        normalized_args = transform_values_to_hash(merged_args)
+        validation_contract = contract || self.contract
+
+        instance = new(**normalized_args)
+        validation = instance.validate_contract(validation_contract)
+        result = validation.success? ? instance.call : instance.log_warning_and_return_failure(validation)
+
+        return result unless block
+
+        Dry::Matcher::ResultMatcher.call(result, &block)
+      end
+
+      private
+
+      # Normalize params: convert ActionController::Parameters and other to_h-capable
+      # values, then deep-symbolize keys for dry-validation compatibility.
+      def transform_values_to_hash(args)
+        symbolized = args.transform_values do |value|
+          if value.respond_to?(:to_h) && !value.is_a?(Hash)
+            value.to_h
+          else
+            value
+          end
+        end
+        deep_symbolize_keys(symbolized)
+      end
+
+      def deep_symbolize_keys(obj)
+        case obj
+        when Hash
+          obj.each_with_object({}) do |(k, v), acc|
+            acc[k.to_sym] = deep_symbolize_keys(v)
+          end
+        when Array
+          obj.map { |v| deep_symbolize_keys(v) }
+        else
+          obj
+        end
+      end
+    end
+
+    # Run validation if a contract is provided; return Success() on skip.
+    def validate_contract(validation_contract)
+      return Success() unless validation_contract
+
+      validation_contract.new.call(**attributes_for_contract)
+    end
+
+    # Hook for app-specific logging; override to plug in your logger.
+    def log_warning_and_return_failure(validation)
+      # LoggerService.call(message: "Validation failed: #{validation.errors.inspect}", level: :warn)
+      errors = validation.respond_to?(:errors) ? validation.errors : validation
+      errors = errors.to_h if errors.respond_to?(:to_h)
+      Failure(errors)
+    end
+
+    # Implement in subclasses.
+    def call
+      raise NotImplementedError
+    end
+
+    # Convenience wrapper; no-op if ActiveRecord is missing.
+    def in_transaction(&)
+      ActiveRecord::Base.transaction(&)
+    end
+
+    # Wrap a block in Try and convert to Result with optional handlers.
+    def safe_call(on_success: ->(s) { Success(s) }, on_error: ->(e) { Failure(e) }, &)
+      Try(&).to_result.either(on_success, on_error)
+    end
+
+    private
+
+    # Uses dry-initializer metadata to capture declared options/params rather than
+    # every instance variable (which may include internal ones).
+    def attributes_for_contract
+      return self.class.dry_initializer.attributes(self) if self.class.respond_to?(:dry_initializer)
+
+      fallback_instance_variables_hash
+    end
+
+    def fallback_instance_variables_hash
+      instance_variables.each_with_object({}) do |var, hash|
+        key = var.to_s.delete('@').to_sym
+        hash[key] = instance_variable_get(var)
+      end
+    end
+  end
+end

data/lib/yabi/base_service.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'base_interactor'
+
+module Yabi
+  # Backwards compatibility wrapper. Prefer Yabi::BaseInteractor.
+  BaseService = BaseInteractor
+end
+
+BaseService = Yabi::BaseService unless defined?(BaseService)

data/lib/yabi/version.rb

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

data/lib/yabi.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'yabi/version'
+require_relative 'yabi/base_interactor'
+require_relative 'yabi/base_contract'
+require_relative 'yabi/base_service'
+
+require 'i18n'
+
+# Load bundled translations for error messages.
+YABI_LOCALE_PATH = File.expand_path('../config/locales/en.yml', __dir__)
+unless I18n.load_path.include?(YABI_LOCALE_PATH)
+  I18n.load_path << YABI_LOCALE_PATH
+  I18n.backend.load_translations
+end
+
+module Yabi
+end
+
+# Provide global constants for easier adoption in existing Rails apps.
+BaseInteractor = Yabi::BaseInteractor unless defined?(BaseInteractor)
+
+# Backwards compatibility shim for legacy code using BaseService naming.
+BaseService = Yabi::BaseInteractor unless defined?(BaseService)

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: yabi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nikkie Grom
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: dry-matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.66'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.66'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.30'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.29'
+description: A small dry-rb-based base service/interactor with optional contract validation.
+email:
+- nikkie@nikkie.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- config/locales/en.yml
+- lib/yabi.rb
+- lib/yabi/base_contract.rb
+- lib/yabi/base_interactor.rb
+- lib/yabi/base_service.rb
+- lib/yabi/version.rb
+homepage: https://github.com/theendcomplete/yabi
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Yet Another Base Interactor
+test_files: []