orchestrate_flow 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c98428620a6c142019c6b2380998d5e109dab19ec00f9be1834994fe878202b6
-  data.tar.gz: b89e58482608fb95da472a459ae51a4ce4cb134892100975c5006c7f2f91a9d9
+  metadata.gz: 8e6805b3b41e73cd47820f9cb2bcfc27045c26b043615b3fef3531893b2591b7
+  data.tar.gz: 48baaf4ddee5bce3face34173297f3dba9c65ca200c887a29d4fa6c2524046a0
 SHA512:
-  metadata.gz: fcdbc1acf7249b729d67ccb0561b2b1f4931a6fa2a27c202b7cdc690843cb79ec29bae307d3d13083f71b5c0ba65df775608df41ec756a1918ddf1e31b601243
-  data.tar.gz: 7cec65f20eb9ca0b452ec5c9a007805be3d84914129e6b2a0098ddff0924d541e06bd7e37c7a01fefa58b58c66739cca1dbf5afe28896b473c16583a22e96c12
+  metadata.gz: ab0a2cebf92c3d6b5821776a068443068c7f5411cf2841d35ef522798c7b92b113a5c1674f6b333c6d7770067b8303fb07f86eb54985e154edd683c745cbbe66
+  data.tar.gz: 6423392a96dd5daef74f18095f49e989830bd2c4242cb4f3deaa0efca95f1dd71c0dad522786e051a998ac1b573f5f9caf8de1bb70e0189d1c1a33df18d6e520

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    orchestrate_flow (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.1)
+    json (2.7.5)
+    language_server-protocol (3.17.0.3)
+    parallel (1.26.3)
+    parser (3.3.5.1)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.68.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.33.1)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.6.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  orchestrate_flow!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.2.32

data/README.md

@@ -27,7 +27,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Defining a Workflow
+You can define states, transitions, and event actions as follows
+
+```ruby
+# Usage Example
+
+# Define a custom workflow class
+class MyWorkflow < OrchestrateFlow::Workflow
+  # Define possible states
+  state :pending
+  state :in_progress
+  state :completed
+  state :failed
+
+  # Define transitions between states
+  transition event: :start, from: :pending, to: :in_progress
+  transition event: :complete, from: :in_progress, to: :completed
+  transition event: :fail, from: :in_progress, to: :failed
+
+  # Define actions to trigger on specific events
+  on :start do
+    puts "Workflow started!"
+  end
+
+  on :complete do
+    puts "Workflow completed successfully!"
+  end
+
+  on :fail do
+    puts "Workflow failed. Please try again."
+  end
+end
+
+# Initialize the workflow and trigger events
+workflow = MyWorkflow.new
+puts workflow.state                   # => :pending
+workflow.trigger(:start)              # => Workflow started!
+puts workflow.state                   # => :in_progress
+workflow.trigger(:complete)           # => Workflow completed successfully!
+puts workflow.state                   # => :completed
+```
 
 ## Development
 

data/lib/orchestrate_flow/version.rb

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

data/lib/orchestrate_flow/workflow.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module OrchestrateFlow
+  # The Workflow class represents a basic state machine for defining workflows
+  # with states, transitions, and event-driven actions. It allows developers
+  # to manage complex workflows using defined states and triggers.
+  class Workflow
+    attr_reader :state
+
+    def initialize
+      @state = :pending
+      @transitions = {}
+      @event_actions = {}
+    end
+
+    # Define a new state
+    def self.state(name)
+      @states ||= []
+      @states << name
+      define_method("#{name}?") { @state == name }
+    end
+
+    # Define a transition between states
+    def self.transition(event:, from:, to:)
+      @transitions ||= {}
+      @transitions[event] = { from: from, to: to }
+    end
+
+    # Define actions to trigger on events
+    def self.on(event, &action)
+      @event_actions ||= {}
+      @event_actions[event] = action
+    end
+
+    # Execute a transition event
+    def trigger(event)
+      unless valid_transition?(event)
+        raise InvalidTransitionError, "Cannot transition from #{@state} using event #{event}"
+      end
+
+      execute_event_action(event)
+      @state = self.class.transitions[event][:to]
+    end
+
+    # Accessors for states, transitions, and event actions
+    class << self
+      attr_reader :states
+    end
+
+    class << self
+      attr_reader :transitions
+    end
+
+    class << self
+      attr_reader :event_actions
+    end
+
+    private
+
+    # Validate if a transition is allowed
+    def valid_transition?(event)
+      transition = self.class.transitions[event]
+      transition && transition[:from] == @state
+    end
+
+    # Execute an event action if defined
+    def execute_event_action(event)
+      action = self.class.event_actions[event]
+      action&.call
+    end
+
+    # Custom error for invalid transitions
+    class InvalidTransitionError < StandardError; end
+  end
+end

data/lib/orchestrate_flow.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "orchestrate_flow/version"
+require_relative "orchestrate_flow/workflow"
 
+# OrchestrateFlow is a Ruby gem module for managing complex workflows and task orchestration.
+# It provides tools for defining states, transitions, and event-driven actions.
 module OrchestrateFlow
-  def self.hello
-    "Hello, World from OrchestrateFlow!"
-  end
 end

data/orchestrate_flow.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/orchestrate_flow/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "orchestrate_flow"
+  spec.version = OrchestrateFlow::VERSION
+  spec.authors = ["Daniel Morales"]
+  spec.email = ["danielmorales1202@gmail.com"]
+
+  spec.summary = "Native orchestration in Ruby with advanced workflow capabilities"
+  spec.description = "Ruby gem for managing complex workflows and orchestrating tasks."
+  spec.homepage = "https://compensix.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/danielmoralesp/orchestrate_flow"
+  spec.metadata["changelog_uri"] = "https://github.com/danielmoralesp/orchestrate_flow/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.glob("**/*").reject do |file|
+    file.match(%r{\A(?:test|spec|features)/}) ||
+      file.match(/\A\.(git|travis|circleci|appveyor)/) ||
+      file.match(/\.gem$/) # Exclude .gem files from the gem package
+  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"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: orchestrate_flow
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel Morales
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-30 00:00:00.000000000 Z
-dependencies: []
+date: 2024-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Ruby gem for managing complex workflows and orchestrating tasks.
 email:
 - danielmorales1202@gmail.com
@@ -17,11 +31,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -29,6 +42,8 @@ files:
 - bin/setup
 - lib/orchestrate_flow.rb
 - lib/orchestrate_flow/version.rb
+- lib/orchestrate_flow/workflow.rb
+- orchestrate_flow.gemspec
 homepage: https://compensix.com
 licenses:
 - MIT

data/.rspec

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

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120