aasm-vis 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11920e9448b638133c2046027a26b757952cb1fe520e9c403b3555ef1511f4fd
-  data.tar.gz: 9346db77906aee7d178070df116b0b80cf0f66d710e0edfd3be91f30a439f726
+  metadata.gz: 4273c8cdcd2c48874d413838a90680f0cfa0a01ea706e10f3c657e0270856f47
+  data.tar.gz: 739e683166d0804ec22572acbc4150f4931320da30087e071b057cb8824a00cc
 SHA512:
-  metadata.gz: 3bfb6f306b4d1077c5c0440021b2ab0ed2613024e2524dfd89e5d970e463c2029e0028c3cb0344211939cc87b1d8bef3631b0f948471e385fb414e9c062dcc74
-  data.tar.gz: 5822cec22a72e374c2df4cf237cc9d36cd0a71ccd9f714f1210bd554a9feb253ab52c0478a72f76b799cc934d0893517212b1787a54a89c4a0409f3c6f91d61a
+  metadata.gz: 621a4e398453d5524fa12c70b42c1e0a91887da11463c3b2c70d59b5823b2cd2e8d4b2e87b554ca1d021ec7f9cea05fc3dca278abec2b9223cba8e6fdf97f0f8
+  data.tar.gz: e50f1b9d8d56b4a24dc2e450c42791d8040122ba84bfd0ab91a44d8dd0871456033104f610e5755e3814c32a2986dc160781fe309efd817df388118a19de783d

data/README.md

@@ -12,6 +12,49 @@ Add `gem 'aasm-vis', group: :development` to your `Gemfile` and run `bundle`.
 
 To visualise the results you can use the [github cli](https://cli.github.com/): `gh gist create tmp/assm-vis.md` or any other tool that can render markdown files supporting mermaid.
 
+## Example
+
+The following ruby code defines a simple state machine for a `Job` model:
+```ruby
+class Job < ApplicationRecord
+  include AASM
+  
+  aasm :state do
+    state :created, initial: true
+    state :running
+    state :finished_successfully
+    state :finished_with_error
+    
+    event :run, after: :notify_somebody do
+      transitions from: :created, to: :running
+      transitions from: :running, to: :finished_with_error
+      transitions from: :running, to: :finished_successfully
+    end
+  end
+end
+```
+
+It will generate the following mermaid diagram:
+
+```mermaid
+---
+title: Job#state
+---
+stateDiagram-v2
+
+created : Created
+running : Running
+finished_successfully : Finished successfully
+finished_with_error : Finished with error
+  
+[*] --> created
+created --> running
+running --> finished_with_error
+running --> finished_successfully
+
+finished_with_error --> [*]
+finished_successfully --> [*]
+```
 
 ## Development
 

data/aasm-vis.gemspec

@@ -32,9 +32,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_dependency "aasm", "~> 5"
+  # TODO: add rails or railties or rake?
 end

data/lib/aasm/vis/version.rb

@@ -2,6 +2,6 @@
 
 module AASM
   module Vis
-    VERSION = "0.1.1"
+    VERSION = "0.1.3"
   end
 end

data/lib/aasm/vis.rb

@@ -26,11 +26,6 @@ module AASM
             end
           end
 
-
-
-
-
-
           results << <<~TXT
             ```mermaid
             ---

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm-vis
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Kamil Gwóźdź
@@ -9,7 +9,21 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2024-07-18 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aasm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
 description: Gem for visualising https://github.com/aasm/aasm state machines using
   markdown and https://github.com/mermaid-js/mermaid.
 email: