draw_me 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +59 -0
- data/Rakefile +2 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/draw_me.gemspec +26 -0
- data/lib/draw_me.rb +61 -0
- data/lib/draw_me/version.rb +3 -0
- data/output.png +0 -0
- metadata +84 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: bb1241fc51512cfd99e9be3e4849c29ea33da2d1
|
4
|
+
data.tar.gz: 94327eb2cead98b821fdac2099a0eba37902afa6
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: d556f6feea9f90b50b1409751116022dfd1e715987f4a4f6d6c644aff1d15fe561fde91518e421a71fb3cfbb9248b1ac429b3edac9e3dd2ed002604974800a66
|
7
|
+
data.tar.gz: ccb1696f26b7664b97c2dd6c169d02c390b925149e2a347781a443470d134ee0f9e720d286e8e64553aae8d83ce6d37fa1f1690856f7627af2c76f0863122ab1
|
data/.gitignore
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at yakob.ubaidi@gmail.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [http://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: http://contributor-covenant.org
|
74
|
+
[version]: http://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2018 Yakob Ubaidi
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,59 @@
|
|
1
|
+
# DrawMe
|
2
|
+
|
3
|
+
This gem is used to generate state diagram for [AASM gem](https://github.com/aasm/aasm). This gem utilize Matsuda's [stateful_enum gem](https://github.com/amatsuda/stateful_enum) graph generator to generate AASM state diagram. Tested with rails 5.1.4
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
Before we start with DrawMe gem there are dependencies for [AASM gem](https://github.com/aasm/aasm) such as graphiz installation and other stuff are need to be done beforehand. Please head to [AASM gem](https://github.com/aasm/aasm) page for more info about the setup.
|
7
|
+
|
8
|
+
1. Create a `doc` folder in your app root directory.
|
9
|
+
|
10
|
+
2. Add this line to your application's Gemfile:
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
gem 'aasm'
|
14
|
+
gem 'stateful_enum'
|
15
|
+
gem 'draw_me'
|
16
|
+
```
|
17
|
+
|
18
|
+
3. And then execute:
|
19
|
+
|
20
|
+
$ bundle
|
21
|
+
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
1. include it into your `model` or directly into your `ApplicationRecord` file.
|
26
|
+
```
|
27
|
+
class EmergencyPurchase < ApplicationRecord
|
28
|
+
include AASM
|
29
|
+
include DrawMe
|
30
|
+
end
|
31
|
+
```
|
32
|
+
|
33
|
+
2. Use it in your console
|
34
|
+
```
|
35
|
+
$ rails c
|
36
|
+
2.4.0 :001 > to_draw = EmergencyPurchase.last
|
37
|
+
2.4.0 :001 > to_draw.draw_me
|
38
|
+
emergencypurchase_graph
|
39
|
+
=> 1
|
40
|
+
```
|
41
|
+
|
42
|
+
if you want to draw all diagram for all of your models :
|
43
|
+
|
44
|
+
2.4.0 :001 > ApplicationRecord.draw_all
|
45
|
+
|
46
|
+
You should be able to find your graph in the doc folder in your root directory.
|
47
|
+
|
48
|
+
![Screenshot](output.png)
|
49
|
+
|
50
|
+
|
51
|
+
## Contributing
|
52
|
+
|
53
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/abigoroth/draw_me. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
54
|
+
|
55
|
+
|
56
|
+
## License
|
57
|
+
|
58
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
59
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "draw_me"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
data/draw_me.gemspec
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'draw_me/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "draw_me"
|
8
|
+
spec.version = DrawMe::VERSION
|
9
|
+
spec.authors = ["Yakob Ubaidi"]
|
10
|
+
spec.email = ["yakob.ubaidi@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = "Draws State Diagram for AASM gem"
|
13
|
+
spec.description = "By utilizing matsuda stateful enum gem."
|
14
|
+
spec.homepage = "http://github.com/abigoroth/draw_me"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
18
|
+
f.match(%r{^(test|spec|features)/})
|
19
|
+
end
|
20
|
+
spec.bindir = "exe"
|
21
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
22
|
+
spec.require_paths = ["lib"]
|
23
|
+
|
24
|
+
spec.add_development_dependency "bundler", "~> 1.14"
|
25
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
26
|
+
end
|
data/lib/draw_me.rb
ADDED
@@ -0,0 +1,61 @@
|
|
1
|
+
require 'rails/railtie'
|
2
|
+
require "draw_me/version"
|
3
|
+
|
4
|
+
module DrawMe
|
5
|
+
extend ActiveSupport::Concern
|
6
|
+
|
7
|
+
def draw_me
|
8
|
+
self_class = self.class.name.gsub("Rfq::", "")
|
9
|
+
tmp = "class #{(self_class.downcase).capitalize}Graph < ApplicationRecord \n"
|
10
|
+
tmp << " self.table_name = '#{self.class.table_name}' \n"
|
11
|
+
tmp << " enum aasm_state: {#{self.aasm.states.map.with_index{|x,i| "#{x.name}: #{i}" }.join(', ')}} do \n"
|
12
|
+
self.class.aasm.events.each_with_index do |event,i|
|
13
|
+
# puts event.inspect
|
14
|
+
# next if i > 0
|
15
|
+
next if event.transitions.count == 0
|
16
|
+
tmp << " event :#{event.name} do \n"
|
17
|
+
event.transitions.each do |transition|
|
18
|
+
tmp << " transition :#{transition.from} => :#{transition.to} \n"
|
19
|
+
end
|
20
|
+
tmp << " end \n\n"
|
21
|
+
end
|
22
|
+
tmp << " end \n"
|
23
|
+
tmp << "end"
|
24
|
+
# File.open("/lib/graph/")
|
25
|
+
# IO.write("#{Rails.root}/lib/graph/#{self_class}.rb", tmp)
|
26
|
+
file = "#{Rails.root}/app/models/#{self_class.downcase}_graph.rb"
|
27
|
+
File.open("#{file}", 'w+') {|f| f.write(tmp) }
|
28
|
+
puts "#{self_class.downcase}_graph"
|
29
|
+
%x[ DEST_DIR=doc rails g stateful_enum:graph #{(self_class.downcase).capitalize}_graph ]
|
30
|
+
File.delete(file)
|
31
|
+
# puts tmp
|
32
|
+
end
|
33
|
+
|
34
|
+
# ["#{Rails.root}/app/models", "#{Rails.root}/app/models/rfq"]
|
35
|
+
class_methods do
|
36
|
+
def draw_all
|
37
|
+
["#{Rails.root}/app/models"].each do |path|
|
38
|
+
Dir.foreach(path) do |model_path|
|
39
|
+
namez = model_path.split("_").map{|x| x.capitalize}.join.gsub(".rb", "")
|
40
|
+
if (namez =~ /[a-zA-Z]/) != nil && (model_path =~ /.rb/) != nil
|
41
|
+
namez = "Rfq::" + namez if (path =~ /rfq/) != nil
|
42
|
+
puts namez
|
43
|
+
# Looking for model with AASM only
|
44
|
+
hm = "#{namez}.try(:aasm)"
|
45
|
+
puts hm
|
46
|
+
tmp = eval(hm)
|
47
|
+
if tmp
|
48
|
+
puts model_path
|
49
|
+
puts namez
|
50
|
+
tmp = eval(namez)
|
51
|
+
tmp = tmp.new
|
52
|
+
tmp.draw_me
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
# Your code goes here...
|
61
|
+
end
|
data/output.png
ADDED
Binary file
|
metadata
ADDED
@@ -0,0 +1,84 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: draw_me
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Yakob Ubaidi
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2018-01-29 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.14'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.14'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
description: By utilizing matsuda stateful enum gem.
|
42
|
+
email:
|
43
|
+
- yakob.ubaidi@gmail.com
|
44
|
+
executables: []
|
45
|
+
extensions: []
|
46
|
+
extra_rdoc_files: []
|
47
|
+
files:
|
48
|
+
- ".gitignore"
|
49
|
+
- CODE_OF_CONDUCT.md
|
50
|
+
- Gemfile
|
51
|
+
- LICENSE.txt
|
52
|
+
- README.md
|
53
|
+
- Rakefile
|
54
|
+
- bin/console
|
55
|
+
- bin/setup
|
56
|
+
- draw_me.gemspec
|
57
|
+
- lib/draw_me.rb
|
58
|
+
- lib/draw_me/version.rb
|
59
|
+
- output.png
|
60
|
+
homepage: http://github.com/abigoroth/draw_me
|
61
|
+
licenses:
|
62
|
+
- MIT
|
63
|
+
metadata: {}
|
64
|
+
post_install_message:
|
65
|
+
rdoc_options: []
|
66
|
+
require_paths:
|
67
|
+
- lib
|
68
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
69
|
+
requirements:
|
70
|
+
- - ">="
|
71
|
+
- !ruby/object:Gem::Version
|
72
|
+
version: '0'
|
73
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
74
|
+
requirements:
|
75
|
+
- - ">="
|
76
|
+
- !ruby/object:Gem::Version
|
77
|
+
version: '0'
|
78
|
+
requirements: []
|
79
|
+
rubyforge_project:
|
80
|
+
rubygems_version: 2.6.10
|
81
|
+
signing_key:
|
82
|
+
specification_version: 4
|
83
|
+
summary: Draws State Diagram for AASM gem
|
84
|
+
test_files: []
|