log-analyser 0.1.3.pre.documentation.20201108193310 → 0.1.3.pre.littleimprovements.20201109103434

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a645c762e28326585af1cbe7f3d96e4bb46d6a72996d775692ba74c555ba6fc
-  data.tar.gz: f98bbcd840b509840304dd1f7176e484938e29e9200326b2561f9c6dcea79962
+  metadata.gz: 3b62538506c3829402a9e9a867bf26d6576937c69614a4f530ef20cd64699d25
+  data.tar.gz: 5c77973bbe06797d4a95726439485ff254474ef3f11417787d972372e5d83d53
 SHA512:
-  metadata.gz: 21314628d221eefc3a808c71847137a8c7ef06b2910085060c58c5f771012bb8950f00c677deaecf2c47e1b775ecfd395b0a57310dfe9e321c2cc73b2be72296
-  data.tar.gz: 6c0243885a4c600c13b6b58145a64102c47d9e8f661e45c477f64d5b1f535a89245bba8e8e459a62ee40380c36b6870df7db1cd6c945759aa04c14a20e0685f4
+  metadata.gz: dc3f9e866820219b709fc2b5fab185afd51698e975cfb8bb528bc11c92132e99650431ce46af7b7d5ef722b02e915a3534876ece19d37fc5d4c6c7497dd6a677
+  data.tar.gz: f55d687636405327c1863950ae14c2720af6313407be1cbffc20239690a18ea88b8a92f54fbaf9f3187cd9c589d2e64d0ad244110e3f1ef798b11797028153fe

data/CHANGELOG

@@ -1,7 +1,7 @@
 v0.1.3.     completing documentation
 
-v0.1.2b.
+v0.1.2b.    add gem deployment
 
-v0.1.2.
+v0.1.2.     add circleci workflow
 
-v0.1.1.     adding gemspec/echoe/
+v0.1.1.     add gemspec

data/README.md

@@ -1,6 +1,6 @@
+[![Circle CI](https://circleci.com/gh/DMazzei/log-analyser.svg?style=shield)](https://app.circleci.com/pipelines/github/DMazzei/log-analyser)
 [![Coverage Status](https://coveralls.io/repos/github/DMazzei/log-analyser/badge.svg?branch=master)](https://coveralls.io/github/DMazzei/log-analyser?branch=master)
 [![Gem Version](https://badge.fury.io/rb/log-analyser.svg)](https://badge.fury.io/rb/log-analyser)
-[![Circle CI](https://circleci.com/gh/DMazzei/log-analyser.svg?style=shield)](https://app.circleci.com/pipelines/github/DMazzei/log-analyser)
 ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/dmazzei/log-analyser)
 ![Gem](https://img.shields.io/gem/dv/log-analyser/stable)
  
@@ -101,12 +101,12 @@ Run the initial setup
 
 #### Usage
 
-Call `./bin/parse_pageview_file.rb` passing a logfile path as argument, will return the pageview count ordered from most to less viewed.</br>
-Check the script with `--help` argument for more options
+Call `./bin/parse_pageview_file.rb` passing a logfile path as argument, it will return the pageview count ordered from most to less viewed.</br>
+Check `--help` for more options
 
 ![image](https://user-images.githubusercontent.com/3502642/98471556-0c265c00-21e5-11eb-8fc3-c029e09e41fa.png)
 
-An example log can be found in `resources` folder:
+An example log can be found in :file_folder:`resources` folder:
 
     $ ./bin/parse_pageview_file.rb --file 'resources/webserver.log'
     |--------------------------------------------------|
@@ -169,23 +169,35 @@ $ bundle install
 
 And the world is your oyster...
 
-You can also run `Bundle exec console` for an interactive prompt that will allow you to experiment.
+You can also run `$ bundle exec console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. 
-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).
+To install this gem onto your local machine, run `$ bundle exec rake install`. 
+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).
 
 #### Linter (rubocop)
 
 _*Rubocop*_ is used as code analyser and maintain code formatting (as well as some best practices).   
 
-Use `Bundle exec rake rubocop` to run the checks. 
+Use `$ bundle exec rake rubocop` to run the checks. 
 
 #### Test coverage
 
-Use `Bundle exec rake rspec` to run the tests.
+[![Coverage Status](https://coveralls.io/repos/github/DMazzei/log-analyser/badge.svg?branch=master)](https://coveralls.io/github/DMazzei/log-analyser?branch=master)
+
+Use `$ bundle exec rspec` or `$ bundle exec rake spec:all` to run all the tests.
+
+:white_check_mark: To run only unit-tests
+
+    $ bundle exec rake spec:unit
 
-The test coverage is handled by `rspec`, `simplecov` and `coveralls`.
-Status and coverage history can be checked [here](https://coveralls.io/github/DMazzei/log-analyser). 
+:white_check_mark: To run only integration tests
+
+    $ bundle exec rake spec:integration
+
+The test coverage is handled by `rspec`, `simplecov` and `coveralls`.</br>
+After running the tests, a local version of the test coverage report is available [here](http://localhost:63342/log-analyser/coverage/index.html).
+
+Full status and coverage history can be checked online on [coveralls](https://coveralls.io/github/DMazzei/log-analyser). 
 
 #### Deployment
 
@@ -197,7 +209,7 @@ The _*master branch*_ merge process will trigger the deployment process on Circl
 
 The whole deployment process will finish by building and tagging a new gem version and pushing it to [rubygems.org](https://rubygems.org/gems/log-analyser).
 
-> :warning: In order to merge changes into _*master branch*_, the version must be bumped up, otherwise the deployment will fail.</br>
+> :warning: To merge changes into _*master*_, the version must be bumped up, otherwise the deployment will fail!</br>
 > The version must be updated in `version.rb`.
 
 ## Contributing
@@ -205,8 +217,13 @@ The whole deployment process will finish by building and tagging a new gem versi
 Bug reports and pull requests are welcome on GitHub at https://github.com/DMazzeig/log-analyser.
 
 ## Next Steps
-
-- Extend the logfile formatting;
+ 
+- One conundrum faced that can be reviewed, deciding between:
+    * reading the file whilst aggregation data, preserving memory - e.g. using `Set`;
+    * loading data into memory and leaving aggregation and count to be dealt later, gaining flexibility and performance;
+- Extend the accepted logfile format;
+- Add more options for sorting and filtering;  
+- Automate library version bump up;
 
 ## License
 

data/lib/parser.rb

@@ -12,24 +12,29 @@ module LogAnalyser
       new.call(file_path)
     end
 
+    def initialize
+      @entries = Hash.new { |h, k| h[k] = [] }
+    end
+
     def call(file_path)
       raise FileNotFoundError, file_path unless File.exist?(file_path)
 
       data = File.open(file_path).map(&:strip)
       data.reject!(&:empty?)
       parse(data)
+
+      entries
     end
 
     private
 
+    attr_reader :entries
+
     def parse(data)
-      entries = Hash.new { |h, k| h[k] = [] }
       data.each do |entry|
         key, value = *entry.split(/\s+/)
         entries[key] << value
       end
-
-      entries
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log-analyser
 version: !ruby/object:Gem::Version
-  version: 0.1.3.pre.documentation.20201108193310
+  version: 0.1.3.pre.littleimprovements.20201109103434
 platform: ruby
 authors:
 - Dan Mazzei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-08 00:00:00.000000000 Z
+date: 2020-11-09 00:00:00.000000000 Z
 dependencies: []
 description: Log reader and data aggregator for pageviews information.
 email: