action_man 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58b0715b75d357e16c37d7330d31a8350547f60e3d4f978f0ae2523b9416b3d3
+  data.tar.gz: 10115fc4353cacb4010a4598a4a3235cf9c6fdff234d609fc1181457bdc7a803
+SHA512:
+  metadata.gz: 4d16a79aac084ca498070fcec78bfc8500bb2b627d6cf060056d0e3024433b4f0b6622ce64e8f26c9f62352f8b93eb6bd9ce72a45af53146e5b80dcc32d37a20
+  data.tar.gz: ec417a86bf70edb7a154696750220a6ab86244cd3ec1a9a823a2d6547ebadb65c9d6d24aac02d6d9eb3edda6e7e65bab93a29fbfb88f671014f603ab8ecb5ac4

data/.editorconfig

@@ -0,0 +1,12 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+trim_trailing_whitespace = true

data/.envrc

@@ -0,0 +1 @@
+PATH_add bin

data/.rubocop.yml

@@ -0,0 +1,55 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+inherit_mode:
+  merge:
+    - Exclude
+    - Include
+    - Prefixes
+
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - "**/bin/**/*"
+    - "**/gemfiles/**/*"
+    - "**/Appraisals"
+  NewCops: enable
+  TargetRubyVersion: 3.1
+
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Metrics/ClassLength:
+  Enabled: false
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+Metrics/MethodLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+Metrics/ModuleLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+Minitest/MultipleAssertions:
+  Max: 5
+
+Style/Documentation:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [Unreleased]
+
+## [0.0.1] - 2023-10-10
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "activesupport"
+gem "minitest"
+gem "rake"
+gem "rubocop"
+gem "rubocop-minitest"
+gem "rubocop-rake"

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    action_man (0.0.1)
+      activesupport (>= 6.1, < 8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.0)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    bigdecimal (3.1.4)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    drb (2.1.1)
+      ruby2_keywords
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.20.0)
+    mutex_m (0.1.2)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rubocop (1.56.4)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-minitest (0.32.2)
+      rubocop (>= 1.39, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  action_man!
+  activesupport
+  minitest
+  rake
+  rubocop
+  rubocop-minitest
+  rubocop-rake
+
+BUNDLED WITH
+   2.4.20

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Javier Aranda
+
+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,40 @@
+# ActionMan
+
+![CI](https://github.com/javierav/action_man/workflows/CI/badge.svg)
+
+Simple actions for your models
+
+## Status
+
+> :warning: **This project is still experimental, use with caution!**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "action_man"
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+## Usage
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## License
+
+Copyright © 2023 Javier Aranda. Released under the terms of the [MIT license](LICENSE).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/action_man/base.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require "active_support/callbacks"
+require "active_support/core_ext/array/wrap"
+require_relative "not_executable"
+require_relative "result"
+
+module ActionMan
+  class Base
+    include ActiveSupport::Callbacks
+
+    RESULT_TYPES = %i[success failure].freeze
+
+    class_attribute :transaction, default: true
+    class_attribute :exception_if_not_executable, default: false
+
+    attr_reader :model, :args, :params, :result
+
+    define_callbacks :execute
+
+    class << self
+      def before(...)
+        set_callback(:execute, :before, ...)
+      end
+
+      def after(*filters, &)
+        set_options_for_callbacks!(filters)
+        set_callback(:execute, :after, *filters, &)
+      end
+
+      def after_success(*filters, &)
+        set_options_for_callbacks!(filters, on: :success)
+        set_callback(:execute, :after, *filters, &)
+      end
+
+      def after_failure(*filters, &)
+        set_options_for_callbacks!(filters, on: :failure)
+        set_callback(:execute, :after, *filters, &)
+      end
+
+      def param(name)
+        define_method(name) do
+          params[name]
+        end
+      end
+
+      def params(*names)
+        names.each { |name| param(name) }
+      end
+
+      def model(name)
+        define_method(name) do
+          model
+        end
+      end
+
+      private
+
+        def set_options_for_callbacks!(args, enforced_options={})
+          options = args.extract_options!.merge!(enforced_options)
+          args << options
+
+          return unless options[:on]
+
+          fire_on = Array.wrap(options[:on])
+          assert_valid_execute_on(fire_on)
+          options[:if] = [
+            -> { fire_on.any? { |on| on.to_sym == result.status.to_sym } },
+            *options[:if]
+          ]
+        end
+
+        def assert_valid_execute_on(actions)
+          return unless (actions - RESULT_TYPES).any?
+
+          raise ArgumentError, ":on conditions for after callbacks have to be one of #{RESULT_TYPES}"
+        end
+    end
+
+    def initialize(model)
+      @model = model
+      @params = {}
+    end
+
+    def executable?
+      true
+    end
+
+    def run(params={})
+      @params = params
+
+      if executable?
+        run_execute
+      elsif exception_if_not_executable
+        raise NotExecutable
+      else
+        Result.failure
+      end
+    end
+
+    private
+
+      def execute
+        raise NotImplementedError
+      end
+
+      def success!(params={})
+        throw :finish, Result.success(params:)
+      end
+
+      def failure!(errors={})
+        throw :finish, Result.failure(errors:)
+      end
+
+      def finish!(value)
+        value ? success! : failure!
+      end
+
+      def run_execute
+        with_transaction do
+          run_callbacks(:execute) do
+            run_with_catch
+          end
+        end
+
+        result
+      end
+
+      def with_transaction(&block)
+        if transaction && defined?(ActiveRecord::Base)
+          ActiveRecord::Base.transaction do
+            block.call
+
+            raise ActiveRecord::Rollback if result.failure?
+          end
+        else
+          block.call
+        end
+      end
+
+      def run_with_catch
+        response = catch :finish do
+          execute
+        end
+
+        @result = response.is_a?(Result) ? response : Result.success(output: response)
+      end
+  end
+end

data/lib/action_man/model.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActionMan
+  module Model
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def action(action_name, class_name=nil)
+        define_method(action_name) do |params|
+          (class_name || self.class.action_class(action_name)).constantize.new(self).run(params)
+        end
+
+        define_method("#{action_name}?") do
+          (class_name || self.class.action_class(action_name)).constantize.new(self).executable?
+        end
+      end
+
+      def action_class(action_name)
+        "#{name.pluralize}::#{action_name.to_s.camelcase}Action"
+      end
+    end
+  end
+end

data/lib/action_man/not_executable.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ActionMan
+  class NotExecutable < StandardError
+  end
+end

data/lib/action_man/result.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ActionMan
+  class Result
+    attr_reader :status, :params, :errors, :output
+
+    class << self
+      def success(params: {}, output: nil)
+        new(:success, params:, output:)
+      end
+
+      def failure(errors: {}, output: nil)
+        new(:failure, errors:, output:)
+      end
+    end
+
+    def initialize(status, params: {}, errors: {}, output: nil)
+      @status = status.to_sym
+      @params = params
+      @errors = errors
+      @output = output
+    end
+
+    def success?
+      @status == :success
+    end
+
+    def failure?
+      @status == :failure
+    end
+  end
+end

data/lib/action_man/version.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActionMan
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+
+  def self.version
+    VERSION::STRING
+  end
+
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+end

data/lib/action_man.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "action_man/base"
+require_relative "action_man/model"
+require_relative "action_man/version"
+
+module ActionMan
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: action_man
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Javier Aranda
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description:
+email:
+- aranda@hey.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".editorconfig"
+- ".envrc"
+- ".rubocop.yml"
+- ".tool-versions"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/action_man.rb
+- lib/action_man/base.rb
+- lib/action_man/model.rb
+- lib/action_man/not_executable.rb
+- lib/action_man/result.rb
+- lib/action_man/version.rb
+homepage: https://github.com/javierav/action_man
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/javierav/action_man
+  source_code_uri: https://github.com/javierav/action_man/tree/v0.0.1
+  changelog_uri: https://github.com/javierav/action_man/blob/v0.0.1/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options:
+- "--charset=UTF-8"
+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.4.10
+signing_key:
+specification_version: 4
+summary: Simple actions for your models
+test_files: []