rails-cops 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1d40596f0dc6a124e29d0c82f55f0ca48de0153c64cc164718ea504fcb22783
+  data.tar.gz: ab0d3b8d41383d206f0f9694053b18b328b52d7a34e0aa9aba42da1b9a32da6d
+SHA512:
+  metadata.gz: 4ff62a7873f745ceca834c11722ccef1dd058e4b40128527d9fc2e4c2fe63b437066c5aee090ce9a70b316400c69b453d332684511833e1c13ab60208dd8e43e
+  data.tar.gz: dbb960fa43c3a965159c1494a35904e09204d022f30b2715559efe2d3681350f32bf0f91a1db98b64a893d5e7e04799a952ea8691f44e56989771befa5e1e96a

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-09-05
+
+- Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails-cops.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    rails-cops (0.1.0)
+      activesupport (>= 4.2.0)
+      rubocop (>= 1.33.0, < 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    minitest (5.17.0)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.48.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  rails-cops!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.4.7

data/README.md

@@ -0,0 +1,54 @@
+# Rails::Cops
+
+These are custom cops for Lixibox Rails project.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rails-cops
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rails-cops
+
+## Usage
+
+You need to tell RuboCop to load the Rails extension. There are three
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rails-cops
+```
+
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+require:
+  - rubocop-other-extension
+  - rails-cops
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop Rails
+cops together with the standard cops.
+
+### Command line
+
+```sh
+$ rubocop --require rails-cops
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lixibox/rails-cops.
+

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/config/default.yml

@@ -0,0 +1,27 @@
+# Common configuration.
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  Exclude:
+    - app/assets/**/*
+    - bin/*
+    # Exclude db/schema.rb and db/[CONFIGURATION_NAMESPACE]_schema.rb by default.
+    # See: https://guides.rubyonrails.org/active_record_multiple_databases.html#setting-up-your-application
+    - db/*schema.rb
+    - log/**/*
+    - public/**/*
+    - storage/**/*
+  # Enable checking Active Support extensions.
+  # See: https://docs.rubocop.org/rubocop/configuration.html#enable-checking-active-support-extensions
+  ActiveSupportExtensionsEnabled: true
+  # What version of Rails is the inspected code using?  If a value is specified
+  # for TargetRailsVersion then it is used.  Acceptable values are specified
+  # 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: ~

data/lib/rails/cops/model_custom_validation_method_name.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Rails
+  module Cops
+    # This is for custom rubocop rule
+    class ModelCustomValidationMethodName < ::RuboCop::Cop::Base
+      MSG = 'You are using model validation method name without _validation, please add suffix _validation to the method name'.freeze
+
+      def_node_matcher :custom_validation, <<-PATTERN
+        (send nil? :validate
+          (sym $_) $...)
+      PATTERN
+
+      # event handler
+      def on_send(node)
+        custom_validation(node) do |method_name, _args|
+          method_node = node.children[2]
+          add_offense(method_node, message: MSG) unless method_name.end_with?('_validation')
+        end
+      end
+    end
+  end
+end

data/lib/rails/cops/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rails
+  module Cops
+    VERSION = "0.1.0"
+  end
+end

data/lib/rails/cops.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require_relative 'cops/version'
+require_relative 'cops/model_custom_validation_method_name'
+
+module Rails
+  module Cops
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/rails-cops.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/rails/cops/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rails-cops"
+  spec.version = Rails::Cops::VERSION
+  spec.authors = ["Lixibox"]
+  spec.email = ["tech@lixibox.com"]
+
+  spec.summary = "Custom cops for Lixibox Rails project."
+  spec.description = "Custom cops for Lixibox Rails project."
+  spec.homepage = "https://github.com/lixibox/rails-cops"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/lixibox/rails-cops"
+  spec.metadata["changelog_uri"] = "https://github.com/lixibox/rails-cops"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_runtime_dependency 'activesupport', '>= 4.2.0'
+  # Rack::Utils::SYMBOL_TO_STATUS_CODE, which is used by HttpStatus cop, was
+  # introduced in rack 1.1
+  spec.add_runtime_dependency 'rubocop', '>= 1.33.0', '< 2.0'
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/rails/cops.rbs

@@ -0,0 +1,6 @@
+module Rails
+  module Cops
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: rails-cops
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lixibox
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.33.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.33.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Custom cops for Lixibox Rails project.
+email:
+- tech@lixibox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- config/default.yml
+- lib/rails/cops.rb
+- lib/rails/cops/model_custom_validation_method_name.rb
+- lib/rails/cops/version.rb
+- rails-cops.gemspec
+- sig/rails/cops.rbs
+homepage: https://github.com/lixibox/rails-cops
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/lixibox/rails-cops
+  source_code_uri: https://github.com/lixibox/rails-cops
+  changelog_uri: https://github.com/lixibox/rails-cops
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Custom cops for Lixibox Rails project.
+test_files: []