rubocop-sequel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7060c587b01d22b660cfabc0ead46e03524b0f51
+  data.tar.gz: 59617e179cec66a67b2d051f0dde3170164b4026
+SHA512:
+  metadata.gz: acdd32c982d42943d8b0dc806668699b024f56deeafc3c9bb38a3c300d650234209a61721396466c82f989482420c29b6618f0a99733c274882eee7153067773
+  data.tar.gz: 39473108b08740593758b370b41848b831d12aea8b44434a433f121ce0315dc035b19b2e6facf6fe52ca15cab15ab73fc3230c96b7e32e800ae0d9e5b038f30b

data/.gitignore

@@ -0,0 +1,2 @@
+.tags
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop_todo.yml

@@ -0,0 +1,13 @@
+# 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/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    rubocop-sequel (0.0.1)
+      rubocop (~> 0.46, >= 0.46)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (2.0.2)
+    parser (2.3.3.1)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.46.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    sequel (4.41.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sqlite3 (1.3.12)
+    unicode-display_width (1.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 3.5, >= 3.5.0)
+  rubocop-sequel!
+  sequel (~> 4.41, >= 4.41.0)
+  simplecov (~> 0.12)
+  sqlite3 (~> 1.3, >= 1.3.12)
+
+BUNDLED WITH
+   1.13.6

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Timothée Peignier <timothee.peignier@tryphon.org>
+
+MIT License
+
+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,44 @@
+# RuboCop Sequel
+
+Code style checking for Sequel.
+
+## Installation
+
+Using the `rubocop-rspec` gem
+
+```bash
+gem install rubocop-sequel
+```
+
+or using bundler by adding in your `Gemfile`
+
+```
+gem 'rubocop-sequel'
+```
+
+## Usage
+
+### RuboCop configuration file
+
+Add to your `.rubocop.yml`.
+
+```
+require: rubocop-sequel
+```
+
+`rubocop` will now automatically load RuboCop Sequel
+cops alongside with the standard cops.
+
+### Command line
+
+```bash
+rubocop --require rubocop-sequel
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-sequel'
+end
+```

data/lib/rubocop-sequel.rb

@@ -0,0 +1,6 @@
+require 'rubocop'
+
+require 'rubocop/cop/sequel/column_default'
+require 'rubocop/cop/sequel/concurrent_index'
+require 'rubocop/cop/sequel/migration_name'
+require 'rubocop/cop/sequel/save_changes'

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

@@ -0,0 +1,18 @@
+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
+
+        def_node_matcher :add_column_default, <<-END
+          (send _ :add_column ... (hash (pair (sym :default) _)))
+        END
+
+        def on_send(node)
+          add_offense(node, :selector, MSG) if add_column_default(node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module RuboCop
+  module Cop
+    module Sequel
+      # ConcurrentIndex looks for non-concurrent index creation.
+      class ConcurrentIndex < Cop
+        MSG = 'Prefer creating new index concurrently'.freeze
+
+        def_node_matcher :add_index, <<-END
+          (send _ :add_index $...)
+        END
+
+        def on_send(node)
+          add_index(node) do |args|
+            add_offense(node, :selector, MSG) if offensive?(args)
+          end
+        end
+
+        private
+
+        def offensive?(args)
+          !args.last.hash_type? || !args.last.each_descendant.any? do |n|
+            next unless n.sym_type?
+            n.children.any? { |s| s == :concurrently }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+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
+
+        def investigate(processed_source)
+          file_path = processed_source.buffer.name
+          return if config.file_to_include?(file_path)
+
+          return unless filename_bad?(file_path)
+
+          add_offense(nil, source_range(processed_source.buffer, 1, 0), nil)
+        end
+
+        private
+
+        def filename_bad?(path)
+          basename = File.basename(path)
+          basename =~ /#{cop_config.fetch('DefaultName', 'new_migration')}/
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+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
+
+        def_node_matcher :model_save, <<-END
+          (send _ :save)
+        END
+
+        def on_send(node)
+          add_offense(node, :selector, MSG) if model_save(node)
+        end
+
+        def autocorrect(node)
+          ->(corrector) { corrector.replace(node.loc.selector, 'save_changes') }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/sequel.rb

@@ -0,0 +1,5 @@
+module RuboCop
+  # RuboCop Sequel project namespace
+  module Sequel
+  end
+end

data/rubocop-sequel.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+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.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'rubocop-sequel'
+  gem.require_paths = ['lib']
+  gem.version       = '0.0.1'
+
+  gem.add_runtime_dependency 'rubocop', '~> 0.46', '>= 0.46'
+
+  gem.add_development_dependency 'sequel', '~> 4.41', '>= 4.41.0'
+  gem.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'
+  gem.add_development_dependency 'simplecov', '~> 0.12'
+  gem.add_development_dependency 'sqlite3', '~> 1.3', '>= 1.3.12'
+end

data/rubocop.yml

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

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

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe RuboCop::Cop::Sequel::ColumnDefault do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offense when setting a default' do
+    inspect_source(cop, 'add_column(:products, :type, :text, default: "cop")')
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it 'does not register an offense when not setting a default' do
+    inspect_source(cop, 'add_column(:products, :type, :text)')
+    expect(cop.offenses).to be_empty
+  end
+end

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

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe RuboCop::Cop::Sequel::ConcurrentIndex do
+  subject(:cop) { described_class.new }
+
+  context 'without the concurrent option' do
+    it 'registers an offense without options' do
+      inspect_source(cop, 'add_index(:products, :name)')
+      expect(cop.offenses.size).to eq(1)
+    end
+
+    it 'registers an offense with other options' do
+      inspect_source(cop, 'add_index(:products, :name, unique: true)')
+      expect(cop.offenses.size).to eq(1)
+    end
+
+    it 'registers an offense with composite index' do
+      inspect_source(cop, 'add_index(:products, :name, unique: true)')
+      expect(cop.offenses.size).to eq(1)
+    end
+  end
+
+  it 'does not register an offense when using concurrent option' do
+    inspect_source(cop, 'add_index(:products, :name, unique: true, concurrently: true)')
+    expect(cop.offenses).to be_empty
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe RuboCop::Cop::Sequel::MigrationName, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) do
+    RuboCop::Config.new(
+      { 'AllCops' => { 'Include' => [] },
+        'Sequel/MigrationName' => cop_config },
+      '/some/.rubocop.yml'
+    )
+  end
+
+  context 'default configuration' do
+    let(:cop_config) { {} }
+
+    it 'registers an offense when using the default name' do
+      inspect_source(cop, '', 'new_migration.rb')
+      expect(cop.offenses.size).to eq(1)
+    end
+
+    it 'does not register an offense when using a specific name' do
+      inspect_source(cop, '', 'add_index.rb')
+      expect(cop.offenses).to be_empty
+    end
+  end
+
+  context 'with custom configuration' do
+    let(:cop_config) { { 'DefaultName' => 'add_migration' } }
+
+    it 'registers an offense when using the default name' do
+      inspect_source(cop, '', 'add_migration.rb')
+      expect(cop.offenses.size).to eq(1)
+    end
+
+    it 'does not register an offense when using a specific name' do
+      inspect_source(cop, '', 'add_index.rb')
+      expect(cop.offenses).to be_empty
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe RuboCop::Cop::Sequel::SaveChanges do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offense when using save' do
+    inspect_source(cop, 'favorite.save')
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it 'does not register an offense when using save_changes' do
+    inspect_source(cop, 'favorite.save_changes')
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'auto-corrects by using save_changes' do
+    new_source = autocorrect_source(cop, 'favorite.save')
+    expect(new_source).to eq('favorite.save_changes')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'rubocop'
+require 'rubocop/rspec/support'
+require 'rubocop-sequel'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-sequel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Timothée Peignier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.46'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.46'
+- !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
+  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
+- !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
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.12
+description: Code style checking for Sequel
+email:
+- timothee.peignier@tryphon.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop_todo.yml"
+- Gemfile
+- Gemfile.lock
+- 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/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/migration_name_spec.rb
+- spec/rubocop/cop/sequel/save_changes_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/rubocop-sequel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A plugin for the RuboCop code style & linting tool.
+test_files:
+- spec/rubocop/cop/sequel/column_default_spec.rb
+- spec/rubocop/cop/sequel/concurrent_index_spec.rb
+- spec/rubocop/cop/sequel/migration_name_spec.rb
+- spec/rubocop/cop/sequel/save_changes_spec.rb
+- spec/spec_helper.rb