structurizr 1.0.0.pre.alpha.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (51) hide show
  1. checksums.yaml +7 -0
  2. data/.gitattributes +1 -0
  3. data/.gitignore +10 -0
  4. data/.jrubyrc +1 -0
  5. data/.reek.yml +127 -0
  6. data/.rubocop.yml +102 -0
  7. data/CODE_OF_CONDUCT.md +74 -0
  8. data/Gemfile +6 -0
  9. data/Makefile +31 -0
  10. data/README.md +53 -0
  11. data/bin/console +15 -0
  12. data/bin/test +9 -0
  13. data/lib/structurizr/arc42_documentation_template.rb +7 -0
  14. data/lib/structurizr/automatic_documentation_template.rb +7 -0
  15. data/lib/structurizr/border.rb +7 -0
  16. data/lib/structurizr/component.rb +7 -0
  17. data/lib/structurizr/container.rb +7 -0
  18. data/lib/structurizr/documentation_templates.rb +6 -0
  19. data/lib/structurizr/enterprise.rb +7 -0
  20. data/lib/structurizr/enums.rb +11 -0
  21. data/lib/structurizr/filter_mode.rb +7 -0
  22. data/lib/structurizr/format.rb +7 -0
  23. data/lib/structurizr/image_utils.rb +7 -0
  24. data/lib/structurizr/interaction_style.rb +7 -0
  25. data/lib/structurizr/location.rb +7 -0
  26. data/lib/structurizr/metal/jars/LICENSE +201 -0
  27. data/lib/structurizr/metal/jars/README.md +7 -0
  28. data/lib/structurizr/metal/jars/commons-logging-1.2.jar +0 -0
  29. data/lib/structurizr/metal/jars/jackson-annotations-2.13.0-rc1.jar +0 -0
  30. data/lib/structurizr/metal/jars/jackson-core-2.13.0-rc1.jar +0 -0
  31. data/lib/structurizr/metal/jars/jackson-databind-2.13.0-rc1.jar +0 -0
  32. data/lib/structurizr/metal/jars/structurizr-client-1.9.5.jar +0 -0
  33. data/lib/structurizr/metal/jars/structurizr-core-1.9.5.jar +0 -0
  34. data/lib/structurizr/metal/jars/structurizr-graphviz-1.5.0.jar +0 -0
  35. data/lib/structurizr/metal.rb +40 -0
  36. data/lib/structurizr/model.rb +13 -0
  37. data/lib/structurizr/model_item.rb +18 -0
  38. data/lib/structurizr/paper_size.rb +7 -0
  39. data/lib/structurizr/person.rb +7 -0
  40. data/lib/structurizr/relationship.rb +7 -0
  41. data/lib/structurizr/routing.rb +7 -0
  42. data/lib/structurizr/shape.rb +7 -0
  43. data/lib/structurizr/software_system.rb +7 -0
  44. data/lib/structurizr/structurizr_documentation_template.rb +7 -0
  45. data/lib/structurizr/tags.rb +7 -0
  46. data/lib/structurizr/version.rb +5 -0
  47. data/lib/structurizr/viewpoints_and_perspectives_documentation_template.rb +8 -0
  48. data/lib/structurizr/workspace.rb +19 -0
  49. data/lib/structurizr.rb +19 -0
  50. data/structurizr.gemspec +33 -0
  51. metadata +164 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: df83d13062a0819df87ea4dc9a1321f83bb81c54d965f9df2ac28411b614a5b9
4
+ data.tar.gz: facec0bf9bc67e67da85e10a9ac51fb6fa1817b4b74f7e12e543ff0f64566724
5
+ SHA512:
6
+ metadata.gz: b41f7c1f86b695ddb5810dac2b0b378b300653770ef4b3b9b522e08026bf89c310445ee5290663505369242cea4f98b87b21e4b4dbe94dbbe12306192b79c0c8
7
+ data.tar.gz: 4c02c4a4dc5547bc6b9d82be0417ba98a83f05f554c799cede8b1f2b2227b907005051833725dcb4a57c3a9b833504dd175331263ff667c168da812eb324a744
data/.gitattributes ADDED
@@ -0,0 +1 @@
1
+ *.jar filter=lfs diff=lfs merge=lfs -text
data/.gitignore ADDED
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ Gemfile.lock
data/.jrubyrc ADDED
@@ -0,0 +1 @@
1
+ debug.fullTrace=true
data/.reek.yml ADDED
@@ -0,0 +1,127 @@
1
+ detectors:
2
+ Attribute:
3
+ enabled: false
4
+ exclude: []
5
+ BooleanParameter:
6
+ enabled: true
7
+ exclude: []
8
+ ClassVariable:
9
+ enabled: false
10
+ exclude: []
11
+ ControlParameter:
12
+ enabled: true
13
+ exclude: []
14
+ DataClump:
15
+ enabled: true
16
+ exclude: []
17
+ max_copies: 2
18
+ min_clump_size: 2
19
+ DuplicateMethodCall:
20
+ enabled: true
21
+ exclude: []
22
+ max_calls: 1
23
+ allow_calls: []
24
+ FeatureEnvy:
25
+ enabled: true
26
+ exclude: []
27
+ InstanceVariableAssumption:
28
+ enabled: false
29
+ IrresponsibleModule:
30
+ enabled: false
31
+ exclude: []
32
+ LongParameterList:
33
+ enabled: true
34
+ exclude: []
35
+ max_params: 4
36
+ overrides:
37
+ initialize:
38
+ max_params: 5
39
+ LongYieldList:
40
+ enabled: true
41
+ exclude: []
42
+ max_params: 3
43
+ ManualDispatch:
44
+ enabled: true
45
+ exclude: []
46
+ MissingSafeMethod:
47
+ enabled: false
48
+ exclude: []
49
+ ModuleInitialize:
50
+ enabled: true
51
+ exclude: []
52
+ NestedIterators:
53
+ enabled: true
54
+ exclude: []
55
+ max_allowed_nesting: 2
56
+ ignore_iterators: []
57
+ NilCheck:
58
+ enabled: false
59
+ exclude: []
60
+ RepeatedConditional:
61
+ enabled: true
62
+ exclude: []
63
+ max_ifs: 3
64
+ SubclassedFromCoreClass:
65
+ enabled: true
66
+ exclude: []
67
+ TooManyConstants:
68
+ enabled: true
69
+ exclude: []
70
+ max_constants: 5
71
+ TooManyInstanceVariables:
72
+ enabled: true
73
+ exclude: []
74
+ max_instance_variables: 9
75
+ TooManyMethods:
76
+ enabled: true
77
+ exclude: []
78
+ max_methods: 25
79
+ TooManyStatements:
80
+ enabled: true
81
+ exclude:
82
+ - initialize
83
+ max_statements: 12
84
+ UncommunicativeMethodName:
85
+ enabled: true
86
+ exclude: []
87
+ reject:
88
+ - "/^[a-z]$/"
89
+ - "/[0-9]$/"
90
+ - "/[A-Z]/"
91
+ accept: []
92
+ UncommunicativeModuleName:
93
+ enabled: true
94
+ exclude: []
95
+ reject:
96
+ - "/^.$/"
97
+ - "/[0-9]$/"
98
+ accept:
99
+ - Inline::C
100
+ - "/V[0-9]/"
101
+ UncommunicativeParameterName:
102
+ enabled: true
103
+ exclude: []
104
+ reject:
105
+ - "/^.$/"
106
+ - "/[0-9]$/"
107
+ - "/[A-Z]/"
108
+ accept: []
109
+ UncommunicativeVariableName:
110
+ enabled: true
111
+ exclude: []
112
+ reject:
113
+ - "/^.$/"
114
+ - "/[0-9]$/"
115
+ - "/[A-Z]/"
116
+ accept:
117
+ - _
118
+ UnusedParameters:
119
+ enabled: true
120
+ exclude: []
121
+ UnusedPrivateMethod:
122
+ enabled: false
123
+ UtilityFunction:
124
+ enabled: false
125
+
126
+ exclude_paths:
127
+ - config
data/.rubocop.yml ADDED
@@ -0,0 +1,102 @@
1
+ AllCops:
2
+ NewCops: enable
3
+
4
+ Style/Documentation:
5
+ Enabled: false
6
+
7
+ Layout/SpaceBeforeFirstArg:
8
+ Exclude:
9
+
10
+ Lint/AmbiguousBlockAssociation:
11
+ Exclude:
12
+ - spec/**/*
13
+
14
+ Metrics/AbcSize:
15
+ # The ABC size is a calculated magnitude, so this number can be an Integer or
16
+ # a Float.
17
+ Max: 15
18
+
19
+ Metrics/BlockLength:
20
+ CountComments: false
21
+ Max: 25
22
+ Exclude:
23
+ - '*.gemspec'
24
+ - config/**/*
25
+ - spec/**/*
26
+ ExcludedMethods:
27
+ - class_methods
28
+
29
+ Metrics/BlockNesting:
30
+ Max: 4
31
+
32
+ Metrics/ClassLength:
33
+ CountComments: false
34
+ Max: 200
35
+
36
+ # Avoid complex methods.
37
+ Metrics/CyclomaticComplexity:
38
+ Max: 7
39
+
40
+ Metrics/MethodLength:
41
+ CountComments: false
42
+ Max: 24
43
+
44
+ Metrics/ModuleLength:
45
+ CountComments: false
46
+ Max: 200
47
+
48
+ Layout/LineLength:
49
+ Max: 100
50
+ # To make it possible to copy or click on URIs in the code, we allow lines
51
+ # containing a URI to be longer than Max.
52
+ AllowURI: true
53
+ URISchemes:
54
+ - http
55
+ - https
56
+
57
+ Metrics/ParameterLists:
58
+ Max: 5
59
+ CountKeywordArgs: true
60
+
61
+ Metrics/PerceivedComplexity:
62
+ Max: 12
63
+
64
+ Style/FrozenStringLiteralComment:
65
+ Enabled: true
66
+
67
+ Style/ModuleFunction:
68
+ Enabled: false
69
+
70
+ Style/RescueModifier:
71
+ Exclude:
72
+ - spec/**/*
73
+
74
+ Naming/PredicateName:
75
+ Enabled: false
76
+
77
+ Style/HashEachMethods:
78
+ Enabled: true
79
+
80
+ Style/HashTransformKeys:
81
+ Enabled: true
82
+
83
+ Style/HashTransformValues:
84
+ Enabled: true
85
+
86
+ Style/RedundantSelf:
87
+ Enabled: false
88
+
89
+ Naming/VariableName:
90
+ Enabled: false
91
+
92
+ Lint/UselessAssignment:
93
+ Enabled: false
94
+
95
+ Metrics/AbcSize:
96
+ Exclude:
97
+ - test/**/*
98
+
99
+ Metrics/MethodLength:
100
+ Max: 20
101
+ Exclude:
102
+ - test/**/*
@@ -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 igor@morozov.is. 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 [https://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: https://contributor-covenant.org
74
+ [version]: https://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ # frozen_string_literal: true
2
+
3
+ source 'https://rubygems.org'
4
+
5
+ # Specify your gem's dependencies in structurizr.gemspec
6
+ gemspec
data/Makefile ADDED
@@ -0,0 +1,31 @@
1
+ .PHONY: download-jars test console
2
+
3
+
4
+ download-jars:
5
+ rm -f lib/structurizr/metal/jars/*.jar
6
+ mvn dependency:get -Dartifact=commons-logging:commons-logging:LATEST -Ddest=./lib/structurizr/metal/jars/
7
+ mvn dependency:get -Dartifact=com.fasterxml.jackson.core:jackson-core:LATEST -Ddest=./lib/structurizr/metal/jars/
8
+ mvn dependency:get -Dartifact=com.fasterxml.jackson.core:jackson-databind:LATEST -Ddest=./lib/structurizr/metal/jars/
9
+ mvn dependency:get -Dartifact=com.fasterxml.jackson.core:jackson-annotations:LATEST -Ddest=./lib/structurizr/metal/jars/
10
+ mvn dependency:get -Dartifact=com.structurizr:structurizr-core:LATEST -Ddest=./lib/structurizr/metal/jars/
11
+ mvn dependency:get -Dartifact=com.structurizr:structurizr-graphviz:LATEST -Ddest=./lib/structurizr/metal/jars/
12
+ mvn dependency:get -Dartifact=com.structurizr:structurizr-client:LATEST -Ddest=./lib/structurizr/metal/jars/
13
+
14
+ test:
15
+ jruby -Itest -Ilib bin/test
16
+
17
+ setup:
18
+ jruby -S gem install bundler
19
+ jruby -S bundle install
20
+
21
+ bundle:
22
+ jruby -S bundle
23
+
24
+ lint:
25
+ jruby -S bundle exec rubocop
26
+
27
+ build:
28
+ jruby -S gem build
29
+
30
+ console:
31
+ bin/console
data/README.md ADDED
@@ -0,0 +1,53 @@
1
+ # Structurizr
2
+
3
+ [![Test Coverage](https://api.codeclimate.com/v1/badges/b75e8c130fc8b3bf54b5/test_coverage)](https://codeclimate.com/github/Morozzzko/structurizr-ruby/test_coverage)[![Maintainability](https://api.codeclimate.com/v1/badges/b75e8c130fc8b3bf54b5/maintainability)](https://codeclimate.com/github/Morozzzko/structurizr-ruby/maintainability)
4
+
5
+
6
+ `structurizr-ruby` brings the [C4 model](https://c4model.com) to Ruby. It piggybacks on top of [Java's API](https://github.com/structurizr/java) for [Structurizr](https://structurizr.com), which is a powerful tool for incorporating C4 model into your software architecture process.
7
+
8
+ The primary goal is to enable better introspection & scripting for workspaces defined by Structurizr DSL.
9
+
10
+ As a bonus, this library provides a complete integration to build Structurizr workspace from Ruby. However, it doesn't make much sense since there's Structurizr DSL.
11
+
12
+ If you've met something which doesn't have a nice Ruby DSL, you can always use [`Structurizr::Metal`](/lib/structurizr/metal.rb) to access Java classes and methods. Please don't forget to [submit issue or a pull-request](#Contributing) which describes your use-case and the missing features.
13
+
14
+ ## Installation
15
+
16
+ Install the gem:
17
+
18
+ $ jruby -S gem install structurizr
19
+
20
+ or add it to your Gemfile via CLI:
21
+
22
+ $ jruby -S bundle add structurizr
23
+
24
+ or just edit your `Gemfile` manually:
25
+
26
+ ```ruby
27
+ # Gemfile
28
+
29
+ gem 'structurizr'
30
+ ```
31
+
32
+ ## Usage
33
+
34
+ Before you start, you need to `require` the necessary files:
35
+
36
+ ```ruby
37
+ require 'structurizr'
38
+ ```
39
+
40
+ ## Development
41
+
42
+ After checking out the repo, run `make setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
43
+
44
+ To install this gem onto your local machine, run `jruby -S bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
45
+
46
+ ## Contributing
47
+
48
+ Bug reports and pull requests are welcome on GitHub at https://github.com/Morozzzko/structurizr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Morozzzko/structurizr-ruby/blob/master/CODE_OF_CONDUCT.md).
49
+
50
+
51
+ ## Code of Conduct
52
+
53
+ Everyone interacting in the Structurizr project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Morozzzko/structurizr-ruby/blob/master/CODE_OF_CONDUCT.md).
data/bin/console ADDED
@@ -0,0 +1,15 @@
1
+ #!/usr/bin/env jruby
2
+ # frozen_string_literal: true
3
+
4
+ require 'bundler/setup'
5
+ require 'structurizr'
6
+
7
+ # You can add fixtures and/or initialization code here to make experimenting
8
+ # with your gem easier. You can also use a different console, if you like.
9
+
10
+ # (If you use this, don't forget to add pry to your Gemfile!)
11
+ # require "pry"
12
+ # Pry.start
13
+
14
+ require 'irb'
15
+ IRB.start(__FILE__)
data/bin/test ADDED
@@ -0,0 +1,9 @@
1
+ #!/usr/bin/env jruby
2
+ # frozen_string_literal: true
3
+
4
+ require 'bundler/setup'
5
+ require 'test_helper'
6
+
7
+ Dir[File.join(__dir__, '../test/**/*_test.rb')].sort.each do |test_path|
8
+ require test_path
9
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ Arc42DocumentationTemplate = Metal::Documentation::Arc42DocumentationTemplate
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ AutomaticDocumentationTemplate = Metal::Documentation::AutomaticDocumentationTemplate
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ Border = Metal::View::Border
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ Component = Metal::Model::Component
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ Container = Metal::Model::Container
7
+ end
@@ -0,0 +1,6 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/structurizr_documentation_template'
4
+ require 'structurizr/arc42_documentation_template'
5
+ require 'structurizr/automatic_documentation_template'
6
+ require 'structurizr/viewpoints_and_perspectives_documentation_template'
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ Enterprise = Metal::Model::Enterprise
7
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/interaction_style'
4
+ require 'structurizr/location'
5
+ require 'structurizr/paper_size'
6
+ require 'structurizr/tags'
7
+ require 'structurizr/shape'
8
+ require 'structurizr/border'
9
+ require 'structurizr/format'
10
+ require 'structurizr/routing'
11
+ require 'structurizr/filter_mode'
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ FilterMode = Metal::View::FilterMode
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ Format = Metal::Documentation::Format
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ ImageUtils = Metal::Util::ImageUtils
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ InteractionStyle = Metal::Model::InteractionStyle
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ Location = Metal::Model::Location
7
+ end
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright {yyyy} {name of copyright owner}
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,7 @@
1
+ # Structurizr jars
2
+
3
+ This directory exists for one single purpose: to store the structurizr jars.
4
+
5
+ I don't mind using [jbundler](https://github.com/mkristian/jbundler), but I don't have the free time now. If you're up for this task, I'll be happy to accept your PR
6
+
7
+ For the license see [LICENSE](LICENSE).
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'java'
4
+
5
+ Dir[File.join(__dir__, 'metal/jars/*.jar')].sort.each do |jar_path|
6
+ require jar_path
7
+ end
8
+
9
+ # require 'structurizr/metal/jars/commons-logging-1.2.jar'
10
+ # require 'structurizr/metal/jars/jackson-core-2.11.2.jar'
11
+ # require 'structurizr/metal/jars/jackson-databind-2.11.2.jar'
12
+ # require 'structurizr/metal/jars/jackson-annotations-2.11.2.jar'
13
+ # require 'structurizr/metal/jars/structurizr-core-1.6.0.jar'
14
+ # require 'structurizr/metal/jars/structurizr-client-1.6.0.jar'
15
+
16
+ module Structurizr
17
+ # This namespace provides lower-level Java integration with Structurizr
18
+ module Metal
19
+ Root = ::Java::ComStructurizr
20
+ Model = ::Java::ComStructurizrModel
21
+ View = ::Java::ComStructurizrView
22
+ Client = ::Java::ComStructurizrClient
23
+ Util = ::Java::ComStructurizrUtil
24
+ Documentation = ::Java::ComStructurizrDocumentation
25
+
26
+ # We need it due to a behavior in jruby which doesn't bind methods from non-public classes
27
+ # https://github.com/jruby/jruby/issues/6197
28
+ # For now we'll stick to our own patch which manually binds those methods
29
+ class Model::ModelItem
30
+ java_alias :addTags, :addTags, [java.lang.String[]]
31
+ java_alias :add_tags, :addTags, [java.lang.String[]]
32
+ java_alias :getTags, :getTags, []
33
+ java_alias :get_tags, :getTags, []
34
+ java_alias :removeTag, :removeTag, [java.lang.String]
35
+ java_alias :remove_tag, :removeTag, [java.lang.String]
36
+ java_alias :hasTag, :hasTag, [java.lang.String]
37
+ java_alias :has_tag, :hasTag, [java.lang.String]
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ Model = Metal::Model::Model
7
+
8
+ class Model
9
+ def elements
10
+ get_elements.to_a
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ ModelItem = Metal::Model::ModelItem
7
+
8
+ class ModelItem
9
+ def tags
10
+ get_tags.split(',')
11
+ end
12
+
13
+ def inspect
14
+ class_name = self.class.name.split('::').last
15
+ %(<#{class_name}: "#{name}">)
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ PaperSize = Metal::View::PaperSize
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ Person = Metal::Model::Person
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ Relationship = Metal::Model::Relationship
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ Routing = Metal::View::Routing
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ Shape = Metal::View::Shape
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ SoftwareSystem = Metal::Model::SoftwareSystem
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ StructurizrDocumentationTemplate = Metal::Documentation::StructurizrDocumentationTemplate
7
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ Tags = Metal::Model::Tags
7
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Structurizr
4
+ VERSION = '1.0.0-alpha.1'
5
+ end
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+
5
+ module Structurizr
6
+ ViewpointsAndPerspectivesDocumentationTemplate =
7
+ Metal::Documentation::ViewpointsAndPerspectivesDocumentationTemplate
8
+ end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/metal'
4
+ require 'structurizr/model'
5
+ require 'structurizr/enterprise'
6
+
7
+ module Structurizr
8
+ Workspace = Metal::Root::Workspace
9
+
10
+ class Workspace
11
+ def to_json(*_args)
12
+ Metal::Util::WorkspaceUtils.to_json(self, true)
13
+ end
14
+
15
+ def self.from_json(json)
16
+ Metal::Util::WorkspaceUtils.from_json(json)
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'structurizr/version'
4
+ require 'structurizr/model_item'
5
+ require 'structurizr/workspace'
6
+ require 'structurizr/container'
7
+ require 'structurizr/component'
8
+ require 'structurizr/relationship'
9
+ require 'structurizr/software_system'
10
+ require 'structurizr/person'
11
+
12
+ require 'structurizr/enums'
13
+ require 'structurizr/documentation_templates'
14
+
15
+ require 'structurizr/image_utils'
16
+
17
+ module Structurizr
18
+ class Error < StandardError; end
19
+ end
@@ -0,0 +1,33 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'lib/structurizr/version'
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = 'structurizr'
7
+ spec.version = Structurizr::VERSION
8
+ spec.authors = ['Igor S. Morozov']
9
+ spec.email = ['igor@morozov.is']
10
+
11
+ spec.summary = 'C4 model in Ruby. Wrapper for Structurizr API'
12
+ spec.homepage = 'https://github.com/Morozzzko/structurizr-ruby'
13
+ spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
14
+
15
+ spec.metadata['homepage_uri'] = spec.homepage
16
+ spec.metadata['source_code_uri'] = spec.homepage
17
+ spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
18
+
19
+ # Specify which files should be added to the gem when it is released.
20
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
21
+ spec.files = Dir.chdir(File.expand_path(__dir__)) do
22
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|.github)/}) }
23
+ end
24
+ spec.bindir = 'exe'
25
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
26
+ spec.require_paths = ['lib']
27
+
28
+ spec.add_development_dependency 'minitest'
29
+ spec.add_development_dependency 'pry'
30
+ spec.add_development_dependency 'rubocop'
31
+ spec.add_development_dependency 'rubocop-minitest'
32
+ spec.add_development_dependency 'simplecov', '~> 0.17.1'
33
+ end
metadata ADDED
@@ -0,0 +1,164 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: structurizr
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0.pre.alpha.1
5
+ platform: ruby
6
+ authors:
7
+ - Igor S. Morozov
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2022-06-10 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - ">="
17
+ - !ruby/object:Gem::Version
18
+ version: '0'
19
+ name: minitest
20
+ prerelease: false
21
+ type: :development
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ requirement: !ruby/object:Gem::Requirement
29
+ requirements:
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: '0'
33
+ name: pry
34
+ prerelease: false
35
+ type: :development
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ requirement: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - ">="
45
+ - !ruby/object:Gem::Version
46
+ version: '0'
47
+ name: rubocop
48
+ prerelease: false
49
+ type: :development
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ requirement: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - ">="
59
+ - !ruby/object:Gem::Version
60
+ version: '0'
61
+ name: rubocop-minitest
62
+ prerelease: false
63
+ type: :development
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ requirement: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - "~>"
73
+ - !ruby/object:Gem::Version
74
+ version: 0.17.1
75
+ name: simplecov
76
+ prerelease: false
77
+ type: :development
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 0.17.1
83
+ description:
84
+ email:
85
+ - igor@morozov.is
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitattributes"
91
+ - ".gitignore"
92
+ - ".jrubyrc"
93
+ - ".reek.yml"
94
+ - ".rubocop.yml"
95
+ - CODE_OF_CONDUCT.md
96
+ - Gemfile
97
+ - Makefile
98
+ - README.md
99
+ - bin/console
100
+ - bin/test
101
+ - lib/structurizr.rb
102
+ - lib/structurizr/arc42_documentation_template.rb
103
+ - lib/structurizr/automatic_documentation_template.rb
104
+ - lib/structurizr/border.rb
105
+ - lib/structurizr/component.rb
106
+ - lib/structurizr/container.rb
107
+ - lib/structurizr/documentation_templates.rb
108
+ - lib/structurizr/enterprise.rb
109
+ - lib/structurizr/enums.rb
110
+ - lib/structurizr/filter_mode.rb
111
+ - lib/structurizr/format.rb
112
+ - lib/structurizr/image_utils.rb
113
+ - lib/structurizr/interaction_style.rb
114
+ - lib/structurizr/location.rb
115
+ - lib/structurizr/metal.rb
116
+ - lib/structurizr/metal/jars/LICENSE
117
+ - lib/structurizr/metal/jars/README.md
118
+ - lib/structurizr/metal/jars/commons-logging-1.2.jar
119
+ - lib/structurizr/metal/jars/jackson-annotations-2.13.0-rc1.jar
120
+ - lib/structurizr/metal/jars/jackson-core-2.13.0-rc1.jar
121
+ - lib/structurizr/metal/jars/jackson-databind-2.13.0-rc1.jar
122
+ - lib/structurizr/metal/jars/structurizr-client-1.9.5.jar
123
+ - lib/structurizr/metal/jars/structurizr-core-1.9.5.jar
124
+ - lib/structurizr/metal/jars/structurizr-graphviz-1.5.0.jar
125
+ - lib/structurizr/model.rb
126
+ - lib/structurizr/model_item.rb
127
+ - lib/structurizr/paper_size.rb
128
+ - lib/structurizr/person.rb
129
+ - lib/structurizr/relationship.rb
130
+ - lib/structurizr/routing.rb
131
+ - lib/structurizr/shape.rb
132
+ - lib/structurizr/software_system.rb
133
+ - lib/structurizr/structurizr_documentation_template.rb
134
+ - lib/structurizr/tags.rb
135
+ - lib/structurizr/version.rb
136
+ - lib/structurizr/viewpoints_and_perspectives_documentation_template.rb
137
+ - lib/structurizr/workspace.rb
138
+ - structurizr.gemspec
139
+ homepage: https://github.com/Morozzzko/structurizr-ruby
140
+ licenses: []
141
+ metadata:
142
+ homepage_uri: https://github.com/Morozzzko/structurizr-ruby
143
+ source_code_uri: https://github.com/Morozzzko/structurizr-ruby
144
+ changelog_uri: https://github.com/Morozzzko/structurizr-ruby/blob/master/CHANGELOG.md
145
+ post_install_message:
146
+ rdoc_options: []
147
+ require_paths:
148
+ - lib
149
+ required_ruby_version: !ruby/object:Gem::Requirement
150
+ requirements:
151
+ - - ">="
152
+ - !ruby/object:Gem::Version
153
+ version: 2.3.0
154
+ required_rubygems_version: !ruby/object:Gem::Requirement
155
+ requirements:
156
+ - - ">"
157
+ - !ruby/object:Gem::Version
158
+ version: 1.3.1
159
+ requirements: []
160
+ rubygems_version: 3.1.6
161
+ signing_key:
162
+ specification_version: 4
163
+ summary: C4 model in Ruby. Wrapper for Structurizr API
164
+ test_files: []