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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb90df084483bf604c36ad9948de85acf67106d600d638e8f5ab0e6108893eb9
-  data.tar.gz: 180dd9ed4317bdf485911d9ad2f3d3bd40e6c1b34fa6b66c5592b099125ac563
+  metadata.gz: e6524a24c2a502423d99cbb9461b86bb54068ee3ce9fe8562186ba1e8d66e05a
+  data.tar.gz: c0ae8e1d4783d80fada235ba7bdf98aec05a15f8666751baf9a9f54dd34dd543
 SHA512:
-  metadata.gz: a56588d152eaa2f08cb5881b60872670d1e473cd81ff161706914076494b47a7fde8c5489eac2793133e5065f34733f9fd245d4b73dc46edb11049aab7e01dde
-  data.tar.gz: f5f025c9a088cfd2ccb7926188c2011c391cc5e7c9361c4df4891e42a60255ce890b9aaf931b7dd9f89523b7375fcebef0fe8991cefc1b3d45a22c2ceb39c7ea
+  metadata.gz: e9b0d8f5e528b4c925d1a50e410a2afdae5a5779208216c8f776dd0ba47e92bc10e9b583917c2cf57f3de197bdafc4c1780ac283d75f7dba2337a43ff05f6bbb
+  data.tar.gz: 421a8d2a04f7246643cde2f09f85aa01bd89715830ea434486df3a0f5fbca19357d3d439b98c0ba3b76170338410ebc693e06129fee90d778540adc0bfdd669a

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,7 +54,7 @@ Or install it yourself as:
 
     $ gem install log-analyser
 
-## Usage
+#### Gem Usage
 
 ```
 ...
@@ -60,18 +64,72 @@ Or install it yourself as:
 ...
 ```
 
+### Project
+
+Install the Ruby version specified in `.ruby-version` </br>
+Clone the project and install Bundler
+
+```
+git clone git@github.com:DMazzei/log-analyser.git
+cd log-analyser
+gem install bundler
+```
+
+#### Setup:
+
+Run the initial setup
+
+    $ bin/setup
+
+> If you need to reinstall dependencies or something alike:
+> ```
+> $ bundle install
+> ```
+
+#### 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
+
+![image](https://user-images.githubusercontent.com/3502642/98471556-0c265c00-21e5-11eb-8fc3-c029e09e41fa.png)
+
+An example log can be found in `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
-```
-    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.
 
-    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.
-```
+> :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
 
@@ -89,25 +147,6 @@ A space must separate the page name (first column) from the user identifier (e.g
 
 #### Start with the project:
 
-Install the Ruby version specified in `.ruby-version` </br>
-Clone the project and install Bundler
-
-```
-git clone git@github.com:DMazzei/log-analyser.git
-cd log-analyser
-gem install bundler
-```
-
-#### Setup:
-
-Run the initial setup
-
-    $ bin/setup
-
-> If you need to reinstall dependencies or something alike:
-> ```
-> $ bundle install
-> ```
 
 
 You can also run `Bundle exec console` for an interactive prompt that will allow you to experiment.
@@ -135,6 +174,8 @@ The _*master branch*_ merge process will trigger the deployment process on Circl
 
 The deployment process will build and tag a new gem version and push 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>
+> The version must be updated in `version.rb`.
 
 ## Contributing
 

data/log-analyser.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   # 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.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']

data/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log-analyser
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3.pre.documentation.20201108181359
 platform: ruby
 authors:
 - Dan Mazzei
 autorequire: 
 bindir: exe
 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:
@@ -19,13 +19,8 @@ extra_rdoc_files: []
 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
@@ -48,9 +43,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/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'