rails-active_action 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ad3a261e2b61e68548d91595e457626e33e5f1403352606b77ae42e9e049152
+  data.tar.gz: 185ae1a5afcc71ce2ed79d7d6d756f8822c0e056a87e8b799fc668783a005f46
+SHA512:
+  metadata.gz: f6436c19c114ad50c6849d91dee2d7fee62a785aa5963d0ca7ca510d7e79f26da4db2c41c6ee836462a43cee3f1d7754d3913dd12263bf73210b22bdc026df47
+  data.tar.gz: 2379e06a68a31caa19c43a90ace2e1bfe9d2422acdf5e9c058898d4cbf04a250741ede94b7b4ea9ca75ab9f9b16e9a30f46d511530d24726292b65062e941a5e

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at lukasz.sliwa@apptamers.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'activesupport', '~> 3.0.0'
+gem 'i18n', '~> 1.8.9'
+
+group :test do
+  gem 'rake', '~> 12.0'
+  gem 'rspec', '~> 3.0'
+end

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    rails-active_action (3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.0.20)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.0.0)
+  i18n (~> 1.8.9)
+  rails-active_action!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Łukasz Śliwa (lukasz.sliwa@apptamers.com)
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Łukasz Śliwa (lukasz.sliwa@apptamers.com)
+
+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,182 @@
+# ActiveAction
+
+A simple way to build and use Service Objects in Ruby on Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-active_action'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails-active_action
+
+## ActiveAction example
+
+```ruby
+# app/actions/my_action.rb
+class MyAction < ActiveAction::Base
+  def perform
+    # Your code here
+  end
+end
+
+# app/controllers/my_controller.rb
+class MyController < ApplicationController
+  def create
+    MyAction.perform
+  end
+end
+```
+
+or `perform!` to raise an error if occurred.
+
+```ruby
+# app/actions/my_action.rb
+class MyAction < ActiveAction::Base
+  def perform
+    # Your code here
+    error!
+  end
+end
+
+# app/controllers/my_controller.rb
+class MyController < ApplicationController
+  def create
+    MyAction.perform! # it will raise ActiveAction::Error
+  end
+end
+```
+
+## Demo
+
+```ruby
+# app/actions/create_user_action.rb
+class CreateUser < ActiveAction::Base
+  attributes :user
+  
+  after_perform :send_email_on_success, on: :success
+  
+  def perform(company, params)
+    self.user = company.users.build(params)
+    if self.user.save
+      success!
+    else
+      error!
+    end
+  end
+  
+  def send_email_on_success
+    User.welcome.with(user: self.user).deliver
+  end
+end
+
+# app/controllers/users_controller.rb
+class UsersController < ApplicationController
+  def create
+    context = CreateUser.perform(current_company, params_user)
+    
+    respond_to do |format|
+      if context.success?
+        format.html { redirect_to dashboard_path, notice: 'Welcome to our app' }
+      else
+        format.html { render action: :new } 
+      end
+    end
+  end
+  
+  private
+  
+  def current_company
+    @company ||= Company.find_by!(subdomain: request.subdomain)
+  end
+end
+```
+
+## Callbacks
+
+On `success` or `error`:
+* `after_perform`
+* `before_perform`
+  
+```ruby
+# app/actions/create_post.rb
+class CreatePost < ActiveAction::Base
+  before_perform do
+    # run a code before perform within a block
+  end
+  
+  after_perform do
+    # run a code after perform within a block
+  end
+  
+  after_perform :run_callback, on: :success
+  after_perform :run_warning_email, on: :error
+  
+  def perform(user, params: {})
+    # your code here
+  end
+end
+```
+
+* `around_perform`
+
+```ruby
+# app/actions/run_process.rb
+class RunProcess < ActiveAction::Base
+  around_perform :measure
+  
+  def measure
+    @start = Time.current
+    yield
+    @end = Time.current
+  end
+  
+  def perform(id)
+    `#{Process.find(id).command}`
+  end
+end
+```
+
+## Statuses
+
+Call `success!`, `succeed!`, `done!`, `correct!`, `ready!`, `active!` if the action performed successfully or `error!`, `fail!`, `failure!`, `failed!`, `invalid!`, `incorrect!`, `inactive!` otherwise.
+
+```ruby
+# app/actions/run.rb
+class Run < ActiveAction::Base
+  def perform
+    if rand(100) % 2 == 0
+      success!
+    else
+      fail!
+    end
+  end
+  
+  after_perform :send_email_on_success
+  
+  def send_email_on_success
+    Mail.deliver! if success?
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lukaszsliwa/active_action. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/lukaszsliwa/active_action/blob/master/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 ActiveAction project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/lukaszsliwa/active_action/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_action"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_action.rb

@@ -0,0 +1,31 @@
+require 'active_support/dependencies/autoload'
+require 'active_support/callbacks'
+
+require 'active_action/version'
+require 'active_action/statuses'
+require 'active_action/callbacks'
+require 'active_action/base'
+require 'active_action/error'
+
+#
+# Examples
+#
+#   class MyAction < ActiveAction::Base
+#     after_perform :send_email, on: :success
+#
+#     def perform(email_address)
+#
+#     end
+#
+#     def send_email
+#
+#     end
+#   end
+#
+
+module ActiveAction
+  extend ActiveSupport::Autoload
+
+  autoload :Base
+  autoload :Error
+end

data/lib/active_action/base.rb

@@ -0,0 +1,36 @@
+module ActiveAction
+  class Base
+    include ActiveSupport::Callbacks
+    define_callbacks :perform
+
+    extend ActiveAction::Callbacks
+    include ActiveAction::Statuses
+
+    attr_reader :status
+    attr_accessor :value
+
+    class << self
+      alias_method :attributes, :attr_accessor
+
+      def perform(*args)
+        instance = self.new
+        instance.value = instance.send(:perform_with_callbacks, *args)
+        instance.success! if instance.status.nil?
+        instance
+      end
+
+      def perform!(*args)
+        if (instance = perform(*args)).error?
+          raise ActiveAction::Error.new
+        end
+        instance
+      end
+    end
+
+    def perform_with_callbacks(*args)
+      run_callbacks :perform do
+        perform(*args)
+      end
+    end
+  end
+end

data/lib/active_action/callbacks.rb

@@ -0,0 +1,26 @@
+module ActiveAction
+  module Callbacks
+    def after_perform(method_name = nil, params = {}, &block)
+      prepare_callback(:perform, :after, method_name, params, &block)
+    end
+
+    def before_perform(method_name = nil, params = {}, &block)
+      prepare_callback(:perform, :before, method_name, params, &block)
+    end
+
+    def around_perform(method_name)
+      set_callback(:perform, :around, method_name)
+    end
+
+    private
+
+    def prepare_callback(on, what, method_name = nil, params = {}, &block)
+      set_callback(on, what) do
+        if params[:on] == :error && error? || \
+          params[:on] == :success && success? || params[:on].nil?
+          block_given? ? instance_eval(&block) : self.method(method_name).call
+        end
+      end
+    end
+  end
+end

data/lib/active_action/error.rb

@@ -0,0 +1,4 @@
+module ActiveAction
+  class Error < StandardError
+  end
+end

data/lib/active_action/statuses.rb

@@ -0,0 +1,14 @@
+module ActiveAction
+  module Statuses
+    {
+      success: %i(success succeed done correct ready active),
+      error: %i(error failure fail invalid incorrect inactive)
+    }.each do |key, values|
+      values.each do |value|
+        define_method(:"#{value}?") { @status == key }
+
+        define_method(:"#{value}!") { @status = key }
+      end
+    end
+  end
+end

data/lib/active_action/version.rb

@@ -0,0 +1,3 @@
+module ActiveAction
+  VERSION = '3.0.0'
+end

data/rails-active_action.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/active_action/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-active_action"
+  spec.version       = ActiveAction::VERSION
+  spec.authors       = ["Łukasz Śliwa"]
+  spec.email         = ["lukasz.sliwa@apptamers.com"]
+
+  spec.summary       = %q{A simple way to build and use Service Objects in Ruby on Rails.}
+  spec.description   = %q{ActiveAction makes you able to organise and move some actions to the separated classes.}
+  spec.homepage      = "https://github.com/lukaszsliwa/active_action"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/lukaszsliwa/active_action"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: rails-active_action
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Łukasz Śliwa
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-28 00:00:00.000000000 Z
+dependencies: []
+description: ActiveAction makes you able to organise and move some actions to the
+  separated classes.
+email:
+- lukasz.sliwa@apptamers.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/active_action.rb
+- lib/active_action/base.rb
+- lib/active_action/callbacks.rb
+- lib/active_action/error.rb
+- lib/active_action/statuses.rb
+- lib/active_action/version.rb
+- rails-active_action.gemspec
+homepage: https://github.com/lukaszsliwa/active_action
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lukaszsliwa/active_action
+  source_code_uri: https://github.com/lukaszsliwa/active_action
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A simple way to build and use Service Objects in Ruby on Rails.
+test_files: []