bnb_blazer 0.11.0 → 0.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +17 -1
- data/app/assets/stylesheets/bnb_blazer/application.scss +1 -0
- data/app/views/blazer/queries/docs.html.erb +137 -0
- data/lib/bnb_blazer/version.rb +1 -1
- metadata +11 -10
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1f0007c4702b90310bd9f40da25359bc7ab6743176964c8e146bf1b4b3b2c94e
|
|
4
|
+
data.tar.gz: 5f07fb6dc71acd498b8ce5e1a48b56d7f20a8c1f5b874c0825ced795662b104f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 559eebae7f25017e2e09954bbaa5d2a485be2e8c65a6af2da3d85c0f441a30035a0b2dca72a737d48e94ba719c7d0026a3449e06c020d99134c9ac28a7b44997
|
|
7
|
+
data.tar.gz: 36a1f645277257368b26b330632b73cfc2faae1f70985e1574cfb15e6a784c934da0faa6ae7c2aea35faf1d9953e74b784ec7c0e8b82f90cc63b29da77cc8f7c
|
data/README.md
CHANGED
|
@@ -15,8 +15,23 @@ gem "bnb_blazer"
|
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
And then execute:
|
|
18
|
+
```
|
|
19
|
+
dip bundle install
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Follow the [Blazer installation instructions](https://github.com/ankane/blazer#installation) to configure the gem and add any custom configuration, _except_ you don't need to add `gem "blazer"`, since that's a dependency of this gem. At minimum, you will need to run:
|
|
18
23
|
|
|
19
|
-
|
|
24
|
+
```
|
|
25
|
+
dip rails generate blazer:install
|
|
26
|
+
dip rails db:migrate
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
And mount the dashboard in your config/routes.rb:
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
mount Blazer::Engine, at: "blazer"
|
|
33
|
+
```
|
|
34
|
+
And specify your `BLAZER_DATABASE_URL`
|
|
20
35
|
|
|
21
36
|
## Development
|
|
22
37
|
|
|
@@ -26,6 +41,7 @@ This gem comes bundled with a test app to help you test out new display designs
|
|
|
26
41
|
2. Make sure you have [Dip](https://github.com/brandnewbox/bnb-dip-defaults) installed and configured
|
|
27
42
|
3. Run `dip setup`
|
|
28
43
|
4. In your new `bnb_blazer` directory, run `docker-compose up`
|
|
44
|
+
5. Uncomment the `mount Blazer::Engine, at: "/blazer"` line in your `config/routes.rb` file.
|
|
29
45
|
5. Navigate to http://localhost:3000/blazer in your browser, and away you go!
|
|
30
46
|
|
|
31
47
|
For the work of actually overriding the gem, Rails will load any view that we have defined in the `app/views` (not `spec/dummy/app/views`) folder before looking for them in the blazer gem. So any view that we want to override or restyle you just have to create at the same location as it would be found in the blazer gem. E.g. the homepage view for blazer is found at `app/views/blazer/queries/home.html.erb`, so if we want to override what the homepage looks like in our gem then we create a new view at `app/views/blazer/queries/home.html.erb` and copy the existing HTML from the gem and make modifications as necessary.
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
<% blazer_title "Docs: #{@data_source.name}" %>
|
|
2
|
+
|
|
3
|
+
<h1>Docs: <%= @data_source.name %></h1>
|
|
4
|
+
|
|
5
|
+
<hr />
|
|
6
|
+
|
|
7
|
+
<h2>Smart Variables</h2>
|
|
8
|
+
|
|
9
|
+
<% if @smart_variables.any? %>
|
|
10
|
+
<p>Use these variable names to get a dropdown of values.</p>
|
|
11
|
+
|
|
12
|
+
<table class="table" style="max-width: 500px;">
|
|
13
|
+
<thead>
|
|
14
|
+
<tr>
|
|
15
|
+
<th>Variable</th>
|
|
16
|
+
</tr>
|
|
17
|
+
</thead>
|
|
18
|
+
<tbody>
|
|
19
|
+
<% @smart_variables.each do |k, _| %>
|
|
20
|
+
<tr>
|
|
21
|
+
<td><code>{<%= k %>}</code></td>
|
|
22
|
+
</tr>
|
|
23
|
+
<% end %>
|
|
24
|
+
</tbody>
|
|
25
|
+
</table>
|
|
26
|
+
|
|
27
|
+
<p>Use <code>{start_time}</code> and <code>{end_time}</code> for a date range selector. End a variable name with <code>_at</code> for a date selector.</p>
|
|
28
|
+
<% else %>
|
|
29
|
+
<p>None set</p>
|
|
30
|
+
<% end %>
|
|
31
|
+
|
|
32
|
+
<h2>Linked Columns</h2>
|
|
33
|
+
|
|
34
|
+
<% if @linked_columns.any? %>
|
|
35
|
+
<p>Use these column names to link results to other pages.</p>
|
|
36
|
+
|
|
37
|
+
<table class="table" style="max-width: 500px;">
|
|
38
|
+
<thead>
|
|
39
|
+
<tr>
|
|
40
|
+
<th style="width: 20%;">Name</th>
|
|
41
|
+
<th>URL</th>
|
|
42
|
+
</tr>
|
|
43
|
+
</thead>
|
|
44
|
+
<tbody>
|
|
45
|
+
<% @linked_columns.each do |k, v| %>
|
|
46
|
+
<tr>
|
|
47
|
+
<td><%= k %></td>
|
|
48
|
+
<td><%= v %></td>
|
|
49
|
+
</tr>
|
|
50
|
+
<% end %>
|
|
51
|
+
</tbody>
|
|
52
|
+
</table>
|
|
53
|
+
|
|
54
|
+
<p>Values that match the format of a URL will be linked automatically.</p>
|
|
55
|
+
<% else %>
|
|
56
|
+
<p>None set</p>
|
|
57
|
+
<% end %>
|
|
58
|
+
|
|
59
|
+
<h2>Smart Columns</h2>
|
|
60
|
+
|
|
61
|
+
<% if @smart_columns.any? %>
|
|
62
|
+
<p>Use these column names to show additional data.</p>
|
|
63
|
+
|
|
64
|
+
<table class="table" style="max-width: 500px;">
|
|
65
|
+
<thead>
|
|
66
|
+
<tr>
|
|
67
|
+
<th>Name</th>
|
|
68
|
+
</tr>
|
|
69
|
+
</thead>
|
|
70
|
+
<tbody>
|
|
71
|
+
<% @smart_columns.each do |k, _| %>
|
|
72
|
+
<tr>
|
|
73
|
+
<td><%= k %></td>
|
|
74
|
+
</tr>
|
|
75
|
+
<% end %>
|
|
76
|
+
</tbody>
|
|
77
|
+
</table>
|
|
78
|
+
<% else %>
|
|
79
|
+
<p>None set</p>
|
|
80
|
+
<% end %>
|
|
81
|
+
|
|
82
|
+
<h2>Charts</h2>
|
|
83
|
+
|
|
84
|
+
<p>Use specific combinations of column types to generate charts.</p>
|
|
85
|
+
|
|
86
|
+
<table class="table" style="max-width: 500px;">
|
|
87
|
+
<thead>
|
|
88
|
+
<tr>
|
|
89
|
+
<th style="width: 20%;">Chart</th>
|
|
90
|
+
<th>Column Types</th>
|
|
91
|
+
</tr>
|
|
92
|
+
</thead>
|
|
93
|
+
<tbody>
|
|
94
|
+
<tr>
|
|
95
|
+
<td>Line</td>
|
|
96
|
+
<td>2+ columns - timestamp, numeric(s)</td>
|
|
97
|
+
</tr>
|
|
98
|
+
<tr>
|
|
99
|
+
<td>Line</td>
|
|
100
|
+
<td>3 columns - timestamp, string, numeric</td>
|
|
101
|
+
</tr>
|
|
102
|
+
<tr>
|
|
103
|
+
<td>Column</td>
|
|
104
|
+
<td>2+ columns - string, numeric(s)</td>
|
|
105
|
+
</tr>
|
|
106
|
+
<tr>
|
|
107
|
+
<td>Column</td>
|
|
108
|
+
<td>3 columns - string, string, numeric</td>
|
|
109
|
+
</tr>
|
|
110
|
+
<tr>
|
|
111
|
+
<td>Scatter</td>
|
|
112
|
+
<td>2 columns - both numeric</td>
|
|
113
|
+
</tr>
|
|
114
|
+
<tr>
|
|
115
|
+
<td>Pie</td>
|
|
116
|
+
<td>2 columns - string, numeric - and last column named <code>pie</code></td>
|
|
117
|
+
</tr>
|
|
118
|
+
<tr>
|
|
119
|
+
<td>Map</td>
|
|
120
|
+
<td>
|
|
121
|
+
Named <code>latitude</code> and <code>longitude</code>, or <code>lat</code> and <code>lon</code>, or <code>lat</code> and <code>lng</code>
|
|
122
|
+
<% if !blazer_maps? %>
|
|
123
|
+
<br />
|
|
124
|
+
<strong>Needs configured</strong>
|
|
125
|
+
<% end %>
|
|
126
|
+
</td>
|
|
127
|
+
</tr>
|
|
128
|
+
</tbody>
|
|
129
|
+
</table>
|
|
130
|
+
|
|
131
|
+
<p>Use the column name <code>target</code> to draw a line for goals.</p>
|
|
132
|
+
|
|
133
|
+
<% if @data_source.supports_cohort_analysis? %>
|
|
134
|
+
<h2>Cohort Analysis</h2>
|
|
135
|
+
|
|
136
|
+
<p>Create a query with the comment <code>/* cohort analysis */</code>. The result should have columns named <code>user_id</code> and <code>conversion_time</code> and optionally <code>cohort_time</code>.</p>
|
|
137
|
+
<% end %>
|
data/lib/bnb_blazer/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,29 +1,29 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: bnb_blazer
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.13.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Joe
|
|
8
|
-
autorequire:
|
|
8
|
+
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2023-03-17 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: blazer
|
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
|
16
16
|
requirements:
|
|
17
|
-
- -
|
|
17
|
+
- - '='
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version:
|
|
19
|
+
version: 2.4.0
|
|
20
20
|
type: :runtime
|
|
21
21
|
prerelease: false
|
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
23
|
requirements:
|
|
24
|
-
- -
|
|
24
|
+
- - '='
|
|
25
25
|
- !ruby/object:Gem::Version
|
|
26
|
-
version:
|
|
26
|
+
version: 2.4.0
|
|
27
27
|
- !ruby/object:Gem::Dependency
|
|
28
28
|
name: sassc
|
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -59,6 +59,7 @@ files:
|
|
|
59
59
|
- app/models/user.rb
|
|
60
60
|
- app/views/blazer/_nav.html.erb
|
|
61
61
|
- app/views/blazer/dashboards/show.html.erb
|
|
62
|
+
- app/views/blazer/queries/docs.html.erb
|
|
62
63
|
- app/views/blazer/queries/home.html.erb
|
|
63
64
|
- app/views/blazer/queries/show.html.erb
|
|
64
65
|
- app/views/bnb_blazer/_footer.html.erb
|
|
@@ -89,7 +90,7 @@ licenses:
|
|
|
89
90
|
metadata:
|
|
90
91
|
homepage_uri: https://github.com/brandnewbox/bnb_blazer
|
|
91
92
|
source_code_uri: https://github.com/brandnewbox/bnb_blazer
|
|
92
|
-
post_install_message:
|
|
93
|
+
post_install_message:
|
|
93
94
|
rdoc_options: []
|
|
94
95
|
require_paths:
|
|
95
96
|
- lib
|
|
@@ -104,8 +105,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
104
105
|
- !ruby/object:Gem::Version
|
|
105
106
|
version: '0'
|
|
106
107
|
requirements: []
|
|
107
|
-
rubygems_version: 3.
|
|
108
|
-
signing_key:
|
|
108
|
+
rubygems_version: 3.3.7
|
|
109
|
+
signing_key:
|
|
109
110
|
specification_version: 4
|
|
110
111
|
summary: Customized branding of the Blazer gem for BNB projects
|
|
111
112
|
test_files: []
|