page_view_parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc62810f4d5cdcc46810bf3cb009e2173e086f40289103c6de060ebef3916bed
+  data.tar.gz: 4f5c6a7d74a12615f98c5a8439c26bfcba6c8d04509033322792f8b2d154b7b5
+SHA512:
+  metadata.gz: c361c7e10da596db6600f87b500d3a50dff9646d162f6a59dacf14493d9a72e8dbdbc9db672a87197afb9e307df66fe689894a089450bee05a0684ce2c5d9e1b
+  data.tar.gz: c196b8b6fa9e18ed3784d4c04cdb22fbba05a4d740d12245627c9a3cd08ef9f97c2fda524bb91b1c5e1a8decddb55894dedba7e025d7e5b47469405e45dad5ca

data/lib/log_parser.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'page.rb'
+
+# Takes a log file where each line has the format of:
+#   PAGE_NAME VISITOR_IP
+# eg.
+#   /about 123.456.789.123
+# and turns it into a list of 'page' objects.
+# The target object to turn each line in the log into is
+# expected to be able to receive page: and visitor: keyword arguments.
+class LogParser
+  class MalformedLog < StandardError; end
+
+  def initialize(page_class: Page)
+    @page_class = page_class
+  end
+
+  # arranging by path in a hash first instead of straight into an Array to avoid
+  # an iteration of the whole list so far on each check for existence. Instead,
+  # using the quicker lookup by key to then later just extract the values into
+  # the list.
+  def parse_from_file(file_path:)
+    page_views = {}.tap do |pages|
+      File.open(file_path).each do |line|
+        build_page line, pages
+      end
+    end
+    [].push(*page_views.values)
+  end
+
+  def parse_from_string(string:)
+    page_views = {}.tap do |pages|
+      string.split("\n").each do |line|
+        build_page line, pages
+      end
+    end
+    [].push(*page_views.values)
+  end
+
+  private
+
+  attr_reader :file_path, :page_class
+
+  def build_page(line, pages)
+    path, visitor = line.split(' ')
+    raise MalformedLog, 'Log malformed' if
+      path.nil? || visitor.nil?
+
+    if pages[path].nil? # The current path hasn't been seen before
+      pages[path] = page_class.new(path: path, visitors: [visitor])
+    else
+      pages[path].visitors << visitor
+    end
+  end
+end

data/lib/page.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Represents a record of a page that can be visited, holding a record of the
+# visitors via their ip address
+class Page
+  attr_reader :path, :visitors
+
+  def initialize(path:, visitors: [])
+    @path = path
+    @visitors = visitors
+  end
+
+  def <<(visitor)
+    visitors << visitor
+  end
+
+  def view_count
+    visitors.count
+  end
+
+  def unique_view_count
+    visitors.uniq.count
+  end
+
+  def to_s(strategy: DEFAULT_PAGE_PRESENTATION_STRATEGY)
+    strategy.call(self)
+  end
+
+  DEFAULT_PAGE_PRESENTATION_STRATEGY = proc do |page|
+    "#{page.path} visited by #{page.visitors.uniq}"
+  end
+end

data/lib/page_list_format_strategies/base.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module PageListFormatStrategies
+  # Base class that represents the interface all pages format strategy
+  # classes must implement.
+  class Base
+    def initialize(pages:)
+      @pages = pages
+    end
+
+    # It is expected that all sub class strategies will override this method and
+    # provide it's own formatting algorithm / behaviour. The result however is
+    # always an array of the new format the Pages have taken.
+    def call
+      pages
+    end
+
+    private
+
+    attr_reader :pages
+  end
+end

data/lib/page_list_format_strategies/with_unique_view_count.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../page_list_format_strategies/base.rb'
+
+module PageListFormatStrategies
+  # A presentation strategy that presents a list of pages in descending order
+  # by the number of unique views with its unique view count.
+  class WithUniqueViewCount < Base
+    def call
+      presentation_strategy = proc do |page|
+        str = ''
+        str += "#{page.path} #{page.unique_view_count} "
+        str += "unique visit#{page.unique_view_count > 1 ? 's' : ''}"
+        str
+      end
+
+      pages.sort_by { |page| -page.unique_view_count }
+           .map { |page| page.to_s(strategy: presentation_strategy) }
+    end
+  end
+end

data/lib/page_list_format_strategies/with_view_count.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../page_list_format_strategies/base.rb'
+
+module PageListFormatStrategies
+  # A presentation strategy that presents a list of page paths in descending
+  # order (highest number of views at the top) with their total view count.
+  class WithViewCount < Base
+    def call
+      presentation_strategy = proc do |page|
+        "#{page.path} #{page.view_count} visit#{page.view_count > 1 ? 's' : ''}"
+      end
+
+      pages.sort_by { |page| -page.view_count }
+           .map { |page| page.to_s(strategy: presentation_strategy) }
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: page_view_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Hayes-Reed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.85'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.85'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: A simple webserver parser that outputs page count information
+email: john.hayes.reed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/log_parser.rb
+- lib/page.rb
+- lib/page_list_format_strategies/base.rb
+- lib/page_list_format_strategies/with_unique_view_count.rb
+- lib/page_list_format_strategies/with_view_count.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Page View Parser
+test_files: []