mel-scene-fsm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3baa69e6ac3e391efa044b8353644503bc5be57ea2c86d7bba710cbffc69790c
+  data.tar.gz: daa40b680d0b4bb4fe612acadfec521012f9b6687fb3408437b38a13f2636a56
+SHA512:
+  metadata.gz: '000922db5c67676c48def20f9c4bf7f23cc95f0891df6317089d0f48263f7d83a410b07b75b9e0f4e7eb4e5ddc245861140de6385338cfbef7dd939ec8d689e9'
+  data.tar.gz: edb61bb2ad75d8a1a9b5166a6009f456b4c17c1aab951831c7891e485158d647c4ccaffdb3a2192ae163daeab5ed7727c792ba6fd26ab565699e5943394ca711

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 3.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-11-11
+
+- Initial release

data/README.md

@@ -0,0 +1,8 @@
+# Mel::Scene::Fsm
+
+The whole point of this gem is to extract and ecapsulate the FSM system for switching scenes in a console application.
+
+This is only a winner if it is easy to make sets of FSM's that can switch between each other and encapsulate functionality.
+
+Test looks promising, now to use it to refactor mobilis
+

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/mel/scene-fsm/version.rb

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

data/lib/mel/scene-fsm.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "state_machines"
+require "tty-prompt"
+
+require_relative "scene-fsm/version"
+
+module Mel
+  class SceneFSM
+    def prompt
+      @prompt ||= TTY::Prompt.new
+    end
+
+    def spacer
+      puts "|+--------------------------------------------------------+|"
+    end
+
+    def blank_space
+      puts ""
+    end
+
+    def ask_prompt(choices)
+      prompt.select("Choose your Path", choices, per_page: choices_per_page)
+    end
+
+    def choices_per_page
+      20
+    end
+
+    # runs a machine until completion, signaled by still_running? returning false
+    def visit_submachine(machine)
+      while machine.still_running?
+        machine.choose_destination
+      end
+    end
+
+    # all states should override this method
+    def choices
+      []
+    end
+
+    # all states should override this method
+    def display = false
+
+    # all states should override this method
+    def action = false
+
+    def still_running?
+      true
+    end
+
+    ##
+    # display, choices, and action methods all change per-state
+    def choose_destination
+      if (some_choices = choices)
+        blank_space
+        display
+        blank_space
+        ask_prompt(some_choices)
+      else
+        action
+      end
+    end
+
+    def decobox(*lines)
+      lines = lines[0].split("\n") if lines.length == 1
+      max_length = lines.map(&:length).max
+      puts "+-#{"-" * max_length}-+"
+      lines.each do |line|
+        num_spacers = max_length - line.length
+        puts "| #{line}#{" " * num_spacers} |"
+      end
+      puts "+-#{"-" * max_length}-+"
+    end
+  end
+end

data/sig/mel/scene/fsm.rbs

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

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: mel-scene-fsm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Meleneth
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: state_machines
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Uses TTY::Prompt and state_machines, extracted implementation
+email:
+- meleneth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/mel/scene-fsm.rb
+- lib/mel/scene-fsm/version.rb
+- sig/mel/scene/fsm.rbs
+homepage: https://github.com/meleneth/mel-scene-fsm
+licenses: []
+metadata:
+  homepage_uri: https://github.com/meleneth/mel-scene-fsm
+  source_code_uri: https://github.com/meleneth/mel-scene-fsm
+  changelog_uri: https://github.com/meleneth/mel-scene-fsm/CHANGELOG.md
+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.4.22
+signing_key:
+specification_version: 4
+summary: FSM base configured to run multiple choice based text UI's
+test_files: []