Merge pull request #1185 from yahonda/rubocop_init

Enable RuboCop and configure GitHub Actions to run RuboCop

.github/workflows/rubocop.yml

@@ -0,0 +1,20 @@
+name: rubocop
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.2
+      - name: Install gems
+        run: bundle install --jobs 4 --retry 3
+      - name: Run RuboCop
+        run: bundle exec rubocop --parallel

.rubocop.yml

@@ -0,0 +1,42 @@
+AllCops:
+  # TargetRubyVersion value is based on `required_ruby_version = '>= 2.3'` in the ransack.gemspec
+  TargetRubyVersion: 2.3
+
+  DisabledByDefault: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: true
+
+Layout/EmptyLines:
+  Enabled: true
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+
+Style/SelfAssignment:
+  Enabled: true
+
+Style/Semicolon:
+  Enabled: true
+

Gemfile

@@ -49,3 +49,8 @@ group :test do
   gem 'rspec', '~> 3'
   gem 'simplecov', :require => false
 end
+
+# RuboCop 0.81.0 is the last version which supports Ruby 2.3.
+# Once Ransack required_ruby_version is bumped, RuboCop version can be bumped.
+# https://github.com/rubocop-hq/rubocop/pull/7869
+gem 'rubocop', '=0.81.0', require: false

lib/polyamorous/polyamorous.rb

@@ -11,7 +11,7 @@ module Polyamorous
   require 'polyamorous/join'
   require 'polyamorous/swapping_reflection_class'
 
-  ar_version = ::ActiveRecord::VERSION::STRING[0,3]
+  ar_version = ::ActiveRecord::VERSION::STRING[0, 3]
   %w(join_association join_dependency reflection).each do |file|
     require "polyamorous/activerecord_#{ar_version}_ruby_2/#{file}"
   end

lib/ransack.rb

@@ -7,7 +7,7 @@
 
 module Ransack
   extend Configuration
-  class UntraversableAssociationError < StandardError; end;
+  class UntraversableAssociationError < StandardError; end
 end
 
 Ransack.configure do |config|

lib/ransack/adapters/active_record/ransack/constants.rb

@@ -97,7 +97,7 @@ module Constants
         arel_predicate: proc { |v| v ? EQ : NOT_EQ },
         compounds: false,
         type: :boolean,
-        validator: proc { |v| BOOLEAN_VALUES.include?(v)},
+        validator: proc { |v| BOOLEAN_VALUES.include?(v) },
         formatter: proc { |v| nil }
         }
       ],

lib/ransack/constants.rb

@@ -36,7 +36,7 @@ module Constants
       'lt'.freeze, 'lteq'.freeze,
       'gt'.freeze, 'gteq'.freeze,
       'in'.freeze, 'not_in'.freeze
-      ].freeze
+    ].freeze
     A_S_I               = ['a'.freeze, 's'.freeze, 'i'.freeze].freeze
 
     EQ                  = 'eq'.freeze
@@ -52,4 +52,3 @@ module Constants
     RANSACK_SLASH_SEARCHES_SLASH_SEARCH = 'ransack/searches/search'.freeze
   end
 end
-

lib/ransack/helpers.rb

@@ -1,2 +1,2 @@
 require 'ransack/helpers/form_builder'
-require 'ransack/helpers/form_helper'
+require 'ransack/helpers/form_helper'

lib/ransack/helpers/form_builder.rb

@@ -45,9 +45,9 @@ def submit(value = nil, options = {})
       end
 
       def attribute_select(options = nil, html_options = nil, action = nil)
-        options = options || {}
-        html_options = html_options || {}
-        action = action || Constants::SEARCH
+        options ||= {}
+        html_options ||= {}
+        action ||= Constants::SEARCH
         default = options.delete(:default)
         raise ArgumentError, formbuilder_error_message(
           "#{action}_select") unless object.respond_to?(:context)

lib/ransack/nodes/attribute.rb

@@ -30,7 +30,7 @@ def associated_collection?
 
       def type
         if ransacker
-          return ransacker.type
+          ransacker.type
         else
           context.type_for(self)
         end

lib/ransack/nodes/condition.rb

@@ -127,7 +127,6 @@ def combinator=(val)
       alias :m= :combinator=
       alias :m :combinator
 
-
       # == build_attribute
       #
       #  This method was originally called from Nodes::Grouping#new_condition
@@ -263,7 +262,6 @@ def attr_value_for_attribute(attr)
         attr.attr
       end
 
-
       def default_type
         predicate.type || (attributes.first && attributes.first.type)
       end

lib/ransack/nodes/sort.rb

@@ -9,7 +9,7 @@ class Sort < Node
       class << self
         def extract(context, str)
           return unless str
-          attr, direction = str.split(/\s+/,2)
+          attr, direction = str.split(/\s+/, 2)
           self.new(context).build(name: attr, dir: direction)
         end
       end

lib/ransack/nodes/value.rb

@@ -50,7 +50,7 @@ def cast_to_date(val)
           y, m, d = *[val].flatten
           m ||= 1
           d ||= 1
-          Date.new(y,m,d) rescue nil
+          Date.new(y, m, d) rescue nil
         end
       end
 

ransack.gemspec

@@ -1,13 +1,14 @@
 # -*- encoding: utf-8 -*-
+
 $:.push File.expand_path("../lib", __FILE__)
 require "ransack/version"
 
 Gem::Specification.new do |s|
   s.name        = "ransack"
   s.version     = Ransack::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Ernie Miller", "Ryan Bigg", "Jon Atack","Sean Carroll"]
-  s.email       = ["[email protected]", "[email protected]", "[email protected]","[email protected]"]
+  s.authors     = ["Ernie Miller", "Ryan Bigg", "Jon Atack", "Sean Carroll"]
+  s.email       = ["[email protected]", "[email protected]", "[email protected]", "[email protected]"]
   s.homepage    = "https://github.com/activerecord-hackery/ransack"
   s.summary     = %q{Object-based searching for Active Record and Mongoid (currently).}
   s.description = %q{Ransack is the successor to the MetaSearch gem. It improves and expands upon MetaSearch's functionality, but does not have a 100%-compatible API.}

spec/blueprints/articles.rb

@@ -2,4 +2,4 @@
   person
   title
   body
-end
+end

spec/blueprints/comments.rb

@@ -2,4 +2,4 @@
   article
   person
   body
-end
+end

spec/blueprints/notes.rb

@@ -2,4 +2,4 @@
   note
   notable_type { "Article" }
   notable_id
-end
+end

spec/blueprints/tags.rb

@@ -1,3 +1,3 @@
 Tag.blueprint do
   name    { Sham.tag_name }
-end
+end

spec/helpers/ransack_helper.rb

@@ -6,4 +6,4 @@ def quote_table_name(table)
   def quote_column_name(column)
     ActiveRecord::Base.connection.quote_column_name(column)
   end
-end
+end

spec/ransack/adapters/active_record/base_spec.rb

@@ -464,9 +464,9 @@ def self.simple_escaping?
               Comment.create(article: Article.create(title: 'Avenger'), person: Person.create(salary: 100_000)),
               Comment.create(article: Article.create(title: 'Avenge'), person: Person.create(salary: 50_000)),
             ]
-            expect(Comment.ransack(article_title_cont: 'aven',s: 'person_salary desc').result).to eq(comments)
+            expect(Comment.ransack(article_title_cont: 'aven', s: 'person_salary desc').result).to eq(comments)
             expect(Comment.joins(:person).ransack(s: 'persons_salarydesc', article_title_cont: 'aven').result).to eq(comments)
-            expect(Comment.joins(:person).ransack(article_title_cont: 'aven',s: 'persons_salary desc').result).to eq(comments)
+            expect(Comment.joins(:person).ransack(article_title_cont: 'aven', s: 'persons_salary desc').result).to eq(comments)
           end
 
           it 'allows sort by `only_sort` field' do
@@ -545,7 +545,6 @@ def self.simple_escaping?
             )
           end
 
-
           it 'should allow passing ransacker arguments to a ransacker' do
             s = Person.ransack(
               c: [{

spec/ransack/adapters/active_record/context_spec.rb

@@ -9,7 +9,6 @@ module ActiveRecord
       describe Context do
         subject { Context.new(Person) }
 
-
         it 'has an Active Record alias tracker method' do
           expect(subject.alias_tracker)
           .to be_an ::ActiveRecord::Associations::AliasTracker
@@ -81,7 +80,7 @@ module ActiveRecord
           end
 
           it 'build correlated subquery for multiple conditions (default scope)' do
-            search = Search.new(Person, { comments_body_not_eq: 'some_title'})
+            search = Search.new(Person, { comments_body_not_eq: 'some_title' })
 
             # Was
             # SELECT "people".* FROM "people" WHERE "people"."id" NOT IN (