rubocop-dir_methods 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2597ca4e84265eb115ab05db871b55b11564a208c4222d2713bbcb179d0bee59
+  data.tar.gz: b17f217c171dd434c89943ff656832358072a6d69063e16f52a47b2b2e1703ba
+SHA512:
+  metadata.gz: 2376dfbd471fc7fe629e5d4a98741a2635b4214cda686b9f6251a4f1935c85d05a5b0ea72750b457e1246f0f040ec2d27a8da26bab883375ce8a37e37169d405
+  data.tar.gz: aef64d3b3e4d984807d20c9cddb0f077f6329b356672704ea9124403849cd0a9b9cd2c89b1f086e67aceb267906feaf3322a37b3fd73ecbbbc76517c6801619a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - "spec/dummy_app/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/WordArray:
+  Enabled: false
+Style/SymbolArray:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - "bin/console"
+
+Naming/FileName:
+  Exclude:
+    - "lib/rubocop-dir_methods.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec"

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    rubocop-dir_methods (0.1.0)
+      rubocop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.8.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.52.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec
+  rubocop-dir_methods!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 GeorgeGorbanev
+
+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,84 @@
+# Rubocop::DirMethods
+
+This gem is a tool designed to extend the functionality of RuboCop. It provides single RuboCop/Cop with capability to define and enforce custom naming conventions for public methods within specific directories in your Ruby projects. With this gem, you can maintain consistent coding practices and preserve the integrity of your project's codebase.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-dir_methods', require: false
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-dir_methods
+
+## Usage
+
+Imagine you have a Rails application with a classic `controllers` directory:
+```
+- sample_rails_app
+    - app
+        - controllers
+            - application_controller.rb
+            - sample_controller.rb
+        ...    
+    ...        
+```
+And you wish to enforce RESTful method naming conventions to help developers think in terms of REST. You can configure your project to allow only RESTful method names within the `controllers` directory:
+```
+# .rubocop.yml
+require:
+  - rubocop-dir_methods
+
+Naming/DirMethods:
+  dirs:
+    app/controllers:
+      allowed_methods:
+        - new
+        - create
+        - show
+        - edit
+        - update
+        - destroy
+      reason: "We want to follow RESTful design in controllers"
+
+```
+
+If a developer creates a method that does not adhere to these conventions, the linter will promptly notify them, ensuring compliance with the established guidelines before the code review process:
+```ruby
+# app/controllers/sample_controller.rb
+class SampleController < ApplicationController
+  def sample_public_method
+    sample_implementation
+  end
+end 
+```
+After running `rubocop`:
+```sh
+rubocop
+...
+app/controllers/sample_controller.rb:3:3: C: Naming/DirMethods: Invalid public method name: sample_public_method (reason: We want to follow RESTful design in controllers)
+  def sample_public_method ...
+  ^^^^^^^^^^^^^^^^^^^^^^^^
+```
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GeorgeGorbanev/rubocop-dir_methods.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+RuboCop::RakeTask.new
+
+task(:default).clear.enhance(["spec", "rubocop"])

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubocop/dir_methods"
+require "irb"
+
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/rubocop/cop/dir_methods_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "naming/dir_methods"

data/lib/rubocop/cop/naming/dir_methods.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Naming
+      class DirMethods < Base
+        include RuboCop::Cop::DefNode
+
+        MODIFIERS = [:public, :protected, :private].freeze
+
+        def on_def(node)
+          node_visibility_modifier = visibility_modifier(node)
+          return if node_visibility_modifier != :public
+
+          file_path = current_file_path(node)
+          _, dir_config = dir_config(file_path)
+          return if dir_config.nil? || dir_config["allowed_methods"].include?(node.method_name.to_s)
+
+          add_offense(node, message: offense_message(node, dir_config))
+        end
+
+        private
+
+        def current_file_path(node)
+          src_path = node.location.expression.source_buffer.name
+
+          if src_path.start_with?("/")
+            project_path = Pathname.new(File.expand_path(".")).realpath
+            Pathname.new(src_path).relative_path_from(project_path).to_s
+          else
+            src_path
+          end
+        end
+
+        def dir_config(file_path)
+          cop_config.fetch("dirs", {}).find do |config|
+            file_path.start_with?(config.first)
+          end
+        end
+
+        def visibility_modifier(node)
+          node.left_siblings.reverse.each do |sibling_node|
+            if inline_modifier?(sibling_node)
+              return sibling_node
+            elsif parent_modifier?(sibling_node)
+              return sibling_node.method_name
+            end
+          end
+
+          :public
+        end
+
+        def inline_modifier?(node)
+          MODIFIERS.include?(node)
+        end
+
+        def parent_modifier?(node)
+          node.respond_to?(:method_name) && MODIFIERS.include?(node.method_name)
+        end
+
+        def offense_message(node, dir_config)
+          message = "Invalid public method name: #{node.method_name}"
+          message += " (reason: #{dir_config['reason']})" if dir_config["reason"]
+          message
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/dir_methods/version.rb

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

data/lib/rubocop/dir_methods.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "rubocop/dir_methods/version"
+
+module RuboCop
+  module DirMethods
+  end
+end

data/lib/rubocop-dir_methods.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+require_relative "rubocop/dir_methods"
+require_relative "rubocop/dir_methods/version"
+require_relative "rubocop/cop/dir_methods_cops"

data/rubocop-dir_methods.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/rubocop/dir_methods/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-dir_methods"
+  spec.version       = RuboCop::DirMethods::VERSION
+  spec.authors       = ["GeorgeGorbanev"]
+  spec.email         = ["georgegorbanev@gmail.com"]
+
+  spec.summary       = "Rubocop plugin for enforcing method names in dirs."
+  spec.description   = "This gem is a tool designed to extend the functionality of RuboCop." \
+                       "It provides single RuboCop/Cop with capability to define and enforce custom naming " \
+                       "conventions for public methods within specific directories in your Ruby projects. " \
+                       "With this gem, you can maintain consistent coding practices and preserve the " \
+                       "integrity of your project's codebase."
+  spec.homepage      = "https://github.com/GeorgeGorbanev/rubocop-dir_methods"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rubocop"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-dir_methods
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GeorgeGorbanev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a tool designed to extend the functionality of RuboCop.It
+  provides single RuboCop/Cop with capability to define and enforce custom naming
+  conventions for public methods within specific directories in your Ruby projects.
+  With this gem, you can maintain consistent coding practices and preserve the integrity
+  of your project's codebase.
+email:
+- georgegorbanev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rubocop-dir_methods.rb
+- lib/rubocop/cop/dir_methods_cops.rb
+- lib/rubocop/cop/naming/dir_methods.rb
+- lib/rubocop/dir_methods.rb
+- lib/rubocop/dir_methods/version.rb
+- rubocop-dir_methods.gemspec
+homepage: https://github.com/GeorgeGorbanev/rubocop-dir_methods
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/GeorgeGorbanev/rubocop-dir_methods
+  source_code_uri: https://github.com/GeorgeGorbanev/rubocop-dir_methods
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Rubocop plugin for enforcing method names in dirs.
+test_files: []