log-analyser 0.1.3.pre.documentation.20201108181359 → 0.1.3.pre.documentation.20201108213409

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6524a24c2a502423d99cbb9461b86bb54068ee3ce9fe8562186ba1e8d66e05a
-  data.tar.gz: c0ae8e1d4783d80fada235ba7bdf98aec05a15f8666751baf9a9f54dd34dd543
+  metadata.gz: b130e3448b5bce64a194ad4843b9d7712e1cee00821086c8d207b187091784ef
+  data.tar.gz: 59933e1912afc0632d6304fe59ef74370a6bf95114773bd7883b273292c693c5
 SHA512:
-  metadata.gz: e9b0d8f5e528b4c925d1a50e410a2afdae5a5779208216c8f776dd0ba47e92bc10e9b583917c2cf57f3de197bdafc4c1780ac283d75f7dba2337a43ff05f6bbb
-  data.tar.gz: 421a8d2a04f7246643cde2f09f85aa01bd89715830ea434486df3a0f5fbca19357d3d439b98c0ba3b76170338410ebc693e06129fee90d778540adc0bfdd669a
+  metadata.gz: 6631b545a1ce34e7a0c291b043c9741dbfd2099aaf4c7129dcde40edc0511905509ac0fa4b88c25d77d72672808e2e2a075e340aaa6863a126be3cbc2f973466
+  data.tar.gz: 5c96d28a31b7b40f022acd0a09ce143e76e4df0788636f4edb15dbe0c659e65ee80e691d9e7b17287299e226356e2f1ffd13d6c60a874239ae69f0d7f58a51eb

data/CHANGELOG

@@ -1 +1,7 @@
-v0.1.1. adding gemspec/echoe/
+v0.1.3.     completing documentation
+
+v0.1.2b.
+
+v0.1.2.
+
+v0.1.1.     adding gemspec/echoe/

data/README.md

@@ -56,13 +56,26 @@ Or install it yourself as:
 
 #### Gem Usage
 
+```ruby
+#!/usr/bin/env ruby
+
+require 'pageviews_log_aggregator'
+
+file_path = '/Users/dmazzei/projects/personal/ruby/sp_test/log-analyser/resources/webserver.log'
+log_aggregator = LogAnalyser::PageviewsLogAggregator.new(file_path)
+
+puts "\nAll pageviews"
+log_aggregator.all.each do |key, value|
+  puts "#{key&.to_s&.ljust(28, '.')} | #{value}"
+end
+
+puts "\nUnique pageviews"
+log_aggregator.unique.each do |key, value|
+  puts "#{key&.to_s&.ljust(28, '.')} | #{value}"
+end
 ```
-...
-...
-...
-...
-...
-```
+
+![image](https://user-images.githubusercontent.com/3502642/98482375-dbe8b880-21f8-11eb-853a-ea67acf643ae.png)
 
 ### Project
 
@@ -88,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'
     |--------------------------------------------------|
@@ -147,34 +160,54 @@ A space must separate the page name (first column) from the user identifier (e.g
 
 #### Start with the project:
 
+```
+$ git clone git@github.com:DMazzei/log-analyser.git
+$ cd log-analyser
+$ gem install bundler
+$ 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
+
+: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). 
 
 #### Deployment
 
-After passing all checks and requirements on github, a *PR* can be merged after review and approval. 
-The _*master branch*_ merge process will trigger the deployment process on CircleCI.
+Following the creation of a _*Pull Request*_ a CI workflow is triggered in CircleCI, that can be checked [here](https://app.circleci.com/pipelines/github/DMazzei/log-analyser).</br>
+This workflow consist in _building_ the library; Running _rubocop_ and _rspec_ to validate integrity and code quality; And lastly generating and pushing a _feature-gem_ that can be used for development and tests.
+
+After passing all checks and requirements on github, a *PR* can be merged as soon as it is reviewed and approved. 
+The _*master branch*_ merge process will trigger the deployment process on CircleCI, and this workflow ends with the generation of a _*tagged-gem*_.
 
-The deployment process will build and tag a new gem version and push it to [rubygems.org](https://rubygems.org/gems/log-analyser).
+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
@@ -182,8 +215,13 @@ The deployment process will build and tag a new gem version and push it to [ruby
 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/pageviews.rb

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 
-class Pageviews
-  InvalidLogEntriesError = Class.new(StandardError)
+module LogAnalyser
+  class Pageviews
+    InvalidLogEntriesError = Class.new(StandardError)
 
-  def self.for(entries = {})
-    new.generate_view_count(entries)
-  rescue StandardError
-    raise InvalidLogEntriesError
-  end
+    def self.for(entries = {})
+      new.generate_view_count(entries)
+    rescue StandardError
+      raise InvalidLogEntriesError
+    end
 
-  def generate_view_count(entries)
-    entries
-      .transform_values(&:size)
-      .sort_by(&:last)
-      .reverse
-      .to_h
+    def generate_view_count(entries)
+      entries
+        .transform_values(&:size)
+        .sort_by(&:last)
+        .reverse
+        .to_h
+    end
   end
 end

data/lib/pageviews_log_aggregator.rb

@@ -4,24 +4,26 @@ require_relative 'parser'
 require_relative 'pageviews'
 require_relative 'unique_pageviews'
 
-class PageviewsLogAggregator
-  def initialize(file_path)
-    @file_path = file_path
-  end
+module LogAnalyser
+  class PageviewsLogAggregator
+    def initialize(file_path)
+      @file_path = file_path
+    end
 
-  def all
-    Pageviews.for(entries)
-  end
+    def all
+      Pageviews.for(entries)
+    end
 
-  def unique
-    UniquePageviews.for(entries)
-  end
+    def unique
+      UniquePageviews.for(entries)
+    end
 
-  private
+    private
 
-  attr_accessor :file_path
+    attr_accessor :file_path
 
-  def entries
-    @entries ||= Parser.call(file_path)
+    def entries
+      @entries ||= Parser.call(file_path)
+    end
   end
 end

data/lib/parser.rb

@@ -1,33 +1,40 @@
 # frozen_string_literal: true
 
-class Parser
-  class FileNotFoundError < StandardError
-    def initialize(path)
-      super("File not found for path: [#{path}]")
+module LogAnalyser
+  class Parser
+    class FileNotFoundError < StandardError
+      def initialize(path)
+        super("File not found for path: [#{path}]")
+      end
     end
-  end
 
-  def self.call(file_path)
-    new.call(file_path)
-  end
+    def self.call(file_path)
+      new.call(file_path)
+    end
 
-  def call(file_path)
-    raise FileNotFoundError, file_path unless File.exist?(file_path)
+    def initialize
+      @entries = Hash.new { |h, k| h[k] = [] }
+    end
 
-    data = File.open(file_path).map(&:strip)
-    data.reject!(&:empty?)
-    parse(data)
-  end
+    def call(file_path)
+      raise FileNotFoundError, file_path unless File.exist?(file_path)
 
-  private
+      data = File.open(file_path).map(&:strip)
+      data.reject!(&:empty?)
+      parse(data)
 
-  def parse(data)
-    entries = Hash.new { |h, k| h[k] = [] }
-    data.each do |entry|
-      key, value = *entry.split(/\s+/)
-      entries[key] << value
+      entries
     end
 
-    entries
+    private
+
+    attr_reader :entries
+
+    def parse(data)
+      data.each do |entry|
+        key, value = *entry.split(/\s+/)
+        entries[key] << value
+      end
+    end
   end
 end

data/lib/unique_pageviews.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
-class UniquePageviews < Pageviews
-  def generate_view_count(entries)
-    entries.transform_values { |value| value.uniq.size }
-           .sort_by(&:last)
-           .reverse
-           .to_h
+module LogAnalyser
+  class UniquePageviews < Pageviews
+    def generate_view_count(entries)
+      entries.transform_values { |value| value.uniq.size }
+             .sort_by(&:last)
+             .reverse
+             .to_h
+    end
   end
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: log-analyser
 version: !ruby/object:Gem::Version
-  version: 0.1.3.pre.documentation.20201108181359
+  version: 0.1.3.pre.documentation.20201108213409
 platform: ruby
 authors:
 - Dan Mazzei
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2020-11-08 00:00:00.000000000 Z
 dependencies: []
@@ -15,9 +15,11 @@ email:
 - danielmazzei@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG
+- LICENSE.txt
+- README.md
 files:
-- ".ruby-version"
 - CHANGELOG
 - LICENSE.txt
 - README.md
@@ -25,15 +27,24 @@ files:
 - lib/pageviews_log_aggregator.rb
 - lib/parser.rb
 - lib/unique_pageviews.rb
-- log-analyser.gemspec
-- version.rb
 homepage: https://github.com/DMazzei/log-analyser
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/DMazzei/log-analyser
+  source_code_uri: https://github.com/DMazzei/log-analyser
+  changelog_uri: https://github.com/DMazzei/log-analyser/blob/master/CHANGELOG
+  bug_tracker_uri: https://github.com/DMazzei/log-analyser/issues
+  documentation_uri: https://www.rubydoc.info/gems/log-analyser
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--title"
+- Emoticon - emotions in terminal
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement

data/.ruby-version

@@ -1 +0,0 @@
-2.7.1

data/log-analyser.gemspec

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'log-analyser'
-  spec.version       = VERSION
-  spec.authors       = ['Dan Mazzei']
-  spec.email         = ['danielmazzei@gmail.com']
-
-  spec.summary       = 'Log reader and data aggregator for pageviews information.'
-  spec.description   = 'Log reader and data aggregator for pageviews information.'
-  spec.homepage      = 'https://github.com/DMazzei/log-analyser'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.7')
-
-  # spec.metadata['allowed_push_host'] = "'TODO: Set to 'http://mygemserver.com''"
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  # spec.metadata['source_code_uri'] = "'TODO: Put your gem's public repo URL here.'"
-  # spec.metadata['changelog_uri'] = "'TODO: Put your gem's CHANGELOG.md URL here.'"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = %w(.ruby-version CHANGELOG LICENSE.txt README.md lib/pageviews.rb lib/pageviews_log_aggregator.rb lib/parser.rb lib/unique_pageviews.rb log-analyser.gemspec version.rb)
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-end

data/version.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-VERSION = '0.1.3'