log_analyzer 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4db64b0570b5c4460fe690d93e3b76e1863a1e7
-  data.tar.gz: a23f1ffeb8204b95450ee89727a4be33b38676bd
+  metadata.gz: ae28afd0313658e95cf16c50b1f9dc3a5ef5fe31
+  data.tar.gz: 72e12660b3efc9ed590784336db4cf71ebbeebd2
 SHA512:
-  metadata.gz: '08e24d953918afdd034d80cd2081c196f963239596c87e038fd1ee7b4d16acfaa3b434dde217f64cf7e877e1a7646fc33a0e31d00311726058c8477564657a0b'
-  data.tar.gz: ab6fc1ab6b6d1edcb22d05ed02641139064eb4929c61775d5499561873a2c7679893adead6276528ae782f12a14df1ff9cb9fb776183bb219c46105021e2b646
+  metadata.gz: 7ff772b58e8164658bdc961b5eece7fa8abd5db65206182b2cef96f1eb97763046e0484cfda2e71eeb5ff0cc2dbd181d1de674f03a159e625db8bca9b07cc795
+  data.tar.gz: c908a2abc1ca1084ba8a15ad570c7bd348768976ecc5b0983f31aa04a3aab8ac44993814a1f9f8d0e64f7ca14d06e9a53040ea337f7d5a6693b0b657e646376c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    log_analyzer (0.2.1)
+    log_analyzer (0.2.2)
       colorize
       rake
       terminal-table

data/README.md

@@ -48,6 +48,9 @@ Samples:
 * `log_analyzer -file log/production.log -sort count -filter view`
 * `log_analyzer -file log/production.log -sort count -filter partial`
 * `log_analyzer -file log/production.log -sort time -filter P`
+* `log_analyzer log/production.log --short`
+* `log_analyzer log/production.log -sp`
+* `log_analyzer -file log/production.log --short`
 * `log_analyzer --help`
 
 **Based on results you can get an idea what to optimize. For example optimizing most often rendering view could give huge benefit. Now with this tool you can find out what are the numbers.**
@@ -62,7 +65,14 @@ To install this gem on your local machine, run `bundle exec rake install`. To re
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/varyform/log_analyzer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/igorkasyanchuk/log_analyzer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Contributors
+
+Big thank you to all contributors:
+
+* @ck3g
+* @ritaritual
 
 ## TODO
 

data/bin/log_analyzer

@@ -23,17 +23,27 @@ parser = OptionParser.new do |opts|
     options[:filter] = v
   end
 
+  opts.on("-sp", "--short", "Shrink long paths") do |v|
+    options[:short] = v
+  end
+
   opts.on('-h', '--help', 'Displays Help') do
     puts opts
     exit
   end
 end
 
+# hack, because "log_analyzer production.log --short" not works but "-sp" works
+if i = ARGV.index("--short")
+  ARGV[i] = "-sp"
+end
+
 parser.parse!
 
-options[:file]     = ARGV[0] if ARGV.size == 1 # user first argument as filename
-options[:sort]   ||= :time # default order
-options[:filter] ||= :all  # default order
+options[:file]      = ARGV[0] if ARGV.size == 1 # user first argument as filename
+options[:sort]    ||= :time # default order
+options[:filter]  ||= :all  # default order
+options[:short]   ||= false
 
 LogAnalyzer::Configuration.configure do |config|
   config.filter = options[:filter]
@@ -45,7 +55,7 @@ if options[:file] && options[:sort]
   analyzer = LogAnalyzer.analyze(filename: options[:file])
   analyzer.run
   analyzer.order(by: options[:sort])
-  analyzer.visualize
+  analyzer.visualize(short: options[:short])
 else
   parser.parse! %w[--help]
-end
+end

data/lib/log_analyzer/analyzer.rb

@@ -2,12 +2,9 @@ module LogAnalyzer
 
   class Analyzer
     DEFAULT_TABLE_WIDTH = 120 # width
-    DANGER_DEFAULT      = 800 # ms
-    WARNING_DEFAULT     = 400 # ms
-    INFO_DEFAULT        = 100 # ms
+    CONTENT_LENGTH      = (0..DEFAULT_TABLE_WIDTH - 20).freeze
+    ROWS_FOR_FOOTER     = 10
     HEADER              = ['Type', 'View', 'Count', 'AVG (ms)', 'Max', 'Min'].freeze
-    PARTIAL_LABEL       = " P ".on_green.black.freeze
-    VIEW_LABEL          = " V ".on_yellow.black.freeze
     MATCHER             = /Rendered (.*\/.*) \((.*)ms\)/.freeze
 
     attr_reader :filename
@@ -23,13 +20,13 @@ module LogAnalyzer
         if line =~ MATCHER
           if $1 && $2
             view = $1
-            @stats[view] ||= Stat.new(type: find_type(view))
+            @stats[view] ||= Stat.new(type: Utils.find_type(view))
             @stats[view].push($2)
           end
         end
       end
     rescue Errno::ENOENT
-      puts "File <#{filename}> not found or not accessible.".red
+      puts "File <#{filename}> is not found or inaccessible.".red
       exit
     end
 
@@ -44,51 +41,44 @@ module LogAnalyzer
       end
     end
 
-    def visualize(limit: 100)
-      length  = (0..DEFAULT_TABLE_WIDTH - 20).freeze
-      filters = LogAnalyzer::Configuration.configuration.filters
-      table   = Terminal::Table.new \
-        headings: HEADER,
-        width: DEFAULT_TABLE_WIDTH do |t|
-          stats.each do |path, stat|
-            next unless filters.include?(stat.type)
-            t.add_row [
-              type_label(stat.type),
-              path[length],
-              stat.count,
-              avg_label(stat.avg),
-              stat.max,
-              stat.min,
-            ]
-          end
-          t.add_separator
-          t.add_row(HEADER)
-      end
-      puts table
-    end
+    def visualize(limit: 100, short: false)
+      table      = new_table
+      rows_count = 0
 
-    private
+      # preparing report
+      stats.each do |path, stat|
+        next unless LogAnalyzer.configuration.filters.include?(stat.type)
 
-      def find_type(view)
-        view.split('/'.freeze).last[0] == '_'.freeze ? 'P'.freeze : 'V'.freeze
-      end
+        table.add_row format_row(path, stat, short)
 
-      def type_label(type)
-        type == LogAnalyzer::Configuration::PARTIALS ? PARTIAL_LABEL : VIEW_LABEL
+        rows_count += 1
       end
 
-      def avg_label(avg)
-        str = avg.to_s
-        if avg > DANGER_DEFAULT
-          str.white.on_red
-        elsif avg > WARNING_DEFAULT
-          str.red
-        elsif avg > INFO_DEFAULT
-          str.yellow
-        else
-          str.green
-        end
+      # adding a footer
+      if rows_count > ROWS_FOR_FOOTER
+        table.add_separator
+        table.add_row(HEADER)
       end
 
+      puts(table)
+    end
+
+    private
+
+    def format_row(path, stat, short)
+      [
+        Utils.type_label(stat.type),
+        Utils.path_to_display(path, short: short, length: CONTENT_LENGTH),
+        stat.count,
+        Utils.avg_label(stat.avg),
+        stat.max,
+        stat.min,
+      ]
+    end
+
+    def new_table
+      Terminal::Table.new(headings: HEADER, width: DEFAULT_TABLE_WIDTH)
+    end
+
   end
-end
+end

data/lib/log_analyzer/configuration.rb

@@ -38,5 +38,4 @@ module LogAnalyzer
     end
 
   end
-
 end

data/lib/log_analyzer/path_shortener.rb

@@ -0,0 +1,34 @@
+module LogAnalyzer
+  class PathShortener
+    CHARS_TO_IGNORE = %w(.)
+    MAX_LENGTH = 80
+
+    def initialize(path, max: MAX_LENGTH)
+      @path = path
+      @max  = max
+    end
+
+    def self.shrink(path, max: MAX_LENGTH)
+      new(path, max: max).shrink
+    end
+
+    def shrink
+      return path if path.length < max
+
+      File.join(
+        File.dirname(path).split(File::SEPARATOR).map { |dir| short_name(dir) },
+        File.basename(path)
+      )
+    end
+
+    private
+
+    attr_reader :path, :max
+
+    def short_name(name)
+      first_char = name[0] || "" # avoid nils in directory names
+
+      CHARS_TO_IGNORE.include?(first_char) ? name[0..1] : first_char
+    end
+  end
+end

data/lib/log_analyzer/utils.rb

@@ -0,0 +1,48 @@
+module LogAnalyzer
+  class Utils
+    DANGER_DEFAULT      = 800 # ms
+    WARNING_DEFAULT     = 400 # ms
+    INFO_DEFAULT        = 100 # ms
+    DEFAULT_PATH_WIDTH  = 60
+    PARTIAL_LABEL       = " P ".on_green.black.freeze
+    VIEW_LABEL          = " V ".on_yellow.black.freeze
+
+    def Utils.find_type(view)
+      if view.split('/'.freeze).last[0] == '_'.freeze
+        LogAnalyzer::Configuration::PARTIALS
+      else
+        LogAnalyzer::Configuration::VIEWS
+      end
+    end
+
+    def Utils.type_label(type)
+      if type == LogAnalyzer::Configuration::PARTIALS
+        PARTIAL_LABEL
+      else
+        VIEW_LABEL
+      end
+    end
+
+    def Utils.avg_label(avg)
+      str = avg.to_s
+      if avg > DANGER_DEFAULT
+        str.white.on_red
+      elsif avg > WARNING_DEFAULT
+        str.red
+      elsif avg > INFO_DEFAULT
+        str.yellow
+      else
+        str.green
+      end
+    end
+
+    def Utils.path_to_display(path, short: false, length: DEFAULT_PATH_WIDTH)
+      if short
+        PathShortener.shrink(path, max: length.last)
+      else
+        path[length]
+      end
+    end
+
+  end
+end

data/lib/log_analyzer/version.rb

@@ -1,3 +1,3 @@
 module LogAnalyzer
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/log_analyzer.rb

@@ -2,11 +2,17 @@ require "terminal-table"
 require "colorize"
 require "log_analyzer/version"
 require "log_analyzer/configuration"
+require "log_analyzer/utils"
 require "log_analyzer/stat"
 require "log_analyzer/analyzer"
+require "log_analyzer/path_shortener"
 
 module LogAnalyzer
-  def self.analyze(filename:)
+  def LogAnalyzer.analyze(filename:)
     LogAnalyzer::Analyzer.new(filename: filename)
   end
+
+  def LogAnalyzer.configuration
+    LogAnalyzer::Configuration.configuration
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: log_analyzer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Igor Kasyanchuk
@@ -139,7 +139,9 @@ files:
 - lib/log_analyzer.rb
 - lib/log_analyzer/analyzer.rb
 - lib/log_analyzer/configuration.rb
+- lib/log_analyzer/path_shortener.rb
 - lib/log_analyzer/stat.rb
+- lib/log_analyzer/utils.rb
 - lib/log_analyzer/version.rb
 - log_analyzer.gemspec
 homepage: https://github.com/igorkasyanchuk