log-analyser 0.1.3.pre.documentation.20201108193310 → 0.1.3.pre.documentation.20201108212148

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a645c762e28326585af1cbe7f3d96e4bb46d6a72996d775692ba74c555ba6fc
-  data.tar.gz: f98bbcd840b509840304dd1f7176e484938e29e9200326b2561f9c6dcea79962
+  metadata.gz: 03efda757aa22b9f9ea0f423141e06e6511652d96413e8cb17126fc683534a52
+  data.tar.gz: b48a0a4c69058d611a3195297c2df0a81a5057d5b7f32119a8cb40ac05b26c31
 SHA512:
-  metadata.gz: 21314628d221eefc3a808c71847137a8c7ef06b2910085060c58c5f771012bb8950f00c677deaecf2c47e1b775ecfd395b0a57310dfe9e321c2cc73b2be72296
-  data.tar.gz: 6c0243885a4c600c13b6b58145a64102c47d9e8f661e45c477f64d5b1f535a89245bba8e8e459a62ee40380c36b6870df7db1cd6c945759aa04c14a20e0685f4
+  metadata.gz: 300cddabf1f0b4ebd49f45aebc8a248086801184a8a2c01efae5d1f316d96beb0fd26dd3310234799dd95b070b7cd5b3197d139b80a70a59f27a03339f0c09a9
+  data.tar.gz: c45d4fd9cb2f49b7a0da8f93a74e6180d24bcd245e7f48d576d34c9d1ae1fd036240f685154cb123ddd5432a0e179c3e26ce2cf670d9988929d2443b2831e59d

data/README.md

@@ -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,20 +169,30 @@ $ 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 rake spec:all` to run all the tests.
+
+:white_check_mark: To run only unit-tests
+
+    $bundle exec rake spec:unit
+
+:white_check_mark: To run only integration tests
+
+    $bundle exec rake spec:integration
 
 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). 
@@ -197,7 +207,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
@@ -207,6 +217,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/DMazze
 ## Next Steps
 
 - Extend the logfile formatting;
+- 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: log-analyser
 version: !ruby/object:Gem::Version
-  version: 0.1.3.pre.documentation.20201108193310
+  version: 0.1.3.pre.documentation.20201108212148
 platform: ruby
 authors:
 - Dan Mazzei