log-analyser 0.1.3.pre.documentation.20201108212148 → 0.1.3.pre.littleimprovements.20201109113028

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 (4) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG +3 -3
  3. data/README.md +23 -9
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 03efda757aa22b9f9ea0f423141e06e6511652d96413e8cb17126fc683534a52
4
- data.tar.gz: b48a0a4c69058d611a3195297c2df0a81a5057d5b7f32119a8cb40ac05b26c31
3
+ metadata.gz: 1caa72031e0898a0a3fc47258d87a2e805afe875654172e2b140ea0514ca3171
4
+ data.tar.gz: 30d8efc2a976b585d22a994bb441770813370ecdb0b4a13c4a5abe38909f6aad
5
5
  SHA512:
6
- metadata.gz: 300cddabf1f0b4ebd49f45aebc8a248086801184a8a2c01efae5d1f316d96beb0fd26dd3310234799dd95b070b7cd5b3197d139b80a70a59f27a03339f0c09a9
7
- data.tar.gz: c45d4fd9cb2f49b7a0da8f93a74e6180d24bcd245e7f48d576d34c9d1ae1fd036240f685154cb123ddd5432a0e179c3e26ce2cf670d9988929d2443b2831e59d
6
+ metadata.gz: '08a08a41cca927c99701ee3a6d49749744167c56eb6a8be211f2cae689b95b32d9f2e67dfd6e257ba22bd054269c02610bc6894115ca585b023e49b9c410ee02'
7
+ data.tar.gz: a3abc3de4d4f9989e5e23265eea9cba7ba07bed02e68d5907526bcbb510b9883f3e90118927c3555bd01b3429374202bbe5d70731d5646488ee3fece499a2206
data/CHANGELOG CHANGED
@@ -1,7 +1,7 @@
1
1
  v0.1.3. completing documentation
2
2
 
3
- v0.1.2b.
3
+ v0.1.2b. add gem deployment
4
4
 
5
- v0.1.2.
5
+ v0.1.2. add circleci workflow
6
6
 
7
- v0.1.1. adding gemspec/echoe/
7
+ v0.1.1. add gemspec
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
+ [![Circle CI](https://circleci.com/gh/DMazzei/log-analyser.svg?style=shield)](https://app.circleci.com/pipelines/github/DMazzei/log-analyser)
1
2
  [![Coverage Status](https://coveralls.io/repos/github/DMazzei/log-analyser/badge.svg?branch=master)](https://coveralls.io/github/DMazzei/log-analyser?branch=master)
2
3
  [![Gem Version](https://badge.fury.io/rb/log-analyser.svg)](https://badge.fury.io/rb/log-analyser)
3
- [![Circle CI](https://circleci.com/gh/DMazzei/log-analyser.svg?style=shield)](https://app.circleci.com/pipelines/github/DMazzei/log-analyser)
4
4
  ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/dmazzei/log-analyser)
5
5
  ![Gem](https://img.shields.io/gem/dv/log-analyser/stable)
6
6
 
@@ -169,7 +169,7 @@ $ bundle install
169
169
 
170
170
  And the world is your oyster...
171
171
 
172
- You can also run `bundle exec console` for an interactive prompt that will allow you to experiment.
172
+ You can also run `$ bundle exec console` for an interactive prompt that will allow you to experiment.
173
173
 
174
174
  To install this gem onto your local machine, run `$ bundle exec rake install`.
175
175
  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).
@@ -184,18 +184,29 @@ Use `$ bundle exec rake rubocop` to run the checks.
184
184
 
185
185
  [![Coverage Status](https://coveralls.io/repos/github/DMazzei/log-analyser/badge.svg?branch=master)](https://coveralls.io/github/DMazzei/log-analyser?branch=master)
186
186
 
187
- Use `$ bundle exec rake spec:all` to run all the tests.
187
+ Use `$ bundle exec rspec` or `$ bundle exec rake spec:all` to run all the tests.
188
188
 
189
189
  :white_check_mark: To run only unit-tests
190
190
 
191
- $bundle exec rake spec:unit
191
+ $ bundle exec rake spec:unit
192
192
 
193
193
  :white_check_mark: To run only integration tests
194
194
 
195
- $bundle exec rake spec:integration
195
+ $ bundle exec rake spec:integration
196
+
197
+ The test coverage is handled by `rspec`, `simplecov` and `coveralls`.</br>
198
+ After running the tests, a version of the test coverage report is available locally:
199
+
200
+ Mac Terminal, from your application's root directory run
201
+
202
+ $ open coverage/index.html
196
203
 
197
- The test coverage is handled by `rspec`, `simplecov` and `coveralls`.
198
- Status and coverage history can be checked [here](https://coveralls.io/github/DMazzei/log-analyser).
204
+ in a debian/ubuntu Terminal,
205
+
206
+ $ xdg-open coverage/index.html
207
+
208
+
209
+ Full status and coverage history can be checked online on [coveralls](https://coveralls.io/github/DMazzei/log-analyser).
199
210
 
200
211
  #### Deployment
201
212
 
@@ -215,8 +226,11 @@ The whole deployment process will finish by building and tagging a new gem versi
215
226
  Bug reports and pull requests are welcome on GitHub at https://github.com/DMazzeig/log-analyser.
216
227
 
217
228
  ## Next Steps
218
-
219
- - Extend the logfile formatting;
229
+
230
+ - One conundrum faced that can be reviewed, deciding between:
231
+ * reading the file whilst aggregation data, preserving memory - e.g. using `Set`;
232
+ * loading data into memory and leaving aggregation and count to be dealt later, gaining flexibility and performance;
233
+ - Extend the accepted logfile format;
220
234
  - Add more options for sorting and filtering;
221
235
  - Automate library version bump up;
222
236
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: log-analyser
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.3.pre.documentation.20201108212148
4
+ version: 0.1.3.pre.littleimprovements.20201109113028
5
5
  platform: ruby
6
6
  authors:
7
7
  - Dan Mazzei
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-11-08 00:00:00.000000000 Z
11
+ date: 2020-11-09 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: Log reader and data aggregator for pageviews information.
14
14
  email: