state_step 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c02c4955910af627a8d6b175ba2f1f4cd464a20ddfe201efea1279552ef68ee2
+  data.tar.gz: f3d4d2b160258ba314f61bbdd2208a2d9a04fe1a958c200fb10466ed17e7ded1
+SHA512:
+  metadata.gz: 3e799f54f69c8208649a0dd793b78ecef250f9d84a84b1ac38e1df6341ac4b8f4e781a695b1e775525921529af35d9db80abfdafad46e038a483a21aa5fcf5e1
+  data.tar.gz: 896b95e55acd3c7fd103dbe55fe1288080627f3f180a25512344d59f82d7efdd4d6e5f55ee5ea52ccf964422b91822f802c59d42f5cbe9637af31a9559b31d18

data/.rspec

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

data/README.md

@@ -0,0 +1,31 @@
+# StateStep
+
+TODO: Delete this and the text below, and describe your gem
+
+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/state_step`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## 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]/state_step.

data/Rakefile

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

data/lib/state_step/state_profile.rb

@@ -0,0 +1,123 @@
+
+require_relative 'state_trans'
+
+module StateStep
+  
+  class IncompleteStateSpec < StandardError; end
+  class ActionNotDefined < StandardError; end
+  
+  class StateProfile
+    include TR::CondUtils
+  
+    attr_reader :default_state, :state_attr
+
+    def parse_init(&block)
+      self.instance_eval(&block)
+    end
+
+    ## DSL
+    def default(st)
+      @default_state = st
+    end
+    alias_method :default_status, :default
+
+    def state_field(field)
+      @state_attr = field
+    end
+    alias_method :status_field, :state_field
+
+    def state(st, &block)
+      trans = st[:trans]
+      raise IncompleteStateSpec, "State transfer 'from' => 'to' state is not given" if is_empty?(trans)
+
+      from = trans.keys.first
+      to = trans.values.first
+      act = st[:action]
+
+      str = StateTrans.new(from, to, act, &block)
+
+      states[from] = {} if states[from].nil?
+      states[from][to] = str
+
+      next_states[from] = [] if next_states[from].nil?
+      next_states[from] << to
+
+      actions[act] = str
+
+      st
+    end
+
+    def trigger_action(act)
+      if actions.keys.include?(act) 
+        actions[act].trigger
+
+      else
+        raise ActionNotDefined, "Active '#{act}' to trigger not defined"
+
+      end
+    end
+
+    ## DSL
+
+    def next_actions
+      if @next_actions.nil?
+        @next_actions = { }
+
+        states.each do |from, tos|
+          next_actions[from] = [] if next_actions[from].nil?
+
+          tos.each do |to, val|
+            next_actions[from] << val.action_name
+          end
+
+        end
+
+      end
+
+      @next_actions
+    end
+
+    def defined_states
+      
+      if @_allStates.nil?
+        @_allStates = []
+        states.each do |k,v|
+          @_allStates << k.to_s
+          v.each do |vk, vv|
+            @_allStates << vk.to_s
+          end
+        end
+        @_allStates = @_allStates.uniq
+      end
+      @_allStates
+    end
+
+
+    private
+    def states 
+      if @states.nil?
+        @states = { }
+      end
+
+      @states
+    end
+
+    def actions
+      if @actions.nil?
+        @actions = { }
+      end
+
+      @actions
+    end
+
+    def next_states
+      if @next_states.nil?
+        @next_states = { }
+      end
+
+      @next_states
+    end
+
+
+  end
+end

data/lib/state_step/state_trans.rb

@@ -0,0 +1,28 @@
+
+
+
+module StateStep
+  class StateTrans
+
+    attr_reader :stFrom, :stTo, :action_name
+    def initialize(from, to, name, &block)
+      @stFrom = from
+      @stTo = to
+      @action_name = name
+      @callback = block
+    end
+
+    def trigger
+      st = @callback.call
+      StateStep.logger.debug "st.nil? : #{st.nil?} / st = '#{st}'"
+      if st.nil? or st == true
+        StateStep.logger.debug "Status changed!"
+        @stTo
+      else
+        StateStep.logger.debug "Status reverted!"
+        @stFrom
+      end
+    end
+
+  end
+end

data/lib/state_step/version.rb

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

data/lib/state_step.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'toolrack'
+require 'teLogger'
+
+require_relative "state_step/version"
+require_relative "state_step/state_profile"
+
+module StateStep
+  include TR::CondUtils
+
+  class Error < StandardError; end
+  # Your code goes here...
+
+  def self.logger(tag = nil, &block)
+    if @_logger.nil?
+      @_logger = TeLogger::Tlogger.new
+    end
+
+    if block
+      if not_empty?(tag)
+        @_logger.with_tag(tag, &block)
+      else
+        @_logger.with_tag(@_logger.tag, &block)
+      end
+    else
+      if is_empty?(tag)
+        @_logger.tag = :state_step
+        @_logger
+      else
+        # no block but tag is given? hmm
+        @_logger.tag = tag
+        @_logger
+      end
+    end
+
+  end # def logger
+
+
+  ## class methods
+  module ClassMethods
+
+    def status_init(&block)
+      profile.parse_init(&block) 
+    end
+    alias_method :states_init, :status_init
+
+    def profile
+      if @profile.nil?
+        @profile = StateProfile.new
+      end
+      @profile
+    end
+
+    def defined_states
+      profile.defined_states
+    end
+    alias_method :defined_status, :defined_states
+  end
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+  ## End class methods
+
+  ## 
+  # Instance methods
+  ##
+  def default_status
+    self.class.profile.default_state
+  end
+
+  def init_default_status
+    if status_field_exist?
+      self.send("#{state_field_name}=", default_status)
+    else
+      # raise here because the init is manual
+      # manual means user IS expecting some status changed
+      # Default here is not appropriate
+      StateStep.logger.debug "Status field '#{state_field_name}' does not exist on #{self}" 
+      raise Error, "Status field '#{state_field_name}' does not exist on '#{self}'"
+    end
+  end
+
+  def is_current_status?(st)
+    if status_field_exist?
+      self.send("#{state_field_name}") == st.to_s
+    else
+      raise Error, "Status field name '#{state_field_name}' not defined" 
+    end
+  end
+  alias_method :is_current_state?, :is_current_status?
+
+  def state_field_name
+    self.class.profile.state_attr
+  end
+
+  def state_trigger_action(action, raise_if_not_found = false)
+
+    if status_field_exist?
+      begin
+        nst = self.class.profile.trigger_action(action)
+        self.send("#{self.class.profile.state_attr}=", nst)
+        true
+      rescue ActionNotDefined => e
+        if raise_if_not_found == true
+          raise e 
+        else
+          false
+        end
+      end
+
+    else
+
+      StateStep.logger.debug "Status field '#{state_field_name}' does not exist" 
+
+    end
+
+  end
+
+  def next_actions
+    currAction = self.send("#{state_field_name}")
+    currAction = currAction.to_sym if not_empty?(currAction)
+
+    res = self.class.profile.next_actions[currAction] || []
+    res
+  end
+
+  private
+  def status_field_exist?
+    self.respond_to?(state_field_name) and self.respond_to?("#{state_field_name}=")
+  end
+
+end

data/sig/state_step.rbs

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

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: state_step
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Chris
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-09 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: release-gem
+  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"
+- README.md
+- Rakefile
+- lib/state_step.rb
+- lib/state_step/state_profile.rb
+- lib/state_step/state_trans.rb
+- lib/state_step/version.rb
+- sig/state_step.rbs
+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.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: ''
+test_files: []