index_checker 1.0.16

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84bb597577a845fb06c0c4db1569bab68b637d9d84d2643a276065d70276a63e
+  data.tar.gz: a6f10a3ea0d786f49fd6f24946e87f0fb3ea9cb3619556491592e2c9f1db553a
+SHA512:
+  metadata.gz: 825daf6370e0213940007174aa2e341ae3c52406ba0f084f647f8bcc1beb0214a819a38fa27f3a8723520bbc36820ed5404eaf844249713d197744274fa2b193
+  data.tar.gz: a4a4de2c18f05370aacdd2e3a6425c68354e7a6acd00a91f555e5be3abbcf060620ec2f4373ca34034d6d0c9b935fd2e5fcb778fd625a646e58240135ba25bb6

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+group :test do
+  gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]
+end
+
+gemspec

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake'
+
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommended for running the tests'
+end
+
+task default: :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end

data/index_checker.gemspec

@@ -0,0 +1,28 @@
+require File.expand_path('lib/index_checker/version', __dir__)
+
+Gem::Specification.new do |s|
+  s.name        = 'index_checker'
+  s.version     = IndexChecker::VERSION
+  s.summary     = 'Index Checker'
+  s.description = 'A simple ruby gem for view statistic information abount index'
+  s.authors     = ['Lê Đức Hoà']
+  s.email       = 'leduchoabatr12@gmail.com'
+  s.files       = Dir['lib/report_template.html.erb', 'lib/**/*.rb', 'lib/**/*.rake', 'index_checker.gemspec',
+                      'Gemfile', 'Rakefile']
+  s.homepage    =
+    'https://github.com/dontregret9/index_checker'
+  s.license = 'MIT'
+
+  s.add_dependency 'erb', '~> 4.0'
+  s.add_dependency 'launchy', '~> 2.5'
+  s.add_dependency 'pg', '~> 1.1'
+
+  s.add_development_dependency 'rails', '~> 6.0.3'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rspec-rails', '~> 4.0'
+  s.add_development_dependency 'rubocop', '~> 0.60'
+  s.add_development_dependency 'rubocop-performance', '~> 1.5'
+  s.add_development_dependency 'rubocop-rspec', '~> 1.37'
+  s.add_development_dependency 'simplecov', '~> 0.1'
+  s.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/generators/index_checker/initialize_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module IndexChecker
+  module Generators
+    class InitializeGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      desc 'Creates a IndexChecker config file'
+      def copy_config
+        file_path = "#{Rails.root}/config/index_checker.rb"
+        return if File.file?(file_path)
+
+        template 'index_checker_config.rb', file_path
+      end
+
+      desc 'Create a IndexChecker folder'
+      def create_initializer_file
+        file_path = "#{Rails.root}/index_checker/general_report.html"
+        return if File.file?(file_path)
+
+        create_file file_path,
+                    'Result of rake index_checker::analysis will be shown here ...'
+      end
+    end
+  end
+end

data/lib/generators/templates/index_checker_config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'index_checker'
+
+IndexChecker.config do |c|
+
+  # dbname  : required
+  # Database name is required
+  c.dbname = 'database-to-analysis'
+
+
+  # user    : optional.
+  # If the `user` is not provided, it will be the default user (same name as your OS name)
+  # c.user = 'your-postgres-username'
+
+
+  # password: optional
+  # The password just requires if your (Postgres) user authenticates by `md5` method, that is optional for other authentication methods: `trust` or `peer`. Your postgres config in pg_hba.config
+  # c.password = 'your-password' 
+
+
+  # rdbms   : default  
+  # This configuration is default. IndexChecker just support PostgresSQL for now!
+
+  # c.rdbms = 'postgresql'
+
+end

data/lib/index_checker/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module IndexChecker
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/index_checker_tasks.rake'
+    end
+  end
+end

data/lib/index_checker/task_definition/base.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module IndexChecker
+  module TaskDefinition
+    class Base
+      class << self
+        def postgres_connection
+          dbname = IndexChecker.dbname
+          user = IndexChecker.user
+          password = IndexChecker.password
+
+          puts "You are connecting to #{dbname} database as #{user} role"
+          begin
+            PG.connect(dbname: dbname, user: user, password: password)
+          rescue Exception => e
+            puts e
+          end
+        end
+
+        def write_results_to_file
+          template = File.read(result_template_path)
+          html_result = ERB.new(template).result(binding)
+
+          File.write(result_file_path, html_result)
+        end
+
+        def open_file_in_browser(path)
+          Launchy.open(path)
+        end
+
+        def result_template_path
+          "#{gem_root_path}lib/report_template.html.erb"
+        end
+
+        def result_file_path
+          "#{Rails.root}/index_checker/general_report.html"
+        end
+
+        def gem_root_path
+          __FILE__.gsub('lib/index_checker/task_definition/base.rb', '')
+        end
+      end
+    end
+  end
+end

data/lib/index_checker/task_definition/general_report.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module IndexChecker
+  module TaskDefinition
+    class GeneralReport < Base
+      GET_INFO_QUERY = "SELECT tbls_stat.relname, tbls_stat.seq_scan, tbls_stat.idx_scan, (tbls_stat.seq_tup_read + tbls_stat.idx_tup_fetch) as read_actions, (tbls_stat.n_tup_ins + tbls_stat.n_tup_upd + tbls_stat.n_tup_del) as write_actions,
+                          idx_stat.indexrelname, pg_relation_size(idx_stat.indexrelid) AS idx_size
+                        FROM pg_stat_all_tables AS tbls_stat INNER JOIN pg_stat_user_indexes AS idx_stat ON tbls_stat.relid = idx_stat.relid
+                        WHERE tbls_stat.relname NOT LIKE 'pg_%'
+                        ORDER BY tbls_stat.idx_scan ASC, tbls_stat.seq_scan DESC"
+
+      def self.generate!
+        connection = postgres_connection
+        return if connection.nil?
+
+        @results = connection.exec(GET_INFO_QUERY)
+
+        write_results_to_file
+        open_file_in_browser(result_file_path)
+      rescue PG::Error => e
+        puts e.message
+      ensure
+        connection&.close
+      end
+    end
+  end
+end

data/lib/index_checker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IndexChecker
+  VERSION = '1.0.16'.freeze
+end

data/lib/index_checker.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'pg'
+require 'erb'
+require 'launchy'
+
+module IndexChecker
+  class << self
+    attr_accessor :rdbms, :dbname, :user, :password
+
+    def config
+      yield self
+    end
+  end
+end
+
+require_relative 'index_checker/railtie' if defined?(Rails)

data/lib/report_template.html.erb

@@ -0,0 +1,49 @@
+<HTML>
+<HEAD>
+  <style>
+    th {
+      margin-top: 50px;
+    }
+
+    td {
+      height: 3rem;
+      margin: 20px;
+      padding: 0 20px;
+    }
+
+    tr:nth-child(odd) {
+      background-color: #f2f5fa;
+    }
+
+    tr:nth-child(even) {
+      background-color: rgba(242, 245, 250, .5)
+    }
+  </style>
+</HEAD>
+<BODY>
+  <table>
+    <tr>
+      <tr>
+        <th> Table Name </th>
+        <th> Index Name </th>
+        <th style="width: 150px"> Write actions </th>
+        <th style="width: 150px"> Read actions </th>
+        <th style="width: 150px"> Sequence Scan </th>
+        <th style="width: 150px"> Index Scan </th>
+        <th style="width: 150px"> Index Size </th>
+      </tr>
+    </tr>
+    <% @results.each do |r| %>
+      <tr>
+        <td> <%= r['relname'] %> </td>
+        <td> <%= r['indexrelname']%></td>
+        <td style="width: 100px; text-align: center"> <%= r['write_actions'] %> </td>
+        <td style="width: 100px; text-align: center"> <%= r['read_actions'] %> </td>
+        <td style="width: 100px; text-align: center"> <%= r['seq_scan'] %> </td>
+        <td style="width: 100px; text-align: center"> <%= r['idx_scan'] %> </td>
+        <td style="width: 100px; text-align: center"> <%= r['idx_size'] %> </td>
+      </tr>
+    <% end %>
+  </table>
+</BODY>
+</HTML>

data/lib/tasks/index_checker_tasks.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rake'
+require_relative '../index_checker/task_definition/base'
+require_relative '../index_checker/task_definition/general_report'
+require "#{Rails.root}/config/index_checker"
+
+namespace :index_checker do
+  task :analysis do
+    IndexChecker::TaskDefinition::GeneralReport.generate!
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: index_checker
+version: !ruby/object:Gem::Version
+  version: 1.0.16
+platform: ruby
+authors:
+- Lê Đức Hoà
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: A simple ruby gem for view statistic information abount index
+email: leduchoabatr12@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- index_checker.gemspec
+- lib/generators/index_checker/initialize_generator.rb
+- lib/generators/templates/index_checker_config.rb
+- lib/index_checker.rb
+- lib/index_checker/railtie.rb
+- lib/index_checker/task_definition/base.rb
+- lib/index_checker/task_definition/general_report.rb
+- lib/index_checker/version.rb
+- lib/report_template.html.erb
+- lib/tasks/index_checker_tasks.rake
+homepage: https://github.com/dontregret9/index_checker
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+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.1.6
+signing_key: 
+specification_version: 4
+summary: Index Checker
+test_files: []