rubocop-sensei 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3d5985f2ba4b1583ff53baadfc49b88342901c7b17aa0e353da4d8bca55ae8d1
+  data.tar.gz: 785df89fde862a0fab0f4756307876f54c133896c2ff9360a4b28f3ffdf88aa5
+SHA512:
+  metadata.gz: c95241d23a5acb41f201da2310f41d28cceda048721e730d3250fc5921e69c4736c49f39d3e4597c0c7e8ccb51e2c46ab408e219cb86048f08b67479c27680ac
+  data.tar.gz: dff62e0eb119d25d819616b25994ff482860a7ba61a1f1a35c8ae96651176c035c71dc73702cfedf77a571bad966e43d837862b1ac56cd8d45d8462c7eb0acb8

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+Naming/FileName:
+ Exclude:
+   - lib/rubocop-sensei.rb

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-sensei.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+gem "rspec"
+gem "debug"

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    rubocop-sensei (0.1.0)
+      rubocop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    debug (1.7.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    io-console (0.5.11)
+    irb (1.6.0)
+      reline (>= 0.3.0)
+    json (2.6.1)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    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.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.40.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  debug
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rspec
+  rubocop-sensei!
+
+BUNDLED WITH
+   2.3.26

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2022 Kuniaki Igarashi
+
+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,5 @@
+# Rubocop::Sensei
+
+# License
+
+MIT

data/Rakefile

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+# Rake::TestTask.new(:test) do |t|
+#   t.libs << "test"
+#   t.libs << "lib"
+#   t.test_files = FileList["test/**/test_*.rb"]
+# end
+# task default: :test
+
+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
+
+  generator = RuboCop::Cop::Generator.new(cop_name)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: 'lib/rubocop/cop/sensei_cops.rb')
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/config/default.yml

@@ -0,0 +1,6 @@
+# Write it!
+
+Lint/ReplaceElsif:
+  Description: 'elsifはCaseで置換できる'
+  Enabled: pending
+  VersionAdded: '<<next>>'

data/lib/rubocop/cop/sensei_cops.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require_relative 'style/replace_elsif'

data/lib/rubocop/cop/style/replace_elsif.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # `elsif`は`case`で書き換え可能です。
+      # N個の分岐から1つ選ぶ「N者択一」のときはcaseをつかうと読みやすくなります。
+      #
+      # @example
+      #   # bad
+      #   if x == 1
+      #     do_something1
+      #   elsif y == 2
+      #     do_something2
+      #   end
+      #
+      #   # good
+      #   case
+      #   when x == 1
+      #     do_something1
+      #   when y == 2
+      #     do_something2
+      #   end
+      #
+      #   # good
+      #   case x
+      #   when (1..20)
+      #     do_something1
+      #   when (21..)
+      #     do_something2
+      #   end
+      #
+      class ReplaceElsif < Base
+        extend RuboCop::Cop::AutoCorrector
+
+        MSG = <<~STRING
+          `elsif`は`case`で書き換え可能です。
+          N個の分岐から1つ選ぶ「N者択一」のときはcaseをつかうと読みやすくなります。
+
+          たとえば、elsifをつかった次のようなコードがあるとき、
+
+          if x == 1
+          elsif y == 2
+          else
+          end
+
+          caseをつかうと次のように書き換えられます。
+
+          case
+          when x == 1
+          when y == 2
+          else
+          end
+
+          同じ変数の値で分岐するときは次のようにも書けます。
+
+          case x
+          when 1
+          when 2
+          else
+          end
+        STRING
+
+        def on_if(node)
+          return unless node.elsif?
+
+          add_offense(node) do |corrector|
+            corrector.replace(node.parent.loc.keyword, "case\nwhen")  # if => case when
+            corrector.replace(node.loc.keyword, "when") # elsif => when
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/sensei/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module Sensei
+    # 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/sensei/version.rb

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

data/lib/rubocop/sensei.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "yaml"
+require_relative "sensei/version"
+
+module RuboCop
+  module Sensei
+    class Error < StandardError; end
+    # Your code goes here...
+    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-sensei.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/sensei'
+require_relative 'rubocop/sensei/version'
+require_relative 'rubocop/sensei/inject'
+
+RuboCop::Sensei::Inject.defaults!
+
+require_relative 'rubocop/cop/sensei_cops'

data/rubocop-sensei.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/rubocop/sensei/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rubocop-sensei"
+  spec.version = RuboCop::Sensei::VERSION
+  spec.authors = ["Kuniaki Igarashi"]
+  spec.email = ["kuniaki.igarashi@garnettech373.com"]
+
+  spec.summary = "Rubocop Sensei"
+  spec.description = "."
+  spec.homepage = "https://github.com/igaiga/rubocop-sensei"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/igaiga/rubocop-sensei"
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|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"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+
+  spec.add_runtime_dependency 'rubocop'
+end
+

data/sig/rubocop/sensei.rbs

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

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-sensei
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kuniaki Igarashi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-30 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: "."
+email:
+- kuniaki.igarashi@garnettech373.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- 'LICENSE '
+- README.md
+- Rakefile
+- config/default.yml
+- lib/rubocop-sensei.rb
+- lib/rubocop/cop/sensei_cops.rb
+- lib/rubocop/cop/style/replace_elsif.rb
+- lib/rubocop/sensei.rb
+- lib/rubocop/sensei/inject.rb
+- lib/rubocop/sensei/version.rb
+- rubocop-sensei.gemspec
+- sig/rubocop/sensei.rbs
+homepage: https://github.com/igaiga/rubocop-sensei
+licenses: []
+metadata:
+  homepage_uri: https://github.com/igaiga/rubocop-sensei
+  source_code_uri: https://github.com/igaiga/rubocop-sensei
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Rubocop Sensei
+test_files: []