sql_reporter 0.10.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6f986dc946bf53f6bc27bb59019cce13ccbcf52d2b91d80f7893a966c4fdc737
+  data.tar.gz: 740bf0c3e7c8dc428ccba73d35e945174a5cf378c88d9ca7e0795c1efb1a59b1
+SHA512:
+  metadata.gz: a79e634a5470eada47d5cc643e610c54e05e770688987fe349b65ed7d9b34b55c157d98d2b567fe5617f176ccbd9718db08d766e315d448d1b981c1e5556134d
+  data.tar.gz: c7f610440bdd33eedee6d076a001c26ae160be1ff02c77c13f43caa712142355331bd5f6a0c0d8cfd1a75879d78295d6a33bc0b974b86515fc7991f3f97a2e2c

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+.bundle
+comparison.*
+samples/*
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.TXT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 JanTaras29
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+## What this is?
+
+This is a gem that can be used for comparing reports generated by excellent [sql_tracker](https://github.com/steventen/sql_tracker) gem for different branches. It can be useful for detecting SQL queries regressions or optimisation opportunities.
+
+## Setup
+
+Simply run the following in terminal while in the repo directory (temporary solution while not in rubygems.org)
+```
+gem build sql_reporter.gemspec
+gem install sql_reporter
+```
+
+or if you are using Bundler
+```
+bundle
+```
+
+## Usage
+
+`sql_reporter original_branch.json improved_branch.json` 
+
+
+The above will generate a comparison.log file with content akin to:
+```
+SQL Count Decreases between samples/master.json -> samples/637.json
+##########################################################
+
+Queries killed: 0
+
+Duration decrease[ms]: 0.0
+
+SQL Count Increases between samples/master.json -> samples/637.json
+##########################################################
+
+Queries killed: 0
+
+Duration decrease[ms]: 0.0
+
+SQL Spawned between samples/master.json -> samples/637.json
+##########################################################
++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+-------------------------------------+
+|Query                                                                                                                                                                                                                                 |Count difference             |Duration difference [ms]             |
++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+-------------------------------------+
+|SELECT `apples`.* FROM `apples` WHERE `apples`.`apple_id` = xxx AND `apples`.`locale` = xxx AND `appler`.`apple_type` IN (xxx)             |0 -> 1                       |0.0 -> 1.76                          |
++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------+-------------------------------------+
+Queries spawned: 1
+
+Duration gain[ms]: 1.76
+
+SQL Gone between samples/master.json -> samples/637.json
+##########################################################
++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+--------------------+
+|Query                                                                                                                                                                                                                                                                   |Count diff… |Duration differenc… |
++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+--------------------+
+|SELECT `apples`.* FROM `apples` WHERE `apples`.`apple_id` = xxx AND `apples`.`apple_type` = xxx AND `apples`.`locale` = xxx ORDER BY `email_default_messages`.`id` ASC LIMI… |7 -> 0      |13.78 -> 0.0        |
++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+--------------------+
+Queries killed: 7
+
+Duration decrease[ms]: 13.78
+
+################## SUMMARY #####################
+
+Queries killed: 6
+
+Duration decrease[ms]: 12.02
+```

data/bin/sql_reporter

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'sql_reporter'
+
+begin
+  SqlReporter::ReporterFactory.new.for_format.generate_report
+rescue StandardError => e
+  STDERR.puts('[ERROR] Unexpected Error occured')
+  puts e.message
+  puts e.backtrace
+end

data/lib/sql_reporter.rb

@@ -0,0 +1,7 @@
+require 'sql_reporter/query'
+require 'sql_reporter/total'
+require 'sql_reporter/parser'
+require 'sql_reporter/difference'
+require 'sql_reporter/reporters/reporters'
+require 'sql_reporter/reporter_factory'
+require 'sql_reporter/version'

data/lib/sql_reporter/difference.rb

@@ -0,0 +1,28 @@
+module SqlReporter
+  # Difference between 2 Query objects
+  class Difference
+    attr_reader :master, :feature, :query_name
+
+    def initialize(name, master, feature)
+      @query_name = name
+      @master = master
+      @feature = feature
+    end
+
+    def delta_count
+      (feature - master).count
+    end
+
+    def delta_cached_count
+      (feature - master).cached_count
+    end
+
+    def delta_time
+      (feature - master).duration_formatted
+    end
+
+    def sort_score(max_count)
+      (master - feature).count.abs + master.post_decimal_score(max_count)
+    end
+  end
+end

data/lib/sql_reporter/parser.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'optparse'
+
+module SqlReporter
+  class Parser
+    def self.parse
+      options = {}
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: sql_reporter [options] file.json file2.json'
+
+        opts.on('-f', '--format FORMAT', String, 'Format of the output file (defaults to pdf, avaliable formats: log , json, png, pdf, xls )') do |f|
+          options[:format] = f
+        end
+
+        opts.on('--disable-console', 'Disable outputting the report to terminal') do |f|
+          options[:disable_console] = true
+        end
+
+        opts.on('-o', '--output FILE', String, 'File to write the report to - without extension') do |o|
+          options[:output] = o
+        end
+
+        opts.on_tail('--version', 'Show version') do
+          puts SqlReporter::VERSION
+          exit
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          puts opts
+          exit
+        end
+      end.parse!
+
+      unless ARGV.size == 2
+        STDERR.puts "[ERROR] Incorrect number of parameters passed (2 files required)"
+        exit(1)
+      end
+
+      begin
+        f0 = File.read(ARGV[0])
+        f1 = File.read(ARGV[1])
+      rescue StandardError => e
+        puts e.message
+        exit(1)
+      end
+  
+      begin
+        master = JSON.load(f0)['data'].values.map do |v| 
+          [v['sql'], SqlReporter::Query.new(v['sql'], v['count'], v['duration'] || 0, v['cached_count'] || 0)]
+        end.to_h
+        feature = JSON.load(f1)['data'].values.map do |v| 
+          [v['sql'], SqlReporter::Query.new(v['sql'], v['count'], v['duration'] || 0, v['cached_count'] || 0)]
+        end.to_h
+      rescue JSON::ParserError
+        STDERR.puts 'One of the files provided is not a correctly formatted JSON file'
+        exit(1)
+      end
+
+      master_key = ARGV[0]
+      feature_key = ARGV[0] == ARGV[1] ? ARGV[0] + '_copy' : ARGV[1]
+
+      { master_key => master, feature_key => feature, format: options[:format] }.merge(options)
+    end
+  end
+end

data/lib/sql_reporter/query.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Data struct for keeping the query data
+module SqlReporter
+  class Query
+    attr_accessor :sql, :count, :duration, :cached_count
+
+    def self.null(query_name)
+      self.new(query_name, 0, 0, 0)
+    end
+
+    def initialize(s, c, d, cc)
+      @sql = s
+      @count = c
+      @duration = d
+      @cached_count = cc
+    end
+
+    def +(other)
+      self.class.new(sql, count + other.count, duration + other.duration, cached_count + other.cached_count)
+    end
+
+    def -(other)
+      self.class.new(sql, count - other.count, duration - other.duration, cached_count - other.cached_count)
+    end
+
+    def post_decimal_score(max_count)
+      count * (1 / (max_count + 1))
+    end
+
+    def duration_formatted
+      duration&.round(2)
+    end
+  end
+end

data/lib/sql_reporter/reporter_factory.rb

@@ -0,0 +1,46 @@
+module SqlReporter
+  class ReporterFactory
+    attr_reader :parser_hsh
+
+    def initialize
+      @parser_hsh = SqlReporter::Parser.parse
+    end
+
+    def for_format
+      case parser_hsh[:format]
+      when 'log'
+        log_reporter
+      when 'json'
+        json_reporter
+      when 'png'
+        plot_reporter
+      when 'pdf'
+        pdf_reporter
+      when 'xls'
+        excel_reporter
+      else
+        pdf_reporter
+      end
+    end
+
+    def log_reporter
+      SqlReporter::Reporters::LogReporter.new(parser_hsh)
+    end
+
+    def json_reporter
+      SqlReporter::Reporters::JsonReporter.new(parser_hsh)
+    end
+
+    def plot_reporter
+      SqlReporter::Reporters::PlotReporter.new(parser_hsh)
+    end
+
+    def pdf_reporter
+      SqlReporter::Reporters::PdfReporter.new(parser_hsh)
+    end
+
+    def excel_reporter
+      SqlReporter::Reporters::ExcelReporter.new(parser_hsh)
+    end
+  end
+end

data/lib/sql_reporter/reporters/excel_reporter.rb

@@ -0,0 +1,71 @@
+#frozen_string_literal: true
+require 'spreadsheet'
+
+module SqlReporter
+	module Reporters
+		class ExcelReporter < LogReporter
+			EXTENSION = '.xls'
+			HEADERS = ['Query', 'Count [master]', 'Count [feature]', 'Total time [master]', 'Total time [feature]']
+
+			attr_reader :totals
+
+			protected
+
+			def generate_summary(totals, **kwargs)
+				@totals = totals
+			end
+
+			def generate_query_line(diff)
+				lines << diff
+			end
+
+			def before_generate_report
+				@lines = []
+			end
+
+			def after_generate_report
+				@totals = totals
+				@lines = lines.sort_by {|d| d.sort_score(master_max_count) }.reverse
+				book = Spreadsheet::Workbook.new
+				sheet = book.create_worksheet(name: "Comparison Report #{fname0} -> #{fname1}") 
+				sheet.row(0).concat HEADERS
+				lines.each_with_index do |l, i|
+					sheet.row(i + 1).concat [l.query_name, l.master.count, l.feature.count, l.master.duration_formatted, l.feature.duration_formatted]
+				end
+				totals_row_no = lines.size + 1
+				accumulated_row = totals_row_no + 2
+				sheet[totals_row_no, 0] = 'Totals:'
+				sheet[totals_row_no, 1] = lines.reduce(0) {|acc, l| acc + l.master.count }
+				sheet[totals_row_no, 2] = lines.reduce(0) {|acc, l| acc + l.feature.count }
+				sheet[totals_row_no, 3] = lines.reduce(0) {|acc, l| acc + l.master.duration_formatted }
+				sheet[totals_row_no, 4] = lines.reduce(0) {|acc, l| acc + l.feature.duration_formatted }
+				sheet[accumulated_row, 1] = 'Count Increase:'
+				sheet[accumulated_row, 2] = sheet[totals_row_no, 2] - sheet[totals_row_no, 1]
+				sheet[accumulated_row, 3] = 'Time Increase:'
+				sheet[accumulated_row, 4] = sheet[totals_row_no, 4] - sheet[totals_row_no, 3]
+
+				bold = Spreadsheet::Format.new(weight: :bold)
+				[totals_row_no, accumulated_row].each do |row|
+					5.times { |x| sheet.row(row).set_format(x, bold) }
+				end
+				book.write "./#{output_file}"
+			end
+
+			def before_increases
+			end
+
+			def before_decreases
+			end
+
+			def before_gone
+			end
+
+			def before_spawned
+			end
+
+			def before_summary
+			end
+			
+		end
+	end
+end

data/lib/sql_reporter/reporters/json_reporter.rb

@@ -0,0 +1,57 @@
+module SqlReporter
+  module Reporters
+    class JsonReporter < Reporter
+      EXTENSION = '.json'
+
+      attr_reader :lines, :title, :body
+
+      protected
+
+      def generate_summary(totals, **kwargs)
+        hsh = { count_increase: totals.query_diff , duration_increase: totals.duration_diff.round(2) }
+        hsh[:queries] = lines unless lines.empty?
+        body[title] = hsh
+        @lines = []
+      end
+
+      def generate_query_line(diff)
+        hsh = {
+          name: diff.query_name,
+          count: {before: diff.master.count, after: diff.feature.count},
+          duration: {before: diff.master.duration_formatted, after: diff.feature.duration_formatted}
+        }
+        lines << hsh
+      end
+
+      def before_generate_report
+        @lines = []
+        @body = {}
+      end
+
+      def after_generate_report
+        io.write(body.to_json)
+        io.close
+      end
+
+      def before_increases
+        @title = 'increases'
+      end
+
+      def before_decreases
+        @title = 'decreases'
+      end
+
+      def before_gone
+        @title = 'gone'
+      end
+
+      def before_spawned
+        @title = 'spawned'
+      end
+
+      def before_summary
+        @title = 'total'
+      end
+    end
+  end
+end

data/lib/sql_reporter/reporters/log_reporter.rb

@@ -0,0 +1,89 @@
+#frozen_string_literal: true
+
+require 'tty-table'
+
+module SqlReporter
+	module Reporters
+		class LogReporter < Reporter
+			EXTENSION = '.log'
+			HEADERS = ['Query', 'Count difference', 'Cached SQLs difference', 'Duration difference [ms]']
+
+			attr_reader :lines
+
+			protected
+
+			def generate_summary(totals, **kwargs)
+				table = TTY::Table.new(HEADERS, lines).render(
+					:ascii,
+					column_widths: [100, 40, 40, 40],
+					multiline: true,
+					resize: true,
+				)
+				io.write(table)
+				io.write("Queries reduced: #{kwargs[:reduced]}\n") if kwargs.key? :reduced
+				io.write("Queries spawned: #{kwargs[:spawned]}\n") if kwargs.key? :spawned
+				io.write(totals.summary)
+				@lines = []
+			end
+
+			def generate_query_line(diff)
+				lines << [diff.query_name, "#{diff.master.count} -> #{diff.feature.count}", "#{diff.master.cached_count} -> #{diff.feature.cached_count}", "#{diff.master.duration_formatted} -> #{diff.feature.duration_formatted}"]
+			end
+
+			def before_generate_report
+				@lines = []
+			end
+
+			def after_generate_report
+				io.close
+			end
+
+			def before_increases
+				print_header('Count Increases')
+			end
+
+			def before_decreases
+				print_header('Count Decreases')
+			end
+
+			def before_gone
+				print_header('Gone')
+			end
+
+			def before_spawned
+				print_header('Spawned')
+			end
+
+			def before_summary
+				io.write("################## SUMMARY #####################\n\n")
+			end
+
+			def setup_io
+				@io = Class.new do
+					attr_reader :file, :console_disabled
+
+					def initialize(file, disable_console = false)
+						@file = File.open(file, "w")
+						@console_disabled = disable_console
+					end
+
+					def write(content)
+						file.write(content)
+						STDOUT.write(content) unless console_disabled
+					end
+
+					def close
+						file.close
+					end
+				end.new(output_file, disable_console)
+      end
+			
+			private
+
+			def print_header(header_name)
+				io.write("SQL #{header_name} between #{fname0} -> #{fname1}\n")
+				io.write("##########################################################\n")
+			end
+		end
+	end
+end

data/lib/sql_reporter/reporters/pdf_reporter.rb

@@ -0,0 +1,37 @@
+require 'prawn'
+
+module SqlReporter
+  module Reporters
+    class PdfReporter< Reporter
+      EXTENSION = '.pdf'
+
+      attr_reader :plot_report, :table_report
+
+      def initialize(parser_hsh)
+        super(parser_hsh)
+        @table_report = SqlReporter::Reporters::PdfTableReporter.new(parser_hsh)
+        @plot_report = SqlReporter::Reporters::PlotReporter.new(parser_hsh)
+      end
+
+      def after_generate_report
+        table_report.generate_report
+        plot_report.generate_report
+        Prawn::Document.generate(output_file) do |pdf|
+          pdf.font_size(20) { pdf.text "Comparison report of #{@fname0} -> #{@fname1}", align: :center, styles: [:bold] }
+          pdf.move_down 20
+          pdf.text 'Count changes:'
+          pdf.move_down 10
+          pdf.image @plot_report.output_file, position: :center, scale: 0.8
+          pdf.move_down 10
+          pdf.text 'Timing changes:'
+          pdf.move_down 10
+          pdf.image('time_' + @plot_report.output_file, position: :center, scale: 0.8)
+          pdf.start_new_page
+          pdf.font_size(25) { pdf.text 'Summary', align: :center, styles: [:bold] }
+          pdf.move_down 10
+          table_report.produce_table(pdf)
+         end
+      end
+    end
+  end
+end

data/lib/sql_reporter/reporters/pdf_table_reporter.rb

@@ -0,0 +1,51 @@
+#frozen_string_literal: true
+require 'prawn/table'
+
+module SqlReporter
+	module Reporters
+		class PdfTableReporter < LogReporter
+
+			attr_reader :totals
+
+			def produce_table(pdf_context)
+				t = pdf_context.make_table([HEADERS, *lines])
+				t.draw
+				pdf_context.move_down(20)
+				pdf_context.font_size(12) { pdf_context.text(totals.summary, styles: [:bold]) }
+			end
+
+			protected
+
+			def generate_summary(totals, **kwargs)
+				@totals = totals 
+			end
+
+			def generate_query_line(diff)
+				lines << [diff.query_name, "#{diff.master.count} -> #{diff.feature.count}", "#{diff.master.duration_formatted} -> #{diff.feature.duration_formatted}"]
+			end
+
+			def before_generate_report
+				@lines = []
+			end
+
+			def after_generate_report
+			end
+
+			def before_increases
+			end
+
+			def before_decreases
+			end
+
+			def before_gone
+			end
+
+			def before_spawned
+			end
+
+			def before_summary
+			end
+			
+		end
+	end
+end

data/lib/sql_reporter/reporters/plot_reporter.rb

@@ -0,0 +1,45 @@
+require 'gruff'
+
+module SqlReporter
+  module Reporters
+    class PlotReporter < Reporter
+      EXTENSION = '.png'
+
+      attr_reader :count_plot, :time_plot,  :diffs
+
+      protected
+
+      def before_generate_report
+        @count_plot = Gruff::Bar.new(400)
+        @time_plot = Gruff::Bar.new(400)
+        @diffs = []
+        count_plot.title = "Count #{fname0} > #{fname1}"
+        count_plot.marker_count = 0
+        count_plot.show_labels_for_bar_values = true
+        time_plot.title = "Timing #{fname0} > #{fname1}"
+        time_plot.marker_count = 0
+        time_plot.show_labels_for_bar_values = true
+      end
+      
+      def generate_query_line(diff)
+        diffs << diff
+      end
+
+      def after_generate_report
+        instert_plot_data(count_plot, :count)
+        instert_plot_data(time_plot, :duration_formatted)
+        count_plot.write(output_file)
+        time_plot.write('time_' + output_file)
+      end
+
+      private
+
+      def instert_plot_data(plot, method)
+        diffs.each do |diff|
+          plot.data(diff.query_name[0..20] + ' BEFORE', diff.master.public_send(method), '#990000')
+          plot.data(diff.query_name[0..20] + ' AFTER', diff.feature.public_send(method), '#000099')
+        end
+      end
+    end
+  end
+end

data/lib/sql_reporter/reporters/reporter.rb

@@ -0,0 +1,125 @@
+module SqlReporter
+  module Reporters
+    class Reporter
+      EXTENSION=''
+
+      def initialize(parser_hsh)
+        @fname0, @master = parser_hsh.entries[0]
+        @fname1, @feature = parser_hsh.entries[1]
+        @master_max_count = @master.values.map(&:count).max
+        @output = parser_hsh[:output] if parser_hsh.key?(:output)
+        @disable_console = parser_hsh[:disable_console] if parser_hsh.key?(:disable_console)
+      end
+    
+      attr_accessor :master, :feature, :fname0, :fname1, :output, :io
+      attr_reader :master_max_count, :disable_console
+
+      def generate_report
+        setup_io
+        before_generate_report
+        totals = []
+        
+        before_decreases
+        totals << summary_for_selected_differences(master.keys | feature.keys) do |key| 
+          master[key] && feature[key] && (
+            master[key].count > feature[key].count || (master[key].count == feature[key].count &&  master[key].cached_count > feature[key].cached_count)
+          )
+        end
+
+        before_increases
+        totals << summary_for_selected_differences(master.keys | feature.keys) do |key|
+          master[key] && feature[key] && (
+            master[key].count < feature[key].count || (master[key].count == feature[key].count && master[key].cached_count < feature[key].cached_count)
+          )
+        end
+
+        before_spawned
+        totals << summary_for_selected_differences(feature.keys - master.keys) { |key| feature[key] }
+
+        before_gone
+        totals << summary_for_selected_differences(master.keys - feature.keys) { |key| master[key] }
+
+        before_summary
+        totals_sum = totals.reduce(SqlReporter::Total.new(0,0,0)) {|acc, t| acc + t}
+        additional_data = {}
+        additional_data[:reduced] = totals.reduce(0) {|acc, t| acc + t.query_drop}
+        additional_data[:spawned] = totals.reduce(0) {|acc, t| acc + t.query_gain}
+        generate_summary(totals_sum, **additional_data)
+        after_generate_report
+        print_success_message
+      end
+
+      def output_file
+        (output || 'comparison') + self.class::EXTENSION
+      end
+
+      protected
+
+      def generate_summary(totals, **kwargs)
+      end
+    
+      def generate_query_line(diff)
+      end
+
+      def summary_for_selected_differences(collection, &block)
+        duration_diff = 0
+        cached_count_diff = 0
+        count_diff = 0
+        process_differences(collection, &block).each do |diff|
+          generate_query_line(diff)
+          count_diff += diff.delta_count
+          cached_count_diff += diff.delta_cached_count
+          duration_diff += diff.delta_time
+        end
+        totals = SqlReporter::Total.new(count_diff, duration_diff, cached_count_diff)
+        generate_summary(totals)
+        totals
+      end
+    
+      def process_differences(collection)
+        prefiltered_collection = collection.select { |key| yield(key) }
+        differences = prefiltered_collection.map do |key| 
+          construct_difference_object(key)
+        end
+        differences.sort_by {|d| d.sort_score(master_max_count) }.reverse
+      end
+    
+      def construct_difference_object(key)
+        m = master[key] || SqlReporter::Query.null(key)
+        f = feature[key] || SqlReporter::Query.null(key)
+        SqlReporter::Difference.new(key, m, f)
+      end
+
+      def before_generate_report
+      end
+
+      def after_generate_report
+      end
+
+      def before_increases
+      end
+
+      def before_decreases
+      end
+
+      def before_gone
+      end
+
+      def before_spawned
+      end
+
+      def before_summary
+      end
+
+      def setup_io
+        @io = File.open(output_file, "w")
+      end
+
+      private
+
+      def print_success_message
+        puts "[Comparison Successful] Comparison report written to: #{`pwd`.strip + '/' + output_file}"
+      end
+    end
+  end
+end

data/lib/sql_reporter/reporters/reporters.rb

@@ -0,0 +1,7 @@
+require 'sql_reporter/reporters/reporter'
+require 'sql_reporter/reporters/log_reporter'
+require 'sql_reporter/reporters/json_reporter'
+require 'sql_reporter/reporters/plot_reporter'
+require 'sql_reporter/reporters/pdf_table_reporter'
+require 'sql_reporter/reporters/pdf_reporter'
+require 'sql_reporter/reporters/excel_reporter'

data/lib/sql_reporter/total.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module SqlReporter
+  class Total
+    attr_accessor :query_diff, :cached_query_diff, :duration_diff
+    def initialize
+      @query_diff = 0
+      @duration_diff = 0
+      @cached_query_diff = 0
+    end
+
+    def initialize(query, duration, cached)
+      @query_diff = query
+      @duration_diff = duration
+      @cached_query_diff = cached
+    end
+
+    def query_gain
+      query_diff > 0 ? query_diff : 0
+    end
+
+    def query_drop
+      query_diff > 0 ? 0 : -query_diff
+    end
+
+    def queries_msg
+      "\nQueries count change: #{query_diff}\n" 
+    end
+
+    def duration_msg
+      "\nDuration #{duration_diff > 0 ? 'gain' : 'decrease' }[ms]: #{duration_diff.abs.round(2)}\n"
+    end
+
+    def summary
+       queries_msg + duration_msg + "\n"
+    end
+
+    def +(total)
+      self.class.new(query_diff + total.query_diff, duration_diff + total.duration_diff, cached_query_diff + total.cached_query_diff)
+    end
+  end
+end

data/lib/sql_reporter/version.rb

@@ -0,0 +1,3 @@
+module SqlReporter
+  VERSION= '0.10.1'.freeze
+end

data/sql_reporter.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sql_reporter/version'
+
+Gem::Specification.new do |spec|
+  spec.authors       = ["Jan Taras"]
+  spec.email         = ["jan.taras29@gmail.com"]
+  spec.name          = "sql_reporter"
+  spec.version       = SqlReporter::VERSION
+  spec.date          = "2019-07-12"
+  spec.summary       = "Supplementary Gem to sql_tracker allowing you to compare query data bewteen files"
+  spec.homepage      = 'https://github.com/JanTaras29/sql_reporter'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['sql_reporter']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('tty-table', '0.10.0')
+  spec.add_dependency('gruff', '0.7.0')
+  spec.add_dependency('prawn', '2.2.0')
+  spec.add_dependency('prawn-table', '0.2.2')
+  spec.add_dependency('spreadsheet', '1.2.4')
+  spec.add_development_dependency('pry')
+end
+

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: sql_reporter
+version: !ruby/object:Gem::Version
+  version: 0.10.1
+platform: ruby
+authors:
+- Jan Taras
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: gruff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: prawn-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: 
+email:
+- jan.taras29@gmail.com
+executables:
+- sql_reporter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.TXT
+- README.md
+- bin/sql_reporter
+- lib/sql_reporter.rb
+- lib/sql_reporter/difference.rb
+- lib/sql_reporter/parser.rb
+- lib/sql_reporter/query.rb
+- lib/sql_reporter/reporter_factory.rb
+- lib/sql_reporter/reporters/excel_reporter.rb
+- lib/sql_reporter/reporters/json_reporter.rb
+- lib/sql_reporter/reporters/log_reporter.rb
+- lib/sql_reporter/reporters/pdf_reporter.rb
+- lib/sql_reporter/reporters/pdf_table_reporter.rb
+- lib/sql_reporter/reporters/plot_reporter.rb
+- lib/sql_reporter/reporters/reporter.rb
+- lib/sql_reporter/reporters/reporters.rb
+- lib/sql_reporter/total.rb
+- lib/sql_reporter/version.rb
+- sql_reporter.gemspec
+homepage: https://github.com/JanTaras29/sql_reporter
+licenses:
+- MIT
+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.3
+signing_key: 
+specification_version: 4
+summary: Supplementary Gem to sql_tracker allowing you to compare query data bewteen
+  files
+test_files: []