rubocop-semantics 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30fa62f94179a0f55677ebc0b0cd6b9b891396306c9fabb7e65daf3d2fdc672d
+  data.tar.gz: 3c9fa227b9e108f21fe4feaa9a33d70e1826facb7b6f814f112a2ba766f7da4c
+SHA512:
+  metadata.gz: 3e7c7a85f0165c52618f61ea6e8e40529c831b0b118c50a43a0fcd7c5ced8ff4efcd0c2b169f4b73c2102e6686237dc45e59a2bdc619864e5ce2785a1f94467d
+  data.tar.gz: 7bf18383844fb804ec55b9e8a5f61043c5cc83dc3c9f2f90cca09b30794872b79d7c92297b7f8b71c61c7e138b5f1b1356110ff3c97b7e388fa9795a2a9d5d70

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.idea/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Naming/FileName:
+  Exclude:
+    - lib/rubocop-semantics.rb
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
+  - head

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# RuboCop Semantics
+
+## Notable changes
+
+### 1.0.0 (2021-08-06)
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-semantics.gemspec
+gemspec

data/README.md

@@ -0,0 +1,50 @@
+# RuboCop Semantics
+
+Checks for meaningless variable names in Ruby code. An extension for [RuboCop](https://rubocop.org).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-semantics', require: false
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-semantics
+
+## Usage
+
+```yaml
+# .rubocop.yml
+
+require:
+  - rubocop-semantics
+```
+
+## 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/vassilevsky/rubocop-semantics
+
+To create a new cop in this extension, run:
+
+    bundle exec rake new_cop[Semantics/RuleName]
+
+Please cover all logic with tests.

data/Rakefile

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+desc "Generate a new cop with a template"
+task :new_cop, [:cop] do |_task, args|
+  require "rubocop"
+
+  cop_name = args.fetch(:cop) do
+    warn "usage: bundle exec rake new_cop[Department/Name]"
+    exit!
+  end
+
+  github_user = `git config github.user`.chop
+  github_user = "your_id" if github_user.empty?
+
+  generator = RuboCop::Cop::Generator.new(cop_name, github_user)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: "lib/rubocop/cop/semantics_cops.rb")
+  generator.inject_config(config_file_path: "config/default.yml")
+
+  puts generator.todo
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rubocop/semantics"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/default.yml

@@ -0,0 +1,4 @@
+Semantics/VariableName:
+  Description: 'Checks for meaningless variable names.'
+  Enabled: true
+  VersionAdded: '1.0.0'

data/lib/rubocop-semantics.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+require_relative "rubocop/semantics"
+require_relative "rubocop/semantics/version"
+require_relative "rubocop/semantics/inject"
+
+RuboCop::Semantics::Inject.defaults!
+
+require_relative "rubocop/cop/semantics_cops"

data/lib/rubocop/cop/semantics/variable_name.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Semantics
+      # Checks for meaningless variable names.
+      # A good variable name describes its contents with nouns and adjectives.
+      #
+      # @example
+      #
+      #   # bad
+      #   data = {name: 'Elijah', age: 40}
+      #
+      #   # good
+      #   customer = {name: 'Elijah', age: 40}
+      #
+      class VariableName < Base
+        MEANINGLESS_NAMES = %i[
+
+          data
+          info
+          value
+
+        ].freeze
+
+        def on_lvasgn(node)
+          variable_name, = *node
+          return unless MEANINGLESS_NAMES.include?(variable_name)
+
+          add_offense(node.loc.name, message: "Use a more descriptive variable name.")
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/semantics_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "semantics/variable_name"

data/lib/rubocop/semantics.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "semantics/version"
+
+module RuboCop
+  # Cops that check for meaningless and misleading names in code
+  module Semantics
+    class Error < StandardError; end
+
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop/semantics/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop-hq/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop-hq/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module Semantics
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/semantics/version.rb

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

data/rubocop-semantics.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/rubocop/semantics/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-semantics"
+  spec.version       = RuboCop::Semantics::VERSION
+  spec.authors       = ["i.vasilevskiy"]
+  spec.email         = ["i.vasilevskiy@fun-box.ru"]
+
+  spec.summary       = "Cops that check for meaningless and misleading names in code"
+  spec.homepage      = "https://github.com/vassilevsky/rubocop-semantics"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/vassilevsky/rubocop-semantics/blob/master/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rubocop"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-semantics
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- i.vasilevskiy
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-06 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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- i.vasilevskiy@fun-box.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop-semantics.rb
+- lib/rubocop/cop/semantics/variable_name.rb
+- lib/rubocop/cop/semantics_cops.rb
+- lib/rubocop/semantics.rb
+- lib/rubocop/semantics/inject.rb
+- lib/rubocop/semantics/version.rb
+- rubocop-semantics.gemspec
+homepage: https://github.com/vassilevsky/rubocop-semantics
+licenses: []
+metadata:
+  homepage_uri: https://github.com/vassilevsky/rubocop-semantics
+  source_code_uri: https://github.com/vassilevsky/rubocop-semantics
+  changelog_uri: https://github.com/vassilevsky/rubocop-semantics/blob/master/CHANGELOG.md
+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: Cops that check for meaningless and misleading names in code
+test_files: []