Skip to content

Commit

Permalink
Updating documentation with more sipity models
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremyf committed May 16, 2017
1 parent 875c54d commit e87afe1
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
1 change: 1 addition & 0 deletions app/models/sipity/method.rb
@@ -1,5 +1,6 @@
module Sipity
class Method < ActiveRecord::Base
self.table_name = 'sipity_workflow_methods'
belongs_to :workflow_action, class_name: 'Sipity::WorkflowAction'
end
end
15 changes: 14 additions & 1 deletion artifacts/entity-relationship-diagram.dot
Expand Up @@ -28,6 +28,14 @@ digraph models_diagram {
"Sipity::WorkflowStateAction" [label="{ Sipity::WorkflowStateAction | The actions that can\n be taken for the\n given workflow & state }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/workflow_state_action.rb";]
"Sipity::WorkflowStateActionPermission" [label="{ Sipity::WorkflowStateActionPermission | The role required to \n take the action \n for the given workflow }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/workflow_state_action_permission.rb";]
"Sipity::Role" [label="{ Sipity::Role | All of the named \n roles for the site }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/role.rb";]
"Sipity::Method" [label=" { Sipity::Method | Arbitrary lambdas to call\nwhen action is taken}" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/method.rb";]
}

subgraph 4 {
node[color=gold penwidth=2]
"Sipity::NotifiableContext" [label=" { Sipity::NotifiableContext | Arbitrary lambdas to call\nwhen action is taken}" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/notifiable_context.rb";]
"Sipity::Notification" [label=" { Sipity::Notification | A type of notification to send }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/notification.rb";]
"Sipity::NotificationRecipient" [label=" { Sipity::NotificationRecipient | Who receives the notification }" URL="http://github.com/projecthydra-labs/hyrax/blob/master/app/models/sipity/notification_recipient.rb";]
}

subgraph 1 {
Expand All @@ -39,7 +47,7 @@ digraph models_diagram {
"AdminSet" -> "PermissionTemplate" [arrowtail=none, arrowhead=none, dir=both]
"User" -> "GroupMembership" [arrowtail=none, arrowhead=crow, dir=both]
"Group" -> "GroupMembership" [arrowtail=none, arrowhead=crow, dir=both]
"PermissionTemplate" -> "Sipity::Workflow" [label="possible" arrowtail=none, arrowhead=crow, dir=both]
"PermissionTemplate" -> "Sipity::Workflow" [label="possible" color=gold fontcolor=gold arrowtail=none, arrowhead=crow, dir=both]
"PermissionTemplate" -> "Sipity::Workflow" [label="active" arrowtail=none, arrowhead=none, dir=both]
"Sipity::Entity" -> "Sipity::Workflow" [arrowtail=crow, arrowhead=none, dir=both]
"AbstractWork" -> "AdminSet" [arrowtail=crow, arrowhead=none, dir=both]
Expand All @@ -51,13 +59,18 @@ digraph models_diagram {
"Sipity::Workflow" -> "Sipity::WorkflowAction" [arrowtail=none, arrowhead=crow, dir=both]
"Sipity::Workflow" -> "Sipity::WorkflowRole" [arrowtail=none, arrowhead=crow, dir=both]
"Sipity::WorkflowAction" -> "Sipity::WorkflowStateAction" [arrowtail=none, arrowhead=crow, dir=both]
"Sipity::WorkflowState" -> "Sipity::WorkflowAction" [label="resulting_workflow_state" color=purple fontcolor=purple arrowtail=none, arrowhead=crow, dir=both]
"Sipity::WorkflowState" -> "Sipity::WorkflowStateAction" [arrowtail=none, arrowhead=crow, dir=both]
"Sipity::WorkflowStateAction" -> "Sipity::WorkflowStateActionPermission" [arrowtail=none, arrowhead=crow, dir=both]
"Sipity::WorkflowRole" -> "Sipity::WorkflowStateActionPermission" [arrowtail=none, arrowhead=crow, dir=both]
"Sipity::Role" -> "Sipity::WorkflowRole" [arrowtail=none, arrowhead=crow, dir=both]
"Sipity::WorkflowRole" -> "Sipity::WorkflowResponsibility" [arrowtail=none, arrowhead=crow, dir=both]
"Sipity::WorkflowAction" -> "Sipity::Method" [arrowtail=none, arrowhead=crow, dir=both]
"Sipity::Agent" -> "Sipity::WorkflowResponsibility" [arrowtail=none, arrowhead=crow, dir=both]
"Sipity::Agent" -> "Group" [label="as proxy" arrowtail=none, arrowhead=none, dir=both]
"Sipity::Agent" -> "User" [label="as proxy" arrowtail=none, arrowhead=none, dir=both]
"Sipity::WorkflowState" -> "Sipity::Entity" [arrowtail=none, arrowhead=crow, dir=both]
"Sipity::WorkflowAction" -> "Sipity::NotifiableContext" [arrowtail=none, arrowhead=crow, dir=both]
"Sipity::NotifiableContext" -> "Sipity::Notification" [arrowtail=none, arrowhead=crow, dir=both]
"Sipity::Notification" -> "Sipity::NotificationRecipient" [arrowtail=none, arrowhead=crow, dir=both]
}
Binary file modified artifacts/entity-relationship-diagram.pdf
Binary file not shown.

0 comments on commit e87afe1

Please sign in to comment.