rubocop-rubycw 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 267e9277fc92afe3b044dcc764e15313316387553c4343b18bdddc61a70c82ce
+  data.tar.gz: 9b0e4621f503b1163dc2be5f7bd593250a7f1ff95cff6008d0cb898ee3a162dd
+SHA512:
+  metadata.gz: '0819b989df9b8d331f67d76872a9c7239e045fd1a32e4dd57b2ae508c6b388af1d88bc4a0d10786e0662d36b9701613771d660bdb0d657e436835d181952ef19'
+  data.tar.gz: 19916ad772aa2cb71089d537d205b2c18e6fabbcaa51ce6214965f912b48edc7193527d9430073fdc15fa6f876b1ecae67f9693fcf4494e078da19320676d281

data/.circleci/config.yml

@@ -0,0 +1,50 @@
+version: 2
+
+steps: &steps
+  steps:
+    - checkout
+    - run: bundle install
+    - run: bundle exec rake
+
+jobs:
+
+  ruby-2.3:
+    docker:
+      - image: circleci/ruby:2.3
+    <<: *steps
+
+  ruby-2.4:
+    docker:
+      - image: circleci/ruby:2.4
+    <<: *steps
+
+  ruby-2.5:
+    docker:
+      - image: circleci/ruby:2.5
+    <<: *steps
+
+  ruby-2.6:
+    docker:
+      - image: circleci/ruby:2.6
+    <<: *steps
+
+  ruby-2.7:
+    docker:
+      - image: circleci/ruby:2.7
+    <<: *steps
+
+  ruby-head:
+    docker:
+      - image: rubocophq/circleci-ruby-snapshot:latest
+    <<: *steps
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - ruby-2.3
+      - ruby-2.4
+      - ruby-2.5
+      - ruby-2.6
+      - ruby-2.7
+      - ruby-head

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.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,3 @@
+Naming/FileName:
+ Exclude:
+   - lib/rubocop-rubycw.rb

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-rubycw.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem 'rspec'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Masataka Pocke Kuwabara
+
+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,46 @@
+# RuboCop Rubycw
+
+Integrate RuboCop and `ruby -cw`.
+
+You can get Ruby's warning as a RuboCop offense by rubocop-rubycw.
+
+## Requirements
+
+* Ruby 2.3 or greater.
+  * But I highly recommend to use Ruby 2.6 or greater.
+    Because it is about 10x slower if it works on Ruby 2.5 or lower.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-rubycw'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-rubycw
+
+## Usage
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-rubycw
+```
+
+## 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 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/rubocop-hq/rubocop-rubycw.
+

data/Rakefile

@@ -0,0 +1,30 @@
+require "bundler/gem_tasks"
+task :default => :spec
+
+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/rubycw_cops.rb')
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubocop/rubycw"
+
+# 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,5 @@
+# Write it!
+
+Rubycw/Rubycw:
+  Description: 'Execute `ruby -cw` and wrap the warning as RuboCop offense.'
+  Enabled: true

data/lib/rubocop-rubycw.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/rubycw'
+require_relative 'rubocop/rubycw/version'
+require_relative 'rubocop/rubycw/inject'
+
+RuboCop::Rubycw::Inject.defaults!
+
+require_relative 'rubocop/rubycw/warning_capturer'
+require_relative 'rubocop/cop/rubycw_cops'

data/lib/rubocop/cop/rubycw/rubycw.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rubycw
+      # Execute `ruby -cw` and wrap the warning as RuboCop offense.
+      class Rubycw < Cop
+        include RangeHelp
+
+        def investigate(processed_source)
+          source = processed_source.raw_source
+
+          warnings(source).each do |line|
+            lnum = line[/.+:(\d+):/, 1].to_i
+            message = line[/.+:\d+: warning: (.+)$/, 1]
+
+            range = source_range(processed_source.buffer, lnum, 0)
+            add_offense(range, location: range, message: message)
+          end
+        end
+
+        def warnings(source)
+          RuboCop::Rubycw::WarningCapturer.capture(source)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rubycw_cops.rb

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

data/lib/rubocop/rubycw.rb

@@ -0,0 +1,14 @@
+require "rubocop/rubycw/version"
+
+module RuboCop
+  module Rubycw
+    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/rubycw/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 Rubycw
+    # 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)
+        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/rubycw/version.rb

@@ -0,0 +1,5 @@
+module RuboCop
+  module Rubycw
+    VERSION = "0.1.4"
+  end
+end

data/lib/rubocop/rubycw/warning_capturer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Rubycw
+    module WarningCapturer
+      if defined?(RubyVM::AbstractSyntaxTree)
+        module ::Warning
+          def self.warn(*message)
+            if WarningCapturer.warnings
+              WarningCapturer.warnings.concat message
+            else
+              super
+            end
+          end
+        end
+
+        def self.capture(source)
+          start
+          RubyVM::AbstractSyntaxTree.parse(source)
+          warnings
+        ensure
+          stop
+        end
+
+        def self.start
+          @verbose = $VERBOSE
+          $VERBOSE = true
+          @warnings = []
+        end
+
+        def self.stop
+          $VERBOSE = @verbose if defined?(@verbose)
+          @warnings = nil
+        end
+
+        def self.warnings
+          @warnings
+        end
+
+        stop
+      else
+        require 'rbconfig'
+        require 'open3'
+
+        def self.capture(source)
+          _stdout, stderr, _status = Open3.capture3(RbConfig.ruby, '-cw', stdin_data: source)
+          stderr.lines.map(&:chomp)
+        end
+      end
+    end
+  end
+end

data/rubocop-rubycw.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/rubocop/rubycw/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-rubycw"
+  spec.version       = RuboCop::Rubycw::VERSION
+  spec.authors       = ["Masataka Pocke Kuwabara"]
+  spec.email         = ["kuwabara@pocke.me"]
+
+  spec.summary       = %q{Integrate RuboCop and ruby -cw}
+  spec.description   = %q{Integrate RuboCop and ruby -cw}
+  spec.homepage      = "https://github.com/rubocop-hq/rubocop-rubycw"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.license       = 'MIT'
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # 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(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'
+end
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-rubycw
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Masataka Pocke Kuwabara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-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: Integrate RuboCop and ruby -cw
+email:
+- kuwabara@pocke.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop-rubycw.rb
+- lib/rubocop/cop/rubycw/rubycw.rb
+- lib/rubocop/cop/rubycw_cops.rb
+- lib/rubocop/rubycw.rb
+- lib/rubocop/rubycw/inject.rb
+- lib/rubocop/rubycw/version.rb
+- lib/rubocop/rubycw/warning_capturer.rb
+- rubocop-rubycw.gemspec
+homepage: https://github.com/rubocop-hq/rubocop-rubycw
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rubocop-hq/rubocop-rubycw
+  source_code_uri: https://github.com/rubocop-hq/rubocop-rubycw
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Integrate RuboCop and ruby -cw
+test_files: []