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.
- checksums.yaml +4 -4
- data/.document +1 -0
- data/.nojekyll +1 -0
- data/.rubocop.yml +1 -1
- data/CHANGELOG.md +2 -0
- data/GETTING-STARTED.md +10 -10
- data/README.md +8 -5
- data/ROADMAP.md +9 -5
- data/doc/.nojekyll +1 -0
- data/doc/CHANGELOG_md.html +125 -0
- data/doc/CODE_OF_CONDUCT_md.html +220 -0
- data/doc/CONSIDERTIONS_md.html +227 -0
- data/doc/CreateLoggableActivities.html +144 -0
- data/doc/CreateLoggableEncryptionKeys.html +140 -0
- data/doc/CreateLoggablePayloads.html +144 -0
- data/doc/GETTING-STARTED_md.html +186 -0
- data/doc/Gemfile.html +104 -0
- data/doc/Gemfile_lock.html +152 -0
- data/doc/LICENSE_txt.html +104 -0
- data/doc/LoggableActivity/CurrentUser.html +99 -0
- data/doc/LoggableActivity/Generators/InstallGenerator.html +178 -0
- data/doc/LoggableActivity/Generators.html +91 -0
- data/doc/README_md.html +138 -0
- data/doc/ROADMAP_md.html +151 -0
- data/doc/Rakefile.html +102 -0
- data/doc/bin/setup.html +100 -0
- data/doc/notes/CHEAT_SHEET_md.html +130 -0
- data/doc/sig/loggable_activity_rbs.html +101 -0
- data/docs/LoggableActivity/Activity.html +494 -0
- data/docs/LoggableActivity/Configuration.html +183 -0
- data/docs/LoggableActivity/Encryption.html +220 -0
- data/docs/LoggableActivity/EncryptionError.html +99 -0
- data/docs/LoggableActivity/EncryptionKey.html +327 -0
- data/docs/LoggableActivity/Error.html +97 -0
- data/docs/LoggableActivity/Hooks.html +172 -0
- data/docs/LoggableActivity/Payload.html +159 -0
- data/docs/LoggableActivity/PayloadsBuilder.html +154 -0
- data/docs/LoggableActivity/UpdatePayloadsBuilder.html +199 -0
- data/docs/LoggableActivity.html +100 -0
- data/docs/created.rid +10 -0
- data/docs/css/fonts.css +167 -0
- data/docs/css/rdoc.css +687 -0
- data/docs/fonts/Lato-Light.ttf +0 -0
- data/docs/fonts/Lato-LightItalic.ttf +0 -0
- data/docs/fonts/Lato-Regular.ttf +0 -0
- data/docs/fonts/Lato-RegularItalic.ttf +0 -0
- data/docs/fonts/SourceCodePro-Bold.ttf +0 -0
- data/docs/fonts/SourceCodePro-Regular.ttf +0 -0
- data/docs/images/add.png +0 -0
- data/docs/images/arrow_up.png +0 -0
- data/docs/images/brick.png +0 -0
- data/docs/images/brick_link.png +0 -0
- data/docs/images/bug.png +0 -0
- data/docs/images/bullet_black.png +0 -0
- data/docs/images/bullet_toggle_minus.png +0 -0
- data/docs/images/bullet_toggle_plus.png +0 -0
- data/docs/images/date.png +0 -0
- data/docs/images/delete.png +0 -0
- data/docs/images/find.png +0 -0
- data/docs/images/loadingAnimation.gif +0 -0
- data/docs/images/macFFBgHack.png +0 -0
- data/docs/images/package.png +0 -0
- data/docs/images/page_green.png +0 -0
- data/docs/images/page_white_text.png +0 -0
- data/docs/images/page_white_width.png +0 -0
- data/docs/images/plugin.png +0 -0
- data/docs/images/ruby.png +0 -0
- data/docs/images/tag_blue.png +0 -0
- data/docs/images/tag_green.png +0 -0
- data/docs/images/transparent.png +0 -0
- data/docs/images/wrench.png +0 -0
- data/docs/images/wrench_orange.png +0 -0
- data/docs/images/zoom.png +0 -0
- data/docs/index.html +91 -0
- data/docs/js/darkfish.js +97 -0
- data/docs/js/navigation.js +105 -0
- data/docs/js/navigation.js.gz +0 -0
- data/docs/js/search.js +110 -0
- data/docs/js/search_index.js +1 -0
- data/docs/js/search_index.js.gz +0 -0
- data/docs/js/searcher.js +229 -0
- data/docs/js/searcher.js.gz +0 -0
- data/docs/table_of_contents.html +184 -0
- data/lib/generators/loggable_activity/install_generator.rb +2 -1
- data/lib/generators/loggable_activity/templates/current_user.rb +1 -1
- data/lib/generators/loggable_activity/templates/loggable_activity.yml +29 -0
- data/lib/loggable_activity/activity.rb +208 -59
- data/lib/loggable_activity/configuration.rb +18 -0
- data/lib/loggable_activity/encryption.rb +20 -1
- data/lib/loggable_activity/encryption_key.rb +81 -14
- data/lib/loggable_activity/hooks.rb +10 -7
- data/lib/loggable_activity/payload.rb +45 -11
- data/lib/loggable_activity/payloads_builder.rb +50 -4
- data/lib/loggable_activity/update_payloads_builder.rb +64 -2
- data/lib/loggable_activity/version.rb +1 -1
- metadata +82 -10
- data/.DS_Store +0 -0
- data/loggable_activity-0.1.32.gem +0 -0
- data/loggable_activity-0.1.33.gem +0 -0
- data/loggable_activity-0.1.34.gem +0 -0
@@ -0,0 +1,178 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta charset="UTF-8">
|
6
|
+
|
7
|
+
<title>class LoggableActivity::Generators::InstallGenerator - 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="class">
|
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
|
+
|
58
|
+
<div id="class-metadata">
|
59
|
+
|
60
|
+
|
61
|
+
<div id="parent-class-section" class="nav-section">
|
62
|
+
<h3>Parent</h3>
|
63
|
+
|
64
|
+
<p class="link">Rails::Generators::NamedBase
|
65
|
+
</div>
|
66
|
+
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
<!-- Method Quickref -->
|
71
|
+
<div id="method-list-section" class="nav-section">
|
72
|
+
<h3>Methods</h3>
|
73
|
+
|
74
|
+
<ul class="link-list" role="directory">
|
75
|
+
<li ><a href="#method-i-create_migration">#create_migration</a>
|
76
|
+
<li ><a href="#method-i-create_model_file">#create_model_file</a>
|
77
|
+
</ul>
|
78
|
+
</div>
|
79
|
+
|
80
|
+
</div>
|
81
|
+
</nav>
|
82
|
+
|
83
|
+
<main role="main" aria-labelledby="class-LoggableActivity::Generators::InstallGenerator">
|
84
|
+
<h1 id="class-LoggableActivity::Generators::InstallGenerator" class="class">
|
85
|
+
class LoggableActivity::Generators::InstallGenerator
|
86
|
+
</h1>
|
87
|
+
|
88
|
+
<section class="description">
|
89
|
+
|
90
|
+
</section>
|
91
|
+
|
92
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
93
|
+
|
94
|
+
|
95
|
+
<section class="constants-list">
|
96
|
+
<header>
|
97
|
+
<h3>Constants</h3>
|
98
|
+
</header>
|
99
|
+
<dl>
|
100
|
+
<dt id="FILE_NAMES">FILE_NAMES
|
101
|
+
<dd>
|
102
|
+
<dt id="TIME">TIME
|
103
|
+
<dd>
|
104
|
+
</dl>
|
105
|
+
</section>
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
110
|
+
<header>
|
111
|
+
<h3>Public Instance Methods</h3>
|
112
|
+
</header>
|
113
|
+
|
114
|
+
<div id="method-i-create_migration" class="method-detail ">
|
115
|
+
<div class="method-header">
|
116
|
+
<div class="method-heading">
|
117
|
+
<span class="method-name">create_migration</span><span
|
118
|
+
class="method-args">()</span>
|
119
|
+
<span class="method-click-advice">click to toggle source</span>
|
120
|
+
</div>
|
121
|
+
</div>
|
122
|
+
|
123
|
+
<div class="method-description">
|
124
|
+
|
125
|
+
|
126
|
+
<div class="method-source-code" id="create_migration-source">
|
127
|
+
<pre><span class="ruby-comment"># File lib/generators/loggable_activity/install_generator.rb, line 14</span>
|
128
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_migration</span>
|
129
|
+
<span class="ruby-identifier">time</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">utc</span>
|
130
|
+
<span class="ruby-constant">FILE_NAMES</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file_name</span>, <span class="ruby-identifier">index</span><span class="ruby-operator">|</span>
|
131
|
+
<span class="ruby-identifier">timestamp</span> = (<span class="ruby-identifier">time</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">index</span>.<span class="ruby-identifier">minutes</span>).<span class="ruby-identifier">strftime</span>(<span class="ruby-string">'%Y%m%d%H%M%S'</span>)
|
132
|
+
<span class="ruby-identifier">migration_file_name</span> = <span class="ruby-node">"create_loggable_#{file_name.pluralize}.rb"</span>
|
133
|
+
<span class="ruby-identifier">destination</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'db'</span>, <span class="ruby-string">'migrate'</span>, <span class="ruby-node">"#{timestamp}_#{migration_file_name}"</span>)
|
134
|
+
<span class="ruby-identifier">template</span> <span class="ruby-identifier">migration_file_name</span>, <span class="ruby-identifier">destination</span>
|
135
|
+
<span class="ruby-keyword">end</span>
|
136
|
+
<span class="ruby-keyword">end</span></pre>
|
137
|
+
</div>
|
138
|
+
</div>
|
139
|
+
|
140
|
+
|
141
|
+
</div>
|
142
|
+
|
143
|
+
<div id="method-i-create_model_file" class="method-detail ">
|
144
|
+
<div class="method-header">
|
145
|
+
<div class="method-heading">
|
146
|
+
<span class="method-name">create_model_file</span><span
|
147
|
+
class="method-args">()</span>
|
148
|
+
<span class="method-click-advice">click to toggle source</span>
|
149
|
+
</div>
|
150
|
+
</div>
|
151
|
+
|
152
|
+
<div class="method-description">
|
153
|
+
|
154
|
+
|
155
|
+
<div class="method-source-code" id="create_model_file-source">
|
156
|
+
<pre><span class="ruby-comment"># File lib/generators/loggable_activity/install_generator.rb, line 24</span>
|
157
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_model_file</span>
|
158
|
+
<span class="ruby-identifier">template</span> <span class="ruby-string">'loggable_activity.en.yml'</span>, <span class="ruby-string">'config/locales/loggable_activity.en.yml'</span>
|
159
|
+
<span class="ruby-identifier">template</span> <span class="ruby-string">"current_user.rb"</span>, <span class="ruby-string">'app/controllers/concerns/loggable_activity/current_user.rb'</span>
|
160
|
+
<span class="ruby-keyword">end</span></pre>
|
161
|
+
</div>
|
162
|
+
</div>
|
163
|
+
|
164
|
+
|
165
|
+
</div>
|
166
|
+
|
167
|
+
</section>
|
168
|
+
|
169
|
+
</section>
|
170
|
+
</main>
|
171
|
+
|
172
|
+
|
173
|
+
<footer id="validator-badges" role="contentinfo">
|
174
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
175
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
|
176
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
177
|
+
</footer>
|
178
|
+
|
@@ -0,0 +1,91 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta charset="UTF-8">
|
6
|
+
|
7
|
+
<title>module LoggableActivity::Generators - 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="module">
|
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
|
+
|
58
|
+
<div id="class-metadata">
|
59
|
+
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
|
64
|
+
</div>
|
65
|
+
</nav>
|
66
|
+
|
67
|
+
<main role="main" aria-labelledby="module-LoggableActivity::Generators">
|
68
|
+
<h1 id="module-LoggableActivity::Generators" class="module">
|
69
|
+
module LoggableActivity::Generators
|
70
|
+
</h1>
|
71
|
+
|
72
|
+
<section class="description">
|
73
|
+
|
74
|
+
</section>
|
75
|
+
|
76
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
77
|
+
|
78
|
+
|
79
|
+
|
80
|
+
|
81
|
+
|
82
|
+
</section>
|
83
|
+
</main>
|
84
|
+
|
85
|
+
|
86
|
+
<footer id="validator-badges" role="contentinfo">
|
87
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
88
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
|
89
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
90
|
+
</footer>
|
91
|
+
|
data/doc/README_md.html
ADDED
@@ -0,0 +1,138 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta charset="UTF-8">
|
6
|
+
|
7
|
+
<title>README - 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-Loggable+Activity+-F0-9F-8C-9F">Loggable Activity 🌟</a>
|
66
|
+
</summary>
|
67
|
+
<ul class="link-list" role="directory">
|
68
|
+
<li> <a href="#label-What+it+is+not">What it is not</a>
|
69
|
+
<li> <a href="#label-Applications">Applications</a>
|
70
|
+
|
71
|
+
</ul>
|
72
|
+
</details>
|
73
|
+
</li>
|
74
|
+
|
75
|
+
</ul>
|
76
|
+
</div>
|
77
|
+
|
78
|
+
|
79
|
+
<div id="project-metadata">
|
80
|
+
|
81
|
+
<div id="fileindex-section" class="nav-section">
|
82
|
+
<h3>Pages</h3>
|
83
|
+
|
84
|
+
<ul class="link-list">
|
85
|
+
<li><a href="./CHANGELOG_md.html">CHANGELOG</a>
|
86
|
+
<li><a href="./CODE_OF_CONDUCT_md.html">CODE_OF_CONDUCT</a>
|
87
|
+
<li><a href="./CONSIDERTIONS_md.html">CONSIDERTIONS</a>
|
88
|
+
<li><a href="./GETTING-STARTED_md.html">GETTING-STARTED</a>
|
89
|
+
<li><a href="./Gemfile.html">Gemfile</a>
|
90
|
+
<li><a href="./Gemfile_lock.html">Gemfile.lock</a>
|
91
|
+
<li><a href="./LICENSE_txt.html">LICENSE</a>
|
92
|
+
<li><a href="./README_md.html">README</a>
|
93
|
+
<li><a href="./ROADMAP_md.html">ROADMAP</a>
|
94
|
+
<li><a href="./Rakefile.html">Rakefile</a>
|
95
|
+
<li><a href="./bin/setup.html">setup</a>
|
96
|
+
<li><a href="./notes/CHEAT_SHEET_md.html">CHEAT_SHEET</a>
|
97
|
+
<li><a href="./sig/loggable_activity_rbs.html">loggable_activity.rbs</a>
|
98
|
+
</ul>
|
99
|
+
</div>
|
100
|
+
|
101
|
+
</div>
|
102
|
+
</nav>
|
103
|
+
|
104
|
+
<main role="main" aria-label="Page README.md">
|
105
|
+
|
106
|
+
<h1 id="label-Loggable+Activity+-F0-9F-8C-9F">Loggable Activity 🌟<span><a href="#label-Loggable+Activity+-F0-9F-8C-9F">¶</a> <a href="#top">↑</a></span></h1>
|
107
|
+
|
108
|
+
<p>Secure protect data and log how it is handled - Keep an activity log of how data in the db are handled. - Protect and secure the privacy of data stored in Activity Logs - Prepare for General Data Protection Regulation (GDPR) compliance. - Handles activities that involves more than one table in the DB.</p>
|
109
|
+
|
110
|
+
<h3 id="label-What+it+is+not">What it is not<span><a href="#label-What+it+is+not">¶</a> <a href="#top">↑</a></span></h3>
|
111
|
+
<ul><li>
|
112
|
+
<p>An error logging system</p>
|
113
|
+
</li><li>
|
114
|
+
<p>A paper trails system with rollback.</p>
|
115
|
+
</li><li>
|
116
|
+
<p>A backup system</p>
|
117
|
+
</li></ul>
|
118
|
+
|
119
|
+
<h3 id="label-Applications">Applications<span><a href="#label-Applications">¶</a> <a href="#top">↑</a></span></h3>
|
120
|
+
|
121
|
+
<p>Most organizations needs to keep a log of how users interact with data stored in the DB - Finance - Healthcare - Sales and Support</p>
|
122
|
+
|
123
|
+
<p><em>Super simplified example from the healthcare.</em> - Each patient has a journal, that is updated on a regular basis. - Supervisor needs to follow the journal, how was it updated, who read it. - Security personnel needs to know how the journal is handled, who did what when. - Patients has the right to know how their journal is handled and that the log is deleted.</p>
|
124
|
+
|
125
|
+
<p>Beside the journal in the db, an activity log is kept so it is possible to track how the journal is used.<br/> At some point in time the patients data from the DB and the activity log has to be removed according to GDPR.<br/></p>
|
126
|
+
|
127
|
+
<p>👉 Join the Slack channel here: <a href="https://join.slack.com/t/loggableactivity/shared_invite/zt-2a3tvgv37-mGwjHJTrBXBH2srXFRRSXQ">LoggableActivity Slack Workspace</a> <br/>👉 Want to play around with an online version: <a href="https://loggableactivity-efe7b931c886.herokuapp.com/">Show Demo</a> <br/> We value each contribution and believe in the power of community. Looking forward to seeing you there!</p>
|
128
|
+
|
129
|
+
</main>
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
<footer id="validator-badges" role="contentinfo">
|
134
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
135
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
|
136
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
137
|
+
</footer>
|
138
|
+
|
data/doc/ROADMAP_md.html
ADDED
@@ -0,0 +1,151 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta charset="UTF-8">
|
6
|
+
|
7
|
+
<title>ROADMAP - 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-Roadmap">Roadmap</a>
|
66
|
+
</summary>
|
67
|
+
<ul class="link-list" role="directory">
|
68
|
+
<li> <a href="#label-Demo+project">Demo project</a>
|
69
|
+
<li> <a href="#label-Open+Source">Open Source</a>
|
70
|
+
<li> <a href="#label-Investigations">Investigations</a>
|
71
|
+
|
72
|
+
</ul>
|
73
|
+
</details>
|
74
|
+
</li>
|
75
|
+
|
76
|
+
</ul>
|
77
|
+
</div>
|
78
|
+
|
79
|
+
|
80
|
+
<div id="project-metadata">
|
81
|
+
|
82
|
+
<div id="fileindex-section" class="nav-section">
|
83
|
+
<h3>Pages</h3>
|
84
|
+
|
85
|
+
<ul class="link-list">
|
86
|
+
<li><a href="./CHANGELOG_md.html">CHANGELOG</a>
|
87
|
+
<li><a href="./CODE_OF_CONDUCT_md.html">CODE_OF_CONDUCT</a>
|
88
|
+
<li><a href="./CONSIDERTIONS_md.html">CONSIDERTIONS</a>
|
89
|
+
<li><a href="./GETTING-STARTED_md.html">GETTING-STARTED</a>
|
90
|
+
<li><a href="./Gemfile.html">Gemfile</a>
|
91
|
+
<li><a href="./Gemfile_lock.html">Gemfile.lock</a>
|
92
|
+
<li><a href="./LICENSE_txt.html">LICENSE</a>
|
93
|
+
<li><a href="./README_md.html">README</a>
|
94
|
+
<li><a href="./ROADMAP_md.html">ROADMAP</a>
|
95
|
+
<li><a href="./Rakefile.html">Rakefile</a>
|
96
|
+
<li><a href="./bin/setup.html">setup</a>
|
97
|
+
<li><a href="./notes/CHEAT_SHEET_md.html">CHEAT_SHEET</a>
|
98
|
+
<li><a href="./sig/loggable_activity_rbs.html">loggable_activity.rbs</a>
|
99
|
+
</ul>
|
100
|
+
</div>
|
101
|
+
|
102
|
+
</div>
|
103
|
+
</nav>
|
104
|
+
|
105
|
+
<main role="main" aria-label="Page ROADMAP.md">
|
106
|
+
|
107
|
+
<h1 id="label-Roadmap">Roadmap<span><a href="#label-Roadmap">¶</a> <a href="#top">↑</a></span></h1>
|
108
|
+
|
109
|
+
<p>Outline of steps to get the <a href="LoggableActivity.html"><code>LoggableActivity</code></a> adapted.</p>
|
110
|
+
|
111
|
+
<h3 id="label-Demo+project">Demo project<span><a href="#label-Demo+project">¶</a> <a href="#top">↑</a></span></h3>
|
112
|
+
|
113
|
+
<p>Nothing is better than gain som experience by getting som real world tests and experiences. <br/> Try the <a href=""https://loggableactivity-efe7b931c886.herokuapp.com/"">Live Demo</a> here or download it from <a href=""https://github.com/maxgronlund/LoggableActivityDemoApp"">Github</a> here</p>
|
114
|
+
|
115
|
+
<h3 id="label-Open+Source">Open Source<span><a href="#label-Open+Source">¶</a> <a href="#top">↑</a></span></h3>
|
116
|
+
|
117
|
+
<p>More eyes and brains on the project wil make it mature and better.</p>
|
118
|
+
|
119
|
+
<h3 id="label-Investigations">Investigations<span><a href="#label-Investigations">¶</a> <a href="#top">↑</a></span></h3>
|
120
|
+
<ul><li>
|
121
|
+
<p>Does there exists a protocol for activity logging</p>
|
122
|
+
</li><li>
|
123
|
+
<p>Will a bigger company like platformatec sponsor the project</p>
|
124
|
+
</li><li>
|
125
|
+
<p>Legal approval, official, medical approval.</p>
|
126
|
+
</li><li>
|
127
|
+
<p>RFC for protocol</p>
|
128
|
+
</li><li>
|
129
|
+
<p>Commercial potentials, business models.</p>
|
130
|
+
</li><li>
|
131
|
+
<p>Explainers</p>
|
132
|
+
</li><li>
|
133
|
+
<p>Documentation RDoc</p>
|
134
|
+
</li><li>
|
135
|
+
<p>Rest API</p>
|
136
|
+
</li><li>
|
137
|
+
<p>GraphQL API</p>
|
138
|
+
</li><li>
|
139
|
+
<p>Integration with other languages, node, elixir…</p>
|
140
|
+
</li></ul>
|
141
|
+
|
142
|
+
</main>
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
<footer id="validator-badges" role="contentinfo">
|
147
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
148
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
|
149
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
150
|
+
</footer>
|
151
|
+
|
data/doc/Rakefile.html
ADDED
@@ -0,0 +1,102 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta charset="UTF-8">
|
6
|
+
|
7
|
+
<title>Rakefile - 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
|
+
|
58
|
+
<div id="project-metadata">
|
59
|
+
|
60
|
+
<div id="fileindex-section" class="nav-section">
|
61
|
+
<h3>Pages</h3>
|
62
|
+
|
63
|
+
<ul class="link-list">
|
64
|
+
<li><a href="./CHANGELOG_md.html">CHANGELOG</a>
|
65
|
+
<li><a href="./CODE_OF_CONDUCT_md.html">CODE_OF_CONDUCT</a>
|
66
|
+
<li><a href="./CONSIDERTIONS_md.html">CONSIDERTIONS</a>
|
67
|
+
<li><a href="./GETTING-STARTED_md.html">GETTING-STARTED</a>
|
68
|
+
<li><a href="./Gemfile.html">Gemfile</a>
|
69
|
+
<li><a href="./Gemfile_lock.html">Gemfile.lock</a>
|
70
|
+
<li><a href="./LICENSE_txt.html">LICENSE</a>
|
71
|
+
<li><a href="./README_md.html">README</a>
|
72
|
+
<li><a href="./ROADMAP_md.html">ROADMAP</a>
|
73
|
+
<li><a href="./Rakefile.html">Rakefile</a>
|
74
|
+
<li><a href="./bin/setup.html">setup</a>
|
75
|
+
<li><a href="./notes/CHEAT_SHEET_md.html">CHEAT_SHEET</a>
|
76
|
+
<li><a href="./sig/loggable_activity_rbs.html">loggable_activity.rbs</a>
|
77
|
+
</ul>
|
78
|
+
</div>
|
79
|
+
|
80
|
+
</div>
|
81
|
+
</nav>
|
82
|
+
|
83
|
+
<main role="main" aria-label="Page Rakefile">
|
84
|
+
|
85
|
+
<p># frozen_string_literal: true</p>
|
86
|
+
|
87
|
+
<p>require ‘bundler/gem_tasks’ require ‘rspec/core/rake_task’</p>
|
88
|
+
|
89
|
+
<p>RSpec::Core::RakeTask.new(:spec)</p>
|
90
|
+
|
91
|
+
<p>task default: :spec</p>
|
92
|
+
|
93
|
+
</main>
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
<footer id="validator-badges" role="contentinfo">
|
98
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
99
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
|
100
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
101
|
+
</footer>
|
102
|
+
|