closed_loop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b34de60db17b5f35bc766ec5d500aeeb7aaf71741084a8f2da94054941f70820
+  data.tar.gz: 98a53ad41899e0a53b92c5c0ee584ec272c5c86e91812f2683dc94b3640d56d0
+SHA512:
+  metadata.gz: 6853892b0d41c33093d1a1bbae4cd64e34d9e5743fb56912426fc3b24ff326ccdab3c8afccd4f624100f2d8e904ae12193ffdfae0527b741422e1c2d7edc13e5
+  data.tar.gz: 97ea90aef5c24d89151881359b6a6c8b584116d264cb6ed1b2f192a897d3128e7afeb8b72df66a0d3cb37b85522924b055efdbd0f834ae854f85099920346260

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+        bundle exec rake

data/.gitignore

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

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-07-12
+
+- Initial release

data/Example.md

@@ -0,0 +1,88 @@
+# Prerequisites
+
+1. ActiveRecord model with the status column
+2. `closed_loop` gem installed
+
+# Configuration
+
+```Ruby
+# app/lib/order_machine.rb
+
+require 'closed_loop'
+
+class OrderMachine < ClosedLoop::Machine::Instance
+  class RoleResolver < ClosedLoop::Machine::RoleResolver
+    def call
+      if !user
+        :system
+      elsif user.role_admin?
+        :admin
+      elsif target.buyer == user
+        :buyer
+      end
+    end
+  end
+
+  private
+
+  def configure_all
+    # Naming convention - "[PROCESS_NAME__]STATE[_SUB_STATE]"
+
+    # Checkout > View cart state
+    transition(role: :buyer, from: :cart__created, to: :cart__reviewed)
+    transition(role: :buyer, from: :cart__reviewed, to: :cart__confirmed)
+
+    # Checkout > Billing state
+    transition(role: :buyer, from: :cart__confirmed, to: :billing_information__submitted)
+    transition(role: :buyer, from: :billing_information__information_submitted, to: :payment__method_selected)
+
+    # Checkout > Payment state
+    transition(role: :buyer, from: :payment__method_selected, to: :payment__pending)
+    transition(role: :system, from: :payment__pending, to: :payment__failed)
+    transition(role: :system, from: :payment__pending, to: :payment__confirmed)
+
+    # Shipping
+    transition(role: :admin, from: :payment__confirmed, to: :parcel__pending)
+    transition(role: :admin, from: :parcel__pending, to: :parcel__prepared)
+    transition(role: :admin, from: :parcel__prepared, to: :parcel__shipping_pending)
+    transition(role: :system, from: :parcel__shipping_pending, to: :parcel__shipped)
+    transition(role: :buyer, from: :parcel__shipped, to: :parcel__received)
+    transition(role: :buyer, from: :parcel__shipped, to: :parcel__lost)
+
+    # Shipping failed
+    transition(role: :admin, from: :parcel__lost, to: :parcel__pending)
+
+    transition(role: :admin, from: :parcel__lost, to: :refunded) do |target, _user|
+      SendRefundNotification.call(target)
+    end
+
+    constraint(role: :admin, from: :parcel__lost, to: :parcel__pending) do |target, _user|
+      # Only small size purchases could be reshipped
+      target.total_price < 15.00
+    end
+
+    # Re-usable callbacks extracted from transitions
+    callback(from: :parcel__shipped, to: %i[parcel__lost parcel__received]) do |target, _user|
+      # Push slack notifications on shipping status change 
+      PushOrderStatusSlackNotification.call(target)
+    end
+
+    callback(to: %i[payment__confirmed payment__failed]) do |target, _user|
+      SendPaymentStatusNotification.call(target)
+    end
+  end
+end
+```
+
+```Ruby
+# In controller / service / interactor / background worker
+
+OrderMachine.insantce.transition!(order, current_user, to: :parcel__received)
+
+# invoke extra methods in the the same transition & ActiveRecord transaction: 
+
+OrderMachine.insantce.transition!(order, current_user, to: :parcel__received) do
+  order.items.each { |item| '#...' }
+end
+
+```

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in closed_loop.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    closed_loop (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  bundler
+  closed_loop!
+  rake
+  rspec
+
+BUNDLED WITH
+   2.2.15

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Vilius Luneckas
+
+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,35 @@
+# ClosedLoop
+
+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/closed_loop`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'closed_loop'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install closed_loop
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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://github.com/[USERNAME]/closed_loop.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "closed_loop"
+
+# 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/closed_loop.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/closed_loop/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'closed_loop'
+  spec.version       = ClosedLoop::VERSION
+  spec.authors       = ['Vilius Luneckas']
+  spec.email         = ['vilius.luneckas@gmail.com']
+
+  spec.summary       = 'State machine DSL'
+  spec.homepage      = 'https://github.com/ViliusLuneckas/closed_loop'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/closed_loop/machine/base.rb

@@ -0,0 +1,15 @@
+module ClosedLoop
+  module Machine
+    class Base
+      ATTRIBUTES = %i[machine to from role].freeze
+
+      attr_reader(*(ATTRIBUTES + [:proc]))
+
+      def initialize(config, proc = nil)
+        config.slice(*ATTRIBUTES).each { |k, v| instance_variable_set("@#{k}", v) }
+
+        @proc = proc
+      end
+    end
+  end
+end

data/lib/closed_loop/machine/callback.rb

@@ -0,0 +1,9 @@
+module ClosedLoop
+  module Machine
+    class Callback < Base
+      def perform!(target, user, options)
+        proc&.call(target, user, options)
+      end
+    end
+  end
+end

data/lib/closed_loop/machine/configuration.rb

@@ -0,0 +1,41 @@
+module ClosedLoop
+  module Machine
+    class Configuration
+      attr_reader :transitions, :callbacks, :machine, :constraints
+
+      def initialize(machine)
+        @machine     = machine
+        @transitions = []
+        @callbacks   = []
+        @constraints = []
+      end
+
+      def transition(config, &block)
+        @transitions << Transition.new(config.merge(machine: machine), block)
+      end
+
+      def callback(config, &block)
+        @callbacks << Callback.new(config.merge(machine: machine), block)
+      end
+
+      def constraint(config, &block)
+        @constraints << Constraint.new(config.merge(machine: machine), block)
+      end
+
+      def select_callbacks_for(transition)
+        @callbacks.select do |callback|
+          (callback.from.nil? || Array(callback.from).include?(transition.from)) &&
+            (callback.to.nil? || Array(callback.to).include?(transition.to))
+        end
+      end
+
+      def select_constraints_for(transition)
+        @constraints.select do |constraint|
+          (constraint.from.nil? || Array(constraint.from).include?(transition.from)) &&
+            (constraint.to.nil? || Array(constraint.to).include?(transition.to)) &&
+            (constraint.role == transition.role)
+        end
+      end
+    end
+  end
+end

data/lib/closed_loop/machine/constraint.rb

@@ -0,0 +1,9 @@
+module ClosedLoop
+  module Machine
+    class Constraint < Base
+      def allows?(*args)
+        proc.call(*args)
+      end
+    end
+  end
+end

data/lib/closed_loop/machine/instance.rb

@@ -0,0 +1,39 @@
+module ClosedLoop
+  module Machine
+    class Instance
+      attr_reader :configuration
+
+      delegate :transition, :callback, :constraint, to: :@configuration
+
+      def initialize
+        @configuration = ClosedLoop::Machine::Configuration.new(self)
+
+        configure_all
+      end
+
+      def available_transitions(target, user)
+        configuration.transitions.select { |transition| transition.available?(target, user) }
+      end
+
+      def transition!(target, user, to:, &block)
+        available_transition = available_transitions(target, user).find do |transition|
+          transition.from == target.status.to_sym && transition.to == to.to_sym
+        end
+
+        if available_transition&.available?(target, user)
+          available_transition.perform!(target, user, &block)
+        else
+          raise("Transition #{self.class} #{target.status}->#{to} for #{target.id} by #{user} not available!")
+        end
+      end
+
+      def resolve_role(*args)
+        self.class.const_get('RoleResolver').new(*args).call
+      end
+
+      def configure_all
+        raise '#configure_all not implemented yet'
+      end
+    end
+  end
+end

data/lib/closed_loop/machine/role_resolver.rb

@@ -0,0 +1,12 @@
+module ClosedLoop
+  module Machine
+    class RoleResolver
+      attr_reader :target, :user
+
+      def initialize(target, user)
+        @target = target
+        @user   = user
+      end
+    end
+  end
+end

data/lib/closed_loop/machine/transition.rb

@@ -0,0 +1,42 @@
+module ClosedLoop
+  module Machine
+    class Transition < Base
+      def times_used
+        @track_times_used ||= 0
+      end
+
+      def available?(target, user)
+        role == machine.resolve_role(target, user) &&
+          target.status.to_sym == from &&
+          none_constraints?(target, user)
+      end
+
+      def none_constraints?(target, user)
+        machine.configuration.select_constraints_for(self).all? do |constraint|
+          constraint.allows?(target, user, transition: self)
+        end
+      end
+
+      def perform!(target, user)
+        target.class.transaction do
+          target.status             = to
+          target.last_transition_at = Time.current if target.respond_to?(:last_transition_at)
+
+          proc&.call(target, user, transition: self)
+
+          target.save!
+
+          machine.configuration.select_callbacks_for(self).each do |callback|
+            callback.perform!(target, user, transition: self)
+          end
+
+          raise 'Callback changes were not saved' if target.changed?
+
+          yield(target, user, transition: self) if block_given?
+        end
+
+        @track_times_used = times_used + 1
+      end
+    end
+  end
+end

data/lib/closed_loop/machine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "machine/base"
+require_relative "machine/role_resolver"
+require_relative "machine/configuration"
+require_relative "machine/callback"
+require_relative "machine/instance"
+require_relative "machine/transition"
+
+module ClosedLoop
+  module Machine
+  end
+end

data/lib/closed_loop/version.rb

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

data/lib/closed_loop.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "closed_loop/version"
+require_relative "closed_loop/machine"
+
+module ClosedLoop
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: closed_loop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vilius Luneckas
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- vilius.luneckas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Example.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- closed_loop.gemspec
+- lib/closed_loop.rb
+- lib/closed_loop/machine.rb
+- lib/closed_loop/machine/base.rb
+- lib/closed_loop/machine/callback.rb
+- lib/closed_loop/machine/configuration.rb
+- lib/closed_loop/machine/constraint.rb
+- lib/closed_loop/machine/instance.rb
+- lib/closed_loop/machine/role_resolver.rb
+- lib/closed_loop/machine/transition.rb
+- lib/closed_loop/version.rb
+homepage: https://github.com/ViliusLuneckas/closed_loop
+licenses: []
+metadata:
+  homepage_uri: https://github.com/ViliusLuneckas/closed_loop
+  source_code_uri: https://github.com/ViliusLuneckas/closed_loop
+  changelog_uri: https://github.com/ViliusLuneckas/closed_loop/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: State machine DSL
+test_files: []