rubocop-extension-generator 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bcee5e332852d452e3588610c68ae4fef761575b0a2570188e46757b2c03e8fd
+  data.tar.gz: 96ac7fdd367d30a449c07f9279ac23e1254514f1e9921f649a84a5e849de3e65
+SHA512:
+  metadata.gz: 8a0b31e2b319110c112285c2b00da343bcee1623d54dc17d12a75210264fa9ad60aaab6a9fc8776f87258a650df898f0074c8253dab6c013b256938917909508
+  data.tar.gz: 8d77af43d7a34596070985d985b5017f2dee1ac35e9e7bfab0a380bd70e868430c93b5e4daf159de41dd559d710dc1b87e3ffff79e7b70b064599a366fbbf22a

data/.gitignore

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

data/Gemfile

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

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,66 @@
+# rubocop-extension-generator
+
+A generator of RuboCop's custom cops gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-extension-generator'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-extension-generator
+
+## Usage
+
+```
+$ rubocop-extension-generator rubocop-foobar
+Creating gem 'rubocop-foobar'...
+      create  rubocop-foobar/Gemfile
+      create  rubocop-foobar/lib/rubocop/foobar.rb
+      create  rubocop-foobar/lib/rubocop/foobar/version.rb
+      create  rubocop-foobar/rubocop-foobar.gemspec
+      create  rubocop-foobar/Rakefile
+      create  rubocop-foobar/README.md
+      create  rubocop-foobar/bin/console
+      create  rubocop-foobar/bin/setup
+      create  rubocop-foobar/.gitignore
+Initializing git repo in /tmp/tmp.Gu7G94wX00/rubocop-foobar
+Gem 'rubocop-foobar' was successfully created. For more information on making a RubyGem visit https://bundler.io/guides/creating_gem.html
+create rubocop-foobar/lib/rubocop-foobar.rb
+create rubocop-foobar/lib/rubocop/foobar/inject.rb
+create rubocop-foobar/lib/rubocop/cop/foobar_cops.rb
+create rubocop-foobar/config/default.yml
+create rubocop-foobar/spec/spec_helper.rb
+create rubocop-foobar/.rspec
+update lib/rubocop/foobar.rb
+update lib/rubocop/foobar.rb
+update lib/rubocop/foobar/version.rb
+update rubocop-foobar.gemspec
+update rubocop-foobar.gemspec
+update Rakefile
+update Gemfile
+
+It's done! You can start developing a new extension of RuboCop in rubocop-foobar.
+For the next step, you can use the cop generator.
+
+  $ bundle exec rake 'new_cop[Foobar/SuperCoolCopName]'
+```
+
+## 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-extension-generator.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubocop/extension/generator"
+
+# 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/exe/rubocop-extension-generator

@@ -0,0 +1,5 @@
+#!ruby
+
+require 'rubocop/extension/generator'
+
+RuboCop::Extension::Generator::CLI.run(ARGV)

data/lib/rubocop/extension/generator.rb

@@ -0,0 +1,17 @@
+require "rubocop/extension/generator/version"
+require "rubocop/extension/generator/cli"
+require "rubocop/extension/generator/generator"
+
+require 'active_support'
+require 'active_support/core_ext/string/inflections'
+
+require 'optparse'
+require 'pathname'
+require 'fileutils'
+
+module RuboCop
+  module Extension
+    module Generator
+    end
+  end
+end

data/lib/rubocop/extension/generator/cli.rb

@@ -0,0 +1,30 @@
+module RuboCop
+  module Extension
+    module Generator
+      class CLI
+        BANNER = <<~TEXT
+          Usage: rubocop-extension-generator NAME
+        TEXT
+
+        def self.run(argv)
+          new(argv).run
+        end
+
+        def initialize(argv)
+          @argv = argv
+        end
+
+        def run
+          # For --help
+          opt = OptionParser.new(BANNER)
+          args = opt.parse(@argv)
+
+          name = args.first
+          raise "It must be named `rubocop-*`. For example: rubocop-rspec" unless name.match?(/\Arubocop-\w+\z/)
+
+          Generator.new(name).generate
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/extension/generator/generator.rb

@@ -0,0 +1,182 @@
+module RuboCop
+  module Extension
+    module Generator
+      class Generator
+        def initialize(name)
+          @name = name
+        end
+
+        def generate
+          system('bundle', 'gem', name, exception: true)
+
+          put "lib/#{name}.rb", <<~RUBY
+            # frozen_string_literal: true
+
+            require 'rubocop'
+
+            require_relative '#{dirname}'
+            require_relative '#{dirname}/version'
+            require_relative '#{dirname}/inject'
+
+            RuboCop::#{classname}::Inject.defaults!
+
+            require_relative '#{cops_file_name.sub(/\.rb$/, '').sub(/^lib\//, '')}'
+          RUBY
+
+          put "lib/#{dirname}/inject.rb", <<~RUBY
+            # 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 #{classname}
+                # 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
+          RUBY
+
+          put cops_file_name, <<~RUBY
+            # frozen_string_literal: true
+          RUBY
+
+          put "config/default.yml", <<~YAML
+            # Write it!
+          YAML
+
+          put 'spec/spec_helper.rb', <<~RUBY
+            # frozen_string_literal: true
+
+            require '#{name}'
+            require 'rubocop/rspec/support'
+
+            RSpec.configure do |config|
+              config.include RuboCop::RSpec::ExpectOffense
+
+              config.disable_monkey_patching!
+              config.raise_errors_for_deprecations!
+              config.raise_on_warning = true
+              config.fail_if_no_examples = true
+
+              config.order = :random
+              Kernel.srand config.seed
+            end
+          RUBY
+
+          put '.rspec', <<~TEXT
+            --format documentation
+            --color
+            --require spec_helper
+          TEXT
+
+          patch "lib/#{dirname}.rb", /^  end\nend/, <<~RUBY
+                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
+          RUBY
+
+          patch "lib/#{dirname}.rb", 'module Rubocop', 'module RuboCop'
+          patch "lib/#{dirname}/version.rb", 'module Rubocop', 'module RuboCop'
+          patch "#{name}.gemspec", 'Rubocop', 'RuboCop'
+
+          patch "#{name}.gemspec", /^end/, <<~RUBY
+
+              spec.add_runtime_dependency 'rubocop'
+            end
+          RUBY
+
+          patch "Rakefile", /\z/, <<~RUBY
+
+            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: '#{cops_file_name}')
+              generator.inject_config(config_file_path: 'config/default.yml')
+
+              puts generator.todo
+            end
+          RUBY
+
+          patch 'Gemfile', /\z/, <<~RUBY
+            gem 'rspec'
+          RUBY
+
+          puts
+          puts <<~MESSAGE
+            It's done! You can start developing a new extension of RuboCop in #{root_path}.
+            For the next step, you can use the cop generator.
+
+              $ bundle exec rake 'new_cop[#{classname}/SuperCoolCopName]'
+          MESSAGE
+        end
+
+        private def put(path, content)
+          path = root_path / path
+          puts "create #{path}"
+          FileUtils.mkdir_p(path.dirname) unless path.dirname.directory?
+          path.write(content)
+        end
+
+        private def patch(path, pattern, replacement)
+          puts "update #{path}"
+          path = root_path / path
+          file = path.read
+          raise "Cannot apply patch for #{path} because #{pattern} is missing" unless file.match?(pattern)
+          path.write file.sub(pattern, replacement)
+        end
+
+        private def root_path
+          @root_path ||= Pathname(name)
+        end
+
+        private def dirname
+          @dirname ||= name.sub('-', '/')
+        end
+
+        private def classname
+          @classname ||= name.split('-').last.camelcase
+        end
+
+        private def cops_file_name
+          @cops_file_name ||= "lib/rubocop/cop/#{name.split('-').last}_cops.rb"
+        end
+
+        attr_reader :name
+        private :name
+      end
+    end
+  end
+end

data/lib/rubocop/extension/generator/version.rb

@@ -0,0 +1,7 @@
+module RuboCop
+  module Extension
+    module Generator
+      VERSION = "0.2.0"
+    end
+  end
+end

data/rubocop-extension-generator.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/rubocop/extension/generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-extension-generator"
+  spec.version       = RuboCop::Extension::Generator::VERSION
+  spec.authors       = ["Masataka Pocke Kuwabara"]
+  spec.email         = ["kuwabara@pocke.me"]
+
+  spec.summary       = %q{A generator of RuboCop's custom cops gem}
+  spec.description   = %q{A generator of RuboCop's custom cops gem}
+  spec.homepage      = "https://github.com/rubocop-hq/rubocop-extension-generator"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.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 'bundler'
+  spec.add_runtime_dependency 'activesupport'
+end

data/smoke/smoke.rb

@@ -0,0 +1,28 @@
+# Smoke testing for this gem
+
+require 'tmpdir'
+require 'pathname'
+
+exe_path = File.expand_path('../exe/rubocop-extension-generator', __dir__)
+load_path = File.expand_path('../lib', __dir__)
+
+Dir.mktmpdir('-rubocop-extension-generator-smoke') do |base_dir|
+  base_dir = Pathname(base_dir)
+  gem_name = 'rubocop-smoke'
+  gem_dir = base_dir / gem_name
+
+  system({ 'RUBYLIB' => load_path }, 'ruby', exe_path, gem_name, exception: true, chdir: base_dir)
+
+  gemspec_path = gem_dir / "#{gem_name}.gemspec"
+  gemspec = gemspec_path.read
+  gemspec[/spec\.summary.+/] = 'spec.summary = "a gem for smoke testing"'
+  gemspec.gsub!(/^.+spec\.description.+$/, '')
+  gemspec.gsub!(/^.+spec\.homepage.+$/, '')
+  gemspec.gsub!(/^.+spec\.metadata.+$/, '')
+
+  gemspec_path.write gemspec
+
+  system('bundle', 'install', exception: true, chdir: gem_dir)
+  system('bundle', 'exec', 'rake', 'new_cop[Smoke/Foo]', exception: true, chdir: gem_dir)
+  system('bundle', 'exec', 'rake', 'spec', exception: true, chdir: gem_dir)
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-extension-generator
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Masataka Pocke Kuwabara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: activesupport
+  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 generator of RuboCop's custom cops gem
+email:
+- kuwabara@pocke.me
+executables:
+- rubocop-extension-generator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rubocop-extension-generator
+- lib/rubocop/extension/generator.rb
+- lib/rubocop/extension/generator/cli.rb
+- lib/rubocop/extension/generator/generator.rb
+- lib/rubocop/extension/generator/version.rb
+- rubocop-extension-generator.gemspec
+- smoke/smoke.rb
+homepage: https://github.com/rubocop-hq/rubocop-extension-generator
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rubocop-hq/rubocop-extension-generator
+  source_code_uri: https://github.com/rubocop-hq/rubocop-extension-generator
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.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 generator of RuboCop's custom cops gem
+test_files: []