rubocop-instance_variable_name 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: edc1016b06ec1779ff54de8765dedeb5d2bd4e2034957a87f6648f966b7b0b3d
+  data.tar.gz: b189aaac6adced8589db034adad52f05f9e9b8a8bd661f12bd94486992bbbe33
+SHA512:
+  metadata.gz: 3174fd3a3a2e09cef31aa71c6ea95554111abe723120387666feeeb925f03a2ee6fe7c8a8c6a94cf603b2c936b61f1b57dc31209bd8b1c908b7ff8bffcd7e5bc
+  data.tar.gz: 6ed63feea60b2f8007f19d731d9fa7a32da6cca765beaf835aaaf69db90023e6adcb3dd5231bdc625e1b67ffe7b64634a0c28fff98ee78f70240bf8028163473

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at satoryu.1981@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tatsuya Sato
+
+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,67 @@
+# Rubocop::InstanceVariableName
+
+A RuboCop extension focused on naming instance variables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-instance_variable_name'
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or install it yourself as:
+
+```sh
+gem install rubocop-instance_variable_name
+```
+
+## Usage
+
+Put the following code into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-instance_variable_name
+```
+
+or
+
+```yaml
+require:
+  - rubocop-other-extensions
+  - rubocop-instance_variable_name
+```
+
+## Configuration
+
+In default, acceptable minimum length of instance variable name is 2.
+If you want to stretch it, put `AcceptableMinimumLength` into your `.rubocop.yml`.
+
+```yaml
+Naming/InstanceVariableName:
+  AcceptableMinimumLength: 5
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 tags, 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/satoryu/rubocop-instance_variable_name. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rubocop::InstanceVariableName project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/satoryu/rubocop-instance_variable_name/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubocop/too_short_instance_variable"
+
+# 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/example/.rubocop.yml

@@ -0,0 +1,15 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+
+require: rubocop-instance_variable_name
+
+Naming/InstanceVariableName:
+  AcceptableLength: 5

data/example/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec path: '../'

data/example/bad_code.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# BadCode is an example for bad code in terms of InstanceVariableName Cop
+class BadCode
+  def initialize(message = '')
+    @msg = message
+  end
+
+  def say
+    puts "This is Bad #{message}"
+  end
+
+  private
+
+  def message
+    @msg
+  end
+end

data/example/good_code.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# GoodCode is an example for good code in terms of InstanceVariableName Cop
+class GoodCode
+  attr_reader :message
+
+  def initialize(message = '')
+    @message = message
+  end
+
+  def say
+    puts "This is Good #{message}"
+  end
+end

data/lib/rubocop-instance_variable_name.rb

@@ -0,0 +1 @@
+require 'rubocop/instance_variable_name'

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

@@ -0,0 +1,23 @@
+require 'rubocop/cop/cop'
+
+module RuboCop
+  module Cop
+    module Naming
+      class InstanceVariableName < ::RuboCop::Cop::Cop
+        MSG = 'Instance variable `%<ivar_name>s` is too short.'.freeze
+        DEFAULT_ACCEPTABLE_MINIMUM_LENGTH = 3.freeze
+
+        def on_ivasgn(node)
+          ivar_name, _ = *node
+          var_name = ivar_name[/^@(\w+)/, 1]
+          add_offense(node, message: format(MSG, ivar_name: ivar_name)) if var_name.length < acceptable_length
+        end
+
+        private
+          def acceptable_length
+            cop_config['AcceptableMinimumLength'] || DEFAULT_ACCEPTABLE_MINIMUM_LENGTH
+          end
+      end
+    end
+  end
+end

data/lib/rubocop/instance_variable_name.rb

@@ -0,0 +1,4 @@
+require 'rubocop'
+
+require 'rubocop/instance_variable_name/version'
+require 'rubocop/cop/naming/instance_variable_name'

data/lib/rubocop/instance_variable_name/version.rb

@@ -0,0 +1,5 @@
+module Rubocop
+  module InstanceVariableName
+    VERSION = "0.1.0"
+  end
+end

data/rubocop-instance_variable_name.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rubocop/instance_variable_name/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-instance_variable_name"
+  spec.version       = Rubocop::InstanceVariableName::VERSION
+  spec.authors       = ["Tatsuya Sato"]
+  spec.email         = ["satoryu.1981@gmail.com"]
+
+  spec.summary       = %q{A custom cop for validating instance variables}
+  spec.description   = <<~DESC
+    Variable name is an important key for developers to understand what codes do.
+    This cope checks instance variable names.
+  DESC
+  spec.homepage      = "https://github.com/satoryu/rubocop-instance_variable_name"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/satoryu/rubocop-instance_variable_name"
+  spec.metadata["changelog_uri"] = "https://github.com/satoryu/rubocop-instance_variable_name"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rubocop", "~> 0.72.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-instance_variable_name
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tatsuya Sato
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.72.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.72.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: |
+  Variable name is an important key for developers to understand what codes do.
+  This cope checks instance variable names.
+email:
+- satoryu.1981@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/.rubocop.yml
+- example/Gemfile
+- example/bad_code.rb
+- example/good_code.rb
+- lib/rubocop-instance_variable_name.rb
+- lib/rubocop/cop/naming/instance_variable_name.rb
+- lib/rubocop/instance_variable_name.rb
+- lib/rubocop/instance_variable_name/version.rb
+- rubocop-instance_variable_name.gemspec
+homepage: https://github.com/satoryu/rubocop-instance_variable_name
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/satoryu/rubocop-instance_variable_name
+  source_code_uri: https://github.com/satoryu/rubocop-instance_variable_name
+  changelog_uri: https://github.com/satoryu/rubocop-instance_variable_name
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A custom cop for validating instance variables
+test_files: []