statize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1419b6b991c36e435ce8282dad28ef1a3d65a04862963058b4ed41bddcd955f9
+  data.tar.gz: a561f07330b9cf9a7247f43f81f97db72f8372b82dc9e4bf47a319aa5489f4b2
+SHA512:
+  metadata.gz: 5e027e8e4da7e11f9cd557d517a61fa72eec2c18d1434fd1237775e5deb1d173a8da2ffdc2b1895a3db19dd6d64c114cc1ba76d0cf7dc17633e47244adf4347b
+  data.tar.gz: 2b7949d5edbab65bb53d8e78ef12ec519b618d33a9dd03e1ef722d29dadfcbefcd907408343ab993dd7034e5b8bd09b923dccd7d4760efe4bb4d7ec453741c7e

data/.rspec

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    statize (0.1.0)
+      teLogger
+      toolrack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base58 (0.2.3)
+    devops_assist (0.3.1)
+      git_cli
+      git_cli_prompt
+      gvcs
+      teLogger
+      toolrack
+      tty-prompt
+    diff-lcs (1.5.0)
+    git_cli (0.10.0)
+      gvcs
+      ptools (~> 1.4.0)
+      teLogger
+      toolrack
+    git_cli_prompt (0.3.1)
+      teLogger
+      toolrack
+      tty-prompt
+    gvcs (0.1.0)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    ptools (1.4.2)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    teLogger (0.2.0)
+    toolrack (0.19.1)
+      base58
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    wisper (2.0.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  devops_assist
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  statize!
+
+BUNDLED WITH
+   2.2.28

data/README.md

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

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 'devops_assist'
+
+task default: :spec

data/bin/console

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

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

data/lib/statize.rb

@@ -0,0 +1,350 @@
+# frozen_string_literal: true
+require 'toolrack'
+require 'teLogger'
+
+require_relative "statize/version"
+
+module Statize
+  class Error < StandardError; end
+  class InvalidState < StandardError; end
+  class InvalidStateForEvent < StandardError; end
+  class UserHalt < StandardError; end
+  class InvalidEvent < StandardError; end
+  class DuplicatedKey < StandardError; end
+  
+  include TR::CondUtils
+
+  include TeLogger::TeLogHelper
+  teLogger_tag :statize
+
+  # class methods start here
+  module ClassMethods
+   
+    def stateful(opts = {  }, &block)
+      @ops = {  } if @ops.nil?
+      ops = {
+        initial_state: :open,
+        state_attr_name: "state",
+      } 
+
+      @profile = opts[:profile] || :default 
+
+      #opts.delete(:profile)
+
+      ops.merge!(opts) if not opts.nil? and opts.is_a?(Hash)
+
+      @ops[@profile] = {  }
+      @ops[@profile].merge!(ops)
+
+      if block
+        class_eval(&block)
+      end
+
+    end
+
+    # definition of event
+    # Using global parameter @profile during definition
+    def event(evt, *args, &block)
+      
+      evt = evt.to_sym
+      add_event_block(@profile, evt, &block)
+
+      args.first.each do |fromSt, toSt|
+        fromSt = fromSt.to_sym
+        toSt = toSt.to_sym
+        add_state_events(@profile,fromSt, evt)
+        add_state_transition(@profile, fromSt, toSt)
+        add_event_states(@profile, evt, fromSt, toSt)
+        add_profile_states(@profile, fromSt, toSt)
+      end
+
+    end
+
+    def state_meaning(ops)
+      raise Error, "Hash expected" if not ops.is_a?(Hash) 
+      ops.each do |k,v|
+        add_state_meaning(@profile, k, v)
+        add_meaning_states(@profile, v, k)
+      end
+    end
+
+    def state_attr_name(prof = :default)
+      @ops[prof][:state_attr_name].to_s.freeze
+    end
+
+    def initial_state(prof = :default)
+      @ops[prof][:initial_state].to_s.freeze
+    end
+
+    def states_table(prof = :default)
+      _states_transfer_table(prof).freeze
+    end
+
+    def state_events_table(prof = :default)
+      _state_events_table(prof).freeze
+    end
+
+    def event_states_table(prof = :default)
+      _event_states_table(prof).freeze
+    end
+
+    def event_block_table(prof = :default)
+      _event_block_table(prof).freeze
+    end
+
+    def profile_states_list(prof = :default)
+      _profile_states_list(prof).freeze
+    end
+
+    def state_meaning_table(prof = :default)
+      _state_meaning_table(prof).freeze
+    end
+
+    def meaning_states_table(prof = :default)
+      _meaning_states_table(prof).freeze
+    end
+
+    def state_profiles
+      @ops.keys.freeze
+    end
+
+    private
+    # keep possible next states
+    def add_state_transition(prof, from, to)
+      _states_transfer_table(prof)[from] = [] if _states_transfer_table(prof)[from].nil?
+      # ok to keep single relationship as this table hold the possible next states,
+      # which is possible duplicate but different event
+      _states_transfer_table(prof)[from] << to if not _states_transfer_table(prof)[from].include?(to)
+    end
+
+    # map state (current state) to possible events
+    def add_state_events(prof, from, evt)
+      _state_events_table(prof)[from] = [] if _state_events_table(prof)[from].nil?
+      _state_events_table(prof)[from] << evt
+    end
+
+    # keep complete event, from and to state
+    def add_event_states(prof, evt, fromSt, toSt)
+      _event_states_table(prof)[evt] = {} if _event_states_table(prof)[evt].nil?
+      _event_states_table(prof)[evt][fromSt] = toSt
+    end
+
+    # map event to block
+    def add_event_block(prof, evt, &block)
+      _event_block_table(prof)[evt] = block if block
+    end
+
+    def add_profile_states(prof, *st)
+      st.each do |s|
+        _profile_states_list(prof) << s if not _profile_states_list(prof).include?(s)
+      end
+    end
+
+    def add_state_meaning(prof, state, meaning)
+      val = _state_meaning_table[state]
+      raise DuplicatedKey, "State '#{state}' has already given meaning '#{val}'" if not val.nil?
+      _state_meaning_table[state] = meaning
+    end
+
+    def add_meaning_states(prof, meaning, state)
+      _meaning_states_table(prof)[meaning] = [] if _meaning_states_table(prof)[meaning].nil?
+      _meaning_states_table(prof)[meaning] << state if not _meaning_states_table(prof)[meaning].include?(state)
+    end
+
+    def _states_transfer_table(prof = :default)
+      @ops[prof][:state_transfer] = {} if @ops[prof][:state_transfer].nil?
+      @ops[prof][:state_transfer]
+    end
+
+    def _state_events_table(prof = :default)
+      @ops[prof][:state_events] = {} if @ops[prof][:state_events].nil?
+      @ops[prof][:state_events]
+    end
+
+    def _event_states_table(prof = :default)
+      @ops[prof][:event_states] = {} if @ops[prof][:event_states].nil?
+      @ops[prof][:event_states]
+    end
+
+    def _event_block_table(prof = :default)
+      @ops[prof][:event_block_table] = {} if @ops[prof][:event_block_table].nil?
+      @ops[prof][:event_block_table]
+    end
+
+    def _profile_states_list(prof = :default)
+      @ops[prof][:states] = [] if @ops[prof][:states].nil?
+      @ops[prof][:states]
+    end
+
+    def _state_meaning_table(prof = :default)
+      @ops[prof][:state_meaning] = {} if @ops[prof][:state_meaning].nil?
+      @ops[prof][:state_meaning]
+    end
+
+    def _meaning_states_table(prof = :default)
+      @ops[prof][:meaning_states] = {} if @ops[prof][:meaning_states].nil?
+      @ops[prof][:meaning_states]
+    end
+
+  end
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+  # end class methods
+
+
+  # 
+  # instance methods
+  #
+  def init_state(prof = :default)
+    prof = prof.to_sym if not prof.nil?
+    set_active_state_profile(prof)
+    update_state(self.class.initial_state(prof))
+  end
+
+  def activate_state_profile(prof)
+    prof = prof.to_sym if not prof.nil?
+    set_active_state_profile(prof)
+  end
+
+  def at_initial_state?
+    current_state == self.class.initial_state(active_state_profile)
+  end
+
+  def next_states
+    st = current_state
+    if not_empty?(st)
+      self.class.states_table(active_state_profile)[st.to_sym].map { |e| e.to_s }
+    else
+      []
+    end
+  end
+
+  def all_states
+    self.class.profile_states_list(active_state_profile).map { |s| s.to_s }
+  end
+
+  def apply_state(st)
+    
+    case st
+    when Symbol
+      sst = st
+    else
+      sst = st.to_sym
+    end
+
+    if next_states.include?(sst.to_s)
+      update_state(sst)
+      true
+    else
+      false
+    end
+  end
+  def apply_state!(st)
+    res = apply_state(st)
+    raise InvalidState, "Given new state '#{st}' is not valid" if not res
+  end
+
+
+  def next_events
+    se = self.class.state_events_table(active_state_profile)
+    cst = current_state
+    res = se[cst.to_sym]
+    # res == nil will happened if it is at the end of the event chain
+    res = [] if res.nil? 
+    res
+  end
+
+  def trigger_event(evt, &block)
+    evt = evt.to_sym if not evt.nil?
+    cst = current_state
+    if not_empty?(cst)
+      cst = cst.to_sym
+      tbl = self.class.event_states_table(active_state_profile)[evt]
+
+      raise InvalidEvent, "Event '#{evt}' not registered under profile '#{active_state_profile}'" if tbl.nil?
+
+      # current state not tie to from state of this event
+      raise InvalidStateForEvent, "Current state '#{cst}' is not register to event '#{evt}'" if not tbl.keys.include?(cst)
+      
+      destSt = tbl[cst]
+      raise InvalidStateForEvent, "New state transition from current state '#{cst}' due to event '#{evt}' is empty" if is_empty?(destSt)
+
+      evtBlock = self.class.event_block_table(active_state_profile)[evt]
+      update = true
+
+      update = evtBlock.call(action: :before, profile: active_state_profile, event: evt, from_state: cst, to_state: destSt, target: self) if not evtBlock.nil?
+      update = true if is_empty?(update) or not_bool?(update)
+
+      if update
+        apply_state(destSt)
+        evtBlock.call(action: :after, profile: active_state_profile, event: evt, from_state: cst, to_state: destSt, target: self) if not evtBlock.nil?
+        block.call(action: :after, profile: active_state_profile, event: evt, from_state: cst, to_state: destSt, target: self) if block
+      else
+        teLogger.error "Event '#{evt}' triggered but block returned false. Status not updated to '#{destSt}'"
+        raise UserHalt,"Event '#{evt}' triggered but block returned false. Status not updated to '#{destSt}'"
+      end
+
+    else
+      # current state is empty!
+    end
+  end
+
+  def current_state
+    if has_rattr?(self.class.state_attr_name(active_state_profile))
+      self.send("#{self.class.state_attr_name(active_state_profile)}")
+    else
+      nil
+    end
+  end
+
+  def state_profiles
+    self.class.state_profiles
+  end
+
+  def current_state_meaning
+    cst = current_state
+    smt = self.class.state_meaning_table(active_state_profile)
+    meaning = smt[cst.to_sym]
+    if meaning.nil?
+      :not_defined
+    else
+      meaning
+    end
+  end
+
+  def states_of_meaning(meaning)
+    res = self.class.meaning_states_table(active_state_profile)[meaning]
+    if not res.nil?
+      res
+    else
+      []
+    end
+  end
+
+  private
+  def has_wattr?(key)
+    self.respond_to?("#{key}=".to_sym)
+  end
+  def has_rattr?(key)
+    self.respond_to?("#{key}".to_sym)
+  end
+
+  def update_state(st)
+    if has_wattr?(self.class.state_attr_name(active_state_profile))
+      self.send("#{self.class.state_attr_name(active_state_profile)}=", st.to_s) 
+    end
+  end
+
+  def active_state_profile
+    @aprof = :default if is_empty?(@aprof)
+    @aprof
+  end
+
+  def set_active_state_profile(val)
+    @aprof = val
+  end
+
+  # instance methods
+
+end

data/statize.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/statize/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "statize"
+  spec.version       = Statize::VERSION
+  spec.authors       = ["Chris"]
+  spec.email         = ["chris@antrapol.com"]
+
+  spec.summary       = ""
+  spec.description   = ""
+  spec.homepage      = ""
+  spec.required_ruby_version = ">= 2.4.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"] = "TODO: Put your gem's public repo URL here."
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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 do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?: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"]
+
+  spec.add_dependency 'toolrack'
+  spec.add_dependency 'teLogger'
+
+  spec.add_development_dependency 'devops_assist'
+
+  # 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, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: statize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: toolrack
+  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: teLogger
+  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: devops_assist
+  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:
+- chris@antrapol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/statize.rb
+- lib/statize/version.rb
+- statize.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+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.22
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []