log-analyser 0.1.1.pre.addgemtagrelease.20201106201808 → 0.1.1.pre.expandreadme.20201107175459

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd47a065d7c65ac5c61c132b8c8ef2c226f5937ed7b33ec180c73e347a966e50
-  data.tar.gz: 4187273a11d196f93982702ad4807ba75841af52f73a65642fc6eeafe256fb35
+  metadata.gz: f9d523d47a6b531fa78376a0973968dd8fd5fe2b4ea1aebedb673797dc10ba0c
+  data.tar.gz: bcd5153042a04926b2d38852c3b31c2f3a038a3b71a679a9c9d822042c0b096d
 SHA512:
-  metadata.gz: 0b765240841a67f0f3a31332e5091025e8e2ba4e4bf7ceaf0f686995c1124ace844acad0d66069c2084d39544a2fe49ace0574bf530b1bc07531723d000cb08a
-  data.tar.gz: 8e2369c8b86517affc31abc6eb11f098d096079739f7bdc925ce6f6de02e104a9bc1b6f717733b2b867a40102843c93c0f21687f3a576bba16dbe9176efa84b8
+  metadata.gz: 04b5916754e08d990557dd0d58e2a08c6c13651193bc443a37b995f8f1c2793083aea770145590aa1bf39fd126e1302a1c4bf3e26b87408aa0e16dfff643fd11
+  data.tar.gz: '09f522da150acc9a30b1496f185df0960e585e41ebb83d90a41c8775ceda810b35d12fbc162ce608a8bcc0bc986ea34f19b114dec1c662123909c17e763becdc'

data/.ruby-version

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

data/Gemfile.lock

@@ -0,0 +1,117 @@
+PATH
+  remote: .
+  specs:
+    log-analyser (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    coderay (1.1.3)
+    coveralls_reborn (0.18.0)
+      simplecov (>= 0.18.1, < 0.20.0)
+      term-ansicolor (~> 1.6)
+      thor (>= 0.20.3, < 2.0)
+      tins (~> 1.16)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (1.8.2)
+    require_all (3.0.0)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.2.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.0.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    simplecov (0.19.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    simplecov-lcov (0.8.0)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.26.0)
+      sync
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  coveralls_reborn (~> 0.18.0)
+  guard
+  guard-rspec
+  log-analyser!
+  pry
+  rake (~> 12.0)
+  require_all
+  rspec (~> 3.8)
+  rspec_junit_formatter
+  rubocop
+  simplecov
+  simplecov-lcov
+
+BUNDLED WITH
+   2.1.4

data/Guardfile

@@ -0,0 +1,45 @@
+# 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/README.md

@@ -1,51 +1,143 @@
 [![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)
+ 
+# Log-Analyser
 
+## About
 
+Simple ruby library to read and parse web-server's log files and aggregate pageview data. 
 
-```
-    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.
+### TL;DR
+<details>
+<summary>check minimal instructions</summary>
 
-    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.
-```
+Install *log-analyser* gem.
+After instantiating *log-analyser's* `PageviewsLogAggregator` class with the path to the logfile:
+</br>- the method `all` will return the pageview count
+</br>- whilst method `unique` will return the unique pageview count. 
 
+</details>
 
-# Log::Analyser
+### Table of Contents
+<details>
+<summary>click to expand the index</summary>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/log/analyser`. To experiment with that code, run `bin/console` for an interactive prompt.
+- [Installation](#installation)
+- [Usage](#usage)
+- [Logs and Pageviews](#logs-and-pageviews)
+    * [Definitions](#definitions)
+    * [Log Formatting](#log-formatting)
+- [Development](#development)
+- [Contributing](#contributing)
+- [Next Steps](#next-steps)
+- [License](#license)
+    
 
-TODO: Delete this and the text above, and describe your gem
+</details>
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To use *log-analyser* in your application, add this line to your Gemfile:
 
 ```ruby
 gem 'log-analyser'
 ```
 
-And then execute:
-
-    $ bundle install
-
 Or install it yourself as:
 
     $ gem install log-analyser
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+...
+...
+...
+...
+...
+```
+
+## 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.
+```
+
+### Log Formatting
+
+The library is prepared to parser text files, containing one entry per line, in the format: `\page_name identifier`.
+
+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
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+#### Start with the project:
+
+Install the Ruby version specified in `.ruby-version` </br>
+Clone the project and install Bundler
 
-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).
+```
+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.
+
+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. 
+
+#### Test coverage
+
+Use `Bundle exec rake rspec` to run the tests.
+
+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). 
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/log-analyser.
 
+## Next Steps
+
+- Extend the logfile formatting;
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+

data/Rakefile

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'rubygems'
-require 'rspec/core/rake_task'
+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

@@ -0,0 +1,19 @@
+#!/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

@@ -0,0 +1,11 @@
+# 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

@@ -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(CHANGELOG Gemfile LICENSE.txt manifest README.md Rakefile 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 Gemfile Gemfile.lock 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']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log-analyser
 version: !ruby/object:Gem::Version
-  version: 0.1.1.pre.addgemtagrelease.20201106201808
+  version: 0.1.1.pre.expandreadme.20201107175459
 platform: ruby
 authors:
 - Dan Mazzei
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2020-11-07 00:00:00.000000000 Z
 dependencies: []
 description: Log reader and data aggregator for pageviews information.
 email:
@@ -17,17 +17,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".ruby-version"
 - CHANGELOG
 - Gemfile
+- Gemfile.lock
+- 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
-- manifest
 - version.rb
 homepage: https://github.com/DMazzei/log-analyser
 licenses:

data/manifest

@@ -1,12 +0,0 @@
-CHANGELOG
-Gemfile
-LICENSE.txt
-Manifest
-README.md
-Rakefile
-lib/pageviews.rb
-lib/pageviews_log_aggregator.rb
-lib/parser.rb
-lib/unique_pageviews.rb
-log-analyser.gemspec
-version.rb