rubocop-sequel 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65861f84673b5424553f927f79bfedf762fbc128
-  data.tar.gz: 8191bd88678e0980457aef64fb2a3748000e15cf
+  metadata.gz: a6bd53027cc6d6df7b1d67153a46c9ac5325509b
+  data.tar.gz: 32b4aa5476643d2c82d4c5495b77ba5cd3fcab02
 SHA512:
-  metadata.gz: d7be5cc421d8d5e9284c4d8304b41a4d483e237e5f1b8038a07649344ae059c6c11badfeede6231676f3be25c49bf80f491d636c91fc5fadfe2f3c5165637fee
-  data.tar.gz: ce105d871158dc7c62ba784d54239733b371f696b9ff766b6538f18deff561afd4238f062242254c9000d0f73fc4ed811b136ecdbb12ed2dda9639b8893490e9
+  metadata.gz: 75952359885f37ceafdc126f9df5b102f3f64d06ed761308085a6fe3498d68382a28bdfef00a6658c14af589f98900a70076fce221d425eb8167b3f2de1d8ed0
+  data.tar.gz: 2016916ef31f9459cc2ad51b4180534563d7c38f901a72e060db218716ddbad3ef9dfc2e35970333bb1877f7ea2d6f6e69018df4c5af37f5ce2de2bd188e5031

data/.github/workflows/actions.yml

@@ -0,0 +1,29 @@
+name: CI
+on: push
+
+jobs:
+  main:
+    name: Ruby ${{ matrix.ruby }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install gems
+        run: bundle install
+
+      - name: RuboCop
+        run: bundle exec rubocop --parallel
+
+      - name: RSpec
+        run: bundle exec rspec

data/.rubocop.yml

@@ -0,0 +1,17 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+Naming/FileName:
+  Exclude:
+    - 'lib/rubocop-sequel.rb'

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -1,10 +1,12 @@
+![CI status](https://github.com/rubocop-hq/rubocop-sequel/workflows/CI/badge.svg)
+
 # RuboCop Sequel
 
-Code style checking for Sequel.
+Code style checking for [Sequel](https://sequel.jeremyevans.net/).
 
 ## Installation
 
-Using the `rubocop-rspec` gem
+Using the `rubocop-sequel` gem
 
 ```bash
 gem install rubocop-sequel

data/lib/rubocop-sequel.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'rubocop'
 
 require 'rubocop/cop/sequel/column_default'
 require 'rubocop/cop/sequel/concurrent_index'
+require 'rubocop/cop/sequel/json_column'
 require 'rubocop/cop/sequel/migration_name'
 require 'rubocop/cop/sequel/save_changes'

data/lib/rubocop/cop/sequel/column_default.rb

@@ -1,16 +1,19 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module Sequel
       # ColumnDefault looks for column creation with a default value.
       class ColumnDefault < Cop
-        MSG = "Don't create new column with default values".freeze
+        MSG = "Don't create new column with default values"
 
-        def_node_matcher :add_column_default, <<-MATCHER
+        def_node_matcher :add_column_default?, <<-MATCHER
           (send _ :add_column ... (hash (pair (sym :default) _)))
         MATCHER
 
         def on_send(node)
-          return unless add_column_default(node)
+          return unless add_column_default?(node)
+
           add_offense(node, location: :selector, message: MSG)
         end
       end

data/lib/rubocop/cop/sequel/concurrent_index.rb

@@ -1,19 +1,19 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module Sequel
       # ConcurrentIndex looks for non-concurrent index creation.
       class ConcurrentIndex < Cop
-        MSG = 'Prefer creating new index concurrently'.freeze
+        MSG = 'Prefer creating or dropping new index concurrently'
 
-        def_node_matcher :add_index, <<-MATCHER
-          (send _ :add_index $...)
+        def_node_matcher :indexes?, <<-MATCHER
+          (send _ {:add_index :drop_index} $...)
         MATCHER
 
         def on_send(node)
-          add_index(node) do |args|
-            if offensive?(args)
-              add_offense(node, location: :selector, message: MSG)
-            end
+          indexes?(node) do |args|
+            add_offense(node, location: :selector, message: MSG) if offensive?(args)
           end
         end
 
@@ -22,6 +22,7 @@ module RuboCop
         def offensive?(args)
           !args.last.hash_type? || args.last.each_descendant.none? do |n|
             next unless n.sym_type?
+
             n.children.any? { |s| s == :concurrently }
           end
         end

data/lib/rubocop/cop/sequel/json_column.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sequel
+      # JSONColumn looks for non-JSONB columns.
+      class JSONColumn < Cop
+        MSG = 'Use JSONB rather than JSON or hstore'
+
+        def_node_matcher :json_or_hstore?, <<-MATCHER
+          (send _ :add_column ... (sym {:json :hstore}))
+        MATCHER
+
+        def_node_matcher :column_type?, <<-MATCHER
+          (send _ {:json :hstore} ...)
+        MATCHER
+
+        def_node_matcher :column_method?, <<-MATCHER
+          (send _ :column ... (sym {:json :hstore}))
+        MATCHER
+
+        def on_send(node)
+          return unless json_or_hstore?(node)
+
+          add_offense(node, location: :selector, message: MSG)
+        end
+
+        def on_block(node)
+          return unless node.send_node.method_name == :create_table
+
+          node.each_node(:send) do |method|
+            next unless column_method?(method) || column_type?(method)
+
+            add_offense(method, location: :selector, message: MSG)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sequel/migration_name.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module Sequel
       # MigrationName looks for migration files named with a default name.
       class MigrationName < Cop
-        MSG = 'Migration files should not use default name.'.freeze
+        include RangeHelp
+
+        MSG = 'Migration files should not use default name.'
 
         def investigate(processed_source)
           file_path = processed_source.buffer.name

data/lib/rubocop/cop/sequel/save_changes.rb

@@ -1,17 +1,20 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module Sequel
       # SaveChanges promotes the use of save_changes.
       class SaveChanges < Cop
         MSG = 'Use `Sequel::Model#save_changes` instead of '\
-          '`Sequel::Model#save`.'.freeze
+          '`Sequel::Model#save`.'
 
-        def_node_matcher :model_save, <<-MATCHER
+        def_node_matcher :model_save?, <<-MATCHER
           (send _ :save)
         MATCHER
 
         def on_send(node)
-          return unless model_save(node)
+          return unless model_save?(node)
+
           add_offense(node, location: :selector, message: MSG)
         end
 

data/lib/rubocop/sequel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   # RuboCop Sequel project namespace
   module Sequel

data/rubocop-sequel.gemspec

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |gem|
   gem.authors       = ['Timothée Peignier']
   gem.email         = ['timothee.peignier@tryphon.org']
   gem.description   = 'Code style checking for Sequel'
-  gem.summary       = 'A plugin for the RuboCop code style & linting tool.'
-  gem.homepage      = 'http://rubygems.org/gems/rubocop-sequel'
+  gem.summary       = 'A Sequel plugin for RuboCop'
+  gem.homepage      = 'https://github.com/rubocop-hq/rubocop-sequel'
   gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
@@ -11,13 +13,16 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = 'rubocop-sequel'
   gem.require_paths = ['lib']
-  gem.version       = '0.0.2'
+  gem.version       = '0.1.0'
+
+  gem.required_ruby_version = '~> 2.4'
 
-  gem.add_runtime_dependency 'rubocop', '~> 0.51', '>= 0.51'
+  gem.add_runtime_dependency 'rubocop', '~> 1.0'
 
-  gem.add_development_dependency 'rake', '~> 12.0.0', '>= 12.0.0'
-  gem.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'
-  gem.add_development_dependency 'sequel', '~> 4.41', '>= 4.41.0'
-  gem.add_development_dependency 'simplecov', '~> 0.12'
+  gem.add_development_dependency 'rake', '~> 12.3.0'
+  gem.add_development_dependency 'rspec', '~> 3.7'
+  gem.add_development_dependency 'rubocop-rspec', '~> 2.0'
+  gem.add_development_dependency 'sequel', '~> 4.49'
+  gem.add_development_dependency 'simplecov', '~> 0.16'
   gem.add_development_dependency 'sqlite3', '~> 1.3', '>= 1.3.12'
 end

data/spec/rubocop/cop/sequel/column_default_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe RuboCop::Cop::Sequel::ColumnDefault do

data/spec/rubocop/cop/sequel/concurrent_index_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe RuboCop::Cop::Sequel::ConcurrentIndex do
@@ -5,25 +7,35 @@ describe RuboCop::Cop::Sequel::ConcurrentIndex do
 
   context 'without the concurrent option' do
     it 'registers an offense without options' do
-      inspect_source('add_index(:products, :name)')
-      expect(cop.offenses.size).to eq(1)
+      inspect_source(<<~SOURCE)
+        add_index(:products, :name)
+        drop_index(:products, :name)
+      SOURCE
+      expect(cop.offenses.size).to eq(2)
     end
 
     it 'registers an offense with other options' do
-      inspect_source('add_index(:products, :name, unique: true)')
-      expect(cop.offenses.size).to eq(1)
+      inspect_source(<<~SOURCE)
+        add_index(:products, :name, unique: true)
+        drop_index(:products, :name, unique: true)
+      SOURCE
+      expect(cop.offenses.size).to eq(2)
     end
 
     it 'registers an offense with composite index' do
-      inspect_source('add_index(:products, :name, unique: true)')
-      expect(cop.offenses.size).to eq(1)
+      inspect_source(<<~SOURCE)
+        add_index(:products, [:name, :price], unique: true)
+        drop_index(:products, [:name, :price])
+      SOURCE
+      expect(cop.offenses.size).to eq(2)
     end
   end
 
   it 'does not register an offense when using concurrent option' do
-    inspect_source(
-      'add_index(:products, :name, unique: true, concurrently: true)'
-    )
+    inspect_source(<<~SOURCE)
+      add_index(:products, :name, unique: true, concurrently: true)
+      drop_index(:products, :name, concurrently: true)
+    SOURCE
     expect(cop.offenses).to be_empty
   end
 end

data/spec/rubocop/cop/sequel/json_column_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RuboCop::Cop::Sequel::JSONColumn do
+  subject(:cop) { described_class.new }
+
+  context 'with add_column' do
+    it 'registers an offense when using json type' do
+      inspect_source('add_column(:products, :type, :json)')
+      expect(cop.offenses.size).to eq(1)
+    end
+
+    it 'registers an offense when using hstore type' do
+      inspect_source('add_column(:products, :type, :hstore)')
+      expect(cop.offenses.size).to eq(1)
+    end
+
+    it 'does not register an offense when using jsonb' do
+      inspect_source('add_column(:products, :type, :jsonb)')
+      expect(cop.offenses).to be_empty
+    end
+  end
+
+  context 'with create_table' do
+    it 'registers an offense when using json as a method' do
+      inspect_source('create_table(:products) { json :type, default: {} }')
+      expect(cop.offenses.size).to eq(1)
+    end
+
+    it 'registers an offense when using the column method with hstore' do
+      inspect_source('create_table(:products) { column :type, :hstore }')
+      expect(cop.offenses.size).to eq(1)
+    end
+
+    it 'does not register an offense when using jsonb as column type`' do
+      inspect_source('create_table(:products) { column :type, :jsonb }')
+      expect(cop.offenses).to be_empty
+    end
+
+    it 'does not register an offense when using jsonb' do
+      inspect_source('create_table(:products) { jsonb :type }')
+      expect(cop.offenses).to be_empty
+    end
+
+    it 'does not register an offense when using a simple type' do
+      inspect_source('create_table(:products) { integer :type, default: 0 }')
+      expect(cop.offenses).to be_empty
+    end
+  end
+end

data/spec/rubocop/cop/sequel/migration_name_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe RuboCop::Cop::Sequel::MigrationName, :config do
@@ -11,7 +13,7 @@ describe RuboCop::Cop::Sequel::MigrationName, :config do
     )
   end
 
-  context 'default configuration' do
+  context 'with default configuration' do
     let(:cop_config) { {} }
 
     it 'registers an offense when using the default name' do

data/spec/rubocop/cop/sequel/save_changes_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe RuboCop::Cop::Sequel::SaveChanges do

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubocop'
 require 'rubocop/rspec/support'
 require 'rubocop-sequel'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sequel
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Timothée Peignier
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2020-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,94 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 12.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 12.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
-    - - ">="
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.41'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.41.0
+        version: '4.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.41'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.41.0
+        version: '4.49'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -131,53 +121,55 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/actions.yml"
 - ".gitignore"
 - ".rspec"
-- ".rubocop_todo.yml"
-- ".travis.yml"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE
 - README.md
 - lib/rubocop-sequel.rb
 - lib/rubocop/cop/sequel/column_default.rb
 - lib/rubocop/cop/sequel/concurrent_index.rb
+- lib/rubocop/cop/sequel/json_column.rb
 - lib/rubocop/cop/sequel/migration_name.rb
 - lib/rubocop/cop/sequel/save_changes.rb
 - lib/rubocop/sequel.rb
 - rubocop-sequel.gemspec
-- rubocop.yml
 - spec/rubocop/cop/sequel/column_default_spec.rb
 - spec/rubocop/cop/sequel/concurrent_index_spec.rb
+- spec/rubocop/cop/sequel/json_column_spec.rb
 - spec/rubocop/cop/sequel/migration_name_spec.rb
 - spec/rubocop/cop/sequel/save_changes_spec.rb
 - spec/spec_helper.rb
-homepage: http://rubygems.org/gems/rubocop-sequel
+homepage: https://github.com/rubocop-hq/rubocop-sequel
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.11
+signing_key:
 specification_version: 4
-summary: A plugin for the RuboCop code style & linting tool.
+summary: A Sequel plugin for RuboCop
 test_files:
 - spec/rubocop/cop/sequel/column_default_spec.rb
 - spec/rubocop/cop/sequel/concurrent_index_spec.rb
+- spec/rubocop/cop/sequel/json_column_spec.rb
 - spec/rubocop/cop/sequel/migration_name_spec.rb
 - spec/rubocop/cop/sequel/save_changes_spec.rb
 - spec/spec_helper.rb

data/.rubocop_todo.yml

@@ -1,13 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2016-12-16 21:46:22 -0800 using RuboCop version 0.46.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 88

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.3
-  - 2.4.0
-script: bundle exec rspec spec

data/rubocop.yml

@@ -1,3 +0,0 @@
-inherit_from: .rubocop_todo.yml
-AllCops:
-  TargetRubyVersion: 2.3