aasm_statecharts 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e89b5b44cb179e336bb467bbe9c0af6198cbb4f5
-  data.tar.gz: cea3f2ae3f920efe4a13e8d47d71566215248c43
+  metadata.gz: 68fbc4a0762a4458ef3f23516302bb7a4f637064
+  data.tar.gz: a6b4caa74d5316079f486f2411e7c8dfb45af463
 SHA512:
-  metadata.gz: 437de932bc28fc77a87015af178618b023fb70e8de11ea407f25885b59b809277c9dbebf57094380952b1e540d8f98d8396a3286dc87ac040101bd5e481ea339
-  data.tar.gz: bf0f765d8eb824967cbcceb54139b1e8020088f741bb2eb7f718014236eb779cc24fca8c68191e200b82176f99f5f0d0e9ca270c909c9c8c5af9cd4421c9bb0c
+  metadata.gz: 40b731b6d28475247efde04ef95c387e841c61e07da0c7bda88b35d3a558d11435075a0cac763f19f4c490d192b2c14dbe53636d88bccf1d607a12f95289f019
+  data.tar.gz: 02392dabebb21d3b78949bed760b7df41a381af2d20f2c7c21db5893c351a0cb916b6e2b56a252d7db17700d797502685f6c83338bdc655d72c818c7930b5d08

data/README.md

@@ -0,0 +1,74 @@
+aasm_statecharts
+================
+
+`aasm_statecharts` is a utility for generating UML statechart diagrams from state machines defined using [AASM](https://github.com/aasm/aasm). Unlike other state diagram generators, it can express extended finite state machine concepts such as guards and entry actions.
+
+Installation and Invokation
+---------------------------
+
+You can install `aasm_statecharts` from RubyGems using `gem install aasm_statecharts`, or add the `aasm_statecharts` gem to your Gemfile and run Bundler to install it.
+
+If you have installed `aasm_statecharts` via gem, you can invoke it using the command `aasm_statecharts`; otherwise, if you have used Bundler without generating binstubs, you can invoke it with the command `bundle exec aasm_statecharts`. The following assumes that it has been installed via gem for simplicity.
+
+Example
+-------
+
+Considuer following model, which is assumed to be stored in `app/models/claim.rb`:
+```rb
+class Claim < ActiveRecord::Base
+  belongs_to :user
+  validates :title, presence: true
+  validates :description, presence: true
+
+  include AASM
+
+  aasm do
+    state :unsubmitted, initial: true
+    state :submitted, exit: [:cancel_deadline, :close_ticket]
+    state :resolved, final: true
+
+    event :submit do
+      transitions from: :unsubmitted, to: :submitted,
+                  guard: :accepting_claims?,
+                  on_transition: :notify_submitted
+    end
+    event :return do
+      transitions from: :submitted, to: :unsubmitted
+    end
+    event :accept do
+      transitions from: :submitted, to: :resolved
+    end
+  end
+  
+  def accepting_claims?
+  end
+  
+  def cancel_deadline
+  end
+
+  def close_ticket
+  end
+  
+  def notify_submitted
+  end
+end
+```
+
+If we invoke `aasm_statecharts claim`, then the following diagram will be written to ./doc/claim.png:
+
+![Claim Statechart](https://raw.githubusercontent.com/WorkflowsOnRails/aasm_statecharts/master/doc/claim.png)
+
+
+Usage
+-----
+
+For more advanced usage information, see `aasm_statecharts --help`:
+
+    Usage: aasm_statecharts [options] <model> [models ...]
+        -a, --all                        Render all models using AASM
+        -d, --directory directory        Output to a specific directory (default: ./doc)
+        -t, --file-type type             Output in the specified format (default: png),
+    which must be one of the following: bmp, canon, dot, xdot, cmap, dia, eps, fig, gd,
+    gd2, gif, gtk, hpgl, ico, imap, cmapx, imap_np, cmapx_np, ismap, jpeg, jpg, jpe, mif,
+    mp, pcl, pdf, pic, plain, plain-ext, png, ps, ps2, svg, svgz, tga, tiff, tif, vml,
+    vmlz, vrml, vtx, wbmp, xlib, none.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aasm_statecharts
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brendan MacDonell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-18 00:00:00.000000000 Z
+date: 2014-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails