loggable_activity 0.1.38b → 0.1.40

Sign up to get free protection for your applications and to get access to all the features.
Files changed (100) hide show
  1. checksums.yaml +4 -4
  2. data/.document +1 -0
  3. data/.nojekyll +1 -0
  4. data/.rubocop.yml +1 -1
  5. data/CHANGELOG.md +2 -0
  6. data/GETTING-STARTED.md +10 -10
  7. data/README.md +8 -5
  8. data/ROADMAP.md +9 -5
  9. data/doc/.nojekyll +1 -0
  10. data/doc/CHANGELOG_md.html +125 -0
  11. data/doc/CODE_OF_CONDUCT_md.html +220 -0
  12. data/doc/CONSIDERTIONS_md.html +227 -0
  13. data/doc/CreateLoggableActivities.html +144 -0
  14. data/doc/CreateLoggableEncryptionKeys.html +140 -0
  15. data/doc/CreateLoggablePayloads.html +144 -0
  16. data/doc/GETTING-STARTED_md.html +186 -0
  17. data/doc/Gemfile.html +104 -0
  18. data/doc/Gemfile_lock.html +152 -0
  19. data/doc/LICENSE_txt.html +104 -0
  20. data/doc/LoggableActivity/CurrentUser.html +99 -0
  21. data/doc/LoggableActivity/Generators/InstallGenerator.html +178 -0
  22. data/doc/LoggableActivity/Generators.html +91 -0
  23. data/doc/README_md.html +138 -0
  24. data/doc/ROADMAP_md.html +151 -0
  25. data/doc/Rakefile.html +102 -0
  26. data/doc/bin/setup.html +100 -0
  27. data/doc/notes/CHEAT_SHEET_md.html +130 -0
  28. data/doc/sig/loggable_activity_rbs.html +101 -0
  29. data/docs/LoggableActivity/Activity.html +494 -0
  30. data/docs/LoggableActivity/Configuration.html +183 -0
  31. data/docs/LoggableActivity/Encryption.html +220 -0
  32. data/docs/LoggableActivity/EncryptionError.html +99 -0
  33. data/docs/LoggableActivity/EncryptionKey.html +327 -0
  34. data/docs/LoggableActivity/Error.html +97 -0
  35. data/docs/LoggableActivity/Hooks.html +172 -0
  36. data/docs/LoggableActivity/Payload.html +159 -0
  37. data/docs/LoggableActivity/PayloadsBuilder.html +154 -0
  38. data/docs/LoggableActivity/UpdatePayloadsBuilder.html +199 -0
  39. data/docs/LoggableActivity.html +100 -0
  40. data/docs/created.rid +10 -0
  41. data/docs/css/fonts.css +167 -0
  42. data/docs/css/rdoc.css +687 -0
  43. data/docs/fonts/Lato-Light.ttf +0 -0
  44. data/docs/fonts/Lato-LightItalic.ttf +0 -0
  45. data/docs/fonts/Lato-Regular.ttf +0 -0
  46. data/docs/fonts/Lato-RegularItalic.ttf +0 -0
  47. data/docs/fonts/SourceCodePro-Bold.ttf +0 -0
  48. data/docs/fonts/SourceCodePro-Regular.ttf +0 -0
  49. data/docs/images/add.png +0 -0
  50. data/docs/images/arrow_up.png +0 -0
  51. data/docs/images/brick.png +0 -0
  52. data/docs/images/brick_link.png +0 -0
  53. data/docs/images/bug.png +0 -0
  54. data/docs/images/bullet_black.png +0 -0
  55. data/docs/images/bullet_toggle_minus.png +0 -0
  56. data/docs/images/bullet_toggle_plus.png +0 -0
  57. data/docs/images/date.png +0 -0
  58. data/docs/images/delete.png +0 -0
  59. data/docs/images/find.png +0 -0
  60. data/docs/images/loadingAnimation.gif +0 -0
  61. data/docs/images/macFFBgHack.png +0 -0
  62. data/docs/images/package.png +0 -0
  63. data/docs/images/page_green.png +0 -0
  64. data/docs/images/page_white_text.png +0 -0
  65. data/docs/images/page_white_width.png +0 -0
  66. data/docs/images/plugin.png +0 -0
  67. data/docs/images/ruby.png +0 -0
  68. data/docs/images/tag_blue.png +0 -0
  69. data/docs/images/tag_green.png +0 -0
  70. data/docs/images/transparent.png +0 -0
  71. data/docs/images/wrench.png +0 -0
  72. data/docs/images/wrench_orange.png +0 -0
  73. data/docs/images/zoom.png +0 -0
  74. data/docs/index.html +91 -0
  75. data/docs/js/darkfish.js +97 -0
  76. data/docs/js/navigation.js +105 -0
  77. data/docs/js/navigation.js.gz +0 -0
  78. data/docs/js/search.js +110 -0
  79. data/docs/js/search_index.js +1 -0
  80. data/docs/js/search_index.js.gz +0 -0
  81. data/docs/js/searcher.js +229 -0
  82. data/docs/js/searcher.js.gz +0 -0
  83. data/docs/table_of_contents.html +184 -0
  84. data/lib/generators/loggable_activity/install_generator.rb +2 -1
  85. data/lib/generators/loggable_activity/templates/current_user.rb +1 -1
  86. data/lib/generators/loggable_activity/templates/loggable_activity.yml +29 -0
  87. data/lib/loggable_activity/activity.rb +208 -59
  88. data/lib/loggable_activity/configuration.rb +18 -0
  89. data/lib/loggable_activity/encryption.rb +20 -1
  90. data/lib/loggable_activity/encryption_key.rb +81 -14
  91. data/lib/loggable_activity/hooks.rb +10 -7
  92. data/lib/loggable_activity/payload.rb +45 -11
  93. data/lib/loggable_activity/payloads_builder.rb +50 -4
  94. data/lib/loggable_activity/update_payloads_builder.rb +64 -2
  95. data/lib/loggable_activity/version.rb +1 -1
  96. metadata +82 -10
  97. data/.DS_Store +0 -0
  98. data/loggable_activity-0.1.32.gem +0 -0
  99. data/loggable_activity-0.1.33.gem +0 -0
  100. data/loggable_activity-0.1.34.gem +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6a53175944ae66c68b08cbf7428105a6f73fc0160f7680f556be20113dc2451e
4
- data.tar.gz: dbf2b2d5052f0849b726315da160fb4eeafe496ddbcfd99bbc515b8198bf3df8
3
+ metadata.gz: 87bb5b080d2a9c390188145f477626a30554ebc5707b2e7ae19a31ecc122ca24
4
+ data.tar.gz: b6f8ad570c6fa4269b11b67b3f12c4da3d653f2314a26348c9e0c0a5c4b2fc1c
5
5
  SHA512:
6
- metadata.gz: 65cb36b2ebb17b01d95cd8b5fe13aaff456b524f11671e8e5191bb4e101e09d2170dab5682218e179a9db1df241e24d8830788f49cc5d0a1d25d51842beeb5ac
7
- data.tar.gz: 9c2f41c649aeaa812ad58bbecfd584de56bcbe37398359129323055cebeae9c64a16798bd89688d26c3a0392d02fb89539b0ed9c8eca9a5c4a8e684fbb5f6b75
6
+ metadata.gz: 949ae83512a7a194331521c1c7a7d6ea64c88af8a9592f083c48c2926fe420a66f13d5db883cd291669000c83e3561d38fbecc79d183a9936ef336a603b64c21
7
+ data.tar.gz: fabee0ee30a6adeb0ad8e8bda323fedd66c5ecf966076e029efa9878b426825ea8fa721ba69e26e06dca59de4df7c240ef32b575a6ca52eaa5581232b47d10df
data/.document ADDED
@@ -0,0 +1 @@
1
+ lib/loggable_activity
data/.nojekyll ADDED
@@ -0,0 +1 @@
1
+ - keep
data/.rubocop.yml CHANGED
@@ -28,7 +28,7 @@ Metrics/PerceivedComplexity:
28
28
 
29
29
  Metrics/ModuleLength:
30
30
  Exclude:
31
- # - lib/loggable_activity/hooks.rb
31
+ - lib/loggable_activity/hooks.rb
32
32
  Metrics/AbcSize:
33
33
  Exclude:
34
34
  - lib/loggable_activity/encryption.rb
data/CHANGELOG.md CHANGED
@@ -1,5 +1,7 @@
1
1
  ## [Unreleased]
2
2
  - nothing so far
3
+ ## [0.1.39] - 2024-02-12
4
+ - Updated README.md and GETTING-STARTED.md
3
5
  ## [0.1.38] - 2024-02-12
4
6
  - Removed dependency on awesome print
5
7
  ## [0.1.35] - 2024-02-11
data/GETTING-STARTED.md CHANGED
@@ -3,7 +3,7 @@ This document should you getting started with `LoggableActivity`
3
3
 
4
4
  ## Prerequisite
5
5
  1 A running Rails Application<br/>
6
- 2 An authorization system where there is a current available.
6
+ 2 An authorization system where there is a current user available.
7
7
 
8
8
  ## Demo Application
9
9
  You can download a demo application from<br/>
@@ -12,18 +12,20 @@ You can download a demo application from<br/>
12
12
  ## Configuration
13
13
  First you have to create a configuration file named `loggable_activity.yml` and locate it in the config folder.<br/>
14
14
  It has the following tags
15
+ - `User` (example)<br>
16
+ This is the name of the model you are configuring, as you can see there is alos a `Demo::Address` in the configuration file below, So if you have a model named `Demo::Club` you have to create at tag for that and fill in the other tags under that.
15
17
  - record_display_name: <br>
16
- You CAN define a method on the **User** model called full name, this will be a part of the json payload related to the **User** model
18
+ Used to display something human to identify a given log entry, in this example the **User** model has a method named `full_name`
17
19
 
18
20
  - loggable_attrs:<br/>
19
- This are the fields in the database you HAS to define
21
+ This are the attributes on a model and reflect the fields in the database you HAS to define, what fields to log.
20
22
 
21
23
  - auto_log:<br/>
22
24
  This are the actions that will be logged automatically, although you can log manually at any time.
23
- Note there is no hook for `Show` in Rails so you would have to log that manually like this `log(:how)`, more about that later.
25
+ Note there is no hook for `Show` in Rails so you would have to log that manually like this `log(:show)`, more about that later.
24
26
 
25
27
  - relations:<br/>
26
- If a model has `belongs_to` and `has_one` relations you can log them as well<br>
28
+ If a model has `belongs_to` and `has_one` relations you can log them automatically as well<br>
27
29
  <br/>
28
30
  *Example confuguration for logging of the user model*
29
31
  ```
@@ -65,7 +67,7 @@ class ApplicationController < ActionController::Base
65
67
  include LoggableActivity::CurrentUser
66
68
  ```
67
69
 
68
- Now when you create a model like this:
70
+ Now if you create a model like this:
69
71
  ```
70
72
  $ rails c
71
73
  $ User.create(first_name: 'John', last_name: 'Doe')
@@ -73,8 +75,6 @@ $ User.create(first_name: 'John', last_name: 'Doe')
73
75
 
74
76
  Then an `LoggableActivity::Activity` is created. You can inspect it from the terminal like this.
75
77
  ```
76
- puts activity = Loggable::Activity.all.latest.first
77
- puts activity.activity_type
78
- puts activity.payloads
79
- puts activity.payload_attrs
78
+ puts activity = Loggable::Activity.last
79
+ puts activity.attrs
80
80
  ```
data/README.md CHANGED
@@ -1,4 +1,5 @@
1
1
  # Loggable Activity 🌟
2
+ Secure protect data and log how it is handled
2
3
  - Keep an activity log of how data in the db are handled.
3
4
  - Protect and secure the privacy of data stored in Activity Logs
4
5
  - Prepare for General Data Protection Regulation (GDPR) compliance.
@@ -7,26 +8,28 @@
7
8
  ### What it is not
8
9
  - An error logging system
9
10
  - A paper trails system with rollback.
11
+ - A backup system
10
12
 
11
13
  ### Applications
12
14
  Most organizations needs to keep a log of how users interact with data stored in the DB
13
15
  - Finance
14
16
  - Healthcare
15
- - Sales
16
- - Organizations
17
+ - Sales and Support
17
18
 
18
19
  *Super simplified example from the healthcare.*
19
20
  - Each patient has a journal, that is updated on a regular basis.
20
- - Supervisor needs to follow the journal.
21
+ - Supervisor needs to follow the journal, how was it updated, who read it.
21
22
  - Security personnel needs to know how the journal is handled, who did what when.
22
- - Patients has the right to their journal.
23
+ - Patients has the right to know how their journal is handled and that the log is deleted.
23
24
 
24
25
  Beside the journal in the db, an activity log is kept so it is possible to track how the journal is used.<br/>
25
26
  At some point in time the patients data from the DB and the activity log has to be removed according to GDPR.<br/>
26
27
 
27
28
 
28
29
  👉 Join the Slack channel here: [LoggableActivity Slack Workspace](https://join.slack.com/t/loggableactivity/shared_invite/zt-2a3tvgv37-mGwjHJTrBXBH2srXFRRSXQ)
29
-
30
+ <br/>
31
+ 👉 Want to play around with an online version: [Show Demo](https://loggableactivity-efe7b931c886.herokuapp.com/)
32
+ <br/>
30
33
  We value each contribution and believe in the power of community. Looking forward to seeing you there!
31
34
 
32
35
 
data/ROADMAP.md CHANGED
@@ -1,8 +1,11 @@
1
1
  # Roadmap
2
2
  Outline of steps to get the LoggableActivity adapted.
3
3
 
4
- ### RD project
5
- Nothing is better than gain som experience by getting som real world tests and experiences
4
+ ### Demo project
5
+ Nothing is better than gain som experience by getting som real world tests and experiences.
6
+ <br/>
7
+ Try the [Live Demo]("https://loggableactivity-efe7b931c886.herokuapp.com/") here or download it from [Github]("https://github.com/maxgronlund/LoggableActivityDemoApp") here
8
+
6
9
 
7
10
  ### Open Source
8
11
  More eyes and brains on the project wil make it mature and better.
@@ -14,6 +17,7 @@ More eyes and brains on the project wil make it mature and better.
14
17
  - RFC for protocol
15
18
  - Commercial potentials, business models.
16
19
  - Explainers
17
- - Hosting of example project.
18
- - Homepage.
19
- - Documentation
20
+ - Documentation RDoc
21
+ - Rest API
22
+ - GraphQL API
23
+ - Integration with other languages, node, elixir...
data/doc/.nojekyll ADDED
@@ -0,0 +1 @@
1
+ - keep
@@ -0,0 +1,125 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>CHANGELOG - RDoc Documentation</title>
8
+
9
+ <script type="text/javascript">
10
+ var rdoc_rel_prefix = "./";
11
+ var index_rel_prefix = "./";
12
+ </script>
13
+
14
+ <script src="./js/navigation.js" defer></script>
15
+ <script src="./js/search.js" defer></script>
16
+ <script src="./js/search_index.js" defer></script>
17
+ <script src="./js/searcher.js" defer></script>
18
+ <script src="./js/darkfish.js" defer></script>
19
+
20
+ <link href="./css/fonts.css" rel="stylesheet">
21
+ <link href="./css/rdoc.css" rel="stylesheet">
22
+
23
+
24
+ <body id="top" role="document" class="file">
25
+ <nav role="navigation">
26
+ <div id="project-navigation">
27
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
+ <h2>
29
+ <a href="./index.html" rel="home">Home</a>
30
+ </h2>
31
+
32
+ <div id="table-of-contents-navigation">
33
+ <a href="./table_of_contents.html#pages">Pages</a>
34
+ <a href="./table_of_contents.html#classes">Classes</a>
35
+ <a href="./table_of_contents.html#methods">Methods</a>
36
+ </div>
37
+ </div>
38
+
39
+ <div id="search-section" role="search" class="project-section initially-hidden">
40
+ <form action="#" method="get" accept-charset="utf-8">
41
+ <div id="search-field-wrapper">
42
+ <input id="search-field" role="combobox" aria-label="Search"
43
+ aria-autocomplete="list" aria-controls="search-results"
44
+ type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
45
+ title="Type to search, Up and Down to navigate, Enter to load">
46
+ </div>
47
+
48
+ <ul id="search-results" aria-label="Search Results"
49
+ aria-busy="false" aria-expanded="false"
50
+ aria-atomic="false" class="initially-hidden"></ul>
51
+ </form>
52
+ </div>
53
+
54
+ </div>
55
+
56
+
57
+ <div class="nav-section">
58
+ <h3>Table of Contents</h3>
59
+
60
+
61
+
62
+ <ul class="link-list" role="directory">
63
+ <li> <a href="#label-5BUnreleased-5D">[Unreleased]</a>
64
+ <li> <a href="#label-5B0.1.39-5D+-+2024-02-12">[0.1.39] - 2024-02-12</a>
65
+ <li> <a href="#label-5B0.1.38-5D+-+2024-02-12">[0.1.38] - 2024-02-12</a>
66
+ <li> <a href="#label-5B0.1.35-5D+-+2024-02-11">[0.1.35] - 2024-02-11</a>
67
+
68
+ </ul>
69
+ </div>
70
+
71
+
72
+ <div id="project-metadata">
73
+
74
+ <div id="fileindex-section" class="nav-section">
75
+ <h3>Pages</h3>
76
+
77
+ <ul class="link-list">
78
+ <li><a href="./CHANGELOG_md.html">CHANGELOG</a>
79
+ <li><a href="./CODE_OF_CONDUCT_md.html">CODE_OF_CONDUCT</a>
80
+ <li><a href="./CONSIDERTIONS_md.html">CONSIDERTIONS</a>
81
+ <li><a href="./GETTING-STARTED_md.html">GETTING-STARTED</a>
82
+ <li><a href="./Gemfile.html">Gemfile</a>
83
+ <li><a href="./Gemfile_lock.html">Gemfile.lock</a>
84
+ <li><a href="./LICENSE_txt.html">LICENSE</a>
85
+ <li><a href="./README_md.html">README</a>
86
+ <li><a href="./ROADMAP_md.html">ROADMAP</a>
87
+ <li><a href="./Rakefile.html">Rakefile</a>
88
+ <li><a href="./bin/setup.html">setup</a>
89
+ <li><a href="./notes/CHEAT_SHEET_md.html">CHEAT_SHEET</a>
90
+ <li><a href="./sig/loggable_activity_rbs.html">loggable_activity.rbs</a>
91
+ </ul>
92
+ </div>
93
+
94
+ </div>
95
+ </nav>
96
+
97
+ <main role="main" aria-label="Page CHANGELOG.md">
98
+
99
+ <h2 id="label-5BUnreleased-5D">[Unreleased]<span><a href="#label-5BUnreleased-5D">&para;</a> <a href="#top">&uarr;</a></span></h2>
100
+ <ul><li>
101
+ <p>nothing so far</p>
102
+
103
+ <h2 id="label-5B0.1.39-5D+-+2024-02-12">[0.1.39] - 2024-02-12<span><a href="#label-5B0.1.39-5D+-+2024-02-12">&para;</a> <a href="#top">&uarr;</a></span></h2>
104
+ </li><li>
105
+ <p>Updated <a href="README_md.html">README.md</a> and <a href="GETTING-STARTED_md.html">GETTING-STARTED.md</a></p>
106
+
107
+ <h2 id="label-5B0.1.38-5D+-+2024-02-12">[0.1.38] - 2024-02-12<span><a href="#label-5B0.1.38-5D+-+2024-02-12">&para;</a> <a href="#top">&uarr;</a></span></h2>
108
+ </li><li>
109
+ <p>Removed dependency on awesome print</p>
110
+
111
+ <h2 id="label-5B0.1.35-5D+-+2024-02-11">[0.1.35] - 2024-02-11<span><a href="#label-5B0.1.35-5D+-+2024-02-11">&para;</a> <a href="#top">&uarr;</a></span></h2>
112
+ </li><li>
113
+ <p>Initial release</p>
114
+ </li></ul>
115
+
116
+ </main>
117
+
118
+
119
+
120
+ <footer id="validator-badges" role="contentinfo">
121
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
122
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
123
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
124
+ </footer>
125
+
@@ -0,0 +1,220 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>CODE_OF_CONDUCT - RDoc Documentation</title>
8
+
9
+ <script type="text/javascript">
10
+ var rdoc_rel_prefix = "./";
11
+ var index_rel_prefix = "./";
12
+ </script>
13
+
14
+ <script src="./js/navigation.js" defer></script>
15
+ <script src="./js/search.js" defer></script>
16
+ <script src="./js/search_index.js" defer></script>
17
+ <script src="./js/searcher.js" defer></script>
18
+ <script src="./js/darkfish.js" defer></script>
19
+
20
+ <link href="./css/fonts.css" rel="stylesheet">
21
+ <link href="./css/rdoc.css" rel="stylesheet">
22
+
23
+
24
+ <body id="top" role="document" class="file">
25
+ <nav role="navigation">
26
+ <div id="project-navigation">
27
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
+ <h2>
29
+ <a href="./index.html" rel="home">Home</a>
30
+ </h2>
31
+
32
+ <div id="table-of-contents-navigation">
33
+ <a href="./table_of_contents.html#pages">Pages</a>
34
+ <a href="./table_of_contents.html#classes">Classes</a>
35
+ <a href="./table_of_contents.html#methods">Methods</a>
36
+ </div>
37
+ </div>
38
+
39
+ <div id="search-section" role="search" class="project-section initially-hidden">
40
+ <form action="#" method="get" accept-charset="utf-8">
41
+ <div id="search-field-wrapper">
42
+ <input id="search-field" role="combobox" aria-label="Search"
43
+ aria-autocomplete="list" aria-controls="search-results"
44
+ type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
45
+ title="Type to search, Up and Down to navigate, Enter to load">
46
+ </div>
47
+
48
+ <ul id="search-results" aria-label="Search Results"
49
+ aria-busy="false" aria-expanded="false"
50
+ aria-atomic="false" class="initially-hidden"></ul>
51
+ </form>
52
+ </div>
53
+
54
+ </div>
55
+
56
+
57
+ <div class="nav-section">
58
+ <h3>Table of Contents</h3>
59
+
60
+
61
+
62
+ <ul class="link-list" role="directory">
63
+ <li>
64
+ <details open>
65
+ <summary> <a href="#label-Contributor+Covenant+Code+of+Conduct">Contributor Covenant Code of Conduct</a>
66
+ </summary>
67
+ <ul class="link-list" role="directory">
68
+ <li> <a href="#label-Our+Pledge">Our Pledge</a>
69
+ <li> <a href="#label-Our+Standards">Our Standards</a>
70
+ <li> <a href="#label-Enforcement+Responsibilities">Enforcement Responsibilities</a>
71
+ <li> <a href="#label-Scope">Scope</a>
72
+ <li> <a href="#label-Enforcement">Enforcement</a>
73
+ <li>
74
+ <details open>
75
+ <summary> <a href="#label-Enforcement+Guidelines">Enforcement Guidelines</a>
76
+ </summary>
77
+ <ul class="link-list" role="directory">
78
+ <li> <a href="#label-1.+Correction">1. Correction</a>
79
+ <li> <a href="#label-2.+Warning">2. Warning</a>
80
+ <li> <a href="#label-3.+Temporary+Ban">3. Temporary Ban</a>
81
+ <li> <a href="#label-4.+Permanent+Ban">4. Permanent Ban</a>
82
+
83
+ </ul>
84
+ </details>
85
+ </li>
86
+ <li> <a href="#label-Attribution">Attribution</a>
87
+
88
+ </ul>
89
+ </details>
90
+ </li>
91
+
92
+ </ul>
93
+ </div>
94
+
95
+
96
+ <div id="project-metadata">
97
+
98
+ <div id="fileindex-section" class="nav-section">
99
+ <h3>Pages</h3>
100
+
101
+ <ul class="link-list">
102
+ <li><a href="./CHANGELOG_md.html">CHANGELOG</a>
103
+ <li><a href="./CODE_OF_CONDUCT_md.html">CODE_OF_CONDUCT</a>
104
+ <li><a href="./CONSIDERTIONS_md.html">CONSIDERTIONS</a>
105
+ <li><a href="./GETTING-STARTED_md.html">GETTING-STARTED</a>
106
+ <li><a href="./Gemfile.html">Gemfile</a>
107
+ <li><a href="./Gemfile_lock.html">Gemfile.lock</a>
108
+ <li><a href="./LICENSE_txt.html">LICENSE</a>
109
+ <li><a href="./README_md.html">README</a>
110
+ <li><a href="./ROADMAP_md.html">ROADMAP</a>
111
+ <li><a href="./Rakefile.html">Rakefile</a>
112
+ <li><a href="./bin/setup.html">setup</a>
113
+ <li><a href="./notes/CHEAT_SHEET_md.html">CHEAT_SHEET</a>
114
+ <li><a href="./sig/loggable_activity_rbs.html">loggable_activity.rbs</a>
115
+ </ul>
116
+ </div>
117
+
118
+ </div>
119
+ </nav>
120
+
121
+ <main role="main" aria-label="Page CODE_OF_CONDUCT.md">
122
+
123
+ <h1 id="label-Contributor+Covenant+Code+of+Conduct">Contributor Covenant Code of Conduct<span><a href="#label-Contributor+Covenant+Code+of+Conduct">&para;</a> <a href="#top">&uarr;</a></span></h1>
124
+
125
+ <h2 id="label-Our+Pledge">Our Pledge<span><a href="#label-Our+Pledge">&para;</a> <a href="#top">&uarr;</a></span></h2>
126
+
127
+ <p>We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.</p>
128
+
129
+ <p>We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.</p>
130
+
131
+ <h2 id="label-Our+Standards">Our Standards<span><a href="#label-Our+Standards">&para;</a> <a href="#top">&uarr;</a></span></h2>
132
+
133
+ <p>Examples of behavior that contributes to a positive environment for our community include:</p>
134
+ <ul><li>
135
+ <p>Demonstrating empathy and kindness toward other people</p>
136
+ </li><li>
137
+ <p>Being respectful of differing opinions, viewpoints, and experiences</p>
138
+ </li><li>
139
+ <p>Giving and gracefully accepting constructive feedback</p>
140
+ </li><li>
141
+ <p>Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience</p>
142
+ </li><li>
143
+ <p>Focusing on what is best not just for us as individuals, but for the overall community</p>
144
+ </li></ul>
145
+
146
+ <p>Examples of unacceptable behavior include:</p>
147
+ <ul><li>
148
+ <p>The use of sexualized language or imagery, and sexual attention or advances of any kind</p>
149
+ </li><li>
150
+ <p>Trolling, insulting or derogatory comments, and personal or political attacks</p>
151
+ </li><li>
152
+ <p>Public or private harassment</p>
153
+ </li><li>
154
+ <p>Publishing others’ private information, such as a physical or email address, without their explicit permission</p>
155
+ </li><li>
156
+ <p>Other conduct which could reasonably be considered inappropriate in a professional setting</p>
157
+ </li></ul>
158
+
159
+ <h2 id="label-Enforcement+Responsibilities">Enforcement Responsibilities<span><a href="#label-Enforcement+Responsibilities">&para;</a> <a href="#top">&uarr;</a></span></h2>
160
+
161
+ <p>Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.</p>
162
+
163
+ <p>Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.</p>
164
+
165
+ <h2 id="label-Scope">Scope<span><a href="#label-Scope">&para;</a> <a href="#top">&uarr;</a></span></h2>
166
+
167
+ <p>This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.</p>
168
+
169
+ <h2 id="label-Enforcement">Enforcement<span><a href="#label-Enforcement">&para;</a> <a href="#top">&uarr;</a></span></h2>
170
+
171
+ <p>Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at max@synthmax.dk. All complaints will be reviewed and investigated promptly and fairly.</p>
172
+
173
+ <p>All community leaders are obligated to respect the privacy and security of the reporter of any incident.</p>
174
+
175
+ <h2 id="label-Enforcement+Guidelines">Enforcement Guidelines<span><a href="#label-Enforcement+Guidelines">&para;</a> <a href="#top">&uarr;</a></span></h2>
176
+
177
+ <p>Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:</p>
178
+
179
+ <h3 id="label-1.+Correction">1. Correction<span><a href="#label-1.+Correction">&para;</a> <a href="#top">&uarr;</a></span></h3>
180
+
181
+ <p><strong>Community Impact</strong>: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.</p>
182
+
183
+ <p><strong>Consequence</strong>: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.</p>
184
+
185
+ <h3 id="label-2.+Warning">2. Warning<span><a href="#label-2.+Warning">&para;</a> <a href="#top">&uarr;</a></span></h3>
186
+
187
+ <p><strong>Community Impact</strong>: A violation through a single incident or series of actions.</p>
188
+
189
+ <p><strong>Consequence</strong>: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.</p>
190
+
191
+ <h3 id="label-3.+Temporary+Ban">3. Temporary Ban<span><a href="#label-3.+Temporary+Ban">&para;</a> <a href="#top">&uarr;</a></span></h3>
192
+
193
+ <p><strong>Community Impact</strong>: A serious violation of community standards, including sustained inappropriate behavior.</p>
194
+
195
+ <p><strong>Consequence</strong>: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.</p>
196
+
197
+ <h3 id="label-4.+Permanent+Ban">4. Permanent Ban<span><a href="#label-4.+Permanent+Ban">&para;</a> <a href="#top">&uarr;</a></span></h3>
198
+
199
+ <p><strong>Community Impact</strong>: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.</p>
200
+
201
+ <p><strong>Consequence</strong>: A permanent ban from any sort of public interaction within the community.</p>
202
+
203
+ <h2 id="label-Attribution">Attribution<span><a href="#label-Attribution">&para;</a> <a href="#top">&uarr;</a></span></h2>
204
+
205
+ <p>This Code of Conduct is adapted from the <a href="https://www.contributor-covenant.org">Contributor Covenant</a>, version 2.0, available at <a href="https://www.contributor-covenant.org/version/2/0/code_of_conduct.html">www.contributor-covenant.org/version/2/0/code_of_conduct.html</a>.</p>
206
+
207
+ <p>Community Impact Guidelines were inspired by <a href="https://github.com/mozilla/diversity">Mozilla’s code of conduct enforcement ladder</a>.</p>
208
+
209
+ <p>For answers to common questions about this code of conduct, see the FAQ at <a href="https://www.contributor-covenant.org/faq">www.contributor-covenant.org/faq</a>. Translations are available at <a href="https://www.contributor-covenant.org/translations">www.contributor-covenant.org/translations</a>.</p>
210
+
211
+ </main>
212
+
213
+
214
+
215
+ <footer id="validator-badges" role="contentinfo">
216
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
217
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
218
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
219
+ </footer>
220
+