rslog 0.0.10 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbfdff7943771b6041ad63326ac885ea1f15734a9605d0b0ec9fc966e97cc2e5
-  data.tar.gz: 19a16f3c7b1e23f52b3ff2f4887c39cbe144470e92b95f9503ba71879c9ef147
+  metadata.gz: '089ce1f53d07365d2cd5a8a132d3f016fd971aec94fb5e1d7d097b83c378d16b'
+  data.tar.gz: 690f6b582c62d555192f003bb9bf48f47c05c73e6144663fc5271ef263a8a6e2
 SHA512:
-  metadata.gz: b7ac79824d646234ed125a91b5652a8974dec571d111eb343c499ef908f47128eba6b182182ab323b24064d06336781820d2dd17570828a35666ad8efee25682
-  data.tar.gz: ee1ee56ebb29461e55572b6404ce52c9c91b2dc1584c85115f4aaa9c0ddc7c37d1a891993a2b2946a4becdda4a85d8976e6b0c6d475ff1cf898dd02aa765bbe6
+  metadata.gz: 2607d6b3ba40a13ecba89d214d0ef3d92d8d7b28b3b0dedf96942b01ea939efd287797ad4fe56e99c6986eac2dcbe53feca954abe41b69f14633ed9a79249f82
+  data.tar.gz: f68723a370022e15d2df26516b60725cad3b20d60a3c59bc3d7c2fc55f4146d874cbd123b1900896f7cc5eeab9dbff3af027241a3e8d57fc1f41c734283c25c8

data/bin/rslog

@@ -2,4 +2,4 @@
 # frozen_string_literal: true
 
 require_relative '../lib/rslog'
-RSlog.run
+RSlog::Main.run

data/lib/rslog.rb

@@ -1,25 +1,54 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative 'rslog/container'
-require_relative 'rslog/worker'
-require_relative 'rslog/input_parser'
-require_relative 'rslog/extractor'
+require_relative 'rslog/args_handler'
 require_relative 'rslog/validator'
-require_relative 'rslog/data_parser'
+require_relative 'rslog/parser'
 require_relative 'rslog/presenter'
-require_relative 'rslog/opts'
+require 'set'
 
-# For development
-# require 'pry'
+module RSlog
+  VERSION = '0.0.16'
 
-class RSlog
-  VERSION = '0.0.10'
+  # Module to hold main process
+  #
+  module Main
+    def self.run
+      file_names.each do |file_name|
+        puts "Statistics for file #{file_name}"
 
-  def self.run
-    Container.new.process_all
+        lines = IO.readlines(file_name)
+
+        RSlog::Validator.execute(lines)
+
+        process(config_sets, lines)
+      end
+    end
+
+    def self.process(config_sets, lines)
+      config_sets.each do |conf|
+        parsed = RSlog::Parser.new(lines, conf).execute
+        RSlog::Presenter.new(parsed, conf).present
+      end
+    end
+
+    def self.file_names
+      file_names = RSlog::ArgsHandler.new(ARGV).handle
+      return file_names if file_names.all? { |file_name| File.file?(file_name) }
+
+      puts 'There is no file names given. Check input.'
+      []
+    end
+
+    def self.config_sets
+      [{ title:       %(List of webpages with most page views ordered from most pages views to less page views:),
+         #          head_titles:     %w[Url Visits Average],
+         head_titles: %w[Url Visits],
+         calc:        proc { |visits| visits.size } },
+       { title:       'List of webpages with most unique page views also ordered:',
+         #          head_titles:     %w[Url Unique\ views Average],
+         head_titles: %w[Url Unique\ views],
+         calc:        proc { |visits| Set.new(visits).size } }]
+    end
   end
 end
-
-# For development
-# RSlog.run.talk

data/lib/rslog/args_handler.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RSlog
+  # Class to parse options and arguments
+  #
+  # returns Array of file names
+  #
+  class ArgsHandler
+    attr_reader :args, :options
+
+    def initialize(args)
+      @args = args
+      @options = @args.select { |el| el =~ /^-/ }
+    end
+
+    def handle
+      if options.any? || args.empty?
+        _handle_options
+        return []
+      end
+
+      # file_names array
+      args - options
+    end
+
+    private
+
+    def _handle_options
+      _show_help || _show_version || _show_unknown_options_warning
+    end
+
+    def _show_help
+      if options.delete('-h') || args.empty?
+        puts _help_message
+        return true
+      end
+      false
+    end
+
+    def _help_message
+      %[
+  R(uby)S(imple)log statistics
+  Usage:
+  > rslog filename[.log|.txt]
+
+  > rslog [-h|-v]
+     -h - show this info
+     -v - show version
+      ]
+    end
+
+    def _show_version
+      if @options.delete('-v')
+        puts "  Version #{RSlog::VERSION}"
+        return true
+      end
+      false
+    end
+
+    def _show_unknown_options_warning
+      if @options.any?
+        puts "  Unknown options #{@options.join(', ')}"
+        return true
+      end
+      false
+    end
+  end
+end

data/lib/rslog/parser.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RSlog
+  # Class to hold data_processing methods
+  #
+  class DataProcessing
+    attr_reader :result
+
+    def initialize(source, conf)
+      @calc      = conf.fetch(:calc)      { proc }
+      @separator = conf.fetch(:separator, ' ')
+      @result = Array(source)
+    end
+
+    # extract
+    def extract
+      @result = @result.map { |item| item.split(@separator) }
+      self
+    end
+
+    # group
+    def group
+      @result = @result.group_by { |url, _visits| url }.to_a
+      self
+    end
+
+    # calculate
+    def calculate
+      # calculate visits
+      @result = @result.map { |url, visits| [url, @calc.call(visits)] }
+      # calculate average
+      # @result = @result.map { |url, visits_qty| [url, visits_qty, (visits_qty.to_f / _total)] }
+      self
+    end
+
+    # sort
+    def order
+      @result = @result.sort_by { |_url, visits_by_page| visits_by_page }
+      @result.reverse!
+      self
+    end
+
+    private
+
+    # calculate total
+    def _total
+      @result.sum { |_url, visits_qty| visits_qty }
+    end
+  end
+
+  require 'forwardable'
+  # Class to parse data
+  #
+  class Parser
+    attr_reader :data_processing
+
+    extend Forwardable
+    def_delegators :@data_processing, :extract, :group, :calculate, :order
+
+    def initialize(source, conf)
+      @data_processing = DataProcessing.new(source, conf)
+    end
+
+    def execute
+      data_processing.extract.group.calculate.order.result
+    end
+  end
+end

data/lib/rslog/presenter.rb

@@ -1,52 +1,68 @@
 # frozen_string_literal: true
 
-require_relative 'tools/hash'
-require_relative 'tools/array'
-
-# Class to present result in needed format
-#
-class Presenter < Worker
-  DECORATORS = {
-    all:  {
-      title:
-              'List of webpages with most page views ordered from most views to less',
-      suffix: 'visits'
-    },
-    uniq: {
-      title:  'List list of webpages with most unique page views also ordered',
-      suffix: 'unique views'
-    }
-  }.freeze
-
-  def execute(type, formatter)
-    @type = type
-    @container.add_message send("format_as_#{formatter}")
-    self
-  end
+module RSlog
+  # Class for format result according to passed 'format_string'
+  #
+  # result is array of formatted strings
+  # e.g
+  # [ "/about                 1 visits",
+  #   "/about/2               1 visits",
+  #   "/home                  1 visits",
+  #   "/contact               1 visits",
+  #   "/help_page/1           1 visits" ]
+  #
+  class Presenter
+    LEFT_UP_CORNER =    "\u250c"
+    RIGHT_UP_CORNER =   "\u2510"
+    LEFT_DOWN_CORNER =  "\u2514"
+    RIGHT_DOWN_CORNER = "\u2518"
+    VERTICAL_BORDER =   "\u2502"
+    HORIZONTAL_BORDER = "\u2500"
+    VERTICAL_LEFT_BORDER = "\u251C"
+    VERTICAL_RIGHT_BORDER = "\u2524"
 
-  private
+    def initialize(source, conf)
+      @source = source
+      @col_size    = conf.fetch(:col_size, 20)
+      @title       = conf.fetch(:title, 'Stat Pages')
+      @formatter   = conf.fetch(:formatter, "%-#{@col_size}s")
+      @columns     = conf.fetch(:columns, @source&.first&.size || 1)
+      @head_titles = conf.fetch(:head_titles, Array.new(@columns, 'title'))
+    end
 
-  def title
-    decorator[:title]
-  end
+    def present
+      puts @title
+      puts _top_border
+      puts VERTICAL_BORDER + format(@formatter * @columns, *@head_titles) + VERTICAL_BORDER
+      puts _middle_border
+      puts _formatted_data
+      puts _bottom_border
+      puts
+    end
 
-  def suffix
-    decorator[:suffix]
-  end
+    private
 
-  def decorator
-    DECORATORS[@type]
-  end
+    def _top_border
+      LEFT_UP_CORNER + _horisontal_line + RIGHT_UP_CORNER
+    end
 
-  def format_as_text
-    [
-      title,
-      @container.result.to_multiline_string(suffix),
-      separator
-    ].join("\n")
-  end
+    def _middle_border
+      VERTICAL_LEFT_BORDER + _horisontal_line + VERTICAL_RIGHT_BORDER
+    end
+
+    def _bottom_border
+      LEFT_DOWN_CORNER + _horisontal_line + RIGHT_DOWN_CORNER
+    end
+
+    def _horisontal_line
+      HORIZONTAL_BORDER * @col_size * @columns
+    end
 
-  def separator
-    '-----------------------------'
+    def _formatted_data
+      @source.map do |row|
+        row = row.map(&:to_s)
+        VERTICAL_BORDER + format(@formatter * @columns, *row).to_s + VERTICAL_BORDER
+      end
+    end
   end
 end

data/lib/rslog/validator.rb

@@ -1,30 +1,32 @@
 # frozen_string_literal: true
 
-require_relative 'tools/array'
+module RSlog
+  # Class to validate if we have valid data in lines, for example well formatted IPs
+  #
+  # Checks if IPs are comply with regex
+  # Output message "Valid IPs"/"Invalid IPs"
+  #
+  module Validator
+    TEMPLATES = {
+      # IP address regex, source https://regexr.com/38odc
+      ip: /\b(?:(?:2(?:[0-4][0-9]|5[0-5])|[0-1]?[0-9]?[0-9])\.){3}(?:(?:2([0-4][0-9]|5[0-5])|[0-1]?[0-9]?[0-9]))\b/
+    }.freeze
 
-# Class to validate if we have valid data in lines, for example well formatted IPs
-#
-class Validator < Worker
-  TEMPLATES = {
-    # IP address regex, source https://regexr.com/38odc
-    ip: /\b(?:(?:2(?:[0-4][0-9]|5[0-5])|[0-1]?[0-9]?[0-9])\.){3}(?:(?:2([0-4][0-9]|5[0-5])|[0-1]?[0-9]?[0-9]))\b/
-  }.freeze
+    MESSAGES = {
+      valid:   proc { |validator_name| "All #{validator_name.upcase}s are valid" },
+      invalid: proc { |validator_name| "Some #{validator_name.upcase}s are NOT valid" }
+    }.freeze
 
-  MESSAGES = {
-    valid:   proc { |validator| "All #{validator.upcase}s are valid" },
-    invalid: proc { |validator| "Some #{validator.upcase}s are NOT valid" }
-  }.freeze
+    def self.execute(source)
+      puts
+      puts MESSAGES[valid?(source)].call(:ip)
+      puts
+    end
 
-  def execute
-    @container.add_message MESSAGES[validate].call(@container.validator)
-    self
-  end
-
-  private
-
-  def validate
-    return :valid if @container.data.all? TEMPLATES[@container.validator]
+    def self.valid?(source)
+      return :valid if source.all? TEMPLATES[:ip]
 
-    :invalid
+      :invalid
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rslog
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.16
 platform: ruby
 authors:
 - Andrey Eremeev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-06-03 00:00:00.000000000 Z
 dependencies: []
 description: Ruby script to get overall Statistic for weblog logs!
 email: a.eremeev@outlook.com
@@ -19,16 +19,10 @@ extra_rdoc_files: []
 files:
 - bin/rslog
 - lib/rslog.rb
-- lib/rslog/container.rb
-- lib/rslog/data_parser.rb
-- lib/rslog/extractor.rb
-- lib/rslog/input_parser.rb
-- lib/rslog/opts.rb
+- lib/rslog/args_handler.rb
+- lib/rslog/parser.rb
 - lib/rslog/presenter.rb
-- lib/rslog/tools/array.rb
-- lib/rslog/tools/hash.rb
 - lib/rslog/validator.rb
-- lib/rslog/worker.rb
 homepage: https://rubygems.org/gems/rslog
 licenses:
 - MIT

data/lib/rslog/container.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-# Class to hold data and implement processing
-#
-class Container
-  attr_accessor(*%i[
-                  argv file_name messages errors data options validator types result
-                ])
-
-  def initialize
-    @errors = []
-    @messages = []
-    @validator = :ip
-    @types = %i[all uniq]
-  end
-
-  def file_name?
-    !file_name.empty? && no_errors?
-  end
-
-  def data?
-    messages.include?('Data in place') && no_errors?
-  end
-
-  def no_errors?
-    errors.empty?
-  end
-
-  def add_message(str)
-    messages << str
-  end
-
-  def add_error(str)
-    errors << str
-  end
-
-  def talk
-    puts messages.join("\n")
-    puts errors.join("\n")
-    self
-  end
-
-  def process_all
-    InputParser.new(self).execute
-    Extractor.new(self).execute if file_name?
-    validate_parse_present if data?
-    talk
-    self
-  end
-
-  def validate_parse_present
-    Validator.new(self).execute
-    types.each do |type|
-      DataParser.new(self).execute(type)
-      Presenter.new(self).execute(type, :text)
-    end
-  end
-end

data/lib/rslog/data_parser.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'tools/array'
-require_relative 'tools/hash'
-
-# Class to parse data from given array
-#
-class DataParser < Worker
-  # type = :count (default) -> just count in groups
-  # type = :uniq -> uniq entries in groups
-  def execute(type)
-    @container.result =
-      @container.data
-                .group_by_index(0)
-                .send("count_by_groups_#{type}")
-                .to_a
-                .sort_by { |item| item[1] }
-                .reverse
-                .map { |elem_arr| elem_arr.map(&:to_s).join(' ') }
-    self
-  end
-end

data/lib/rslog/extractor.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-# Class for extracting data from file
-#
-class Extractor < Worker
-  def execute
-    @file_name = @container.file_name
-    check
-    self
-  end
-
-  private
-
-  def check
-    if File.zero?(@file_name)
-      @container.add_message 'Empty file'
-    else
-      @container.data = File.open(@file_name, 'r').to_a
-      @container.add_message 'Data in place'
-    end
-  rescue StandardError => e
-    @container.add_error e
-  end
-end

data/lib/rslog/input_parser.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require 'optparse'
-require_relative 'opts'
-
-# Class to parse input filenames and args
-#
-class InputParser < Worker
-  include Opts
-
-  def execute
-    handle_opts
-    handle_args
-    self
-  end
-
-  private
-
-  attr_accessor :opts
-
-  def handle_opts
-    Opts.create_opts.parse!(into: @container.options)
-  rescue OptionParser::InvalidOption => e
-    @container.add_error e
-  end
-
-  def handle_args
-    @container.file_name = ARGV.select { |str| str =~ /.\.log|.\.txt/ }[0] || ''
-    @container.add_error 'No file_name provided' if @container.file_name.empty?
-  end
-end

data/lib/rslog/opts.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-# Service module to give opts
-#
-module Opts
-  VERSION = {
-    descr:  ['-v', '--version', 'Show version and exit'],
-    action: proc do
-      puts "#{File.basename($PROGRAM_NAME)}: #{RSlog::VERSION}"
-      exit
-    end
-  }.freeze
-
-  HELP = {
-    descr:  ['-h', '--help', 'Prints this message and exit'],
-    action: proc do |opts|
-      puts opts
-      exit
-    end
-  }.freeze
-
-  def self.create_opts
-    OptionParser.new do |opts|
-      opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} FILENAME"
-      opts.on(*Opts::VERSION[:descr]) { Opts::VERSION[:action].call }
-      opts.on(*Opts::HELP[:descr]) { Opts::HELP[:action].call(opts) }
-    end
-  end
-end

data/lib/rslog/tools/array.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-# Monkey patch for Array class
-#
-class Array
-  def group_by_index(index = 0)
-    group_by { |str| str.split(' ')[index] }
-  end
-
-  def to_multiline_string(suffix = '')
-    map { |item| "#{item} #{suffix}" }.join("\n")
-  end
-end

data/lib/rslog/tools/hash.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'set'
-
-# Monkey patch for a Hash class to make counts
-#
-class Hash
-  def count_by_groups_all
-    res = {}
-    each do |group_key, arr|
-      res[group_key] = arr.size
-    end
-    res
-  end
-
-  def count_by_groups_uniq
-    res = {}
-    each do |group_key, arr|
-      res[group_key] = Set.new(arr).size
-    end
-    res
-  end
-end

data/lib/rslog/worker.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-# Class to hold worker functionality
-#
-class Worker
-  def initialize(container)
-    @container = container
-  end
-
-  def execute
-    raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
-  end
-end