micromachine 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1e4cf4c889a6b914e2b7f2e6e94e14b6ca5e97f
-  data.tar.gz: 7c27986b29e696f35424ae9c31a4dbf1307bf63b
+  metadata.gz: 82b235594232cccbcac8ea901232262324cd7748
+  data.tar.gz: 3c6c8d2b2cbcbdc5d435a30e30bf6ed2f078bddf
 SHA512:
-  metadata.gz: be3ccf1c76220287fe4897368d10d1bfaead7adbe62b966912b54ff8660f2cc63d96536978c66358de841d2a7a8c16fdbac71cd01f69e4a4f941547128972c0c
-  data.tar.gz: eae3a5f96d87b1075b30c4de5c59d6c205ca39a066e7449b88791c14b1edc53526a87340b8c3b908a10fd4c38fc3e4861bd273ab1882c05c9119b56acfc4214f
+  metadata.gz: 0c15ea016bf6bec45f30cc52e17369476be9503361bc935b85b3c4b7999bd980b9b8fd60f36dd6c5d7a5d2cda85fc68b9cd6166055c268ae9f74b84aee23e7da
+  data.tar.gz: fbdf2e41392c293b9afd9433dad03d672aa196cd97a4efcd286801d8b8c92ffac611efc46031de3e6dafde83f7588f665df39cd7f53299b1a6691cfd1c138616

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/) 
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [2.1.0] - 2017-07-07
+
+### Added
+- `triggerable_events` method lists events that can be called from the current state
+
+### Changed
+- (nothing)
+
+## [2.0.0] - 2015-11-03
+
+(These and previous changes were not documented)

data/CONTRIBUTING

@@ -0,0 +1,24 @@
+This code tries to solve a particular problem with a very simple
+implementation. We try to keep the code to a minimum while making
+it as clear as possible. The design is very likely finished, and
+if some feature is missing it is possible that it was left out on
+purpose. That said, new usage patterns may arise, and when that
+happens we are ready to adapt if necessary.
+
+A good first step for contributing is to meet us on IRC and discuss
+ideas. We spend a lot of time on #lesscode at freenode, always ready
+to talk about code and simplicity. If connecting to IRC is not an
+option, you can create an issue explaining the proposed change and
+a use case. We pay a lot of attention to use cases, because our
+goal is to keep the code base simple. Usually the result of a
+conversation is the creation of a different tool.
+
+Please don't start the conversation with a pull request. The code
+should come at last, and even though it may help to convey an idea,
+more often than not it draws the attention to a particular
+implementation.
+
+# Running the Tests
+
+- `gem install cutest`
+- `make`

data/README.md

@@ -89,6 +89,19 @@ end
 Note that `:any` is a special key. Using it as a state when declaring
 transitions will give you unexpected results.
 
+Finally, you can list possible events or states:
+
+``` ruby
+# All possible events
+machine.events #=> [:confirm, :ignore, :reset]
+
+# All events triggerable from the current state
+machine.triggerable_events #=> [:confirm, :ignore]
+
+# All possible states
+machine.states #=> [:new, :confirmed, :ignored]
+```
+
 Check the examples directory for more information.
 
 Adding MicroMachine to your models

data/lib/micromachine.rb

@@ -37,6 +37,10 @@ class MicroMachine
     transitions_for.keys
   end
 
+  def triggerable_events
+    events.select { |event| trigger?(event) }
+  end
+
   def states
     transitions_for.values.map(&:to_a).flatten.uniq
   end

data/micromachine.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "micromachine"
-  s.version = "2.0.0"
+  s.version = "2.1.0"
   s.summary = %{Minimal Finite State Machine.}
   s.description = %Q{There are many finite state machine implementations for Ruby, and they all provide a nice DSL for declaring events, exceptions, callbacks, and all kinds of niceties in general.\n\nBut if all you want is a finite state machine, look no further: this has less than 50 lines of code and provides everything a finite state machine must have, and nothing more.}
   s.author = ["Michel Martens"]

data/test/introspection.rb

@@ -14,6 +14,10 @@ test "returns an array with the defined events" do |machine|
   assert_equal [:confirm, :ignore, :reset], machine.events
 end
 
+test "list the available events for the current state" do |machine|
+  assert_equal [:confirm, :ignore], machine.triggerable_events
+end
+
 test "returns an array with the defined states" do |machine|
   assert_equal [:pending, :confirmed, :ignored], machine.states
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: micromachine
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-03 00:00:00.000000000 Z
+date: 2017-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest
   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: |-
@@ -34,7 +34,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gems
+- ".gems"
+- CHANGELOG.md
+- CONTRIBUTING
 - LICENSE
 - README.md
 - examples/advanced.rb
@@ -57,17 +59,17 @@ 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.0.14
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Minimal Finite State Machine.