lol_dba 2.1.5 → 2.1.6

data/gemfiles/rails_5_1.gemfile.lock

@@ -1,36 +1,36 @@
 PATH
   remote: ..
   specs:
-    lol_dba (2.1.4)
-      actionpack (>= 3.0)
-      activerecord (>= 3.0)
-      railties (>= 3.0)
+    lol_dba (2.1.5)
+      actionpack (>= 3.0, < 6.0)
+      activerecord (>= 3.0, < 6.0)
+      railties (>= 3.0, < 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.1.5)
-      actionview (= 5.1.5)
-      activesupport (= 5.1.5)
+    actionpack (5.1.7)
+      actionview (= 5.1.7)
+      activesupport (= 5.1.7)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.5)
-      activesupport (= 5.1.5)
+    actionview (5.1.7)
+      activesupport (= 5.1.7)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activemodel (5.1.5)
-      activesupport (= 5.1.5)
-    activerecord (5.1.5)
-      activemodel (= 5.1.5)
-      activesupport (= 5.1.5)
+    activemodel (5.1.7)
+      activesupport (= 5.1.7)
+    activerecord (5.1.7)
+      activemodel (= 5.1.7)
+      activesupport (= 5.1.7)
       arel (~> 8.0)
-    activesupport (5.1.5)
+    activesupport (5.1.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     appraisal (2.2.0)
@@ -39,57 +39,61 @@ GEM
       thor (>= 0.14.0)
     arel (8.0.0)
     builder (3.2.3)
-    concurrent-ruby (1.0.5)
-    crass (1.0.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
     diff-lcs (1.3)
-    erubi (1.7.0)
-    i18n (0.9.5)
+    docile (1.3.1)
+    erubi (1.8.0)
+    i18n (1.6.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.2.0)
+    json (2.2.0)
+    loofah (2.2.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    method_source (0.9.0)
-    mini_portile2 (2.3.0)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
     minitest (5.11.3)
-    nokogiri (1.8.2)
-      mini_portile2 (~> 2.3.0)
-    power_assert (1.1.1)
-    rack (2.0.4)
-    rack-test (0.8.3)
+    nokogiri (1.10.2)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (5.1.5)
-      actionpack (= 5.1.5)
-      activesupport (= 5.1.5)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.1.7)
+      actionpack (= 5.1.7)
+      activesupport (= 5.1.7)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (12.3.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rake (12.3.2)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-rails (3.7.2)
+      rspec-support (~> 3.8.0)
+    rspec-rails (3.8.2)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sqlite3 (1.3.13)
-    test-unit (3.2.7)
-      power_assert
-    thor (0.20.0)
+    thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
@@ -100,12 +104,12 @@ PLATFORMS
 DEPENDENCIES
   actionpack (~> 5.1.0)
   activerecord (~> 5.1.0)
-  appraisal
+  appraisal (~> 2.2)
   lol_dba!
   railties (~> 5.1.0)
   rspec-rails
-  sqlite3
-  test-unit
+  simplecov (~> 0.1)
+  sqlite3 (~> 1.3.5)
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

data/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0"
+gem "actionpack", "~> 5.2.0"
+gem "railties", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_5_2.gemfile.lock

@@ -0,0 +1,115 @@
+PATH
+  remote: ..
+  specs:
+    lol_dba (2.1.5)
+      actionpack (>= 3.0, < 6.0)
+      activerecord (>= 3.0, < 6.0)
+      railties (>= 3.0, < 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (9.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    erubi (1.8.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    json (2.2.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.2)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (12.3.2)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-rails (3.8.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sqlite3 (1.3.13)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 5.2.0)
+  activerecord (~> 5.2.0)
+  appraisal (~> 2.2)
+  lol_dba!
+  railties (~> 5.2.0)
+  rspec-rails
+  simplecov (~> 0.1)
+  sqlite3 (~> 1.3.5)
+
+BUNDLED WITH
+   1.17.3

data/lib/lol_dba/cli.rb

@@ -4,43 +4,54 @@ require 'lol_dba/version'
 
 module LolDba
   class CLI
-
     class << self
       def start
+        new(Dir.pwd, parse_options).start(ARGV.first)
+      end
+
+      def parse_options
         options = {}
         OptionParser.new do |opts|
-          opts.on('-d', '--debug', 'Show stack traces when an error occurs.') { |v| options[:debug] = v }
-          opts.on_tail("-v", "--version", "Show version") do
+          opts.on('-d', '--debug',
+                  'Show stack traces when an error occurs.') do |opt|
+            options[:debug] = opt
+          end
+          opts.on_tail('-v', '--version', 'Show version') do
             puts LolDba::VERSION
             exit
           end
         end.parse!
-        new(Dir.pwd, options).start
       end
     end
 
     def initialize(path, options)
-      @path, @options = path, options
+      @path = path
+      @options = options
     end
 
-    def start
+    def start(arg)
       load_application
-      arg = ARGV.first
+      select_action(arg)
+    rescue Exception => exception
+      if @options[:debug]
+        warn "Failed: #{exception.class}: #{exception.message}"
+        warn exception.backtrace.map { |trace| "    from #{trace}" }
+      end
+    end
+
+    protected
+
+    def select_action(arg)
       if arg =~ /db:find_indexes/
-        LolDba.simple_migration
+        LolDba::IndexFinder.run
       elsif arg !~ /\[/
-        LolDba::SqlGenerator.generate("all")
+        LolDba::SqlGenerator.run('all')
       else
         which = arg.match(/.*\[(.*)\].*/).captures[0]
-        LolDba::SqlGenerator.generate(which)
+        LolDba::SqlGenerator.run(which)
       end
-    rescue Exception => e
-      $stderr.puts "Failed: #{e.class}: #{e.message}" if @options[:debug]
-      $stderr.puts e.backtrace.map { |t| "    from #{t}" } if @options[:debug]
     end
 
-    protected
-
     # Tks to https://github.com/voormedia/rails-erd/blob/master/lib/rails_erd/cli.rb
     def load_application
       require "#{@path}/config/environment"

data/lib/lol_dba/index_finding/belongs_to.rb

@@ -0,0 +1,32 @@
+module LolDba
+  class BelongsTo < RelationInspector
+    def relation_columns
+      if reflection_options.options[:polymorphic]
+        name = reflection_options.name
+        poly_type = "#{name}_type"
+        poly_id = "#{name}_id"
+        [poly_type, poly_id].sort
+      else
+        foreign_key = non_polymorphic_fk
+
+        # not a clue why rails 4.1+ creates this left_side_id thing
+        foreign_key == 'left_side_id' ? nil : foreign_key.to_s
+      end
+    end
+
+    def table_name
+      model_class.table_name
+    end
+
+    private
+
+    def non_polymorphic_fk
+      foreign_key = reflection_options.options[:foreign_key]
+      foreign_key ||= if reflection_options.respond_to?(:primary_key_name)
+                        reflection_options.primary_key_name
+                      else
+                        reflection_options.foreign_key
+        end
+    end
+  end
+end

data/lib/lol_dba/index_finding/error_logging.rb

@@ -0,0 +1,15 @@
+module LolDba
+  class ErrorLogging
+    def self.log(model_class, reflection_options, exception)
+      puts 'some errors here...'
+      puts 'please, create an issue with the following information here:'
+      puts 'https://github.com/plentz/lol_dba/issues'
+      puts '***************************'
+      puts "class: #{model_class}"
+      puts "association type: #{reflection_options.macro}"
+      puts "association options: #{reflection_options.options}"
+      puts "exception: #{exception.message}"
+      exception.backtrace.each { |trace| puts trace }
+    end
+  end
+end

data/lib/lol_dba/index_finding/has_and_belongs_to_many.rb

@@ -0,0 +1,20 @@
+module LolDba
+  class HasAndBelongsToMany < RelationInspector
+    def relation_columns
+      foreign_key = get_through_foreign_key(model_class, reflection_options)
+      index_name = [association_fk, foreign_key].map(&:to_s).sort
+    end
+
+    def table_name
+      table_name = reflection_options.options[:join_table]
+      table_name || [model_class.table_name, reflection_name.to_s].sort.join('_')
+    end
+
+    private
+
+    def association_fk
+      association_fk = reflection_options.options[:association_foreign_key]
+      association_fk || "#{reflection_name.to_s.singularize}_id"
+    end
+  end
+end

data/lib/lol_dba/index_finding/has_many.rb

@@ -0,0 +1,47 @@
+module LolDba
+  class HasMany < RelationInspector
+    def relation_columns
+      # has_many tables are threaten by the other side of the relation
+      return nil unless through && reflections[through.to_s]
+
+      # FIXME: currently we don't support :through =>
+      # :another_regular_has_many_and_non_through_relation
+      if (association_foreign_key = find_association_fk).present?
+        [association_foreign_key, foreign_key].map(&:to_s).sort
+      end
+    end
+
+    def table_name
+      through_class.table_name
+    end
+
+    private
+
+    def find_association_fk
+      if (source = reflection_options.options[:source])
+        association_reflection = through_reflections[source.to_s]
+        return nil if association_reflection.options[:polymorphic]
+        get_through_foreign_key(association_reflection.klass, reflection_options)
+      elsif belongs_to_reflections = through_reflections[reflection_name.singularize]
+        # go to joining model through has_many and find belongs_to
+        belongs_to_reflections.options[:foreign_key]
+      end
+    end
+
+    def through_class
+      reflections[through.to_s].klass
+    end
+
+    def through
+      reflection_options.options[:through]
+    end
+
+    def foreign_key
+      get_through_foreign_key(model_class, reflection_options)
+    end
+
+    def through_reflections
+      through_class.reflections.stringify_keys
+    end
+  end
+end

data/lib/lol_dba/index_finding/index_finder.rb

@@ -0,0 +1,81 @@
+module LolDba
+  class IndexFinder
+    def self.run
+      MigrationFormatter.new(check_for_indexes).puts_migration_content
+    end
+
+    def self.check_for_indexes
+      eager_load_if_needed
+
+      required_indexes = Hash.new([])
+
+      model_classes.each do |model_class|
+        unless model_class.descends_from_active_record?
+          index_name = [model_class.inheritance_column, model_class.base_class.primary_key].sort
+          required_indexes[model_class.base_class.table_name] += [index_name]
+        end
+        reflections = model_class.reflections.stringify_keys
+        reflections.each_pair do |reflection_name, reflection_options|
+          begin
+            clazz = RelationInspectorFactory.for(reflection_options.macro)
+            next unless clazz.present?
+            inspector = clazz.new(model_class, reflection_options,
+                                  reflection_name)
+            columns = inspector.relation_columns
+
+            unless columns.nil? || reflection_options.options.include?(:class)
+              required_indexes[inspector.table_name.to_s] += [columns]
+            end
+          rescue StandardError => exception
+            LolDba::ErrorLogging.log(model_class, reflection_options, exception)
+          end
+        end
+      end
+
+      missing_indexes(required_indexes)
+    end
+
+    def self.missing_indexes(indexes_required)
+      missing_indexes = {}
+      indexes_required.each do |table_name, foreign_keys|
+        next if foreign_keys.blank? || !tables.include?(table_name.to_s)
+        keys_to_add = foreign_keys.uniq - existing_indexes(table_name)
+        missing_indexes[table_name] = keys_to_add unless keys_to_add.empty?
+      end
+      missing_indexes
+    end
+
+    def self.tables
+      LolDba::RailsCompatibility.tables
+    end
+
+    def self.existing_indexes(table_name)
+      table_indexes(table_name) + primary_key(table_name)
+    end
+
+    def self.table_indexes(table_name)
+      indexes = ActiveRecord::Base.connection.indexes(table_name.to_sym)
+      indexes.collect do |index|
+        index.columns.size > 1 ? index.columns : index.columns.first
+      end
+    end
+
+    def self.primary_key(table_name)
+      Array(ActiveRecord::Base.connection.primary_key(table_name.to_s))
+    end
+
+    def self.model_classes
+      ActiveRecord::Base.descendants.select do |obj|
+        Class == obj.class && session_store?(obj)
+      end
+    end
+
+    def self.session_store?(obj)
+      !defined?(ActiveRecord::SessionStore::Session) || obj != ActiveRecord::SessionStore::Session
+    end
+
+    def self.eager_load_if_needed
+      Rails.application.eager_load! if defined?(Rails) && !Rails.env.test?
+    end
+  end
+end

data/lib/lol_dba/index_finding/migration_formatter.rb

@@ -0,0 +1,50 @@
+module LolDba
+  class MigrationFormatter
+    def initialize(indexes)
+      @indexes = indexes
+    end
+
+    def puts_migration_content
+      formated_indexes = format_for_migration(@indexes)
+      if formated_indexes.blank?
+        puts 'Yey, no missing indexes found!'
+      else
+        puts migration_instructions(formated_indexes)
+      end
+    end
+
+    def format_for_migration(missing_indexes)
+      add = []
+      missing_indexes.each do |table_name, keys_to_add|
+        keys_to_add.each do |key|
+          next if key.blank?
+          add << format_index(table_name, key)
+        end
+      end
+      add
+    end
+
+    def format_index(table_name, key)
+      if key.is_a?(Array)
+        keys = key.collect { |col| ":#{col}" }
+        "add_index :#{table_name}, [#{keys.join(', ')}]"
+      else
+        "add_index :#{table_name}, :#{key}"
+      end
+    end
+
+    def migration_instructions(formated_indexes)
+      <<-MIGRATION
+* TIP: if you have a problem with the index name('index name too long'), you can
+solve with the :name option. Something like :name => 'my_index'.
+* run `rails g migration AddMissingIndexes` and add the following content:
+
+    class AddMissingIndexes < ActiveRecord::Migration
+      def change
+        #{formated_indexes.sort.uniq.join("\n        ")}
+      end
+    end
+MIGRATION
+    end
+  end
+end

data/lib/lol_dba/index_finding/relation_inspector.rb

@@ -0,0 +1,30 @@
+module LolDba
+  class RelationInspector
+    attr_reader :model_class, :reflection_options, :reflection_name
+
+    def initialize(model_class, reflection_options, reflection_name)
+      @model_class = model_class
+      @reflection_options = reflection_options
+      @reflection_name = reflection_name
+    end
+
+    def get_through_foreign_key(target_class, reflection_options)
+      # has_many :through
+      reflection = target_class.reflections[reflection_options.options[:through].to_s]
+
+      # has_and_belongs_to_many
+      reflection ||= reflection_options
+
+      # Guess foreign key?
+      if reflection.options[:foreign_key]
+        reflection.options[:foreign_key]
+      else
+        "#{target_class.name.tableize.singularize}_id"
+      end
+    end
+
+    def reflections
+      model_class.reflections.stringify_keys
+    end
+  end
+end

data/lib/lol_dba/index_finding/relation_inspector_factory.rb

@@ -0,0 +1,13 @@
+module LolDba
+  class RelationInspectorFactory
+    TYPES = {
+      belongs_to: BelongsTo,
+      has_and_belongs_to_many: HasAndBelongsToMany,
+      has_many: HasMany
+    }.freeze
+
+    def self.for(type)
+      TYPES[type]
+    end
+  end
+end