index_shotgun 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 177ae0bdc732e173f7813384773d2d1d7494a3427a2e9683caafdc2c7dde5112
-  data.tar.gz: 8d671561f7c7aa86a4169eef4ed7e7f35fd39279e5809e13acbbd8b1a9892e70
+  metadata.gz: e083f50b59dfe9def74cef986544b8086cc1e60bf2fe765672f233e5935a8685
+  data.tar.gz: c42212bddff5076c1c7252cf8ff33378a480e64190f7acc47591d3fbd1c16541
 SHA512:
-  metadata.gz: 523d34c9aad011951a1b76beb8e55a7ff07282a83b830d19f2029966e6100f75de8ea9aa1a9df77c3fe4f464076866629b7e031168156c4d19434cd2cff5c6d9
-  data.tar.gz: a5319c356f1f834e5b294cfc844f5eb8b578172de2650eff782f0987ac2a847ec0cde84e73db398773e65345ef13361bf7e9efc48ffd7e4be9eeef157a95fbfb
+  metadata.gz: 72226e56029dd8e36e853e9a23380d51c37991d7785bef739871846fdc985a6bf24ae8f36e041ced640a96ffba6574d35b180ecead0e5b619f07200fac2c401d
+  data.tar.gz: 5f773916e8a3ed188be272201c9e41e3f35390cd793f7755702c20e2055b60ecf3be2ff5aa8253021a9cfba67b98671581c6fbdc986739d9643645c7a727b5ac

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+# c.f. https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+version: 2
+
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    assignees:
+      - sue445

data/.github/workflows/pages.yml

@@ -0,0 +1,63 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - ".github/workflows/test.yml"
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_WITHOUT: mysql postgresql sqlite3 oracle
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          bundler-cache: true
+
+      - run: bundle exec yard
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: './doc'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@main
+
+      - name: Slack Notification (not success)
+        uses: act10ns/slack@v2
+        if: "! success()"
+        continue-on-error: true
+        with:
+          status: ${{ job.status }}
+          webhook-url: ${{ secrets.SLACK_WEBHOOK }}

data/.github/workflows/test.yml

@@ -4,11 +4,15 @@ on:
   push:
     branches:
       - master
+    paths-ignore:
+      - ".github/workflows/pages.yml"
   pull_request:
     types:
       - opened
       - synchronize
       - reopened
+    paths-ignore:
+      - ".github/workflows/pages.yml"
   schedule:
     - cron: "0 20 * * 5" # JST 5:00 (Sat)
 
@@ -26,6 +30,9 @@ jobs:
           - "2.6"
           - "2.7"
           - "3.0"
+          - "3.1"
+          - "3.2"
+          - "3.3"
         gemfile:
           - activerecord_5_0
           - activerecord_5_1
@@ -33,16 +40,13 @@ jobs:
           - activerecord_6_0
           - activerecord_6_1
           - activerecord_7_0
+          - activerecord_7_1
         database:
           - sqlite3
           - mysql
           - postgresql
           - oracle
         exclude:
-          # TODO: Remove this after activerecord-oracle_enhanced-adapter supports activerecord v7
-          - database: oracle
-            gemfile:  activerecord_7_0
-
           # Rails 7.0+ requires Ruby 2.7+
           - ruby:    "2.4"
             gemfile: activerecord_7_0
@@ -50,6 +54,12 @@ jobs:
             gemfile: activerecord_7_0
           - ruby:    "2.6"
             gemfile: activerecord_7_0
+          - ruby:    "2.4"
+            gemfile: activerecord_7_1
+          - ruby:    "2.5"
+            gemfile: activerecord_7_1
+          - ruby:    "2.6"
+            gemfile: activerecord_7_1
 
           # Rails 6.0+ requires Ruby 2.5+
           - ruby:    "2.4"
@@ -64,6 +74,28 @@ jobs:
             gemfile: activerecord_5_1
           - ruby:    "3.0"
             gemfile: activerecord_5_2
+          - ruby:    "3.1"
+            gemfile: activerecord_5_0
+          - ruby:    "3.1"
+            gemfile: activerecord_5_1
+          - ruby:    "3.1"
+            gemfile: activerecord_5_2
+          - ruby:    "3.2"
+            gemfile: activerecord_5_0
+          - ruby:    "3.2"
+            gemfile: activerecord_5_1
+          - ruby:    "3.2"
+            gemfile: activerecord_5_2
+          - ruby:    "3.3"
+            gemfile: activerecord_5_0
+          - ruby:    "3.3"
+            gemfile: activerecord_5_1
+          - ruby:    "3.3"
+            gemfile: activerecord_5_2
+
+          # TODO: latest activerecord-oracle_enhanced-adapter doesn't support activerecord 7.1
+          - database: oracle
+            gemfile: activerecord_7_1
 
     env:
       BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
@@ -99,14 +131,14 @@ jobs:
           ORACLE_SYSTEM_PASSWORD: oracle
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
 
       - name: Cache vendor/bundle
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         id: cache_gem
         with:
           path: vendor/bundle
@@ -127,8 +159,8 @@ jobs:
           command: before-build
         continue-on-error: true
 
-      # c.f. https://github.blog/changelog/2020-02-21-github-actions-breaking-change-ubuntu-virtual-environments-will-no-longer-start-the-mysql-service-automatically/
-      - run: sudo /etc/init.d/mysql start
+      # c.f. https://github.com/actions/virtual-environments/issues/4732#issuecomment-992614476
+      - run: sudo systemctl start mysql
 
       - name: Run test
         run: |
@@ -148,15 +180,13 @@ jobs:
         continue-on-error: true
 
       - name: Slack Notification (not success)
-        uses: lazy-actions/slatify@master
+        uses: act10ns/slack@v2
         if: "! success()"
         continue-on-error: true
         with:
-          job_name: ${{ format('*build* ({0}, {1}, {2})', matrix.ruby, matrix.gemfile, matrix.database) }}
-          type: ${{ job.status }}
-          icon_emoji: ":octocat:"
-          url: ${{ secrets.SLACK_WEBHOOK }}
-          token: ${{ secrets.GITHUB_TOKEN }}
+          status: ${{ job.status }}
+          webhook-url: ${{ secrets.SLACK_WEBHOOK }}
+          matrix: ${{ toJson(matrix) }}
 
   rubocop:
     runs-on: ubuntu-latest
@@ -166,14 +196,14 @@ jobs:
       BUNDLE_WITHOUT: mysql postgresql sqlite3 oracle
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
 
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ env.RUBY_VERSION }}
 
       - name: Cache vendor/bundle
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         id: cache_gem_rubocop
         with:
           path: vendor/bundle
@@ -192,15 +222,12 @@ jobs:
           bundle exec rubocop
 
       - name: Slack Notification (not success)
-        uses: lazy-actions/slatify@master
+        uses: act10ns/slack@v2
         if: "! success()"
         continue-on-error: true
         with:
-          job_name: '*rubocop*'
-          type: ${{ job.status }}
-          icon_emoji: ":octocat:"
-          url: ${{ secrets.SLACK_WEBHOOK }}
-          token: ${{ secrets.GITHUB_TOKEN }}
+          status: ${{ job.status }}
+          webhook-url: ${{ secrets.SLACK_WEBHOOK }}
 
   notify:
     needs:
@@ -211,12 +238,9 @@ jobs:
 
     steps:
       - name: Slack Notification (success)
-        uses: lazy-actions/slatify@master
+        uses: act10ns/slack@v2
         if: always()
         continue-on-error: true
         with:
-          job_name: '*build*'
-          type: ${{ job.status }}
-          icon_emoji: ":octocat:"
-          url: ${{ secrets.SLACK_WEBHOOK }}
-          token: ${{ secrets.GITHUB_TOKEN }}
+          status: ${{ job.status }}
+          webhook-url: ${{ secrets.SLACK_WEBHOOK }}

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--no-private

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Change Log
 ## Unreleased
-[Full Changelog](https://github.com/sue445/index_shotgun/compare/v1.0.1...master)
+[Full Changelog](https://github.com/sue445/index_shotgun/compare/v1.0.3...master)
+
+## [v1.0.2](https://github.com/sue445/index_shotgun/tree/v1.0.3) (2024/05/14)
+[Full Changelog](https://github.com/sue445/index_shotgun/compare/v1.0.2...v1.0.3)
+
+* Fixed false positives when there are multiple unique indexes on a single table
+  * https://github.com/sue445/index_shotgun/pull/140
+
+## [v1.0.2](https://github.com/sue445/index_shotgun/tree/v1.0.2) (2023/12/28)
+[Full Changelog](https://github.com/sue445/index_shotgun/compare/v1.0.1...v1.0.2)
+
+* Fixed deprecation warning in activesupport 7.1
+  * https://github.com/sue445/index_shotgun/pull/134
 
 ## [v1.0.1](https://github.com/sue445/index_shotgun/tree/v1.0.1) (2021/11/20)
 [Full Changelog](https://github.com/sue445/index_shotgun/compare/v1.0.0...v1.0.1)

data/ci/build.sh

@@ -1,5 +1,18 @@
 #!/bin/bash -xe
 
+if [ "${DATABASE}" = "mysql" ]; then
+  export BUNDLE_WITHOUT="postgresql sqlite3 oracle"
+elif [ "${DATABASE}" = "postgresql" ]; then
+  export BUNDLE_WITHOUT="mysql sqlite3 oracle"
+elif [ "${DATABASE}" = "sqlite3" ]; then
+  export BUNDLE_WITHOUT="mysql postgresql oracle"
+elif [ "${DATABASE}" = "oracle" ]; then
+  export BUNDLE_WITHOUT="mysql postgresql sqlite3"
+else
+  echo "${DATABASE} is unknown"
+  exit 1
+fi
+
 cp ci/database.yml.${DATABASE} spec/config/database.yml
 bundle exec rspec --profile
 

data/ci/install.sh

@@ -1,6 +1,9 @@
 #!/bin/bash -xe
 
-gem install bundler --no-document -v 1.17.3 || true
+gem update --system --quiet || true
+
+gem --version
+bundle --version
 
 if [ "${DATABASE}" = "mysql" ]; then
   sudo apt-get update
@@ -44,4 +47,4 @@ else
 fi
 
 bundle config set --local path "vendor/bundle/"
-bundle install --jobs $(nproc) --retry 3
+bundle update --jobs $(nproc) --retry 3

data/gemfiles/activerecord_7_0.gemfile

@@ -1,26 +1,26 @@
 source "https://rubygems.org"
 
-gem "activerecord", "~> 7.0.0.alpha2"
+# NOTE: Ruby 3.1 + Rails 7.0.0 doesn't work
+# c.f. https://gist.github.com/yahonda/2776d8d7b6ea7045359f38c10449937b
+gem "activerecord", "~> 7.0.1"
 
 group :postgresql do
-  # c.f. https://github.com/rails/rails/blob/v7.0.0.alpha2/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L3
+  # c.f. https://github.com/rails/rails/blob/v7.0.0/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L3
   gem "pg", "~> 1.1"
 end
 
 group :mysql do
-  # c.f. https://github.com/rails/rails/blob/v7.0.0.alpha2/activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb#L6
+  # c.f. https://github.com/rails/rails/blob/v7.0.0/activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb#L6
   gem "mysql2", "~> 0.5"
 end
 
 group :oracle do
-  # TODO: Enable this after activerecord-oracle_enhanced-adapter supports activerecord v7
-  # gem "activerecord-oracle_enhanced-adapter", "~> 6.1.2"
-
+  gem "activerecord-oracle_enhanced-adapter", "~> 7.0.0"
   gem "ruby-oci8"
 end
 
 group :sqlite3 do
-  # c.f. https://github.com/rails/rails/blob/v7.0.0.alpha2/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L13
+  # c.f. https://github.com/rails/rails/blob/v7.0.0/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L13
   gem "sqlite3", "~> 1.4"
 end
 

data/gemfiles/activerecord_7_1.gemfile

@@ -0,0 +1,28 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 7.1.0"
+
+group :postgresql do
+  # c.f. https://github.com/rails/rails/blob/v7.1.0/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L3
+  gem "pg", "~> 1.1"
+end
+
+group :mysql do
+  # c.f. https://github.com/rails/rails/blob/v7.1.0/activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb#L6
+  gem "mysql2", "~> 0.5"
+end
+
+# TODO: latest activerecord-oracle_enhanced-adapter doesn't support activerecord 7.1
+# group :oracle do
+#   gem "activerecord-oracle_enhanced-adapter", "~> 7.0.0"
+#   gem "ruby-oci8"
+# end
+
+group :sqlite3 do
+  # c.f. https://github.com/rails/rails/blob/v7.1.0/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L14
+  gem "sqlite3", "~> 1.4"
+end
+
+eval_gemfile "#{__dir__}/common.gemfile"
+
+gemspec path: "../"

data/gemfiles/common.gemfile

@@ -13,3 +13,9 @@ if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.4.4")
   # zeitwerk requires Ruby 2.4.4+
   gem "activesupport", "< 6.0.0"
 end
+
+if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.5.0")
+  # parser 3.3.0.0 uses String#delete_suffix, but String#delete_suffix is available since Ruby 2.5.0+
+  # c.f https://github.com/whitequark/parser/blob/v3.3.0.0/lib/parser/lexer/literal.rb#L250
+  gem "parser", "< 3.3.0.0"
+end

data/index_shotgun.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://sue445.github.io/index_shotgun/"
   spec.metadata["rubygems_mfa_required"] = "true"
 
   spec.required_ruby_version = ">= 2.4.0"
@@ -29,14 +30,14 @@ Gem::Specification.new do |spec|
   spec.add_dependency "thor"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "coveralls_reborn"
   spec.add_development_dependency "onkcop", "0.53.0.2"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rake_shared_context", "0.2.2"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-its"
-  spec.add_development_dependency "rspec-power_assert"
   spec.add_development_dependency "rubocop", "0.62.0"
   spec.add_development_dependency "rubocop_auto_corrector"
   spec.add_development_dependency "simplecov", "< 0.18.0"
+  spec.add_development_dependency "yard"
 end

data/lib/index_shotgun/analyzer.rb

@@ -21,7 +21,7 @@ module IndexShotgun
       # @return [IndexShotgun::Analyzer::Response]
       def perform
         tables =
-          ActiveSupport::Deprecation.silence do
+          silence_deprecations do
             ActiveRecord::Base.connection.tables
           end
         tables.reject! {|table| exclude_tables.include?(table.downcase) }
@@ -70,7 +70,7 @@ module IndexShotgun
       # check duplicate indexes of table
       # @param table [String] table name
       # @return [Array<Hash>] array of index info
-      #   index: index info {ActiveRecord::ConnectionAdapters::IndexDefinition}
+      #   index: index info `ActiveRecord::ConnectionAdapters::IndexDefinition`
       #   result: search result message
       def check_indexes(table)
         indexes = table_indexes(table)
@@ -78,6 +78,8 @@ module IndexShotgun
         indexes.permutation(2).each_with_object([]) do |(source_index, target_index), response|
           next unless source_index.columns.start_with?(target_index.columns)
 
+          next if source_index.unique && target_index.unique
+
           if target_index.unique
             response << {
               index:  source_index,
@@ -94,7 +96,6 @@ module IndexShotgun
 
       # get indexes of table
       # @param table [String]
-      # @see [ActiveRecord::ConnectionAdapters::TableDefinition#indexes]
       def table_indexes(table)
         ActiveRecord::Base.connection.indexes(table)
       end
@@ -288,6 +289,18 @@ module IndexShotgun
         @exclude_tables = tables.map(&:downcase)
         @exclude_tables
       end
+
+      def silence_deprecations
+        if ActiveSupport.version >= Gem::Version.create("7.1.0")
+          ActiveSupport::Deprecation::Deprecators.new.silence do
+            yield
+          end
+        else
+          ActiveSupport::Deprecation.silence do
+            yield
+          end
+        end
+      end
     end
   end
 end

data/lib/index_shotgun/version.rb

@@ -1,3 +1,3 @@
 module IndexShotgun
-  VERSION = "1.0.1".freeze
+  VERSION = "1.0.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: index_shotgun
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - sue445
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2024-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,20 +136,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-power_assert
-  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'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +178,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: duplicate index checker
 email:
 - sue445@sue445.net
@@ -201,11 +201,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/pages.yml"
 - ".github/workflows/test.yml"
 - ".github_changelog_generator"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -226,6 +229,7 @@ files:
 - gemfiles/activerecord_6_0.gemfile
 - gemfiles/activerecord_6_1.gemfile
 - gemfiles/activerecord_7_0.gemfile
+- gemfiles/activerecord_7_1.gemfile
 - gemfiles/common.gemfile
 - index_shotgun.gemspec
 - lib/index_shotgun.rb
@@ -243,6 +247,7 @@ metadata:
   homepage_uri: https://github.com/sue445/index_shotgun
   source_code_uri: https://github.com/sue445/index_shotgun
   changelog_uri: https://github.com/sue445/index_shotgun/blob/master/CHANGELOG.md
+  documentation_uri: https://sue445.github.io/index_shotgun/
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -259,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: duplicate index checker