state_machine_checker 0.1.0

data/lib/state_machine_checker/rspec_matchers.rb

@@ -0,0 +1,60 @@
+require "state_machine_checker"
+
+module StateMachineChecker
+  module RspecMatchers
+    def satisfy(formula)
+      SatisfyMatcher.new(formula)
+    end
+
+    class SatisfyMatcher
+      include StateMachineChecker
+
+      def initialize(formula)
+        @formula = formula
+      end
+
+      def description
+        "satisfy \"#{formula}\""
+      end
+
+      def diffable?
+        false
+      end
+
+      def matches?(instance_generator)
+        @instance_generator = instance_generator
+        @result = check_satisfied(formula, instance_generator)
+        @result.satisfied?
+      end
+
+      def failure_message
+        <<~MESSAGE
+          Expected state machine for #{machine_name} to satisfy "#{formula}" but it does not.
+          Counterexample: #{result.counterexample}
+        MESSAGE
+      end
+
+      def failure_message_when_negated
+        <<~MESSAGE
+          Expected state machine for #{machine_name} not to satisfy "#{formula}" but it does.
+          Witness: #{result.witness}
+        MESSAGE
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+      private
+
+      attr_reader :instance_generator, :formula, :result
+
+      def machine_name
+        # TODO: This assumes state_machines gem
+        klass = instance_generator.call.class
+        gem_machine = klass.state_machine
+        "#{klass}##{gem_machine.name}"
+      end
+    end
+  end
+end

data/lib/state_machine_checker/state_result.rb

@@ -0,0 +1,57 @@
+module StateMachineChecker
+  # The result of checking whether this state satisfies a formula.
+  class StateResult
+    # @param [Boolean] satisfied
+    # @param [Array<Symbol>] path
+    def initialize(satisfied, path)
+      @satisfied = satisfied
+      @path = path
+    end
+
+    # Whether the formula is satisfied from this state.
+    #
+    # @return [true, false]
+    def satisfied?
+      satisfied
+    end
+
+    # A witness that the formula is satisfied from this state.
+    #
+    # @return [Array<Symbol>] an array of the names of transitions.
+    def witness
+      if satisfied?
+        path
+      end
+    end
+
+    # A counterexample demonstrating that the formula is not satisfied from this
+    # state.
+    #
+    # @return [Array<Symbol>] an array of the names of transitions.
+    def counterexample
+      unless satisfied?
+        path
+      end
+    end
+
+    def or(other)
+      if satisfied?
+        self
+      else
+        other
+      end
+    end
+
+    def and(other)
+      if !other.satisfied?
+        other
+      else
+        self
+      end
+    end
+
+    private
+
+    attr_reader :satisfied, :path
+  end
+end

data/lib/state_machine_checker/transition.rb

@@ -0,0 +1,49 @@
+module StateMachineChecker
+  # A transition from one state to another
+  class Transition
+    attr_reader :from, :to, :name
+
+    # @param [Symbol] from the starting state.
+    # @param [Symbol] to the ending state.
+    # @param [Symbol] name the name of the transition.
+    def initialize(from, to, name)
+      @from = from
+      @to = to
+      @name = name
+    end
+
+    # Execute the transition on an instance.
+    #
+    # This assumes that the instance has a method corresponding to the
+    # transition name, and that that will return a boolean representing whether
+    # the transition was successful.
+    #
+    # @param instance the instance to execute the transition on.
+    def execute(instance)
+      # TODO: calling the "bang" version (to raise on failure) is specific to
+      # the state_machines gem.
+      instance.public_send("#{name}!")
+    end
+
+    def ==(other)
+      hash_attributes.all? { |attr|
+        other.respond_to?(attr) &&
+          other.public_send(attr) == public_send(attr)
+      }
+    end
+
+    def eql?(other)
+      other == self
+    end
+
+    def hash
+      hash_attributes.map(&:hash).hash
+    end
+
+    private
+
+    def hash_attributes
+      [:from, :to, :name]
+    end
+  end
+end

data/lib/state_machine_checker/version.rb

@@ -0,0 +1,3 @@
+module StateMachineChecker
+  VERSION = "0.1.0"
+end

data/lib/state_machine_checker.rb

@@ -0,0 +1,43 @@
+require "state_machine_checker/version"
+require "state_machine_checker/finite_state_machine"
+require "state_machine_checker/labeled_machine"
+require "state_machine_checker/labeling"
+require "state_machine_checker/adapters/state_machines"
+require "state_machine_checker/ctl/api"
+
+# The main entrypoint is {#check_satisfied}. The other methods are provided
+# primarily for debugging and transparency.
+module StateMachineChecker
+  # Check whether a formula is satisfied by the state machine of a given class.
+  #
+  # @param [CTL::Formula] formula the formula that should be satisfied.
+  # @param instance_generator a thunk (zero-argument function) that must return
+  #   an instance of an object containing a state machine. The instance must be
+  #   in the initial state.
+  # @return [StateResult] the result for the initial state.
+  def check_satisfied(formula, instance_generator)
+    labeled_machine = build_labeled_machine(formula, instance_generator)
+    check = formula.check(labeled_machine)
+    check.for_state(labeled_machine.initial_state)
+  end
+
+  # Build a labeled machine (Kripke structure) over the atomic propositions
+  # contained in the given formula.
+  #
+  # @param [CTL::Formula] formula the formula from which to extract atomic
+  #   propositions.
+  # @param instance_generator a thunk (zero-argument function) that must return
+  #   an instance of an object containing a state machine. The instance must be
+  #   in the initial state.
+  # @return [LabeledMachine]
+  def build_labeled_machine(formula, instance_generator)
+    # TODO: Assumes state_machines gem.
+    gem_machine = instance_generator.call.class.state_machine
+    adapter = Adapters::StateMachines.new(gem_machine)
+    fsm = FiniteStateMachine.new(adapter.initial_state, adapter.transitions)
+    LabeledMachine.new(
+      fsm,
+      Labeling.new(formula.atoms, fsm, instance_generator)
+    )
+  end
+end

data/state_machine_checker.gemspec

@@ -0,0 +1,47 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "state_machine_checker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "state_machine_checker"
+  spec.version       = StateMachineChecker::VERSION
+  spec.authors       = ["Chris Stadler"]
+  spec.email         = ["chrisstadler@gmail.com"]
+
+  spec.summary       = "Model checking for state machines using CTL."
+  spec.description   = <<~DESC
+    Verify that your state machines have the expected properties. Properties are
+    specified using CTL.
+  DESC
+  spec.homepage      = "https://github.com/CJStadler/state_machine_checker"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/CJStadler/state_machine_checker"
+    spec.metadata["changelog_uri"] =
+      "https://github.com/CJStadler/state_machine_checker/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").
+      reject { |f| f.match(%r{^(test|spec|features)/}) }.
+      reject { |f| f.match('paper.pdf')}
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "state_machines", "~> 0.5.0"
+  spec.add_development_dependency "standard", "~> 0.0.36"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "yard", "~> 0.9.18"
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: state_machine_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Stadler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: state_machines
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.36
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.36
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.18
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.18
+description: |
+  Verify that your state machines have the expected properties. Properties are
+  specified using CTL.
+email:
+- chrisstadler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/state_machine_checker.rb
+- lib/state_machine_checker/adapters/state_machines.rb
+- lib/state_machine_checker/check_result.rb
+- lib/state_machine_checker/ctl/a_f.rb
+- lib/state_machine_checker/ctl/a_g.rb
+- lib/state_machine_checker/ctl/a_u.rb
+- lib/state_machine_checker/ctl/a_x.rb
+- lib/state_machine_checker/ctl/and.rb
+- lib/state_machine_checker/ctl/api.rb
+- lib/state_machine_checker/ctl/atom.rb
+- lib/state_machine_checker/ctl/binary_formula.rb
+- lib/state_machine_checker/ctl/e_f.rb
+- lib/state_machine_checker/ctl/e_g.rb
+- lib/state_machine_checker/ctl/e_u.rb
+- lib/state_machine_checker/ctl/e_x.rb
+- lib/state_machine_checker/ctl/formula.rb
+- lib/state_machine_checker/ctl/implication.rb
+- lib/state_machine_checker/ctl/not.rb
+- lib/state_machine_checker/ctl/or.rb
+- lib/state_machine_checker/ctl/unary_operator.rb
+- lib/state_machine_checker/finite_state_machine.rb
+- lib/state_machine_checker/labeled_machine.rb
+- lib/state_machine_checker/labeling.rb
+- lib/state_machine_checker/rspec_matchers.rb
+- lib/state_machine_checker/state_result.rb
+- lib/state_machine_checker/transition.rb
+- lib/state_machine_checker/version.rb
+- state_machine_checker.gemspec
+homepage: https://github.com/CJStadler/state_machine_checker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/CJStadler/state_machine_checker
+  source_code_uri: https://github.com/CJStadler/state_machine_checker
+  changelog_uri: https://github.com/CJStadler/state_machine_checker/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Model checking for state machines using CTL.
+test_files: []