rubocop-schema-gen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9896f77d8a3c4c39bd31f21878bffdb2d8979dee897b5fe38b3ef090bd11043d
+  data.tar.gz: bfa9fe9b715b977f1dc973f48e80eafe59a448545bbef559247055bd98cfc5bd
+SHA512:
+  metadata.gz: 074f101c7a87e0ce7e1de730a82b6bc83682bf0068d60519c1b042ca6bbcc7d3ca574e5ed47f3fec0f2cb63ce3639b98ab2915b90644b1e349aa4c589c3d6cab
+  data.tar.gz: aeafc3e4661bed171c7d182ffbf6c752ded81d002623984bd0e146072c70fca9609d79410a8f5c23fe031c49caf15755d8ad5a3fe120955e7f23b9ddbd813398

data/.gitignore

@@ -0,0 +1,19 @@
+# Actual stuff
+
+/cache
+/.cache
+/Gemfile.lock
+
+# Generated by `bundle gem`
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,38 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  SuggestExtensions: false
+  NewCops: enable
+  TargetRubyVersion: 3.0
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+Style/StderrPuts:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 3.0.0
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at neil.pearson@bigcommerce.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubocop-schema.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.13.0', require: false
+gem 'rubocop-rake', require: false
+gem 'rubocop-rspec', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Neil E. Pearson
+
+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,44 @@
+# Rubocop::Schema
+
+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/rubocop/schema`. 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 'rubocop-schema'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-schema
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/[USERNAME]/rubocop-schema. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rubocop-schema/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rubocop::Schema project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rubocop-schema/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/assets/templates/cop_schema.yml

@@ -0,0 +1,15 @@
+type: object
+additionalProperties: true
+
+propertyNames:
+  type: string
+  pattern: '^[A-Z][A-Za-z]*$'
+
+properties:
+  Enabled: { type: boolean }
+  Exclude: { $ref: '#/definitions/listOfFiles' }
+  Include: { $ref: '#/definitions/listOfFiles' }
+  Severity: { $ref: '#/definitions/severity' }
+  Details: { type: string }
+  StyleGuideBaseURL: { type: string }
+  StyleGuide: { type: string }

data/assets/templates/schema.yml

@@ -0,0 +1,67 @@
+$schema: http://json-schema.org/draft-07/schema
+
+title: RuboCop configuration schema
+description: >-
+  Schema for RuboCop configuration files (e.g. .rubocop.yml), intended for
+  helping IDEs provide autocompletion and validation.
+
+type: object
+additionalProperties: false
+
+definitions:
+  inherit_mode:
+    type: object
+    minProperties: 1
+    propertyNames:
+      enum:
+        - merge
+        - override
+    additionalProperties:
+      type: array
+      minItems: 1
+      items: { type: string }
+
+  listOfFiles:
+    type: array
+    items: { type: string }
+
+  severity:
+    type: string
+    enum:
+      - info
+      - refactor
+      - convention
+      - warning
+      - error
+      - fatal
+
+  stringOrStrings:
+    oneOf:
+      - type: string
+      - type: array
+        items: { type: string }
+
+properties:
+  inherit_from: { type: string }
+
+  inherit_gem:
+    type: object
+    additionalProperties: { $ref: '#/definitions/stringOrStrings' }
+
+  require: { $ref: '#/definitions/stringOrStrings' }
+
+  inherit_mode: { $ref: '#/definitions/inherit_mode' }
+
+  AllCops:
+    type: object
+    additionalProperties: false
+    properties:
+      Exclude: { $ref: '#/definitions/listOfFiles' }
+      Include: { $ref: '#/definitions/listOfFiles' }
+      NewCops: { enum: [ enable, disable ] }
+      EnabledByDefault: { type: boolean }
+      DisabledByDefault: { type: boolean }
+      SuggestExtensions: { type: boolean }
+      TargetRubyVersion: { type: number }
+      StyleGuideBaseURL: { type: string }
+      StyleGuide: { type: string }

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rubocop/schema'
+
+# 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-schema-gen

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rubocop/schema'
+require 'rubocop/schema/cli'
+require 'json'
+
+RuboCop::Schema::CLI.new(Dir.pwd, ENV, ARGV).run

data/lib/rubocop/schema.rb

@@ -0,0 +1,16 @@
+require 'pathname'
+require 'rubocop'
+
+require 'rubocop/schema/version'
+require 'rubocop/schema/cache'
+require 'rubocop/schema/scraper'
+require 'rubocop/schema/lockfile_inspector'
+
+module RuboCop
+  module Schema
+    ROOT =
+      Pathname(__dir__) # rubocop/
+        .parent         # lib/
+        .parent         # /
+  end
+end

data/lib/rubocop/schema/cache.rb

@@ -0,0 +1,47 @@
+require 'pathname'
+require 'uri'
+require 'net/http'
+
+module RuboCop
+  module Schema
+    class Cache
+      # @return [URI]
+      attr_reader :base_url
+
+      def initialize(cache_dir, base_url: nil, &event_handler)
+        @cache_dir     = Pathname(cache_dir)
+        @base_url      = validate_url(base_url)
+        @event_handler = event_handler
+      end
+
+      def get(url)
+        url = URI(url)
+        url = @base_url + url if @base_url && url.relative?
+        validate_url url
+
+        path = path_for_url(url)
+        return path.read if path.readable?
+
+        path.parent.mkpath
+        @event_handler&.call Event.new(type: :request)
+        Net::HTTP.get(url).force_encoding(Encoding::UTF_8).tap(&path.method(:write))
+      end
+
+      private
+
+      def validate_url(url)
+        return if url.nil?
+
+        raise ArgumentError, 'Expected an absolute URL' unless url.absolute?
+        raise ArgumentError, 'Expected an HTTP URL' unless url.is_a? URI::HTTP
+
+        url
+      end
+
+      # @param [URI::HTTP] url
+      def path_for_url(url)
+        @cache_dir + url.scheme + url.hostname + url.path[1..]
+      end
+    end
+  end
+end

data/lib/rubocop/schema/cli.rb

@@ -0,0 +1,68 @@
+require 'pathname'
+require 'json'
+
+module RuboCop
+  module Schema
+    class CLI
+      # @param [Pathname] working_dir
+      # @param [Hash] env
+      # @param [Array<String>] args
+      def initialize(working_dir, env, args)
+        @working_dir = Pathname(working_dir)
+        @env         = env
+        @args        = args
+      end
+
+      def run
+        fail "Cannot read #{lockfile_path}" unless lockfile_path.readable?
+        fail 'RuboCop is not part of this project' unless lockfile.specs.any?
+
+        schema = report_duration { Scraper.new(lockfile, cache).schema }
+        puts JSON.pretty_generate schema
+      end
+
+      private
+
+      def report_duration
+        started  = Time.now
+        yield
+      ensure
+        finished = Time.now
+        handle_event Event.new(message: "Complete in #{(finished - started).round 1}s")
+      end
+
+      def handle_event(event)
+        case event.type
+        when :request
+          $stderr << '.'
+          @line_dirty = true
+        else
+          $stderr.puts '' if @line_dirty
+          @line_dirty = false
+          $stderr.puts event.message.to_s
+        end
+      end
+
+      def fail(msg)
+        $stderr.puts msg.to_s
+        exit 1
+      end
+
+      def lockfile
+        @lockfile ||= LockfileInspector.new(lockfile_path)
+      end
+
+      def lockfile_path
+        @lockfile_path ||= @working_dir + 'Gemfile.lock'
+      end
+
+      def cache
+        @cache ||= Cache.new(cache_dir, &method(:handle_event))
+      end
+
+      def cache_dir
+        @cache_dir ||= Pathname(Dir.home) + '.rubocop-schema-cache'
+      end
+    end
+  end
+end