traceindex 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1976ad785be5c111087d12387e9a84df779ec397bc278e3824c9fdf66343140
-  data.tar.gz: 9585e24b1aff78526e791572ae31401ed47dbb243aae0a4044657bc9263a5753
+  metadata.gz: b0a76e873f9bb112b3cd1f98613af8aa41754e426943e22fef117254b1a1309c
+  data.tar.gz: 98cd2a6ab6c7cd985648edc1310cad7197e444b7bb497e6fb4c698fb958a9d95
 SHA512:
-  metadata.gz: b7af461287ee4ab0e7c95ef037b618082603a539ba55057b60f0728bea43635fe6c40388553c7c04796d138caecca37d9fa0eac15b5e550cb2faf236d864bba1
-  data.tar.gz: 9f51f3ae65db56ef36c5cc2b1d616fa48c9e5cc7e3a71af1ca06dcceb5ab58837cd2cabcd87278cecbd525a6da6f8b0c01035610b178cad39b0ed9b48c44140f
+  metadata.gz: b7b05e1ccfd3f5a79adc80bc3b0412b19dc8ee47b725fa8f9d1ffe5a8c8f9fa4400d05a88465dd2fdc0c32fbe09c9e5d437697a02a72c5caaf3b93ecb1208335
+  data.tar.gz: ed7118e1fd8b2aa65da7422f04963bfeacab40d516d64f79f683b14888be31637b641ad6891866d638f38a64e91e70cdc5f991e2aa683f8410306dd8a98f1442

data/.circleci/config.yml

@@ -0,0 +1,52 @@
+version: 2.1
+
+executors:
+  default:
+    working_directory: ~/app
+    docker:
+      - image: circleci/ruby:2.6
+        environment:
+          DB_USER: 'root'
+          DB_PASS: 'root'
+          DB_HOST: '127.0.0.1'
+      - image: circleci/mysql:8-ram
+        environment:
+          MYSQL_ROOT_PASSWORD: root
+          MYSQL_DATABASE: traceindex_test
+        command: [--default-authentication-plugin=mysql_native_password]
+
+commands:
+  setup_bundle:
+    steps:
+      - restore_cache:
+          key: bundle-{{ checksum "traceindex.gemspec" }}
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - save_cache:
+          key: bundle-{{ checksum "traceindex.gemspec" }}
+          paths:
+          - vendor/bundle
+
+  wait_for_db:
+    steps:
+      - run:
+          name: Wait for DB
+          command: dockerize -wait tcp://127.0.0.1:3306 -timeout 1m
+
+jobs:
+  test:
+    executor: default
+    steps:
+      - checkout
+      - setup_bundle
+      - wait_for_db
+      - run: bundle exec rspec ./spec
+
+workflows:
+  version: 2
+
+  test:
+    jobs:
+      - test

data/.gitignore

@@ -3,4 +3,3 @@
 Gemfile.lock
 pkg/*
 *.log
-spec/database.yml

data/README.md

@@ -29,18 +29,27 @@ If you want the rake task to fail when errors are found.
 % FAIL_ON_ERROR=1 rake traceindex
 ```
 
+If you want the rake task to ignore foreign_keys.
+
+```
+% IGNORE_FOREIGN_KEY=1 rake traceindex
+```
+
 ## How do I tell it to ignore columns?
 
 Create a .traceindex.yaml or .traceindex.yml file in your root directory.
 
 ```yaml
+ignore_tables:
+  - action_mailbox_inbound_emails
+  - action_text_rich_texts
+  - active_storage_attachments
+  - active_storage_blobs
+  - active_storage_variant_records
 ignore_columns:
   - users.created_user_id
-ignore_models:
-  - ActiveStorage::Blob
-  - ActiveStorage::Attachment
-  - ActionText::RichText
-  - ActionMailbox::InboundEmail
+ignore_foreign_keys:
+  - users.created_user_id
 ```
 
 ## Copyright

data/lib/tasks/traceindex.rake

@@ -3,10 +3,21 @@ task traceindex: :environment do
   traceindex   = Traceindex.new(Rails.application)
   column_names = traceindex.missing_index_column_names
 
-  if column_names.size > 0
+  unless column_names.empty?
     puts "Missing index columns (#{column_names.size}):"
     column_names.each { |column| puts "  #{column}" }
+  end
+
+  if ENV['IGNORE_FOREIGN_KEY'].nil?
+    fk_column_names = traceindex.missing_foreign_keys
+
+    unless fk_column_names.empty?
+      puts "Missing foreign keys (#{fk_column_names.size}):"
+      fk_column_names.each { |column| puts "  #{column}" }
+    end
+  end
 
-    raise 'Missing indexes detected.' if ENV['FAIL_ON_ERROR']
+  if ENV['FAIL_ON_ERROR'] && (!column_names.empty? || !fk_column_names.empty?)
+    raise 'Missing indexes detected.'
   end
 end

data/lib/traceindex.rb

@@ -8,17 +8,11 @@ class Traceindex
   end
 
   def initialize(app)
-    @app            = app
-    @ignore_models  = []
-    @ignore_columns = []
-
-    (config["ignore_models"] || []).each do |ignored_model|
-      @ignore_models << ignored_model
-    end
-
-    (config["ignore_columns"] || []).each do |ignored_column|
-      @ignore_columns << ignored_column
-    end
+    @app                 = app
+    @ignore_models       = (config["ignore_models"] || [])
+    @ignore_columns      = (config["ignore_columns"] || [])
+    @ignore_foreign_keys = (config["ignore_foreign_keys"] || [])
+    @ignore_tables       = (config["ignore_tables"] || [])
   end
 
   def missing_index_column_names
@@ -41,6 +35,25 @@ class Traceindex
     end
   end
 
+  def missing_foreign_keys
+    models.each.with_object([]) do |model, missing_columns|
+      id_columns = model.columns.select {|column| column.name.end_with?("_id") }
+
+      foreign_keys = ActiveRecord::Base.connection.foreign_keys(model.table_name)
+
+      id_columns.each do |id_column|
+        if @ignore_foreign_keys.include?("#{model.table_name}.#{id_column.name}")
+          next
+        end
+
+        next unless foreign_keys.none? { |index| index.column == id_column.name }
+        missing_columns << "#{model.table_name}.#{id_column.name}"
+      end
+    rescue => e
+      puts e.message
+    end
+  end
+
   private
 
   def config_filename
@@ -56,7 +69,7 @@ class Traceindex
 
     @app.eager_load!
     @models ||= ActiveRecord::Base.descendants.reject(&:abstract_class).reject do |model|
-      @ignore_models.include?(model.name)
+      @ignore_models.include?(model.name) || @ignore_tables.include?(model.table_name)
     end
   end
 end

data/spec/app.rb

@@ -12,13 +12,13 @@ module DummyApp
 end
 
 ActiveRecord::Base.establish_connection(
-  YAML.load(File.read('spec/database.yml'))['test']
+  YAML.load(ERB.new(File.read('spec/database.yml')).result)['test']
 )
 
 ActiveRecord::Schema.define version: 0 do
   create_table :users, force: true do |t|
-    t.integer :created_user_id, index: true
-    t.integer :updated_user_id, index: false
+    t.references :created_user,    foreign_key: { to_table: :users }
+    t.integer    :updated_user_id, index: false
   end
 end
 

data/spec/database.yml

@@ -0,0 +1,18 @@
+default: &default
+  adapter:   mysql2
+  encoding:  utf8mb4
+  charset:   utf8mb4
+  collation: utf8mb4_general_ci
+  pool:      5
+  username:  <%= ENV.fetch("DB_USER") { 'root' } %>
+  password:  <%= ENV.fetch("DB_PASS") { '' } %>
+  host:      <%= ENV.fetch("DB_HOST") { '127.0.0.1' } %>
+  socket:    /tmp/mysql.sock
+
+development:
+  <<: *default
+  database: traceindex_development
+
+test:
+  <<: *default
+  database: traceindex_test

data/spec/traceroute_spec.rb

@@ -7,30 +7,110 @@ describe Traceindex do
     expect(Traceindex::VERSION).not_to be nil
   end
 
+  let(:traceindex) { Traceindex.new(Rails.application) }
+
+  after { File.delete '.traceindex.yml' if File.exists? '.traceindex.yml' }
+
   describe '#missing_index_column_names' do
     it 'missing index found.' do
-      traceindex = Traceindex.new(Rails.application)
       expect(traceindex.missing_index_column_names).to eq(['users.updated_user_id'])
     end
 
-    context 'If you have a configuration file' do
+    context 'If you have a configuration file(ignore_columns)' do
       before do
         File.open '.traceindex.yml', 'w' do |file|
           file.puts 'ignore_columns:'
           file.puts '  - users.updated_user_id'
+        end
+      end
+
+      it 'missing index not found.' do
+        expect(traceindex.missing_index_column_names).to eq([])
+      end
+    end
+
+    context 'If you have a configuration file(ignore_models)' do
+      before do
+        File.open '.traceindex.yml', 'w' do |file|
           file.puts 'ignore_models:'
           file.puts '  - User'
         end
       end
 
-      after do
-        File.delete '.traceindex.yml'
+      it 'missing index not found.' do
+        expect(traceindex.missing_index_column_names).to eq([])
+      end
+    end
+
+    context 'If you have a configuration file(ignore_tables)' do
+      before do
+        File.open '.traceindex.yml', 'w' do |file|
+          file.puts 'ignore_tables:'
+          file.puts '  - users'
+        end
       end
 
       it 'missing index not found.' do
-        traceindex = Traceindex.new(Rails.application)
         expect(traceindex.missing_index_column_names).to eq([])
       end
     end
+
+    context 'If you have a configuration file(ignore_foreign_keys)' do
+      before do
+        File.open '.traceindex.yml', 'w' do |file|
+          file.puts 'ignore_foreign_keys:'
+          file.puts '  - users.updated_user_id'
+        end
+      end
+
+      it 'missing index exists.' do
+        expect(traceindex.missing_index_column_names).to eq(['users.updated_user_id'])
+      end
+    end
+  end
+
+  describe '#missing_foreign_keys' do
+    it 'missing index found.' do
+      expect(traceindex.missing_foreign_keys).to eq(['users.updated_user_id'])
+    end
+
+    context 'If you have a configuration file(ignore_columns)' do
+      before do
+        File.open '.traceindex.yml', 'w' do |file|
+          file.puts 'ignore_columns:'
+          file.puts '  - users.updated_user_id'
+        end
+      end
+
+      it 'missing foreign keys exists.' do
+        expect(traceindex.missing_foreign_keys).to eq(['users.updated_user_id'])
+      end
+    end
+
+    context 'If you have a configuration file(ignore_foreign_keys)' do
+      before do
+        File.open '.traceindex.yml', 'w' do |file|
+          file.puts 'ignore_foreign_keys:'
+          file.puts '  - users.updated_user_id'
+        end
+      end
+
+      it 'missing foreign keys not found.' do
+        expect(traceindex.missing_foreign_keys).to eq([])
+      end
+    end
+
+    context 'If you have a configuration file(ignore_models)' do
+      before do
+        File.open '.traceindex.yml', 'w' do |file|
+          file.puts 'ignore_models:'
+          file.puts '  - User'
+        end
+      end
+
+      it 'missing foreign keys not found.' do
+        expect(traceindex.missing_foreign_keys).to eq([])
+      end
+    end
   end
 end

data/traceindex.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path('lib', __dir__)
 
 Gem::Specification.new do |s|
   s.name        = 'traceindex'
-  s.version     = '0.0.1'
+  s.version     = '0.1.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Akira Kusumoto']
   s.email       = ['akirakusumo10@gmail.com']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: traceindex
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Akira Kusumoto
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -74,6 +74,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - Gemfile
 - MIT-LICENSE
@@ -82,7 +83,7 @@ files:
 - lib/tasks/traceindex.rake
 - lib/traceindex.rb
 - spec/app.rb
-- spec/database.yml.sample
+- spec/database.yml
 - spec/spec_helper.rb
 - spec/traceroute_spec.rb
 - traceindex.gemspec
@@ -90,7 +91,7 @@ homepage: https://github.com/bluerabbit/traceindex
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,12 +106,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A Rake task that helps you find the missing indexes for your Rails app
 test_files:
 - spec/app.rb
-- spec/database.yml.sample
+- spec/database.yml
 - spec/spec_helper.rb
 - spec/traceroute_spec.rb

data/spec/database.yml.sample

@@ -1,15 +0,0 @@
-default: &default
-  adapter: mysql2
-  encoding: utf8
-  pool: 5
-  username: root
-  password:
-  socket: /tmp/mysql.sock
-
-development:
-  <<: *default
-  database: traceindex_development
-
-test:
-  <<: *default
-  database: traceindex_test