rubocop-postgresql_cursor 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0f03dcc56486d825b1b6456f2b036ab36c0ba55
+  data.tar.gz: 34e8cc5c3ecf32effd0c09c408811631746f3be7
+SHA512:
+  metadata.gz: 0c69acf7e46f610ce31b198727aae092d6299c0cf09050340c87a7b06a22663988910ae9e4586ee497c545319836fb92c98c96926ec052c87e2341cc83fc2b18
+  data.tar.gz: 1a944149b512087c54eb78eef5b2ac18d5c5135f479d5a09068323944a78342aef9db92b066f6711711af4183e5a8bc2acb5269753ae3e28b92e5fd1b77dcf72

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubocop_postgres_cursor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Tijmen Brommet
+
+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,32 @@
+# Rubocop - Enforce PostgreSQL Cursor usage
+
+Enforces the use of `each_instance` over `find_each`, so that all batching is done with [the postgresql_cursor gem](https://github.com/afair/postgresql_cursor).
+
+Supports auto-correct!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-postgresql_cursor'
+```
+
+And then execute:
+
+    $ bundle
+
+Add the following line to `rubocop.yml`:
+
+```
+require:
+ - rubocop-postgresql_cursor
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/tijmenb/rubocop-postgres_cursor/fork )
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/rubocop/cop/rails/postgresql_cursor.rb

@@ -0,0 +1,22 @@
+module RuboCop
+  module Cop
+    module Rails
+      class PostgresqlCursor < Cop
+        MSG = 'Prefer `each_instance` over `find_each`.'
+
+        def on_send(node)
+          _receiver, method_name, *_args = *node
+          return unless :find_each == method_name
+
+          add_offense(node, :selector, MSG)
+        end
+
+        def autocorrect(node)
+          @corrections << lambda do |corrector|
+            corrector.replace(node.loc.selector, 'each_instance')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop-postgresql_cursor/version.rb

@@ -0,0 +1,3 @@
+module RubocopPostgresqlCursor
+  VERSION = '0.0.2'
+end

data/lib/rubocop-postgresql_cursor.rb

@@ -0,0 +1,3 @@
+require 'rubocop-postgresql_cursor/version'
+
+require 'rubocop/cop/rails/postgresql_cursor'

data/rubocop_postgresql_cursor.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubocop-postgresql_cursor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-postgresql_cursor"
+  spec.version       = RubocopPostgresqlCursor::VERSION
+  spec.authors       = ["tijmen"]
+  spec.email         = ["tijmen@gmail.com"]
+  spec.summary       = %q{Enforce usage of each_instance over find_each.}
+  spec.description   = %q{Enforce usage of the postgresql_cursor gem in Rails
+                          projects. }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rubocop', '~> 0.24'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/spec/lib/rubocop_postgresql_cursor_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe RuboCop::Cop::Rails::PostgresqlCursor do
+  subject(:cop) { described_class.new }
+
+  it "registers an offense for find_each" do
+    inspect_source_file(cop, "User.find_each { |x| x }")
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it 'auto-corrects to each_instance' do
+    new_source = autocorrect_source_file(cop, 'User.find_each')
+    expect(new_source).to eq('User.each_instance')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+# As much as possible, we try to reuse RuboCop's spec environment.
+require File.join(
+Gem::Specification.find_by_name('rubocop').gem_dir, 'spec', 'spec_helper.rb'
+)
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rubocop-postgres_cursor'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-postgresql_cursor
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- tijmen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: "Enforce usage of the postgresql_cursor gem in Rails\n                          projects. "
+email:
+- tijmen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rubocop-postgresql_cursor.rb
+- lib/rubocop-postgresql_cursor/version.rb
+- lib/rubocop/cop/rails/postgresql_cursor.rb
+- rubocop_postgresql_cursor.gemspec
+- spec/lib/rubocop_postgresql_cursor_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Enforce usage of each_instance over find_each.
+test_files:
+- spec/lib/rubocop_postgresql_cursor_spec.rb
+- spec/spec_helper.rb
+has_rdoc: