rubocop-oracle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f08071efb4fee0574a8a1665daf6a4206c836de8a8f3924a6b74b1267e654f46
+  data.tar.gz: 2193018fe03e09ed648a00639edf46dfe663148f29d0e61d64487af1b21857f9
+SHA512:
+  metadata.gz: 332761e4fabe2affbb55327b46b6e8d60a6620a59f91aabbe3b770a0e1ac3bf267ae02878698800c621651e28aac4d8e27ea92b0d7f22801900fc1bda5ff1804
+  data.tar.gz: 2c67d042742a50cc6d784e9769b7f705ec6a29ca3b5b08918518c348685f2fb5edbd2a757a308cc99d926477bc50215238ff127c87b4a88708b4f717adafb08b

data/.circleci/config.yml

@@ -0,0 +1,43 @@
+version: 2.1
+
+jobs:
+  rake_default:
+    parameters:
+      image:
+        description: "Name of the Docker image."
+        type: string
+        default: "circleci/ruby"
+    docker:
+      - image: << parameters.image >>
+    environment:
+      # CircleCI container has two cores, but Ruby can see 32 cores. So we
+      # configure test-queue.
+      # See https://github.com/tmm1/test-queue#environment-variables
+      TEST_QUEUE_WORKERS: 2
+      JRUBY_OPTS: "--dev -J-Xmx1000M"
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rake
+
+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
+      - rake_default:
+          name: Ruby 3.0
+          image: circleci/ruby:3.0
+      - 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/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: koic

data/.gitignore

@@ -0,0 +1,62 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+Gemfile.lock
+Gemfile.local
+
+# rbenv
+.ruby-version
+
+# rspec
+/spec/examples.txt
+/.test_queue_stats
+.rspec_status
+
+# jeweler generated
+pkg
+
+# etags
+TAGS
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,84 @@
+# This is the configuration used to check the rubocop source code.
+
+require:
+  - rubocop/cop/internal_affairs
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+
+Naming/PredicateName:
+  # Method define macros for dynamically generated method.
+  MethodDefinitionMacros:
+    - define_method
+    - define_singleton_method
+    - def_node_matcher
+    - def_node_search
+
+Style/FormatStringToken:
+  # Because we parse a lot of source codes from strings. Percent arrays
+  # look like unannotated format string tokens to this cop.
+  Exclude:
+    - test/**/*
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+      - module_inclusion
+      - constants
+      - public_class_methods
+      - initializer
+      - instance_methods
+      - protected_methods
+      - private_methods
+
+# Trailing white space is meaningful in code examples
+Layout/TrailingWhitespace:
+  AllowInHeredoc: true
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'test/**/*.rb'
+
+Lint/InterpolationCheck:
+  Exclude:
+    - 'test/**/*.rb'
+
+Lint/UselessAccessModifier:
+  MethodCreatingMethods:
+    - 'def_matcher'
+    - 'def_node_matcher'
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - '**/*.gemspec'
+
+Naming/FileName:
+  Exclude:
+    - lib/rubocop-oracle.rb
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'test/**/*.rb'
+
+Performance/ChainArrayAllocation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change log
+
+## master (unreleased)
+
+## 0.1.0 (2021-04-13)
+
+### New features
+
+* Create RuboCop Oracle gem. ([@koic][])
+
+[@koic]: https://github.com/koic

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubocop-oracle.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'
+gem 'rubocop-performance'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Koichi ITO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# RuboCop Oracle
+
+[![Gem Version](https://badge.fury.io/rb/rubocop-oracle.svg)](https://badge.fury.io/rb/rubocop-oracle)
+[![CircleCI](https://circleci.com/gh/koic/rubocop-oracle.svg?style=svg)](https://circleci.com/gh/koic/rubocop-oracle)
+
+A [RuboCop](https://github.com/rubocop-hq/rubocop) extension for [Active Record Oracle enhanced adapter](https://github.com/rsim/oracle-enhanced).
+
+## Installation
+
+Just install the `rubocop-oracle` gem
+
+```sh
+gem install rubocop-oracle
+```
+
+or if you use bundler put this in your `Gemfile`
+
+```ruby
+gem 'rubocop-oracle'
+```
+
+## Usage
+
+You need to tell RuboCop to load the Oracle extension. There are three
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-oracle
+```
+
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+require:
+  - rubocop-other-extension
+  - rubocop-oracle
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop Oracle
+cops together with the standard cops.
+
+### Command line
+
+```sh
+rubocop --require rubocop-oracle
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-oracle'
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/koic/rubocop-oracle.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rubocop/oracle'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/default.yml

@@ -0,0 +1,26 @@
+# Common configuration.
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  Exclude:
+    - bin/*
+    - db/schema.rb
+  # What version of Rails is the inspected code using?  If a value is specified
+  # for TargetRailsVersion then it is used.  Acceptable values are specificed
+  # as a float (i.e. 5.1); the patch version of Rails should not be included.
+  # If TargetRailsVersion is not set, RuboCop will parse the Gemfile.lock or
+  # gems.locked file to find the version of Rails that has been bound to the
+  # application.  If neither of those files exist, RuboCop will use Rails 5.0
+  # as the default.
+  TargetRailsVersion: ~
+
+Oracle/OnlineIndex:
+  Description: 'Checks for uses `options: online` option on `add_index`.'
+  Enabled: true
+  VersionAdded: '0.1'
+  MigratedSchemaVersion: ~
+  Include:
+    - 'db/migrate/**/*.rb'

data/lib/rubocop-oracle.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/oracle'
+require_relative 'rubocop/oracle/version'
+require_relative 'rubocop/oracle/inject'
+
+RuboCop::Oracle::Inject.defaults!
+
+require_relative 'rubocop/cop/oracle_cops'

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Oracle
+      #
+      # 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.
+      # By specifying `MigratedSchemaVersion` option, migration files that have been migrated can be ignored.
+      #
+      # @example
+      #
+      #   # bad
+      #   add_index :table_name, :column_name
+      #
+      #   # good
+      #   add_index :table_name, :column_name, options: :online
+      #
+      # @example MigratedSchemaVersion: '202104130150'
+      #
+      #   # bad - Migration files higher than '202104130150' will be registered an offense.
+      #   add_index :table_name, :column_name
+      #
+      #   # good - Migration files lower than or equal to '202104130150' will be ignored.
+      #   add_index :table_name, :column_name
+      #
+      class OnlineIndex < Base
+        extend AutoCorrector
+
+        MSG = 'Specify `options: :online` option to `add_index`.'
+        RESTRICT_ON_SEND = %i[add_index].freeze
+
+        def on_send(node)
+          return if already_migrated_file? || use_online_option?(node.last_argument)
+
+          add_offense(node.loc.selector) do |corrector|
+            corrector.insert_after(node, ', options: :online')
+          end
+        end
+
+        private
+
+        def already_migrated_file?
+          schema_version = File.basename(processed_source.file_path).match(/(?<timestamp>\d{12})/)['timestamp']
+          return false unless migrated_schema_version
+
+          schema_version <= migrated_schema_version # Ignore applied migration files.
+        end
+
+        def use_online_option?(options)
+          if options.hash_type?
+            options.each_pair do |key, value|
+              return true if key.source.match?(/\A:?options\z/i) && value.source.match?(/\A:?online\z/i)
+            end
+          end
+
+          false
+        end
+
+        def migrated_schema_version
+          cop_config.fetch('MigratedSchemaVersion', nil)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/oracle_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'oracle/online_index'

data/lib/rubocop/oracle.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative 'oracle/version'
+
+module RuboCop
+  # RuboCop Oralce project namespace
+  module Oracle
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop/oracle/inject.rb

@@ -0,0 +1,18 @@
+# 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

data/lib/rubocop/oracle/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Oracle
+    VERSION = '0.1.0'
+  end
+end

data/rubocop-oracle.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rubocop/oracle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop-oracle'
+  spec.version       = RuboCop::Oracle::VERSION
+  spec.authors       = ['Koichi ITO']
+  spec.email         = ['koic.ito@gmail.com']
+
+  spec.summary       = 'A RuboCop extension for Active Record Oracle enhanced adapter.'
+  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.metadata['homepage_uri'] = spec.homepage
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rubocop', '~> 1.0'
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-oracle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koichi ITO
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A RuboCop extension for Active Record Oracle enhanced adapter.
+email:
+- koic.ito@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".github/FUNDING.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop-oracle.rb
+- 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/version.rb
+- rubocop-oracle.gemspec
+homepage: https://github.com/koic/rubocop-oracle
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/koic/rubocop-oracle
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: A RuboCop extension for Active Record Oracle enhanced adapter.
+test_files: []