rubocop-oracle 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f08071efb4fee0574a8a1665daf6a4206c836de8a8f3924a6b74b1267e654f46
-  data.tar.gz: 2193018fe03e09ed648a00639edf46dfe663148f29d0e61d64487af1b21857f9
+  metadata.gz: ec64193df38a8ba40bdedd1bc182d40434cd882f19c2b68cf6f8c9bdb367264f
+  data.tar.gz: 1d21407ef02b559429f4d423b9f977020f02a8b2e418402d6b0fe4515ad125d8
 SHA512:
-  metadata.gz: 332761e4fabe2affbb55327b46b6e8d60a6620a59f91aabbe3b770a0e1ac3bf267ae02878698800c621651e28aac4d8e27ea92b0d7f22801900fc1bda5ff1804
-  data.tar.gz: 2c67d042742a50cc6d784e9769b7f705ec6a29ca3b5b08918518c348685f2fb5edbd2a757a308cc99d926477bc50215238ff127c87b4a88708b4f717adafb08b
+  metadata.gz: 9754bf5aa90cf084920449004f8c326c2067f64019775646e03394cb74d7c71f94abccad07ee1b79460bcd534941c9e18d44246a00219bcfa20df655492d5bc0
+  data.tar.gz: c3177af36bb04b48fce38165ccbe6d8be25ab53b8f85c1e32ab304ec17dd5006bc5ff5b006c5e3c17f7cda5f1e4d70556ceff4bbf042fecd39e7acf0ffc26192

data/.circleci/config.yml

@@ -23,12 +23,6 @@ jobs:
 workflows:
   build:
     jobs:
-      - rake_default:
-          name: Ruby 2.5
-          image: circleci/ruby:2.5
-      - rake_default:
-          name: Ruby 2.6
-          image: circleci/ruby:2.6
       - rake_default:
           name: Ruby 2.7
           image: circleci/ruby:2.7
@@ -38,6 +32,3 @@ workflows:
       - rake_default:
           name: Ruby HEAD
           image: rubocophq/circleci-ruby-snapshot:latest # Nightly snapshot build
-      - rake_default:
-          name: JRuby 9.2
-          image: circleci/jruby:9.2

data/.rubocop.yml

@@ -1,14 +1,18 @@
 # This is the configuration used to check the rubocop source code.
 
-require:
-  - rubocop/cop/internal_affairs
+plugins:
+  - rubocop-internal_affairs
+  - rubocop-oracle
   - rubocop-performance
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   SuggestExtensions: false
 
+InternalAffairs/OnSendWithoutOnCSend:
+  Enabled: false
+
 Naming/PredicateName:
   # Method define macros for dynamically generated method.
   MethodDefinitionMacros:

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## master (unreleased)
 
+### New features
+
+## 1.0.0 (2025-04-05)
+
+* Pluginfy RuboCop Oracle. ([@koic][])
+
+## 0.2.0 (2021-04-14)
+
+### Changes
+
+* Mark `Oracle/OnlineIndex` as unsafe auto-correction. ([@koic][])
+
 ## 0.1.0 (2021-04-13)
 
 ### New features

data/README.md

@@ -19,6 +19,34 @@ or if you use bundler put this in your `Gemfile`
 gem 'rubocop-oracle'
 ```
 
+## Cops
+
+This gem contains `Oracle/OnlineIndex` cop to check if indexing is possible without stopping Rails application' service using Oracle.
+The cop supports safe migration for your production environment.
+
+### `Oracle/OnlineIndex` cop
+
+This cop checks for uses `options: online` option on `add_index`.
+The `ONLINE` option is required if you want to run with OLTP when indexing migration in Oracle.
+
+```ruby
+# bad
+add_index :table_name, :column_name
+
+# good
+add_index :table_name, :column_name, options: :online
+```
+
+By specifying `MigratedSchemaVersion` option, migration files that have been migrated can be ignored.
+
+```yaml
+# .rubocop.yml
+Oracle/OnlineIndex:
+  MigratedSchemaVersion: '202104130150' # Migration files lower than or equal to '202104130150' will be ignored.
+```
+
+This prevents detection of migration files that have already been applied to the production environment.
+
 ## Usage
 
 You need to tell RuboCop to load the Oracle extension. There are three

data/config/default.yml

@@ -20,7 +20,9 @@ AllCops:
 Oracle/OnlineIndex:
   Description: 'Checks for uses `options: online` option on `add_index`.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.1'
+  VersionChanged: '0.2'
   MigratedSchemaVersion: ~
   Include:
     - 'db/migrate/**/*.rb'

data/lib/rubocop/cop/oracle/online_index.rb

@@ -3,8 +3,7 @@
 module RuboCop
   module Cop
     module Oracle
-      #
-      # This cop checks for uses `options: online` option on `add_index`.
+      # Checks for uses `options: online` option on `add_index`.
       # The `ONLINE` option is required if you want to run with OLTP when indexing migration in Oracle.
       # By specifying `MigratedSchemaVersion` option, migration files that have been migrated can be ignored.
       #

data/lib/rubocop/oracle/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module Oracle
+    # A plugin that integrates RuboCop Oracle with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-oracle',
+          version: VERSION,
+          homepage: 'https://github.com/koic/rubocop-oracle',
+          description: 'A RuboCop extension for Active Record Oracle enhanced adapter.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join('../../../config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/oracle/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Oracle
-    VERSION = '0.1.0'
+    VERSION = '1.0.0'
   end
 end

data/lib/rubocop-oracle.rb

@@ -4,8 +4,5 @@ require 'rubocop'
 
 require_relative 'rubocop/oracle'
 require_relative 'rubocop/oracle/version'
-require_relative 'rubocop/oracle/inject'
-
-RuboCop::Oracle::Inject.defaults!
-
+require_relative 'rubocop/oracle/plugin'
 require_relative 'rubocop/cop/oracle_cops'

data/rubocop-oracle.gemspec

@@ -12,9 +12,11 @@ Gem::Specification.new do |spec|
   spec.description   = 'A RuboCop extension for Active Record Oracle enhanced adapter.'
   spec.homepage      = 'https://github.com/koic/rubocop-oracle'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.metadata['default_lint_roller_plugin'] = 'RuboCop::Oracle::Plugin'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -25,5 +27,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rubocop', '~> 1.0'
+  spec.add_dependency 'lint_roller', '~> 1.1'
+  spec.add_dependency 'rubocop', '~> 1.72'
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-oracle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Koichi ITO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-12 00:00:00.000000000 Z
+date: 2025-04-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.72'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.72'
 description: A RuboCop extension for Active Record Oracle enhanced adapter.
 email:
 - koic.ito@gmail.com
@@ -48,7 +62,7 @@ files:
 - lib/rubocop/cop/oracle/online_index.rb
 - lib/rubocop/cop/oracle_cops.rb
 - lib/rubocop/oracle.rb
-- lib/rubocop/oracle/inject.rb
+- lib/rubocop/oracle/plugin.rb
 - lib/rubocop/oracle/version.rb
 - rubocop-oracle.gemspec
 homepage: https://github.com/koic/rubocop-oracle
@@ -56,6 +70,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/koic/rubocop-oracle
+  rubygems_mfa_required: 'true'
+  default_lint_roller_plugin: RuboCop::Oracle::Plugin
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -64,14 +80,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.18
 signing_key:
 specification_version: 4
 summary: A RuboCop extension for Active Record Oracle enhanced adapter.

data/lib/rubocop/oracle/inject.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Oracle
-    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
-    # bit of our configuration.
-    module Inject
-      def self.defaults!
-        path = CONFIG_DEFAULT.to_s
-        hash = ConfigLoader.send(:load_yaml_configuration, path)
-        config = Config.new(hash, path).tap(&:make_excludes_absolute)
-        puts "configuration from #{path}" if ConfigLoader.debug?
-        config = ConfigLoader.merge_with_default(config, path, unset_nil: false)
-        ConfigLoader.instance_variable_set(:@default_configuration, config)
-      end
-    end
-  end
-end