rubocop-rake 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '08c0328080d816a5440b34c59982e558d8816b5c7c6b02b0a047631fe53b056f'
+  data.tar.gz: 354fb71bfa405da3dcc0818e3e7de4e8cafb4ba1bc1d484cf578ac80403eac1a
+SHA512:
+  metadata.gz: 98e781c7ee3a6861f4c8b7236e0afa989158b6259ec1e490109140aaeafeb0a9e0b8f6506e525d5b4e8c2cd4b92ff66563d1825763c4a5d688b77c6c1774c07b
+  data.tar.gz: b2b54fcd86a9e40bb34cd04998e577ae802c340041715e6b2eb79d10e7911bd2c95ae9ddb6d863a9669bd28a385eba2f608baa1ef1c49848795e9a2231c9d27a

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/Gemfile

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

data/README.md

@@ -0,0 +1,38 @@
+# RuboCop Rake
+
+A [RuboCop](https://github.com/rubocop-hq/rubocop) plugin for Rake.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-rake'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-rake
+
+## Usage
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-rake
+```
+
+## 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/pocke/rubocop-rake.
+

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/rake_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/rake"
+
+# 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,7 @@
+Rake/Desc:
+  Description: 'Describe the task with `desc` method.'
+  Enabled: true
+  VersionAdded: '0.1.0'
+  Include:
+    - 'Rakefile'
+    - '**/*.rake'

data/lib/rubocop-rake.rb

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

data/lib/rubocop/cop/rake/desc.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rake
+      # Rake task definition should have a description with `desc` method.
+      # It is useful as a documentation of task. And Rake does not display
+      # task that does not have `desc` by `rake -T`.
+      #
+      # @example
+      #   # bad
+      #   task :do_something
+      #
+      #   # bad
+      #   task :do_something do
+      #   end
+      #
+      #   # good
+      #   desc 'Do something'
+      #   task :do_something
+      #
+      #   # good
+      #   desc 'Do something'
+      #   task :do_something do
+      #   end
+      #
+      class Desc < Cop
+        MSG = 'Describe the task with `desc` method.'.freeze
+
+        def_node_matcher :task?, <<~PATTERN
+          (send nil? :task ...)
+        PATTERN
+
+        def on_send(node)
+          return unless task?(node)
+          return if task_with_desc?(node)
+
+          add_offense(node)
+        end
+
+        private def task_with_desc?(node)
+          parent, task = parent_and_task(node)
+          return false unless parent
+
+          idx = parent.children.find_index(task) - 1
+          desc_candidate = parent.children[idx]
+          return false unless desc_candidate
+
+          desc_candidate.send_type? && desc_candidate.method_name == :desc
+        end
+
+        private def parent_and_task(task_node)
+          parent = task_node.parent
+          return nil, task_node unless parent
+          return parent, task_node unless parent.block_type?
+
+          if parent.children.find_index(task_node) == 0
+            # when task {}
+            return parent.parent, parent
+          else
+            # when something { task }
+            return parent, task_node
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rake_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative './rake/desc'

data/lib/rubocop/rake.rb

@@ -0,0 +1,13 @@
+require "rubocop/rake/version"
+
+module RuboCop
+  module Rake
+    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/rake/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 Rake
+    # 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/rake/version.rb

@@ -0,0 +1,5 @@
+module RuboCop
+  module Rake
+    VERSION = "0.1.0"
+  end
+end

data/rubocop-rake.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/rubocop/rake/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-rake"
+  spec.version       = RuboCop::Rake::VERSION
+  spec.authors       = ["Masataka Pocke Kuwabara"]
+  spec.email         = ["kuwabara@pocke.me"]
+
+  spec.summary       = %q{A RuboCop plugin for Rake}
+  spec.description   = %q{A RuboCop plugin for Rake}
+  spec.homepage      = "https://github.com/pocke/rubocop-rake"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.licenses = ['MIT']
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  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,75 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-rake
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masataka Pocke Kuwabara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-04 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: A RuboCop plugin for Rake
+email:
+- kuwabara@pocke.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop-rake.rb
+- lib/rubocop/cop/rake/desc.rb
+- lib/rubocop/cop/rake_cops.rb
+- lib/rubocop/rake.rb
+- lib/rubocop/rake/inject.rb
+- lib/rubocop/rake/version.rb
+- rubocop-rake.gemspec
+homepage: https://github.com/pocke/rubocop-rake
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/pocke/rubocop-rake
+  source_code_uri: https://github.com/pocke/rubocop-rake
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A RuboCop plugin for Rake
+test_files: []