aasm-diagram 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 19ab5bb163d998949ffe56f47041a3d0d27f8bda
-  data.tar.gz: 5bc368e78cb78526aa765335d1caf623e45765c6
+SHA256:
+  metadata.gz: 60cce49c3986317422d3b5385239b00e250ad462430fa9711994fc9b0b4839d8
+  data.tar.gz: 18fe0ac14dd690b7c51570e1afbe0ca54c70ea5c6200bc539813750072ec2c1a
 SHA512:
-  metadata.gz: 5bf93420985ed58f256fc541628112072525934d4f494cee4002a05be8c83f4292d80adfce659e65a771e109715f61505f5884e7b14d55876fb5ff0aee6cdeaa
-  data.tar.gz: bba5da0c27d949db9e51c60624cea4b5fe36b4d255af8776bdc43760935a9453112201a537b08f368f84214797307523a636e3d42ffd84043efe0ac430dc1515
+  metadata.gz: 6bd83db82bc1bd1cf97d87c719979e5dec4e8522092ef9bd42260fb211703351a6d370228816f35b45986c2a086f227962f310ed1385e96e7e9ed8545ce6fde9
+  data.tar.gz: 3bd045610e90a710a7a384860d89e5437dae6c0dd72c7037e4e55ae4c2b56722a43e25c5811ab23b6361c1d0cfb801afa5680862434840a206b14c36e5bb38a8

data/README.md

@@ -37,8 +37,59 @@ Generates the following diagram:
 
 ## Installation
 
-* Install Graphviz ([see the rails-erd guide for more details](https://voormedia.github.io/rails-erd/install.html)). If you use Homebrew try `brew install graphviz`.
-* Add `gem 'aasm-diagram', require: false, group: :development` to your `Gemfile` and run `bundle`.
+- Install Graphviz ([see the rails-erd guide for more details](https://voormedia.github.io/rails-erd/install.html)). If you use Homebrew try `brew install graphviz`.
+- Add `gem 'aasm-diagram', require: false, group: :development` to your `Gemfile` and run `bundle`.
+
+## Integration
+
+The gem exposes the `generate` Rake task, that can be used to generate the diagrams of state machines into
+PNG images. The `generate` task accepts two parameters:
+
+- the name of the model, in underscored format, will be CamelCased by the task
+- the name of the state machine, for models with multiple AASMs; this argument is optional
+
+The task will output the PNG image by default to the `/tmp` folder; but can be configured via the
+`AASM_DIAGRAM_OUTPUT_DIR` environment variable to write the files to another folder.
+
+The filenames are generated based on the parameters as follows `model_name-state_machine_name.png`.
+If no state machine name is provided, the task will use `default` for the file name.
+
+```sh
+# for the Order model and the :dropoff state machine
+rake aasm-diagram:generate[order,dropoff] # -> tmp/order-dropoff.png
+
+# for the Invoice model and the "default" state machine
+rake aasm-diagram:generate[invoice] # -> tmp/invoice-default.png
+
+# with custom output directory
+AASM_DIAGRAM_OUTPUT_DIR=docs rake aasm-diagram:generate[invoice] # -> docs/invoice-default.png
+```
+
+### Rails
+
+Once installed, the gem automatically integrates with Rails via Railties and exposes the task automatically.
+
+`rails aasm-diagram:generate[my_model,my_state_machine]`
+
+If the model contains only one state machine, or you just want to generate for the "default" one
+you can skip the state machine name parameter.
+
+`rails assm-diagram:generate[my_model]`
+
+### Plain Ruby
+
+For plain Ruby projects the gem includes a Rakefile that can be loaded in your project's Rakefile,
+using source code along the lines of:
+
+```ruby
+# in Rakefile
+
+require 'aasm-diagram'
+
+spec = Gem::Specification.find_by_name 'aasm-diagram'
+rakefile = "#{spec.gem_dir}/lib/aasm_diagram/Rakefile"
+load rakefile
+```
 
 ## More Examples
 

data/aasm-diagram.gemspec

@@ -26,6 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'ruby-graphviz', '~> 1.2'
 
   spec.add_development_dependency 'bundler', '~> 1.14'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/aasm-diagram.rb

@@ -3,3 +3,5 @@ require 'graphviz'
 
 require 'aasm_diagram/version'
 require 'aasm_diagram/diagram'
+
+require 'aasm_diagram/railtie' if defined?(Rails)

data/lib/aasm_diagram/Rakefile

@@ -0,0 +1,4 @@
+require 'aasm-diagram'
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/*.rake").each { |f| import f }

data/lib/aasm_diagram/railtie.rb

@@ -0,0 +1,13 @@
+require 'aasm-diagram'
+require 'rails'
+
+module AASMDiagram
+  class Railtie < Rails::Railtie
+    railtie_name :aasm_diagram
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/aasm_diagram/tasks/generate.rake

@@ -0,0 +1,20 @@
+namespace :'aasm-diagram' do
+  desc 'Generate AASM diagram for the given model and (optionally) state machine'
+  task :generate, [:model, :smn] => :environment do |_task, args|
+    puts 'Missing `model` argument.' unless args[:model].present?
+    model_klass = args[:model].camelize.safe_constantize
+    puts 'Invalid `model` argument.' unless model_klass
+
+    smn = args[:smn]&.to_sym
+
+    model_instance = model_klass.new
+
+    output_dir = ENV.fetch('AASM_DIAGRAM_OUTPUT_DIR') { './tmp' }
+    output = File.join([output_dir, "#{args[:model]}-#{args[:smn] || 'default'}.png"])
+
+    AASMDiagram::Diagram.new(
+      smn && model_instance.aasm(smn) || model_instance.aasm,
+      output
+    )
+  end
+end

data/lib/aasm_diagram/version.rb

@@ -1,3 +1,3 @@
 module AASMDiagram
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aasm-diagram
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Kate Murphy
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-10-20 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm
@@ -64,14 +64,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +92,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - code@kate.io
 executables: []
@@ -103,13 +109,16 @@ files:
 - docs/multiple-state-machines-1.png
 - docs/multiple-state-machines-2.png
 - lib/aasm-diagram.rb
+- lib/aasm_diagram/Rakefile
 - lib/aasm_diagram/diagram.rb
+- lib/aasm_diagram/railtie.rb
+- lib/aasm_diagram/tasks/generate.rake
 - lib/aasm_diagram/version.rb
 homepage: https://github.com/katee/aasm-diagram
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,9 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Automatically generate diagrams of AASM state machines.
 test_files: []