rubocop-oracle 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f08071efb4fee0574a8a1665daf6a4206c836de8a8f3924a6b74b1267e654f46
-  data.tar.gz: 2193018fe03e09ed648a00639edf46dfe663148f29d0e61d64487af1b21857f9
+  metadata.gz: 4386eee3acd95655ca1eed299d20110d745f177d6d7e3c7583544c19f5d1d5e1
+  data.tar.gz: e0c8eab371f6a6d3c9bf915c581a42507596aea50e767ce4101a613469323b9a
 SHA512:
-  metadata.gz: 332761e4fabe2affbb55327b46b6e8d60a6620a59f91aabbe3b770a0e1ac3bf267ae02878698800c621651e28aac4d8e27ea92b0d7f22801900fc1bda5ff1804
-  data.tar.gz: 2c67d042742a50cc6d784e9769b7f705ec6a29ca3b5b08918518c348685f2fb5edbd2a757a308cc99d926477bc50215238ff127c87b4a88708b4f717adafb08b
+  metadata.gz: 248f4e8662943bee026bf35a02a97d3785e9081589d279f6e2331685830ece09f4cd59af73bea1821aa188ae7a03587b02335f8f85c3cc04e98c5b7be2feee95
+  data.tar.gz: ed9f6f5197432d7f96596293af50945dc0d226d1960dc1b9b635ae2227aef0d0e48eaec406eeb46070fbb28074073402d5ae14e577afab2a17210dba2000cf0d

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master (unreleased)
 
+## 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/oracle/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-oracle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Koichi ITO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-12 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop