ruby-grafana-reporter 0.1.6 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +0 -0
  3. data/README.md +95 -173
  4. data/bin/ruby-grafana-reporter +5 -0
  5. data/lib/VERSION.rb +5 -3
  6. data/lib/grafana/abstract_panel_query.rb +22 -20
  7. data/lib/grafana/abstract_query.rb +132 -127
  8. data/lib/grafana/abstract_sql_query.rb +51 -42
  9. data/lib/grafana/dashboard.rb +77 -66
  10. data/lib/grafana/errors.rb +66 -61
  11. data/lib/grafana/grafana.rb +133 -131
  12. data/lib/grafana/panel.rb +41 -39
  13. data/lib/grafana/panel_image_query.rb +52 -49
  14. data/lib/grafana/variable.rb +217 -259
  15. data/lib/grafana_reporter/abstract_report.rb +112 -109
  16. data/lib/grafana_reporter/application/application.rb +158 -229
  17. data/lib/grafana_reporter/application/errors.rb +33 -30
  18. data/lib/grafana_reporter/application/webservice.rb +230 -0
  19. data/lib/grafana_reporter/asciidoctor/alerts_table_query.rb +101 -99
  20. data/lib/grafana_reporter/asciidoctor/annotations_table_query.rb +96 -96
  21. data/lib/grafana_reporter/asciidoctor/errors.rb +40 -37
  22. data/lib/grafana_reporter/asciidoctor/extensions/alerts_table_include_processor.rb +92 -86
  23. data/lib/grafana_reporter/asciidoctor/extensions/annotations_table_include_processor.rb +91 -86
  24. data/lib/grafana_reporter/asciidoctor/extensions/panel_image_block_macro.rb +69 -67
  25. data/lib/grafana_reporter/asciidoctor/extensions/panel_image_inline_macro.rb +68 -65
  26. data/lib/grafana_reporter/asciidoctor/extensions/panel_property_inline_macro.rb +61 -58
  27. data/lib/grafana_reporter/asciidoctor/extensions/panel_query_table_include_processor.rb +78 -75
  28. data/lib/grafana_reporter/asciidoctor/extensions/panel_query_value_inline_macro.rb +73 -70
  29. data/lib/grafana_reporter/asciidoctor/extensions/processor_mixin.rb +20 -18
  30. data/lib/grafana_reporter/asciidoctor/extensions/show_environment_include_processor.rb +43 -41
  31. data/lib/grafana_reporter/asciidoctor/extensions/show_help_include_processor.rb +30 -202
  32. data/lib/grafana_reporter/asciidoctor/extensions/sql_table_include_processor.rb +70 -67
  33. data/lib/grafana_reporter/asciidoctor/extensions/sql_value_inline_macro.rb +66 -65
  34. data/lib/grafana_reporter/asciidoctor/extensions/value_as_variable_include_processor.rb +88 -57
  35. data/lib/grafana_reporter/asciidoctor/help.rb +435 -0
  36. data/lib/grafana_reporter/asciidoctor/panel_first_value_query.rb +36 -32
  37. data/lib/grafana_reporter/asciidoctor/panel_image_query.rb +28 -23
  38. data/lib/grafana_reporter/asciidoctor/panel_property_query.rb +44 -43
  39. data/lib/grafana_reporter/asciidoctor/panel_table_query.rb +40 -36
  40. data/lib/grafana_reporter/asciidoctor/query_mixin.rb +312 -309
  41. data/lib/grafana_reporter/asciidoctor/report.rb +179 -159
  42. data/lib/grafana_reporter/asciidoctor/sql_first_value_query.rb +42 -34
  43. data/lib/grafana_reporter/asciidoctor/sql_table_query.rb +44 -32
  44. data/lib/grafana_reporter/configuration.rb +304 -326
  45. data/lib/grafana_reporter/console_configuration_wizard.rb +269 -0
  46. data/lib/grafana_reporter/errors.rb +48 -38
  47. data/lib/grafana_reporter/logger/two_way_logger.rb +58 -52
  48. data/lib/ruby-grafana-reporter.rb +32 -27
  49. metadata +116 -16
data/lib/ruby-grafana-reporter.rb CHANGED
@@ -1,27 +1,32 @@
1
- require 'net/http'
2
- require 'fileutils'
3
- require 'yaml'
4
- require 'socket'
5
- require 'uri'
6
- require 'json'
7
- require 'tempfile'
8
- require 'cgi'
9
- require 'optparse'
10
- require 'date'
11
- require 'time'
12
- require 'logger'
13
- require 'asciidoctor'
14
- require 'asciidoctor/extensions'
15
- require 'asciidoctor-pdf'
16
- require 'zip'
17
- require_relative 'VERSION.rb'
18
-
19
- folders = [
20
- %w[grafana],
21
- %w[grafana_reporter logger],
22
- %w[grafana_reporter],
23
- %w[grafana_reporter asciidoctor extensions],
24
- %w[grafana_reporter asciidoctor],
25
- %w[grafana_reporter application]
26
- ]
27
- folders.each { |folder| Dir[File.join(__dir__, *folder, '*.rb')].sort.each { |file| require_relative file } }
1
+ # frozen_string_literal: true
2
+
3
+ require 'net/http'
4
+ require 'fileutils'
5
+ require 'yaml'
6
+ require 'socket'
7
+ require 'uri'
8
+ require 'json'
9
+ require 'tempfile'
10
+ require 'cgi'
11
+ require 'optparse'
12
+ require 'date'
13
+ require 'time'
14
+ require 'logger'
15
+ require 'asciidoctor'
16
+ require 'asciidoctor/extensions'
17
+ require 'asciidoctor-pdf'
18
+ require 'zip'
19
+ require_relative 'VERSION'
20
+
21
+ # TODO: automatically build a template based on configured grafana dashboard
22
+ # TODO: add an sample report to github from grafana play (if permitted)
23
+
24
+ folders = [
25
+ %w[grafana],
26
+ %w[grafana_reporter logger],
27
+ %w[grafana_reporter],
28
+ %w[grafana_reporter asciidoctor extensions],
29
+ %w[grafana_reporter asciidoctor],
30
+ %w[grafana_reporter application]
31
+ ]
32
+ folders.each { |folder| Dir[File.join(__dir__, *folder, '*.rb')].sort.each { |file| require_relative file } }
metadata CHANGED
@@ -1,23 +1,116 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ruby-grafana-reporter
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.6
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Christian Kohlmeyer
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-10-19 00:00:00.000000000 Z
12
- dependencies: []
13
- description: |-
14
- The reporter provides a full extension setup for the famous Asciidoctor and can perfectly integrate in a docker environment. It can be used as to convert single documents or run as a service.
15
-
16
- As a result of the reporter, you receive PDF documents or any other format that is supported by Asciidoctor.
11
+ date: 2021-03-02 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: asciidoctor
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: asciidoctor-pdf
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.5'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.5'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rubyzip
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">"
46
+ - !ruby/object:Gem::Version
47
+ version: 1.1.1
48
+ - - "<"
49
+ - !ruby/object:Gem::Version
50
+ version: '2.4'
51
+ type: :runtime
52
+ prerelease: false
53
+ version_requirements: !ruby/object:Gem::Requirement
54
+ requirements:
55
+ - - ">"
56
+ - !ruby/object:Gem::Version
57
+ version: 1.1.1
58
+ - - "<"
59
+ - !ruby/object:Gem::Version
60
+ version: '2.4'
61
+ - !ruby/object:Gem::Dependency
62
+ name: rspec
63
+ requirement: !ruby/object:Gem::Requirement
64
+ requirements:
65
+ - - "~>"
66
+ - !ruby/object:Gem::Version
67
+ version: '3.9'
68
+ type: :development
69
+ prerelease: false
70
+ version_requirements: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - "~>"
73
+ - !ruby/object:Gem::Version
74
+ version: '3.9'
75
+ - !ruby/object:Gem::Dependency
76
+ name: simplecov
77
+ requirement: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - "~>"
80
+ - !ruby/object:Gem::Version
81
+ version: '0.16'
82
+ type: :development
83
+ prerelease: false
84
+ version_requirements: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - "~>"
87
+ - !ruby/object:Gem::Version
88
+ version: '0.16'
89
+ - !ruby/object:Gem::Dependency
90
+ name: webmock
91
+ requirement: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - "~>"
94
+ - !ruby/object:Gem::Version
95
+ version: '3.9'
96
+ type: :development
97
+ prerelease: false
98
+ version_requirements: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - "~>"
101
+ - !ruby/object:Gem::Version
102
+ version: '3.9'
103
+ description: Provides a standalone and a webservice frontend for creating reports
104
+ based on asciidoctor, including interfaces to integrate dynamic content captured
105
+ from grafana.By default the reports will be converted to PDF documents, whereas
106
+ other target formats can be used as well.
17
107
  email: kohly@gmx.de
18
- executables: []
108
+ executables:
109
+ - ruby-grafana-reporter
19
110
  extensions: []
20
- extra_rdoc_files: []
111
+ extra_rdoc_files:
112
+ - README.md
113
+ - LICENSE
21
114
  files:
22
115
  - "./lib/VERSION.rb"
23
116
  - "./lib/grafana/abstract_panel_query.rb"
@@ -32,6 +125,7 @@ files:
32
125
  - "./lib/grafana_reporter/abstract_report.rb"
33
126
  - "./lib/grafana_reporter/application/application.rb"
34
127
  - "./lib/grafana_reporter/application/errors.rb"
128
+ - "./lib/grafana_reporter/application/webservice.rb"
35
129
  - "./lib/grafana_reporter/asciidoctor/alerts_table_query.rb"
36
130
  - "./lib/grafana_reporter/asciidoctor/annotations_table_query.rb"
37
131
  - "./lib/grafana_reporter/asciidoctor/errors.rb"
@@ -48,6 +142,7 @@ files:
48
142
  - "./lib/grafana_reporter/asciidoctor/extensions/sql_table_include_processor.rb"
49
143
  - "./lib/grafana_reporter/asciidoctor/extensions/sql_value_inline_macro.rb"
50
144
  - "./lib/grafana_reporter/asciidoctor/extensions/value_as_variable_include_processor.rb"
145
+ - "./lib/grafana_reporter/asciidoctor/help.rb"
51
146
  - "./lib/grafana_reporter/asciidoctor/panel_first_value_query.rb"
52
147
  - "./lib/grafana_reporter/asciidoctor/panel_image_query.rb"
53
148
  - "./lib/grafana_reporter/asciidoctor/panel_property_query.rb"
@@ -57,16 +152,20 @@ files:
57
152
  - "./lib/grafana_reporter/asciidoctor/sql_first_value_query.rb"
58
153
  - "./lib/grafana_reporter/asciidoctor/sql_table_query.rb"
59
154
  - "./lib/grafana_reporter/configuration.rb"
155
+ - "./lib/grafana_reporter/console_configuration_wizard.rb"
60
156
  - "./lib/grafana_reporter/errors.rb"
61
157
  - "./lib/grafana_reporter/logger/two_way_logger.rb"
62
158
  - "./lib/ruby-grafana-reporter.rb"
63
159
  - LICENSE
64
160
  - README.md
161
+ - bin/ruby-grafana-reporter
65
162
  homepage: https://github.com/divinity666/ruby-grafana-reporter
66
163
  licenses:
67
164
  - MIT
68
- metadata: {}
69
- post_install_message:
165
+ metadata:
166
+ source_code_uri: https://github.com/divinity666/ruby-grafana-reporter
167
+ bug_tracker_uri: https://github.com/divinity666/ruby-grafana-reporter/issues
168
+ post_install_message:
70
169
  rdoc_options: []
71
170
  require_paths:
72
171
  - lib
@@ -74,15 +173,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
74
173
  requirements:
75
174
  - - ">="
76
175
  - !ruby/object:Gem::Version
77
- version: '0'
176
+ version: 2.3.3
78
177
  required_rubygems_version: !ruby/object:Gem::Requirement
79
178
  requirements:
80
179
  - - ">="
81
180
  - !ruby/object:Gem::Version
82
181
  version: '0'
83
182
  requirements: []
84
- rubygems_version: 3.1.4
85
- signing_key:
183
+ rubyforge_project:
184
+ rubygems_version: 2.7.6.2
185
+ signing_key:
86
186
  specification_version: 4
87
- summary: "(Asciidoctor) Reporter Service for Grafana"
187
+ summary: Reporter Service for Grafana
88
188
  test_files: []