lifecycle_vm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12e44a51967bc4275e68b74de045c3b50604c939ade596365a102e9b34280c4a
+  data.tar.gz: d2efdbc98e5ce8e02cfad19e9c4ff479691a4c10c5e5db7261ca089c7cb4efb8
+SHA512:
+  metadata.gz: ce5700cf19e330bf3c1f1006d519037776f0f50bba74295943ccf71100fd77f7f0d96fbd174b4ecd09c8fc2864e52f647602e56aad23c499ab6da089e903e123
+  data.tar.gz: 430a04f58436b5702cf9fe4cf994bec3dec84eaf1030d65b29f74a7dae4b43f2a1489089b147382c06f3808c57d20390b14ec4801ed6cca4faf96c2c3fa573cf

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+lifecycle_vm

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.4

data/Gemfile

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

data/LICENSE

@@ -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,35 @@
+# LifecycleVm
+
+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/lifecycle_vm`. 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 'lifecycle_vm'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install lifecycle_vm
+
+## 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]/lifecycle_vm.

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/lib/lifecycle_vm/cond_base.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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 LifecycleVM
+  # Base class for all conditionals in a vm.
+  # A conditional may read from vm emory by declare reads using the DSL. The
+  # lifecycle of a conditional is initialize -> call, and both methods will
+  # always be called. All reads and logger will be provided before initialize
+  # is called.
+  #
+  # A conditional may not write to vm memory, and must not error.
+  class CondBase
+    # Raised if a conditional attempts to read from a memory slot that does not exist.
+    class InvalidAttr < ::LifecycleVM::Error
+      attr_reader :cond_class, :attribute
+
+      def initialize(cond_class, attribute)
+        @cond_class = cond_class
+        @attribute = attribute
+        super("Invalid attribute #{attribute} access by #{cond_class.name}")
+      end
+    end
+
+    # Read one or more values out of vm memory and provide them as readable attributes
+    def self.reads(*attrs)
+      @reads ||= {}
+      @reads.merge!(Hash[attrs.map { |attribute| [attribute, :"@#{attribute}"] }])
+      attr_reader(*attrs)
+    end
+
+    # Execute the current op with the gien vm memory.
+    # This will read out all declared reads from memory and return the result of #call.
+    def self.call(memory)
+      obj = allocate
+
+      @reads ||= {}
+
+      @reads.each do |(attribute, ivar)|
+        raise InvalidAttr.new(self, attribute) unless memory.respond_to?(attribute)
+
+        obj.instance_variable_set(ivar, memory.send(attribute).clone)
+      end
+
+      obj.instance_variable_set(:"@logger", memory.logger)
+
+      obj.send(:initialize)
+      obj.send(:call)
+    end
+
+    attr_reader :logger
+
+    def call; end
+  end
+end

data/lib/lifecycle_vm/memory.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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 LifecycleVM
+  # Base class for VM memory.
+  # Any slots that you want to make readable must have a getter method defined.
+  # Any slots that you want to make writeable must have a setter method defined.
+  class Memory
+    PROTECTED = %i[current_state last_state current_op error_op].freeze
+    BUILTINS = (PROTECTED + %i[logger]).freeze
+
+    attr_accessor(*BUILTINS)
+  end
+end

data/lib/lifecycle_vm/op_base.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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 'lifecycle_vm/memory'
+
+module LifecycleVM
+  # Base class for all ops in a vm.
+  # An op may read and write to vm memory by declaring reads and writes using the
+  # DSL. The lifecycle of an op is initialize -> call -> validate, and all three
+  # methods will always be called. All reads and logger will be provided before
+  # initialize is called.
+  #
+  # An op may indicate that it encountered an error or otherwise failed by calling
+  # #error. If an op has any errors, no writes will be persisted to the vm memory.
+  class OpBase
+    # Raised if an op attempts to read or write to a memory slot that does not
+    # exist, or if an op attempts to write to any slot in LifecycleVM::Memory::PROTECTED.
+    class InvalidAttr < ::LifecycleVM::Error
+      attr_reader :op_class, :attribute
+
+      def initialize(op_class, attribute)
+        @op_class = op_class
+        @attribute = attribute
+        super("Invalid attribute #{attribute} access by #{op_class.name}")
+      end
+    end
+
+    # Read one or more values out of vm memory and provide them as readable attributes
+    def self.reads(*attrs)
+      @reads ||= {}
+      @writes ||= {}
+
+      attrs.each do |attribute|
+        attribute = attribute.to_sym
+
+        attr_reader attribute unless @writes.key?(attribute)
+
+        @reads[attribute] = :"@#{attribute}"
+      end
+
+      @reads
+    end
+
+    # Allow writing one or more values to vm memory and provide them as writeable attributes
+    # @note You may not write to any slot in LifecycleVM::Memory::PROTECTED
+    def self.writes(*attrs)
+      @reads ||= {}
+      @writes ||= {}
+
+      attrs.each do |attribute|
+        attribute = attribute.to_sym
+        raise InvalidAttr.new(self, attribute) if LifecycleVM::Memory::PROTECTED.include?(attribute)
+
+        if @reads.key?(attribute)
+          attr_writer attribute
+        else
+          attr_accessor attribute
+        end
+
+        @writes[attribute] = :"#{attribute}="
+      end
+
+      @writes
+    end
+
+    # Execute the current op with the gien vm memory.
+    # This will read out all declared reads from memory and if executed without
+    # any errors will write all declared writes to memory.
+    def self.call(memory)
+      obj = allocate
+
+      @reads ||= {}
+      @writes ||= {}
+
+      @reads.each do |(attribute, ivar)|
+        raise InvalidAttr.new(self, attribute) unless memory.respond_to?(attribute)
+
+        obj.instance_variable_set(ivar, memory.send(attribute).clone)
+      end
+
+      @writes.each do |(attribute, setter)|
+        raise InvalidAttr.new(self, attribute) unless memory.respond_to?(setter)
+      end
+
+      obj.instance_variable_set(:"@logger", memory.logger)
+      obj.instance_variable_set(:"@errors", nil)
+
+      obj.send(:initialize)
+      obj.send(:call)
+      obj.send(:validate)
+
+      unless obj.errors?
+        @writes.each do |(attribute, setter)|
+          memory.send(setter, obj.send(attribute))
+        end
+      end
+
+      obj
+    end
+
+    def call; end
+    def validate; end
+
+    attr_reader :errors, :logger
+
+    # Declare that an error has occurred.
+    # @param field [Symbol] the memory field which is in error. The convention is to use :base
+    #   for errors not associated with any particular memory field.
+    # @param message [Object] a description of the error. Convention is to use a string.
+    def error(field, message)
+      @errors ||= {}
+      @errors[field] ||= []
+      @errors[field] << message
+    end
+
+    # Did any errors occur in the execution of this op?
+    def errors?
+      !(@errors.nil? || @errors.empty?)
+    end
+  end
+end

data/lib/lifecycle_vm/state.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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 'lifecycle_vm/then'
+
+module LifecycleVM
+  # Represents a state in the lifecycle.
+  # A state may optionally define a single operation to perform, and then must
+  # define which state to transition to next.
+  # Transitions may be conditional, controlled by a subclass of LifecycleVM::CondBase
+  # @see LifecycleVM::VM
+  # @see LifecycleVM::OpBase
+  # @see LifecycleVM::CondBase
+  class State
+    attr_reader :name, :op, :then
+
+    def initialize(name, options)
+      @name = name
+      @op = options[:do]
+      @then = Then.new(options[:then]) if options.key?(:then)
+    end
+  end
+end

data/lib/lifecycle_vm/then.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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 'lifecycle_vm/vm'
+
+module LifecycleVM
+  class Then
+    class Simple
+      def initialize(state)
+        @state = state
+      end
+
+      def call(_vm)
+        @state
+      end
+    end
+
+    class AnonymousState
+      attr_reader :op, :then
+
+      def initialize(options)
+        @op = options[:do]
+        @then = Then.new(options[:then])
+      end
+
+      def call(vm)
+        vm.do_anonymous_op(@op, @then)
+      end
+    end
+
+    def self.new(options)
+      if options.kind_of?(Symbol)
+        return Simple.new(options)
+      else
+        super
+      end
+    end
+
+    def initialize(options)
+      if !(options.kind_of?(Hash) && options.key?(:case) && options.key?(:when))
+        raise InvalidThen.new(options)
+      end
+
+      @cond = options[:case]
+      @branches = options[:when].transform_values do |value|
+        case value
+        when Hash
+          if value.key?(:case)
+            Then.new(value)
+          elsif value.key?(:then)
+            AnonymousState.new(value)
+          else
+            raise InvalidBranch.new(value, options)
+          end
+        when Symbol
+          Simple.new(value)
+        else
+          raise InvalidBranch.new(value, options)
+        end
+      end
+    end
+
+    class InvalidThen < ::LifecycleVM::Error
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+
+        super("Invalid then configuration #{options}")
+      end
+    end
+
+    class InvalidBranch < ::LifecycleVM::Error
+      attr_reader :value, :options
+
+      def initialize(value, options)
+        @value = value
+        @options = options
+
+        super("Invalid then option value #{value.inspect} in #{options}")
+      end
+    end
+
+    class InvalidCond < ::LifecycleVM::Error
+      attr_reader :value, :cond, :branches, :vm
+
+      def initialize(value, cond, branches, vm)
+        @value = value
+        @cond = cond
+        @branches = branches
+        @vm = vm
+
+        super("Unhandled condition result #{value.inspect} returned by #{cond} in #{branches}. Current context #{@vm}")
+      end
+    end
+
+    def call(vm)
+      state_name = vm.current_state.name
+      conditional_name = @cond.name
+      logger = vm.logger
+
+      logger&.debug(:conditional_check, state: state_name, ctx: vm, conditional: conditional_name)
+      value = @cond.call(vm.memory)
+      logger&.debug(:conditional_result, state: state_name, ctx: vm, conditional: conditional_name, result: value)
+
+      branch = @branches[value]
+      raise InvalidCond.new(value, @cond, @branches, vm) unless branch.respond_to?(:call)
+
+      branch.call(vm)
+    end
+  end
+end

data/lib/lifecycle_vm/version.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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 LifecycleVM
+  VERSION = "0.1.0"
+end

data/lib/lifecycle_vm/vm.rb

@@ -0,0 +1,243 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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 'forwardable'
+
+require 'lifecycle_vm/state'
+require 'lifecycle_vm/memory'
+
+module LifecycleVM
+  class VM
+    extend Forwardable
+
+    # By default the lifecycle state machine starts at :start, ends at :exit,
+    # and immediately termiantes on op failure.
+    DEFAULT_START = :start
+    DEFAULT_TERMINALS = [:exit].freeze
+    DEFAULT_ON_OP_FAILURE = :exit
+
+    # Stores state machine configuration.
+    class Config
+      # @return [Symbol, nil] the state to transition to when an op fails
+      attr_accessor :on_op_failure
+
+      # @return [Hash<Symbol, LifecycleVM::State>] a mapping of state names to state structures
+      attr_accessor :states
+
+      # @return [Symbol] the state to start at
+      attr_accessor :initial_state
+
+      # @return [Array<Symbol>] a list of state names which the machine will stop at
+      attr_accessor :terminal_states
+
+      # @return [LifecycleVM::Memory] not an instance of but the class of the memory for this
+      #   particular machine
+      attr_accessor :memory_class
+
+      # Creates a new Config with default settings
+      def initialize
+        @states = {}
+        @on_op_failure = DEFAULT_ON_OP_FAILURE
+        @initial_state = DEFAULT_START
+        @terminal_states = DEFAULT_TERMINALS
+        @memory_class = LifecycleVM::Memory
+        @terminal_states.each do |state|
+          @states[state] ||= State.new(state, {})
+        end
+      end
+    end
+
+    # Error raised if the machine attempts to enter a state not declared with .on
+    class InvalidState < ::LifecycleVM::Error
+      # @return [Symbol] the name of the state that was attempted
+      attr_reader :state
+
+      # @return [LifecycleVM::VM] the state machine being executed
+      attr_reader :vm
+
+      # @param state [Symbol] the name of the state that does not exist
+      # @param vm [LifecycleVM::VM] the vm raising the error
+      def initialize(state, vm)
+        @state = state
+        @vm = vm
+        super("Invalid state transition to #{@state}. Current context #{@vm}")
+      end
+    end
+
+    class << self
+      # Set the state to transition to if an op fails
+      # @param state [Symbol] the state to transition to when any op fails.
+      #   There may only be one declared failure handler for any VM.
+      def on_op_failure(state)
+        @config ||= Config.new
+        @config.on_op_failure = state
+      end
+
+      # Declare a state with an optional op and conditional transitions
+      # @param state [Symbol] the name of the state
+      # @param opts [Hash]
+      # @option opts [LifecycleVM::OpBase] :do (nil) the op to execute upon entering this state
+      # @option opts [Symbol, Hash] :then (nil) either the name of the state to transition do
+      #   after executing :do, or a hash of the form
+      #   { case: LifecycleVM::CondBase, when: Hash<_, [Symbol, Hash]> }
+      def on(state, opts)
+        @config ||= Config.new
+        @config.states[state] = State.new(state, opts)
+      end
+
+      # Set the state to start execution at
+      def initial(state)
+        @config ||= Config.new
+        @config.initial_state = state
+      end
+
+      # Set one or more states as states to halt execution at
+      def terminal(*states)
+        @config ||= Config.new
+        @config.terminal_states += states
+        states.each do |state|
+          @config.states[state] ||= State.new(state, {})
+        end
+      end
+
+      # Set the class to be instantiated to store VM memory
+      def memory_class(klass)
+        @config ||= Config.new
+        @config.memory_class = klass
+      end
+
+      # @return [Config] the machine configuration
+      attr_reader :config
+    end
+
+    # The current VM memory
+    # @return [LifecycleVM::Memory] the current VM memory
+    attr_reader :memory
+
+    # (see LifecycleVM::VM.config)
+    def config
+      self.class.config
+    end
+
+    def_delegators :@memory, *(LifecycleVM::Memory::BUILTINS)
+    def_delegators :@memory, *(LifecycleVM::Memory::BUILTINS).map { |field| :"#{field}=" }
+
+    def initialize(memory = nil)
+      @memory = memory || config.memory_class.new
+    end
+
+    # Executes the VM until a terminal state is reached.
+    # @note May never terminate!
+    def call
+      next_state = config.initial_state
+      loop do
+        next_state = do_state(next_state)
+        break unless next_state
+      end
+      self
+    end
+
+    # Did this vm exit with an errored op?
+    # @return [Boolean] true if the vm exited with an errored op
+    def errors?
+      !!error_op&.errors?
+    end
+
+    # @return [Hash<Symbol, Array<String>>] errors from the errored op
+    def errors
+      error_op&.errors
+    end
+
+    # Did this vm encounter an error trying to recover from an errored op?
+    # @return [Boolean] true if an op associated with the op failure state errored
+    def recovery_errors?
+      !!current_op&.errors?
+    end
+
+    # @return [Hash<Symbol, Array<String>>] errors from the op failure op
+    def recovery_errors
+      current_op&.errors
+    end
+
+    # @private
+    def do_anonymous_op(op, following)
+      raise InvalidState.new(current_state.name, self) if op && current_op.executed?
+
+      do_op(op, following)
+    end
+
+  private
+
+    def do_state(next_state)
+      logger&.debug(:enter, state: next_state, ctx: self)
+      self.last_state = current_state
+
+      state = config.states[next_state]
+      raise InvalidState.new(next_state, self) unless state
+
+      self.current_state = state
+
+      return nil if config.terminal_states.include?(current_state.name)
+
+      do_op(state.op, state.then)
+    end
+
+    OpEntry = Struct.new(:state_name, :op, :errors) do
+      def executed?
+        !op.nil?
+      end
+
+      def errors?
+        !(errors.nil? || errors.empty?)
+      end
+    end
+
+    def do_op(op, following)
+      # If we're running under systemd, as determined by the presence of the SdNotify gem,
+      # notify the watchdog each time we run an op. This gets us more or less free
+      # watchdog monitoring for long running services.
+      SdNotify.watchdog if defined?(SdNotify)
+
+      op_result = op&.call(memory)
+      self.current_op = OpEntry.new(current_state.name, op, op_result&.errors)
+
+      if current_op.errors?
+        logger&.error(:op_errors, state_name: current_op.state_name, op_name: current_op.op.name,
+                                  errors: current_op.errors, ctx: self)
+        on_op_failure = config.on_op_failure
+
+        # If we're here, then first an op failed, and then an op executed by our
+        # on_op_failure state also failed. In this case, both error_op and
+        # current_op should be set, and both should #errors? => true
+        return DEFAULT_TERMINALS.first if current_state.name == on_op_failure
+
+        self.error_op = current_op
+
+        # We unset current op here so that if there is no failure handler and we're
+        # directly transitioning to a terminal state we do not indicate that there
+        # were recovery errors (as there was no recovery)
+        self.current_op = nil
+
+        return on_op_failure
+      # Only clear our error op if we have successfully executed another op
+      elsif op
+        self.error_op = nil
+      end
+
+      following.call(self)
+    end
+  end
+end

data/lib/lifecycle_vm.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, Inc.
+#
+# 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
+#
+#     https://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 LifecycleVM
+  class Error < RuntimeError; end
+end
+
+require 'lifecycle_vm/version'
+require 'lifecycle_vm/cond_base'
+require 'lifecycle_vm/op_base'
+require 'lifecycle_vm/vm'

data/lifecycle_vm.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/lifecycle_vm/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lifecycle_vm"
+  spec.version       = LifecycleVM::VERSION
+  spec.authors       = ["Alex Scarborough"]
+  spec.email         = ["alex@teak.io"]
+
+  spec.summary       = "Lifecycle VM is a minimal vm to support long running ruby processes."
+  spec.description   = "Lifecycle VM provides basic lifecycle management following the idea of only executing a single significant operation per program state."
+  spec.homepage      = "https://github.com/GoCarrot/lifecycle_vm"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/GoCarrot/lifecycle_vm"
+
+  # 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|features|script)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency('simplecov', '~> 0.21.2')
+  spec.add_development_dependency('rspec', '~> 3.10')
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: lifecycle_vm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Scarborough
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: Lifecycle VM provides basic lifecycle management following the idea of
+  only executing a single significant operation per program state.
+email:
+- alex@teak.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lifecycle_vm.rb
+- lib/lifecycle_vm/cond_base.rb
+- lib/lifecycle_vm/memory.rb
+- lib/lifecycle_vm/op_base.rb
+- lib/lifecycle_vm/state.rb
+- lib/lifecycle_vm/then.rb
+- lib/lifecycle_vm/version.rb
+- lib/lifecycle_vm/vm.rb
+- lifecycle_vm.gemspec
+homepage: https://github.com/GoCarrot/lifecycle_vm
+licenses: []
+metadata:
+  homepage_uri: https://github.com/GoCarrot/lifecycle_vm
+  source_code_uri: https://github.com/GoCarrot/lifecycle_vm
+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.1.6
+signing_key:
+specification_version: 4
+summary: Lifecycle VM is a minimal vm to support long running ruby processes.
+test_files: []