command_chain 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76b553218bb927776a118ff5fc01884102f56edf2ff8fd7189d9d0a6fca194d6
+  data.tar.gz: 791660e9b9ea23eb6a00aedaf65faa7593bd4b38cb466c1ca440a2d9c2b1f807
+SHA512:
+  metadata.gz: d6e6268d937239baaf57eff16d73f2f022748b43a9f40db8348137c74afe9ed72f8eddaeb1752906f06521fee9829d704e943e2cf8b3fef6b2a8db4c3a3c1d4b
+  data.tar.gz: 16a73d1c1cdbebcaef169697122bb83e69661bbc5228d1802479de5b2c69c769f48e77dfeb9272b67c820c67a1b9c1f3c6e6dc312fe103bedb3dc07a357e3ff8

data/CODE_OF_CONDUCT.markdown

@@ -0,0 +1,10 @@
+The Ruby Community Conduct Guideline
+====================================
+
+This document provides community guidelines for a safe, respectful, productive, and collaborative place for any person who is willing to contribute to the Ruby community.
+It applies to all “collaborative space”, which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.).
+
+- Participants will be tolerant of opposing views.
+- Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+- When interpreting the words and actions of others, participants should always assume good intentions.
+- Behaviour which can be reasonably considered harassment will not be tolerated.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in command_chain.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    command_chain (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.16.2)
+    rake (13.0.6)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  command_chain!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.17

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,82 @@
+# CommandChain
+
+Command-chain is an algorithm based on the command patterns that allows commands to be chained.
+It is used to divide large actions into smaller ones and automatically undo them when something goes wrong.
+
+Each Chain consists of a series of sequential commands.
+So, given a sequence A→B→C→D→E, the Chain executes A, then B, then C, and so on...
+If one fails, the Chain will undo every command in reverse order when they are undoable. So if D fails, then the Chain undo C, then undo B, and so on.
+
+The main reason why this gem was created is to show how using lambdas can produce a cleaner code than using service objects.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add command_chain
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install command_chain
+
+## Usage
+
+To use the CommandChain, first, you must create the lambdas/procs responsible for the 'do' and 'undo' actions.
+Second, make the Chain with an Array of Arrays.
+If a command does not need an undo action, use an Array with just an element or nil as the second element.
+
+```ruby
+do1 = lambda {|obj| puts "first execution"}
+undo1 = lambda {|obj| puts "third execution"}
+
+do2 = lambda {|obj| puts "second execution"}
+
+do3 = lambda {|obj| raise CommandChain::Error.new("error")}
+undo3 = lambda {|obj| puts "will not execute"}
+
+do4 = lambda {|obj| puts "will not execute"}
+undo4 = lambda {|obj| puts "will not execute"}
+
+CommandChain::Chain.new(
+  [
+    [do1, undo1],
+    [do2, nil],
+    [do3, undo3],
+    [do4, undo4],
+  ]
+).execute
+```
+There are two ways that a Command can receive variables; one is implicit because the commands are closures, and the second is through a variable that the closure gets as an argument.
+
+```ruby
+add_taxes = lambda do |order|
+  order.tax = 0.1
+end
+
+calculate_total = lambda do |order|
+  order.total_price = order.base_price + order.base_price * order.tax
+end
+
+Order = Struct.new('Order', :base_price, :tax, :total_price)
+order = Order.new
+order.base_price = 120.0
+
+CommandChain::Chain.new(
+  [
+    [add_taxes, nil],
+    [calculate_total, nil]
+  ]
+).execute(order)
+
+puts order.total_price # => 132.0
+```
+
+## Development
+
+After checking out the repo, 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://bitbucket.org/fredlinhares/command\_chain](bitbucket.org/fredlinhares/command_chain).

data/Rakefile

@@ -0,0 +1,12 @@
+# 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
+
+task default: :test

data/command_chain.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/command_chain/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "command_chain"
+  spec.version = CommandChain::VERSION
+  spec.authors = ["Frederico de Oliveira Linhares"]
+  spec.email = ["fred@linhares.blue"]
+  spec.homepage = "https://linhares.blue/tool/command_chain"
+
+  spec.summary =
+    "CommandChain is an algorithm based on the command patterns that allows "\
+    "commands to be chained."
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] =
+    "https://git.linhares.blue/benedictine_code_of_conduct.git/"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(
+        %r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/command_chain/chain.rb

@@ -0,0 +1,69 @@
+# Copyright 2022 Frederico de Oliveira Linhares
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module CommandChain
+
+  # Is a sequence of commands. Given a sequence A→B→C→D→E, the Chain executes
+  # A, then B, then C, and so on... If one fails, the Chain will undo every
+  # command in reverse order when they are undoable. So if D fails, then the
+  # Chain undo C, then undo B, and so on.
+  class Chain
+
+    # The argument must be an array of arrays; the inner arrays must have one
+    # or two objects. Each inner array is converted to a Command. The first
+    # object must be a Proc or Lambda with one parameter; it must raise a
+    # {CommandChain::Error} if it fails. The second can be another Proc or
+    # Lambda with one argument or nil.
+    #
+    # @param commands [Array<Array<Lambda, Proc, nil>>] list of commands
+    # @return [Chain] self
+    def initialize(commands)
+      @commands = commands.map { Command.new(_1[0], _1[1]) }
+    end
+
+    # Executes every command in order. If one fails, revert the executed
+    # commands from last to first.
+    #
+    # @param object will be sent to every {Command#execute} and
+    #   {Command#revert}.
+    # @return [Chain] self
+    def execute(object = nil)
+      for i in 0..(@commands.size - 1)
+        begin
+          @commands[i].execute.call(object)
+        rescue Error
+          partial_revert(object, i - 1)
+          raise
+        end
+      end
+      self
+    end
+
+    # Executes the {Command#revert} from last to first.
+    #
+    # @param object will be sent to every {Command#revert} Command.
+    # @return [Chain] self
+    def revert(object = nil) = partial_revert(object, @commands.size - 1)
+
+    protected
+
+    def partial_revert(object, step)
+      step.downto(0) do |i|
+        command = @commands[i].revert
+        command.call(object) unless command.nil?
+      end
+      self
+    end
+  end
+end

data/lib/command_chain/command.rb

@@ -0,0 +1,20 @@
+# Copyright 2022 Frederico de Oliveira Linhares
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module CommandChain
+
+  # This class is similar to the {https://en.wikipedia.org/wiki/Command_pattern
+  # command pattern} but uses lambdas instead of pointers to methods.
+  Command = Struct.new('Command', :execute, :revert)
+end

data/lib/command_chain/version.rb

@@ -0,0 +1,17 @@
+# Copyright 2022 Frederico de Oliveira Linhares
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module CommandChain
+  VERSION = "0.1.0"
+end

data/lib/command_chain.rb

@@ -0,0 +1,23 @@
+# Copyright 2022 Frederico de Oliveira Linhares
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative "command_chain/chain"
+require_relative "command_chain/command"
+require_relative "command_chain/version"
+
+module CommandChain
+  # When a {Command#execute} fails, it must return an instance of this class.
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/command_chain.rbs

@@ -0,0 +1,4 @@
+module CommandChain
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: command_chain
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frederico de Oliveira Linhares
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-26 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- fred@linhares.blue
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.markdown
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- command_chain.gemspec
+- lib/command_chain.rb
+- lib/command_chain/chain.rb
+- lib/command_chain/command.rb
+- lib/command_chain/version.rb
+- sig/command_chain.rbs
+homepage: https://linhares.blue/tool/command_chain
+licenses: []
+metadata:
+  homepage_uri: https://linhares.blue/tool/command_chain
+  source_code_uri: https://git.linhares.blue/benedictine_code_of_conduct.git/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: CommandChain is an algorithm based on the command patterns that allows commands
+  to be chained.
+test_files: []