better_interactor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47df3c729fd268322b7e1c16ed660ee5390d2701766a3f2892bb6859186222bf
+  data.tar.gz: bce8bdc90bc8508170dc19fd3f610b2da2e6ec79e440c772209906624a34f84e
+SHA512:
+  metadata.gz: 57d31e2133e2801e2a03f2189f1e03133481d5ce1f7c27de5e1d2e044c0d101cec37a68f5f8b1eccbb9da3a32fd228592d189cb2e6b178cacf4a00432387a4ef
+  data.tar.gz: 3d43c73d5608b7d9b037254270df3f74bd1e475a5a5a1477b91aa87ad563b57e8f8c50301fa3d9204c5804ef464f5cd2af8170a76b920f7cdf90d46c7f203b23

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,115 @@
+# BetterInteractor
+
+Better Interactor is a gem that aims to extend the default usage for the [Interactor](https://github.com/collectiveidea/interactor) gem. The default Interactor usage is unchanged, extended with new possibilities:
+
+- adding a condition to your interactors, in the organizer, to skip its call, if that returns false
+- defining a default condition for each interactor call, in the organizer
+- [UNDER DEVELOPMENT] defining a method inside the organizer and call that instead of an organizer
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add better_interactor
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install better_interactor
+```
+
+## Usage
+
+### Conditional Call
+
+passing an hash instead of and interactor allows you to define 2 keys inside of it:
+
+- class: with the interactor class name
+- if: with a symbol with the same name as the method that responds to our condition
+
+``` ruby
+class PlaceOrder
+  include Interactor::Organizer
+
+  def should_send_thank_you?
+    context.client.is_a_good_client?
+  end
+
+  organize CreateOrder,
+           { class: ChargeCard }
+           { class: SendThankYou, if: :should_send_thank_you? }
+end
+```
+
+In this example:
+
+- CreateOrder will always be called, because you passed only the class
+- ChargeCard will always be called, because there's no "if"
+- SendThankYou will be called only if the method should_send_thank_you?, with the passed context, returns true
+
+### Default Condition
+
+This grants a default condition name for the method to call, defined as follows:
+"can_[interactor class name underscored]?"
+
+``` ruby
+class PlaceOrder
+  include Interactor::Organizer
+
+  def can_send_thank_you?
+    context.client.is_a_good_client?
+  end
+
+  organize CreateOrder,
+           { class: ChargeCard }
+           { class: SendThankYou }
+end
+```
+
+In this example:
+
+- CreateOrder will always be called, because you passed only the class
+- ChargeCard will always be called, because there's no method named **can_charge_card?**
+- SendThankYou will be called only if the method **can_send_thank_you?**, with the passed context, returns true
+
+**In case of Interactors inside of Modules (Client::SendThanksYou) the modules are included inside the method name (can_client_send_thanks_you?)**
+
+### Interactor-like method
+
+If you feel like an interactor, sometimes, is too much for a small non-reusable piece of logic, you can define a method
+and use it as an interactor, just pass a symbol with the method name as you would with a normal interactor
+
+``` ruby
+class PlaceOrder
+  include Interactor::Organizer
+
+  def create_order
+    Order.create(context.order_attr)
+  end
+
+  def send_thank_you
+    Email.new(to: context.client.email, content: "thanks :D")
+  end
+
+  organize :create_order,
+           { class: :send_thank_you }
+end
+```
+
+In this example we use 0 Interactors, and rely only on methods.
+
+**Conditional logic defined above still applies!!!**
+
+## Development
+
+Clone this repo, run bundle and you are good to go.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gimbardo/better_interactor.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/better_interactor/interactor.rb

@@ -0,0 +1,7 @@
+module Interactor
+  module ClassMethods
+    def default_condition_name
+      "can_#{self.name.underscore.gsub("/", "_")}?"
+    end
+  end
+end

data/lib/better_interactor/organizer.rb

@@ -0,0 +1,35 @@
+
+module Interactor
+  module Organizer
+    module InstanceMethods
+      # Internal: Invoke the organized Interactors. An Interactor::Organizer is
+      # expected not to define its own "#call" method in favor of this default
+      # implementation.
+      #
+      # Returns nothing.
+      def call
+        self.class.organized.each do |interactor|
+          handle_call(interactor) if should_call? interactor
+        end
+      end
+
+      def handle_call(interactor)
+        to_call = interactor.is_a?(Hash) ? interactor[:class] : interactor
+        to_call.is_a?(Symbol) ? send(to_call) : to_call.call!(context)
+      end
+
+      def should_call?(interactor)
+        if interactor.is_a?(Hash)
+          interactor[:if].nil? || send(interactor[:if])
+        else
+          condition = condition_for interactor
+          !respond_to?(condition) || send(condition)
+        end
+      end
+
+      def condition_for(interactor)
+        interactor.is_a?(Symbol) ? "can_#{interactor}}?" : interactor.default_condition_name
+      end
+    end
+  end
+end

data/lib/better_interactor/version.rb

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

data/lib/better_interactor.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "interactor"
+require "active_support/inflector"
+require_relative "better_interactor/version"
+require_relative "better_interactor/interactor"
+require_relative "better_interactor/organizer"

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: better_interactor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gamberi Elia
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: interactor-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+email:
+- me@gimbaro.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/better_interactor.rb
+- lib/better_interactor/interactor.rb
+- lib/better_interactor/organizer.rb
+- lib/better_interactor/version.rb
+homepage: https://gimbaro.dev
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://gimbaro.dev
+  source_code_uri: https://github.com/Gimbardo/better_interactor
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Better Interactor is a small gem that aims to improve a lot of stuff that
+  is missing in the main interactor gem
+test_files: []