pushdown 0.1.0.pre.20210714190141 → 0.1.0

data/spec/pushdown/transition/pop_spec.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../../spec_helper'
+
+require 'pushdown/transition/pop'
+require 'pushdown/state'
+
+
+RSpec.describe( Pushdown::Transition::Pop ) do
+
+	let( :state_class ) do
+		Class.new( Pushdown::State )
+	end
+
+	let( :state_a ) { state_class.new }
+	let( :state_b ) { state_class.new }
+	let( :state_c ) { state_class.new }
+
+	let( :state_data ) { Object.new }
+
+	let( :stack ) do
+		return [ state_a, state_b, state_c ]
+	end
+
+
+	it "pops the last state from the stack when applied" do
+		stack = [ state_a, state_b, state_c ]
+		transition = described_class.new( :pop_test )
+
+		new_stack = transition.apply( stack )
+
+		expect( new_stack ).to eq([ state_a, state_b ])
+	end
+
+
+	it "passes state data through the transition callbacks" do
+		transition = described_class.new( :pop_test, state_data )
+
+		expect( state_c ).to receive( :on_stop ).with( state_data ).
+			and_return( state_data ).once.ordered
+		expect( state_b ).to receive( :on_resume ).with( state_data ).once.ordered
+
+		transition.apply( stack )
+	end
+
+
+	it "errors if applied to a stack that has only one state" do
+		stack = [ state_a ]
+		transition = described_class.new( :pop_test )
+
+		expect {
+			transition.apply( stack )
+		}.to raise_error( Pushdown::TransitionError, /can't pop/i )
+	end
+
+
+	it "errors if applied to an empty stack" do
+		stack = []
+		transition = described_class.new( :pop_test )
+
+		expect {
+			transition.apply( stack )
+		}.to raise_error( Pushdown::TransitionError, /can't pop/i )
+	end
+
+end
+

data/spec/pushdown/transition/push_spec.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../../spec_helper'
+
+require 'pushdown'
+require 'pushdown/transition/push'
+
+
+RSpec.describe( Pushdown::Transition::Push ) do
+
+	let( :state_class ) do
+		Class.new( Pushdown::State )
+	end
+	let( :other_state_class ) do
+		Class.new( Pushdown::State )
+	end
+
+	let( :state_a ) { state_class.new }
+	let( :state_b ) { state_class.new }
+	let( :state_c ) { other_state_class.new }
+
+	let( :stack ) do
+		return [ state_a, state_b ]
+	end
+
+	let( :state_data ) { Object.new }
+
+
+	it "pushes a new state onto the stack when applied" do
+		transition = described_class.new( :push_test, other_state_class )
+
+		new_stack = transition.apply( stack )
+
+		expect( new_stack ).to be_an( Array )
+		expect( new_stack.length ).to eq( 3 )
+		expect( new_stack.last ).to be_a( other_state_class )
+	end
+
+
+	it "passes state data through the transition callbacks" do
+		transition = described_class.new( :push_test, other_state_class, state_data )
+
+		expect( state_b ).to receive( :on_pause ).
+			with( state_data ).once.and_return( state_data ).ordered
+
+		expect( other_state_class ).to receive( :new ).and_return( state_c )
+		expect( state_c ).to receive( :on_start ).with( state_data ).once.ordered
+
+		transition.apply( stack )
+	end
+
+end
+

data/spec/pushdown/transition/replace_spec.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../../spec_helper'
+
+require 'pushdown/transition/replace'
+require 'pushdown/state'
+
+RSpec.describe( Pushdown::Transition::Replace ) do
+
+	let( :state_class ) do
+		Class.new( Pushdown::State )
+	end
+	let( :other_state_class ) do
+		Class.new( Pushdown::State )
+	end
+
+	let( :state_a ) { state_class.new }
+	let( :state_b ) { state_class.new }
+	let( :state_c ) { state_class.new }
+	let( :state_d ) { other_state_class.new }
+
+	let( :stack ) do
+		return [ state_a, state_b, state_c ]
+	end
+
+	let( :state_data ) { Object.new }
+
+
+	it "replaces the current stack members with a single new instance of a state when applied" do
+		transition = described_class.new( :replace_test, other_state_class )
+
+		new_stack = transition.apply( stack )
+
+		expect( new_stack ).to be_an( Array )
+		expect( new_stack.length ).to eq( 1 )
+		expect( new_stack.last ).to be_a( other_state_class )
+	end
+
+
+	it "passes state data through the transition callbacks" do
+		transition = described_class.new( :replace_test, other_state_class, state_data )
+
+		expect( state_c ).to receive( :on_stop ).
+			with( state_data ).once.and_return( state_data ).ordered
+		expect( state_b ).to receive( :on_stop ).
+			with( state_data ).once.and_return( state_data ).ordered
+		expect( state_a ).to receive( :on_stop ).
+			with( state_data ).once.and_return( state_data ).ordered
+
+		expect( other_state_class ).to receive( :new ).and_return( state_c )
+		expect( state_c ).to receive( :on_start ).with( state_data ).once.ordered
+
+		transition.apply( stack )
+	end
+
+end
+

data/spec/pushdown/transition/switch_spec.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../../spec_helper'
+
+require 'pushdown/transition/switch'
+require 'pushdown/state'
+
+RSpec.describe( Pushdown::Transition::Switch ) do
+
+	let( :state_class ) do
+		Class.new( Pushdown::State )
+	end
+	let( :other_state_class ) do
+		Class.new( Pushdown::State )
+	end
+
+	let( :state_a ) { state_class.new }
+	let( :state_b ) { state_class.new }
+	let( :state_c ) { other_state_class.new }
+
+	let( :stack ) do
+		return [ state_a, state_b ]
+	end
+
+	let( :state_data ) { Object.new }
+
+
+	it "pops the current state off the stack and adds a new state when applied" do
+		transition = described_class.new( :switch_test, other_state_class )
+
+		new_stack = transition.apply( stack )
+
+		expect( new_stack ).to be_an( Array )
+		expect( new_stack.length ).to eq( 2 )
+		expect( new_stack.last ).to be_a( other_state_class )
+	end
+
+
+	it "passes state data through the transition callbacks" do
+		transition = described_class.new( :switch_test, other_state_class, state_data )
+
+		expect( state_b ).to receive( :on_stop ).
+			with( state_data ).once.and_return( state_data ).ordered
+
+		expect( other_state_class ).to receive( :new ).and_return( state_c )
+		expect( state_c ).to receive( :on_start ).with( state_data ).once.ordered
+
+		transition.apply( stack )
+	end
+
+end
+

data/spec/pushdown/transition_spec.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../spec_helper'
+
+require 'pushdown/transition'
+require 'pushdown/state'
+
+
+RSpec.describe( Pushdown::Transition ) do
+
+	let( :state_class ) do
+		Class.new( Pushdown::State )
+	end
+
+	let( :state_a ) { state_class.new }
+	let( :state_b ) { state_class.new }
+
+
+	it "is an abstract class" do
+		expect {
+			described_class.new( :change_state )
+		}.to raise_error( NoMethodError )
+	end
+
+
+	describe 'complete concrete subclass' do
+
+		let( :subclass ) do
+			Class.new( described_class ) do
+
+				def initialize( name, new_state, *args )
+					super( name, *args )
+					@new_state = new_state
+				end
+
+				attr_reader :new_state
+
+				def apply( stack )
+					stack.push( self.new_state.new )
+					return stack
+				end
+
+			end
+		end
+
+		it "can be instantiated" do
+			result = subclass.new( :change_state, state_class )
+			expect( result ).to be_a( described_class )
+			expect( result.name ).to eq( :change_state )
+		end
+
+
+		it "requires a name to be instantiated" do
+			expect {
+				subclass.new
+			}.to raise_error( ArgumentError, /wrong number of arguments/i )
+		end
+
+
+		it "can alter the stack" do
+			stack = [ state_a, state_b ]
+			transition = subclass.new( :go_home, state_class )
+
+			result = transition.apply( stack )
+
+			expect( result ).to be_an( Array )
+			expect( result.length ).to eq( 3 )
+			expect( result.last ).to be_a( state_class )
+		end
+
+	end
+
+
+	describe 'incomplete concrete subclass' do
+
+		let( :subclass ) { Class.new(described_class) }
+
+
+		it "raises an error when applied to a stack" do
+			stack = [ state_a, state_b ]
+			transition = subclass.new( :change_state )
+
+			expect {
+				transition.apply( stack )
+			}.to raise_error( NotImplementedError, /apply/i )
+		end
+
+	end
+
+end
+

data/spec/spec_helper.rb

@@ -7,6 +7,8 @@ require 'rspec'
 
 require 'loggability/spechelpers'
 
+require 'pushdown'
+
 
 ### Mock with RSpec
 RSpec.configure do |config|
@@ -23,6 +25,8 @@ RSpec.configure do |config|
 	config.run_all_when_everything_filtered = true
 	config.shared_context_metadata_behavior = :apply_to_host_groups
 	# config.warnings = true
+
+	config.include( Loggability::SpecHelpers )
 end
 
 

metadata

@@ -1,15 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: pushdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.20210714190141
+  version: 0.1.0
 platform: ruby
 authors:
 - Michael Granger
 autorequire:
 bindir: bin
-cert_chain: []
-date: 2021-07-14 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIID+DCCAmCgAwIBAgIBAzANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdnZWQv
+  REM9RmFlcmllTVVEL0RDPW9yZzAeFw0yMDEyMjQyMDU1MjlaFw0yMTEyMjQyMDU1
+  MjlaMCIxIDAeBgNVBAMMF2dlZC9EQz1GYWVyaWVNVUQvREM9b3JnMIIBojANBgkq
+  hkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAvyVhkRzvlEs0fe7145BYLfN6njX9ih5H
+  L60U0p0euIurpv84op9CNKF9tx+1WKwyQvQP7qFGuZxkSUuWcP/sFhDXL1lWUuIl
+  M4uHbGCRmOshDrF4dgnBeOvkHr1fIhPlJm5FO+Vew8tSQmlDsosxLUx+VB7DrVFO
+  5PU2AEbf04GGSrmqADGWXeaslaoRdb1fu/0M5qfPTRn5V39sWD9umuDAF9qqil/x
+  Sl6phTvgBrG8GExHbNZpLARd3xrBYLEFsX7RvBn2UPfgsrtvpdXjsHGfpT3IPN+B
+  vQ66lts4alKC69TE5cuKasWBm+16A4aEe3XdZBRNmtOu/g81gvwA7fkJHKllJuaI
+  dXzdHqq+zbGZVSQ7pRYHYomD0IiDe1DbIouFnPWmagaBnGHwXkDT2bKKP+s2v21m
+  ozilJg4aar2okb/RA6VS87o+d7g6LpDDMMQjH4G9OPnJENLdhu8KnPw/ivSVvQw7
+  N2I4L/ZOIe2DIVuYH7aLHfjZDQv/mNgpAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYD
+  VR0PBAQDAgSwMB0GA1UdDgQWBBRyjf55EbrHagiRLqt5YAd3yb8k4DANBgkqhkiG
+  9w0BAQsFAAOCAYEAMYegZanJi8zq7QKPT7wqXefX4C88I5JWeBHR3PvvWK0CwyMV
+  peyiu5I13w/lYX+HUZjE4qsSpJMJFXWl4WZCOo+AMprOcf0PxfuJpxCej5D4tavf
+  vRfhahSw7XJrcZih/3J+/UgoH7R05MJ+8LTcy3HGrB3a0vTafjm8OY7Xpa0LJDoN
+  JDqxK321VIHyTibbKeA1hWSE6ljlQDvFbTqiCj3Ulp1jTv3TOlvRl8fqcfhxUJI0
+  +5Q82jJODjEN+GaWs0V+NlrbU94cXwS2PH5dXogftB5YYA5Ex8A0ikZ73xns4Hdo
+  XxdLdd92F5ovxA23j/rKe/IDwqr6FpDkU3nPXH/Qp0TVGv9zZnVJc/Z6ChkuWj8z
+  pW7JAyyiiHZgKKDReDrA2LA7Zs3o/7KA6UtUH0FHf8LYhcK+pfHk6RtjRe65ffw+
+  MCh97sQ/Z/MOusb5+QddBmB+k8EicXyGNl4b5L4XpL7fIQu+Y96TB3JEJlShxFD9
+  k9FjI4d9EP54gS/4
+  -----END CERTIFICATE-----
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: loggability
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: pluggability
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: e2mmap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake-deveiate
   requirement: !ruby/object:Gem::Requirement
@@ -32,22 +99,36 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".simplecov"
 - History.md
+- LICENSE.txt
 - README.md
-- Rakefile
 - lib/pushdown.rb
+- lib/pushdown/automaton.rb
+- lib/pushdown/exceptions.rb
+- lib/pushdown/state.rb
+- lib/pushdown/transition.rb
+- lib/pushdown/transition/pop.rb
+- lib/pushdown/transition/push.rb
+- lib/pushdown/transition/replace.rb
+- lib/pushdown/transition/switch.rb
+- spec/pushdown/automaton_spec.rb
+- spec/pushdown/state_spec.rb
+- spec/pushdown/transition/pop_spec.rb
+- spec/pushdown/transition/push_spec.rb
+- spec/pushdown/transition/replace_spec.rb
+- spec/pushdown/transition/switch_spec.rb
+- spec/pushdown/transition_spec.rb
 - spec/pushdown_spec.rb
 - spec/spec_helper.rb
 homepage: http://hg.sr.ht/~ged/Pushdown
 licenses:
 - BSD-3-Clause
 metadata:
-  bug_tracker_uri: http://todo.sr.ht/~ged/Pushdown
-  changelog_uri: http://deveiate.org/code/pushdown/History_md.html
-  documentation_uri: http://deveiate.org/code/pushdown
   homepage_uri: http://hg.sr.ht/~ged/Pushdown
+  documentation_uri: http://deveiate.org/code/pushdown
+  changelog_uri: http://deveiate.org/code/pushdown/History_md.html
   source_uri: http://hg.sr.ht/~ged/Pushdown
+  bug_tracker_uri: http://todo.sr.ht/~ged/Pushdown
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -59,9 +140,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: