rslog 0.0.14 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a458692b87d66b9b3b9159e9263172dc27b8d07a9df51a9fc336da6ff36c9388
-  data.tar.gz: d5ecb7b45c9534739a6e7c42c03cde7a468bd634b13659a837c9750647763120
+  metadata.gz: 565f890daf1b4081d160be0695bdb10c6522d4477f293e629fd960de9dd6e6eb
+  data.tar.gz: b30cfe363b91deea197373d561e09529594062e659cf319230cc9f3c76e3b0dd
 SHA512:
-  metadata.gz: 5e92c43c6e11b59e096a78e750007bd3a607c6742e1332231fb92e4ba6a7156836300f91cef763637e95ecadca52df671e76ad6963b45ec3bf744ef64a55d4f0
-  data.tar.gz: f77065e38bb39f59fdd2b82e4ada8dc25313891075e4927fa0176ab931b846d036a56507edb94cdbf90c9958ed7e05282c63f9a933906a1bd617438c91d40384
+  metadata.gz: e2eae3d47dc76857e1dcd3cfc3541b9d9fed3b10ab1340783b744761b61436f550efb67adb6d01ba06ff1c478805b7754bcf08e5a0ee7cf860ce8b5fcb96bfaf
+  data.tar.gz: f2f5a2a8396d3a2b529c8684c77b015d9196ee2f278b18a5c0ebed510141b5b93cd2dd1889a001a9f67c0f480ac259dbfd99e5f737c6b8e1367f617c2d0f5b7e

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,26 +1,53 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative 'rslog/container'
-require_relative 'rslog/worker'
-require_relative 'rslog/opts'
-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/decorators'
+require_relative 'rslog/data_processing'
+require_relative 'rslog/parser'
+require_relative 'rslog/decorator'
 require_relative 'rslog/presenter'
+require 'set'
 
-# For development
-# require 'pry'
+module RSlog
+  VERSION = '0.0.19'
 
-class RSlog
-  VERSION = '0.0.14'
+  # Module to hold main process
+  #
+  module Main
+    extend RSlog::ArgsHandler
+    extend RSlog::Validator
 
-  def self.run
-    Container.new.process_all
+    def self.run
+      file_names_from_args(ARGV).each do |file_name|
+        puts "Statistics for file #{file_name}"
+
+        lines = IO.readlines(file_name)
+
+        validate(lines)
+
+        _process(lines)
+      end
+    end
+
+    def self._process(lines)
+      decorator = RSlog::Decorator.new(:utf)
+      _config_sets.each do |conf|
+        data_processing = RSlog::DataProcessing.new(lines, conf)
+        parsed_data = RSlog::Parser.new(data_processing).parse
+        RSlog::Presenter.new(parsed_data, conf, decorator).present
+      end
+    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,74 @@
+# frozen_string_literal: true
+
+module RSlog
+  # Class to parse options and arguments
+  #
+  # returns Array of file names
+  #
+  module ArgsHandler
+    #    attr_reader :args, :options
+    #
+    #    def initialize(args)
+    #      @args = args
+    #      @options = @args.select { |el| el =~ /^-/ }
+    #    end
+
+    def file_names_from_args(args)
+      @args = args
+      @options = @args.select { |el| el =~ /^-/ }
+      if @options.any? || @args.empty?
+        _handle_options
+        return []
+      end
+
+      # file_names array
+      file_names = @args - @options
+      return file_names if file_names.all? { |file_name| File.file?(file_name) }
+
+      puts 'There is no file names given. Check input.'
+      []
+    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/data_processing.rb

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

data/lib/rslog/decorator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module RSlog
+  # Class for load borders for table
+  #
+  class Decorator
+    FILE_PATH = 'lib/rslog/decorators.yml'
+
+    attr_reader :decorators
+
+    def initialize(coding = :utf)
+      @coding = String(coding)
+      @decorators = YAML.load_file(FILE_PATH)[@coding]
+      @decorators.each do |name, value|
+        instance_variable_set("@#{name}", value)
+        Decorator.attr_reader name.to_sym
+      end
+    end
+  end
+end

data/lib/rslog/decorators.yml

@@ -0,0 +1,21 @@
+---
+utf:
+  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"
+
+str:
+  left_up_corner:        "+"
+  right_up_corner:       "+"
+  left_down_corner:      "+"
+  right_down_corner:     "+"
+  vertical_border:       "|"
+  horizontal_border:     "-"
+  vertical_left_border:  "+"
+  vertical_right_border: "+"
+  

data/lib/rslog/parser.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RSlog
+  # Class to parse data
+  #
+  class Parser
+    attr_reader :data_processing
+
+    def initialize(data_processing)
+      @data_processing = data_processing
+    end
+
+    def parse
+      data_processing.extract.group.calculate.order.result
+    end
+  end
+end

data/lib/rslog/presenter.rb

@@ -1,32 +1,70 @@
 # frozen_string_literal: true
 
-require_relative 'tools/hash'
-require_relative 'tools/array'
+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
+    def initialize(source, conf, decorator)
+      @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'))
+      @decorator   = decorator || _default_decorator
+    end
 
-# Class to present result in needed format
-#
-class Presenter < Worker
-  include Decorators
+    def present
+      puts @title
+      puts _top_border
+      puts @decorator.vertical_border + _formatted_head_titles + @decorator.vertical_border
+      puts _middle_border
+      puts _formatted_data
+      puts _bottom_border
+      puts
+    end
 
-  attr_accessor :type
+    private
+    
+    def _default_decorator
+      RSlog::Decorator.new(:utf)      
+    end
 
-  def execute(type, formatter)
-    @type = type
-    container.add_message send("format_as_#{formatter}")
-    self
-  end
+    def _top_border
+      @decorator.left_up_corner + _horisontal_line + @decorator.right_up_corner
+    end
 
-  private
+    def _middle_border
+      @decorator.vertical_left_border + _horisontal_line + @decorator.vertical_right_border
+    end
 
-  def format_as_text
-    [
-      Decorators.send("#{type}_title"),
-      container.result.to_multiline_string(Decorators.send("#{type}_suffix")),
-      separator
-    ].join("\n")
-  end
+    def _bottom_border
+      @decorator.left_down_corner + _horisontal_line + @decorator.right_down_corner
+    end
+
+    def _horisontal_line
+      @decorator.horizontal_border * @col_size * @columns
+    end
+
+    def _formatted_head_titles
+      format(@formatter * @columns, *@head_titles)
+    end
 
-  def separator
-    '-----------------------------'
+    def _formatted_data
+      @source.map do |row|
+        row = row.map(&:to_s)
+        @decorator.vertical_border +
+          format(@formatter * @columns, *row).to_s +
+          @decorator.vertical_border
+      end
+    end
   end
 end

data/lib/rslog/validator.rb

@@ -1,30 +1,34 @@
 # 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 validate(source)
+      puts
+      puts MESSAGES[_valid?(source)].call(:ip)
+      puts
+    end
 
-  def execute
-    container.add_message MESSAGES[validate].call(container.validator)
-    self
-  end
-
-  private
+    private
 
-  def validate
-    return :valid if container.data.all? TEMPLATES[container.validator]
+    def _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.14
+  version: 0.0.19
 platform: ruby
 authors:
 - Andrey Eremeev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies: []
 description: Ruby script to get overall Statistic for weblog logs!
 email: a.eremeev@outlook.com
@@ -19,17 +19,13 @@ extra_rdoc_files: []
 files:
 - bin/rslog
 - lib/rslog.rb
-- lib/rslog/container.rb
-- lib/rslog/data_parser.rb
-- lib/rslog/decorators.rb
-- lib/rslog/extractor.rb
-- lib/rslog/input_parser.rb
-- lib/rslog/opts.rb
+- lib/rslog/args_handler.rb
+- lib/rslog/data_processing.rb
+- lib/rslog/decorator.rb
+- lib/rslog/decorators.yml
+- 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/decorators.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-# Class to present result in needed format
-#
-module Decorators
-  def self.all_title
-    'List of webpages with most page views ordered from most views to less'
-  end
-  def self.all_suffix
-    'visits'
-  end
-
-  def self.uniq_title
-    'List list of webpages with most unique page views also ordered'
-  end
-  
-  def self.uniq_suffix
-    'unique views'
-  end
-
-  def self.separator
-    '-----------------------------'
-  end
-end

data/lib/rslog/extractor.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-# Class for extracting data from file
-#
-class Extractor < Worker
-  def execute
-    check
-    self
-  end
-
-  private
-
-  def file_name
-    container.file_name
-  end
-
-  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,29 +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
-
-  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,45 +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}"
-    end
-  }.freeze
-
-  HELP = {
-    descr:  ['-h', '--help', 'Prints this message and exit'],
-    action: proc do |opts|
-      puts opts
-    end
-  }.freeze
-
-  def self.create_opts
-    OptionParser.new do |opts|
-      banner(opts)
-      help(opts)
-      version(opts)
-    end
-  end
-
-  def self.banner(opts)
-    opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} FILENAME"
-  end
-
-  def self.help(opts)
-    opts.on(*Opts::VERSION[:descr]) do
-      Opts::VERSION[:action].call
-      exit
-    end
-  end
-
-  def self.version(opts)
-    opts.on(*Opts::HELP[:descr]) do
-      Opts::HELP[:action].call(opts)
-      exit
-    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,15 +0,0 @@
-# frozen_string_literal: true
-
-# Class to hold worker functionality
-#
-class Worker
-  attr_reader :container
-
-  def initialize(container)
-    @container = container
-  end
-
-  def execute
-    raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
-  end
-end