custom_cops_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b3a26c7275ff33acb6bdfb41c4eb9dd3264c6d06ae058e7551b9b6c10021e3b
+  data.tar.gz: 1b1606a45da88d889934d9e701353e79e68a2f7b7dadd9c304b22b16ba362746
+SHA512:
+  metadata.gz: 3d74b53a1a7e7c47764ae5fcb652ea11e02961793149b74655bf451c07dd9249fc29cee2d78bfec6abd4cd44dbae6a809cefe94942748fe56f8057d5f6bdf031
+  data.tar.gz: 7e6513aab2049ee7c5bc54f14ce6f656f02c67f7d0c948d717bb6a43b50d8c6ee71519e4e82eed40f40ca5e0fc999149a07deda8957ac9628ec625766278649d

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 custom_cops_generator.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/README.md

@@ -0,0 +1,36 @@
+# CustomCopsGenerator
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/custom_cops_generator`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'custom_cops_generator'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install custom_cops_generator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/custom_cops_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 "custom_cops_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/custom_cops_generator.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/custom_cops_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "custom_cops_generator"
+  spec.version       = CustomCopsGenerator::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/pocke/custom_cops_generator"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  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/exe/custom_cops_generator

@@ -0,0 +1,5 @@
+#!ruby
+
+require 'custom_cops_generator'
+
+CustomCopsGenerator::CLI.run(ARGV)

data/lib/custom_cops_generator.rb

@@ -0,0 +1,15 @@
+require "custom_cops_generator/version"
+require "custom_cops_generator/cli"
+require "custom_cops_generator/generator"
+
+require 'active_support'
+require 'active_support/core_ext/string/inflections'
+
+require 'optparse'
+require 'pathname'
+require 'fileutils'
+
+module CustomCopsGenerator
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/custom_cops_generator/cli.rb

@@ -0,0 +1,34 @@
+module CustomCopsGenerator
+  class CLI
+    BANNER = <<~TEXT
+      Usage: custom_cops_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
+
+    private def to_dirname(name)
+      name.sub('-', '/')
+    end
+
+    private def to_classname
+      
+    end
+  end
+end

data/lib/custom_cops_generator/generator.rb

@@ -0,0 +1,161 @@
+module CustomCopsGenerator
+  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}'
+      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 '#{dirname}'
+        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 "#{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
+
+        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, content)
+      puts "update #{path}"
+      path = root_path / path
+      path.write path.read.sub(pattern, content)
+    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

data/lib/custom_cops_generator/version.rb

@@ -0,0 +1,3 @@
+module CustomCopsGenerator
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: custom_cops_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masataka Pocke Kuwabara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-03 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:
+- custom_cops_generator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- custom_cops_generator.gemspec
+- exe/custom_cops_generator
+- lib/custom_cops_generator.rb
+- lib/custom_cops_generator/cli.rb
+- lib/custom_cops_generator/generator.rb
+- lib/custom_cops_generator/version.rb
+homepage: https://github.com/pocke/custom_cops_generator
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/pocke/custom_cops_generator
+  source_code_uri: https://github.com/pocke/custom_cops_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: []