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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb90df084483bf604c36ad9948de85acf67106d600d638e8f5ab0e6108893eb9
-  data.tar.gz: 180dd9ed4317bdf485911d9ad2f3d3bd40e6c1b34fa6b66c5592b099125ac563
+  metadata.gz: 03efda757aa22b9f9ea0f423141e06e6511652d96413e8cb17126fc683534a52
+  data.tar.gz: b48a0a4c69058d611a3195297c2df0a81a5057d5b7f32119a8cb40ac05b26c31
 SHA512:
-  metadata.gz: a56588d152eaa2f08cb5881b60872670d1e473cd81ff161706914076494b47a7fde8c5489eac2793133e5065f34733f9fd245d4b73dc46edb11049aab7e01dde
-  data.tar.gz: f5f025c9a088cfd2ccb7926188c2011c391cc5e7c9361c4df4891e42a60255ce890b9aaf931b7dd9f89523b7375fcebef0fe8991cefc1b3d45a22c2ceb39c7ea
+  metadata.gz: 300cddabf1f0b4ebd49f45aebc8a248086801184a8a2c01efae5d1f316d96beb0fd26dd3310234799dd95b070b7cd5b3197d139b80a70a59f27a03339f0c09a9
+  data.tar.gz: c45d4fd9cb2f49b7a0da8f93a74e6180d24bcd245e7f48d576d34c9d1ae1fd036240f685154cb123ddd5432a0e179c3e26ce2cf670d9988929d2443b2831e59d

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

@@ -26,6 +26,8 @@ After instantiating *log-analyser's* `PageviewsLogAggregator` class with the pat
 <summary>click to expand the index</summary>
 
 - [Installation](#installation)
+    * [Gem](#gem)
+    * [Project](#project)
 - [Usage](#usage)
 - [Logs and Pageviews](#logs-and-pageviews)
     * [Definitions](#definitions)
@@ -40,6 +42,8 @@ After instantiating *log-analyser's* `PageviewsLogAggregator` class with the pat
 
 ## Installation
 
+### Gem
+
 To use *log-analyser* in your application, add this line to your Gemfile:
 
 ```ruby
@@ -50,44 +54,30 @@ Or install it yourself as:
 
     $ gem install log-analyser
 
-## Usage
-
-```
-...
-...
-...
-...
-...
-```
-
-## Logs and Pageviews
-
-### Definitions
-```
-    A pageview is defined as a view of a page on your site that is being tracked by the Analytics tracking code. 
-    If a user clicks reload after reaching the page, this is counted as an additional pageview. 
-    If a user navigates to a different page and then returns to the original page, a second pageview is recorded as well.
+#### Gem Usage
 
-    A unique pageview, as seen in the Content Overview report, aggregates pageviews that are generated by the same 
-    user during the same session. A unique pageview represents the number of sessions during which that page was 
-    viewed one or more times.
-```
+```ruby
+#!/usr/bin/env ruby
 
-### Log Formatting
+require 'pageviews_log_aggregator'
 
-The library is prepared to parser text files, containing one entry per line, in the format: `\page_name identifier`.
+file_path = '/Users/dmazzei/projects/personal/ruby/sp_test/log-analyser/resources/webserver.log'
+log_aggregator = LogAnalyser::PageviewsLogAggregator.new(file_path)
 
-A space must separate the page name (first column) from the user identifier (e.g. IP address):
+puts "\nAll pageviews"
+log_aggregator.all.each do |key, value|
+  puts "#{key&.to_s&.ljust(28, '.')} | #{value}"
+end
 
-```
-/help_page/1 126.318.035.038
-/contact 184.123.665.067
-/home 184.123.665.067
+puts "\nUnique pageviews"
+log_aggregator.unique.each do |key, value|
+  puts "#{key&.to_s&.ljust(28, '.')} | #{value}"
+end
 ```
 
-## Development
+![image](https://user-images.githubusercontent.com/3502642/98482375-dbe8b880-21f8-11eb-853a-ea67acf643ae.png)
 
-#### Start with the project:
+### Project
 
 Install the Ruby version specified in `.ruby-version` </br>
 Clone the project and install Bundler
@@ -109,32 +99,116 @@ Run the initial setup
 > $ bundle install
 > ```
 
+#### Usage
+
+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 :file_folder:`resources` folder:
+
+    $ ./bin/parse_pageview_file.rb --file 'resources/webserver.log'
+    |--------------------------------------------------|
+    | All pageviews                                    |
+    |--------------------------------------------------|
+    | /about/2.................... | 90                |
+    | /contact.................... | 89                |
+    | /index...................... | 82                |
+    | /about...................... | 81                |
+    | /help_page/1................ | 80                |
+    | /home....................... | 78                |
+    |--------------------------------------------------|
+    
+The `-u` or `--unique` option will also display the unique pageview count:
+
+    $ ./bin/parse_pageview_file.rb --file 'resources/webserver.log' -u
+    
+And any specific page can be filtered with `-p` or `--page`:
+
+    $ ./bin/parse_pageview_file.rb --file 'resources/webserver.log' -p '/index'
+    |--------------------------------------------------|
+    | View count for page: /index                      |
+    |--------------------------------------------------|
+    | All pageviews                                    |
+    |--------------------------------------------------|
+    | /index...................... | 82                |
+    |--------------------------------------------------|
+
+## Logs and Pageviews
+
+### Definitions
+
+> :page_facing_up: A pageview is defined as a view of a page on your site that is being tracked by the Analytics tracking code. If a user clicks reload after reaching the page, this is counted as an additional pageview. If a user navigates to a different page and then returns to the original page, a second pageview is recorded as well.
+
+> :page_with_curl: A unique pageview, as seen in the Content Overview report, aggregates pageviews that are generated by the same user during the same session. A unique pageview represents the number of sessions during which that page was viewed one or more times.
+
+
+### Log Formatting
+
+The library is prepared to parser text files, containing one entry per line, in the format: `\page_name identifier`.
 
-You can also run `Bundle exec console` for an interactive prompt that will allow you to experiment.
+A space must separate the page name (first column) from the user identifier (e.g. IP address):
+
+```
+/help_page/1 126.318.035.038
+/contact 184.123.665.067
+/home 184.123.665.067
+```
 
-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).
+## Development
+
+#### 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.
+
+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). 
 
 #### 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: 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
 
@@ -143,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/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,44 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: log-analyser
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3.pre.documentation.20201108212148
 platform: ruby
 authors:
 - Dan Mazzei
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-11-07 00:00:00.000000000 Z
+date: 2020-11-08 00:00:00.000000000 Z
 dependencies: []
 description: Log reader and data aggregator for pageviews information.
 email:
 - danielmazzei@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG
+- LICENSE.txt
+- README.md
 files:
-- ".ruby-version"
 - CHANGELOG
-- Gemfile
-- Guardfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/setup
-- config/environment.rb
 - lib/pageviews.rb
 - 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
@@ -48,9 +54,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.4
 signing_key: 

data/.ruby-version

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

data/Gemfile

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gem 'bundler'
-gem 'rake', '~> 12.0'
-gem 'require_all'
-
-group :development, :test do
-  gem 'coveralls_reborn', '~> 0.18.0', require: false
-  gem 'rspec', '~> 3.8'
-  gem 'rspec_junit_formatter'
-  gem 'rubocop', require: false
-  gem 'simplecov', require: false
-  gem 'simplecov-lcov'
-end
-
-group :development do
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'pry'
-end
-
-gemspec name: 'log-analyser'

data/Guardfile

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-## Uncomment and set this to only include directories you want to watch
-# directories %w(app lib config test spec features) \
-#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
-
-## Note: if you are using the `directories` clause above and you are not
-## watching the project directory ('.'), then you will want to move
-## the Guardfile to a watched dir and symlink it back, e.g.
-#
-#  $ mkdir config
-#  $ mv Guardfile config/
-#  $ ln -s config/Guardfile .
-#
-# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
-
-# Note: The cmd option is now required due to the increasing number of ways
-#       rspec may be run, below are examples of the most common uses.
-#  * bundler: 'bundle exec rspec'
-#  * bundler binstubs: 'bin/rspec'
-#  * spring: 'bin/rspec' (This will use spring if running and you have
-#                          installed the spring binstubs per the docs)
-#  * zeus: 'zeus rspec' (requires the server to be started separately)
-#  * 'just' rspec: 'rspec'
-
-guard :rspec, cmd: 'bundle exec rspec' do
-  require 'guard/rspec/dsl'
-  dsl = Guard::RSpec::Dsl.new(self)
-
-  # Feel free to open issues for suggestions and improvements
-
-  # RSpec files
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
-  watch(/^lib\/documents_analyser\/(.+)\.rb$/) { |m| "spec/#{m[1]}_spec.rb" }
-
-  # Ruby files
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
-end

data/Rakefile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-Bundler::GemHelper.install_tasks
-
-require 'rubygems'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/bin/setup

@@ -1,19 +0,0 @@
-#!/usr/bin/env ruby
-require 'fileutils'
-
-# path to your application root.
-APP_ROOT = File.expand_path('..', __dir__)
-
-def system!(*args)
-  system(*args) || abort("\n== Command #{args} failed ==")
-end
-
-FileUtils.chdir APP_ROOT do
-  # This script is a way to setup or update your development environment automatically.
-  # This script is idempotent, so that you can run it at anytime and get an expectable outcome.
-  # Add necessary setup steps to this file.
-
-  puts '== Installing dependencies =='
-  system! 'gem install bundler --conservative'
-  system('bundle check') || system!('bundle install')
-end

data/config/environment.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'pathname'
-require 'require_all'
-
-APP_ROOT = Pathname.new(__dir__).parent
-$LOAD_PATH.unshift(File.join(APP_ROOT, '/lib')) unless $LOAD_PATH.include?(File.join(APP_ROOT, '/lib'))
-
-require './version'
-require_all './lib'

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 Gemfile Guardfile LICENSE.txt README.md Rakefile bin/setup config/environment.rb 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.2'