log-analyser 0.1.3.pre.documentation.20201108184713 → 0.1.3.pre.documentation.20201108192110

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e37f374a61508be8ed7cf40a9cea997d1726eef0a5751cf26f99d1a8652de396
-  data.tar.gz: 5d466d1e94319b45d24f0980c04583c80e93a7d7abe06e42ef522e2ae4cd6a02
+  metadata.gz: c2b9b98f46b7ffd52716e53e4b069bfa6d1a01186bfe24bd5e6d9136fc9b79af
+  data.tar.gz: 67c01dedd6e66dc077d6e852f64c5270573cdd6c579aeda09326f881845dc61f
 SHA512:
-  metadata.gz: 9fe9ca653e989b8dfa52d27958f069343e9cad29fffc97bcf6a19a49aa2e45da8a6892bc29c9139f3360c81acb59b488c957ce412a4d495bb26f4557e308bcd2
-  data.tar.gz: d7501783412b7916e185b40f21cfca58ead4fa33f5e1d2a5c7c871975e5512bd1204755e751bf542bc06e187f352e653e984d746a1856a7eec7c1369ee47018b
+  metadata.gz: a60d02c6be8493405b7bcd36c7b1bdcffb8a3f24f5432411fbacb707ccc4d0c59f44797d64fa1f553ab48b13ee9c3f750d8ec4c1a06b3a910db65c7ad71638ee
+  data.tar.gz: b56ec12bf9e52a256498c9573bfceb0eefe40404131536a5ce37514f92ef2840a269df5aad120230aa9a9539c14239419d07a8cba6b35dcdf26621a319bf4f5f

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

@@ -169,10 +169,13 @@ Status and coverage history can be checked [here](https://coveralls.io/github/DM
 
 #### 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.
 
-The deployment process will build and tag a new gem version and push it to [rubygems.org](https://rubygems.org/gems/log-analyser).
+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 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>
 > The version must be updated in `version.rb`.

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,35 @@
 # 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 call(file_path)
+      raise FileNotFoundError, file_path unless File.exist?(file_path)
 
-    data = File.open(file_path).map(&:strip)
-    data.reject!(&:empty?)
-    parse(data)
-  end
+      data = File.open(file_path).map(&:strip)
+      data.reject!(&:empty?)
+      parse(data)
+    end
 
-  private
+    private
 
-  def parse(data)
-    entries = Hash.new { |h, k| h[k] = [] }
-    data.each do |entry|
-      key, value = *entry.split(/\s+/)
-      entries[key] << value
-    end
+    def parse(data)
+      entries = Hash.new { |h, k| h[k] = [] }
+      data.each do |entry|
+        key, value = *entry.split(/\s+/)
+        entries[key] << value
+      end
 
-    entries
+      entries
+    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.20201108184713
+  version: 0.1.3.pre.documentation.20201108192110
 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'