stateful-simple 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fe68e13582d8019215abdbe923c7c2cbbbca3ca
+  data.tar.gz: 7f6f02d7f9dba92e7942c00de3d2c5e9530e8c9e
+SHA512:
+  metadata.gz: 2cfb5c2f1245d89312ab0b105c1de27226fa230547070f389e5b32bd822a151397511e4fb536646a60a96c1a77a9b19bc75c1f41a5a09586cda70a12fb06e5d8
+  data.tar.gz: 33ff7b160a3bee7fd366cd5c991bdc32bf976d0e971af573360f437ebc6c1aecf1ce99c349326c152c6e51ca3088e86e1d16860bb23ab550b11dfd390932dbd1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Chris Liaw
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# Stateful
+
+Stateful is inspired by event machine....I think...
+
+It was an old library (> 5 years) converted to gem to facilitate state transfer of a record from one to another. 
+
+Idea is to have different chained state and its associated action that causes the state changed.
+
+For example, in real world visualization, an user account's status can be seen from
+```
+         (event: activate)
+active -------------------->>> inactive
+       <<<--------------------
+         (event: inactivate)
+```
+
+Hence the activate event/action will cause the user state changed from active to inactive and inactivate event/action shall cause the user state changed from inactive to active.
+
+The major usage of this gem is now at the view of the rails application, the developer shall know what is the next possible action that could display to the user. 
+Now system can prompt user "inactivate user" instead of edit screen via "change status" link and select another status from the list.
+
+
+## Usage
+Stateful tied to ActiveRecord. In order to use:
+
+```ruby
+class User < ApplicationRecord
+	# Indicate that stateful gem to be used. With initial status set to "active" (:active.to_s)
+	stateful initial: :active
+
+	# transform is state transfer specification, from state :active to :inactive
+	transform :active => :inactive do
+		# forward means from :active to :inactive, the event name is "inactive"
+		forward :inactivate
+		# backward means from :inactive to :active, the event name is "active"
+		backward :activate
+	end
+
+	# if there are other state transfer specification, can add more...
+	
+end
+```
+Noted however that the database field used by the stateful is 'state' (string field).
+
+Once the model is activated with stateful, it can be changed its state by invoking the appropriate event/action by invoking the event name with exclamation mark
+
+```ruby
+@model.<event/action name>!
+```
+or
+```ruby
+@model.send "#{<event/action name>}!"
+```
+
+Example to change the status from "active" to "inactive"
+```ruby
+@model.inactivate!
+```
+
+In the event that the action is not actually the next possible action, the status remained untouched and false shall be returned.
+ 
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stateful'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install stateful
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Stateful'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/stateful_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/stateful .js
+//= link_directory ../stylesheets/stateful .css

data/app/assets/javascripts/stateful/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/stateful/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/stateful/application_controller.rb

@@ -0,0 +1,5 @@
+module Stateful
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/stateful/application_helper.rb

@@ -0,0 +1,4 @@
+module Stateful
+  module ApplicationHelper
+  end
+end

data/app/jobs/stateful/application_job.rb

@@ -0,0 +1,4 @@
+module Stateful
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/stateful/application_mailer.rb

@@ -0,0 +1,6 @@
+module Stateful
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/stateful/application_record.rb

@@ -0,0 +1,5 @@
+module Stateful
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/stateful/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Stateful</title>
+  <%= stylesheet_link_tag    "stateful/application", media: "all" %>
+  <%= javascript_include_tag "stateful/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Stateful::Engine.routes.draw do
+end

data/lib/stateful.rb

@@ -0,0 +1,187 @@
+require "stateful/engine"
+
+module Stateful
+	class Event
+		attr_accessor :new_events
+		def initialize(states,es_table)
+			# mapping of { :event => [{:transition => {:from_state => :to_state}, :guard => Proc..., },
+			#                         {:transition => {:from_state => :to_state}, :guard => Proc...,}
+			#                         ] }
+			@es_table = es_table
+			@states = states					
+			@new_events = []
+		end
+
+		def forward(event,opts={})
+			#puts "Forward Event : #{event}"
+			#puts "States : #{@states}"
+			if @es_table[event] == nil
+				@new_events << event
+				@es_table[event] = []
+			end
+			@es_table[event] << { :transition => { @states.keys[0] => @states.values[0] }, :guard => opts[:guard] }
+			#p @event_states
+		end
+
+		def backward(event,opts={})
+			#puts "Backward Event : #{event}"
+			#puts "States : #{@states}"
+			if @es_table[event] == nil
+				@new_events << event
+				@es_table[event] = []
+			end
+			@es_table[event] << { :transition => { @states.values[0] => @states.keys[0] }, :guard => opts[:guard] }
+			#p @event_states
+		end
+
+		def fire_event(event,record,auto_commit = true)
+			current = record.state.to_sym
+			#p record.event_states_table[event]
+			@success = false
+			#record.event_states_table[event].each do |evt|
+			@es_table[event].each do |evt|
+				if evt[:transition].keys[0] == current
+					if evt[:guard] != nil
+						if evt[:guard].call(record)
+							record.state = evt[:transition].values[0].to_s if evt[:transition].keys[0] == current
+							record.save if auto_commit  # to comply to '!' notication of the method
+							@success = true
+							break # break here to honour the first guard found and return true
+						end
+					else
+						record.state = evt[:transition].values[0].to_s if evt[:transition].keys[0] == current
+						record.save if auto_commit  # to comply to '!' notication of the method
+						@success = true
+					end
+				end
+			end
+			@success
+		end
+	end
+	# end Event class	
+end
+
+module Stateful
+	module StateMachine
+		extend ActiveSupport::Concern
+
+		#mattr_accessor :_states, :initial, :options, :event_states_table
+
+		included do
+		end
+
+		module ClassMethods
+
+			def stateful(opts = {})
+				options = {
+					initial: "open",
+					column_name: "state"
+				}
+
+				options.merge!(opts)
+				#opts[:initial] = "open" if opts[:initial] == nil or opts[:initial].empty?
+				#opts[:column_name] = "state"
+
+				#@@_states = []
+				#@@initial = options[:initial]
+				#@@options = options
+				#@@event_states_table = {}
+				self.class_variable_set(:@@_states,[])
+				#self.class_variable_set(:@@initial,opts[:initial])
+				self.class_variable_set(:@@initial,options[:initial])
+				self.class_variable_set(:@@options, options)
+				self.class_variable_set(:@@event_states_table,{})			
+			end
+
+			def transform(states,opts={},&block)
+				#puts "From state : #{states.keys[0]}"
+				_states = class_variable_get :@@_states
+				event_states_table = class_variable_get :@@event_states_table
+				_states << states.keys[0].to_sym if !_states.include?(states.keys[0].to_sym)
+				#puts "To state : #{states.values[0]}"
+				_states << states.values[0].to_sym if !_states.include?(states.values[0].to_sym)
+				e = Event.new(states,event_states_table)
+				e.instance_eval(&block) if block
+				e.new_events.each do |evt|
+					define_method("#{evt}!") { 
+						e.fire_event(evt,self) 
+					}
+
+					define_method("#{evt}") { 
+						e.fire_event(evt,self,false) 
+					}
+				end
+				#puts "Event states table"
+				#p event_states_table
+			end
+
+			def states
+				class_variable_get :@@_states
+			end
+
+		end # end ClassMethods
+
+		# instance methods
+		def possible_events
+			@events = []
+			opts = self.class.class_variable_get :@@options
+			if self.has_attribute?(opts[:column_name].to_sym)
+
+				@current = send(opts[:column_name].to_sym).to_sym #self.state.to_sym
+				event_states_table = self.class.class_variable_get :@@event_states_table
+				event_states_table.keys.each do |k|
+					event_states_table[k].each do |s|
+						if s[:transition].keys[0] == @current and !@events.include?(k)
+							if s[:guard] != nil
+								puts "guard result #{s[:guard].call(self)} for #{k}"
+								if s[:guard].call(self)
+									@events << k
+								end
+							else
+								@events << k
+							end
+						end
+					end
+				end
+
+			end
+			@events
+		end 
+		alias :next_actions :possible_events
+
+		def initialize(*arg)
+			super(*arg)
+			# 23 Aug 2014 - guard is to handle migration
+			# If a model is not stateful but later it become stateful in subsequent migration script
+			# and at the same time, there are default data created in the initial migration
+			# script which creating new records. Migration will failed since there is no
+			# state column. State column only exist further down the migration.
+			# If the state field does not exist, just skipped that first. After all, it is not
+			# important by the time initial migration scirpt was run
+			begin
+				opts = self.class.class_variable_get :@@options
+				#opts = @@options
+				if self.attributes.keys.include? opts[:column_name].to_s
+					if self.class.class_variable_defined? :@@initial
+						self.send("#{opts[:column_name]}=", opts[:initial])
+						#self.state = self.class.class_variable_get :@@initial
+						#self.state = self.state.to_s if self.state != nil
+					end
+				end
+			
+			rescue Exception => ex
+			end
+			#opts = self.class.class_variable_get :@@options
+			##opts = @@options
+			#if self.attributes.keys.include? opts[:column_name].to_s
+			#	if self.class.class_variable_defined? :@@initial
+			#		self.send("#{opts[:column_name]}=", opts[:initial])
+			#		#self.state = self.class.class_variable_get :@@initial
+			#		#self.state = self.state.to_s if self.state != nil
+			#	end
+			#end
+		end
+
+	end
+end
+

data/lib/stateful/engine.rb

@@ -0,0 +1,12 @@
+module Stateful
+  class Engine < ::Rails::Engine
+    isolate_namespace Stateful
+		
+		config.to_prepare do
+			# include into ApplicationController
+			#ActionController::Base.send :include, Canopus::Concerns::Controllers::Authenticator
+			ActiveRecord::Base.send :include, Stateful::StateMachine
+		end		
+		
+  end
+end

data/lib/stateful/version.rb

@@ -0,0 +1,3 @@
+module Stateful
+  VERSION = '0.1.0'
+end

data/lib/tasks/stateful_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :stateful do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: stateful-simple
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Liaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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:
+- chrisliaw@antrapol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/stateful_manifest.js
+- app/assets/javascripts/stateful/application.js
+- app/assets/stylesheets/stateful/application.css
+- app/controllers/stateful/application_controller.rb
+- app/helpers/stateful/application_helper.rb
+- app/jobs/stateful/application_job.rb
+- app/mailers/stateful/application_mailer.rb
+- app/models/stateful/application_record.rb
+- app/views/layouts/stateful/application.html.erb
+- config/routes.rb
+- lib/stateful.rb
+- lib/stateful/engine.rb
+- lib/stateful/version.rb
+- lib/tasks/stateful_tasks.rake
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []