active_act 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49bb1f2ed54517d7a8ec023f2540b55a7b4485abfd7b0d0d409ebe984def0cbe
-  data.tar.gz: 2f55526b80a98e5d280b61bf3318d5ad0bfa6fbf25408d038c96937e07ae938a
+  metadata.gz: f97bab53c823e61bd0c317974fab745a3a0a7d5f056ca6dd992cf5d4566f741f
+  data.tar.gz: 6fafffba84d21351f1a5db402986bb0675c269128c65ae4058cac08dcf54d848
 SHA512:
-  metadata.gz: 50da068f06e1de7293bb0bff4ae06cf9307b1fb3435524861964d1cc69b9c87253a06ff181543507972dac97bf53ea9e79ff8bdd22429e6abe0c840aed3a44f6
-  data.tar.gz: 6696376e521fe681cb52238515f146403330157ef7adffe459b8188126b492731150ab7f534cd354040584a1e873d016282bdd7fa596b9f9600630701881b829
+  metadata.gz: 7bf8afdad1c966dd28fc0a1468cb733e903368781736fbdd858944eb9a5136324a0cc016fcedf5e521533e255ecb904b30f78cee6264faa9d3a84697661f2837
+  data.tar.gz: ef9578a447f242e263d2bb69dec9355ee7965d6bd46d4a41d2d80178233d0785531a0fb97f47f4b0960514f60b2e00c3b2d35a693575a33a800535c67559677b

data/README.md

@@ -1,34 +1,119 @@
 # ActiveAct
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/active_act`. To experiment with that code, run `bin/console` for an interactive prompt.
+ActiveAct is a Rails Engine that introduces a standardized Action layer for your Rails applications. It provides a base class and generators to help you organize business logic in a clean, reusable way.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_act'
+```
 
-Install the gem and add to the application's Gemfile by executing:
+And then execute:
 
-```bash
-bundle add active_act
+```sh
+$ bundle install
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Run the install generator to set up the base structure:
 
-```bash
-gem install active_act
+```sh
+$ rails generate active_act:install
 ```
 
+This will create the `app/actions` directory and a base `application_action.rb` file.
+
 ## Usage
 
-TODO: Write usage instructions here
+### Creating a new Action
+
+You can manually create a new action by inheriting from `ApplicationAction`:
+
+```ruby
+# app/actions/send_welcome_email.rb
+class SendWelcomeEmail < ApplicationAction
+  def initialize(user)
+    @user = user
+  end
+
+  def call
+    # Your business logic here
+    UserMailer.welcome(@user).deliver_later
+  rescue => e
+    fail(e)
+  end
+end
+```
+
+Or, use the (upcoming) generator:
+
+```sh
+$ rails generate active_act:action SendWelcomeEmail
+```
+
+### Executing an Action
+
+You can call your action from anywhere in your app:
+
+```ruby
+SendWelcomeEmail.call(user)
+```
+
+## Base Action API
+
+The generated `ApplicationAction` provides:
+
+- `.call(*args, **kwargs, &block)`: Instantiates and runs the action.
+- `#call`: To be implemented in your subclass.
+- `#fail(error = nil)`: Raises an error to signal failure.
+
+## Example
+
+```ruby
+# app/actions/process_payment.rb
+class ProcessPayment < ApplicationAction
+  def initialize(order)
+    @order = order
+  end
+
+  def call
+    PaymentService.charge(@order)
+  rescue PaymentService::Error => e
+    fail(e)
+  end
+end
+
+# Usage:
+ProcessPayment.call(order)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/magdielcardoso/active_act.
 
-## Development
+## How to contribute
 
-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.
+1. Fork the repository: https://github.com/magdielcardoso/active_act
+2. Create a new branch for your feature or fix:
+   ```sh
+   git checkout -b my-feature
+   ```
+3. Make your changes, including tests if applicable.
+4. Run the test suite to ensure everything is working:
+   ```sh
+   bundle install
+   bundle exec rake spec
+   ```
+5. Commit your changes and push your branch:
+   ```sh
+   git add .
+   git commit -m "Describe your change"
+   git push origin my-feature
+   ```
+6. Open a Pull Request on GitHub and describe your contribution.
 
-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).
+Thank you for helping to improve ActiveAct!
 
 ## License
 

data/lib/active_act/version.rb

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

data/lib/generators/active_act/install/templates/application_action.rb

@@ -1,4 +1,16 @@
 # frozen_string_literal: true
 
+# Base class for all domain actions
 class ApplicationAction
+  def self.call(*args, **kwargs, &block)
+    new(*args, **kwargs, &block).call
+  end
+
+  def call
+    raise NotImplementedError, "You must implement the #call method in your action."
+  end
+
+  def fail(error = nil)
+    raise(error || "Action failed")
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_act
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Magdiel Cardoso
 bindir: exe
 cert_chain: []
-date: 2025-06-10 00:00:00.000000000 Z
+date: 2025-06-11 00:00:00.000000000 Z
 dependencies: []
 description: "Abstract spare methods from your controllers and models into actions
   in Ruby with Active Act \U0001F680"
@@ -24,6 +24,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- active_act-0.1.0.gem
 - app/actions/application_action.rb
 - lib/active_act.rb
 - lib/active_act/engine.rb